Payments

Find payments

Find payments you’ve previously created using PayNext’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind.

Search Query Language

Build a search query by combining one or more search clauses. A clause has the format field operator value where the operators are :, ~, >, <, >=, <=, or the prefix - for negation.

Operators

Operator	Description	Example
`:`	Exact match (case-insensitive)	`payment_status:"SETTLED"`
`~`	Substring match (min 3 chars, case-insensitive)	`statement_descriptor~"ACME"`
`>`	Greater than	`amount>5000`
`>=`	Greater than or equal	`amount>=5000`
`<`	Less than	`amount<10000`
`<=`	Less than or equal	`amount<=10000`
`-`	Negation (prefix)	`-payment_status:"CANCELLED"`

Logical Operators

Combine clauses with AND or OR. Clauses separated by a space default to AND logic. You cannot mix AND and OR in the same query. Maximum of 10 clauses per query.

Quoting

String values must be enclosed in single or double quotes. Numeric values do not require quotes. Escape quotes with a backslash.

Metadata

Query metadata fields using bracket notation: metadata["key"]:"value". Check for the presence of a metadata key: -metadata["key"]:null.

Null Checks

Use field:null to find records where a field is empty or absent. Use -field:null to find records where a field is present.

Nested Fields

Access nested object fields using dot notation. Examples:

customer.email:"jane@example.com"
payment_method.type:"CARD"
payment_method.details.last4:"1111"
subscription.status:"active"

Searchable Payment Fields

Top-level fields:

Field	Type	Operators
`id`	token	`:`
`amount`	numeric	`:`, `>`, `>=`, `<`, `<=`
`amount_usd`	numeric	`:`, `>`, `>=`, `<`, `<=`
`currency_code`	string (ISO 4217)	`:`
`payment_status`	string (PENDING/FAILED/AUTHORIZED/SETTLING/SETTLED/DECLINED/BLOCKED/CANCELLED)	`:`
`payment_type`	string (MIT/CIT)	`:`
`transaction_type`	string (Auth/Settle)	`:`
`payment_token_type`	string (CARD_PAN/NETWORK_TOKEN/PROCESSOR_TOKEN)	`:`
`refunded_amount`	numeric	`:`, `>`, `>=`, `<`, `<=`
`statement_descriptor`	string	`:`, `~`
`created_at`	date (RFC3339)	`:`, `>`, `>=`, `<`, `<=`
`updated_at`	date (RFC3339)	`:`, `>`, `>=`, `<`, `<=`
`metadata["key"]`	string	`:`

Nested customer fields:

Field	Type	Operators
`customer.id`	token	`:`
`customer.email`	string	`:`, `~`
`customer.full_name`	string	`:`, `~`
`customer.phone`	string	`:`, `~`
`customer.external_id`	token	`:`
`customer.created_at`	date (RFC3339)	`:`, `>`, `>=`, `<`, `<=`
`customer.updated_at`	date (RFC3339)	`:`, `>`, `>=`, `<`, `<=`
`customer.metadata["key"]`	string	`:`
`customer.address.country`	string (ISO-2)	`:`
`customer.address.city`	string	`:`, `~`
`customer.address.state`	string	`:`
`customer.address.postal_code`	string	`:`
`customer.address.line1`	string	`:`, `~`
`customer.address.line2`	string	`:`, `~`

Nested payment_method fields — common:

Field	Type	Operators
`payment_method.type`	string (CARD/PAYPAL/VENMO/CASHAPP/APPLEPAY/GPAY)	`:`

When payment_method.type:"CARD":

Field	Type	Operators
`payment_method.details.bin`	string	`:`
`payment_method.details.last4`	string	`:`
`payment_method.details.exp_month`	numeric	`:`, `>`, `>=`, `<`, `<=`
`payment_method.details.exp_year`	numeric	`:`, `>`, `>=`, `<`, `<=`
`payment_method.details.bin_data.brand`	string	`:`
`payment_method.details.bin_data.country`	string (ISO-2)	`:`
`payment_method.details.bin_data.funding`	string	`:`
`payment_method.details.bin_data.issuer`	string	`:`, `~`

When payment_method.type:"PAYPAL":

Field	Type	Operators
`payment_method.details.payer_info.email`	string	`:`, `~`
`payment_method.details.payer_info.first_name`	string	`:`, `~`
`payment_method.details.payer_info.last_name`	string	`:`, `~`
`payment_method.details.payer_info.payer_id`	token	`:`
`payment_method.details.processor_customer_email`	string	`:`, `~`
`payment_method.details.processor_customer_id`	token	`:`
`payment_method.details.processor_payment_method_id`	token	`:`

When payment_method.type:"VENMO" / "CASHAPP":

Field	Type	Operators
`payment_method.details.processor_customer_id`	token	`:` (CashApp only)
`payment_method.details.processor_payment_method_id`	token	`:`

When payment_method.type:"APPLEPAY" / "GPAY":

Field	Type	Operators
`payment_method.details.token`	string	`:`
`payment_method.details.token_exp_month`	numeric	`:`, `>`, `>=`, `<`, `<=`
`payment_method.details.token_exp_year`	numeric	`:`, `>`, `>=`, `<`, `<=`
`payment_method.details.token_service_provider`	string	`:`

Nested payment_details fields:

Field	Type	Operators
`payment_details.arn`	string	`:`
`payment_details.auth_code`	string	`:`
`payment_details.network_payment_id`	string	`:`
`payment_details.processor_transaction_id`	string	`:`

Nested processor fields:

Field	Type	Operators
`processor.id`	token	`:`
`processor.type`	string (STRIPE/…)	`:`

Nested subscription fields:

Field	Type	Operators
`subscription.id`	token	`:`
`subscription.status`	string (trial/active/past_due/cancelled/scheduled_for_cancellation)	`:`
`subscription.created_at`	date (RFC3339)	`:`, `>`, `>=`, `<`, `<=`
`subscription.updated_at`	date (RFC3339)	`:`, `>`, `>=`, `<`, `<=`
`subscription.current_period_start`	date (RFC3339)	`:`, `>`, `>=`, `<`, `<=`
`subscription.current_period_end`	date (RFC3339)	`:`, `>`, `>=`, `<`, `<=`
`subscription.next_billing_date`	date (RFC3339)	`:`, `>`, `>=`, `<`, `<=`
`subscription.metadata["key"]`	string	`:`

Nested refund / check fields:

Field	Type	Operators
`refund.status`	string (PENDING/DECLINED/SETTLING/SETTLED)	`:`
`refund.amount`	numeric	`:`, `>`, `>=`, `<`, `<=`
`avs_check.result.postal_code`	string (pass/fail/…)	`:`
`avs_check.result.street_address`	string	`:`
`cvc_check.result.cvc`	string	`:`
`status_reason.status`	string (declined/failed)	`:`
`status_reason.decline_code`	string	`:`
`three_d_secure.status`	string (action-required/success/failure)	`:`

Card network token fields (when present):

Field	Type	Operators
`payment_method.details.network_token.bin`	string	`:`
`payment_method.details.network_token.last4`	string	`:`
`payment_method.details.network_token.expiry_month`	string	`:`
`payment_method.details.network_token.expiry_year`	string	`:`

Tax fields:

Field	Type	Operators
`tax.status`	string	`:`
`tax.behavior`	string (INCLUSIVE/EXCLUSIVE)	`:`
`tax.error.code`	string	`:`
`tax.error.message`	string	`:`

3-D Secure fields:

Field	Type	Operators
`three_d_secure.attempted`	boolean	`:`
`three_d_secure.flow`	string	`:`
`three_d_secure.liability_shift`	string	`:`
`three_d_secure.eci_value`	string	`:`
`three_d_secure.eci_result`	string	`:`
`three_d_secure.status_reason`	string	`:`

Decline detail and refund flag:

Field	Type	Operators
`status_reason.message`	string	`:`, `~`
`refund.is_refunded`	boolean	`:`

Fraud prevention fields:

