Secure token
Retrieve secure token
get/v1/frontend/tokens/{chargeTokenId}
Path parameters
chargeTokenIdstring required
Response
OK
Example response
{
"charge": {
"agreement": {
"agreement_id": "iaouobo39hiv0m2560q45j3p04",
"created_date": "2022-06-27T13:07:57.58Z",
"description": "Description for the paying user describing the purpose of the agreement",
"reference": "Service agreement reference",
"service_id": "Service external ID",
"user_identifier": "reference for the paying user"
},
"agreement_id": "md1mjge8gb6p4qndfs8mf8gto5",
"amount": 100,
"auth_3ds_data": {
"issuerUrl": "https://3ds-secure-redirect-url.example.org",
"md": "NnheOml4nhgrnx...pP6oBb3KQqKXiYGL3X8=",
"paRequest": "eNpVUttygjAQ/R...jI+ts3+f4Afk4a3Y"
},
"auth_code": "91011",
"authorisation_mode": "web",
"authorisation_summary": {
"three_d_secure": {
"required": true,
"version": "2.1.0"
}
},
"authorised_date": "2022-06-28T16:05:33Z",
"card_brand": "Visa",
"card_details": {
"billing_address": {
"city": "London",
"country": "GB",
"county": "county",
"line1": "Address line 1",
"line2": "Address line 2",
"postcode": "AB1 2CD"
},
"card_brand": "Visa",
"card_type": "debit",
"cardholder_name": "Joe B"
},
"charge_id": "b02b63b370fd35418ad66b0101",
"created_date": "2022-06-28T09:24:45.715Z",
"description": "payment description",
"email": "Joe.Bogs@example.org",
"exemption": {
"exemption": {
"requested": true
}
},
"fee": 10,
"gateway_account": {
"allow_apple_pay": true,
"allow_google_pay": true,
"block_prepaid_cards": true,
"card_types": [
{
"brand": "visa",
"id": "ac8a3abd-bcfd-4fa6-8905-321ce913e7f5",
"label": "Visa",
"type": "DEBIT"
}
],
"external_id": "fbf905a3f7ea416c8c252410eb45ddbd",
"gateway_account_id": 1,
"gateway_merchant_id": "abc123",
"integration_version_3ds": 2,
"payment_provider": "sandbox",
"requires3ds": true,
"service_id": "cd1b871207a94a7fa157dee678146acd",
"service_name": "service name",
"type": "test"
},
"gateway_transaction_id": "5422624d-12b1-4821-8b26-d0383ecf1602",
"language": "en",
"links": [
{
"href": "https://connector.example.com/v1/api/charges/b02b63b370fd35418ad66b0101",
"method": "GET",
"rel": "self"
},
{
"href": "https://frontend.example.com/charges/1?chargeTokenId=82347",
"method": "GET",
"rel": "next_url"
},
{
"href": "https://connector.example.com//v1/api/accounts/1/charges/b02b63b370fd35418ad66b0101/refunds",
"method": "GET",
"rel": "refunds"
}
],
"net_amount": 90,
"payment_outcome": {
"code": "P0010",
"status": "failed",
"supplemental": {
"error_code": "E1234",
"error_message": "The payment card does not exist"
}
},
"payment_provider": "sandbox",
"processor_id": "12345",
"provider_id": "45678",
"refund_summary": {
"amount_available": 100,
"status": "available",
"user_external_id": "sk03k2pojvsojd1po2joij92pspodrkwpenl"
},
"return_url": "https://service-name.gov.uk/transactions/12345",
"settlement_summary": {
"capture_submit_time": "2022-06-28T09:26:45.715Z",
"captured_date": "2022-06-28"
},
"state": {
"can_retry": true,
"code": "P0010",
"finished": true,
"message": "Payment method rejected",
"status": "success"
},
"telephone_number": "+44000000000",
"wallet_type": "APPLE_PAY"
}
}