Skip to main content
POST
/
v1
/
cards
Create Virtual Card
curl --request POST \
  --url https://qa-lynx.nayax.com/operational/v1/cards \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ActorID": 123,
  "CardUniqueIdentifier": "<string>",
  "CardDisplayNumber": "<string>",
  "CardHolderName": "<string>",
  "CardStatus": 1,
  "CardType": 31,
  "CardUserIdentity": "<string>",
  "CountryID": 123,
  "Currency": 123,
  "MobileNumber": "<string>",
  "Email": "<string>",
  "CardPhysicalType": 123,
  "MemberType": 123,
  "CardActivationDate": "2023-11-07T05:31:56Z",
  "CardExpirationDate": "2023-11-07T05:31:56Z",
  "CardImageUrl": "<string>",
  "CardNote": "<string>",
  "wd_limits_money": "<string>",
  "wd_limits_trans": "<string>",
  "use_wd_limit": true
}
'
{
  "MobileNumber": "<string>",
  "CardID": 123,
  "ActorID": 123,
  "CardUniqueIdentifier": "<string>",
  "CardDisplayNumber": "<string>",
  "CardHolderName": "<string>",
  "CardStatus": 123,
  "CardType": 123,
  "CardUserIdentity": "<string>",
  "UpdatedDt": "2023-11-07T05:31:56Z",
  "CreatedDt": "2023-11-07T05:31:56Z",
  "CreatedBy": 123,
  "UpdatedBy": 123,
  "CountryID": 123,
  "Email": "<string>",
  "CardPhysicalType": 123,
  "MemberType": 123,
  "CardActivationDate": "2023-11-07T05:31:56Z",
  "CardExpirationDate": "2023-11-07T05:31:56Z",
  "CardImageUrl": "<string>",
  "CardNote": "<string>",
  "wd_limits_money": "<string>",
  "wd_limits_trans": "<string>",
  "use_wd_limit": true,
  "CardExternalApplicationUserID": "<string>",
  "Refs": {}
}

Authorizations

​
Authorization
string
header
required

Enter your API key. It's required to authenticate API requests.

Body

application/json

The details of the card to be created.

Represents the details required to create or update a card associated with an actor, including card attributes and contact information.

​
ActorID
integer<int64> | null

The unique identifier of the actor associated with the card.

​
CardUniqueIdentifier
string | null

The unique identifier assigned to the card.

​
CardDisplayNumber
string | null

The display number of the card.

​
CardHolderName
string | null

The name of the cardholder.

​
CardStatus
enum<integer> | null

The current status of the card.

Available options:
1,
2
​
CardType
enum<integer> | null

The type identifier of the card.

Available options:
31,
33,
34,
30000616
​
CardUserIdentity
string | null

The unique identity or user ID associated with the card.

​
CountryID
integer<int32> | null

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

​
Currency
integer<int32> | null

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

​
MobileNumber
string | null

The mobile number associated with the card.

​
Email
string | null

The email address associated with the card.

​
CardPhysicalType
integer<int32> | null

The physical type identifier of the card.

​
MemberType
integer<int32> | null

The membership type identifier associated with the card.

​
CardActivationDate
string<date-time> | null

The date and time when the card becomes active.

​
CardExpirationDate
string<date-time> | null

The date and time when the card expires.

​
CardImageUrl
string | null

The URL of the image associated with the card.

​
CardNote
string | null

Any additional notes associated with the card.

​
wd_limits_money
string | null

The monetary limits applied to the card on specific weekdays.

​
wd_limits_trans
string | null

The transaction limits applied to the card on specific weekdays.

​
use_wd_limit
boolean | null

Indicates whether the weekday limits are enabled for the card.

Response

200 - application/json

The virtual card was created successfully.

Represents the details of a card, including its attributes, status, and associated actor information.

​
MobileNumber
string | null

The mobile number associated with the card.

​
CardID
integer<int64> | null

The unique identifier of the card.

​
ActorID
integer<int64> | null

The unique identifier of the actor associated with the card.

​
CardUniqueIdentifier
string | null

The unique identifier assigned to the card.

​
CardDisplayNumber
string | null

The display number of the card.

​
CardHolderName
string | null

The name of the cardholder.

​
CardStatus
integer<int32> | null

The current status of the card.

​
CardType
integer<int32> | null

The type identifier of the card.

​
CardUserIdentity
string | null

The unique identity or user ID associated with the card.

​
UpdatedDt
string<date-time> | null

The date and time when the card was last updated.

​
CreatedDt
string<date-time> | null

The date and time when the card was created.

​
CreatedBy
integer<int64> | null

The identifier of the user who created the card.

​
UpdatedBy
integer<int64> | null

The identifier of the user who last updated the card.

​
CountryID
integer<int32> | null

The identifier of the country associated with the card.

​
Email
string | null

The email address associated with the card.

​
CardPhysicalType
integer<int32> | null

The physical type identifier of the card.

​
MemberType
integer<int32> | null

The membership type identifier associated with the card.

​
CardActivationDate
string<date-time> | null

The date and time when the card becomes active.

​
CardExpirationDate
string<date-time> | null

The date and time when the card expires.

​
CardImageUrl
string | null

The URL of the image associated with the card.

​
CardNote
string | null

Any additional notes associated with the card.

​
wd_limits_money
string | null

The monetary limits applied to the card on specific weekdays.

​
wd_limits_trans
string | null

The transaction limits applied to the card on specific weekdays.

​
use_wd_limit
boolean | null

Indicates whether the weekday limits are enabled for the card.

​
CardExternalApplicationUserID
string | null

The external application user ID associated with the card.

​
Refs
object

Additional references or metadata associated with the card.