Create Ledger Account

POST

https://api.mpay.com.au/ledger/v1/create

Create a new, active ledger with a linked automatcher. This endpoint also allows you to link an existing automatcher to the ledger by passing an existing bankAccountNumber. Optionally, you can also specify a BSB. If no existing automatcher is linked, a new one will be created.

If you wish to link a PayID to the automatcher you will need to use the PayID endpoints.

The API response will vary based on whether a new automatcher is being created, or an existing automatcher is being linked to the ledger account. Automatcher activation is an asynchronous process that can take a few minutes to complete. If a new or inactive automatcher is linked, the API will respond with isActive: false, and the statusDescription: 'Account is being setup for Npp. Please allow a few minutes for the account to become active'.

acceptstringGenerated from available response content types

bodyobject

200Successful response.

400Bad Request - the request was malformed or contained invalid parameters.

401Unauthorized - authentication failed, or the API key was missing or invalid.

500Internal Server Error - an unexpected error occurred while processing the request.

curl --request POST \
     --url https://api.mpay.com.au/ledger/v1/create \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "ledgerUniqueReference": "CUST-000123",
     "name": "Acme Pty Ltd",
     "ABN": "51824753556",
     "description": "Primary settlement ledger for Acme Pty Ltd",
     "automatcherDetails": {
     "bsb": "012-345",
     "bankAccountNumber": "123456789",
     "bankAccountName": "Acme Pty Ltd",
     "clientUniqueId": "93bf57eb1e2c42cf8101509b4356741e",
     "subMerchantId": "93bf57eb1e2c42cf8101509b4356741e",
     "akaNames": [
     "Acme Trading",
     "Acme Group"
     ]
     }
     }'