Direct Debits
List direct debits
Returns a list of direct debits. For further details on Pagination, see general section above. Sort order is always descending on date.
get/payments/v2/direct-debits
Query parameters
accountIdstring
Include only direct debits for the given destination account.
status'CREATED' | 'APPROVED' | 'REJECTED' | 'PENDING_SUBMISSION' | 'SENT' | 'PENDING_AT_BANK' | 'ACCEPTED' | 'EXECUTED' | 'FAILED' | 'RETURNED' | 'UNKNOWN'
Status of a payment. Applicable to both credit transfer payments and direct debit payments.
Example:SENT
Include only direct debits with the given status.
Example:2022-01-15
Include only direct debits with property date matching the given value. The parameter value may be either a string for equality matching, or an object for range-like matching criteria.
scheme'SDD_CORE' | 'SDD_B2B' | 'GB_DD_BACS' | 'AUTOGIRO' | 'CH_DD_LSV' | 'CH_DD_BDD'
Direct debit payment scheme. Choose among: <ul>
<li><code>SDD_CORE</code> (<a href="https://www.europeanpaymentscouncil.eu/what-we-do/epc-payment-schemes/sepa-direct-debit/sepa-direct-debit-core-rulebook-and-implementation">SEPA Direct Debit Core</a>)</li> <li><code>SDD_B2B</code> (<a href="https://www.europeanpaymentscouncil.eu/what-we-do/epc-payment-schemes/sepa-direct-debit/sepa-direct-debit-b2b-rulebook-and-implementation">SEPA Direct Debit B2B</a>)</li> <li><code>GB_DD_BACS</code> (UK <a href="https://www.bacs.co.uk">BACS</a> Direct Debit)</li> <li><code>AUTOGIRO</code> (Swedish <a href="https://www.bankgirot.se/autogiro">Bg AutoGiro</a>)</li> <li><code>CH_DD_LSV</code> (Swiss <a href="https://www.six-group.com/en/products-services/banking-services/billing-and-payments/direct-debits.html">Direct Debit LSV+</a>)</li> <li><code>CH_DD_BDD</code> (Swiss <a href="https://www.six-group.com/en/products-services/banking-services/billing-and-payments/direct-debits.html">Direct Debit BDD</a>)</li> </ul>Example:SDD_CORE
Include only direct debits with the given direct debit scheme.
batchIdstring
Include only direct debits that are part of the payment batch with the given batch ID.
limitinteger
Limit the number of items in resulting query response.
tokenstring
If a query response contains a non-empty nextToken, use that value as token query parameter to continue pagination.
Response
List of direct debits.
Example response
{
"items": [
{
"id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
"organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
"creatorUserId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
"amount": {
"currency": "EUR",
"stringValue": "15.02",
"value": 1502
},
"scheme": "SDD_CORE",
"schemeDetails": {
"instrument": {
"type": "CITI_WORLDLINK",
"citiWorldlinkId": "123456789"
}
},
"date": "2022-05-07",
"status": "SENT",
"statusReason": {
"code": "DS02",
"description": "EBICS VEU/EDS signature cancelled by user"
},
"destination": {
"id": "ac1963d7-fff9-4783-aa1d-92acb7b21a19",
"type": "ACCOUNT",
"organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
"market": "DE",
"currency": "EUR",
"identifiers": [
{
"market": "DE",
"type": "IBAN",
"number": "DE89370400440532013000"
}
],
"routing": [
{
"type": "BIC",
"number": "COBADEFFXXX"
}
]
},
"destinationHolder": {
"type": "ENTITY",
"id": "29a4555b-99b2-4de7-9062-47c8ebc03f56",
"legalName": "Example Company GmbH",
"address": {
"country": "DE",
"city": "Munich",
"postalCode": "123456"
}
},
"source": {
"id": "31d593d7-fff9-4783-aa1d-92acb7b21a19",
"organizationId": "605e26fc-4fce-495a-a92f-2c3592d7287e",
"market": "GB",
"type": "EXTERNAL_ACCOUNT",
"identifiers": [
{
"type": "IBAN",
"market": "GB",
"number": "GB33BUKB20201555555555"
}
],
"routing": [
{
"type": "BIC",
"number": "BUKBGB22XXX"
}
]
},
"sourceHolder": {
"type": "ENTITY",
"id": "29a4555b-99b2-4de7-9062-47c8ebc03f56",
"legalName": "Example Company GmbH",
"address": {
"country": "DE",
"city": "Munich",
"postalCode": "123456"
}
},
"mandate": {
"id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
"signatureDate": "2022-05-07",
"version": 1
},
"approvalSteps": [
{
"id": "735c7b8c-ef29-456a-8caf-113be117d131",
"status": "APPROVED",
"approver": {
"id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
"username": "john.smith@example.com",
"name": "John Smith",
"roleId": "2a1e16eb-2f83-4597-99e2-cffbc4311df2"
}
}
],
"attachedTransactions": [
{
"type": "TRANSACTION",
"id": "27abf7cb-3867-4119-bfa7-ee3fb667ecf3"
}
],
"categoryPurpose": "SALA",
"chargeBearer": "SHARED",
"connectionInstructionId": "c1d6502c-07c7-4c77-bee5-963f9464c7d8",
"batch": {
"id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
"treatment": "INDIVIDUAL_PAYMENTS"
},
"paymentScheduleId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
"etag": "version:3",
"externalId": "walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl",
"metadata": {
"my_metadata_key": "2a9a79b9-601c-449b-aa05-432f41dbbc4a"
},
"version": 1,
"created": "2022-05-04T18:31:12.889104898Z",
"updated": "2022-05-04T18:47:32.213842599Z"
}
],
"nextToken": "eyIxIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
"token": "eyIwIjogIlRoaXMgaXMgYSBkdW1teSBwYWdpbmF0aW9uIHRva2VuLiJ9",
"limit": 100
}