Provsion a network token
POST/network-tokens
Provsion a network token via Visa or MDES.
Request
- application/json
Body
required
An object containing payment method details
Processing entityId
provided by Nuvei.
80aef199-b89a-4d59-ba0c-f2cd3c25d5cd
paymentOption
object
required
The full credit card number.
Possible values: non-empty
and <= 20 characters
5113981660016597
The card expiration month.
Possible values: >= 2 characters
and <= 2 characters
, Value must match regular expression ^(0[1-9]|1[0-2])$
06
The card expiration year.
Possible values: >= 2 characters
and <= 4 characters
, Value must match regular expression ^(\d{4}|\d{2})$
2022
The CVV/CVC security code.
Possible values: <= 4 characters
591
Responses
- 201
- 400
- 401
- 403
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
paymentOption
object
networkToken
object
Possible values: <= 29 characters
Possible values: <= 40 characters
Possible values: <= 64 characters
card
object
Possible values: <= 4 characters
Possible values: <= 15 characters
result
object
required
Possible values: [success
, error
]
errors
object
If an error occurred on the request side, an error code is returned in this parameter.
Possible values: <= 11 characters
7000.1000
If an error occurred on the request side, then an error reason is returned in this parameter.
Possible values: <= 400 characters
Unexpected error
{
"paymentOption": {
"networkToken": {
"paymentTokenId": "string",
"tokenNumber": "string",
"expirationYear": "string",
"expirationMonth": "string",
"tokenStatus": "string",
"tokenUniqueReference": "string",
"PaymentAccountReferenc": "string",
"card": {
"last4Digits": "string",
"expirationYear": "string",
"expirationMonth": "string",
"cardUpdated": "string",
"updateReason": "string",
"updateDate": "string"
}
}
},
"tokenRequestorId": "string",
"result": {
"status": "success",
"errors": {
"code": "7000.1000",
"reason": "Unexpected error"
}
}
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Invalid Value
- Missing Mandatory Field Value
Schema
paymentOption
object
networkToken
object
Possible values: <= 29 characters
Possible values: <= 40 characters
Possible values: <= 64 characters
card
object
Possible values: <= 4 characters
Possible values: <= 15 characters
result
object
required
Possible values: [success
, error
]
errors
object
If an error occurred on the request side, an error code is returned in this parameter.
Possible values: <= 11 characters
7000.1000
If an error occurred on the request side, then an error reason is returned in this parameter.
Possible values: <= 400 characters
Unexpected error
{
"paymentOption": {
"networkToken": {
"paymentTokenId": "string",
"tokenNumber": "string",
"expirationYear": "string",
"expirationMonth": "string",
"tokenStatus": "string",
"tokenUniqueReference": "string",
"PaymentAccountReferenc": "string",
"card": {
"last4Digits": "string",
"expirationYear": "string",
"expirationMonth": "string",
"cardUpdated": "string",
"updateReason": "string",
"updateDate": "string"
}
}
},
"tokenRequestorId": "string",
"result": {
"status": "success",
"errors": {
"code": "7000.1000",
"reason": "Unexpected error"
}
}
}
{
"result": {
"status": "error",
"errors": {
"code": "5000.1000",
"reason": "[paymentOption.card.expirationMonth] must match \"^(0[1-9]|1[0-2])$\""
}
}
}
{
"result": {
"status": "error",
"errors": {
"code": "5000.1000",
"reason": "[processingEntityId] must not be null"
}
}
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Authorization Error
Schema
paymentOption
object
networkToken
object
Possible values: <= 29 characters
Possible values: <= 40 characters
Possible values: <= 64 characters
card
object
Possible values: <= 4 characters
Possible values: <= 15 characters
result
object
required
Possible values: [success
, error
]
errors
object
If an error occurred on the request side, an error code is returned in this parameter.
Possible values: <= 11 characters
7000.1000
If an error occurred on the request side, then an error reason is returned in this parameter.
Possible values: <= 400 characters
Unexpected error
{
"paymentOption": {
"networkToken": {
"paymentTokenId": "string",
"tokenNumber": "string",
"expirationYear": "string",
"expirationMonth": "string",
"tokenStatus": "string",
"tokenUniqueReference": "string",
"PaymentAccountReferenc": "string",
"card": {
"last4Digits": "string",
"expirationYear": "string",
"expirationMonth": "string",
"cardUpdated": "string",
"updateReason": "string",
"updateDate": "string"
}
}
},
"tokenRequestorId": "string",
"result": {
"status": "success",
"errors": {
"code": "7000.1000",
"reason": "Unexpected error"
}
}
}
{
"result": {
"status": "error",
"errors": {
"code": "7300.3000",
"reason": "Authorization error."
}
}
}
Forbidden
- application/json
- Schema
- Example (from schema)
- Authorization Error
Schema
paymentOption
object
networkToken
object
Possible values: <= 29 characters
Possible values: <= 40 characters
Possible values: <= 64 characters
card
object
Possible values: <= 4 characters
Possible values: <= 15 characters
result
object
required
Possible values: [success
, error
]
errors
object
If an error occurred on the request side, an error code is returned in this parameter.
Possible values: <= 11 characters
7000.1000
If an error occurred on the request side, then an error reason is returned in this parameter.
Possible values: <= 400 characters
Unexpected error
{
"paymentOption": {
"networkToken": {
"paymentTokenId": "string",
"tokenNumber": "string",
"expirationYear": "string",
"expirationMonth": "string",
"tokenStatus": "string",
"tokenUniqueReference": "string",
"PaymentAccountReferenc": "string",
"card": {
"last4Digits": "string",
"expirationYear": "string",
"expirationMonth": "string",
"cardUpdated": "string",
"updateReason": "string",
"updateDate": "string"
}
}
},
"tokenRequestorId": "string",
"result": {
"status": "success",
"errors": {
"code": "7000.1000",
"reason": "Unexpected error"
}
}
}
Authorization error
{
"result": {
"status": "error",
"errors": {
"code": "7300.3000",
"reason": "Authorization error."
}
}
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
- Internal Processing Error
Schema
paymentOption
object
networkToken
object
Possible values: <= 29 characters
Possible values: <= 40 characters
Possible values: <= 64 characters
card
object
Possible values: <= 4 characters
Possible values: <= 15 characters
result
object
required
Possible values: [success
, error
]
errors
object
If an error occurred on the request side, an error code is returned in this parameter.
Possible values: <= 11 characters
7000.1000
If an error occurred on the request side, then an error reason is returned in this parameter.
Possible values: <= 400 characters
Unexpected error
{
"paymentOption": {
"networkToken": {
"paymentTokenId": "string",
"tokenNumber": "string",
"expirationYear": "string",
"expirationMonth": "string",
"tokenStatus": "string",
"tokenUniqueReference": "string",
"PaymentAccountReferenc": "string",
"card": {
"last4Digits": "string",
"expirationYear": "string",
"expirationMonth": "string",
"cardUpdated": "string",
"updateReason": "string",
"updateDate": "string"
}
}
},
"tokenRequestorId": "string",
"result": {
"status": "success",
"errors": {
"code": "7000.1000",
"reason": "Unexpected error"
}
}
}
Internal processing error
{
"result": {
"status": "error",
"errors": {
"code": "7000.1000",
"reason": "Internal Processing Error."
}
}
}