Skip to content
Payments / Manage payments / Get a list of payments

Get a list of payments Beta

Last updated: September 14, 2022

Retrieve a list of payments matching a specified reference to view related payment information, without using a payment ID or session ID.

Use the details below to set up your request.

Endpoints

    get

    https://api.checkout.com/payments

    Query parameters

    You can use the following query parameters to filter and refine your search query:

    ParameterDescription

    reference

    The payment reference to search for. This query parameter is required.

    limit

    The number of results to retrieve. The maximum value is 100. If no value is specified, 10 is used by default.

    skip

    The number of results to skip in the returned list of payments.

    Use this for result pagination. For example, if you perform a query and specify limit=100, a maximum of 100 results will be returned in the initial request. If there are more than 100 matches for the query, you can include skip=100 in a subsequent request to retrieve the next page of results.

    Authentication

    Requests to the endpoint must be authenticated by providing your access key (OAuth 2.0) or API key in the request's Authorization header.

    1
    --header 'Authorization: Bearer <token>'

    Request example

    1
    curl --location --request GET 'https://api.sandbox.checkout.com/payments?limit=10&skip=0&reference=ORD-5023-4E89' \
    2
    --header 'Authorization: Bearer sk_sbox_wjvrysklsqjmrhn3yoexnshsl72'

    Response example

    The results are sorted by processing date in descending order.

    1
    {
    2
      "limit": 10,
    3
      "skip": 0,
    4
      "total_count": 1,
    5
      "data": [
    6
        {
    7
          "id": "pay_einf5abzzgbejdpuartvqgl36i",
    8
          "requested_on": "2022-04-14T17:03:10.103019Z",
    9
          "source": {
    10
            "type": "card",
    11
            "expiry_month": 11,
    12
            "expiry_year": 2024,
    13
            "scheme": "Visa",
    14
            "last4": "7526",
    15
            "fingerprint": "F2FFA3967396478A7EB64FE6E0A2384F230C23A2F7E520D27EDBB46F24E5B922",
    16
            "bin": "482028",
    17
            "card_type": "CREDIT",
    18
            "card_category": "CONSUMER",
    19
            "issuer": "Test Bank",
    20
            "issuer_country": "US",
    21
            "product_id": "N1",
    22
            "product_type": "Visa Rewards"
    23
          },
    24
          "amount": 1000,
    25
          "currency": "EUR",
    26
          "payment_type": "Recurring",
    27
          "reference": "ORD-5023-4E89",
    28
          "description": "Set of 3 masks",
    29
          "status": "Declined",
    30
          "approved": false,
    31
          "3ds": {
    32
            "downgraded": false,
    33
            "enrolled": "N"
    34
          },
    35
          "risk": {
    36
            "flagged": false,
    37
            "score": 0
    38
          },
    39
          "metadata": {
    40
            "udf1": "TEST123",
    41
            "coupon_code": "NY2018",
    42
            "partner_id": "123989"
    43
          },
    44
          "_links": {
    45
            "self": {
    46
              "href": "https://api.sandbox.checkout.com/payments/pay_einf5abzzgbejdpuartvqgl36i"
    47
            },
    48
            "actions": {
    49
              "href": "https://api.sandbox.checkout.com/payments/pay_einf5abzzgbejdpuartvqgl36i/actions"
    50
            }
    51
          }
    52
        }
    53
      ]
    54
    }

    On this page

    Endpoints
    Query parameters
    Authentication
    Request example
    Response example