List purchases

Return purchases owned by the authenticated account or product-scoped API key.

Last updated

Author: AtomicPay API

Authentication

Send your AtomicPay developer API key using Authorization: Bearer <API_KEY> or X-API-Key: <API_KEY>. This endpoint requires purchases.read permission, unless the key has wildcard access (*).

Query parameters

limit

Optional. Number of records to return. Defaults to 20 and is capped at 100.

status

Optional. Filter by purchase status, such as approved, declined, or refunded.

customer_id

Optional. Filter purchases by AtomicPay customer ID.

GET/v1/purchases

Base URL: https://api.atomicpay.com.br

Return purchases owned by the authenticated account or product-scoped API key.

Request examples

curl

curl "https://api.atomicpay.com.br/v1/purchases?limit=20&status=approved" \
  -H "Authorization: Bearer {{api_key}}"

request.js

const response = await fetch('https://api.atomicpay.com.br/v1/purchases?limit=20&status=approved', {
  method: 'GET',
  headers: { Authorization: 'Bearer {{api_key}}' },
});

const data = await response.json();

Response

response.json

{
  "object": "list",
  "data": [
    {
      "id": "purchase_123",
      "object": "purchase",
      "status": "approved",
      "amount": 1000,
      "currency": "BRL",
      "payment_method": "pix",
      "customer": { "id": "cus_123", "name": "Jenny Rosen", "email": "jenny@example.com" },
      "product": { "id": "prod_123", "name": "Starter" },
      "created_at": 1766400000000,
      "status_date": 1766400000000
    }
  ],
  "has_more": false,
  "total_count": 1
}

Authentication, permissions, and errors

How to authenticate requests, understand permissions, rate limits, and handle API errors.

Retrieve a purchase

Retrieve one purchase by ID, scoped to the authenticated account or product.