Initiate Direct Debit Payment Request

Create direct debit initiation and process settlement workflow.

Error Codes

CodeStatusReasonWhat to do
PAS_AMT_REQUIRED400Amount is requiredInclude amount in direct debit payload.
PAS_AMT_INVALID400Amount format is invalidUse a valid numeric amount format.
R104422Consent is missing or invalidSet consent_received to "true" and retry.
R101422Amount exceeds allowed thresholdReduce amount and retry.
R801422Similar debit attempted within cooldown periodWait for cooldown window and retry.
R102422Daily spend limit exceededRetry later or reduce amount.
R100422Daily transaction count exceededRetry next day or after account review.
R103422Destination payout not enabledUpdate merchant payout settings or remove destination.
R803422Direct debit initiation failed upstreamRetry; if repeated, contact support with request details.
MOV_INVALID_BANK_ACCOUNT400Bank account does not belong to current institutionCorrect payer account details and retry.
MOV_INVALID_BSB400Invalid BSB numberProvide valid 6-digit BSB and retry.
MOV_REQUEST_TIMEOUT408Request timed outRetry after a short delay.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
direct_debit
object
required

Request payload used to create and initiate direct debit flow.

destination
object

Destination payout account details used when instant payout is enabled.

Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json