Interfaces / BPAY

Get controls for an existing batch

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

GET

/gb/interface/exports/bpay/controls/{bpay_id}

curl --request GET \
  --url 'https://api.catch-e.com/gb/interface/exports/bpay/controls/{bpay_id}?bank_account_bpay_mapping_id=%3Cstring%3E' \
  --header 'Authorization: <api-key>'

{
  "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

Path Parameters

bpay_idstringrequired

BPAY interface export id

Maximum string length: 10

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

Query Parameters

bank_account_bpay_mapping_idstringquery

Bank Account Bpay Mapping Id

Maximum string length: 20

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

Response

Success

invoicesnumber

itemsnumber

totalnumber

Still need help? Ask the team