FAfatzebra

Create a direct debit

Changed on
post/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

Headers

Content-Typestring

Request body

descriptionstring required

Must be unique. Max 18 characters, allowed chars are A-Z, 0-9, period, hyphen, ampersand, and underscore. It is recommended you make this descriptive for your customer - e.g. Invoice ABCD123.

amountnumber float required

Amount. Minimum 0.01, positive only.

bsbstring required

The source account's BSB number. Format: ###-###

account_namestring required

The source account name. Max 32 characters.

account_numberstring required

The source account number. Max 9 digits.

account_typestring

Type of the source bank account.

datestring date

Date of the direct debit. Optional but recommended. Defaults to the next processing period (current day if before 17:00, next day if after). Must be in the future.

referencestring

Unique reference

metadataobject

Metadata of the direct debit

bank_accountstring

The Fat Zebra bank account ID to be used in place of account_name, account_number, and bsb. If bank_account is supplied, the other attributes should be omitted.

Response

201

successfulboolean
testboolean

Example response

{
  "successful": true,
  "response": {
    "id": "071-DD-L4M3SN0E",
    "amount": 42,
    "bsb": "123-123",
    "account_number": "012345678",
    "account_name": "Test",
    "description": "Confirmation",
    "reference": "071-DD-L4M3SN0E",
    "date": "2018-09-14",
    "status": "New"
  },
  "test": true
}

Changes