Skip to main content
GET
/
v1
/
checkouts
Listar checkouts
curl --request GET \
  --url https://api.troqpay.com/v1/checkouts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "chk_01HR7P8Z5N7A8Q2P8Y7F2D8Q6J",
      "livemode": false,
      "status": "PENDING",
      "amount": 12990,
      "currency": "BRL",
      "createdAt": "2023-11-07T05:31:56Z",
      "expiresAt": "2023-11-07T05:31:56Z",
      "pix": {
        "copyPaste": "00020101021226840014br.gov.bcb.pix...",
        "qrCodeUrl": "https://api.troqpay.com/qrcode/chk_01HR7P8Z5N7A8Q2P8Y7F2D8Q6J.png"
      },
      "settlement": {
        "currency": "USDT",
        "status": "PENDING",
        "amount": "24.560000"
      },
      "description": "Plano Pro",
      "externalId": "order_1001",
      "checkoutUrl": "https://pay.troqpay.com/c/chk_01HR7P8Z5N7A8Q2P8Y7F2D8Q6J",
      "paidAt": "2023-11-07T05:31:56Z",
      "customer": {
        "name": "Maria Santos",
        "email": "maria@example.com",
        "document": "12345678909"
      },
      "metadata": {}
    }
  ],
  "nextCursor": null
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

status
enum<string>
Available options:
PENDING,
PAID,
EXPIRED,
CANCELLED
externalId
string
limit
integer
default:20
Required range: 1 <= x <= 100
cursor
string

Response

Lista de checkouts.

data
object[]
required
nextCursor
string | null
Example:

null