Interfaces / BPAY

Update BPAY batch

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

PUT

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

Update BPAY batch

curl --request PUT \
  --url https://api.catch-e.com/gb/interface/exports/bpay/{bpay_id} \
  --header 'Authorization: <api-key>' \
  --header 'Audit-User-Id: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "notes": "Example note text",
  "status_flag": "exported_ok"
}
'

{
  "detail": "Unauthorized",
  "status": 401,
  "title": "Unauthorized",
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

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]*$

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

JSON payload

notesstring

Example: Example note text

status_flagenum<string>

Available options: pending, exported_ok

Example: exported_ok

Response

Success

Still need help? Ask the team