Create outbound Direct Debit

post

http://localhost:8080/v1/direct-debits

Body Params

amount

number

required

Value of the Direct Debit transfer, to 2 decimal places

description

string

required

length between 1 and 18

Description on Direct Debit transfer, maximum 18 characters in length

idempotencyKey

uuid

required

Unique value (UUID) used to identify this request and used to recognise any subsequent retries

recipientAccountNumber

string

required

Account Number of Account receiving Direct Debit instruction (account to be debited), 5-9 digits in length

recipientBsb

string

required

BSB (Bank State Branch) of Account receiving Direct Debit instruction (account to be debited), 6 digits in length

recipientName

string

required

length between 1 and 32

Name on the Account receiving Direct Debit instruction (account to be debited)

senderAccountNumber

string

required

Account Number of Account sending Direct Debit instruction (account to be credited), 5-9 digits in length

senderBsb

string

required

BSB (Bank State Branch) of Account sending Direct Debit instruction (account to be credited), 6 digits in length

senderName

string

required

length between 1 and 16

Name on the Account sending Direct Debit instruction (account to be credited)

transactionId

uuid

required

Unique identifier (UUID) of the Transaction

Responses

Language

Loading…

Response

Choose an example:

application/json

200Success

400Bad Request

403Forbidden

422Unprocessable Entity

500Internal Server Error

501Not Implemented