Skip to content

Get payment details

Last updated: September 14, 2022

This endpoint allows you to retrieve and view information and parameters related to a specific payment, using a payment ID or session ID.

The session ID is provided in the cko-session-id query parameter included in the redirect URL back to your site. Redirect URLs have the following format: http://example.com/success?cko-session-id=sid_ubfj2q76miwundwlk72vxt2i7

The cko-session-id expires 15 minutes after being created.

Alternatively, you can also retrieve a list of payments that match a specified payment reference.

Use the details below to set up your request.

Endpoints

For the full API specification, see the API reference.

    get

    https://api.checkout.com/payments/{id}

    Copied!

    Response example

    If your request is successful, the response will return information about the payment. If unsuccessful, you may receive a 404 – Payment not found error instead.

    Note that the actions array is only returned in the response if the request was made using a cko-session-id value.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    {
    "id": "pay_mbabizu24mvu3mela5njyhpit4",
    "requested_on": "2020-08-26T10:22:13Z",
    "source": {
    "type": "card",
    "id": "src_nwd3m4in3hkuddfpjsaevunhdy",
    "billing_address": {
    "address_line1": "Checkout.com",
    "address_line2": "90 Tottenham Court Road",
    "city": "London",
    "state": "London",
    "zip": "W1T 4TJ",
    "country": "GB"
    },
    "phone": {
    "country_code": "+1",
    "number": "415 555 2671"
    }
    },
    "destination": {
    "type": "card",
    "id": "src_wmlfc3zyhqzehihu7giusaaawu",
    "billing_address": {
    "address_line1": "Checkout.com",
    "address_line2": "90 Tottenham Court Road",
    "city": "London",
    "state": "London",
    "zip": "W1T 4TJ",
    "country": "GB"
    },
    "phone": {
    "country_code": "+1",
    "number": "415 555 2671"
    }
    },
    "amount": 6540,
    "currency": "USD",
    "payment_type": "Recurring",
    "reference": "ORD-5023-4E89",
    "description": "Set of 3 masks",
    "approved": true,
    "expires_on": "string",
    "status": "Authorized",
    "balances": {
    "total_authorized": 6540,
    "total_voided": 0,
    "available_to_void": 6540,
    "total_captured": 0,
    "available_to_capture": 6540,
    "total_refunded": 0,
    "available_to_refund": 0
    },
    "3ds": {
    "downgraded": false,
    "enrolled": "Y",
    "signature_valid": "Y",
    "authentication_response": "Y",
    "cryptogram": "hv8mUFzPzRZoCAAAAAEQBDMAAAA=",
    "xid": "MDAwMDAwMDAwMDAwMDAwMzIyNzY=",
    "version": "2.1.0",
    "challenged": true
    },
    "risk": {
    "flagged": true,
    "score": 50
    },
    "customer": {
    "id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
    "email": "brucewayne@gmail.com",
    "name": "Bruce Wayne"
    },
    "billing_descriptor": {
    "name": "SUPERHEROES.COM",
    "city": "GOTHAM",
    "reference": "string"
    },
    "shipping": {
    "address": {
    "address_line1": "Checkout.com",
    "address_line2": "90 Tottenham Court Road",
    "city": "London",
    "state": "London",
    "zip": "W1T 4TJ",
    "country": "GB"
    },
    "phone": {
    "country_code": "+1",
    "number": "415 555 2671"
    }
    },
    "payment_ip": "90.197.169.245",
    "marketplace": {
    "sub_entity_id": "ent_rgyzti4x74xubmu72m6r3pvksa"
    },
    "recipient": {
    "dob": "1985-05-15",
    "account_number": "5555554444",
    "zip": "W1T",
    "first_name": "John",
    "last_name": "Jones"
    },
    "processing": {
    "preferred_scheme": "visa",
    "partner_customer_id": "kDgi7cgHPwZ6fIs"
    },
    "metadata": {
    "coupon_code": "NY2018",
    "partner_id": 123989
    },
    "eci": "06",
    "scheme_id": "488341541494658",
    "actions": [
    {
    "id": "act_y3oqhf46pyzuxjbcn2giaqnb44",
    "type": "Authorization",
    "response_code": "10000",
    "response_summary": "Approved"
    }
    ],
    "_links": {
    "self": {
    "href": "https://api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44"
    },
    "actions": {
    "href": "https://api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44/actions"
    },
    "authorize": {
    "href": "https://api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44/authorizations"
    },
    "refund": {
    "href": "https://api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44/refund"
    }
    }
    }

    Response parameters

    Find out what the different fields in your successful response mean by looking at our API reference.