List Payments

List payments.

Scopes: payments:read

string uuid4

The organization ID.

OR

string[]

Example:1dbfc517-0bbf-4301-9ba8-555ca42b9737

Filter by organization ID.

string uuid4

OR

string[]

Filter by checkout ID.

string uuid4

OR

string[]

Filter by order ID.

string uuid4

The customer ID.

OR

string[]

Filter by customer ID.

'pending' | 'succeeded' | 'failed'

OR

PaymentStatus[]

Filter by payment status.

string

OR

string[]

Filter by payment method.

string

OR

string[]

Filter by customer email.

pageinteger

Page number, defaults to 1.

limitinteger

Size of a page, defaults to 10. Maximum is 100.

sortingPaymentSortProperty[] nullable

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

Response

Successful Response

Example response

{
  "items": [
    {
      "amount": 1000,
      "currency": "usd",
      "method": "card",
      "decline_reason": "insufficient_funds",
      "decline_message": "Your card has insufficient funds.",
      "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
      "checkout_id": "e4b478fa-cd25-4253-9f1f-8a41e6370ede",
      "order_id": "e4b478fa-cd25-4253-9f1f-8a41e6370ede",
      "method_metadata": {
        "brand": "visa",
        "last4": "4242"
      }
    }
  ]
}

List Payments

Query parameters

Response

Example response

Changes