| Anchor | ||||
|---|---|---|---|---|
|
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-carddirect-debitopen-banking
transaction_type string (optional)
Default value is set to SALE. If passed, it can only be one of the following:
SALEVERIFYPREAUTHREFUND_SALEREFUNDCAPTURECANCEL
delay_capture_daysinteger (optional)
Number of days, the transaction will be delayed for. This field can be passed only for SALE, REFUND_SALE and REFUND type transaction.
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.
card_layoutstring (optional)
To get different structure of card layout for any transaction , this parameter is passed. This field is optional. If not passed, default value is basic.
basicsingle-linemulti-line
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,
"transaction_type": "SALE",
"delay_capture_days": 3,
"payment_type": "credit-card",
"currency": "GBP",
"return_url": "https://mydomain.com/return",
"notification_url": "https://mydomain.com/notification"
} |
Response
| Code Block |
|---|
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": 123,
"payment_intent": "pi_Swhc84aSLtUGppvPARX...",
"transaction_type": "SALE",
"expiry_date": "2023-04-19T10:19:17Z",
"amount": 1.01,
"currency": "GBP",
"payment_type": "credit-card",
"return_url": "https://mydomain.com/return",
"notification_url": "https://mydomain.com/notification",
"card_layout": "single-line",
"element": {
"ccElement": "<input type=\"hidden\" name=\"merchantID\" value=\"14456\"/>\n <input type=\"hidden\" name=\"payment_intent\" value=\"pi_pqXuNE8rO************************1I2uPcipp1d8qSDTSPIucQyrNNa1UiyBYsBTCffUn9zkGVd3a_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=\"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=\"145671\"/>\n <input type=\"hidden\" name=\"payment_intent\" value=\"pi_pqXuNE8rOEmUN0vtQqgf8NnkuQJq4LyOVVz-nz*************************QyrNNa1UiyBYsBTCffUn9zkGVd3a_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_pqXuNE8rOEmUN0vtQqgf8NnkuQJq4LyOVVz-nzcR81I2uPcipp1d8qSDTSPIucQyrNNa1UiyBYsBTCffU*******************uxXgNb-LD5jaMk\"/>\n <input type=\"hidden\" name=\"transaction_unique\" value=\"OiXWrlnKvvfh\"/>\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 <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=\"140567\"/>\n <input type=\"hidden\" name=\"payment_intent\" value=\"pi_pqXuNE8rOEmUN0vtQq*************************d8qSDTSPIucQyrNNa1UiyBYsBTCffUn9zkGVd3a_94uxXgNb-LD5jaMk\"/>\n <input type=\"hidden\" name=\"resource\" value=\"openbankings\"/>\n <input type=\"hidden\" name=\"transaction_unique\" value=\"OiXWrlnKvvfh\"/>\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 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...",
"transaction_type": "SALE",
"expiry_date": "2023-04-19T10:19:17Z",
"amount": 1.01,
"currency": "GBP",
"payment_type": "credit-card",
"return_url": "https://mydomain.com/return",
"notification_url": "https://mydomain.com/notification",
"card_layout": "single-line",
"element": {
"ccElement": "<input type=\"hidden\" name=\"merchantID\" value=\"140****\"/>\n <input type=\"hidden\" name=\"payment_intent\" value=\"pi_pqXuNE8rOEmUN0vtQqgf*******************8qSDTSPIucQyrNNa1UiyBYsBTCffUn9zkGVd3a_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=\"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=\"146***\"/>\n <input type=\"hidden\" name=\"payment_intent\" value=\"pi_pqXuNE8rOEmUN0vtQqgf8NnkuQJq4LyO*********************1d8qSDTSPIucQyrNNa1UiyBYsBTCffUn9zkGVd3a_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_pqXu******************************************XgNb-LD5jaMk\"/>\n <input type=\"hidden\" name=\"transaction_unique\" value=\"OiXWrlnKvvfh\"/>\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 <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=\"14*****\"/>\n <input type=\"hidden\" name=\"payment_intent\" value=\"pi_pqXuNE8rOEmUN0vtQqgf8NnkuQJq4Ly**********************SDTSPIucQyrNNa1UiyBYsBTCffUn9zkGVd3a_94uxXgNb-LD5jaMk\"/>\n <input type=\"hidden\" name=\"resource\" value=\"openbankings\"/>\n <input type=\"hidden\" name=\"transaction_unique\" value=\"OiXWrlnKvvfh\"/>\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 | ||||
|---|---|---|---|---|
|
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...",
"transaction_type": "SALE",
"expiry_date": "2023-04-19T11:19:17Z",
"amount": 1.01,
"currency": "GBP",
"payment_type": "credit-card",
"return_url": "https://mydomain.com/return",
"notification_url": "https://mydomain.com/notification",
"card_layout": "single-line",
"element": {
"ccElement": "<input type=\"hidden\" name=\"merchantID\" value=\"1235\"/>\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=\"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=\"1235\"/>\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_pqX************************z-nzcR81I2uPcipp1d8qSDTSPIucQyrNNa1UiyBYsBTCffUn9zkGVd3a_94uxXgNb-LD5jaMk\"/>\n <input type=\"hidden\" name=\"transaction_unique\" value=\"OiXWrlnKvvfh\"/>\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 <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=\"1235\"/>\n <input type=\"hidden\" name=\"payment_intent\" value=\"pi_pqXuNE8rOEmUN0vtQqgf8NnkuQJq4LyOVVz-nzcR81I2uPcipp1d8qSDTSPIucQyrNNa1UiyBYsBTCffUn9zkGVd3a_94uxXgNb-LD5jaMk\"/>\n <input type=\"hidden\" name=\"resource\" value=\"openbankings\"/>\n <input type=\"hidden\" name=\"transaction_unique\" value=\"OiXWrlnKvvfh\"/>\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..."
} |