Field	Type	Operators
`fraud_prevention`	object (presence; use `:null` / `-...:null`)	`:`
`fraud_prevention.visa_order_insight.type`	string	`:`
`fraud_prevention.visa_compelling_evidence.status`	string (accepted/declined)	`:`
`fraud_prevention.visa_rdr.status`	string (accepted/declined)	`:`
`fraud_prevention.visa_rdr.reason.code`	string	`:`
`fraud_prevention.visa_rdr.reason.name`	string	`:`
`fraud_prevention.visa_rdr.reason.category`	string	`:`
`fraud_prevention.mastercard_consumer_clarity.type`	string	`:`

GET

payments

Find payments

curl --request GET \
  --url https://sandbox-api.paynext.com/payments \
  --header 'X-API-Version: <x-api-version>'

const options = {method: 'GET', headers: {'X-API-Version': '<x-api-version>'}};

fetch('https://sandbox-api.paynext.com/payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-api.paynext.com/payments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Version", "<x-api-version>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-api.paynext.com/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Version: <x-api-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "object": "payments",
  "url": "/v1/payments",
  "has_more": false,
  "next_page": null,
  "data": [
    {
      "id": "pay_e8a1b2c3-d4f5-6789-abcd-ef0123456789",
      "amount": 15000,
      "amount_usd": 15000,
      "currency_code": "USD",
      "payment_status": "SETTLED",
      "payment_type": "CIT",
      "payment_token_type": "CARD_PAN",
      "refunded_amount": 0,
      "refund_reason": null,
      "statement_descriptor": "ACME CORP",
      "customer": {
        "id": "cus_b8d0fe7e-3a7f-4b5f-a68b-d31358b49c3f",
        "email": "alice.johnson@example.com",
        "external_id": "ext_001",
        "full_name": "Alice Johnson",
        "phone": "+1-555-123-4567",
        "address": {
          "city": "San Francisco",
          "country": "US",
          "line1": "123 Market Street",
          "line2": "Suite 400",
          "postal_code": "94105",
          "state": "CA"
        },
        "metadata": {
          "key": "value"
        },
        "created_at": "2025-05-28T14:00:00Z",
        "updated_at": "2025-05-28T14:05:00Z"
      },
      "payment_method": {
        "type": "CARD",
        "billing_address": {
          "city": "San Francisco",
          "country": "US",
          "line1": "123 Market Street",
          "line2": "Suite 400",
          "postal_code": "94105",
          "state": "CA"
        },
        "details": {
          "bin": "411111",
          "last4": "1111",
          "exp_month": 12,
          "exp_year": 2028,
          "is_network_tokenized": true,
          "number": "4111111111111111",
          "bin_data": {
            "brand": "visa",
            "country": "US",
            "currency_code": "USD",
            "description": "Chase Sapphire Preferred",
            "funding": "credit",
            "issuer": "Chase Bank",
            "type": "consumer"
          }
        }
      },
      "payment_details": {
        "arn": "74922051234567",
        "auth_code": "334385",
        "network_payment_id": "119676610486528",
        "processor_transaction_id": "pi_3RgN6TJVVBuowJOx0B4fpGWi"
      },
      "processor": {
        "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
        "description": "Stripe US",
        "type": "STRIPE",
        "processor_merchant_id": "12345678"
      },
      "subscription": {
        "id": "sub_123e4567-e89b-12d3-a456-426614174000",
        "status": "active",
        "current_period_start": "2025-05-26T10:00:00Z",
        "current_period_end": "2025-06-26T10:00:00Z",
        "cancelled_at": null,
        "cancellation_details": {
          "reason": null,
          "trigger_payment_id": null
        },
        "next_billing_date": "2025-06-26T12:00:00Z",
        "past_due": {
          "attempt_count": 0,
          "max_attempts_count": 7
        },
        "plan": {
          "id": "price_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
          "name": "Pro Plan",
          "type": "recurring",
          "interval": "months",
          "interval_count": 1,
          "trial_interval": "days",
          "trial_interval_count": 14,
          "price": {
            "amount": 1999,
            "currency": "USD"
          },
          "trial_price": {
            "amount": 0,
            "currency": "USD"
          },
          "tax": {
            "collect_tax": "DEFAULT"
          }
        },
        "metadata": {},
        "created_at": "2025-05-26T10:00:00Z",
        "updated_at": "2025-05-27T10:00:00Z"
      },
      "refund": {
        "amount": 0,
        "amount_usd": 0,
        "status": "PENDING",
        "processor_transaction_id": "",
        "created_at": "2025-05-26T10:15:00Z",
        "updated_at": "2025-05-26T10:15:00Z"
      },
      "avs_check": {
        "result": {
          "postal_code": "pass",
          "street_address": "pass"
        }
      },
      "cvc_check": {
        "result": {
          "cvc": "pass"
        }
      },
      "tax": {
        "amount_subtotal": 15000,
        "amount_subtotal_usd": 15000,
        "amount_tax": 0,
        "amount_tax_usd": 0,
        "behavior": "EXCLUSIVE",
        "status": "calculated",
        "provider": {
          "id": "numeral",
          "type": "NUMERAL"
        },
        "calculation_id": "calc_123",
        "transaction_id": "tx_123"
      },
      "three_d_secure": {
        "authentication_flow": "challenge",
        "status": "success",
        "version": "2.2.0",
        "transaction_id": "3ds_123",
        "electronic_commerce_indicator": {
          "liability_shift": true,
          "result": "pass",
          "value": "05"
        }
      },
      "status_reason": {
        "status": "declined",
        "status_reason": {
          "advice_code": "do_not_try_again",
          "decline_code": "insufficient_funds",
          "message": "Card has insufficient funds"
        }
      },
      "metadata": {
        "order_id": "ORD-12345"
      },
      "created_at": "2025-05-25T14:30:00Z",
      "updated_at": "2025-05-26T10:15:00Z"
    },
    {
      "id": "pay_e8a1b2c3-d4f5-6789-abcd-ef0123456789",
      "amount": 15000,
      "amount_usd": 15000,
      "currency_code": "USD",
      "payment_status": "SETTLED",
      "payment_type": "CIT",
      "payment_token_type": "CARD_PAN",
      "refunded_amount": 0,
      "refund_reason": null,
      "statement_descriptor": "ACME CORP",
      "customer": {
        "id": "cus_b8d0fe7e-3a7f-4b5f-a68b-d31358b49c3f",
        "email": "alice.johnson@example.com",
        "external_id": "ext_001",
        "full_name": "Alice Johnson",
        "phone": "+1-555-123-4567",
        "address": {
          "city": "San Francisco",
          "country": "US",
          "line1": "123 Market Street",
          "line2": "Suite 400",
          "postal_code": "94105",
          "state": "CA"
        },
        "metadata": {
          "key": "value"
        },
        "created_at": "2025-05-28T14:00:00Z",
        "updated_at": "2025-05-28T14:05:00Z"
      },
      "payment_method": {
        "type": "PAYPAL",
        "details": {
          "payer_info": {
            "email": "alice.johnson@example.com",
            "first_name": "Alice",
            "last_name": "Johnson",
            "payer_id": "PAYER12345",
            "tenant": "Tenant"
          },
          "processor_customer_email": "alice.johnson@example.com",
          "processor_customer_id": "cus_pp_1234567890",
          "processor_payment_method_id": "pm_pp_1234567890"
        },
        "billing_address": {
          "city": "San Francisco",
          "country": "US",
          "line1": "123 Market Street",
          "line2": "Suite 400",
          "postal_code": "94105",
          "state": "CA"
        }
      },
      "payment_details": {
        "arn": "74922051234567",
        "auth_code": "334385",
        "network_payment_id": "119676610486528",
        "processor_transaction_id": "pi_3RgN6TJVVBuowJOx0B4fpGWi"
      },
      "processor": {
        "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
        "description": "Stripe US",
        "type": "STRIPE",
        "processor_merchant_id": "12345678"
      },
      "subscription": {
        "id": "sub_123e4567-e89b-12d3-a456-426614174000",
        "status": "active",
        "current_period_start": "2025-05-26T10:00:00Z",
        "current_period_end": "2025-06-26T10:00:00Z",
        "cancelled_at": null,
        "cancellation_details": {
          "reason": null,
          "trigger_payment_id": null
        },
        "next_billing_date": "2025-06-26T12:00:00Z",
        "past_due": {
          "attempt_count": 0,
          "max_attempts_count": 7
        },
        "plan": {
          "id": "price_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
          "name": "Pro Plan",
          "type": "recurring",
          "interval": "months",
          "interval_count": 1,
          "trial_interval": "days",
          "trial_interval_count": 14,
          "price": {
            "amount": 1999,
            "currency": "USD"
          },
          "trial_price": {
            "amount": 0,
            "currency": "USD"
          },
          "tax": {
            "collect_tax": "DEFAULT"
          }
        },
        "metadata": {},
        "created_at": "2025-05-26T10:00:00Z",
        "updated_at": "2025-05-27T10:00:00Z"
      },
      "refund": {
        "amount": 0,
        "amount_usd": 0,
        "status": "PENDING",
        "processor_transaction_id": "",
        "created_at": "2025-05-26T10:15:00Z",
        "updated_at": "2025-05-26T10:15:00Z"
      },
      "avs_check": {
        "result": {
          "postal_code": "pass",
          "street_address": "pass"
        }
      },
      "cvc_check": {
        "result": {
          "cvc": "pass"
        }
      },
      "tax": {
        "amount_subtotal": 15000,
        "amount_subtotal_usd": 15000,
        "amount_tax": 0,
        "amount_tax_usd": 0,
        "behavior": "EXCLUSIVE",
        "status": "calculated",
        "provider": {
          "id": "numeral",
          "type": "NUMERAL"
        },
        "calculation_id": "calc_123",
        "transaction_id": "tx_123"
      },
      "three_d_secure": {
        "authentication_flow": "challenge",
        "status": "success",
        "version": "2.2.0",
        "transaction_id": "3ds_123",
        "electronic_commerce_indicator": {
          "liability_shift": true,
          "result": "pass",
          "value": "05"
        }
      },
      "status_reason": {
        "status": "declined",
        "status_reason": {
          "advice_code": "do_not_try_again",
          "decline_code": "insufficient_funds",
          "message": "Card has insufficient funds"
        }
      },
      "metadata": {
        "order_id": "ORD-12345"
      },
      "created_at": "2025-05-25T14:30:00Z",
      "updated_at": "2025-05-26T10:15:00Z"
    },
    {
      "id": "pay_e8a1b2c3-d4f5-6789-abcd-ef0123456789",
      "amount": 15000,
      "amount_usd": 15000,
      "currency_code": "USD",
      "payment_status": "SETTLED",
      "payment_type": "CIT",
      "payment_token_type": "CARD_PAN",
      "refunded_amount": 0,
      "refund_reason": null,
      "statement_descriptor": "ACME CORP",
      "customer": {
        "id": "cus_b8d0fe7e-3a7f-4b5f-a68b-d31358b49c3f",
        "email": "alice.johnson@example.com",
        "external_id": "ext_001",
        "full_name": "Alice Johnson",
        "phone": "+1-555-123-4567",
        "address": {
          "city": "San Francisco",
          "country": "US",
          "line1": "123 Market Street",
          "line2": "Suite 400",
          "postal_code": "94105",
          "state": "CA"
        },
        "metadata": {
          "key": "value"
        },
        "created_at": "2025-05-28T14:00:00Z",
        "updated_at": "2025-05-28T14:05:00Z"
      },
      "payment_method": {
        "type": "VENMO",
        "details": {
          "processor_payment_method_id": "pm_venmo_1234567890"
        }
      },
      "payment_details": {
        "arn": "74922051234567",
        "auth_code": "334385",
        "network_payment_id": "119676610486528",
        "processor_transaction_id": "pi_3RgN6TJVVBuowJOx0B4fpGWi"
      },
      "processor": {
        "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
        "description": "Stripe US",
        "type": "STRIPE",
        "processor_merchant_id": "12345678"
      },
      "subscription": {
        "id": "sub_123e4567-e89b-12d3-a456-426614174000",
        "status": "active",
        "current_period_start": "2025-05-26T10:00:00Z",
        "current_period_end": "2025-06-26T10:00:00Z",
        "cancelled_at": null,
        "cancellation_details": {
          "reason": null,
          "trigger_payment_id": null
        },
        "next_billing_date": "2025-06-26T12:00:00Z",
        "past_due": {
          "attempt_count": 0,
          "max_attempts_count": 7
        },
        "plan": {
          "id": "price_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
          "name": "Pro Plan",
          "type": "recurring",
          "interval": "months",
          "interval_count": 1,
          "trial_interval": "days",
          "trial_interval_count": 14,
          "price": {
            "amount": 1999,
            "currency": "USD"
          },
          "trial_price": {
            "amount": 0,
            "currency": "USD"
          },
          "tax": {
            "collect_tax": "DEFAULT"
          }
        },
        "metadata": {},
        "created_at": "2025-05-26T10:00:00Z",
        "updated_at": "2025-05-27T10:00:00Z"
      },
      "refund": {
        "amount": 0,
        "amount_usd": 0,
        "status": "PENDING",
        "processor_transaction_id": "",
        "created_at": "2025-05-26T10:15:00Z",
        "updated_at": "2025-05-26T10:15:00Z"
      },
      "avs_check": {
        "result": {
          "postal_code": "pass",
          "street_address": "pass"
        }
      },
      "cvc_check": {
        "result": {
          "cvc": "pass"
        }
      },
      "tax": {
        "amount_subtotal": 15000,
        "amount_subtotal_usd": 15000,
        "amount_tax": 0,
        "amount_tax_usd": 0,
        "behavior": "EXCLUSIVE",
        "status": "calculated",
        "provider": {
          "id": "numeral",
          "type": "NUMERAL"
        },
        "calculation_id": "calc_123",
        "transaction_id": "tx_123"
      },
      "three_d_secure": {
        "authentication_flow": "challenge",
        "status": "success",
        "version": "2.2.0",
        "transaction_id": "3ds_123",
        "electronic_commerce_indicator": {
          "liability_shift": true,
          "result": "pass",
          "value": "05"
        }
      },
      "status_reason": {
        "status": "declined",
        "status_reason": {
          "advice_code": "do_not_try_again",
          "decline_code": "insufficient_funds",
          "message": "Card has insufficient funds"
        }
      },
      "metadata": {
        "order_id": "ORD-12345"
      },
      "created_at": "2025-05-25T14:30:00Z",
      "updated_at": "2025-05-26T10:15:00Z"
    },
    {
      "id": "pay_e8a1b2c3-d4f5-6789-abcd-ef0123456789",
      "amount": 15000,
      "amount_usd": 15000,
      "currency_code": "USD",
      "payment_status": "SETTLED",
      "payment_type": "CIT",
      "payment_token_type": "CARD_PAN",
      "refunded_amount": 0,
      "refund_reason": null,
      "statement_descriptor": "ACME CORP",
      "customer": {
        "id": "cus_b8d0fe7e-3a7f-4b5f-a68b-d31358b49c3f",
        "email": "alice.johnson@example.com",
        "external_id": "ext_001",
        "full_name": "Alice Johnson",
        "phone": "+1-555-123-4567",
        "address": {
          "city": "San Francisco",
          "country": "US",
          "line1": "123 Market Street",
          "line2": "Suite 400",
          "postal_code": "94105",
          "state": "CA"
        },
        "metadata": {
          "key": "value"
        },
        "created_at": "2025-05-28T14:00:00Z",
        "updated_at": "2025-05-28T14:05:00Z"
      },
      "payment_method": {
        "type": "CASHAPP",
        "details": {
          "processor_customer_id": "cus_ca_1234567890",
          "processor_payment_method_id": "pm_ca_1234567890"
        }
      },
      "payment_details": {
        "arn": "74922051234567",
        "auth_code": "334385",
        "network_payment_id": "119676610486528",
        "processor_transaction_id": "pi_3RgN6TJVVBuowJOx0B4fpGWi"
      },
      "processor": {
        "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
        "description": "Stripe US",
        "type": "STRIPE",
        "processor_merchant_id": "12345678"
      },
      "subscription": {
        "id": "sub_123e4567-e89b-12d3-a456-426614174000",
        "status": "active",
        "current_period_start": "2025-05-26T10:00:00Z",
        "current_period_end": "2025-06-26T10:00:00Z",
        "cancelled_at": null,
        "cancellation_details": {
          "reason": null,
          "trigger_payment_id": null
        },
        "next_billing_date": "2025-06-26T12:00:00Z",
        "past_due": {
          "attempt_count": 0,
          "max_attempts_count": 7
        },
        "plan": {
          "id": "price_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
          "name": "Pro Plan",
          "type": "recurring",
          "interval": "months",
          "interval_count": 1,
          "trial_interval": "days",
          "trial_interval_count": 14,
          "price": {
            "amount": 1999,
            "currency": "USD"
          },
          "trial_price": {
            "amount": 0,
            "currency": "USD"
          },
          "tax": {
            "collect_tax": "DEFAULT"
          }
        },
        "metadata": {},
        "created_at": "2025-05-26T10:00:00Z",
        "updated_at": "2025-05-27T10:00:00Z"
      },
      "refund": {
        "amount": 0,
        "amount_usd": 0,
        "status": "PENDING",
        "processor_transaction_id": "",
        "created_at": "2025-05-26T10:15:00Z",
        "updated_at": "2025-05-26T10:15:00Z"
      },
      "avs_check": {
        "result": {
          "postal_code": "pass",
          "street_address": "pass"
        }
      },
      "cvc_check": {
        "result": {
          "cvc": "pass"
        }
      },
      "tax": {
        "amount_subtotal": 15000,
        "amount_subtotal_usd": 15000,
        "amount_tax": 0,
        "amount_tax_usd": 0,
        "behavior": "EXCLUSIVE",
        "status": "calculated",
        "provider": {
          "id": "numeral",
          "type": "NUMERAL"
        },
        "calculation_id": "calc_123",
        "transaction_id": "tx_123"
      },
      "three_d_secure": {
        "authentication_flow": "challenge",
        "status": "success",
        "version": "2.2.0",
        "transaction_id": "3ds_123",
        "electronic_commerce_indicator": {
          "liability_shift": true,
          "result": "pass",
          "value": "05"
        }
      },
      "status_reason": {
        "status": "declined",
        "status_reason": {
          "advice_code": "do_not_try_again",
          "decline_code": "insufficient_funds",
          "message": "Card has insufficient funds"
        }
      },
      "metadata": {
        "order_id": "ORD-12345"
      },
      "created_at": "2025-05-25T14:30:00Z",
      "updated_at": "2025-05-26T10:15:00Z"
    },
    {
      "id": "pay_e8a1b2c3-d4f5-6789-abcd-ef0123456789",
      "amount": 15000,
      "amount_usd": 15000,
      "currency_code": "USD",
      "payment_status": "SETTLED",
      "payment_type": "CIT",
      "payment_token_type": "CARD_PAN",
      "refunded_amount": 0,
      "refund_reason": null,
      "statement_descriptor": "ACME CORP",
      "customer": {
        "id": "cus_b8d0fe7e-3a7f-4b5f-a68b-d31358b49c3f",
        "email": "alice.johnson@example.com",
        "external_id": "ext_001",
        "full_name": "Alice Johnson",
        "phone": "+1-555-123-4567",
        "address": {
          "city": "San Francisco",
          "country": "US",
          "line1": "123 Market Street",
          "line2": "Suite 400",
          "postal_code": "94105",
          "state": "CA"
        },
        "metadata": {
          "key": "value"
        },
        "created_at": "2025-05-28T14:00:00Z",
        "updated_at": "2025-05-28T14:05:00Z"
      },
      "payment_method": {
        "type": "APPLEPAY",
        "details": {
          "token": "ap_token_12345678",
          "token_exp_month": 12,
          "token_exp_year": 2028,
          "token_service_provider": "APPLE"
        },
        "billing_address": {
          "city": "San Francisco",
          "country": "US",
          "line1": "123 Market Street",
          "line2": "Suite 400",
          "postal_code": "94105",
          "state": "CA"
        }
      },
      "payment_details": {
        "arn": "74922051234567",
        "auth_code": "334385",
        "network_payment_id": "119676610486528",
        "processor_transaction_id": "pi_3RgN6TJVVBuowJOx0B4fpGWi"
      },
      "processor": {
        "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
        "description": "Stripe US",
        "type": "STRIPE",
        "processor_merchant_id": "12345678"
      },
      "subscription": {
        "id": "sub_123e4567-e89b-12d3-a456-426614174000",
        "status": "active",
        "current_period_start": "2025-05-26T10:00:00Z",
        "current_period_end": "2025-06-26T10:00:00Z",
        "cancelled_at": null,
        "cancellation_details": {
          "reason": null,
          "trigger_payment_id": null
        },
        "next_billing_date": "2025-06-26T12:00:00Z",
        "past_due": {
          "attempt_count": 0,
          "max_attempts_count": 7
        },
        "plan": {
          "id": "price_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
          "name": "Pro Plan",
          "type": "recurring",
          "interval": "months",
          "interval_count": 1,
          "trial_interval": "days",
          "trial_interval_count": 14,
          "price": {
            "amount": 1999,
            "currency": "USD"
          },
          "trial_price": {
            "amount": 0,
            "currency": "USD"
          },
          "tax": {
            "collect_tax": "DEFAULT"
          }
        },
        "metadata": {},
        "created_at": "2025-05-26T10:00:00Z",
        "updated_at": "2025-05-27T10:00:00Z"
      },
      "refund": {
        "amount": 0,
        "amount_usd": 0,
        "status": "PENDING",
        "processor_transaction_id": "",
        "created_at": "2025-05-26T10:15:00Z",
        "updated_at": "2025-05-26T10:15:00Z"
      },
      "avs_check": {
        "result": {
          "postal_code": "pass",
          "street_address": "pass"
        }
      },
      "cvc_check": {
        "result": {
          "cvc": "pass"
        }
      },
      "tax": {
        "amount_subtotal": 15000,
        "amount_subtotal_usd": 15000,
        "amount_tax": 0,
        "amount_tax_usd": 0,
        "behavior": "EXCLUSIVE",
        "status": "calculated",
        "provider": {
          "id": "numeral",
          "type": "NUMERAL"
        },
        "calculation_id": "calc_123",
        "transaction_id": "tx_123"
      },
      "three_d_secure": {
        "authentication_flow": "challenge",
        "status": "success",
        "version": "2.2.0",
        "transaction_id": "3ds_123",
        "electronic_commerce_indicator": {
          "liability_shift": true,
          "result": "pass",
          "value": "05"
        }
      },
      "status_reason": {
        "status": "declined",
        "status_reason": {
          "advice_code": "do_not_try_again",
          "decline_code": "insufficient_funds",
          "message": "Card has insufficient funds"
        }
      },
      "metadata": {
        "order_id": "ORD-12345"
      },
      "created_at": "2025-05-25T14:30:00Z",
      "updated_at": "2025-05-26T10:15:00Z"
    },
    {
      "id": "pay_e8a1b2c3-d4f5-6789-abcd-ef0123456789",
      "amount": 15000,
      "amount_usd": 15000,
      "currency_code": "USD",
      "payment_status": "SETTLED",
      "payment_type": "CIT",
      "payment_token_type": "CARD_PAN",
      "refunded_amount": 0,
      "refund_reason": null,
      "statement_descriptor": "ACME CORP",
      "customer": {
        "id": "cus_b8d0fe7e-3a7f-4b5f-a68b-d31358b49c3f",
        "email": "alice.johnson@example.com",
        "external_id": "ext_001",
        "full_name": "Alice Johnson",
        "phone": "+1-555-123-4567",
        "address": {
          "city": "San Francisco",
          "country": "US",
          "line1": "123 Market Street",
          "line2": "Suite 400",
          "postal_code": "94105",
          "state": "CA"
        },
        "metadata": {
          "key": "value"
        },
        "created_at": "2025-05-28T14:00:00Z",
        "updated_at": "2025-05-28T14:05:00Z"
      },
      "payment_method": {
        "type": "GPAY",
        "details": {
          "token": "gp_token_12345678",
          "token_exp_month": 12,
          "token_exp_year": 2028,
          "token_service_provider": "GOOGLE"
        },
        "billing_address": {
          "city": "San Francisco",
          "country": "US",
          "line1": "123 Market Street",
          "line2": "Suite 400",
          "postal_code": "94105",
          "state": "CA"
        }
      },
      "payment_details": {
        "arn": "74922051234567",
        "auth_code": "334385",
        "network_payment_id": "119676610486528",
        "processor_transaction_id": "pi_3RgN6TJVVBuowJOx0B4fpGWi"
      },
      "processor": {
        "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
        "description": "Stripe US",
        "type": "STRIPE",
        "processor_merchant_id": "12345678"
      },
      "subscription": {
        "id": "sub_123e4567-e89b-12d3-a456-426614174000",
        "status": "active",
        "current_period_start": "2025-05-26T10:00:00Z",
        "current_period_end": "2025-06-26T10:00:00Z",
        "cancelled_at": null,
        "cancellation_details": {
          "reason": null,
          "trigger_payment_id": null
        },
        "next_billing_date": "2025-06-26T12:00:00Z",
        "past_due": {
          "attempt_count": 0,
          "max_attempts_count": 7
        },
        "plan": {
          "id": "price_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
          "name": "Pro Plan",
          "type": "recurring",
          "interval": "months",
          "interval_count": 1,
          "trial_interval": "days",
          "trial_interval_count": 14,
          "price": {
            "amount": 1999,
            "currency": "USD"
          },
          "trial_price": {
            "amount": 0,
            "currency": "USD"
          },
          "tax": {
            "collect_tax": "DEFAULT"
          }
        },
        "metadata": {},
        "created_at": "2025-05-26T10:00:00Z",
        "updated_at": "2025-05-27T10:00:00Z"
      },
      "refund": {
        "amount": 0,
        "amount_usd": 0,
        "status": "PENDING",
        "processor_transaction_id": "",
        "created_at": "2025-05-26T10:15:00Z",
        "updated_at": "2025-05-26T10:15:00Z"
      },
      "avs_check": {
        "result": {
          "postal_code": "pass",
          "street_address": "pass"
        }
      },
      "cvc_check": {
        "result": {
          "cvc": "pass"
        }
      },
      "tax": {
        "amount_subtotal": 15000,
        "amount_subtotal_usd": 15000,
        "amount_tax": 0,
        "amount_tax_usd": 0,
        "behavior": "EXCLUSIVE",
        "status": "calculated",
        "provider": {
          "id": "numeral",
          "type": "NUMERAL"
        },
        "calculation_id": "calc_123",
        "transaction_id": "tx_123"
      },
      "three_d_secure": {
        "authentication_flow": "challenge",
        "status": "success",
        "version": "2.2.0",
        "transaction_id": "3ds_123",
        "electronic_commerce_indicator": {
          "liability_shift": true,
          "result": "pass",
          "value": "05"
        }
      },
      "status_reason": {
        "status": "declined",
        "status_reason": {
          "advice_code": "do_not_try_again",
          "decline_code": "insufficient_funds",
          "message": "Card has insufficient funds"
        }
      },
      "metadata": {
        "order_id": "ORD-12345"
      },
      "created_at": "2025-05-25T14:30:00Z",
      "updated_at": "2025-05-26T10:15:00Z"
    }
  ]
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "Missing required parameter: email",
    "code": "parameter_missing",
    "param": "email"
  }
}

