APIPay Out endpointsPayouts

Get virtual card details

Retrieves vCard details for a single card in an entrypoint.

Path parameters

cardTokenstringRequired
ID for a virtual card.

Headers

requestTokenstringRequired

Response

Success
vcardSentboolean or null
Indicates if the virtual card was sent.
cardTokenstring or null
A unique token identifier for the card.
cardNumberstring or null
The masked number of the card.
cvcstring or null
Masked Card Verification Code.
expirationDatestring or null
The expiration date of the card.
statusstring or null
The current status of the card.
amountdouble or null
The initial amount loaded on the card.
currentBalancedouble or null
The current balance available on the card.
expenseLimitdouble or null
The set limit for expenses.
expenseLimitPeriodstring or null
The period for the expense limit.
maxNumberOfUsesinteger or null
Maximum number of uses allowed for the card.
currentNumberOfUsesinteger or null
The current number of times the card has been used.
exactAmountboolean or null
Indicates if only the exact amount is allowed for transactions.
mccstring or null
Merchant Category Code, if applicable.
tccstring or null
Transaction Category Code, if applicable.
misc1string or null
A miscellaneous field for additional information.
misc2string or null
Another miscellaneous field for extra information.
dateCreatedstring or null
The creation date of the record.
dateModifiedstring or null
The last modified date of the record.
associatedVendorobject or null
Information about the associated vendor.
associatedCustomerstring or null
Information about the associated customer, if applicable.
ParentOrgNamestring or null
Name of the parent organization.
PaypointDbanamestring or null
The 'Doing Business As' name of the Paypoint.
PaypointLegalnamestring or null
The legal name of the Paypoint.
PaypointEntrynamestring or null
Entry name for the Paypoint, if applicable.
externalPaypointIDstring or null

A custom identifier for the paypoint, if applicable. Like entrypoint is the Payabli identifier for the merchant, externalPaypointId is a custom field you can use to include the merchant’s ID from your own systems.

paypointIdinteger or null
The unique identifier for the paypoint.

Errors