API Reference
Client PortalAPI StatusWebsite

List Direct Debit Instructions

get
https://www.bankingcircleconnect.com/api/v1/reports/customer-payment-status-report

The Customer Payment Status Report provides information on the processing status of previously submitted payment or direct debit instructions.
It informs whether the individual transaction has been accepted, rejected, or is pending processing.

Query Params
boolean

Whether to include the transaction details in the response. Defaults to false.

string

Status of Direct Debit Instructions to retrieve. If not provided, no status filtering is applied.

instructionUetrs
array of uuids

Instruction Id filter. Optional.

instructionUetrs
accountIds
array of uuids

Account Id filter. Optional.

accountIds
int32

Max number of records to return per page.

Must be bigger than 0 and less than or equal to 1000. Default is 100.

Cannot be used together with Cursor.

string

Order of the records returned. Possible values:

  • 'DESC' (Default)

  • 'ASC'

Cannot be used together with Cursor.

string

A cursor used to fetch the next or previous page of results.

Cannot be used with any other parameters except Direction.

string

The direction of traversal when using Cursor. Possible values:

  • 'NEXT'

  • 'PREV'

Required when using Cursor.

Responses

Updated 14 days ago

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json

Updated 14 days ago