API Reference

API Reference

Payments

Read the status and context of BOB payment intents. Money movement stays governed inside BOB.

GETRequires a Bearer token/api/ext/v1/payment-intents/{intentId}

Get a payment intent

Parameters

NameInTypeDescription
intentIdrequiredpathstringThe payment intent's id (from a payment.* event).

Responses

200The payment intent's status and context. Curated: the destination account/wallet, internal ids, rail, and fee cap are never included; amount is in integer cents.
FieldTypeDescription
amount_centsrequiredint64Amount, in cents.
created_atrequiredstring · date-timeWhen the intent was created.
currencyrequiredstringISO currency code.
destination_typerequiredstringHow the payee is referenced (never the destination itself).
idrequiredstringThe payment intent id.
latest_settlement_byoptionalstring · date-timeLatest expected settlement time. Null if not applicable.
statusrequiredstringcompleted, failed, held, canceled, or in-flight.
updated_atrequiredstring · date-timeWhen the intent was last updated.
200 example
{
  "amount_cents": 42000,
  "created_at": "2026-01-15T09:30:00Z",
  "currency": "USD",
  "destination_type": "counterparty_us_bank_account",
  "id": "pi_3Nk2Ht7Qz",
  "latest_settlement_by": "2026-01-15T09:30:00Z",
  "status": "completed",
  "updated_at": "2026-01-15T09:30:00Z"
}

Errors

401Missing or invalid API token
403Token lacks the required scope or credential class
404No such payment intent in your organization
429Rate limit exceeded

All errors return { "error": string }.

Example request

curl https://api.bankofbots.ai/api/ext/v1/payment-intents/{intentId} \
  -H "Authorization: Bearer $BOB_API_TOKEN"
Was this page helpful?