Upvest Investment API.
- Retrieve a direct debit mandate
Upvest Investment API (1.75.0)
https://sandbox.upvest.co/
https://api.upvest.co/
Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750
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
A UUID to be used as an idempotency key. This prevents a duplicate request from being replayed. https://docs.upvest.co/documentation/concepts/api_concepts/idempotency
International Bank Account Number IBAN.
Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) ISO 9362.
- Sandbox environment
https://sandbox.upvest.co/payments/mandates
- Live environment
https://api.upvest.co/payments/mandates
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://sandbox.upvest.co/payments/mandates \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-H 'authorization: Bearer c2VjcmV0Cg==' \
-H 'idempotency-key: ccb07f42-4104-44ad-8e1f-c660bb7b269c' \
-H 'signature: string' \
-H 'signature-input: string' \
-H 'upvest-api-version: 1' \
-H 'upvest-client-id: ebabcf4d-61c3-4942-875c-e265a7c2d062' \
-d '{
"user_id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202",
"iban": "DE89000000000000000000",
"bic": "ABCDEXXX",
"confirmed_at": "2021-12-08T08:38:48.021Z"
}'
Mandate
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
Obfuscated International Bank Account Number IBAN.
Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) ISO 9362.
Address. Must not be a P.O. box or c/o address.
Postal code (postcode, PIN or ZIP code)
Accepted country code. ISO 3166-1 alpha-2 codes.
State, province, county. ISO 3166 alpha-2 Codes.
{ "id": "9c5a7dea-46f2-4502-b6b5-9902a53860e4", "created_at": "2020-08-24T14:15:22Z", "user_id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202", "iban": "DE8900**********0000", "bic": "ABCDEXXX", "creditor_name": "Creditor Company", "creditor_id": "DE98ZZZ09999999999", "creditor_address": { "address_line1": "Strasse 1", "address_line2": "Company GmbH", "postcode": "12345", "city": "Berlin", "state": "BE", "country": "DE" }, "type": "RECURRENT", "confirmed_at": "2021-12-08T08:38:48.021Z" }
Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750
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/mandates/{mandate_id}
- Live environment
https://api.upvest.co/payments/mandates/{mandate_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://sandbox.upvest.co/payments/mandates/{mandate_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'
Mandate
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
Obfuscated International Bank Account Number IBAN.
Business Identifier Code (also known as SWIFT-BIC, BIC, SWIFT ID or SWIFT code) ISO 9362.
Address. Must not be a P.O. box or c/o address.
Postal code (postcode, PIN or ZIP code)
Accepted country code. ISO 3166-1 alpha-2 codes.
State, province, county. ISO 3166 alpha-2 Codes.
{ "id": "9c5a7dea-46f2-4502-b6b5-9902a53860e4", "created_at": "2020-08-24T14:15:22Z", "user_id": "83d83ec2-d2ca-49ff-bbea-b92b5c3be202", "iban": "DE8900**********0000", "bic": "ABCDEXXX", "creditor_name": "Creditor Company", "creditor_id": "DE98ZZZ09999999999", "creditor_address": { "address_line1": "Strasse 1", "address_line2": "Company GmbH", "postcode": "12345", "city": "Berlin", "state": "BE", "country": "DE" }, "type": "RECURRENT", "confirmed_at": "2021-12-08T08:38:48.021Z" }
Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750
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/mandates/{mandate_id}
- Live environment
https://api.upvest.co/payments/mandates/{mandate_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://sandbox.upvest.co/payments/mandates/{mandate_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'
No content