Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Current »

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 create token request.

Once a paylink is processed i.e. payment is done using that link, it can’t be used again to perform another transaction.

Resources

POST /paylink/v1/paylinks
GET /paylink/v1/paylinks/{id}
GET /paylink/v1/paylinks
PATCH /paylink/v1/paylinks/{id}
DELETE /paylink/v1/paylinks/{id}
POST https://<notification_url>

POST /paylink/v1/paylinks

Headers

Content-Type string
Content type.

Authorization string
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 

full_name string
Customer full name.

email string
Customer email.

mobile_number string
Customer mobile number.

transaction_unique string
Unique transaction string.

is_decide_amount boolean
If customer will decide amount:

  • true

  • false

amount float
Transaction amount.

reminder boolean optional
If reminder will be sent to customer:

  • true

  • false (default value)

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

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

  • days

  • week

notes string 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 (optional)
GET URL on your domain, where Blink will send transaction details when the transaction is done e.g. https://mydomain.com/return.

Request

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,
    "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

HTTP/1.1 201 Created
Content-Type: application/json

{
    "id": 123,
    "paylink_url": "https://secure.blinkpayment.co.uk/secondstore/l/5jkigj",
    "transaction_unique": "fyr7894"
}

Get details of a specific paylink using id.

GET /paylink/v1/paylinks/{id}

Headers

Content-Type string
Content type.

Authorization string
Access token generated from create token request.

Request

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

Response

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.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"
}

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-Type string
Content type.

Authorization string
Access token generated from create token request.

Query parameters

status string
Paylink status

customer_name string
Customer name.

amount float
Amount

amount_gt float
Amount should be greater than specified value

amount_lt float
Amount should be less than specified value

Request

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

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": "https://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"
  }
]

PATCH /paylink/v1/paylinks/{id}

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

Headers

Content-Type string
Content type.

Authorization string
Access token generated from create token request.

Attributes

email string (optional)
Email address

mobile_number interger (optional)
Customer mobile number

status string (optional)
Paylink status

Request

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

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

Response

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

{
    "id": 123,
    "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"
}

DELETE /paylink/v1/paylinks/{id}

Delete a specific paylink using it’s id.

Headers

Content-Type string
Content type.

Authorization string
Access token generated from create token request.

Request

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

Response

HTTP/1.1 204 No Content

POST https://<notification_url>

Headers

Content-Type string
Content type is JSON.

Attributes

transaction_id string
Transaction id.

status string
The new status of the transaction.

note string
Notification note.

Request

POST https://my_domain/notification HTTP/1.1
Content-Type: application/json

{
    "transaction_id": "BL-****",
    "status": "Paid",
    "note": "Payment successful"
}

Response

HTTP/1.1 200 OK

POST /paylink/v1/paylinks/{paylink_id}/notifications

Headers

Content-Type string
Content type.

Authorization string
Access token generated from create token request.

Attributes

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

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

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

Request

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

{
    "send_sms": true,
    "send_email": true
}

Response

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

{
    "message": "Notification sent"
}

  • No labels