ghostCard

Create ghost card

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.

post/MoneyOutCard/GhostCard/{entry}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/MoneyOutCard/GhostCard/{entry}
  • Auth: HTTP bearer

Path parameters

entrystring required

The entity's entrypoint identifier. Learn more.

The entity's entrypoint identifier. Learn more

Request body

vendorIdinteger required

ID of the vendor who receives the card. The vendor must belong to the paypoint and have an active status.

expenseLimitnumber double required

Spending limit for the card. Must be greater than 0 and can't exceed the paypoint's configured payout credit limit.

expirationDatestring

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

amountnumber double required

Initial load amount for the card.

maxNumberOfUsesinteger required

Maximum number of times the card can be used. Ignored and set to 1 when exactAmount is true.

exactAmountboolean required

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

expenseLimitPeriodstring required

Time period over which expenseLimit applies (for example, monthly or weekly).

billingCyclestring required

Billing cycle identifier.

billingCycleDaystring required

Day within the billing cycle.

dailyTransactionCountinteger required

Maximum number of transactions allowed per day.

dailyAmountLimitnumber double required

Maximum total spend allowed per day.

transactionAmountLimitinteger required

Maximum spend allowed per single transaction.

mccstring

Merchant Category Code to restrict where the card can be used. Must be a valid MCC if provided.

tccstring

Transaction Category Code to restrict where the card can be used. Must be a valid TCC if provided.

misc1string

Custom metadata field. Stored on the card record.

misc2string

Custom metadata field. Stored on the card record.

Response

Success response with ghost card details.

isSuccessboolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

responseTextstring required

Response text for operation: 'Success' or 'Declined'.

Changes

No recorded changes to this operation across all 1 revision of this API.