Tokenize a Card Temporarily.
POST/temporaryPaymentTokens
Creates a temporary card token for the duration of the session.
Request
- application/json
Body
required
Processing entityId
provided by Nuvei.
paymentOption
object
required
card
object
required
Possible values: <= 70 characters
The cardholder name.
Possible values: non-empty
and <= 20 characters
The full credit card number.
Possible values: >= 2 characters
and <= 2 characters
, Value must match regular expression ^(0[1-9]|1[0-2])$
The card expiration month.
Possible values: >= 2 characters
and <= 4 characters
, Value must match regular expression ^(\d{4}|\d{2})$
The card expiration year.
Possible values: <= 4 characters
The CVV/CVC security code.
Responses
- 200
- 400
- 401
- 403
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
temporaryPaymentToken
object
paymentOption
object
required
card
object
Possible values: <= 70 characters
The cardholder name.
Possible values: <= 20 characters
The masked credit card number.
Possible values: <= 8 characters
The first six or eight digits from the credit card number for identifying the processing bank. The rest of the number is not displayed.
Possible values: >= 2 characters
and <= 2 characters
, Value must match regular expression ^(0[1-9]|1[0-2])$
The card expiration month.
Possible values: >= 2 characters
and <= 4 characters
, Value must match regular expression ^(\d{4}|\d{2})$
The card expiration year.
Possible values: [Credit
, Debit
]
The type of card used in the transaction.
Possible values: [VISA
, MASTERCARD
, AMEX
, DINERS
]
The card brand used in the transaction.
Indicates if the card is prepaid or not.
Possible values: >= 2 characters
and <= 2 characters
result
object
required
Possible values: [success
, error
]
errors
object
Possible values: <= 11 characters
If an error occurred on the request side, an error code is returned in this parameter.
Possible values: <= 400 characters
If an error occurred on the request side, then an error reason is returned in this parameter.
{
"temporaryPaymentToken": {
"paymentTokenId": "1eaf1356-a9a2-4a16-a0c1-290ba2265257",
"paymentOption": {
"card": {
"cardHolderName": "Jada Pinkett",
"maskedCardNumber": "5***6597",
"bin": "546221",
"expirationMonth": "06",
"expirationYear": "2022",
"cardType": "Credit",
"cardBrand": "VISA",
"cardProduct": "string",
"cardProgram": "string",
"cardProductType": "string",
"isPrepaid": true,
"issuingCountry": "DE",
"isVirtual": true,
"isDynamicCurrencyConversionSupported": true
}
}
},
"result": {
"status": "success",
"errors": {
"code": "7000.1000",
"reason": "Unexpected error"
}
}
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
temporaryPaymentToken
object
paymentOption
object
required
card
object
Possible values: <= 70 characters
The cardholder name.
Possible values: <= 20 characters
The masked credit card number.
Possible values: <= 8 characters
The first six or eight digits from the credit card number for identifying the processing bank. The rest of the number is not displayed.
Possible values: >= 2 characters
and <= 2 characters
, Value must match regular expression ^(0[1-9]|1[0-2])$
The card expiration month.
Possible values: >= 2 characters
and <= 4 characters
, Value must match regular expression ^(\d{4}|\d{2})$
The card expiration year.
Possible values: [Credit
, Debit
]
The type of card used in the transaction.
Possible values: [VISA
, MASTERCARD
, AMEX
, DINERS
]
The card brand used in the transaction.
Indicates if the card is prepaid or not.
Possible values: >= 2 characters
and <= 2 characters
result
object
required
Possible values: [success
, error
]
errors
object
Possible values: <= 11 characters
If an error occurred on the request side, an error code is returned in this parameter.
Possible values: <= 400 characters
If an error occurred on the request side, then an error reason is returned in this parameter.
{
"temporaryPaymentToken": {
"paymentTokenId": "1eaf1356-a9a2-4a16-a0c1-290ba2265257",
"paymentOption": {
"card": {
"cardHolderName": "Jada Pinkett",
"maskedCardNumber": "5***6597",
"bin": "546221",
"expirationMonth": "06",
"expirationYear": "2022",
"cardType": "Credit",
"cardBrand": "VISA",
"cardProduct": "string",
"cardProgram": "string",
"cardProductType": "string",
"isPrepaid": true,
"issuingCountry": "DE",
"isVirtual": true,
"isDynamicCurrencyConversionSupported": true
}
}
},
"result": {
"status": "success",
"errors": {
"code": "7000.1000",
"reason": "Unexpected error"
}
}
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
temporaryPaymentToken
object
paymentOption
object
required
card
object
Possible values: <= 70 characters
The cardholder name.
Possible values: <= 20 characters
The masked credit card number.
Possible values: <= 8 characters
The first six or eight digits from the credit card number for identifying the processing bank. The rest of the number is not displayed.
Possible values: >= 2 characters
and <= 2 characters
, Value must match regular expression ^(0[1-9]|1[0-2])$
The card expiration month.
Possible values: >= 2 characters
and <= 4 characters
, Value must match regular expression ^(\d{4}|\d{2})$
The card expiration year.
Possible values: [Credit
, Debit
]
The type of card used in the transaction.
Possible values: [VISA
, MASTERCARD
, AMEX
, DINERS
]
The card brand used in the transaction.
Indicates if the card is prepaid or not.
Possible values: >= 2 characters
and <= 2 characters
result
object
required
Possible values: [success
, error
]
errors
object
Possible values: <= 11 characters
If an error occurred on the request side, an error code is returned in this parameter.
Possible values: <= 400 characters
If an error occurred on the request side, then an error reason is returned in this parameter.
{
"temporaryPaymentToken": {
"paymentTokenId": "1eaf1356-a9a2-4a16-a0c1-290ba2265257",
"paymentOption": {
"card": {
"cardHolderName": "Jada Pinkett",
"maskedCardNumber": "5***6597",
"bin": "546221",
"expirationMonth": "06",
"expirationYear": "2022",
"cardType": "Credit",
"cardBrand": "VISA",
"cardProduct": "string",
"cardProgram": "string",
"cardProductType": "string",
"isPrepaid": true,
"issuingCountry": "DE",
"isVirtual": true,
"isDynamicCurrencyConversionSupported": true
}
}
},
"result": {
"status": "success",
"errors": {
"code": "7000.1000",
"reason": "Unexpected error"
}
}
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
temporaryPaymentToken
object
paymentOption
object
required
card
object
Possible values: <= 70 characters
The cardholder name.
Possible values: <= 20 characters
The masked credit card number.
Possible values: <= 8 characters
The first six or eight digits from the credit card number for identifying the processing bank. The rest of the number is not displayed.
Possible values: >= 2 characters
and <= 2 characters
, Value must match regular expression ^(0[1-9]|1[0-2])$
The card expiration month.
Possible values: >= 2 characters
and <= 4 characters
, Value must match regular expression ^(\d{4}|\d{2})$
The card expiration year.
Possible values: [Credit
, Debit
]
The type of card used in the transaction.
Possible values: [VISA
, MASTERCARD
, AMEX
, DINERS
]
The card brand used in the transaction.
Indicates if the card is prepaid or not.
Possible values: >= 2 characters
and <= 2 characters
result
object
required
Possible values: [success
, error
]
errors
object
Possible values: <= 11 characters
If an error occurred on the request side, an error code is returned in this parameter.
Possible values: <= 400 characters
If an error occurred on the request side, then an error reason is returned in this parameter.
{
"temporaryPaymentToken": {
"paymentTokenId": "1eaf1356-a9a2-4a16-a0c1-290ba2265257",
"paymentOption": {
"card": {
"cardHolderName": "Jada Pinkett",
"maskedCardNumber": "5***6597",
"bin": "546221",
"expirationMonth": "06",
"expirationYear": "2022",
"cardType": "Credit",
"cardBrand": "VISA",
"cardProduct": "string",
"cardProgram": "string",
"cardProductType": "string",
"isPrepaid": true,
"issuingCountry": "DE",
"isVirtual": true,
"isDynamicCurrencyConversionSupported": true
}
}
},
"result": {
"status": "success",
"errors": {
"code": "7000.1000",
"reason": "Unexpected error"
}
}
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
temporaryPaymentToken
object
paymentOption
object
required
card
object
Possible values: <= 70 characters
The cardholder name.
Possible values: <= 20 characters
The masked credit card number.
Possible values: <= 8 characters
The first six or eight digits from the credit card number for identifying the processing bank. The rest of the number is not displayed.
Possible values: >= 2 characters
and <= 2 characters
, Value must match regular expression ^(0[1-9]|1[0-2])$
The card expiration month.
Possible values: >= 2 characters
and <= 4 characters
, Value must match regular expression ^(\d{4}|\d{2})$
The card expiration year.
Possible values: [Credit
, Debit
]
The type of card used in the transaction.
Possible values: [VISA
, MASTERCARD
, AMEX
, DINERS
]
The card brand used in the transaction.
Indicates if the card is prepaid or not.
Possible values: >= 2 characters
and <= 2 characters
result
object
required
Possible values: [success
, error
]
errors
object
Possible values: <= 11 characters
If an error occurred on the request side, an error code is returned in this parameter.
Possible values: <= 400 characters
If an error occurred on the request side, then an error reason is returned in this parameter.
{
"temporaryPaymentToken": {
"paymentTokenId": "1eaf1356-a9a2-4a16-a0c1-290ba2265257",
"paymentOption": {
"card": {
"cardHolderName": "Jada Pinkett",
"maskedCardNumber": "5***6597",
"bin": "546221",
"expirationMonth": "06",
"expirationYear": "2022",
"cardType": "Credit",
"cardBrand": "VISA",
"cardProduct": "string",
"cardProgram": "string",
"cardProductType": "string",
"isPrepaid": true,
"issuingCountry": "DE",
"isVirtual": true,
"isDynamicCurrencyConversionSupported": true
}
}
},
"result": {
"status": "success",
"errors": {
"code": "7000.1000",
"reason": "Unexpected error"
}
}
}