Creates a ghost card, a multi-use virtual debit card issued to a vendor for recurring or discretionary spend.
Unlike single-use virtual cards issued as part of a payout transaction, ghost cards aren't tied to a specific payout. They're issued directly to a vendor and can be reused up to a configurable number of times within the card's spending limits.
Only one ghost card can exist per vendor per paypoint. To issue a new card to the same vendor, cancel the existing card first.
Request
This endpoint expects an object.
vendorIdlongRequired
ID of the vendor who receives the card. The vendor must belong to the paypoint and have an active status.
expenseLimitdoubleRequired
Spending limit for the card. Must be greater than 0 and can’t exceed the paypoint’s configured payout credit limit.
amountdoubleRequired
Initial load amount for the card.
maxNumberOfUsesintegerRequired
Maximum number of times the card can be used. Ignored and set to 1 when exactAmount is true.
exactAmountbooleanRequired
When true, restricts the card to a single use. maxNumberOfUses is automatically set to 1 regardless of any other value provided.
expenseLimitPeriodstringRequired
Time period over which expenseLimit applies (for example, monthly or weekly).
billingCyclestringRequired
Billing cycle identifier.
billingCycleDaystringRequired
Day within the billing cycle.
dailyTransactionCountintegerRequired
Maximum number of transactions allowed per day.
dailyAmountLimitdoubleRequired
Maximum total spend allowed per day.
transactionAmountLimitintegerRequired
Maximum spend allowed per single transaction.
expirationDatestringOptional
Requested expiration date for the card. If not provided, defaults to 30 days from creation.
mccstringOptional
Merchant Category Code to restrict where the card can be used. Must be a valid MCC if provided.
tccstringOptional
Transaction Category Code to restrict where the card can be used. Must be a valid TCC if provided.
misc1stringOptional
Custom metadata field. Stored on the card record.
misc2stringOptional
Custom metadata field. Stored on the card record.
Response
Success response with ghost card details.
responseTextstring
Response text for operation: ‘Success’ or ‘Declined’.
isSuccessboolean
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.