OPopenpayd

GET /direct-debit

Request

  • Base URL
    https://sandbox.openpayd.com/api
  • URL
    https://sandbox.openpayd.com/api/direct-debit
  • Auth
    API key in header Authorization

Query parameters

status'PENDING' | 'REJECT_REQUESTED' | 'REJECTED' | 'CANCEL_REQUESTED' | 'CANCELLED' | 'FAILED' | 'ACCEPTED' | 'COMPLETED' | 'REVERSE_REQUESTED' | 'REVERSED' | 'REFUND_REQUESTED' | 'REFUNDED'

Filters results by transaction status.

transactionType'DEBIT' | 'CREDIT'

Indicates whether the transaction is a debit or credit.

debitTypes'FIRST' | 'RECURRING' | 'FINAL' | 'ONE_OFF'

Specifies the Direct Debit category.

amountFromnumber float

Returns transactions with an amount greater than or equal to this value.

amountTonumber float

Returns transactions with an amount less than or equal to this value.

pageinteger

Defines which page to return (pages are zero-indexed, starting from 0).

sizeinteger

Sets the number of records returned per page (up to 200 records per page).

Response

idstring
transactionIdstring
shortIdstring
statusstring
accountHolderIdstring
accountIdstring
mandateIdinteger
mandateReferencestring
mandateDateOfSigningstring date
mandateStatusstring
ownerIdinteger
ownerNamestring
ownerAddressLine1string
ownerAddressLine2string
ownerCountrystring
ownerBicstring
ownerIbanstring
ownerInstitutionIdstring
ownerTypestring
debitTypestring
dueDatestring date-time
cutOffTimestring date-time
transactionReferencestring
complianceStatusstring
tenantIdstring
clientDecisionboolean
endToEndReferencestring
friendlyNamestring
transactionTypestring

Changes

No recorded changes to this operation across all 1 revision of this API.