Upvest Investment API.
API Reference/- Direct Debit events
List direct debits
Trigger a direct debit
Retrieve a direct debit
Direct Debit events
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/direct_debits/{direct_debit_id}
- Live environment
https://api.upvest.co/payments/direct_debits/{direct_debit_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://sandbox.upvest.co/payments/direct_debits/{direct_debit_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'Direct debit payment
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
Payment reference the end user will see in their bank statement for the corresponding direct debit booking (“Verwendungszweck”). We recommend that you keep this info concise and avoid special characters or non-standardised formatting (see more).
Status of the direct debit
- NEW - Direct debit is created but not started processing.
- PROCESSING - Direct debit is in processing.
- CONFIRMED - Direct debit was successfully processed.
- CANCELLED - Direct debit was cancelled.
Enum"NEW""PROCESSING""CONFIRMED""CANCELLED"
Purpose of the payment based on ExternalPurpose1Code from ISO 20022.
Response
application/json
{ "id": "1ab4fef9-a097-4c6f-9345-647025d5fde6", "created_at": "2020-08-24T14:15:22Z", "user_id": "82b49999-1145-4e05-916a-567662daa7bc", "account_group_id": "1ea60f56-b67b-61fc-829a-0242ac130003", "mandate_id": "730b8719-0bc6-401d-98dd-b2de72afbf05", "cash_amount": "200.00", "currency": "EUR", "remittance_information": "payment for green energy portfolio", "status": "NEW", "purpose_code": "OTHR" }
Bodyapplication/json
Date and time when the event was created. RFC 3339-5, ISO8601 UTC
Event type
Enum"DIRECT_DEBIT.NEW""DIRECT_DEBIT.PROCESSING""DIRECT_DEBIT.CONFIRMED""DIRECT_DEBIT.CANCELLED"
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
Payment reference the end user will see in their bank statement for the corresponding direct debit booking (“Verwendungszweck”). We recommend that you keep this info concise and avoid special characters or non-standardised formatting (see more).
Status of the direct debit
- NEW - Direct debit is created but not started processing.
- PROCESSING - Direct debit is in processing.
- CONFIRMED - Direct debit was successfully processed.
- CANCELLED - Direct debit was cancelled.
Enum"NEW""PROCESSING""CONFIRMED""CANCELLED"
Purpose of the payment based on ExternalPurpose1Code from ISO 20022.
- Sandbox environment
https://sandbox.upvest.co/Direct Debit events
- Live environment
https://api.upvest.co/Direct Debit events
application/json
{ "id": "8962b496-8d42-4560-bfab-10490dd1a721", "created_at": "2021-07-21T14:10:00.00Z", "type": "DIRECT_DEBIT.NEW", "object": { "id": "1ab4fef9-a097-4c6f-9345-647025d5fde6", "created_at": "2020-08-24T14:15:22Z", "user_id": "82b49999-1145-4e05-916a-567662daa7bc", "account_group_id": "1ea60f56-b67b-61fc-829a-0242ac130003", "mandate_id": "730b8719-0bc6-401d-98dd-b2de72afbf05", "cash_amount": "200.00", "currency": "EUR", "remittance_information": "payment for green energy portfolio", "status": "NEW" }, "webhook_id": "9df39835-be87-4243-9018-f2500b39cee6" }