Headers

X-API-Version

enum<string>

default:2.0.0

required

Specifies the version of the API to use

Available options:

2.0.0

Query Parameters

query

string

required

The search query string. Uses PayNext's Search Query Language. Supports exact match (:), substring match (~), numeric comparisons (>, >=, <, <=), negation (-), logical operators (AND, OR), and nested field access (dot notation). Field names use dotted paths (for example payment_status, customer.email, payment_method.details.last4); short aliases are not accepted. See the endpoint description for the full list of searchable fields and their types. Maximum 10 clauses per query.

limit

integer

default:10

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Required range: 1 <= x <= 100

page

string

A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

Response

A dictionary with a data property that contains an array of up to limit payments. If no payments match the query, the resulting array will be empty.

object

enum<string>

String representing the object's type. Value is always payments.

Available options:

payments

Example:

"payments"

total_count

integer

The accurate total number of records matching the query (not capped at 10,000). Returned alongside the cursor pagination fields.

Example:

142

url

string

The URL for accessing this list.

Example:

"/v1/payments"

data

object[]

An array of up to limit payments that match the query. Each entry in the array is a separate payment object. If no payments match the query, the resulting array will be empty.

Show child attributes

has_more

boolean

Whether or not there are more elements available after this set. If false, this set comprises the end of the list.

