Interfaces

Get BECS disbursements batch

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

GET

/gb/interface/exports/becs/disbursements/{becs_id}

curl --request GET \
  --url https://api.catch-e.com/gb/interface/exports/becs/disbursements/{becs_id} \
  --header 'Authorization: <api-key>'

{
  "becs_id": "123456",
  "uri": "https://catch-e-interface-exports.s3.ap-southeast-2.amazonaws.com/example/bpay/123456?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ZKIBIA46LLA7H5KN5S4Q%2F20190201%2Fap-southeast-2%2Fs3%2Faws4_request&X-Amz-Date=20190201T045824Z&X-Amz-SignedHeaders=host&X-Amz-Expires=300&X-Amz-Signature=6dcb136a7e0d285419ec8f88602785df41dc0036df8657bbc6e20309d3f3d5ba",
  "uri_expiry": "2023-11-07T05:31:56Z"
}

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

becs_idstringrequired

BECS interface export id

Maximum string length: 10

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

Response

Success

becs_idstring

Example: 123456

uristring

Example:

https://catch-e-interface-exports.s3.ap-southeast-2.amazonaws.com/example/bpay/123456?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ZKIBIA46LLA7H5KN5S4Q%2F20190201%2Fap-southeast-2%2Fs3%2Faws4_request&X-Amz-Date=20190201T045824Z&X-Amz-SignedHeaders=host&X-Amz-Expires=300&X-Amz-Signature=6dcb136a7e0d285419ec8f88602785df41dc0036df8657bbc6e20309d3f3d5ba

uri_expirystring

Still need help? Ask the team