PaybytokenDocs
Payment Intents
API reference · Payment Intents

Retrieve a Payment Intent

Retrieve payment state, activity, token, balance transaction, and refund details.

GET /api/v1/payment_intents/:id

curl https://api-prod.paybytoken.io/api/v1/payment_intents/pay_t24b28nbodnk4icGMyE7 \
  -H "Authorization: Bearer $PAYBYTOKEN_SECRET_KEY"

Path parameter

ParameterTypeDescription
idstringPayment Intent ID.

Response

Returns the PaymentIntent object, plus:

AttributeTypeDescription
tokenobjectCurrent token and network configuration.
balance_transactionobject or nullCredit created when the payment succeeds.
activitiesarrayCreation, receipt, settlement, failure, or cancellation activity.
refundobject or nullLatest refund when one has been requested.
{
  "id": "pay_t24b28nbodnk4icGMyE7",
  "account_id": "acct_1",
  "payer_address": "0x1234...",
  "one_time_address": "0xa1A0340cF7b9326eA4210AB49c17e20e0c32a2FB",
  "chain": "base",
  "currency": "USDC",
  "amount": "15.25",
  "amount_received": "15.25",
  "amount_capturable": "0.0",
  "amount_captured": "15.25",
  "payment_method_types": ["crypto_transfer"],
  "payment_method_type": "crypto_transfer",
  "capture_method": "automatic",
  "description": "Order 123",
  "metadata": { "order_id": "order_123" },
  "customer": null,
  "customer_id": null,
  "customer_email": "customer@example.com",
  "receipt_email": "receipts@example.com",
  "status": "succeeded",
  "tx_hash": "0xabcd...",
  "balance_detected_block": 32600123,
  "error_message": null,
  "token": {
    "currency": "USDC",
    "chain": "base",
    "decimals": 6
  },
  "balance_transaction": {
    "id": "txn_bal_123",
    "amount": "15.25",
    "currency": "USDC",
    "chain": "base",
    "type": "credit",
    "resource_type": "payment_intent",
    "resource_id": "pay_t24b28nbodnk4icGMyE7"
  },
  "activities": [
    {
      "type": "created",
      "datetime": "2026-07-29T10:15:00.000Z"
    },
    {
      "type": "received",
      "amount": "15.25",
      "currency": "USDC",
      "chain": "base",
      "transaction_hash": "0xabcd...",
      "datetime": "2026-07-29T10:18:00.000Z"
    }
  ],
  "expired_at": "2026-07-29T10:30:00.000Z",
  "created_at": "2026-07-29T10:15:00.000Z",
  "updated_at": "2026-07-29T10:18:00.000Z"
}

On this page

API Workbench

Full Explorer

Open in new tab