Page Comparison

Authenticate requests using HTTP Basic Auth by adding a bearer token to the header, e.g. Authentication: Bearer {{access_token}}. You can get the {{access_token}} from the

Anchor
create-paylink
create-paylink

Create paylink

POST /paylink/v1/paylinks

Headers

Content-Typestring
Content type.

Authorizationstring
Access token generated from create token request.

Attributes

payment_method array

Can be one or more of the following:

credit-card
direct-debit
open-banking

transaction_type string
Can be one of the following:

SALE
PREAUTH
VERIFY CARD

currency string
Three letter currency code (ISO 4217) e.g USD, GBP.

full_namestring
Customer full name.

emailstring
Customer email.

mobile_numberstring
Customer mobile number.

transaction_uniquestring
Unique transaction string.

is_decide_amountboolean
If customer will decide amount:

true
false

amountfloat
Transaction amount.

reminderboolean optional
If reminder will be sent to customer:

true
false (default value)

reminder_interval_countinteger optional
If reminder is true, then need to mention the number of days/weeks

reminder_interval_frequencystring optional
If reminder is true, then need to mention the interval frequency. It can be one of the following:

days
week

notesstring optional
Add any note to describe the Paylink request to the customer.

notification_url string
POST URL on your domain, where Blink will send status updates when the transaction status is changed e.g. https://mydomain.com/notification.

redirect_url string
POST string (optional)
GET URL on your domain, where Blink will send status updates transaction details when the transaction status is changed done e.g. https://mydomain.com/notificationreturn.

Request

Code Block

POST https://secure.blinkpayment.co.uk/api/paylink/v1/paylinks HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...

{
    "payment_method": ["credit-card","open-banking"],
    "transaction_type": "SALE",
    "full_name": "Test Developer",
    "email": "testdeveloper@gmail.com",
    "mobile_number": "9123908567",
    "transaction_unique": "fyr7894",
    "is_decide_amount": true,
    "currency": "GBP",
    "amount": 1.00,
    "reminder": true,
    "reminder_interval_count": 2,
    "reminder_interval_frequency": "days",
    "notes": "test note",
    "notification_url": "https://mydomain.com/notification",
    "redirect_url": "https://mydomain.com/notification"
}

Response

Code Block
HTTP/1.1 201 Created Content-Type: application/json { "id": 123, "paylink_url": "https://secure.blinkpayment.co.uk/secondstore/l/5jkigj", "transaction_unique": "fyr7894" }

Anchor
get-paylink
get-paylink

Get paylink

Get details of a specific paylink using id.

GET /paylink/v1/paylinks/{id}

Headers

Content-Typestring
Content type.

Authorizationstring
Access token generated from create token request.

Request

Code Block
GET https://secure.blinkpayment.co.uk/api/paylink/v1/paylinks/123 HTTP/1.1 Content-Type: application/json Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...

Response

Code Block

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

{
    "id": 123,
    "paylink_url": 123"https://dev.blinkpayment.co.uk/codatdev/l/asdhgl8",
    "status": "Unpaid",
    "created_by": "Test developer",
    "amount": 1.00,
    "currency": "GBP",
    "transaction_type": "SALE",
    "customer_name": "Demo Customer",
    "customer_email": "demo123@gmail.com",
    "phone_number": "2374993932",
    "payment_method": ["credt-card","open-banking"],
    "is_decide_amount": true,
    "notes": "test",
    "redirect_url": "https://mydomain.com/notification"
}

Anchor
get-paylinks
get-paylinks

Get paylinks

Get details of all the paylinks created by the same merchant. Using the below query parameters results can be filtered.

GET /paylink/v1/paylinks

Headers

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

Authorizationstring
Access token generated from create token request.

Query parameters

statusstring
Paylink status

customer_namestring
Customer name.

amountfloat
Amount

amount_gtfloat
Amount should be greater than specified value

amount_ltfloat
Amount should be less than specified value

Request

Code Block
GET https://secure.blinkpayment.co.uk/api/paylink/v1/paylinks?status=unpaid&customer_name=test_developer HTTP/1.1 Content-Type: application/json Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...

Response

Code Block

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

[
  {
    "id": 123,
    "paylink_url": "https://dev.blinkpayment.co.uk/codatdev/l/asdhgl8",
    "status": "Unpaid",
    "created_by": "Test developer",
    "amount": 1,
    "currency": "GBP",
    "transaction_type": "SALE",
    "customer_name": "Demo Customer",
    "customer_email": "demo123@gmail.com",
    "phone_number": "2374993932",
    "payment_method": [
      "credt-card",
      "open-banking"
    ],
    "is_decide_amount": true,
    "notes": "test",
    "redirect_url": "testhttps://mydomain.com/notification"
  },
  {
    "id": 124,
    "paylink_url": "https://dev.blinkpayment.co.uk/codatdev/l/asdhgl8",
    "status": "Unpaid",
    "created_by": "Test developer",
    "amount": 1.1,
    "currency": "GBP",
    "transaction_type": "SALE",
    "customer_name": "Demo Customer",
    "customer_email": "demo123@gmail.com",
    "phone_number": "2374993932",
    "payment_method": [
      "open-banking"
    ],
    "is_decide_amount": true,
    "notes": "test2",
    "redirect_url": "https://mydomain.com/notification"
  }
]

Anchor
update-paylink
update-paylink

Update paylinks

PATCH /paylink/v1/paylinks/{id}

