API Reference

Fetch a direct debit

GET/direct_debits/{id_or_reference}

Query Parameters

id_or_referencestring

ID or reference of the direct debit

Request

curl
curl https://gateway.pmnts-sandbox.io/v1.0/direct_debits/071-DD-ULX5DGSW -u TEST:TEST

Response

200Result
json
{
  "successful": true,
  "response": {
  "id": "071-DD-ULX5DGSW",
  "amount": 10,
  "bsb": "083-832",
  "account_number": "181843123",
  "account_name": "James Smith",
  "description": "test",
  "reference": "RMT1636366032",
  "date": "2018-09-14",
  "process_date": null,
  "status": "New",
  "result": null,
  "metadata": null
  },
  "errors": [],
  "test": true
}
404Result
json
{
  "successful": false,
  "response": {},
  "errors": [
  "Could not find Direct Entry"
  ],
  "test": true
}