| Anchor | ||||
|---|---|---|---|---|
|
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-carddirect-debitopen-banking
transaction_type string
Can be one of the following:
SALEPREAUTHVERIFY CARD
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:
truefalse
amountfloat
Transaction amount.
reminderboolean optional
If reminder will be sent to customer:
truefalse(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:
daysweek
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.
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,
"amount": 1.00,
"reminder": true,
"reminder_interval_count": 2,
"reminder_interval_frequency": "days",
"notes": "test note",
"notification_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 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,
"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"
} |
| Anchor | ||||
|---|---|---|---|---|
|
Get paylinks
Get details of all the paylinks created by the same merchant.
GET /paylink/v1/paylinks
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 HTTP/1.1 Content-Type: application/json Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG... |
Response
| Code Block |
|---|
HTTP/1.1 200 OK
Content-Type: application/json
[
{
"id": 123,
"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"
},
{
"id": 124,
"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"
}
] |
| Anchor | ||||
|---|---|---|---|---|
|
Update paylinks
PATCH /paylink/v1/paylinks/{id}
Update any data associated with the paylink until the link is used.
Headers
Content-Typestring
Content type.
Authorizationstring
Access token generated from create token request.
Attributes
notification_urlstring (optional)
Notification url.
Request
| Code Block |
|---|
PATCH https://secure.blinkpayment.co.uk/api/paylink/v1/paylinks/{id} HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...
{
"notification_url": "https://mydomain.com/notification"
} |
Response
| Code Block |
|---|
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"
} |
| Anchor | ||||
|---|---|---|---|---|
|
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
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 200 OK |