Skip to main content
GET
/
v2
/
payment-orders
List all payment orders
curl --request GET \
  --url http://localhost:3156/v2/payment-orders \
  --header 'x-api-key: <api-key>' \
  --header 'x-merchant-id: <api-key>'
{
  "data": [
    {
      "externalId": "ORDER-123",
      "amount": 100.5,
      "currency": "USD",
      "status": "PENDING",
      "payments": [
        {
          "id": "856b4a29-a7e5-4726-87d4-77e55d5ecfbf",
          "status": "PENDING_CAPTURE",
          "paymentMethodType": "SPEI",
          "amount": "200.99",
          "refundedAmount": "0.00",
          "paymentMethodId": "<string>",
          "createdAt": "2025-05-19T18:14:32.424Z",
          "updatedAt": "2025-05-19T18:14:32.523Z"
        }
      ],
      "orderNumber": "C25123101",
      "description": "Payment for order #123",
      "billingAddressLine": "123 Main St",
      "billingCity": "New York",
      "billingState": "NY",
      "billingPostalCode": "10001",
      "billingCountry": "US",
      "customer": {
        "externalId": "CUST-123",
        "firstName": "John",
        "lastName": "Doe",
        "email": "[email protected]",
        "phoneNumber": "+1234567890",
        "active": true,
        "createdAt": "2024-03-20T10:00:00Z",
        "updatedAt": "2024-03-20T10:00:00Z"
      },
      "createdAt": "2024-03-20T10:00:00Z",
      "updatedAt": "2024-03-20T10:00:00Z",
      "paymentMethod": {
        "type": "card",
        "options": {
          "card": {
            "number": "4111111111111111",
            "expiryMonth": "12",
            "expiryYear": "2025",
            "cvc": "123"
          },
          "spei": {
            "clabe": "123456789012345678"
          }
        }
      }
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "count": 123,
    "totalPages": 123
  }
}

Authorizations

x-api-key
string
header
required

API key for authentication (required)

x-merchant-id
string
header
required

Merchant ID for identifying the merchant (required)

Query Parameters

customerId
string
required

Customer ID to filter payment orders

Minimum string length: 1
page
integer
default:1

Page number

Required range: x >= 1
limit
integer
default:20

Number of orders to return per page (max 100)

Required range: 1 <= x <= 100

Response

Payment orders retrieved successfully

data
object[]
required
pagination
object
required