APIPay Out endpointsCards

Create ghost card

View as MarkdownOpen in Claude

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.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

entrystringRequired

The entity’s entrypoint identifier. Learn more

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.

expirationDatestringOptional
Requested expiration date for the card. If not provided, defaults to 30 days from creation.
amountdoubleOptional

Initial load amount for the card. Defaults to 0.

maxNumberOfUsesintegerOptional

Maximum number of times the card can be used. If 0 or negative, defaults to 9999. Ignored and set to 1 when exactAmount is true.

exactAmountbooleanOptional

When true, restricts the card to a single use. maxNumberOfUses is automatically set to 1 regardless of any other value provided.

expenseLimitPeriodstringOptional

Time period over which expenseLimit applies (for example, monthly or weekly). No server-side enforcement.

billingCyclestringOptional
Billing cycle identifier.
billingCycleDaystringOptional
Day within the billing cycle.
dailyTransactionCountintegerOptional

Maximum number of transactions allowed per day. Defaults to 0 (unlimited).

dailyAmountLimitdoubleOptional

Maximum total spend allowed per day. Defaults to 0 (unlimited).

transactionAmountLimitintegerOptional

Maximum spend allowed per single transaction. Defaults to 0 (unlimited).

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.

responseDataobject

Errors

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