Get virtual card details

View as MarkdownOpen in Claude
Retrieves vCard details for a single card in an entrypoint.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

cardTokenstringRequired
ID for a virtual card.

Response

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

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
The unique identifier for the paypoint.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error