Tokens
To authenticate requests, the Blink API uses an api_key and secret_key combination, which is used to obtain an access_token for your session.
HTTP Basic Auth is used for authentication. The access_token should be used via bearer in the header to authenticate all requests, e.g. Authentication: Bearer {{access_token}}.
Access token is expired after 30 minutes. Then, you need to create a new token.
You can manage and renew your keys on the Blink platform. In case you do not see the keys, simply reach out to support to get set up.
It is essential to keep your API keys secure as they hold significant privileges. Refrain from sharing your secret API keys in public areas such as GitHub, client-side code, etc.
All API requests must be made over HTTPS. Requests made over plain HTTP will be unsuccessful. API requests that lack authentication will also fail.
- application/json
Request Body
- api_key string required
256 alpha numeric, obtained through the Blink platform.
- secret_key string required
256 alpha numeric, obtained through the Blink platform.
- payment_api_status boolean
To enable payment API , value should be set to true. This field is optional. If not passed, default value is true.
- send_blink_receipt boolean
To enable Blink receipt feature after any transaction , value should be set to true. This field is optional. If not passed, default value is false.
- address_postcode_required boolean
To fetch address and postcode details of any user for any transaction , value should be set to true. This field is optional. If not passed, default value is false.
- enable_moto_payments boolean
To enable MOTO payment feature for any transaction , value should be set to true. This field is optional. If not passed, default value is false.
- 200
Response Headers
- application/json
- Schema
- Example (from schema)
- Example
Schema
- access_token string
- expired_on string
- payment_types string[]
- currencies string[]
- payment_api_status boolean
- send_blink_receipt boolean
- address_postcode_required boolean
- enable_moto_payments boolean
{
"access_token": "string",
"expired_on": "string",
"payment_types": [
"string"
],
"currencies": [
"string"
],
"payment_api_status": true,
"send_blink_receipt": true,
"address_postcode_required": true,
"enable_moto_payments": true
}
{
"access_token": "eyJ0eXAiOiJKV1QiLCJhbG...",
"expired_on": "2023-01-01T12:00:00Z",
"payment_types": [
"credit-card",
"open-banking",
"direct-debit"
],
"currencies": [
"GBP"
],
"payment_api_status": true,
"send_blink_receipt": true,
"address_postcode_required": true,
"enable_moto_payments": true
}