Get a Payment Setup
Beta
Retrieves a Payment Setup by its unique identifier.
Path Parameters
- Type: stringidrequired
The unique identifier of the Payment Setup to retrieve.
Responses
- application/json
- 401
Authentication failed. Provide a valid API key.
- 403
You do not have permission to retrieve this Payment Setup.
Request Example for get/payments/setups/{id}
Shell Curl
curl 'https://{prefix}.api.sandbox.checkout.com/payments/setups/{id}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
"id": "string",
"processing_channel_id": "pc_q4dbxom5jbgudnjzjpz7j2z6uq",
"amount": 10000,
"currency": "GBP",
"presentment_details": {
"amount": 110,
"currency": "EUR"
},
"payment_type": "regular",
"reference": "REF-0987-475",
"description": "Set of 3 t-shirts",
"payment_methods": {
"auto_confirm": "card",
"instrument": {
"status": "ready",
"flags": [
"string"
],
"id": "src_wmlfc3zttb4uzmk6snpwb43jbi",
"type": "bacs",
"action": {
"type": "set_instrument"
}
},
"klarna": {
"status": "ready",
"flags": [
"string"
],
"initialization": "disabled",
"action": {
"type": "sdk",
"client_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.ewogICJzZXNzaW9uX2lkIiA6ICIw",
"session_id": "0b1d9815-165e-42e2-8867-35bc03789e00"
},
"account_holder": {
"name": "string"
},
"iban": "DE89370400440532013000"
},
"stcpay": {
"status": "ready",
"flags": [
"string"
],
"initialization": "disabled",
"action": {
"type": "otp"
}
},
"tabby": {
"status": "ready",
"flags": [
"string"
],
"initialization": "disabled",
"payment_types": [
"pay_later"
]
},
"bizum": {
"status": "ready",
"flags": [
"string"
]
},
"paynow": {
"status": "ready",
"flags": [
"string"
]
},
"qpay": {
"status": "ready",
"flags": [
"string"
],
"description": "string"
},
"eps": {
"status": "ready",
"flags": [
"string"
]
},
"ideal": {
"status": "ready",
"flags": [
"string"
],
"description": "2 t-shirts"
},
"knet": {
"status": "ready",
"flags": [
"string"
],
"language": "en"
},
"bancontact": {
"status": "ready",
"flags": [
"string"
],
"account_holder_name": "string"
},
"benefit": {
"status": "ready",
"flags": [
"string"
]
},
"blik": {
"status": "ready",
"flags": [
"string"
]
},
"vipps": {
"status": "ready",
"flags": [
"string"
]
},
"twint": {
"status": "ready",
"flags": [
"string"
]
},
"alipay_cn": {
"status": "ready",
"flags": [
"string"
],
"terminal_type": "web",
"os_type": "android"
},
"alipay_hk": {
"status": "ready",
"flags": [
"string"
],
"terminal_type": "web",
"os_type": "android"
},
"gcash": {
"status": "ready",
"flags": [
"string"
],
"terminal_type": "web",
"os_type": "android"
},
"tng": {
"status": "ready",
"flags": [
"string"
],
"terminal_type": "web",
"os_type": "android"
},
"dana": {
"status": "ready",
"flags": [
"string"
],
"terminal_type": "web",
"os_type": "android"
},
"mobilepay": {
"status": "ready",
"flags": [
"string"
]
},
"tamara": {
"status": "ready",
"flags": [
"string"
],
"initialization": "disabled",
"risk_assessment": {
"premium_customer": false,
"risk_score": 42,
"order_count_last24h": 0,
"linked_device_count": 2
}
},
"mbway": {
"status": "ready",
"flags": [
"string"
]
},
"multibanco": {
"status": "ready",
"flags": [
"string"
],
"account_holder_name": "string"
},
"wechatpay": {
"status": "ready",
"flags": [
"string"
]
},
"kakaopay": {
"status": "ready",
"flags": [
"string"
],
"terminal_type": "web",
"os_type": "android"
},
"truemoney": {
"status": "ready",
"flags": [
"string"
],
"terminal_type": "web",
"os_type": "android"
},
"octopus": {
"status": "ready",
"flags": [
"string"
]
},
"p24": {
"status": "ready",
"flags": [
"string"
],
"account_holder": {
"name": "string",
"email": "hello@example.com"
}
},
"alma": {
"status": "ready",
"flags": [
"string"
]
},
"swish": {
"status": "ready",
"flags": [
"string"
],
"billing_descriptor": "string",
"account_holder": {
"first_name": "John",
"last_name": "Smith"
}
},
"sequra": {
"status": "ready",
"flags": [
"string"
]
},
"ach": {
"status": "ready",
"flags": [
"string"
],
"account_type": "savings",
"account_holder": {
"type": "individual",
"first_name": "string",
"last_name": "string",
"company_name": "string",
"date_of_birth": "string"
},
"country": "string"
},
"sepa": {
"status": "ready",
"flags": [
"string"
],
"account_holder": {
"type": "individual",
"first_name": "string",
"last_name": "string",
"company_name": "string"
},
"country": "string",
"currency": "string",
"mandate": {
"id": "string",
"type": "core",
"date_of_signature": "2026-09-23"
}
},
"bacs": {
"status": "ready",
"flags": [
"string"
],
"initialization": "disabled",
"instrument_id": "src_wkq7552u245upl5h75x24554xy",
"account_holder": {
"type": "individual",
"first_name": "string",
"last_name": "string",
"company_name": "string",
"email": "john.smith@example.com"
},
"country": "string",
"currency": "string",
"allow_partial_match": false
},
"paybybank": {
"status": "ready",
"flags": [
"string"
],
"bank_id": "ob-natwest",
"action": {
"type": "select_bank",
"banks": [
{
"bank_id": "ob-natwest",
"display_name": "NatWest",
"logo_url": "https://cdn.token.io/banks/natwest.png",
"available": true
}
]
}
},
"paypal": {
"status": "ready",
"flags": [
"string"
],
"initialization": "disabled",
"user_action": "pay_now",
"brand_name": "Acme Corporation",
"shipping_preference": "no_shipping",
"action": {
"type": "sdk",
"order_id": "dd4b1a85-31de-404b-99f4-f143f8ba35ba"
}
},
"googlepay": {
"status": "ready",
"flags": [
"string"
],
"token": {
"id": "string",
"expires_on": "2026-09-23T13:52:07.856Z"
},
"phone": {
"country_code": "+44",
"number": "207 946 0000"
},
"account_holder": {
"type": "individual",
"first_name": "string",
"last_name": "string",
"middle_name": "string",
"company_name": "string",
"account_name_inquiry": true
},
"schemes": [
"accel"
],
"preferred_scheme": "visa"
},
"applepay": {
"status": "ready",
"flags": [
"string"
],
"token": {
"id": "string",
"expires_on": "2026-09-23T13:52:07.856Z"
},
"phone": {
"country_code": "+44",
"number": "207 946 0000"
},
"account_holder": {
"type": "individual",
"first_name": "string",
"last_name": "string",
"middle_name": "string",
"company_name": "string",
"account_name_inquiry": true
},
"schemes": [
"accel"
],
"preferred_scheme": "visa"
},
"card": {
"status": "ready",
"flags": [
"string"
],
"token": {
"id": "string"
},
"details": {
"last4": "string",
"bin": "string",
"scheme": "string",
"expiry_month": 1,
"expiry_year": 1,
"expires_on": "2026-09-23T13:52:07.856Z",
"allow_update": true
},
"phone": {
"country_code": "+44",
"number": "207 946 0000"
},
"account_holder": {
"type": "individual",
"first_name": "string",
"last_name": "string",
"middle_name": "string",
"company_name": "string",
"account_name_inquiry": true
},
"schemes": [
"accel"
],
"preferred_scheme": "visa"
},
"stablecoin": {
"status": "ready",
"flags": [
"string"
]
}
},
"available_payment_methods": [
"card",
"klarna",
"stcpay",
"stablecoin"
],
"settings": {
"success_url": "https://example.com/payments/success",
"failure_url": "https://example.com/payments/fail",
"capture": true,
"excluded_payment_methods": [
"card",
"klarna",
"stcpay"
]
},
"risk": {
"enabled": true
},
"customer": {
"country": "GB",
"id": "cus_123456789",
"email": {
"address": "johnsmith@example.com",
"verified": true
},
"name": "John Smith",
"tax_number": "GB123456789",
"phone": {
"country_code": "+44",
"number": "207 946 0000"
},
"device": {
"locale": "en_GB"
},
"merchant_account": {
"id": "1234",
"registration_date": "2023-05-01",
"last_modified": "2023-05-01",
"returning_customer": true,
"first_transaction_date": "2023-09-15",
"last_transaction_date": "2025-03-28",
"total_order_count": 6,
"last_payment_amount": 55.99
}
},
"order": {
"items": [
{
"name": "Battery Power Pack",
"quantity": 1,
"unit_price": 1000,
"total_amount": 1000,
"reference": "BA67A",
"discount_amount": 150,
"url": "https://example.com/products/my-item",
"image_url": "https://example.com/products/my-item/image",
"type": "digital"
}
],
"shipping": {
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"phone": {
"country_code": "+44",
"number": "207 946 0000"
},
"address": {
"address_line1": "10 Canterbury Road",
"address_line2": "Flat 2",
"city": "London",
"state": "Greater London",
"zip": "NE1 1KO",
"country": "GB"
},
"method": "string",
"delay": 3
},
"sub_merchants": [
{
"id": "SUB12345",
"product_category": "Electronics",
"number_of_sales": 500,
"registration_date": "2023-01-15"
}
],
"invoice_id": "inv_123456789",
"shipping_amount": 5,
"discount_amount": 10,
"tax_amount": 2,
"tipping_amount": 2,
"surcharge_amount": 2,
"amount_allocations": [
{
"id": "ent_w4jelhppmfiufdnatam37wrfc4",
"amount": 1000,
"reference": "ORD-5023-4E89",
"commission": {
"amount": 1000,
"percentage": 1.125
}
}
]
},
"billing": {
"address": {
"address_line1": "10 Canterbury Road",
"address_line2": "Flat 2",
"city": "London",
"state": "Greater London",
"zip": "NE1 1KO",
"country": "GB"
}
},
"industry": {
"airline": [
{
"ticket": {
"number": "0742464639523",
"issue_date": "2025-05-01",
"issuing_carrier_code": "042",
"travel_package_indicator": "A",
"travel_agency_name": "Checkout Travel Agents",
"travel_agency_code": "91114362"
},
"passengers": [
{
"first_name": "John",
"last_name": "Smith",
"date_of_birth": "1990-10-31",
"address": {
"country": "GB"
}
}
],
"flight_leg_details": [
{
"flight_number": "BA1483",
"carrier_code": "BA",
"class_of_travelling": "W",
"departure_airport": "LHR",
"departure_date": "2025-10-13",
"departure_time": "18:30",
"arrival_airport": "JFK",
"stop_over_code": "X",
"fare_basis_code": "WUP14B"
}
],
"total_number_of_passengers": 1,
"travel_type": "international",
"trip_type": "one_way",
"refundable": true,
"delivery_recipient": "jane.smith@example.com",
"ancillaries": "extra_baggage",
"insurance": {
"type": "travel",
"company": "AXA",
"price": {
"amount": 500,
"currency": "SAR"
}
}
}
],
"accommodation": [
{
"name": "Checkout Lodge",
"booking_reference": "REF9083748",
"check_in_date": "2025-04-11",
"check_out_date": "2025-04-18",
"address": {
"address_line1": "123 High Street",
"city": "London",
"state": "Greater London",
"country": "GB",
"zip": "NE1 1CK"
},
"number_of_rooms": 2,
"guests": [
{
"first_name": "John",
"last_name": "Smith",
"date_of_birth": "1970-03-19"
}
],
"room": [
{
"rate": 42.3,
"number_of_nights": 5,
"type": "deluxe"
}
],
"total_number_of_guests": 2,
"refundable": true,
"delivery_recipient": "jane.smith@example.com",
"host": {
"registration_date": "2020-01-01",
"total_reservation_count": 150
}
}
]
},
"account_funding_transaction": {
"enabled": true,
"purpose": "financial_services",
"sender": {
"date_of_birth": "2000-01-01",
"reference": "0fc88634-78c1-4286-9cb6-6ca358730c8c",
"identification": {
"type": "passport",
"number": "1234567890",
"issuing_country": "US"
}
},
"recipient": {
"date_of_birth": "2000-01-01",
"account_number": "string",
"first_name": "string",
"last_name": "string",
"address": {
"address_line1": "10 Canterbury Road",
"address_line2": "Flat 2",
"city": "London",
"state": "Greater London",
"zip": "NE1 1KO",
"country": "GB"
}
}
},
"terminal": {
"id": "12345678",
"local_date_time": "2026-05-26T13:05:14+01:00"
},
"billing_descriptor": {
"name": "Checkout.com",
"city": "London",
"reference": "Payment for order 123456"
},
"metadata": {
"additionalProperty": "string"
},
"latest_payment": {}
}