Create paylink
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.
- application/json
Request Body
- payment_method string[]
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 integer
Transaction amount.
- reminder boolean
If reminder will be sent to customer:
- true
- false (default value)
- reminder_interval_count integer
If reminder is true, then need to mention the number of days/weeks
- reminder_interval_frequency string
If reminder is true, then need to mention the interval frequency. It can be one of the following:
- days
- week
- notes string
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.
- 201
Response Headers
- application/json
- Schema
- Example (from schema)
- Example
Schema
- id integer
- paylink_url string
- transaction_unique string
{
"id": 0,
"paylink_url": "string",
"transaction_unique": "string"
}
{
"id": 123,
"paylink_url": "https://secure.blinkpayment.co.uk/secondstore/l/5jkigj",
"transaction_unique": "fyr7894"
}