Payments
Get payment lists
Returns a list of your business' payments that match the specified reference. Results are returned in reverse chronological order, with the most recent payments shown first.
This will only return payments initiated from June 2022 onwards. Payments initiated before this date may return a 404 error code if you attempt to retrieve them.
get/payments
Request
- Base URLhttps://{prefix}.api.sandbox.checkout.com
- Auth
- OAuth 2Client credentialsToken URLstringScopesgateway, gateway:payment-details
- or API key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
limitinteger
The numbers of results to retrieve
skipinteger
The number of results to skip
referencestring required
A reference, such as an order ID, that can be used to identify the payment
Response
Payments retrieved successfully
Example response
{
"limit": 10,
"skip": 10,
"total_count": 1,
"data": [
{
"id": "pay_mbabizu24mvu3mela5njyhpit4",
"source": {
"id": "src_nwd3m4in3hkuddfpjsaevunhdy",
"billing_address": {
"address_line1": "123 High St.",
"address_line2": "Flat 456",
"city": "London",
"zip": "SW1A 1AA",
"country": "GB"
},
"phone": {
"country_code": "+1",
"number": "415 555 2671"
},
"expiry_month": 6,
"expiry_year": 2025,
"name": "Bruce Wayne",
"scheme": "VISA",
"scheme_local": "Cartes_Bancaires",
"local_schemes": [
"cartes_bancaires",
"visa"
],
"last4": "9996",
"fingerprint": "F639CAB2745BEE4140BF86DF6B6D6",
"bin": "45434748",
"card_type": "CREDIT",
"card_category": "CONSUMER",
"issuer": "GOTHAM STATE BANK",
"issuer_country": "US",
"product_id": "F",
"product_type": "CLASSIC",
"avs_check": "S",
"cvv_check": "Y",
"payment_account_reference": "EUNIX9AX7THOOJIEJ2AP6OOFAHGH4",
"encrypted_card_number": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUz...",
"account_update_status": "card_updated",
"account_update_failure_code": "VAU009"
},
"destination": {
"type": "bank_account"
},
"amount": 6540,
"amount_requested": 6540,
"currency": "USD",
"payment_type": "Recurring",
"payment_plan": {
"amount_variability": "Variable",
"days_between_payments": 28,
"total_number_of_payments": 5,
"current_payment_number": 3,
"expiry": "20251031",
"name": "Subscription 1234",
"start_date": "20260507",
"amount": 1234
},
"reference": "ORD-5023-4E89",
"description": "Set of 3 masks",
"approved": true,
"status": "Authorized",
"balances": {
"total_authorized": 6540,
"available_to_void": 6540,
"available_to_capture": 6540
},
"3ds": {
"enrolled": "Y",
"signature_valid": "Y",
"cryptogram": "hv8mUFzPzRZoCAAAAAEQBDMAAAA=",
"xid": "MDAwMDAwMDAwMDAwMDAwMzIyNzY=",
"version": "2.1.0",
"exemption": "low_value",
"challenged": true,
"upgrade_reason": "sca_retry",
"trusted_listing": {
"status": "Y",
"source": "01"
}
},
"authentication": {
"experience": "3ds"
},
"risk": {
"flagged": true,
"score": 22
},
"customer": {
"id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
"email": "brucewayne@gmail.com",
"name": "Bruce Wayne",
"summary": {
"registration_date": "2023-05-01T00:00:00.0000000",
"first_transaction_date": "2023-07-01T00:00:00.0000000",
"last_payment_date": "2023-08-01T00:00:00.0000000",
"total_order_count": 15,
"last_payment_amount": 500,
"is_premium_customer": true,
"is_returning_customer": true,
"lifetime_value": 500
}
},
"billing_descriptor": {
"name": "SUPERHEROES.COM",
"city": "GOTHAM",
"local_descriptors": [
{
"name": "漢字"
}
]
},
"shipping": {
"address": {
"address_line1": "123 High St.",
"address_line2": "Flat 456",
"city": "London",
"zip": "SW1A 1AA",
"country": "GB"
},
"phone": {
"country_code": "+1",
"number": "415 555 2671"
}
},
"payment_ip": "90.197.169.245",
"sender": {
"type": "instrument",
"reference": "8285282045818",
"first_name": "John",
"last_name": "Jones",
"address": {
"address_line1": "123 High St.",
"address_line2": "Flat 456",
"city": "London",
"zip": "SW1A 1AA",
"country": "GB"
}
},
"amount_allocations": [
{
"id": "ent_w4jelhppmfiufdnatam37wrfc4",
"amount": 1000,
"reference": "ORD-5023-4E89",
"commission": {
"amount": 1000,
"percentage": 1.125
}
}
],
"recipient": {
"dob": "1985-05-15T00:00:00.0000000",
"account_number": "5555554444",
"address": {
"address_line1": "123 High St.",
"address_line2": "Flat 456",
"city": "London",
"zip": "SW1A 1AA",
"country": "GB"
},
"zip": "SW1A",
"first_name": "John",
"last_name": "Jones"
},
"processing": {
"preferred_scheme": "cartes_bancaires",
"app_id": "com.iap.linker_portal",
"airline_data": [
{
"ticket": {
"number": "045-21351455613",
"issue_date": "2023-05-20T00:00:00.0000000",
"issuing_carrier_code": "AI",
"travel_package_indicator": "B",
"travel_agency_name": "World Tours",
"travel_agency_code": "01"
},
"passenger": [
{
"first_name": "John",
"last_name": "White",
"date_of_birth": "1990-05-26T00:00:00.0000000",
"address": {
"country": "US"
}
}
],
"flight_leg_details": [
{
"flight_number": "101",
"carrier_code": "BA",
"class_of_travelling": "J",
"departure_airport": "LHR",
"departure_date": "2023-06-19T00:00:00.0000000",
"departure_time": "15:30",
"arrival_airport": "LAX",
"stop_over_code": "x",
"fare_basis_code": "SPRSVR"
}
]
}
],
"accommodation_data": [
{
"name": "The Sea View Hotel",
"booking_reference": "HOTEL123",
"check_in_date": "2023-06-20T00:00:00.0000000",
"check_out_date": "2023-06-23T00:00:00.0000000",
"address": {
"address_line1": "123 Beach Road",
"zip": "10001"
},
"state": "FL",
"country": "USA",
"city": "Los Angeles",
"number_of_rooms": 2,
"guests": [
{
"first_name": "Jane",
"last_name": "Doe",
"date_of_birth": "1985-07-14T00:00:00.0000000"
}
],
"room": [
{
"rate": "70",
"number_of_nights_at_room_rate": "3"
}
],
"property_phone": [
{
"country_code": "44",
"number": "7123456789"
}
],
"customer_service_phone": [
{
"country_code": "44",
"number": "7123456789"
}
]
}
],
"partner_customer_id": "2102209000001106125F8",
"partner_payment_id": "440644309099499894406",
"partner_code": "999111",
"failure_code": "partner_error",
"partner_response_code": "ER_WRONG_TICKET",
"tax_amount": 1000,
"locale": "en-US",
"retrieval_reference_number": "909913440644",
"partner_merchant_advice_code": "24",
"merchant_category_code": "5311",
"scheme_merchant_id": "123456",
"scheme": "ACCEL"
},
"items": [
{
"type": "digital",
"sub_type": "stablecoin",
"name": "Necklace",
"quantity": 2,
"unit_price": 50,
"reference": "858818ac",
"commodity_code": "DEF123",
"unit_of_measure": "metres",
"total_amount": 29000,
"tax_rate": 2000,
"tax_amount": 1000,
"discount_amount": 1000,
"wxpay_goods_id": "1001",
"service_ends_on": "2025-01-01T00:00:00.0000000",
"purchase_country": "GB",
"foreign_retailer_amount": 200
}
],
"metadata": {
"coupon_code": "NY2018",
"partner_id": 123989
},
"eci": "06",
"scheme_id": "488341541494658",
"actions": [
{
"id": "act_y3oqhf46pyzuxjbcn2giaqnb44",
"response_code": "10000",
"response_summary": "Approved"
}
],
"instruction": {
"purpose": "financial_services"
},
"_links": {
"self": {
"href": "https://{prefix}.api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44"
},
"actions": {
"href": "https://{prefix}.api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44/actions"
},
"authorize": {
"href": "https://{prefix}.api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44/authorizations"
},
"refund": {
"href": "https://{prefix}.api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44/refund"
}
}
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.