Open banking payment webhook
Webhook that is called when an open banking payment reaches a final status. It is sent once per payment. This endpoint should be implemented by clients of the Grid API.
Authentication
The webhook includes a signature in the X-Grid-Signature header that allows you to verify that the webhook was sent by Grid.
To verify the signature:
- Get the Grid public key provided to you during integration
- Decode the base64 signature from the header
- Create a SHA-256 hash of the request body
- Verify the signature using the public key and the hash
If the signature verification succeeds, the webhook is authentic. If not, it should be rejected.
Event types
OPEN_BANKING_PAYMENT.COMPLETED— The customer’s bank sent the payment. The credit is an incoming transaction with its ownINCOMING_PAYMENTwebhook. It can arrive just after this event, sodata.incomingTransactionIdmay be absent here;GETthe payment to read it once the credit lands.OPEN_BANKING_PAYMENT.FAILED— The customer cancelled, or their bank refused the payment. No funds move.OPEN_BANKING_PAYMENT.EXPIRED— The customer did not approve the payment beforeexpiresAt. No funds move.
Authorizations
Secp256r1 (P-256) asymmetric signature of the webhook payload, which can be used to verify that the webhook was sent by Grid. To verify the signature:
- Get the Grid public key provided to you during integration
- Decode the base64 signature from the header
- Create a SHA-256 hash of the request body
- Verify the signature using the public key and the hash
If the signature verification succeeds, the webhook is authentic. If not, it should be rejected.
Body
Response
Webhook received successfully