Page Comparison

Anchor
create-intent
create-intent

Create intent

POST /pay/v1/intents

Headers

Content-Typestring
Content type.

Authorizationstring
Access token generated from create token request.

Attributes

amountfloat
Transaction amount.

payment_type string
Can only be one of the following:

credit-card
direct-debit
open-banking

currency string
Three letter currency code (ISO 4217) e.g USD, GBP.

reutrn_url string
GET URL on your domain, where Blink will redirect after transaction is processed e.g. https://mydomain.com/return.

notification_url string
POST URL on your domain, where Blink will send status updates when the transaction status is changed e.g. https://mydomain.com/notification.

customer_name string (optional)
Customer name.

customer_email string (optional)
Customer email.

customer_address string (optional)
Customer address.

customer_postcode string (optional)
Customer postcode.

Request

Code Block

POST https://secure.blinkpayment.co.uk/api/pay/v1/intents HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...

{
    "amount": 1.01,
    "payment_type": "credit-card",
    "currency": "GBP",
    "return_url": "https://mydomain.com/return",
    "notification_url": "https://mydomain.com/notification"
}

Response

Code Block

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 123,
    "payment_intent": "pi_Swhc84aSLtUGppvPARX...",
    "amount": 1.01,
    "currency": "GBP",
    "payment_type": "credit-card",
    "return_url": "https://mydomain.com/return",
    "notification_url": "https://mydomain.com/notification",
    "element": {
        "ccElement": "<input type=\"hidden\" name=\"merchantID\" value=\"1478997140841\"/>\n              <input type=\"hidden\" name=\"payment_intent\" value=\"pi_Qt1xKdGzi-Ny***************4byN0g3yuSYBIaRUQ9-AioQg6IiidUZFLNl3mvmVZGzvHUOX2luESfVBxmhj8pqXuNE8rOEmUN0vtQqgf8NnkuQJq4LyOVVz-nzcR81I2uPcipp1d8qSDTSPIucQyrNNa1UiyBYsBTCffUn9zkGVd3a_94uxXgNb-LD5jaMk\"/>\n <input type=\"hidden\" name=\"resource\" value=\"creditcards\"/>\n   <input type=\"hidden\" name=\"transaction_unique\" value=\"Ha6TP**OiXWrlnKvvfh\"/>\n              <input type=\"text\" name=\"customer_name\" value=\"\" placeholder=\"Name on card\" /><br>\n     <input type=\"text\" name=\"customer_email\" value=\"\" placeholder=\"Email\"/><br><input type=\"text\" placeholder=\"Address\" name=\"customer_address\" value=\"\" /><br>\n <input type=\"text\" placeholder=\"             <input type=\"text\" placeholder=\"Postcode\" name=\"customer_postcode\" value=\"\" /><br><input type=\"hostedfield:cardNumber\" placeholder=\"1234 1234 1234 1234\"/><br>\n  <input type=\"hostedfield:cardExpiryDate\" placeholder=\"MM/YY\"/><br>\n  <input type=\"hostedfield:cardCVV\" placeholder=\"CVV\"/><br>\n <input type=\"hostedfield:cardCVV\" placeholder=\"CVV  <input type=\"hidden\" id=\"device_timezone\" name=\"device_timezone\" /><br>\n  <input type=\"hidden\" id=\"device_capabilities\" name=\"device_capabilities\" /><br>\n <input type=\"hidden\" id=\"device_accept_language\" name=\"device_accept_language\" /><br>\n  <input type=\"hidden\" id=\"device_screen_resolution\" name=\"device_screen_resolution\" /><br>\n <input type=\"hidden\" id=\"remote_address\" name=\"remote_address\" /><br>\n input type=\"hidden\" id=\"type\" name=\"type\" value=\"1\"/><br>",
        "ccMotoElement": "<input type=\"hidden\" name=\"merchantID\" value=\"140841\"/>\n              <input type=\"hidden\" name=\"payment_intent\" value=\"pi_pqXuNE8rOEmUN0vtQqgf8NnkuQJq4LyOVVz-nzcR81I2uPcipp1d8qSDTSPIucQyrNNa1UiyBYsBTCffUn9zkGVd3a_94uxXgNb-LD5jaMk\"/>\n  <input type=\"hidden\" name=\"resource\" value=\"creditcards\"/>\n   <input type=\"hidden\" name=\"transaction_unique\" value=\"OiXWrlnKvvfh\"/>\n              <input type=\"text\" name=\"customer_name\" value=\"\" placeholder=\"Name on card\" /><br>\n     <input type=\"text\" name=\"customer_email\" value=\"\" placeholder=\"Email\"/><br><input type=\"text\" placeholder=\"Address\" name=\"customer_address\" value=\"\" /><br>\n              <input type=\"text\" placeholder=\"Postcode\" name=\"customer_postcode\" value=\"\" /><br><input type=\"hostedfield:cardNumber\" placeholder=\"1234 1234 1234 1234\"/><br>\n  <input type=\"hostedfield:cardExpiryDate\" placeholder=\"MM/YY\"/><br>\n  <input type=\"hostedfield:cardCVV\" placeholder=\"CVV\"/><br>\n <input type=\"hidden\" id=\"type\" name=\"type\" value=\"2\"/><br>",
        "ddElement": "<input type=\"hidden\" name=\"payment_intent\" value=\"pi_Qt1xKdGzipqXuNE8rOEmUN0vtQqgf8NnkuQJq4LyOVVz-Ny1zeasZKyrKw7teoCwEoc__AetX1P_Nnvt54byN0g3yuSYBIaRUQ9-A******************************OX2luESfVBxmhj8nzcR81I2uPcipp1d8qSDTSPIucQyrNNa1UiyBYsBTCffUn9zkGVd3a_94uxXgNb-LD5jaMk\"/>\n  <input type=\"hidden\" name=\"transaction_unique\" value=\"Ha6TPerZ2LYuOiXWrlnKvvfh\"/>\n   <input type=\"hidden\" name=\"resource\" value=\"directdebits\"/>\n   <input type=\"text\" placeholder=\"Given Name\" name=\"given_name\"/><br>\n              <input type=\"text\" placeholder=\"Family Name\" name=\"family_name\"/><br>\n><br>\n              <input type=\"text\" placeholder=\"Company Name\" name=\"company_name\"/><br>\n              <input type=\"text\" placeholder=\"Email\" name=\"email\"/><br><input type=\"text\" placeholder=\"Address\" name=\"customer_address\" value=\"\" /><br>\n <input type=\"text\" placeholder=\"Postcode\" name=\"customer_postcode\" value=\"\" /><br><input type=\"text\" placeholder=\"Account Holder Name\" name=\"account_holder_name\"/><br>\n           <input type=\"text\" placeholder=\"Branch Code\" name=\"branch_code\"/><br>\n              <input type=\"text\" placeholder=\"Bank Account Number\" name=\"account_number\"/><br>",
        "obElement": "<input type=\"hidden\" name=\"merchant_id\" value=\"140841\"/>\n              <input type=\"hidden\" name=\"payment_intent\" value=\"pi_Qt1xKdGzi-Ny1**********************P_Nnvt54byN0g3yuSYBIaRUQ9-AioQg6IiidUZFLNl3mvmVZGzvHUOX2luESfVBxmhj8pqXuNE8rOEmUN0vtQqgf8NnkuQJq4LyOVVz-nzcR81I2uPcipp1d8qSDTSPIucQyrNNa1UiyBYsBTCffUn9zkGVd3a_94uxXgNb-LD5jaMk\"/>\n  <input type=\"hidden\" name=\"resource\" value=\"openbankings\"/>\n  <input type=\"hidden\" name=\"transaction_unique\" value=\"Ha6TPerZ2LYuOiXWrlnKvvfh\"/>\n              <input type=\"text\" name=\"user_name\" value=\"\" placeholder=\"Name on card\" /><br>\n         <input type=\"text\" name=\"user_email\" value=\"\" placeholder=\"Email\"/><br><input type=\"text\" placeholder=\"Address\" name=\"customer_address\" value=\"\" /><br>\n              <input type=\"text\" placeholder=\"Postcode\" name=\"customer_postcode\" value=\"\" /><br>"
    },
    "merchant_id": 134857,
    "transaction_unique": "xbKXyWkIL..."
}