Update any data some specific data (email, mobile number) associated with the paylink until the link is usedpaylink until the link is used. If a paylink is not paid then it’s status can be changed to ‘Cancelled’.

Headers

Content-Typestring
Content type.

Authorizationstring
Access token generated from create token request.

Attributesnotification_url

emailstring (optional)
Email address

mobile_numberinterger (optional)
Customer mobile number

statusstring (optional)
Notification url.Paylink status

Request

Code Block

PATCH https://secure.blinkpayment.co.uk/api/paylink/v1/paylinks/{id} /paylinks/{id} HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...

{
  "email": "testdemo@yopmail.com"
}

Response

Code Block
HTTP/1.1 200 OK Content-Type: application/json Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG... { { "id": 123, "status": "Unpaid", "notificationcreated_urlby": "https://mydomain.com/notification" }

Response

Code Block

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

{Test developer",
    "amount": 1.00,
    "currency": "GBP",
    "idtransaction_type": 123"SALE",
    "statuscustomer_name": "UnpaidDemo Customer",
    "createdcustomer_byemail": "Test developerdemo123@gmail.com",
    "amountphone_number": 1.00"2374993932",
    "currencypayment_method": "GBP"["credt-card","open-banking"],
    "transactionis_decide_typeamount": "SALE"true,
    "customer_namenotes": "Demo Customertest",
    "customerredirect_emailurl": "demo123@gmail.com",
    "phone_number": "2374993932",
    "payment_method": ["credt-card","open-banking"],
    "is_decide_amount": true,
    "notes": "test"
}

Anchordelete-paylinkdelete-paylinkDelete paylink

DELETE /paylink/v1/paylinks/{id}

Delete a specific paylink using it’s id.

Headers

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

Request

Code Block
DELETE https://secure.blinkpayment.co.uk/api/paylink/v1/paylinks/{id} HTTP/1.1 Content-Type: application/json Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...https://mydomain.com/notification" }

Anchor
delete-paylink
delete-paylink

Delete paylink

DELETE /paylink/v1/paylinks/{id}

Delete a specific paylink using it’s id.

Headers

Content-Typestring
Content type.

Authorizationstring
Access token generated from create token request.

Request

Code Block
DELETE https://secure.blinkpayment.co.uk/api/paylink/v1/paylinks/{id} HTTP/1.1 Content-Type: application/json Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...

Response

Code Block
HTTP/1.1 204 No Content

Anchor
notification-webhook
notification-webhook

Notification webhook

POST https://<notification_url>

Headers

Content-Typestring
Content type is JSON.

Attributes

transaction_idstring
Transaction id.

statusstring
The new status of the transaction.

notestring
Notification note.

Request

Code Block
POST https://my_domain/notification HTTP/1.1 Content-Type: application/json { "transaction_id": "BL-****", "status": "Paid", "note": "Payment successful" }

Response

Code Block
HTTP/1.1 204200 No ContentOK

Anchor
paylink-notification
paylink-

webhook

notification

-webhook

Paylink Notification

webhook

POST https://<notification_url>/paylink/v1/paylinks/{paylink_id}/notifications

Headers

Content-Typestring
Content type is JSONContent type.

Authorizationstring
Access token generated from create token request.

Attributes

transactionsend_idstring
Transaction id.statusstring
The new status of the transaction.notestring
Notification note.

Request

Code BlockPOST https://my_domain

smsboolean
If send sms is true , it will sent notification through sms.

send_emailboolean
If send email is true , it will sent notification through email.

If both are true, then email and sms will be sent.

Request

Code Block

POST https://secure.blinkpayment.co.uk/api/paylink/v1/paylinks/{paylink_id}/notification HTTP/1.1
Content-Type: application/json

{
    "transactionsend_idsms": "BL-****"true,
    "statussend_email": "Paid",
    "note": "Payment successful"
true
}

Response

Code Block
HTTP/1.1 200 OK Content-Type: application/json { "message": "Notification sent" }

Versions Compared

Old Version 5

New Version Current

Key

Anchor
create-paylink
create-paylink

Create paylink

Anchor
get-paylink
get-paylink

Get paylink

Anchor
get-paylinks
get-paylinks

Get paylinks

Anchor
update-paylink
update-paylink

Update paylinks

Anchor
delete-paylink
delete-paylink

Delete paylink

Anchor
notification-webhook
notification-webhook

Notification webhook

Anchor
paylink-notification
paylink-

notification

Paylink Notification

Page Comparison

Versions Compared

Old Version 5

New Version Current

Key

Anchorcreate-paylinkcreate-paylinkCreate paylink

Anchorget-paylinkget-paylinkGet paylink

Anchorget-paylinksget-paylinksGet paylinks

Anchorupdate-paylinkupdate-paylinkUpdate paylinks

Anchordelete-paylinkdelete-paylinkDelete paylink

Anchornotification-webhooknotification-webhookNotification webhook

Anchorpaylink-notificationpaylink-

notification

Paylink Notification

Anchor
create-paylink
create-paylink

Create paylink

Anchor
get-paylink
get-paylink

Get paylink

Anchor
get-paylinks
get-paylinks

Get paylinks

Anchor
update-paylink
update-paylink

Update paylinks

Anchor
delete-paylink
delete-paylink

Delete paylink

Anchor
notification-webhook
notification-webhook

Notification webhook

Anchor
paylink-notification
paylink-