Get direct debits

get

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

API endpoint to get direct debits by filter.

Query Params

accountId

string

The accountId the direct debit.

paymentId

string

The identifier of the direct debit.

batchId

string

The batchId number assigned by neo, to all transactions received in particular request.

outgoingMessageId

string

The identifier of the outgoing message.

incomingMessageId

string

The identifier of the incoming message.

outgoingRequestId

string

The requestId of the request made by using Request direct debits.

incomingRequestId

string

The requestId of the payments reconciliation.

requestedCollectionDateFrom

string

The date that the direct debit will be collected.

requestedCollectionDateTo

string

The date that the direct debit will be collected.

state

string

The state of the direct debit transaction.

reasonCode

string

SEPA reject/return reason code received in the incoming camt.053 message.

pageNumber

int32

pageSize

int32

Headers

accept-version

string

required

Defaults to v1

API versioning

x-request-id

uuid

required

Defaults to 39c354cc-ba40-4939-b43a-28e94de8430f

Correlates HTTP requests between a client and server

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

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

200OK

401Unauthorized

403Forbidden

422Unprocessable Content