A customer completed an access request

POST

Sent to each webhook destination. Verify Banklink-Signature before trusting the body. Respond with any 2xx; other responses and timeouts (30 s) are recorded as a delivery failure.

Authorizations

• bearerAuth

Parameters

Header Parameters

Banklink-Signature

required

string

Example

t=1790000000,v1=5257a869e7ecebeda32affa62cdca3fa51cad7e77a0e56ff536d0ce8e108d8bd

t=<unix seconds>,v1=<hex HMAC-SHA256 of {t}.{raw body}>. Two v1 values during a secret rotation.

Banklink-Event

required

string

Allowed value: access_request.completed

Banklink-Delivery

required

string format: uuid

Unique id for this delivery. Use it to ignore duplicates.

Request Body^required

Media typeapplication/json

object

event

required

string

Allowed values: link_request.completed access_request.completed pulse.delivered

request_type

string

Allowed values: link_request access_request

link_request_id

string format: uuid

access_request_id

string format: uuid

pulse_id

string format: uuid

reference

The reference you set when creating the request

string

account_number

string | null

transactions

required

Array<object>

object

id

string

date

string format: date

description

string

amount

number

currency

string

Example

ZAR

direction

string

Allowed values: debit credit

balance

number | null

reference

string | null

Responses

200

Any 2xx acknowledges the delivery