Versions Compared

Old Version 11

changes.mady.by.user Mohsin Shah

Saved on

compared with

New Version 12

changes.mady.by.user Mohsin Shah

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Getting started

Quick links

Get API Keys
Postman
Endpoints
Errors
Markup Conventions

Anchor
get-api-keys
get-api-keys

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.

AnchorpostmanpostmanPostman

Download collection and environment file

  1. Go to the official Blink release page.

  2. Download Source code (zip).

  3. Unzip the folder. The folder contains two files:
    Blink Env v1.0.x.postman_environment.json
    Blink Payment v1.0.x.postman_collection.json

Image Removed

Start Postman

  1. Open Postman.

  2. Create a new account.

  3. Create a new workspace.

Image Removed

Import Collection

  1. Click Collections

  2. Click Import

  3. Drag Blink Payment v1.0.x.postman_collection.json

Image Removed

Import Environment

  1. Click Environments

  2. Click Import

  3. Drag Blink Payment v1.0.x.postman_collection.json

Image Removed

Initial environment values

  1. Set the url to https://secure.blinkpayment.co.uk/api/pay/v1.

  2. Set the merchant_id.

  3. Set the api_key.

  4. Set the secret_key.

  5. Click …

  6. Click Reset All

  7. Click Save

NOTE: If you do not have the merchant_id or keys, follow the Get API Keys instruction.

Image Removed

Select the correct environment, from the drop down on top right.

Image Removed

Execute Request

  1. Select Collections

  2. Expand Blink Payment 1.0.x

  3. Expand Tokens

  4. Click POST tokens

  5. Click Send

Image Removed

Anchor
endpoints
endpoints

Endpoints

Method

Endpoint

Description

POST 

token 

Create an access token 

POST 

intent 

Create an intent 

POST 

token/refresh 

Refresh the access token 

POST 

intent/refresh 

Refresh the intent 

GET 

intent/{id} 

Return the intent 

PATCH 

intent/{id} 

Update the intent 

POST 

element

Return required details to populate payment form 

POST 

cc/process

Processes credit card payment and redirects to return_url 

GET

transaction/{id}

Returns transactions details

POST

{notification_url}

Redirects to notification URL

POST 

dd/process

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 

dd/callback

Return payment request status using payment id in later phase 

POST 

ob/process

Process open banking request with transaction details. On success it will provide the bank server redirect URL. 

Anchor
errors
errors

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
markup-conventions

Markup Conventions

Item

Description

Auth

Code in the body of test

Code Block
POST ...

Code block

{{access_token}}

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.