Create a direct debit

post

https://gateway.pmnts-sandbox.io/v1.0/direct_debits

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

description

string

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.

amount

float

required

Amount. Minimum 0.01, positive only.

bsb

string

required

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

account_name

string

required

The source account name. Max 32 characters.

account_number

string

required

The source account number. Max 9 digits.

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.

reference

string

Unique reference

bank_account

string

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.

Headers

Content-Type

string

Defaults to application/json

Responses

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201201

422422