Skip to main content
GET
Get a payment attempt

Authorizations

Authorization
string
header
required

Tenant API key (vdx_live_…) as Authorization: Bearer.

Path Parameters

id
string<uuid>
required

Response

The attempt.

id
string<uuid>
callId
string
attemptNo
integer

The nth attempt on this call.

status
enum<string>
Available options:
reserved,
collecting,
completed,
failed,
abandoned,
expired,
needs_review
amountMinor
integer

What was charged, in minor units (cents). The balance, or the amount the caller agreed to.

balanceMinor
integer | null

What the call owed when the payment started: the most it could be.

currency
string

ISO 4217, lower case.

result
string | null

Twilio's Result, e.g. success or payment-connector-error.

errorCode
string | null
reference
string | null

The charge reference Twilio reports on success. Never card data.

createdAt
string<date-time>
updatedAt
string<date-time>