v1

latestOpenAPI 3.0.12026-07-26181265484.9 KB
Cards

Create Virtual Card

Creates a new virtual card with the provided details.

post/v1/cards

Request body

ActorIDinteger nullable

The unique identifier of the actor associated with the card.

CardUniqueIdentifierstring nullable

The unique identifier assigned to the card.

CardDisplayNumberstring nullable

The display number of the card.

CardHolderNamestring nullable

The name of the cardholder.

{"stackTrail":"components:schemas:ActiveInactiveEnum","oasType":"schema","type":"unknown","extensionFields":{"x-enumDescriptions":{"1":"Active","2":"Inactive"}}}
CardType31 | 33 | 34 | 30000616 nullable

The type identifier of the card.

CardUserIdentitystring nullable

The unique identity or user ID associated with the card.

CountryIDinteger nullable

The identifier of the country associated with the card. Use the Get Countries endpoint for a full list of available countries.

Currencyinteger nullable

The currency identifier used for the card. Use the Get Currencies endpoint for a full list of available currencies.

MobileNumberstring nullable

The mobile number associated with the card.

Emailstring nullable

The email address associated with the card.

CardPhysicalTypeinteger nullable

The physical type identifier of the card.

MemberTypeinteger nullable

The membership type identifier associated with the card.

CardActivationDatestring date-time nullable

The date and time when the card becomes active.

CardExpirationDatestring date-time nullable

The date and time when the card expires.

CardImageUrlstring nullable

The URL of the image associated with the card.

CardNotestring nullable

Any additional notes associated with the card.

wd_limits_moneystring nullable

The monetary limits applied to the card on specific weekdays.

wd_limits_transstring nullable

The transaction limits applied to the card on specific weekdays.

use_wd_limitboolean nullable

Indicates whether the weekday limits are enabled for the card.

Response

The virtual card was created successfully.

MobileNumberstring nullable

The mobile number associated with the card.

CardIDinteger nullable

The unique identifier of the card.

ActorIDinteger nullable

The unique identifier of the actor associated with the card.

CardUniqueIdentifierstring nullable

The unique identifier assigned to the card.

CardDisplayNumberstring nullable

The display number of the card.

CardHolderNamestring nullable

The name of the cardholder.

CardStatusinteger nullable

The current status of the card.

CardTypeinteger nullable

The type identifier of the card.

CardUserIdentitystring nullable

The unique identity or user ID associated with the card.

UpdatedDtstring date-time nullable

The date and time when the card was last updated.

CreatedDtstring date-time nullable

The date and time when the card was created.

CreatedByinteger nullable

The identifier of the user who created the card.

UpdatedByinteger nullable

The identifier of the user who last updated the card.

CountryIDinteger nullable

The identifier of the country associated with the card.

Emailstring nullable

The email address associated with the card.

CardPhysicalTypeinteger nullable

The physical type identifier of the card.

MemberTypeinteger nullable

The membership type identifier associated with the card.

CardActivationDatestring date-time nullable

The date and time when the card becomes active.

CardExpirationDatestring date-time nullable

The date and time when the card expires.

CardImageUrlstring nullable

The URL of the image associated with the card.

CardNotestring nullable

Any additional notes associated with the card.

wd_limits_moneystring nullable

The monetary limits applied to the card on specific weekdays.

wd_limits_transstring nullable

The transaction limits applied to the card on specific weekdays.

use_wd_limitboolean nullable

Indicates whether the weekday limits are enabled for the card.

CardExternalApplicationUserIDstring nullable

The external application user ID associated with the card.

Refsobject nullable

Additional references or metadata associated with the card.