Payments

Find payments

On API version 1 (without the X-API-Version: 2.0.0 header), GET /payments and GET /payments/opensearch accept an optional raw OpenSearch query object in the request body. Exact term, terms, and exists predicates, and ordinary queries, keep working. A body that uses a non-exact predicate (prefix, wildcard, regexp, range, fuzzy, intervals with use_field, and similar forms, including inside bool must, must_not, filter, or should) on a card number, a card security code, or a wallet token is refused with HTTP 400. The error message is: search body must not sort, collapse, aggregate, or use a non-exact query on a card number, card security code, network-token number, or wallet token.

A body that references network_token fields is refused with HTTP 400. The error message is: query body must not reference network_token fields.

GET

payments

Find payments

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

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

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>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

import requests

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

headers = {
    "X-API-Version": "<x-api-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

<?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 => [
    "Authorization: Bearer <token>",
    "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;
}

{
  "data": [
    {
      "amount": 15000,
      "amount_usd": 15000,
      "avs_check": {
        "result": {
          "postal_code": "pass",
          "street_address": "pass"
        }
      },
      "created_at": "2025-05-25T14:30:00Z",
      "currency_code": "AED",
      "customer": {
        "address": {
          "city": "San Francisco",
          "country": "AD",
          "line1": "123 Market Street",
          "line2": "Suite 400",
          "postal_code": "94105",
          "state": "CA"
        },
        "created_at": "2025-05-28T14:00:00Z",
        "email": "alice.johnson@example.com",
        "external_id": "ext_001",
        "full_name": "Alice Johnson",
        "id": "cus_b8d0fe7e-3a7f-4b5f-a68b-d31358b49c3f",
        "metadata": {
          "key": "value"
        },
        "phone": "+1-555-123-4567",
        "updated_at": "2025-05-28T14:05:00Z"
      },
      "cvc_check": {
        "result": {
          "cvc": "pass"
        }
      },
      "disputes": [
        {
          "disputed_at": "2026-08-01T10:15:00Z",
          "external_id": "dp_1Nx2yZAbCdEfGh",
          "id": "dsp_7c1a2b3c-4d5e-6f70-8a9b-0c1d2e3f4a5b",
          "reason": "FRAUDULENT",
          "stage": "DISPUTE",
          "status": "NEEDS_RESPONSE"
        }
      ],
      "id": "pay_e8a1b2c3-d4f5-6789-abcd-ef0123456789",
      "metadata": {
        "key": "value"
      },
      "payment_details": {
        "arn": "123453",
        "auth_code": "334385",
        "network_payment_id": "119676610486528",
        "processor_transaction_id": "pi_3RgN6TJVVBuowJOx0B4fpGWi"
      },
      "payment_method": {
        "details": {
          "bin": "411111",
          "bin_data": {
            "brand": "visa",
            "country": "AD",
            "currency_code": "<string>",
            "description": "Chase Sapphire Preferred",
            "funding": "debit",
            "issuer": "Chase Bank",
            "type": "consumer"
          },
          "exp_month": 12,
          "exp_year": 2028,
          "is_network_tokenized": true,
          "last4": "1111",
          "network_token": {
            "bin": "48953700",
            "last4": "0370",
            "exp_month": 5,
            "exp_year": 31,
            "status": "active",
            "last_synced_at": "2025-05-26T10:15:00Z"
          },
          "number": "4111111111111111"
        },
        "type": "CARD",
        "billing_address": {
          "city": "San Francisco",
          "country": "AD",
          "line1": "123 Market Street",
          "line2": "Suite 400",
          "postal_code": "94105",
          "state": "CA"
        },
        "card_updater": true,
        "fpan_out_of_sync": false,
        "status": "active"
      },
      "payment_status": "PENDING",
      "payment_token_type": "CARD_PAN",
      "payment_type": "MIT",
      "processor": {
        "description": "Stripe US",
        "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
        "processor_merchant_id": "12345678",
        "type": "STRIPE"
      },
      "refund": {
        "amount": 123,
        "amount_usd": 123,
        "created_at": "<string>",
        "processor_transaction_id": "<string>",
        "status": "PENDING",
        "updated_at": "<string>"
      },
      "refunded_amount": 0,
      "refund_reason": "fraud_prevention",
      "statement_descriptor": "MY COMPANY",
      "status_reason": {
        "status": "declined",
        "status_reason": {
          "advice_code": "do_not_try_again",
          "decline_code": "insufficient_funds",
          "message": "<string>"
        }
      },
      "subscription": {
        "created_at": "2025-05-26T10:00:00Z",
        "current_period_end": "<string>",
        "cancelled_at": "2026-06-10T14:32:08Z",
        "cancellation_details": {
          "reason": "fraud_prevention",
          "trigger_payment_id": "pay_e8a1b2c3-1d2e-3f4a-5b6c-7d8e9f0a1b2c"
        },
        "current_period_start": "<string>",
        "id": "sub_123e4567-e89b-12d3-a456-426614174000",
        "metadata": {
          "key": "value"
        },
        "next_billing_date": "2025-06-26T12:00:00Z",
        "past_due": {
          "attempt_count": 2,
          "max_attempts_count": 7
        },
        "plan": {
          "id": "price_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
          "interval": "days",
          "interval_count": 1,
          "name": "Pro Plan",
          "price": {
            "amount": 1999,
            "currency": "AED"
          },
          "tax": {
            "collect_tax": "<unknown>"
          },
          "trial_interval": "days",
          "trial_interval_count": 14,
          "trial_price": {
            "amount": 1999,
            "currency": "AED"
          },
          "type": "recurring"
        },
        "status": "trial",
        "updated_at": "2025-05-27T10:00:00Z"
      },
      "tax": {
        "amount_subtotal": 123,
        "amount_subtotal_usd": 123,
        "amount_tax": 123,
        "amount_tax_usd": 123,
        "behavior": "<unknown>",
        "calculation_id": "<string>",
        "error": {
          "code": "<unknown>",
          "message": "<string>"
        },
        "provider": {
          "id": "<string>",
          "type": "NUMERAL"
        },
        "status": "<unknown>",
        "transaction_id": "<string>"
      },
      "three_d_secure": {
        "authentication_flow": "<string>",
        "electronic_commerce_indicator": {
          "liability_shift": true,
          "result": "<string>",
          "value": "<string>"
        },
        "status": "action-required",
        "status_reason": "<string>",
        "transaction_id": "<string>",
        "version": "<string>"
      },
      "updated_at": "2025-05-26T10:15:00Z"
    }
  ],
  "meta": {
    "limit": 100,
    "page": 1,
    "pages": 1,
    "snapshot_at": "2026-01-01T00:00:00Z",
    "total": 1
  }
}

{
  "error": {
    "message": "some error message"
  }
}

{
  "error": {
    "message": "some error message"
  }
}

{
  "error": {
    "message": "some error message"
  }
}

Authorizations

Authorization

string

header

required

Authentication header of the form api key, where api key is your organization api key.

Headers

X-API-Version

enum<string>

default:1.0.0

required

Specifies the version of the API to use

Available options:

1.0.0

Query Parameters

amount_from

integer

Minimum payment amount

amount_to

integer

Maximum payment amount

currency_code

enum<string>

ISO currency code (e.g., USD, EUR)

Available options:

AED,

AFN,

ALL,

AMD,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BTN,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLP,

CNY,

COP,

CRC,

CUC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ERN,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HTG,

HUF,

IDR,

ILS,

IMP,

INR,

IQD,

IRR,

ISK,

JEP,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRU,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SLE,

SOS,

SRD,

SSP,

STD,

STN,

SVC,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

BOV,

COU,

CHE,

CHW,

MXV,

UGX,

VES,

VND,

VUV,

XAF,

XCD,

XCG,

XOF,

XPF,

YER,

USD

from

string

Only payments created on or after this time. Accepts YYYY-MM-DD (from 00:00:00 UTC), YYYY-MM-DD HH:MM[:SS] with a space or T and no time zone (read as UTC), or RFC 3339 with a time zone (2026-10-01T14:30:00Z). Works without to. A value that can't be read is ignored; to still applies.

limit

integer

default:100

Number of items per page

Required range: 1 <= x <= 1000

order

enum<string>

default:desc

Sort order

Available options:

asc,

desc

page

integer

default:1

Page number for paginated results

Required range: x >= 1

payment_status

enum<string>

Filter by payment status

Available options:

PENDING,

FAILED,

AUTHORIZED,

SETTLING,

SETTLED,

DECLINED,

BLOCKED,

CANCELLED

payment_status_in

enum<string>

Available options:

PENDING,

FAILED,

AUTHORIZED,

SETTLING,

SETTLED,

DECLINED,

BLOCKED,

CANCELLED

payment_status_not_in

enum<string>

Available options:

PENDING,

FAILED,

AUTHORIZED,

SETTLING,

SETTLED,

DECLINED,

BLOCKED,

CANCELLED

payment_status_set

string

failure_reason_in

string

Comma-separated list of failure reason messages. Both failure_reason_in and decline_message_in are independent filters applied together: a payment is returned only if it matches both. A payment has a single message, so two different messages used together return no payments; the same message in both returns payments with that message. Previously the two lists were combined as a union.

failure_reason_not_in

string

Comma-separated list of failure reason messages to exclude. Payments carrying any excluded message are removed; payments without a message are kept.

decline_message_in

string

Comma-separated list of decline messages. Both failure_reason_in and decline_message_in are independent filters applied together: a payment is returned only if it matches both. A payment has a single message, so two different messages used together return no payments; the same message in both returns payments with that message. Previously the two lists were combined as a union.

decline_message_not_in

string

Comma-separated list of decline messages to exclude. Payments carrying any excluded message are removed; payments without a message are kept.

string

Keyword to search across fields

snapshot_at

string

Timestamp of the data snapshot

sort

string

default:created_at

Field to sort by

statement_descriptor

string

Statement descriptor filter

string

Only payments created on or before this time. Accepts YYYY-MM-DD (covers that whole UTC day), YYYY-MM-DD HH:MM[:SS] with a space or T and no time zone (read as UTC), or RFC 3339 with a time zone (2026-10-01T14:30:00Z). Works without from. A value that can't be read is ignored; from still applies.

Response

data

object[]

Show child attributes

meta

object

Show child attributes

⌘I

Find payments

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

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

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>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

import requests

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

headers = {
    "X-API-Version": "<x-api-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

<?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 => [
    "Authorization: Bearer <token>",
    "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;
}

{
  "data": [
    {
      "amount": 15000,
      "amount_usd": 15000,
      "avs_check": {
        "result": {
          "postal_code": "pass",
          "street_address": "pass"
        }
      },
      "created_at": "2025-05-25T14:30:00Z",
      "currency_code": "AED",
      "customer": {
        "address": {
          "city": "San Francisco",
          "country": "AD",
          "line1": "123 Market Street",
          "line2": "Suite 400",
          "postal_code": "94105",
          "state": "CA"
        },
        "created_at": "2025-05-28T14:00:00Z",
        "email": "alice.johnson@example.com",
        "external_id": "ext_001",
        "full_name": "Alice Johnson",
        "id": "cus_b8d0fe7e-3a7f-4b5f-a68b-d31358b49c3f",
        "metadata": {
          "key": "value"
        },
        "phone": "+1-555-123-4567",
        "updated_at": "2025-05-28T14:05:00Z"
      },
      "cvc_check": {
        "result": {
          "cvc": "pass"
        }
      },
      "disputes": [
        {
          "disputed_at": "2026-08-01T10:15:00Z",
          "external_id": "dp_1Nx2yZAbCdEfGh",
          "id": "dsp_7c1a2b3c-4d5e-6f70-8a9b-0c1d2e3f4a5b",
          "reason": "FRAUDULENT",
          "stage": "DISPUTE",
          "status": "NEEDS_RESPONSE"
        }
      ],
      "id": "pay_e8a1b2c3-d4f5-6789-abcd-ef0123456789",
      "metadata": {
        "key": "value"
      },
      "payment_details": {
        "arn": "123453",
        "auth_code": "334385",
        "network_payment_id": "119676610486528",
        "processor_transaction_id": "pi_3RgN6TJVVBuowJOx0B4fpGWi"
      },
      "payment_method": {
        "details": {
          "bin": "411111",
          "bin_data": {
            "brand": "visa",
            "country": "AD",
            "currency_code": "<string>",
            "description": "Chase Sapphire Preferred",
            "funding": "debit",
            "issuer": "Chase Bank",
            "type": "consumer"
          },
          "exp_month": 12,
          "exp_year": 2028,
          "is_network_tokenized": true,
          "last4": "1111",
          "network_token": {
            "bin": "48953700",
            "last4": "0370",
            "exp_month": 5,
            "exp_year": 31,
            "status": "active",
            "last_synced_at": "2025-05-26T10:15:00Z"
          },
          "number": "4111111111111111"
        },
        "type": "CARD",
        "billing_address": {
          "city": "San Francisco",
          "country": "AD",
          "line1": "123 Market Street",
          "line2": "Suite 400",
          "postal_code": "94105",
          "state": "CA"
        },
        "card_updater": true,
        "fpan_out_of_sync": false,
        "status": "active"
      },
      "payment_status": "PENDING",
      "payment_token_type": "CARD_PAN",
      "payment_type": "MIT",
      "processor": {
        "description": "Stripe US",
        "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
        "processor_merchant_id": "12345678",
        "type": "STRIPE"
      },
      "refund": {
        "amount": 123,
        "amount_usd": 123,
        "created_at": "<string>",
        "processor_transaction_id": "<string>",
        "status": "PENDING",
        "updated_at": "<string>"
      },
      "refunded_amount": 0,
      "refund_reason": "fraud_prevention",
      "statement_descriptor": "MY COMPANY",
      "status_reason": {
        "status": "declined",
        "status_reason": {
          "advice_code": "do_not_try_again",
          "decline_code": "insufficient_funds",
          "message": "<string>"
        }
      },
      "subscription": {
        "created_at": "2025-05-26T10:00:00Z",
        "current_period_end": "<string>",
        "cancelled_at": "2026-06-10T14:32:08Z",
        "cancellation_details": {
          "reason": "fraud_prevention",
          "trigger_payment_id": "pay_e8a1b2c3-1d2e-3f4a-5b6c-7d8e9f0a1b2c"
        },
        "current_period_start": "<string>",
        "id": "sub_123e4567-e89b-12d3-a456-426614174000",
        "metadata": {
          "key": "value"
        },
        "next_billing_date": "2025-06-26T12:00:00Z",
        "past_due": {
          "attempt_count": 2,
          "max_attempts_count": 7
        },
        "plan": {
          "id": "price_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
          "interval": "days",
          "interval_count": 1,
          "name": "Pro Plan",
          "price": {
            "amount": 1999,
            "currency": "AED"
          },
          "tax": {
            "collect_tax": "<unknown>"
          },
          "trial_interval": "days",
          "trial_interval_count": 14,
          "trial_price": {
            "amount": 1999,
            "currency": "AED"
          },
          "type": "recurring"
        },
        "status": "trial",
        "updated_at": "2025-05-27T10:00:00Z"
      },
      "tax": {
        "amount_subtotal": 123,
        "amount_subtotal_usd": 123,
        "amount_tax": 123,
        "amount_tax_usd": 123,
        "behavior": "<unknown>",
        "calculation_id": "<string>",
        "error": {
          "code": "<unknown>",
          "message": "<string>"
        },
        "provider": {
          "id": "<string>",
          "type": "NUMERAL"
        },
        "status": "<unknown>",
        "transaction_id": "<string>"
      },
      "three_d_secure": {
        "authentication_flow": "<string>",
        "electronic_commerce_indicator": {
          "liability_shift": true,
          "result": "<string>",
          "value": "<string>"
        },
        "status": "action-required",
        "status_reason": "<string>",
        "transaction_id": "<string>",
        "version": "<string>"
      },
      "updated_at": "2025-05-26T10:15:00Z"
    }
  ],
  "meta": {
    "limit": 100,
    "page": 1,
    "pages": 1,
    "snapshot_at": "2026-01-01T00:00:00Z",
    "total": 1
  }
}

{
  "error": {
    "message": "some error message"
  }
}

{
  "error": {
    "message": "some error message"
  }
}

{
  "error": {
    "message": "some error message"
  }
}

Introduction

API Reference

Find payments

Authorizations

Headers

Query Parameters

Response