Skip to main content
GET
/
payments
Error
A valid request URL is required to generate request examples
{
  "items": [
    {
      "paymentId": "a4da2b04-aa79-4b40-8987-048d6caf118f",
      "status": "PAID",
      "amount": 29,
      "currency": "USD",
      "createdAt": "2024-01-15T10:00:00Z",
      "updatedAt": "2024-01-15T10:00:00Z",
      "paymentProfileId": "c014b666-22e4-430e-bb18-9257a383dfe2",
      "receiptUrl": "https://payments.example.com/receipts/a4da2b04-aa79-4b40-8987-048d6caf118f",
      "metadata": {}
    }
  ],
  "pagination": {
    "total": 123,
    "limit": 123,
    "offset": 123,
    "sort": {
      "key": "<string>",
      "direction": "ASC"
    }
  }
}

Authorizations

​
X-Api-Key
string
header
required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Query Parameters

​
limit
integer
default:100

The maximum number of items to return.

Required range: 1 <= x <= 1000
​
offset
integer
default:0

The number of items to skip before starting to collect the result set.

Required range: x >= 0
​
customerId
string[]

Filter payments by customer IDs

​
status
enum<string>[]

Filter payments by status

Current status of a payment in its lifecycle.

Available options:
PENDING,
PAID,
FAILED,
REFUNDED,
CANCELED
​
fromDate
string<date>

Filter payments created from this date

​
toDate
string<date>

Filter payments created up to this date

Response

Payments retrieved successfully

​
items
object[]
required
​
pagination
object