List direct debits

Changed on
get/direct_debits

Request

  • Base URL
    https://gateway.pmnts-sandbox.io/v1.0
  • URL
    https://gateway.pmnts-sandbox.io/v1.0/direct_debits
  • Auth
    HTTP basic

Query parameters

offsetinteger

Page number to return

limitinteger

Max number of results to return

fromstring date

Lower bound for the time at which the direct debit was created

tostring date

Upper bound for the time at which the direct debit was created

Headers

Content-Typestring

Response

200

successfulboolean
testboolean
recordsinteger
total_recordsinteger
pageinteger
total_pagesinteger

Example response

{
  "successful": true,
  "response": [
    {
      "id": "071-DD-RDOR6I3K",
      "amount": 10,
      "bsb": "083-832",
      "account_number": "181843123",
      "account_name": "James Smith",
      "description": "test",
      "reference": "RMT1636366033",
      "date": "2018-09-21",
      "status": "New"
    }
  ],
  "test": true,
  "records": 2,
  "total_records": 16582,
  "page": 1,
  "total_pages": 8291
}

Changes