Retrieve a purchase

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

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 (*).

Path parameters

id

Required. AtomicPay purchase ID.

GET/v1/purchases/:id

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

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

Request examples

curl

curl "https://api.atomicpay.com.br/v1/purchases/purchase_123" \
  -H "Authorization: Bearer {{api_key}}"

request.js

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

const data = await response.json();

Response

response.json

{
  "id": "purchase_123",
  "object": "purchase",
  "status": "approved",
  "status_description": null,
  "amount": 1000,
  "currency": "BRL",
  "payment_method": "pix",
  "installments": 1,
  "customer": { "id": "cus_123", "name": "Jenny Rosen", "email": "jenny@example.com" },
  "product": { "id": "prod_123", "name": "Starter" },
  "offer": { "code": "offer_123", "name": "Monthly", "period": "monthly" },
  "subscription_id": null,
  "created_at": 1766400000000,
  "status_date": 1766400000000
}

List purchases

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

List customers

Return customers visible to the authenticated account or product-scoped key.