Example:

false

next_page

string | null

A cursor for use in pagination. If has_more is true, you can pass the value of next_page to a subsequent call to fetch the next page of results.

Example:

null

⌘I

Find payments

curl --request GET \
  --url https://sandbox-api.paynext.com/payments \
  --header 'X-API-Version: <x-api-version>'

const options = {method: 'GET', headers: {'X-API-Version': '<x-api-version>'}};

fetch('https://sandbox-api.paynext.com/payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-api.paynext.com/payments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Version", "<x-api-version>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-api.paynext.com/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Version: <x-api-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "object": "payments",
  "url": "/v1/payments",
  "has_more": false,
  "next_page": null,
  "data": [
    {
      "id": "pay_e8a1b2c3-d4f5-6789-abcd-ef0123456789",
      "amount": 15000,
      "amount_usd": 15000,
      "currency_code": "USD",
      "payment_status": "SETTLED",
      "payment_type": "CIT",
      "payment_token_type": "CARD_PAN",
      "refunded_amount": 0,
      "refund_reason": null,
      "statement_descriptor": "ACME CORP",
      "customer": {
        "id": "cus_b8d0fe7e-3a7f-4b5f-a68b-d31358b49c3f",
        "email": "alice.johnson@example.com",
        "external_id": "ext_001",
        "full_name": "Alice Johnson",
        "phone": "+1-555-123-4567",
        "address": {
          "city": "San Francisco",
          "country": "US",
          "line1": "123 Market Street",
          "line2": "Suite 400",
          "postal_code": "94105",
          "state": "CA"
        },
        "metadata": {
          "key": "value"
        },
        "created_at": "2025-05-28T14:00:00Z",
        "updated_at": "2025-05-28T14:05:00Z"
      },
      "payment_method": {
        "type": "CARD",
        "billing_address": {
          "city": "San Francisco",
          "country": "US",
          "line1": "123 Market Street",
          "line2": "Suite 400",
          "postal_code": "94105",
          "state": "CA"
        },
        "details": {
          "bin": "411111",
          "last4": "1111",
          "exp_month": 12,
          "exp_year": 2028,
          "is_network_tokenized": true,
          "number": "4111111111111111",
          "bin_data": {
            "brand": "visa",
            "country": "US",
            "currency_code": "USD",
            "description": "Chase Sapphire Preferred",
            "funding": "credit",
            "issuer": "Chase Bank",
            "type": "consumer"
          }
        }
      },
      "payment_details": {
        "arn": "74922051234567",
        "auth_code": "334385",
        "network_payment_id": "119676610486528",
        "processor_transaction_id": "pi_3RgN6TJVVBuowJOx0B4fpGWi"
      },
      "processor": {
        "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
        "description": "Stripe US",
        "type": "STRIPE",
        "processor_merchant_id": "12345678"
      },
      "subscription": {
        "id": "sub_123e4567-e89b-12d3-a456-426614174000",
        "status": "active",
        "current_period_start": "2025-05-26T10:00:00Z",
        "current_period_end": "2025-06-26T10:00:00Z",
        "cancelled_at": null,
        "cancellation_details": {
          "reason": null,
          "trigger_payment_id": null
        },
        "next_billing_date": "2025-06-26T12:00:00Z",
        "past_due": {
          "attempt_count": 0,
          "max_attempts_count": 7
        },
        "plan": {
          "id": "price_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
          "name": "Pro Plan",
          "type": "recurring",
          "interval": "months",
          "interval_count": 1,
          "trial_interval": "days",
          "trial_interval_count": 14,
          "price": {
            "amount": 1999,
            "currency": "USD"
          },
          "trial_price": {
            "amount": 0,
            "currency": "USD"
          },
          "tax": {
            "collect_tax": "DEFAULT"
          }
        },
        "metadata": {},
        "created_at": "2025-05-26T10:00:00Z",
        "updated_at": "2025-05-27T10:00:00Z"
      },
      "refund": {
        "amount": 0,
        "amount_usd": 0,
        "status": "PENDING",
        "processor_transaction_id": "",
        "created_at": "2025-05-26T10:15:00Z",
        "updated_at": "2025-05-26T10:15:00Z"
      },
      "avs_check": {
        "result": {
          "postal_code": "pass",
          "street_address": "pass"
        }
      },
      "cvc_check": {
        "result": {
          "cvc": "pass"
        }
      },
      "tax": {
        "amount_subtotal": 15000,
        "amount_subtotal_usd": 15000,
        "amount_tax": 0,
        "amount_tax_usd": 0,
        "behavior": "EXCLUSIVE",
        "status": "calculated",
        "provider": {
          "id": "numeral",
          "type": "NUMERAL"
        },
        "calculation_id": "calc_123",
        "transaction_id": "tx_123"
      },
      "three_d_secure": {
        "authentication_flow": "challenge",
        "status": "success",
        "version": "2.2.0",
        "transaction_id": "3ds_123",
        "electronic_commerce_indicator": {
          "liability_shift": true,
          "result": "pass",
          "value": "05"
        }
      },
      "status_reason": {
        "status": "declined",
        "status_reason": {
          "advice_code": "do_not_try_again",
          "decline_code": "insufficient_funds",
          "message": "Card has insufficient funds"
        }
      },
      "metadata": {
        "order_id": "ORD-12345"
      },
      "created_at": "2025-05-25T14:30:00Z",
      "updated_at": "2025-05-26T10:15:00Z"
    },
    {
      "id": "pay_e8a1b2c3-d4f5-6789-abcd-ef0123456789",
      "amount": 15000,
      "amount_usd": 15000,
      "currency_code": "USD",
      "payment_status": "SETTLED",
      "payment_type": "CIT",
      "payment_token_type": "CARD_PAN",
      "refunded_amount": 0,
      "refund_reason": null,
      "statement_descriptor": "ACME CORP",
      "customer": {
        "id": "cus_b8d0fe7e-3a7f-4b5f-a68b-d31358b49c3f",
        "email": "alice.johnson@example.com",
        "external_id": "ext_001",
        "full_name": "Alice Johnson",
        "phone": "+1-555-123-4567",
        "address": {
          "city": "San Francisco",
          "country": "US",
          "line1": "123 Market Street",
          "line2": "Suite 400",
          "postal_code": "94105",
          "state": "CA"
        },
        "metadata": {
          "key": "value"
        },
        "created_at": "2025-05-28T14:00:00Z",
        "updated_at": "2025-05-28T14:05:00Z"
      },
      "payment_method": {
        "type": "PAYPAL",
        "details": {
          "payer_info": {
            "email": "alice.johnson@example.com",
            "first_name": "Alice",
            "last_name": "Johnson",
            "payer_id": "PAYER12345",
            "tenant": "Tenant"
          },
          "processor_customer_email": "alice.johnson@example.com",
          "processor_customer_id": "cus_pp_1234567890",
          "processor_payment_method_id": "pm_pp_1234567890"
        },
        "billing_address": {
          "city": "San Francisco",
          "country": "US",
          "line1": "123 Market Street",
          "line2": "Suite 400",
          "postal_code": "94105",
          "state": "CA"
        }
      },
      "payment_details": {
        "arn": "74922051234567",
        "auth_code": "334385",
        "network_payment_id": "119676610486528",
        "processor_transaction_id": "pi_3RgN6TJVVBuowJOx0B4fpGWi"
      },
      "processor": {
        "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
        "description": "Stripe US",
        "type": "STRIPE",
        "processor_merchant_id": "12345678"
      },
      "subscription": {
        "id": "sub_123e4567-e89b-12d3-a456-426614174000",
        "status": "active",
        "current_period_start": "2025-05-26T10:00:00Z",
        "current_period_end": "2025-06-26T10:00:00Z",
        "cancelled_at": null,
        "cancellation_details": {
          "reason": null,
          "trigger_payment_id": null
        },
        "next_billing_date": "2025-06-26T12:00:00Z",
        "past_due": {
          "attempt_count": 0,
          "max_attempts_count": 7
        },
        "plan": {
          "id": "price_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
          "name": "Pro Plan",
          "type": "recurring",
          "interval": "months",
          "interval_count": 1,
          "trial_interval": "days",
          "trial_interval_count": 14,
          "price": {
            "amount": 1999,
            "currency": "USD"
          },
          "trial_price": {
            "amount": 0,
            "currency": "USD"
          },
          "tax": {
            "collect_tax": "DEFAULT"
          }
        },
        "metadata": {},
        "created_at": "2025-05-26T10:00:00Z",
        "updated_at": "2025-05-27T10:00:00Z"
      },
      "refund": {
        "amount": 0,
        "amount_usd": 0,
        "status": "PENDING",
        "processor_transaction_id": "",
        "created_at": "2025-05-26T10:15:00Z",
        "updated_at": "2025-05-26T10:15:00Z"
      },
      "avs_check": {
        "result": {
          "postal_code": "pass",
          "street_address": "pass"
        }
      },
      "cvc_check": {
        "result": {
          "cvc": "pass"
        }
      },
      "tax": {
        "amount_subtotal": 15000,
        "amount_subtotal_usd": 15000,
        "amount_tax": 0,
        "amount_tax_usd": 0,
        "behavior": "EXCLUSIVE",
        "status": "calculated",
        "provider": {
          "id": "numeral",
          "type": "NUMERAL"
        },
        "calculation_id": "calc_123",
        "transaction_id": "tx_123"
      },
      "three_d_secure": {
        "authentication_flow": "challenge",
        "status": "success",
        "version": "2.2.0",
        "transaction_id": "3ds_123",
        "electronic_commerce_indicator": {
          "liability_shift": true,
          "result": "pass",
          "value": "05"
        }
      },
      "status_reason": {
        "status": "declined",
        "status_reason": {
          "advice_code": "do_not_try_again",
          "decline_code": "insufficient_funds",
          "message": "Card has insufficient funds"
        }
      },
      "metadata": {
        "order_id": "ORD-12345"
      },
      "created_at": "2025-05-25T14:30:00Z",
      "updated_at": "2025-05-26T10:15:00Z"
    },
    {
      "id": "pay_e8a1b2c3-d4f5-6789-abcd-ef0123456789",
      "amount": 15000,
      "amount_usd": 15000,
      "currency_code": "USD",
      "payment_status": "SETTLED",
      "payment_type": "CIT",
      "payment_token_type": "CARD_PAN",
      "refunded_amount": 0,
      "refund_reason": null,
      "statement_descriptor": "ACME CORP",
      "customer": {
        "id": "cus_b8d0fe7e-3a7f-4b5f-a68b-d31358b49c3f",
        "email": "alice.johnson@example.com",
        "external_id": "ext_001",
        "full_name": "Alice Johnson",
        "phone": "+1-555-123-4567",
        "address": {
          "city": "San Francisco",
          "country": "US",
          "line1": "123 Market Street",
          "line2": "Suite 400",
          "postal_code": "94105",
          "state": "CA"
        },
        "metadata": {
          "key": "value"
        },
        "created_at": "2025-05-28T14:00:00Z",
        "updated_at": "2025-05-28T14:05:00Z"
      },
      "payment_method": {
        "type": "VENMO",
        "details": {
          "processor_payment_method_id": "pm_venmo_1234567890"
        }
      },
      "payment_details": {
        "arn": "74922051234567",
        "auth_code": "334385",
        "network_payment_id": "119676610486528",
        "processor_transaction_id": "pi_3RgN6TJVVBuowJOx0B4fpGWi"
      },
      "processor": {
        "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
        "description": "Stripe US",
        "type": "STRIPE",
        "processor_merchant_id": "12345678"
      },
      "subscription": {
        "id": "sub_123e4567-e89b-12d3-a456-426614174000",
        "status": "active",
        "current_period_start": "2025-05-26T10:00:00Z",
        "current_period_end": "2025-06-26T10:00:00Z",
        "cancelled_at": null,
        "cancellation_details": {
          "reason": null,
          "trigger_payment_id": null
        },
        "next_billing_date": "2025-06-26T12:00:00Z",
        "past_due": {
          "attempt_count": 0,
          "max_attempts_count": 7
        },
        "plan": {
          "id": "price_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
          "name": "Pro Plan",
          "type": "recurring",
          "interval": "months",
          "interval_count": 1,
          "trial_interval": "days",
          "trial_interval_count": 14,
          "price": {
            "amount": 1999,
            "currency": "USD"
          },
          "trial_price": {
            "amount": 0,
            "currency": "USD"
          },
          "tax": {
            "collect_tax": "DEFAULT"
          }
        },
        "metadata": {},
        "created_at": "2025-05-26T10:00:00Z",
        "updated_at": "2025-05-27T10:00:00Z"
      },
      "refund": {
        "amount": 0,
        "amount_usd": 0,
        "status": "PENDING",
        "processor_transaction_id": "",
        "created_at": "2025-05-26T10:15:00Z",
        "updated_at": "2025-05-26T10:15:00Z"
      },
      "avs_check": {
        "result": {
          "postal_code": "pass",
          "street_address": "pass"
        }
      },
      "cvc_check": {
        "result": {
          "cvc": "pass"
        }
      },
      "tax": {
        "amount_subtotal": 15000,
        "amount_subtotal_usd": 15000,
        "amount_tax": 0,
        "amount_tax_usd": 0,
        "behavior": "EXCLUSIVE",
        "status": "calculated",
        "provider": {
          "id": "numeral",
          "type": "NUMERAL"
        },
        "calculation_id": "calc_123",
        "transaction_id": "tx_123"
      },
      "three_d_secure": {
        "authentication_flow": "challenge",
        "status": "success",
        "version": "2.2.0",
        "transaction_id": "3ds_123",
        "electronic_commerce_indicator": {
          "liability_shift": true,
          "result": "pass",
          "value": "05"
        }
      },
      "status_reason": {
        "status": "declined",
        "status_reason": {
          "advice_code": "do_not_try_again",
          "decline_code": "insufficient_funds",
          "message": "Card has insufficient funds"
        }
      },
      "metadata": {
        "order_id": "ORD-12345"
      },
      "created_at": "2025-05-25T14:30:00Z",
      "updated_at": "2025-05-26T10:15:00Z"
    },
    {
      "id": "pay_e8a1b2c3-d4f5-6789-abcd-ef0123456789",
      "amount": 15000,
      "amount_usd": 15000,
      "currency_code": "USD",
      "payment_status": "SETTLED",
      "payment_type": "CIT",
      "payment_token_type": "CARD_PAN",
      "refunded_amount": 0,
      "refund_reason": null,
      "statement_descriptor": "ACME CORP",
      "customer": {
        "id": "cus_b8d0fe7e-3a7f-4b5f-a68b-d31358b49c3f",
        "email": "alice.johnson@example.com",
        "external_id": "ext_001",
        "full_name": "Alice Johnson",
        "phone": "+1-555-123-4567",
        "address": {
          "city": "San Francisco",
          "country": "US",
          "line1": "123 Market Street",
          "line2": "Suite 400",
          "postal_code": "94105",
          "state": "CA"
        },
        "metadata": {
          "key": "value"
        },
        "created_at": "2025-05-28T14:00:00Z",
        "updated_at": "2025-05-28T14:05:00Z"
      },
      "payment_method": {
        "type": "CASHAPP",
        "details": {
          "processor_customer_id": "cus_ca_1234567890",
          "processor_payment_method_id": "pm_ca_1234567890"
        }
      },
      "payment_details": {
        "arn": "74922051234567",
        "auth_code": "334385",
        "network_payment_id": "119676610486528",
        "processor_transaction_id": "pi_3RgN6TJVVBuowJOx0B4fpGWi"
      },
      "processor": {
        "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
        "description": "Stripe US",
        "type": "STRIPE",
        "processor_merchant_id": "12345678"
      },
      "subscription": {
        "id": "sub_123e4567-e89b-12d3-a456-426614174000",
        "status": "active",
        "current_period_start": "2025-05-26T10:00:00Z",
        "current_period_end": "2025-06-26T10:00:00Z",
        "cancelled_at": null,
        "cancellation_details": {
          "reason": null,
          "trigger_payment_id": null
        },
        "next_billing_date": "2025-06-26T12:00:00Z",
        "past_due": {
          "attempt_count": 0,
          "max_attempts_count": 7
        },
        "plan": {
          "id": "price_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
          "name": "Pro Plan",
          "type": "recurring",
          "interval": "months",
          "interval_count": 1,
          "trial_interval": "days",
          "trial_interval_count": 14,
          "price": {
            "amount": 1999,
            "currency": "USD"
          },
          "trial_price": {
            "amount": 0,
            "currency": "USD"
          },
          "tax": {
            "collect_tax": "DEFAULT"
          }
        },
        "metadata": {},
        "created_at": "2025-05-26T10:00:00Z",
        "updated_at": "2025-05-27T10:00:00Z"
      },
      "refund": {
        "amount": 0,
        "amount_usd": 0,
        "status": "PENDING",
        "processor_transaction_id": "",
        "created_at": "2025-05-26T10:15:00Z",
        "updated_at": "2025-05-26T10:15:00Z"
      },
      "avs_check": {
        "result": {
          "postal_code": "pass",
          "street_address": "pass"
        }
      },
      "cvc_check": {
        "result": {
          "cvc": "pass"
        }
      },
      "tax": {
        "amount_subtotal": 15000,
        "amount_subtotal_usd": 15000,
        "amount_tax": 0,
        "amount_tax_usd": 0,
        "behavior": "EXCLUSIVE",
        "status": "calculated",
        "provider": {
          "id": "numeral",
          "type": "NUMERAL"
        },
        "calculation_id": "calc_123",
        "transaction_id": "tx_123"
      },
      "three_d_secure": {
        "authentication_flow": "challenge",
        "status": "success",
        "version": "2.2.0",
        "transaction_id": "3ds_123",
        "electronic_commerce_indicator": {
          "liability_shift": true,
          "result": "pass",
          "value": "05"
        }
      },
      "status_reason": {
        "status": "declined",
        "status_reason": {
          "advice_code": "do_not_try_again",
          "decline_code": "insufficient_funds",
          "message": "Card has insufficient funds"
        }
      },
      "metadata": {
        "order_id": "ORD-12345"
      },
      "created_at": "2025-05-25T14:30:00Z",
      "updated_at": "2025-05-26T10:15:00Z"
    },
    {
      "id": "pay_e8a1b2c3-d4f5-6789-abcd-ef0123456789",
      "amount": 15000,
      "amount_usd": 15000,
      "currency_code": "USD",
      "payment_status": "SETTLED",
      "payment_type": "CIT",
      "payment_token_type": "CARD_PAN",
      "refunded_amount": 0,
      "refund_reason": null,
      "statement_descriptor": "ACME CORP",
      "customer": {
        "id": "cus_b8d0fe7e-3a7f-4b5f-a68b-d31358b49c3f",
        "email": "alice.johnson@example.com",
        "external_id": "ext_001",
        "full_name": "Alice Johnson",
        "phone": "+1-555-123-4567",
        "address": {
          "city": "San Francisco",
          "country": "US",
          "line1": "123 Market Street",
          "line2": "Suite 400",
          "postal_code": "94105",
          "state": "CA"
        },
        "metadata": {
          "key": "value"
        },
        "created_at": "2025-05-28T14:00:00Z",
        "updated_at": "2025-05-28T14:05:00Z"
      },
      "payment_method": {
        "type": "APPLEPAY",
        "details": {
          "token": "ap_token_12345678",
          "token_exp_month": 12,
          "token_exp_year": 2028,
          "token_service_provider": "APPLE"
        },
        "billing_address": {
          "city": "San Francisco",
          "country": "US",
          "line1": "123 Market Street",
          "line2": "Suite 400",
          "postal_code": "94105",
          "state": "CA"
        }
      },
      "payment_details": {
        "arn": "74922051234567",
        "auth_code": "334385",
        "network_payment_id": "119676610486528",
        "processor_transaction_id": "pi_3RgN6TJVVBuowJOx0B4fpGWi"
      },
      "processor": {
        "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
        "description": "Stripe US",
        "type": "STRIPE",
        "processor_merchant_id": "12345678"
      },
      "subscription": {
        "id": "sub_123e4567-e89b-12d3-a456-426614174000",
        "status": "active",
        "current_period_start": "2025-05-26T10:00:00Z",
        "current_period_end": "2025-06-26T10:00:00Z",
        "cancelled_at": null,
        "cancellation_details": {
          "reason": null,
          "trigger_payment_id": null
        },
        "next_billing_date": "2025-06-26T12:00:00Z",
        "past_due": {
          "attempt_count": 0,
          "max_attempts_count": 7
        },
        "plan": {
          "id": "price_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
          "name": "Pro Plan",
          "type": "recurring",
          "interval": "months",
          "interval_count": 1,
          "trial_interval": "days",
          "trial_interval_count": 14,
          "price": {
            "amount": 1999,
            "currency": "USD"
          },
          "trial_price": {
            "amount": 0,
            "currency": "USD"
          },
          "tax": {
            "collect_tax": "DEFAULT"
          }
        },
        "metadata": {},
        "created_at": "2025-05-26T10:00:00Z",
        "updated_at": "2025-05-27T10:00:00Z"
      },
      "refund": {
        "amount": 0,
        "amount_usd": 0,
        "status": "PENDING",
        "processor_transaction_id": "",
        "created_at": "2025-05-26T10:15:00Z",
        "updated_at": "2025-05-26T10:15:00Z"
      },
      "avs_check": {
        "result": {
          "postal_code": "pass",
          "street_address": "pass"
        }
      },
      "cvc_check": {
        "result": {
          "cvc": "pass"
        }
      },
      "tax": {
        "amount_subtotal": 15000,
        "amount_subtotal_usd": 15000,
        "amount_tax": 0,
        "amount_tax_usd": 0,
        "behavior": "EXCLUSIVE",
        "status": "calculated",
        "provider": {
          "id": "numeral",
          "type": "NUMERAL"
        },
        "calculation_id": "calc_123",
        "transaction_id": "tx_123"
      },
      "three_d_secure": {
        "authentication_flow": "challenge",
        "status": "success",
        "version": "2.2.0",
        "transaction_id": "3ds_123",
        "electronic_commerce_indicator": {
          "liability_shift": true,
          "result": "pass",
          "value": "05"
        }
      },
      "status_reason": {
        "status": "declined",
        "status_reason": {
          "advice_code": "do_not_try_again",
          "decline_code": "insufficient_funds",
          "message": "Card has insufficient funds"
        }
      },
      "metadata": {
        "order_id": "ORD-12345"
      },
      "created_at": "2025-05-25T14:30:00Z",
      "updated_at": "2025-05-26T10:15:00Z"
    },
    {
      "id": "pay_e8a1b2c3-d4f5-6789-abcd-ef0123456789",
      "amount": 15000,
      "amount_usd": 15000,
      "currency_code": "USD",
      "payment_status": "SETTLED",
      "payment_type": "CIT",
      "payment_token_type": "CARD_PAN",
      "refunded_amount": 0,
      "refund_reason": null,
      "statement_descriptor": "ACME CORP",
      "customer": {
        "id": "cus_b8d0fe7e-3a7f-4b5f-a68b-d31358b49c3f",
        "email": "alice.johnson@example.com",
        "external_id": "ext_001",
        "full_name": "Alice Johnson",
        "phone": "+1-555-123-4567",
        "address": {
          "city": "San Francisco",
          "country": "US",
          "line1": "123 Market Street",
          "line2": "Suite 400",
          "postal_code": "94105",
          "state": "CA"
        },
        "metadata": {
          "key": "value"
        },
        "created_at": "2025-05-28T14:00:00Z",
        "updated_at": "2025-05-28T14:05:00Z"
      },
      "payment_method": {
        "type": "GPAY",
        "details": {
          "token": "gp_token_12345678",
          "token_exp_month": 12,
          "token_exp_year": 2028,
          "token_service_provider": "GOOGLE"
        },
        "billing_address": {
          "city": "San Francisco",
          "country": "US",
          "line1": "123 Market Street",
          "line2": "Suite 400",
          "postal_code": "94105",
          "state": "CA"
        }
      },
      "payment_details": {
        "arn": "74922051234567",
        "auth_code": "334385",
        "network_payment_id": "119676610486528",
        "processor_transaction_id": "pi_3RgN6TJVVBuowJOx0B4fpGWi"
      },
      "processor": {
        "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
        "description": "Stripe US",
        "type": "STRIPE",
        "processor_merchant_id": "12345678"
      },
      "subscription": {
        "id": "sub_123e4567-e89b-12d3-a456-426614174000",
        "status": "active",
        "current_period_start": "2025-05-26T10:00:00Z",
        "current_period_end": "2025-06-26T10:00:00Z",
        "cancelled_at": null,
        "cancellation_details": {
          "reason": null,
          "trigger_payment_id": null
        },
        "next_billing_date": "2025-06-26T12:00:00Z",
        "past_due": {
          "attempt_count": 0,
          "max_attempts_count": 7
        },
        "plan": {
          "id": "price_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
          "name": "Pro Plan",
          "type": "recurring",
          "interval": "months",
          "interval_count": 1,
          "trial_interval": "days",
          "trial_interval_count": 14,
          "price": {
            "amount": 1999,
            "currency": "USD"
          },
          "trial_price": {
            "amount": 0,
            "currency": "USD"
          },
          "tax": {
            "collect_tax": "DEFAULT"
          }
        },
        "metadata": {},
        "created_at": "2025-05-26T10:00:00Z",
        "updated_at": "2025-05-27T10:00:00Z"
      },
      "refund": {
        "amount": 0,
        "amount_usd": 0,
        "status": "PENDING",
        "processor_transaction_id": "",
        "created_at": "2025-05-26T10:15:00Z",
        "updated_at": "2025-05-26T10:15:00Z"
      },
      "avs_check": {
        "result": {
          "postal_code": "pass",
          "street_address": "pass"
        }
      },
      "cvc_check": {
        "result": {
          "cvc": "pass"
        }
      },
      "tax": {
        "amount_subtotal": 15000,
        "amount_subtotal_usd": 15000,
        "amount_tax": 0,
        "amount_tax_usd": 0,
        "behavior": "EXCLUSIVE",
        "status": "calculated",
        "provider": {
          "id": "numeral",
          "type": "NUMERAL"
        },
        "calculation_id": "calc_123",
        "transaction_id": "tx_123"
      },
      "three_d_secure": {
        "authentication_flow": "challenge",
        "status": "success",
        "version": "2.2.0",
        "transaction_id": "3ds_123",
        "electronic_commerce_indicator": {
          "liability_shift": true,
          "result": "pass",
          "value": "05"
        }
      },
      "status_reason": {
        "status": "declined",
        "status_reason": {
          "advice_code": "do_not_try_again",
          "decline_code": "insufficient_funds",
          "message": "Card has insufficient funds"
        }
      },
      "metadata": {
        "order_id": "ORD-12345"
      },
      "created_at": "2025-05-25T14:30:00Z",
      "updated_at": "2025-05-26T10:15:00Z"
    }
  ]
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "Missing required parameter: email",
    "code": "parameter_missing",
    "param": "email"
  }
}

Introduction

API Reference

Find payments

Search Query Language

Operators

Logical Operators

Quoting

Metadata

Null Checks

Nested Fields

Searchable Payment Fields

Headers

Query Parameters

Response