Versions Compared

Old Version 11

changes.mady.by.user Mohsin Shah

Saved on

compared with

New Version Current

changes.mady.by.user Sainita Mukherjee

Saved on

Key

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

Getting started

Welcome to our collection of Blink API Integration Guides.

Quick links

Get API Keys
Postman
Endpoints
Errors
Markup Conventions

Anchor
get-api-keys
get-api-keys

Get API Keys

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

Before using, you will need to login log in to Blink and get the API key and secret key for your Blink page:

1.1 Open Log in to https://secure.blinkpayment.co.uk

1.2 Scroll down to API Credentials on your dashboardNavigate to My Blink pages under Customer Centre.

1.3 Select the relevant Blink pagePage

1.4 You should see the API key and secret key for the selected page.

If you have a test developer account, you can also find the API Credentials on your dashboard.

NOTE: If you do not see the keys, then please contact the Blink support team to set up the API keys for you.

Image Removed
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

Image Added

Anchor
endpoints
endpoints

Endpoints

Method

Endpoint

Description

POST 

token 

pay/v1/tokens

Create an access token 

POST 

intent 

pay/v1/intents

Create an intent 

POST 

GET 

intent

GET 

token/refresh 

Refresh the access token 

POST 

intent/refresh 

Refresh the intent 

pay/v1/intents/{id} 

Return the intent 

PATCH 

intent

pay/v1/intents/{id} 

Update the intent 

POST 

element

pay/v1/elements

Return required details to populate payment form 

POST 

cc

pay/v1/

process

creditcards

Processes credit card payment and redirects to return_url 

GET

transaction

pay/v1/transactions/{id}

Returns transactions details

POST

{notification_url}

Redirects

Pushback transaction details to the specified notification URL

POST 

dd

pay/v1/

processob/process

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 

dd/callback

Return payment request status using payment id in later phase 

POST 

500  

Something went wrong 

pay/v1/openbankings

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

AnchorerrorserrorsErrors

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.

POST

pay/v1/transactions/{id}/reruns

Rerun any existing transaction which has been failed earlier.

POST

pay/v1/transactions/{id}/captures

Capture any transaction earlier than the predefined delay capture duration

POST

paylink/v1/paylinks

Create paylink url

GET

paylink/v1/paylinks/{id}

Return the paylink details. If, Id is not passed, it will return all the paylinks created from that merchant account.

PATCH

paylink/v1/paylinks/{id}

Update the paylink

DELETE

paylink/v1/paylinks/{id}

Delete the paylink

POST

paylink/v1/paylinks/{id}/notifications

Send reminder to the email or phone number at any time for the payment of the paylink

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.