Retrieve a Single Buyer's Payment Token
GET/buyers/{buyerId}/paymentTokens/{paymentTokenId}
Retrieves a single payment token of a Buyer.
Request
Path Parameters
Possible values: <= 255 characters
Unique identifier of the customer in your system.
Represents a customer bank account in the Nuvei system.
Responses
- 200
OK
- application/json
- Schema
- Example (from schema)
Schema
paymentToken
object
ID of card in the Gateway. Values: 1 = VISA | 2 = MasterCard | 3 = Amex | 4 = Diners | 5 = JCB | 6 = Discover
paymentOption
object
required
card
object
Possible values: <= 70 characters
The card holder name.
Possible values: <= 20 characters
The masked credit card number.
Possible values: <= 6 characters
The first six 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
alternativePaymentMethod
object
Possible values: non-empty
and <= 50 characters
data
object
Possible values: <= 255 characters
Possible values: <= 50 characters
Merchant Reference for a business entity (token, subscription, etc.)
Processing entityId
provided by Nuvei.
Possible values: [recurring
, unscheduled
]
result
object
required
Possible values: [success
, error
]
errors
object
Possible values: <= 11 characters
Possible values: <= 400 characters
{
"paymentToken": {
"paymentTokenId": "1eaf1356-a9a2-4a16-a0c1-290ba2265257",
"cccId": 1,
"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
},
"alternativePaymentMethod": {
"name": "ACH",
"data": {
"accountNumber": "11345739548759",
"routingNumber": "847937857"
}
}
},
"buyerId": "[email protected]",
"merchantReference": "MREF_6f06168d-ff6e-448b-8401-30051eb6b1af",
"processingEntityId": "80aef199-b89a-4d59-ba0c-f2cd3c25d5cd",
"usageIntent": "recurring"
},
"result": {
"status": "success",
"errors": {
"code": "7000.1000",
"reason": "Unexpected error"
}
}
}