--- title: "Search payments" method: POST path: "/payments/search" tags: ["Payments"] --- # Search payments `POST /payments/search` ## Request - Base URL: `https://{prefix}.api.sandbox.checkout.com` - URL: `https://{prefix}.api.sandbox.checkout.com/payments/search` - Auth: one of: - OAuth 2 - Client credentials - Token URL: `string` scopes: `payments:search` - API key in header `Authorization` - TypeScript: (a function with typed inputs; its response is checked against the schema) Beta

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 Search and filter payments documentation. ## Request body - SearchRequest - `query` string: The query string. For more information on how to build out your query, see the Search and filter payments documentation. - `limit` integer: The number of results to return per page. - `from` string: The UTC date and time for the query start in ISO 8601 format. Required if `to` is provided. - `to` string: The UTC date and time for the query end in ISO 8601 format. Required if `from` is provided. ## Response `200` Successful search - union - PayinResponse - `data` Payin[] - `id` string: The unique identifier of the payment. - `requested_on` string: The UTC date and time the payment was requested, in ISO 8601 format. - `source` object: The source of the payment. - `type` string: The payment source type. For payment request sources that result in a card token, this will be `card`. For example, a token or source ID. - `expiry_month` string: The card expiration month. - `expiry_year` string: The card expiration year. - `name` string: The cardholder's name. - `scheme` string: The card scheme. - `local_schemes` string[]: The local co-branded card scheme. - `last4` string: The last four digits of the card number. - `fingerprint` string: The card's unique fingerprint. You can use the card fingerprint to compare cards across customers. - `bin` string: The card issuer's Bank Identification Number (BIN). - `card_type` string: The card type. - `card_wallet_type` string: The card wallet type. - `issuer` string: The card issuer. - `issuer_country` string: The issuer country, as a [two-letter ISO country code](https://www.checkout.com/docs/developer-resources/codes/country-codes). - `avs_check` string: The result of the Address Verification System (AVS) check. - `amount` number: The original payment amount. - `amount_requested` number: The full amount from the original authorization, if a partial authorization was requested. - `currency` string: The currency of the payment, as a [three-letter ISO currency code](https://www.checkout.com/docs/developer-resources/codes/currency-codes). - `payment_type` string: The type of payment. This field is returned for card payments where the cardholder was not present. For example, recurring payments or mail order / telephone order (MOTO) payments. - `processing_channel_id` string: The unique identifier of the processing channel that was used for the payment. - `reference` string: The reference for the payment. - `status` string: The status of the payment. - `balances` object: The payment's balances. - `total_authorized` number: The total amount that was authorized. - `total_captured` number: The total amount that was captured. - `total_refunded` number: The total amount that was refunded. - `3ds` object: Details relating to payments processed with 3D Secure (3DS). - `eci` string: The Electronic Commerce Indicator (ECI). - `version` string: The version of 3DS that was used for authentication. - `risk` object: The payment's risk assessment results. - `flagged` boolean: Specifies whether the payment was flagged by a risk check. - `score` string: The risk score calculated by our Fraud Detection engine. This field is only returned if sufficient data was provided to Fraud Detection. - `customer` object: The customer linked to the payment. - `email` string: The customer's email address. - `name` string: The customer's name. - `billing_descriptor` object: An optional description displayed on the customer's statement identifying a purchase. Applies to card payments only. - `name` string: The reference displayed on the customer's bank statement. - `city` string: The city from which the payment originated. - `metadata` object: A set of key-value pairs attached to the payout, used to store additional information. - `actions` object[] - `id` string: The unique identifier of the payment action, including authentication and disputes. - `type` 'Authentication' | 'Authorization' | 'Card Verification' | 'Void' | 'Capture' | 'Partial Capture' | 'Partial Refund' | 'Refund' | 'Cancelation' | 'Request' | 'Pending' | 'Dispute': The type of action. - `status` string: The action outcome. - `processed_on` string, date-time: The date and time the action was processed. - `amount` integer: The action amount in minor currency units. - `auth_code` string: The issuer authorization code for cards. - `response_code` string: The response code. - `response_summary` string: The response summary. - `reference` string: Your reference for the action. - `processing` object - `acquirer_reference_number` string: A unique identifier for the capture that is submitted to the card scheme during processing. - `fraud_score` string: The risk score calculated by our Fraud Detection engine. This field is only returned if sufficient data was provided to Fraud Detection. - `response_status_reason` string: The reason for the response status. This is only available as a result of a 3DS2 authentication. - `authentication_experience` string: The authentication type used. - `reason_code` string: The reason code provided by the card scheme. This only applies to disputes. - `_links` Links: Links related to the search. - `next` Link - `href` string, required: The link URL - BankPayoutResponse - `data` BankPayout[] - `id` string: The unique identifier of the payout. - `requested_on` string: The UTC date and time the payment was requested, in ISO 8601 format. - `destination` object: The destination of the payout. - `type` string: The payout destination type. - `id` string: The unique identifier of the payment instrument. - `bank_code` string: The code that identifies the bank. - `branch_code` string: The code that identifies the bank branch. - `iban` string: The International Bank Account Number (IBAN) of the account. - `country` string: The country where the account is based, as a [two-letter ISO country code](https://www.checkout.com/docs/developer-resources/codes/country-codes). - `account_holder` object: The account holder's details. - `first_name` string: The account holder's first name. - `last_name` string: The account holder's last name. - `amount` number: The original payout amount. - `currency` string: The currency of the payout, as a [three-letter ISO currency code](https://www.checkout.com/docs/developer-resources/codes/currency-codes). - `reference` string: The reference for the payout. - `billing_descriptor` object: The billing descriptor details. - `reference` string: The reference displayed on the payout recipient's bank statement. - `status` string: The status of the payout. - `processing_channel_id` string: The unique identifier of the processing channel that was used for the payout. - `sender` object: The payout sender's details. - `first_name` string: The sender's first name. - `last_name` string: The sender's last name. - `actions` object[] - `id` string: The unique identifier of the payment action. - `type` 'Payout' | 'Return': The type of action. - `processed_on` string, date-time: The date and time the action was processed. - `response_code` string: The response code. - `response_summary` string: The response summary. - `reference` string: The reference for the payout. - `_links` Links: Links related to the search. - `next` Link - `href` string, required: The link URL - CardPayoutResponse - `data` CardPayout[] - `id` string: The unique identifier of the payout. - `requested_on` string: The UTC date and time the payment was requested, in ISO 8601 format. - `destination` object: The destination of the payout. - `type` string: The payout destination type. - `id` string: The unique identifier of the payment source. - `expiry_year` string: The card expiration year. - `expiry_month` string: The card expiration month. - `account_holder` object: The account holder's details. - `first_name` string: The account holder's first name. This field is only returned if `destination.account_holder.type` is `individual`. - `last_name` string: The account holder's last name. This field is only returned if `destination.account_holder.type` is `individual`. - `scheme` string: The card scheme. - `last4` string: The last four digits of the card number. - `issuer` string: The issuer name. - `issuer_country` string: The issuer country, as a [two-letter ISO country code](https://www.checkout.com/docs/developer-resources/codes/country-codes). - `amount` number: The original payout amount. - `currency` string: The currency of the payout, as a [three-letter ISO currency code](https://www.checkout.com/docs/developer-resources/codes/currency-codes). - `reference` string: The reference for the payout. - `billing_descriptor` object: The billing descriptor details. - `reference` string: The reference displayed on the payout recipient's bank statement. - `status` string: The status of the payout. - `processing_channel_id` string: The unique identifier of the processing channel that was used for the payout. - `sender` object: The payout sender's details. - `type` string: The sender type. This field is only returned for payout requests for some [funds transfer types](https://www.checkout.com/docs/payments/request-payouts/card-payouts#Fund_Transfer_Types). - `first_name` string: The sender's first name. This field is only returned if `sender.type` is `individual`. - `last_name` string: The sender's last name. This field is only returned if `sender.type` is `individual`. - `metadata` object: A set of key-value pairs attached to the payout, used to store additional information. - `actions` object[] - `id` string: The unique identifier of the payment action. - `type` 'Payout': The type of action. - `processed_on` string, date-time: The date and time the action was processed. - `processing` object - `acquirer_reference_number` string: A unique identifier for the payout that is submitted to the card scheme during processing. - `response_code` string: The response code. - `response_summary` string: The response summary. - `reference` string: The reference for the payout. - `sanction_screening` string: The outcome of sanction screening. - `_links` Links: Links related to the search. - `next` Link - `href` string, required: The link URL ## Other responses - `400`: Invalid input - `401`: Unauthorized - `403`: Forbidden - `422`: Query validation error --- [API](https://skmtc.dev/checkout/apis/checkout-com-api-reference.md) - [All operations](https://skmtc.dev/checkout/apis/checkout-com-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/checkout/apis/checkout-com-api-reference/revisions/0f1abdb1c3e9?raw)