The Blink API allows Blink merchants to create payments through card, open banking and direct debit. The payment API allows for full customization, while the paylink API enables users to create unique links for quick ECOM payments.
\nSign up here for a free sandbox account.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"21463868","collectionId":"7e48f79e-ad44-44bb-8013-8294f77e8e5f","publishedId":"2sA3kSo3Um","public":true,"customColor":{"top-bar":"EFF3FB","right-sidebar":"4CB2FF","highlight":"7590FF"},"publishDate":"2024-07-30T13:50:32.000Z"},"item":[{"name":"Authentication Token","item":[{"name":"tokens","event":[{"listen":"test","script":{"id":"c78d4225-c68b-43b1-80c6-678256d05906","exec":["","pm.collectionVariables.set(\"access_token\", pm.response.json().access_token);","pm.collectionVariables.set(\"payment_types\", pm.response.json().payment_types);",""],"type":"text/javascript","packages":{}}}],"id":"bd039426-3a16-4d93-b85b-34edb7da82bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"api_key\": \"eff458c623bba928a1a211521a7e38433bdf68780d0d8a16e2502f43cca322bc\",\n \"secret_key\": \"6310e48bdd0e4381459a62b46d2c4fd6e8ab65a2a4d5205c6c3ddebfbbaebbf8\",\n \"send_blink_receipt\": true,\n \"address_postcode_required\": true,\n \"enable_moto_payments\": true,\n \"application_name\": \"Blink API Postman Demo\",\n \"application_description\": \"Potsman collection of the Blink API - Take payments through, card, open banking and direct debits.\",\n \"source_site\": \"getpostman.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://secure.blinkpayment.co.uk/api/pay/v1/tokens","description":"This endpoint is used to generate access tokens for authentication and authorisation purposes.
\napi_key (string, required): The API key for authentication, 256 alpha numeric, obtained through the Blink platform.
secret_key (string, required): The secret key for authentication, 256 alpha numeric, obtained through the Blink platform.
send_blink_receipt (boolean): Defaulted to false. To enable the Blink receipt feature, value should be set to true.
address_postcode_required (boolean): Defaulted to false. To fetch the address and postcode details of a user, value should be set to true.
enable_moto_payments (boolean): Defaulted to false. To enable MOTO payment feature for any transaction, value should be set to true.
application_name (string, optional): The name of your application.
application_description (string, optional): Description of how your application interacts with blink.
source_site (string, optional): The site your application is hotsed on.
access_token (string): The generated access token for authentication and authorization purposes.
expired_on (string): The time when the token expires.
payment_types (array): The Payment types availble on the Blink account.
currencies (array): The currencies available on the Blink account.
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 eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjaGFudF9pZCI6NDM5OCwic2VjcmV0X2tleSI6IjYzMTBlNDhiZGQwZTQzODE0NTlhNjJiNDZkMmM0ZmQ2ZThhYjY1YTJhNGQ1MjA1YzZjM2RkZWJmYmJhZWJiZjgiLCJleHAiOjE3MjA3MDcyNjZ9.91qa4veQ9xGVM-Jc_3_i_vaykEdYarRwUzb-37aLD0c.
This endpoint allows you to create a new intent.
\ntransaction_type (string, required): Type of transaction.
Default value is set to SALE. If passed, it can only be one of the following:
SALE
\nVERIFY
\nPREAUTH
\nCREDIT
\npayment_type (string, required): Type of payment. It can only be one of the following:
credit-card
\ndirect-debit
\nopen-banking
\namount (number, required): Amount of the transaction (for transaction_type VERIFY, amount should be left out).
currency (string, required): Currency of the transaction. See the token's response for available currencies.
return_url (string, required): GET URL to return to after transaction completion.
notification_url (string, required): POST URL for transaction notification as the transaction is completed.
card_layout (string): Different structure of card layout for any transaction. This field is optional. If not passed, default value is basic.
basic
single-line
multi-line
delay_capture_days (integer, optional): Number of days for which the transaction will be delayed. This field can be passed only for SALE and CREDIT transactions.
id (number): The unique identifier of the intent.
payment_intent (string): The type of payment intent.
transaction_type (string): The type of transaction.
expiry_date (string): The expiry date of the intent.
status (string): The status of the intent.
payment_type (string): The type of payment.
currency (string): The currency of the transaction.
amount (number): The amount of the transaction.
return_url (string): The URL to return to after the transaction.
notification_url (string): The URL for transaction notifications.
card_layout (string): The layout of the card inputs in ccElement and ccMotoElement.
element (object): An object containing specific elements for credit card, moto, and online banking transactions:
ccElement (string): Credit card element.
ccMotoElement (string): Moto (Mail Order/Telephone Order) element.
obElement (string): Open banking element.
ddElement (string): Direct debit element.
gpElement (string): Google Pay element.
apElement (string): Apple Pay element.
merchant_id (number): The identifier of the merchant.
transaction_unique (string): The unique identifier of the transaction.
This endpoint retrieves the details of a specific intent by making a GET request to the specified URL. The request should include the unique identifier of the intent in the URL path.
\nintent id (string, required)
id (number): The unique identifier of the intent.
payment_intent (string): The type of payment intent.
transaction_type (string): The type of transaction.
expiry_date (string): The expiry date of the intent.
status (string): The status of the intent.
payment_type (string): The type of payment.
currency (string): The currency of the transaction.
amount (number): The amount of the transaction.
return_url (string): The URL to return to after the transaction.
notification_url (string): The URL for transaction notifications.
card_layout (string): The layout of the card inputs in ccElement and ccMotoElement.
element (object): An object containing specific elements for credit card, moto, and online banking transactions:
ccElement (string): Credit card element.
ccMotoElement (string): Moto (Mail Order/Telephone Order) element.
obElement (string): Open banking element.
ddElement (string): Direct debit element.
gpElement (string): Google Pay element.
apElement (string): Apple Pay element.
merchant_id (number): The identifier of the merchant.
transaction_unique (string): The unique identifier of the transaction.
This endpoint allows you to update an existing intent by sending an HTTP PATCH request to the specified URL with the intent ID. This is used for changing the return or notification_url.
\nintent id(string, required)
notification_url (string): The URL to receive notifications.
return_url (string): The URL to redirect after the intent is updated.
Upon a successful request, the server will respond with the updated intent object, including the following fields:
\nid (integer): The ID of the intent.
payment_intent (string): The payment intent associated with the intent.
transaction_type (string): The type of transaction.
expiry_date (string): The expiry date of the intent.
status (string): The status of the intent.
payment_type (string): The type of payment.
currency (string): The currency of the transaction.
amount (integer): The amount of the transaction.
return_url (string): The URL to redirect after the intent is updated.
notification_url (string): The URL to receive notifications.
card_layout (string): The layout of the card.
element (object): An object containing specific elements related to the intent.
merchant_id (integer): The ID of the merchant associated with the intent.
transaction_unique (string): The unique identifier for the transaction.
Creates a unique intent specifiying the transaction details.
\n","_postman_id":"8d34bd8f-bd2d-4ec2-9a3f-4446bfa2b927","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjaGFudF9pZCI6NDM5OCwic2VjcmV0X2tleSI6IjYzMTBlNDhiZGQwZTQzODE0NTlhNjJiNDZkMmM0ZmQ2ZThhYjY1YTJhNGQ1MjA1YzZjM2RkZWJmYmJhZWJiZjgiLCJleHAiOjE3MjA3MDcyNjZ9.91qa4veQ9xGVM-Jc_3_i_vaykEdYarRwUzb-37aLD0c"}]},"isInherited":true,"source":{"_postman_id":"4c1731cb-44fe-4d26-becf-cd316970412b","id":"4c1731cb-44fe-4d26-becf-cd316970412b","name":"Payments API","type":"folder"}}},{"name":"CreditCards","item":[{"name":"payment_tokens","event":[{"listen":"test","script":{"id":"1b636594-a554-413c-b6df-12b0de0abc26","exec":["pm.collectionVariables.set(\"paymentToken\", pm.response.json().paymentToken);","",""],"type":"text/javascript","packages":{}}}],"id":"9e615d52-883d-4990-9562-6612170b6b0f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"process","value":"tokenise","type":"text"},{"key":"merchantID","value":"233508","type":"text"},{"key":"tokenType","value":"card","type":"text"},{"key":"tokenData[cardNumber]","value":"4111111111111111","type":"text"},{"key":"tokenData[cardExpiryDate]","value":"12/24","type":"text"},{"key":"tokenData[cardCVV]","value":"123","type":"text"}]},"url":"https://gateway2.blinkpayment.co.uk/paymentform","description":"In practice, we do not recommend using this request to tokenise the card details. It is preferable to use the hosted fields code for secure tokenisation.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjaGFudF9pZCI6NDM5OCwic2VjcmV0X2tleSI6IjYzMTBlNDhiZGQwZTQzODE0NTlhNjJiNDZkMmM0ZmQ2ZThhYjY1YTJhNGQ1MjA1YzZjM2RkZWJmYmJhZWJiZjgiLCJleHAiOjE3MjA3MDcyNjZ9.91qa4veQ9xGVM-Jc_3_i_vaykEdYarRwUzb-37aLD0c"}]},"isInherited":true,"source":{"_postman_id":"4c1731cb-44fe-4d26-becf-cd316970412b","id":"4c1731cb-44fe-4d26-becf-cd316970412b","name":"Payments API","type":"folder"}},"urlObject":{"protocol":"https","path":["paymentform"],"host":["gateway2","blinkpayment","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"9e615d52-883d-4990-9562-6612170b6b0f"},{"name":"creditcards (ECOM 3DS)","id":"94e2fdf8-b59c-4269-975a-7b0d1e9a07bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjaGFudF9pZCI6NDM5OCwic2VjcmV0X2tleSI6IjYzMTBlNDhiZGQwZTQzODE0NTlhNjJiNDZkMmM0ZmQ2ZThhYjY1YTJhNGQ1MjA1YzZjM2RkZWJmYmJhZWJiZjgiLCJleHAiOjE3MjA3MDcyNjZ9.91qa4veQ9xGVM-Jc_3_i_vaykEdYarRwUzb-37aLD0c"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjaGFudF9pZCI6NDM5OCwic2VjcmV0X2tleSI6IjYzMTBlNDhiZGQwZTQzODE0NTlhNjJiNDZkMmM0ZmQ2ZThhYjY1YTJhNGQ1MjA1YzZjM2RkZWJmYmJhZWJiZjgiLCJleHAiOjE3MjA3MDcyNjZ9.91qa4veQ9xGVM-Jc_3_i_vaykEdYarRwUzb-37aLD0c"},{"key":"Accept-Charset","value":"\"\""}],"body":{"mode":"raw","raw":"{\n \"payment_intent\": \"\",\n \"paymentToken\": \"\",\n \"type\": 1,\n \"customer_email\": \"Hassan_Greenfelder32@gmail.com\",\n \"customer_name\": \"Ethel Maggio\",\n \"transaction_unique\": \"\",\n \"merchant_data\": \"{\\\"order_id\\\": \\\"cc-12345678\\\"}\",\n \"device_timezone\": \"-330\",\n \"device_capabilities\": \"javascript\",\n \"device_accept_language\": \"en-GB\",\n \"device_screen_resolution\": \"1366x768x24\",\n \"remote_address\": \"123.123.123.123\"\n}","options":{"raw":{"language":"json"}}},"url":"https://secure.blinkpayment.co.uk/api/pay/v1/creditcards","description":"Using the creditcards resource to accept ECOM payments. The response will be an html form (acsform) that needs to be auto-submitted for the transaction to go through 3Ds checks.
\npayment_intent (string, required): The payment intent token.
paymentToken (string, required): The tokenised card details.
type (integer, required): value is 1.
customer_email (string, required): The email address of the customer making the payment.
customer_name (string, required): The name of the customer making the payment.
transaction_unique (string, required): A unique identifier for the transaction.
device_timezone (string, required): Device timezone value which can be fetched using javascript and assigned to the respective hosted input field.
device_capabilities (string, required): Device capabilities which can be fetched using javascript and assigned to the respective hosted input field.
device_accept_language (string, required): Device accept language which can be fetched using javascript and assigned to the respective hosted input field.
device_screen_resolution (string, required): Device accept language which can be fetched using javascript and assigned to the respective hosted input field.
remote_address (string, required): Remote address which can be fetched using javascript and assigned to the respective hosted input field.
merchant_data (json, optional): Additional custom data related to the merchant or customer.
acsform an html form to be submitted for 3DS screening.MOTO transactions do not require 3DS.
\npayment_intent (string, required): The payment intent token.
paymentToken (string, required): The tokenised card details.
type (integer, required): value is 2
customer_email (string, required): The email address of the customer making the payment.
customer_name (string, required): The name of the customer making the payment.
customer_address (string, optional): The billing address of the customer's card, may be required for addtional AVS checking.
customer_postcode (string, optional): The billing post code of the customer's card, may be required for addtional AVS checking.
transaction_unique (string, required): A unique identifier for the transaction.
merchant_data (json, optional): Additional custom data related to the merchant or customer.
url (string): The return_url entered in the intent with query paramters of the trasnaction result.Using the googlepay resource to accept ECOM payments from Google Pay. The response may be an html form (acsform) that needs to be auto-submitted for the transaction to go through 3Ds checks.
\npayment_intent (string, required): The payment intent token.
paymentToken (string, required): The strignified JSON from the Google API representing the customer card.
type (integer, required): value is 1.
customer_email (string, required): The email address of the customer making the payment.
customer_name (string, required): The name of the customer making the payment.
transaction_unique (string, required): A unique identifier for the transaction.
device_timezone (string, required): Device timezone value which can be fetched using javascript and assigned to the respective hosted input field.
device_capabilities (string, required): Device capabilities which can be fetched using javascript and assigned to the respective hosted input field.
device_accept_language (string, required): Device accept language which can be fetched using javascript and assigned to the respective hosted input field.
device_screen_resolution (string, required): Device accept language which can be fetched using javascript and assigned to the respective hosted input field.
remote_address (string, required): Remote address which can be fetched using javascript and assigned to the respective hosted input field.
merchant_data (json, optional): Additional custom data related to the merchant or customer.
acsform an html form to be submitted for 3DS screening.Using the applepay resource to accept ECOM payments from Apple Pay.
\npayment_intent (string, required): The payment intent token.
paymentToken (string, required): The strignified JSON from the Google API representing the customer card.
type (integer, required): value is 1.
customer_email (string, required): The email address of the customer making the payment.
customer_name (string, required): The name of the customer making the payment.
transaction_unique (string, required): A unique identifier for the transaction.
device_timezone (string, required): Device timezone value which can be fetched using javascript and assigned to the respective hosted input field.
device_capabilities (string, required): Device capabilities which can be fetched using javascript and assigned to the respective hosted input field.
device_accept_language (string, required): Device accept language which can be fetched using javascript and assigned to the respective hosted input field.
device_screen_resolution (string, required): Device accept language which can be fetched using javascript and assigned to the respective hosted input field.
remote_address (string, required): Remote address which can be fetched using javascript and assigned to the respective hosted input field.
merchant_data (json, optional): Additional custom data related to the merchant or customer.
url (string): The return_url enternered in the in the intent with query paramters of the trasnaction result.Using the intent to charge the customer via their credit/ debit card details.
\nThis can be done via
\n/creditcards ECOM (will go through 3DS)
\n/creditcards MOTO
\n/googlepay for googlepay transactions
\n/applepay for applepay transactions
\nThis endpoint processes an open banking payment and returns the banking server redirect url as a response.
\npayment_intent (string, required): The payment intent token.
customer_email (string, required): The email address of the customer making the payment.
customer_name (string, required): The name of the customer making the payment.
transaction_unique (string, required): A unique identifier for the transaction.
merchant_data (json, optional): Additional custom data related to the merchant or customer.
url (string): The banking server redirect URL where the customer needs to be redirected to complete the payment process.This endpoint processes direct debits payments and returns to the user-defined URL with a url encoded transaction response.
\npayment_intent (string, required): The payment intent token.
given_name(string, required): The first name of the customer making the payment.
family_name(string, required): The surname of the customer making the payment.
company_name (string, optional): User’s company name. It’s required only if user’s given name and family name are not present.
email (string, required): The email address of the customer making the payment.
country_code(string, optional): ISO country code. Default value GB.
customer_address (string, optional): Customer’s address details.
customer_postcode (string, optional): Customer’s postcode.
account_holder_name(string, required): Customer’s bank account name.
branch_code (string, required): Customer’s bank short code.
account_number (string, required): Customer’s bank account number.
merchant_data (Json, optional): Additional custom data related to the merchant or customer.
status (string): Indicates the status of the transaction, such as \"success\" or \"failure\".
transaction_id (string): Unique identifier for the transaction.
transaction_status (string): Status of the transaction, e.g., \"processed\", \"pending\", \"failed\".
transaction_response_code (string): Response code for the transaction.
transaction_response_message (string): Message associated with the transaction response.
This endpoint gets transaction details.
\ntransaction_id (string, required): Transaction ID returned as resvalue in return url after the Payment request.
transaction_id: The unique identifier for the transaction
status: The status of the transaction
message: A message related to the transaction status
amount: The transaction amount
currency: The currency of the transaction
payment_source: The payment source used for the transaction
customer_name: The name of the customer
customer_email: The email address of the customer
merchant_data: Additional data related to the merchant, including the order_id
This endpoint cancels an existing transaction which has been authorised but not yet settled (only applicable for card transactions).
\ntransaction_id (string, required): Transaction ID returned as resvalue in return url after the Payment request.
success: (boolean) Indicates whether the cancellation was successful.
message: (string) Provides a message related to the cancellation status.
amount: (string) Represents the amount associated with the cancelled transaction.
reference: (string) Contains a note or reference related to the cancellation.
transaction_id: (string) Identifies the cancelled transaction with a unique ID.
This endpoint refunds a transaction which has been authorised and settled (only applicable for card transactions).
\ntransaction_id (string, required): Transaction ID returned as resvalue in return url after the Payment request.
partial_refund (boolean, optional): If the transaction is a partial refund, then set it to true. Default value is false.
amount (float, optional): Amount is required if it’s a partial refund. The amount cannot be greater than the original received amount minus any already refunded amount.
reference (string, optional): Reference for the refund. Default is the original transaction_unique.
id (string): The unique identifier for the refund transaction.transaction_id (string): The identifier of the original transaction for which the refund is being processed.amount (float): The amount refunded in the transaction.status (string): The status of the refund transaction, such as \"completed\", \"pending\", or \"failed\".created_at (string): The timestamp indicating when the refund transaction was created.reference (string): The reference for the refund, which may be the original transaction_unique or a custom reference if provided.
This endpoint captures a delayed capture transaction earlier than the set day.
\ntransaction_id (string, required): Transaction ID returned as resvalue in return url after the Payment request.
amount (float, optional): Defaults to the original transaction amount. Cannot charge more than the original amount.
transaction_unique (string, optional): Defaults to the original transaction_unique.
This endpoint reruns an existing transaction which had failed earlier.
\namount (float, optional): Defaults to the original transaction amount.
transaction_unique (string, optional): Defaults to the original transaction_unique.
delay_capture_days (integer optional): Number of days for which the transaction will be delayed.
status (string): The status of the rerun transaction.
transaction_id (string): The unique identifier for the rerun transaction.
amount (float): The amount of the rerun transaction.
transaction_unique (string): The unique identifier for the rerun transaction, defaults to the original transaction_unique.
message (string): A brief message or description related to the rerun transaction.
Create a repeat schedule to automate subscriptions or split a payment into multiple installments in a recurring schedule.
\npayment_intent (string, required): The payment intent token.
paymentToken (string, required): The tokenised card details.
type (integer, required): value is 1 for ECOM.
customer_email (string, required): The email address of the customer making the payment.
customer_name (string, required): The name of the customer making the payment.
customer_address (string, optional): The billing address of the customer's card, may be required for addtional AVS checking.
customer_postcode (string, optional): The billing post code of the customer's card, may be required for addtional AVS checking.
reference (string, required): Reference for the schedule.
currency (string, required): Three letter currency code (ISO 4217) e.g USD, GBP.
device_timezone (string, required): The device timezone value which can be fetched using javascript and assigned to the respective hosted input field.
device_capabilities (string, required): Device capabilities which can be fetched using javascript and assigned to the respective hosted input field.
device_accept_language (string, required): Device accept language which can be fetched using javascript and assigned to the respective hosted input field.
device_screen_resolution (string, required): Device accept language which can be fetched using javascript and assigned to the respective hosted input field.
remote_address (string, required): Remote address which can be fetched using javascript and assigned to the respective hosted input field.
merchant_data (json, optional): Additional custom data related to the merchant or customer.
payment_type (string, required): Repeat payment type.
Possible values are:
fixed_schedule
variable_schedule
For fixed_schedule, the following fields are
frequency (string, required): Payment cycle frequency. For fixed_schedule.
Possible values are
days
\nweeks
\nmonths
\nfrequency_duration (integer, required): Payment frequency duration. (E.g. “2” and “days” will be every 2 days) For fixed_schedule.
start_payment_date (date , optional): Date on which the first payment will be captured. Default value set to today.
first_amount (float, optional)
First payment amount. When creating a Fixed Schedule, the first amount value can be customised.
recurring_amount (float, required): Recurring amount for each installment.
is_limited_installments (boolean):
If the schedule will have unlimited or limited installments.
installments (integer): Number of installments.
It is required when creating a Fixed Schedule if the is_limited_installments field is true (i.e. it has limited instalments).
For variable_schedule, the following fields are
schedule_set (array, required): Schedule set is an array set of date and amount where the date will be the key and the amount will be its value. This array needs to have a minimum of 2 sets of values.acsform an html form to be submitted for 3DS screening.Create a repeat schedule to automate subscriptions or split a payment into multiple installments.
\npayment_intent (string, required): The payment intent token.
paymentToken (string, required): The tokenised card details.
type (integer, required): value is 2 for MOTO.
customer_email (string, required): The email address of the customer making the payment.
customer_name (string, required): The name of the customer making the payment.
customer_address (string, optional): The billing address of the customer's card, may be required for addtional AVS checking.
customer_postcode (string, optional): The billing post code of the customer's card, may be required for addtional AVS checking.
reference (string, required): Reference for the schedule.
currency (string, required): Three letter currency code (ISO 4217) e.g USD, GBP.
merchant_data (json, optional): Additional custom data related to the merchant or customer.
payment_type (string, required): Repeat payment type.
Possible values are:
fixed_schedule
variable_schedule
For fixed_schedule, the following fields are:
frequency (string, required): Payment cycle frequency. For fixed_schedule.
Possible values are
days
\nweeks
\nmonths
\nfrequency_duration (integer, required): Payment frequency duration. (E.g. “2” and “days” will be every 2 days) For fixed_schedule.
start_payment_date (date , optional): Date on which the first payment will be captured. Default value set to today.
first_amount (float, optional): First payment amount. When creating a Fixed Schedule, the first amount value can be customised.
recurring_amount (float, required): Recurring amount for each installment.
is_limited_installments (boolean):
If the schedule will have unlimited or limited installments.
installments (integer): Number of installments.
It is required when creating a Fixed Schedule if the is_limited_installments field is true (i.e. it has limited instalments).
final_amount (integer): Final payment amount. When creating a Fixed Schedule, the final amount value can be customised.
For variable_schedule, the following fields are:
schedule_set (array, required): Schedule set is an array set of date and amount where the date will be the key and the amount will be its value. This array needs to have a minimum of 2 sets of values.id: A unique identifier for the repeat payment sechdule.
payment_type: Specifies the type of payment_type.
status: The current status of the payment request, possible values are:
Active - This means the payments have started
Pending - This means the first payment has not yet been processed
Cancelled - This means the schedule has been cancelled. No further payments will be processed
Completed - This means all the payments have been processed. No further payments will be processed
customer_email: The email address of the customer who has made the payment.
customer_name: The name of the customer who has made the payment.
address: The billing address of the customer's card.
postcode : The billing post code of the customer's card.
reference: Reference for the schedule.
currency: Three letter currency code (ISO 4217) e.g USD, GBP.
start_payment_date: The date when the schedule begins.
final_payment_date: The date when the schedule ends.
recurring_amount: The amount to be charged in each recurring payment.
is_limited_installments: A boolean indicating whether the payment schedule has a limited number of installments.
installments: The number of installments.
frequency: The interval between recurring payments.
frequency_duration: The number of units for the frequency interval.
is_active: A boolean indicating whether the payment plan is currently active.
xref: A unique reference code for the payment request.
recurring_data: An array of objects, each representing details about individual recurring payments:
recurring_id: A unique identifier for each recurring payment.
payment_date: The date the payment is scheduled to be processed.
reference: A label or description for the specific recurring payment.
processed_amount: The amount that has been processed for that specific payment.
is_processed: A boolean indicating whether the payment has been processed.
schedule : The current status of that specific payment (e.g., \"Captured\", \"Pending\").
xref: A unique reference code for the payment request.
Create a repeat schedule to automate subscriptions or split a payment into multiple installments from an existing transaction
\ntransaction_id (string, required): Original transaction id the schedule is being created from.
type (integer, required): value is 2 for MOTO and 1 for ECOM
customer_email (string, required): The email address of the customer making the payment.
customer_name (string, required): The name of the customer making the payment.
reference (string, required): Reference for the schedule.
merchant_data (json, optional): Additional custom data related to the merchant or customer.
payment_type (string, required): Repeat payment type.
Possible values are:
fixed_schedule
variable_schedule
For variable_schedule, the following fields are:
schedule_set (array, required): Schedule set is an array set of date and amount where the date will be the key and the amount will be its value. This array needs to have a minimum of 2 sets of values.
frequency (string, required): Payment cycle frequency. For fixed_schedule.
Possible values are
days
\nweeks
\nmonths
\nfrequency_duration (integer, required): Payment frequency duration. (E.g. “2” and “days” will be every 2 days) For fixed_schedule.
start_payment_date (date , optional): Date on which the first payment will be captured. Default value set to today.
first_amount (float, optional): First payment amount. When creating a Fixed Schedule, the first amount value can be customised.
recurring_amount (float, required): Recurring amount for each installment.
is_limited_installments (boolean):
If the schedule will have unlimited or limited installments.
installments (integer): Number of installments.
It is required when creating a Fixed Schedule if the is_limited_installments field is true (i.e. it has limited instalments).
final_amount (integer): Final payment amount. When creating a Fixed Schedule, the final amount value can be customised.
id: A unique identifier for the repeat payment sechdule.
payment_type: Specifies the type of payment_type.
status: The current status of the payment request, possible values are:
Active - This means the payments have started
Pending - This means the first payment has not yet been processed
Cancelled - This means the schedule has been cancelled. No further payments will be processed
Completed - This means all the payments have been processed. No further payments will be processed
customer_email: The email address of the customer who has made the payment.
customer_name: The name of the customer who has made the payment.
address: The billing address of the customer's card.
postcode : The billing post code of the customer's card.
reference: Reference for the schedule.
currency: Three letter currency code (ISO 4217) e.g USD, GBP.
start_payment_date: The date when the schedule begins.
final_payment_date: The date when the schedule ends.
recurring_amount: The amount to be charged in each recurring payment.
is_limited_installments: A boolean indicating whether the payment schedule has a limited number of installments.
installments: The number of installments.
frequency: The interval between recurring payments.
frequency_duration: The number of units for the frequency interval.
is_active: A boolean indicating whether the payment plan is currently active.
xref: A unique reference code for the payment request.
recurring_data: An array of objects, each representing details about individual recurring payments:
recurring_id: A unique identifier for each recurring payment.
payment_date: The date the payment is scheduled to be processed.
reference: A label or description for the specific recurring payment.
processed_amount: The amount that has been processed for that specific payment.
is_processed: A boolean indicating whether the payment has been processed.
schedule : The current status of that specific payment (e.g., \"Captured\", \"Pending\").
xref: A unique reference code for the payment request.
This endpoint gets details of a specific repeat payment schedule using its id.
\nschedule_id (integer): id of the repeat payment schedule.payment_type: Repeat payment type. It must be either of the following values. It is passed to identify the type of the specific repeat schedule. This value cannot be updated.fixed_schedule
\nvariable_schedule
\nid (integer): The unique identifier for the repeat payment schedule.
payment_type (string): The type of repeat payment schedule, which can be either \"fixed_schedule\" or \"variable_schedule\".
start_date (string): The start date of the repeat payment schedule.
end_date (string): The end date of the repeat payment schedule.
amount (number): The amount of the repeat payment.
currency (string): The currency in which the payment is made.
status (string): The status of the repeat payment schedule, such as \"active\", \"completed\", \"cancelled\", etc.
created_at (string): The date and time when the repeat payment schedule was created.
updated_at (string): The date and time when the repeat payment schedule was last updated.
This endpoint gets the details of all repeat payment schedules created from a specific account.
\npayment_type: Repeat payment type. It must be either of the following values. It is passed to identify the type of the specific repeat schedule. This value cannot be updated.fixed_schedule
\nvariable_schedule
\npage (integer): Page number.
status (string): Repeat payment status.
Active - The payments of the RP have not been processed yet.
\nPaused - The RP has been paused for now.
\nPending - The RP has been created, but the first payment has not yet been processed
\nCancelled - The RP has been cancelled
\nCompleted - All the payments have been processed
\nid (string): The unique identifier for the repeat payment schedule.
\naccount_id (string): The identifier of the account associated with the repeat payment schedule.
\npayment_type (string): The type of repeat payment schedule (fixed_schedule or variable_schedule).
\nstatus (string): The status of the repeat payment schedule (Active, Paused, Pending, Cancelled, Completed).
\nstart_date (string): The start date of the repeat payment schedule.
\nend_date (string): The end date of the repeat payment schedule.
\nnext_payment_date (string): The date of the next scheduled payment.
\namount (number): The amount of each payment in the repeat payment schedule.
\ncurrency (string): The currency of the payment amount.
\nmetadata (object): Additional metadata associated with the repeat payment schedule.
\nThis endpoint refunds a single previous payment in a schedule.
\nschedule_id (integer): id of the schedule of the repeat payment.payment_type (string, required): Repeat payment type. It must be either of the following values. It is passed to identify the type of the specific repeat schedule. This value cannot be updated.fixed_schedule
\nvariable_schedule
\nrecurring_id (integer, required): id of the transaction you wish to cancel.success (boolean)
message (string)
This endpoint deletes a schedule and all its remaining payments that haven’t been processed yet. If a recurring_id is entered, then it will only remove that specific future payment.
schedule_id (integer) : id of the schedule of the repeat payment.payment_type (string, required): Repeat payment type. It must be either of the following values. It is passed to identify the type of the specific repeat schedule. This value cannot be updated.fixed_schedule
\nvariable_schedule
\nrecurring_id (integer, optional): id of the transaction you wish to remove.success (boolean)
message (string)
This endpoint reruns any specific payment which returned a declined status due to some issue with its Repeat schedule.
\nschedule_id (integer) : id of the schedule of the repeat payment.payment_type (string, required): Repeat payment type. It must be either of the following values. It is passed to identify the type of the specific repeat schedule. This value cannot be updated.
fixed_schedule
\nvariable_schedule
\nrecurring_id (integer, required): id of the transaction you wish to retry.
success (boolean)
message (string)
This endpoint allows the user to change the card being charged on the reccuring schedule.
\nschedule_id (integer): id of the schedule of the repeat payment.payment_type (string, required): Repeat payment type. It must be either of the following values. It is passed to identify the type of the specific repeat schedule. This value cannot be updated.fixed_schedule
\nvariable_schedule
\npaymentToken (string, required): The tokenised card details.API requests to create recurring/ scheduled payments.
\n","_postman_id":"d92d49d9-9b22-4b34-9145-ba05451afa11","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjaGFudF9pZCI6NDM5OCwic2VjcmV0X2tleSI6IjYzMTBlNDhiZGQwZTQzODE0NTlhNjJiNDZkMmM0ZmQ2ZThhYjY1YTJhNGQ1MjA1YzZjM2RkZWJmYmJhZWJiZjgiLCJleHAiOjE3MjA3MDcyNjZ9.91qa4veQ9xGVM-Jc_3_i_vaykEdYarRwUzb-37aLD0c"}]},"isInherited":true,"source":{"_postman_id":"4c1731cb-44fe-4d26-becf-cd316970412b","id":"4c1731cb-44fe-4d26-becf-cd316970412b","name":"Payments API","type":"folder"}}},{"name":"Apple Pay Domain Registration","item":[{"name":"Domain Verification File","id":"2cc6c894-dfca-47f0-b7c8-9ab8ea4ba868","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://secure.blinkpayment.co.uk/.well-known/apple-developer-merchantid-domain-association","description":"The domain verifcation file required to upload to your site to allow apple pay to work.
\nhttps://{your-domain}/.well-known/apple-developer-merchantid-domain-association.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjaGFudF9pZCI6NDM5OCwic2VjcmV0X2tleSI6IjYzMTBlNDhiZGQwZTQzODE0NTlhNjJiNDZkMmM0ZmQ2ZThhYjY1YTJhNGQ1MjA1YzZjM2RkZWJmYmJhZWJiZjgiLCJleHAiOjE3MjA3MDcyNjZ9.91qa4veQ9xGVM-Jc_3_i_vaykEdYarRwUzb-37aLD0c"}]},"isInherited":true,"source":{"_postman_id":"4c1731cb-44fe-4d26-becf-cd316970412b","id":"4c1731cb-44fe-4d26-becf-cd316970412b","name":"Payments API","type":"folder"}},"urlObject":{"protocol":"https","path":[".well-known","apple-developer-merchantid-domain-association"],"host":["secure","blinkpayment","co","uk"],"query":[],"variable":[]}},"response":[],"_postman_id":"2cc6c894-dfca-47f0-b7c8-9ab8ea4ba868"},{"name":"applepay/domains","id":"1f7a2dee-04d9-4006-8556-966fd542399d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjaGFudF9pZCI6NDM5OCwic2VjcmV0X2tleSI6IjYzMTBlNDhiZGQwZTQzODE0NTlhNjJiNDZkMmM0ZmQ2ZThhYjY1YTJhNGQ1MjA1YzZjM2RkZWJmYmJhZWJiZjgiLCJleHAiOjE3MjA3MDcyNjZ9.91qa4veQ9xGVM-Jc_3_i_vaykEdYarRwUzb-37aLD0c"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"domain_name\": \"https://demo-app.co.uk/\" \r\n}","options":{"raw":{"language":"json"}}},"url":"https://secure.blinkpayment.co.uk/api/pay/v1/applepay/domains","description":"domain_name (string, required): domain that is being registered for apple pay.Response Body
\nsuccess (boolean): indicates weather registration was succesful.
message (string): Gives more details on the registration or steps needed to retry.
This endpoint is used to see what domains are registered for apple pay.
\nThis API allows users to register their domain for Apple Pay through Blink, allowing users to accept apple pay wallet payments.
\n","_postman_id":"14a6b5b2-dbfc-4b6c-bc6a-0755d0242ca1","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjaGFudF9pZCI6NDM5OCwic2VjcmV0X2tleSI6IjYzMTBlNDhiZGQwZTQzODE0NTlhNjJiNDZkMmM0ZmQ2ZThhYjY1YTJhNGQ1MjA1YzZjM2RkZWJmYmJhZWJiZjgiLCJleHAiOjE3MjA3MDcyNjZ9.91qa4veQ9xGVM-Jc_3_i_vaykEdYarRwUzb-37aLD0c"}]},"isInherited":true,"source":{"_postman_id":"4c1731cb-44fe-4d26-becf-cd316970412b","id":"4c1731cb-44fe-4d26-becf-cd316970412b","name":"Payments API","type":"folder"}}}],"id":"4c1731cb-44fe-4d26-becf-cd316970412b","description":"The Payments API allows users to take payments directly form their own website and platforms.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjaGFudF9pZCI6NDM5OCwic2VjcmV0X2tleSI6IjYzMTBlNDhiZGQwZTQzODE0NTlhNjJiNDZkMmM0ZmQ2ZThhYjY1YTJhNGQ1MjA1YzZjM2RkZWJmYmJhZWJiZjgiLCJleHAiOjE3MjA3MDcyNjZ9.91qa4veQ9xGVM-Jc_3_i_vaykEdYarRwUzb-37aLD0c"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"0f2e1b4c-edcf-4708-86a8-355287f5dda9","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"52b2de1e-216b-4117-8585-2a8aedd571c3","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"4c1731cb-44fe-4d26-becf-cd316970412b"},{"name":"Paylink API","item":[{"name":"Create Paylink","event":[{"listen":"test","script":{"id":"35ae1ffd-789e-440a-a18e-324096b3b549","exec":["pm.collectionVariables.set(\"paylink_id\", pm.response.json().id);"],"type":"text/javascript","packages":{}}}],"id":"e9d1498f-9b99-4fbd-bc6e-a9bc572aad30","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjaGFudF9pZCI6NDM5OCwic2VjcmV0X2tleSI6IjYzMTBlNDhiZGQwZTQzODE0NTlhNjJiNDZkMmM0ZmQ2ZThhYjY1YTJhNGQ1MjA1YzZjM2RkZWJmYmJhZWJiZjgiLCJleHAiOjE3MjA3MDcyNjZ9.91qa4veQ9xGVM-Jc_3_i_vaykEdYarRwUzb-37aLD0c"}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjaGFudF9pZCI6NDM5OCwic2VjcmV0X2tleSI6IjYzMTBlNDhiZGQwZTQzODE0NTlhNjJiNDZkMmM0ZmQ2ZThhYjY1YTJhNGQ1MjA1YzZjM2RkZWJmYmJhZWJiZjgiLCJleHAiOjE3MjA3MDcyNjZ9.91qa4veQ9xGVM-Jc_3_i_vaykEdYarRwUzb-37aLD0c"}],"body":{"mode":"raw","raw":"{\n\t\"payment_method\": [\"credit-card\",\"open-banking\"],\n \"transaction_type\": \"SALE\",\n \"full_name\": \"Joe Blogs\",\n \"email\": \"j.blogs@blinkpayment.co.uk\",\n \"currency\": \"GBP\",\n \"mobile_number\": \"0753215468\",\n \"transaction_unique\": \"Postman Test\",\n \"is_decide_amount\": true,\n \"amount\": 2.01,\n \"notes\": \"test note\",\n \"reminder\": true,\n \"reminder_interval_count\": 2,\n \"reminder_interval_frequency\": \"days\",\n \"notification_url\": \"https://blinkpayment.co.uk/webhook\",\n \"redirect_url\": \"https://api-demo-php.blinkpayment.co.uk/return\"\n}","options":{"raw":{"language":"json"}}},"url":"https://secure.blinkpayment.co.uk/api/paylink/v1/paylinks","description":"This endpoint creates a payment link to be used for a one-time transaction.
\npayment_method (array, required): Can be one or more of the following:credit-card
direct-debit
open-banking
transaction_type (string, required):SALE
PREAUTH
VERIFY
full_name (string, required): Customer full name.
email (string, optional): Customer email.
mobile_number (string, optional): Customer mobile number.
transaction_unique (string, required): Unique transaction reference.
is_decide_amount (boolean, optional): If the customer decides the amount.
amount (float, required): Transaction amount.
currency (string, required): Currency of the transaction. See the token's response for available currencies.
address(string, optional): Customer's billing address, this will prefill the paylink with the address entered. The customer can change it.
postcode(string, optional): Customer's billing postcode, this will prefill the paylink with the address entered. The customer can change it.
reminder (boolean, optional): If reminder will be sent to the customer. Defaults to false.
reminder_interval_count (integer, optional):
If reminder is true, you need to mention the number of days/weeks
reminder_interval_frequency (string, optional):
If reminder is true, you need to mention the interval frequency. It can be one of the following:
days
week
notes (string, optional): Add any note to describe the Paylink request to the customer.
notification_url (string, optional): POST URL on your domain, where Blink will send status updates when the transaction status is changed e.g. https://mydomain.com/notification.
redirect_url (string, optional): GET URL on your domain, where Blink will send transaction details when the transaction is done e.g. https://mydomain.com/return.
is_notification_required (boolean, optional): If set to true, it will send the paylink to the customer by email and/ or SMS. Defaults to false.
expiry_date(string, optional): date to set the paylink to expire e.g. \"15-09-2025\"
id (string): The unique identifier for the payment link.
paylink_url (string): The URL for the payment link that can be shared with the customer.
transaction_unique (string): The unique identifier of the transaction that will be made form the payment link.
reminder (boolean, optional): If reminder will be sent to the customer. Defaults to false.
reminder_interval_count (integer, optional):
If reminder is true, you need to mention the number of days/weeks
reminder_interval_frequency (string, optional):
If reminder is true, you need to mention the interval frequency.
expiry_date(string, optional): date to set the paylink to expire e.g. \"15-09-2025\"
This endpoint gets details of a specific paylink using id.
\npaylink_id (integer, required): id of the paylink.
id (integer): The unique identifier of the paylink.amount (number): The amount associated with the paylink.description (string): The description or details of the paylink.status (string): The status of the paylink, such as \"active\" or \"inactive\".expiry_date (string): The expiry date of the paylink.created_at (string): The date and time when the paylink was created.updated_at (string): The date and time when the paylink was last updated.
Gets details of all the paylinks created by a specific merchant.
\nstatus (string): status of the paylink.
customer_name (string): Customer name.
amount (float): amount of the paylink.
amount_gt (float): Amount should be greater than specified value.
amount_lt (float):
Amount should be less than specified value.
id (string): The unique identifier for the paylink.
status (string): The status of the paylink, such as \"unpaid\", \"paid\", etc.
amount (float): The amount associated with the paylink.
customer_name (string): The name of the customer associated with the paylink.
created_at (string): The timestamp indicating when the paylink was created.
updated_at (string): The timestamp indicating when the paylink was last updated.
This endpoint is used to resend a paylink either by email or SMS.
\npaylink_id (integer, required): id of the paylink.
send_email (boolean, optional): If send email is true, it will send notification through email.
send_sms (boolean, optional): If send sms is true, it will send notification through sms.
Updates data associated with the paylink before the link is used.
\npaylink_id (integer, required): id of the paylink.
email (string, optional): Email address
mobile_number (integer, optional): Customer mobile number
status (string, optional): Paylink status
expiry_date(string, optional): date to set the paylink to expire e.g. \"15-09-2025\"
The Paylink API allows users to generate secure payment links and send links via email and SMS. The payment links can be customised via the Blink portal.
\n","_postman_id":"2d9a4d25-e2cf-4075-9db3-7509f031a0c9"}],"event":[{"listen":"prerequest","script":{"id":"aa8f9686-1fe7-4d7f-8173-2a48f4c07f0e","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"16880418-c1b2-46ba-ae5b-08a3b75cb5c3","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"api_key","value":"eff458c623bba928a1a211521a7e38433bdf68780d0d8a16e2502f43cca322bc","type":"string"},{"key":"secret_key","value":"6310e48bdd0e4381459a62b46d2c4fd6e8ab65a2a4d5205c6c3ddebfbbaebbf8","type":"string"},{"key":"access_token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjaGFudF9pZCI6NDM5OCwic2VjcmV0X2tleSI6IjYzMTBlNDhiZGQwZTQzODE0NTlhNjJiNDZkMmM0ZmQ2ZThhYjY1YTJhNGQ1MjA1YzZjM2RkZWJmYmJhZWJiZjgiLCJleHAiOjE3MjA3MDcyNjZ9.91qa4veQ9xGVM-Jc_3_i_vaykEdYarRwUzb-37aLD0c","type":"string"},{"key":"payment_types","value":"","type":"string"},{"key":"payment_intent","value":"","type":"string"},{"key":"transaction_unique","value":"","type":"string"},{"key":"merchant_id","value":"233508","type":"string"},{"key":"intent_id","value":"5548","type":"string"},{"key":"transaction_id","value":"BL-2MUXYN2QLP","type":"string"},{"key":"paymentToken","value":"","type":"string"},{"key":"email","value":"","type":"string"},{"key":"paylink_id","value":"","type":"string"},{"key":"payment_id","value":"","type":"string"},{"key":"schedule_id","value":"270","type":"default"}]}