| Anchor | ||||
|---|---|---|---|---|
|
Get API Keys
Before using you will need to login to Blink and get the API key and secret key for your Blink page:
1.1 Open https://secure.blinkpayment.co.uk
1.2 Scroll down to API Credentials on your dashboard
1.3 Select the Blink page
1.4 You should see the API key and secret key for the selected page.
NOTE: If you do not see the keys, then please contact Blink support team to set up the API keys for you.
| Anchor | ||||
|---|---|---|---|---|
|
Endpoints
Method | Endpoint | Description |
|---|---|---|
POST | tokens | Create an access token |
POST | intents | Create an intent |
GET | intents/{id} | Return the intent |
PATCH | intents/{id} | Update the intent |
POST | elements | Return required details to populate payment form |
POST | creditcards | Processes credit card payment and redirects to |
GET | transactions/{id} | Returns transactions details |
POST | {notification_url} | Redirects to notification URL |
POST | directdebits | Create customer, their bank account, mandate and payment request using the customer details and returns to user defined return URL after successful payment request creation |
POST | openbankings | Process open banking request with transaction details. On success it will provide the bank server redirect URL. |
| Anchor | ||||
|---|---|---|---|---|
|
Errors
Name | Description |
|---|---|
200 OK | Everything worked as expected. |
400 Bad Request | Often due to missing a required parameter. |
401 Unauthorized | No valid API key provided. |
402 Request failed | The parameters were valid but the request failed. |
403 Forbidden | The API key doesn't have permissions to perform the request. |
404 Not Found | The requested resource doesn't exist. |
409 - Conflict | Conflicts with another request (perhaps using the same key). |
429 - Too Many Requests | Too many requests hit the API too quickly. |
500 | Something went wrong |
| Anchor | ||||
|---|---|---|---|---|
|
Markup Conventions
Item | Description | ||
|---|---|---|---|
| Code in the body of test | ||
| Code block | ||
| Variable in code | ||
GET | Get method | ||
POST | Post method | ||
PUT | Put method | ||
PATCH | Patch method | ||
DELETE | Delete method | ||
(optional) | All attributes are mandatory, unless identified optional keyword. |