FAfatzebra

Update a direct debit

Changed on

A direct debit can be updated if it has a status of New. Once direct debits have been submitted to the financial institution, they are locked and can only be updated by the Fat Zebra system.

put/direct_debits/{id}

Request

  • Base URL
    https://gateway.pmnts-sandbox.io/v1.0
  • URL
    https://gateway.pmnts-sandbox.io/v1.0/direct_debits/{id}
  • Auth
    HTTP basic

Path parameters

idstring required

ID of the direct debit

Headers

Content-Typestring

Request body

descriptionstring

Max 18 characters, allowed chars are A-Z, 0-9, period, hyphen, ampersand, and underscore.

amountnumber float

Amount. Minimum 0.01, positive only.

bsbstring

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

account_namestring

The source account name. Max 32 characters.

account_numberstring

The source account number. Max 9 digits.

Response

200

successfulboolean
testboolean

Example response

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

Changes