Interfaces / BPAY

Create next BPAY batch

This method requires the InterfaceExports:BpayBatchCreate permission to be associated with your role.

POST

/gb/interface/exports/bpay

curl --request POST \
  --url https://api.catch-e.com/gb/interface/exports/bpay \
  --header 'Authorization: <api-key>' \
  --header 'Audit-User-Id: <string>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'bank_account_bpay_mapping_id=%3Cstring%3E'

{
  "bpay_id": 123456,
  "invoices": 2,
  "items": 2,
  "total": 1234.56
}

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Headers

Audit-User-Idstringheader

(Optional) User Id to use for audit purposes. This header requires the Audit:UserIdOverride permission to be associated with your role.

Maximum string length: 5

Pattern: ^[1-9]{1}[0-9]*$

Body

bank_account_bpay_mapping_idstringrequired

Bank Account Bpay Mapping Id

Maximum string length: 20

Pattern: ^[1-9]{1}[0-9]*$

Response

Success

bpay_idstring

invoicesnumber

itemsnumber

totalnumber

Still need help? Ask the team