v1
latestOpenAPI 3.1.02026-08-06142966.9 KBcharges
Get Charge
Get a charge by ID.
get/charges/{charge_id}
Path parameters
charge_idstring uuid required
Headers
X-API-Keystring nullable
Response
Successful Response
org_idstring uuid required
ID of the organization
instrument_idstring uuid nullable
ID of the payment instrument
customer_idstring uuid nullable
ID of the customer
amountnumber required
Charge amount
currency'mxn' | 'cop' | 'brl' | 'usd' | 'eur' | 'gbp'
Currency enum.
referencestring nullable
Reference provided by tenant
inline_instrumentobject nullable
Inline instrument data
inline_customerobject nullable
Inline customer data
idstring uuid required
status'verification_in_progress' | 'pending' | 'processing' | 'confirmed' | 'declined' | 'chargeback' | 'canceled' required
Charge status enum.
declined_reason'insufficient_funds' | 'account_blocked' | 'undetermined' | 'risk_engine' | 'account_does_not_exist' | 'account_canceled' | 'account_in_other_currency' | 'account_not_belongs_to_bank' | 'transaction_duplicated' | 'client_order_declined_pay_to_issuer' | 'client_order_amount_is_more_than_authorized' | 'client_order_canceled' | 'client_service_not_authorized' | 'payment_order_expired' | 'client_rejected_charge'
Declined reason enum.
declined_reason_railstring nullable
created_atstring date-time required
updated_atstring date-time nullable
chargeback_atstring date-time nullable
result_atstring date-time nullable
risk_status'pending' | 'ok' | 'cancelled_by_risk'
Risk evaluation outcome for a charge.
risk_evaluated_atstring date-time nullable
risk_reasonsstring[] nullable