Anchor
get-intent
get-intent

Get intents

GET /pay/v1/pay/intents/{id}

Headers

Content-Typestring
Content type.

Authorizationstring
Access token generated from create token request.

Request

Code Block
GET https://secure.blinkpayment.co.uk/api/pay/v1/intents/123 HTTP/1.1 Content-Type: application/json Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG...

Response

Code Block

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 123,
    "payment_intent": "pi_Swhc84aSLtUGppvPARX...",
    "amount": 1.01,
    "currency": "GBP",
    "payment_type": "credit-card",
    "return_url": "https://mydomain.com/return",
    "notification_url": "https://mydomain.com/notification",
    "element": {
        "ccElement": "<input type=\"hidden\" name=\"merchantID\" value=\"123456\"/>\n              <input type=\"hidden\" name=\"payment_intent\" value=\"pi_Swhc84aSLtUGppvPARX...\"/>\n              <input type=\"text\" name=\"customer_name\" value=\"\" placeholder=\"Name on card\" /></br>\n              <input type=\"text\" name=\"customer_email\" value=\"\" placeholder=\"Email\"/></br><input type=\"text\" placeholder=\"Address\" name=\"customer_address\"/><br>\n                  <input type=\"text\" placeholder=\"Postcode\" name=\"customer_postcode\"/><br><input type=\"hostedfield:cardNumber\" placeholder=\"1234 1234 1234 1234\"/><br>\n               <input type=\"hostedfield:cardExpiryDate\" placeholder=\"MM/YY\"/><br>\n               <input type=\"hostedfield:cardCVV\" placeholder=\"CVV\"/>",
        "ddElement": "<input type=\"hidden\" name=\"payment_intent\" value=\"pi_Swhc84aSLtUGppvPARX...\"/>\n              <input type=\"hidden\" name=\"unique_transaction\" value=\"xbKXyWkILDda\"/>\n              <input type=\"text\" placeholder=\"Given Name\" name=\"given_name\"/><br>\n              <input type=\"text\" placeholder=\"Family Name\" name=\"family_name\"/><br>\n              <input type=\"text\" placeholder=\"Company Name\" name=\"company_name\"/><br>\n              <input type=\"text\" placeholder=\"Email\" name=\"email\"/><br><input type=\"text\" placeholder=\"Address\" name=\"customer_address\"/><br>\n                  <input type=\"text\" placeholder=\"Postcode\" name=\"customer_postcode\"/><br><input type=\"text\" placeholder=\"Account Holder Name\" name=\"account_holder_name\"/><br/>\n              <input type=\"text\" placeholder=\"Branch Code\" name=\"branch_code\"/><br/>\n              <input type=\"text\" placeholder=\"Bank Account Number\" name=\"account_number\"/>",
        "obElement": "<input type=\"hidden\" name=\"merchant_id\" value=\"123456\"/>\n              <input type=\"hidden\" name=\"payment_intent\" value=\"pi_Swhc84aSLtUGppvPARX...\"/>\n              <input type=\"text\" name=\"user_name\" value=\"\" placeholder=\"Name on card\" /></br>\n              <input type=\"text\" name=\"user_email\" value=\"\" placeholder=\"Email\"/><input type=\"text\" placeholder=\"Address\" name=\"customer_address\"/><br>\n                  <input type=\"text\" placeholder=\"Postcode\" name=\"customer_postcode\"/><br>"
    },
    "merchant_id": 134857,
    "transaction_unique": "xbKXyWkIL..."
}

