Request direct debits

post

https://apim.demo01.my.fivedegrees.cloud/sbx/cash-accounts/request-direct-debits

API endpoint to request a list of direct debits.

Body Params

The direct debits request data

requestedCollectionDate

string

required

length ≥ 1

Date when the amount needs to be collected from the debtor account. Cannot be in the past.
Note: The inputter is responsible for providing the correct date, according to the SDD rule book.

sequenceType

string

required

length ≥ 1

The following direct debit (sequence types) are in scope:
RCUR: for first and subsequent Direct Debits of a recurrent series.
OOFF: for a one-off Direct Debit.

transactions

array of objects | null

transactions

Headers

accept-version

string

required

Defaults to v1

API versioning

x-request-id

uuid

required

Defaults to 3b7d2fcf-6d62-431b-b111-a5f4b5fcff57

Correlates HTTP requests between a client and server

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

202

Accepted

500

Internal Server Error

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

400Bad Request

401Unauthorized

403Forbidden

422Unprocessable Content