Upvest Investment API.
API Reference/- Cancel withdrawal by ID
Trigger a withdrawal
Retrieve withdrawal
List withdrawals
Withdrawals events
Cancel withdrawal by ID
Upvest Investment API (1.75.0)
Overview
Languages
Servers
Sandbox environment
https://sandbox.upvest.co/
Live environment
https://api.upvest.co/
Headers
Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750
Example: Bearer c2VjcmV0Cg==
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he
- Sandbox environment
https://sandbox.upvest.co/payments/withdrawals/{withdrawal_id}
- Live environment
https://api.upvest.co/payments/withdrawals/{withdrawal_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://sandbox.upvest.co/payments/withdrawals/{withdrawal_id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'authorization: Bearer c2VjcmV0Cg==' \
-H 'signature: string' \
-H 'signature-input: string' \
-H 'upvest-api-version: 1' \
-H 'upvest-client-id: ebabcf4d-61c3-4942-875c-e265a7c2d062'Withdrawal
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
Payment reference the end user will see in their bank statement for the corresponding credit transfer booking (“Verwendungszweck”). We recommend that you keep this info concise and avoid special characters or non-standardised formatting (see more).
Status of the withdrawal
- NEW - Withdrawal is created but not started processing.
- PROCESSING - Withdrawal is in processing.
- CONFIRMED - Withdrawal was successfully processed.
- CANCELLED - Withdrawal was cancelled.
Enum"NEW""PROCESSING""CONFIRMED""CANCELLED"
Purpose of the payment based on ExternalPurpose1Code from ISO 20022.
Response
application/json
{ "id": "6ffa6b16-2380-4e7a-88b2-ae625c8eef99", "created_at": "2020-08-24T14:15:22Z", "updated_at": "2020-08-24T14:15:22Z", "reference_account_id": "295378ec-036e-4f3f-ae5c-2be85c93e837", "account_group_id": "ac1c39e9-2101-46b8-a624-d10a9e351b6c", "user_id": "b668282b-cdf3-439a-bda2-3f3c9f655bb7", "amount": "200.00", "currency": "EUR", "remittance_information": "Withdrawal", "taxes": [ { … } ], "status": "CONFIRMED", "purpose_code": "OTHR" }
Headers
Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750
Example: Bearer c2VjcmV0Cg==
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he
- Sandbox environment
https://sandbox.upvest.co/payments/withdrawals/{withdrawal_id}
- Live environment
https://api.upvest.co/payments/withdrawals/{withdrawal_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://sandbox.upvest.co/payments/withdrawals/{withdrawal_id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'authorization: Bearer c2VjcmV0Cg==' \
-H 'signature: string' \
-H 'signature-input: string' \
-H 'upvest-api-version: 1' \
-H 'upvest-client-id: ebabcf4d-61c3-4942-875c-e265a7c2d062'Response
No contentQuery
Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.
Default "ASC"
Enum"ASC""DESC"
Use the offset argument to specify where in the list of results to start when returning items for a particular query.
Headers
Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750
Example: Bearer c2VjcmV0Cg==
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he
- Sandbox environment
https://sandbox.upvest.co/account_groups/{account_group_id}/payments/withdrawals
- Live environment
https://api.upvest.co/account_groups/{account_group_id}/payments/withdrawals
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://sandbox.upvest.co/account_groups/{account_group_id}/payments/withdrawals?sort=id&order=ASC&offset=0&limit=100' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'authorization: Bearer c2VjcmV0Cg==' \
-H 'signature: string' \
-H 'signature-input: string' \
-H 'upvest-api-version: 1' \
-H 'upvest-client-id: ebabcf4d-61c3-4942-875c-e265a7c2d062'Withdrawals list
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
Payment reference the end user will see in their bank statement for the corresponding credit transfer booking (“Verwendungszweck”). We recommend that you keep this info concise and avoid special characters or non-standardised formatting (see more).
Status of the withdrawal
- NEW - Withdrawal is created but not started processing.
- PROCESSING - Withdrawal is in processing.
- CONFIRMED - Withdrawal was successfully processed.
- CANCELLED - Withdrawal was cancelled.
Enum"NEW""PROCESSING""CONFIRMED""CANCELLED"
Purpose of the payment based on ExternalPurpose1Code from ISO 20022.
Response
application/json
{ "meta": { "offset": 0, "limit": 100, "count": 1, "total_count": 1 }, "data": [ { … } ] }