Get intent

Get details for a payment intent

Path Parameters

intent_id string required
The id of the payment intent

Responses

Response Headers

application/json

Schema
Example (from schema)
Example

Schema

id integer
payment_intent string
transaction_type string
expiry_date string
status string
amount number
currency string
payment_type string
return_url string
notification_url string
card_layout string
element object
ccElement string
ccMotoElement string
ddElement string
obElement string
merchant_id integer
transaction_unique string

{
  "id": 0,
  "payment_intent": "string",
  "transaction_type": "string",
  "expiry_date": "string",
  "status": "string",
  "amount": 0,
  "currency": "string",
  "payment_type": "string",
  "return_url": "string",
  "notification_url": "string",
  "card_layout": "string",
  "element": {
    "ccElement": "string",
    "ccMotoElement": "string",
    "ddElement": "string",
    "obElement": "string"
  },
  "merchant_id": 0,
  "transaction_unique": "string"
}

{
  "id": 123,
  "payment_intent": "pi_Swhc84aSLtUGppvPARX...",
  "transaction_type": "SALE",
  "expiry_date": "2023-04-19T10:19:17Z",
  "status": "active",
  "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..."
}

GET /api/pay/v1/intents/:intent_id

Authorization

name: Authorizationtype: apiKeyin: headerdescription: All requests apart from /api/pay/v1/tokens require an authorization header in the form of a bearer access_token. See the token endpoint documentation for further information.

Request

Base URL

https://secure.blinkpayment.co.uk

Authorization

intent_id — path required

curl / cURL
curl -L -X GET 'https://secure.blinkpayment.co.uk/api/pay/v1/intents/:intent_id' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

python / requests
curl -L -X GET 'https://secure.blinkpayment.co.uk/api/pay/v1/intents/:intent_id' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

go / native
curl -L -X GET 'https://secure.blinkpayment.co.uk/api/pay/v1/intents/:intent_id' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

nodejs / axios
curl -L -X GET 'https://secure.blinkpayment.co.uk/api/pay/v1/intents/:intent_id' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

ruby / Net::HTTP
curl -L -X GET 'https://secure.blinkpayment.co.uk/api/pay/v1/intents/:intent_id' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

csharp / RestSharp
curl -L -X GET 'https://secure.blinkpayment.co.uk/api/pay/v1/intents/:intent_id' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

php / cURL
curl -L -X GET 'https://secure.blinkpayment.co.uk/api/pay/v1/intents/:intent_id' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

java / OkHttp
curl -L -X GET 'https://secure.blinkpayment.co.uk/api/pay/v1/intents/:intent_id' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

powershell / RestMethod
curl -L -X GET 'https://secure.blinkpayment.co.uk/api/pay/v1/intents/:intent_id' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

Get intent​

Authorization

Request

Get intent