Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

A webhook is an event driven notification from Blink to your system. Webhooks are also known as callback or return URL.

The return webhook is triggered when the payment has been processed and the notification webhook is triggered when the transaction status is changed in Blink.

The user is redirected to the return_url or notification_url specified in the intent request.

The return webook webhook passes a paramater parameter called res in the URL. This res is the transaction_id in base64_encoded format, which you need decode using base64_decoded.


Anchor
return-webhook
return-webhook

Return Webhook

POST GET https://<return_url>?res=12345

Headers

Content-Typestring
Content type.Authorizationstring
Access token generated from create token request.

Attributes

transaction_idstring
Transaction ID.statusstring
Status.notestring
Note.transaction_id=BL-002A12345&status=Pending%2BSubmission&note=Pending%2BSubmission&merchant_data=%257B%2522order_id%2522%253A%2522dd-12345678%2522%257D

Request

Code Block
POSTGET https://my_domain/return?res=QkwtMDBGN0Q…..1Ng%3D%3Dtransaction_id=BL-002A12345&status=Pending%2BSubmission&note=Pending%2BSubmission&merchant_data=%257B%2522order_id%2522%253A%2522dd-12345678%2522%257D HTTP/1.1
Content-Type: application/json

Response

Code Block
HTTP/1.1 200 OK
Content-Type: application/json

Anchor
notification-webhook
notification-webhook

Notification Webhook

POST https://v1/pay/notification<notification_url>

Headers

Content-Typestring
Content type is JSON.AuthorizationstringAccess token generated from create token request.

Attributes

transaction_idstring
Transaction id.

statusstring
StatusThe new status of the transaction.

notestring
NoteNotification note.

merchant_datajson
JSON string of all the optional data sent by the merchant.

Request

Code Block
POST https://secure.blinkpayment.co.uk/api/v1/pay/my_domain/notification HTTP/1.1
Content-Type: application/json
api-key:
eyJ0eXAiOiJKV1QiLCJhbG...
secret-key: eyJ0eXAiOiJKV1QiLCJhbG...

{
    "transaction_id": "BL-****",
    "status": "Captured",
    "note": "Status changes to Captured",
    "merchant_data": "{'{
      "order_id'": 1234567
    }"
}

Response

Code Block
HTTP/1.1 200 OK
Content-Type: application/json

{
    "message": "Success"
}