Direct Debits
Retrieve a direct debit
Retrieve a direct debit
get/payments/direct_debits/{direct_debit_id}
Response
Direct debit payment
idstring uuid required
Direct debit funding request unique identifier
created_atstring date-time required
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
user_idstring uuid
User unique identifier.
account_group_idstring uuid required
Account group unique identifier.
mandate_idstring uuid required
Direct Debit Mandate unique identifier.
cash_amountstring required
currency'EUR' | 'GBP' required
Alphabetic three-letter ISO 4217 currency code.
- EUR - Euro
- GBP - Pound Sterling
remittance_informationstring
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'NEW' | 'PROCESSING' | 'CONFIRMED' | 'CANCELLED'
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.
cancellation_reason'CANCELLED_BY_BANK' | 'CANCELLED_BY_UPVEST' | 'CANCELLED_BY_CLIENT' | 'OTHER'
Reason the direct debit was cancelled. The field is present in case the direct debit has a status of CANCELLED.
- CANCELLED_BY_BANK - The payment was not completed by your bank. Please check your account details or contact support.
- CANCELLED_BY_UPVEST - The payment was cancelled. Contact support for details.
- CANCELLED_BY_CLIENT - The payment was cancelled at your request.
- OTHER - Reason not available (applies to historical data only).
purpose_codestring
Purpose of the payment based on ExternalPurpose1Code from ISO 20022.