Anchor
update-intent
update-intent

Update intents

PATCH /pay/v1/intents/{id}

Headers

Content-Typestring
Content type.

Authorizationstring
Access token generated from create token request.

Attributes

return_urlstring (optional)
Return url.

notification_urlstring (optional)
Notification url.

Request

Code Block
PATCH https://secure.blinkpayment.co.uk/api/pay/v1/intents/{id} HTTP/1.1 Content-Type: application/json Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG... { "return_url": "https://mydomain.com/return" }

Response

Code Block

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 123,
    "payment_intent": "pi_Swhc84aSLtUGppvPARX...",
    "amount": 1.01,
    "currency": "GBP",
    "payment_type": "credit-card",
    "return_url": "https://mydomain.com/return",
    "notification_url": "https://mydomain.com/notification",
    "element": {
        "ccElement": "<input type=\"hidden\" name=\"merchantID\" value=\"123456\"/>\n              <input type=\"hidden\" name=\"payment_intent\" value=\"pi_Swhc84aSLtUGppvPARX...\"/>\n              <input type=\"text\" name=\"customer_name\" value=\"\" placeholder=\"Name on card\" /></br>\n              <input type=\"text\" name=\"customer_email\" value=\"\" placeholder=\"Email\"/></br><input type=\"text\" placeholder=\"Address\" name=\"customer_address\"/><br>\n                  <input type=\"text\" placeholder=\"Postcode\" name=\"customer_postcode\"/><br><input type=\"hostedfield:cardNumber\" placeholder=\"1234 1234 1234 1234\"/><br>\n               <input type=\"hostedfield:cardExpiryDate\" placeholder=\"MM/YY\"/><br>\n               <input type=\"hostedfield:cardCVV\" placeholder=\"CVV\"/>",
        "ddElement": "<input type=\"hidden\" name=\"payment_intent\" value=\"pi_Swhc84aSLtUGppvPARX...\"/>\n              <input type=\"hidden\" name=\"unique_transaction\" value=\"xbKXyWkILDda\"/>\n              <input type=\"text\" placeholder=\"Given Name\" name=\"given_name\"/><br>\n              <input type=\"text\" placeholder=\"Family Name\" name=\"family_name\"/><br>\n              <input type=\"text\" placeholder=\"Company Name\" name=\"company_name\"/><br>\n              <input type=\"text\" placeholder=\"Email\" name=\"email\"/><br><input type=\"text\" placeholder=\"Address\" name=\"customer_address\"/><br>\n                  <input type=\"text\" placeholder=\"Postcode\" name=\"customer_postcode\"/><br><input type=\"text\" placeholder=\"Account Holder Name\" name=\"account_holder_name\"/><br/>\n              <input type=\"text\" placeholder=\"Branch Code\" name=\"branch_code\"/><br/>\n              <input type=\"text\" placeholder=\"Bank Account Number\" name=\"account_number\"/>",
        "obElement": "<input type=\"hidden\" name=\"merchant_id\" value=\"123456\"/>\n              <input type=\"hidden\" name=\"payment_intent\" value=\"pi_Swhc84aSLtUGppvPARX...\"/>\n              <input type=\"text\" name=\"user_name\" value=\"\" placeholder=\"Name on card\" /></br>\n              <input type=\"text\" name=\"user_email\" value=\"\" placeholder=\"Email\"/><input type=\"text\" placeholder=\"Address\" name=\"customer_address\"/><br>\n                  <input type=\"text\" placeholder=\"Postcode\" name=\"customer_postcode\"/><br>"
    },
    "merchant_id": 134857,
    "transaction_unique": "xbKXyWkIL..."
}

Version	Old Version 32	New Version 33
Changes made by	Sainita Mukherjee	Sainita Mukherjee
Saved on	28 March 2023	29 March 2023

Versions Compared

Key

Anchor
create-intent
create-intent

Create intent

Anchor
get-intent
get-intent

Get intents

Anchor
update-intent
update-intent

Update intents

Page Comparison

Versions Compared

Key

Anchorcreate-intentcreate-intentCreate intent

Anchorget-intentget-intentGet intents

Anchorupdate-intentupdate-intentUpdate intents

Anchor
create-intent
create-intent

Create intent

Anchor
get-intent
get-intent

Get intents

Anchor
update-intent
update-intent

Update intents