CHcheckout
Payments

Search payments

<span style="font-size: 12px; font-weight: 500; color: rgb(0, 0, 0); background-color: rgb(255, 176, 97); border-radius: 4px; padding: 2px 6px" >Beta</span><p></p>

Search and filter through your payment data to retrieve payments that match your query.

If a search returns more results than the value specified in limit, additional results are returned in a new page. A link to the next page of results is returned in the response's _links.next.href field.

For more information on search syntax, see the <a href="https://www.checkout.com/docs/payments/manage-payments/search-and-filter-payments" target="blank">Search and filter payments</a> documentation.

post/payments/search

Request

Request body

querystring

The query string.

For more information on how to build out your query, see the <a href="https://www.checkout.com/docs/payments/manage-payments/search-and-filter-payments#Search_through_your_payments" target="blank">Search and filter payments</a> documentation.

limitinteger

The number of results to return per page.

fromstring

The UTC date and time for the query start in ISO 8601 format. Required if to is provided.

tostring

The UTC date and time for the query end in ISO 8601 format. Required if from is provided.

Example request

{
  "query": "id:'pay_mbabizu24mvu3mela5njyhpit4'",
  "limit": 10,
  "from": "2023-08-24T14:15:22Z",
  "to": "2023-08-24T14:15:22Z"
}

Response

Successful search

OR
OR

Example response

{
  "data": [
    {
      "id": "pay_mbabizu24mvu3mela5njyhpit4",
      "requested_on": "2023-08-24T14:15:22Z",
      "source": {
        "type": "card",
        "expiry_month": "04",
        "expiry_year": "2024",
        "name": "Jia Tsang",
        "scheme": "Visa",
        "local_schemes": [
          "cartes bancaires"
        ],
        "last4": "3131",
        "fingerprint": "B16D9C2EF0C861A8825C9BD59CCE9171D84EBC45E89CC792B5D1D2D0DDE3DAB7",
        "bin": "313131",
        "card_type": "credit",
        "card_wallet_type": "googlepay",
        "issuer": "GE CAPITAL FINANCIAL, INC",
        "issuer_country": "US",
        "avs_check": "G"
      },
      "amount": 10000,
      "amount_requested": 10000,
      "currency": "GBP",
      "payment_type": "regular",
      "processing_channel_id": "pc_vxt6yftthv4e5flqak6w2i7rim",
      "reference": "ORD-5023-4E89",
      "status": "captured",
      "balances": {
        "total_authorized": 200,
        "total_captured": 150,
        "total_refunded": 50
      },
      "3ds": {
        "eci": "02",
        "version": "2.1.0"
      },
      "risk": {
        "score": "22"
      },
      "customer": {
        "email": "jia.tsang@checkout.com",
        "name": "Jia Tsang"
      },
      "billing_descriptor": {
        "name": "Purchase",
        "city": "London"
      },
      "actions": [
        {
          "id": "act_egiv5753bwmexj6ip3tlpog6gq",
          "type": "Dispute",
          "processed_on": "2023-08-25T14:15:24.0000000+00:00",
          "status": "Evidence Required",
          "amount": 1310,
          "reason_code": "13.1"
        },
        {
          "id": "act_i3cd3w3lcooexmyrtlgulk3d7a",
          "type": "Capture",
          "processed_on": "2023-08-24T14:15:26.0000000+00:00",
          "status": "Approved",
          "amount": 1310,
          "auth_code": "983647",
          "response_code": "10000",
          "response_summary": "Approved",
          "reference": "REF-7HR-IYW",
          "processing": {
            "acquirer_reference_number": "25651432189281252509653"
          }
        },
        {
          "id": "act_2uwlm6xyeszerhroqhfnotmiwu",
          "type": "Authorization",
          "processed_on": "2023-08-24T14:15:25.0000000+00:00",
          "status": "Approved",
          "amount": 1310,
          "auth_code": "983647",
          "response_code": "10000",
          "response_summary": "Approved",
          "reference": "REF-7HR-IYW",
          "processing": {
            "acquirer_reference_number": "25651432189281252509653"
          }
        },
        {
          "id": "act_mscwxewzdldefh2rbbnhm6aeqi",
          "type": "Authorization",
          "processed_on": "2023-08-24T14:15:24.0000000+00:00",
          "status": "Pending",
          "amount": 1310,
          "reference": "REF-7HR-IYW"
        },
        {
          "id": "act_qocmjw6skb4u3c4wd3avpot64y",
          "type": "Authentication",
          "processed_on": "2023-08-24T14:15:34.0000000+00:00",
          "status": "Approved",
          "authentication_experience": "3ds",
          "authentication_transaction_id": "f05af960-f718-428d-b856-068f6cb9a3b4"
        },
        {
          "id": "act_qocmjw6skb4u3c4wd3avpot64y",
          "type": "Authentication",
          "processed_on": "2023-08-24T14:15:22.0000000+00:00",
          "status": "Pending",
          "reference": "REF-7HR-IYW"
        }
      ]
    }
  ],
  "_links": {
    "next": {
      "href": "https://{prefix}.api.checkout.com/payments/search/nGd7-altGkOfSl3fJptLxA?token=MTc0MDUwMjE2MjQxOCxlN2NiNTdmYy04MDA5LTQ3YmMtOTYzNi0zNDEyOWRmZTkwZTI"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.