Tokenize a prepaid card
POST/profile/prepaid/cards/:cardId/tokenizations
Tokenize given card for specific mobile wallet.
Request
Path Parameters
UUID based Card id.
- application/json
Body
Request for card tokenization for a specific mobile wallet.
Possible values: [GOOGLE_PAY
, APPLE_PAY
, SAMSUNG_PAY
]
Contains supported wallet types.
Required for cards with VISA schema + Samsung/Google Pay. Not required for VISA + Apple Pay.
Required for cards with VISA schema + Samsung/Google Pay.
The leaf certificate returned by the wallet provider, that was signed using subordinateCertificate
.
Should be converted to hexadecimal (case insensitive) binary data of the certificate.
If the certificate is in PEM encoding, then it should follow the typical standards for PEM.
In particular, the tags -----BEGIN CERTIFICATE-----
and -----END CERTIFICATE-----
should be present and the Base64-encoded value should have lines of length 64.
The subordinate certificate returned by the wallet provider that was signed using the Wallet Provider’s Certificate Authority (CA) certificate.
Should be converted to hexadecimal (case insensitive) binary data of the certificate. If the certificate is in PEM encoding, then it should follow the typical standards for PEM. In particular, the tags
-----BEGIN CERTIFICATE-----
and -----END CERTIFICATE-----
should be present and the Base64-encoded value should have lines of length 64.
Hexadecimal (case insensitive) nonce value returned by the Apple Pay SDK
Hexadecimal (case insensitive) nonce signature value returned by the Apple Pay SDK.
Responses
- 201
- 400
- 404
- 405
- 500
Created
- application/json
- Schema
- Example (from schema)
- GOOGLE_PAY_TOKENIZATION_RESPONSE
- APPLE_PAY_TOKENIZATION_RESPONSE
Schema
Opaque payment card - needs to be shared with Google Pay 'as is' and will be presented to TSP to receive a token.
An encrypted info containing the sensitive information needed to add a card to Apple Pay.
The ephemeral public key used by elliptic curve cryptography (ECC) used with Apple Pay.
This property contains the data provided to the payment network as a cryptographic one-time pad (OTP), per the Payment Network API specification.
Possible values: [CARD_NETWORK_VISA
, CARD_NETWORK_MASTERCARD
]
Possible values: [TOKEN_PROVIDER_VISA
, TOKEN_PROVIDER_MASTERCARD
]
customer
object
Customer
information about specific card holder.
Possible values: >= 4 characters
and <= 40 characters
Possible values: <= 30 characters
Possible values: <= 30 characters
Possible values: <= 30 characters
Max 30 characters: letters, spaces, hyphen and period
Possible values: >= 2 characters
and <= 2 characters
Country code in ISO-3166 Alpha 2
Possible values: <= 3 characters
For US Customers: 2,3-character state or province abbreviation Example: "UT"
Possible values: non-empty
and <= 16 characters
For EU customers: maximum length 16
For US customers: Pattern: ^[a-zA-Z0-9-\ ]*$
minimum 4, maximum 10
Possible values: Value must match regular expression ^\+\d+\s?\d{1,16}$
Mobile phone number used during card creation.
Possible values: >= 4 characters
and <= 4 characters
Last four digits of the card.
{
"opaquePaymentCard": "string",
"encryptedPassData": "string",
"ephemeralPublicKey": "string",
"activationData": "string",
"cardNetwork": "CARD_NETWORK_VISA",
"tokenProvider": "TOKEN_PROVIDER_VISA",
"customer": {
"address1": "Tsarigradsko Shose 73",
"address2": "string",
"address3": "string",
"city": "Sofia",
"countryCode": "BG",
"state": "string",
"postalCode": "1000",
"name": "John Roger Smith",
"mobile": "string"
},
"cardLastDigits": "4234"
}
{
"opaquePaymentCard": "eyJhbGciOiJBMjU2R0NNS1ciLCJjaGFubmVsU2VjdXJpdHlDb250ZXh0IjoiU0hBUkVEX1NFQ1JFVCIsImVuYyI6IkEyNTZHQ00iLCJpYXQiOjE3MDQ0MjQ1MzgsIml2IjoiNUE0WklCWmJzbWQ2QVJTbyIsImtpZCI6IkdHTVNQV1VMVVdOREZLVDJZSUo2MTRtN1BhanVxU3Qxb1pwZWU5aERGUEdCTnJfTjAiLCJ0YWciOiI4T2g5eEtmVVRmOThmZnhJSWR4dEVBIiwidHlwIjoiSk9TRSJ9",
"cardNetwork": "CARD_NETWORK_VISA",
"tokenProvider": "TOKEN_PROVIDER_VISA",
"customer": {
"address1": "Tsarigradsko Shose 73",
"city": "Sofia",
"countryCode": "BG",
"postalCode": "1000",
"name": "John Roger Smith",
"mobile": "+1 1234567896"
},
"cardLastDigits": "4234"
}
{
"encryptedPassData": "SHZDPnVxVDhjLUExVjZ0VlZ3a1V1M0xhUUN2NGw2UWtocVc4bGN2S2JMS1VCMA==",
"ephemeralPublicKey": "Z2U+dnBCQE81WUdFdURjN3JRMVRqdDZKOERQcUNGM2Y1cG9kTVJkbVBWYjR5VQ==",
"activationData": "QWRSdkFySnhHMEFyR1IwZkUpNTJrbkBhNE5GMnJzWGFEU0JlS1JiNjZnVmdqYQ==",
"cardNetwork": "CARD_NETWORK_VISA",
"tokenProvider": "TOKEN_PROVIDER_VISA",
"customer": {
"address1": "Tsarigradsko Shose 73",
"city": "Sofia",
"countryCode": "BG",
"postalCode": "1000",
"name": "John Roger Smith",
"mobile": "+1 1234567896"
},
"cardLastDigits": "4234"
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
error
object
Additional details about an error
The error code.
A description of the error.
Details of any parameter value errors.
fieldErrors
object[]
Identifies the JSON request field.
The problem associated with the field.
{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
],
"fieldErrors": [
{
"field": "string",
"error": "string"
}
]
}
}
Not Found
- application/json
- Schema
- Example (from schema)
- CARD_NOT_FOUND
Schema
Array [
]
error
object
Additional details about an error
The error code.
A description of the error.
Details of any parameter value errors.
fieldErrors
object[]
Identifies the JSON request field.
The problem associated with the field.
{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
],
"fieldErrors": [
{
"field": "string",
"error": "string"
}
]
}
}
{
"error": {
"code": "5269",
"message": "Entity not found",
"details": [
"The ID(s) specified in the URL do not correspond to the values in the system."
],
"fieldErrors": []
}
}
Method Not Allowed
- application/json
- Schema
- Example (from schema)
- DW-OPERATION-NOT-ALLOWED
Schema
Array [
]
error
object
Additional details about an error
The error code.
A description of the error.
Details of any parameter value errors.
fieldErrors
object[]
Identifies the JSON request field.
The problem associated with the field.
{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
],
"fieldErrors": [
{
"field": "string",
"error": "string"
}
]
}
}
{
"error": {
"code": "DW-OPERATION-NOT-ALLOWED",
"message": "Operation is not allowed in your account. Contact Paysafe for further details.",
"details": [
"Operation is not allowed in your account. Contact Paysafe for further details."
]
}
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
error
object
Additional details about an error
The error code.
A description of the error.
Details of any parameter value errors.
fieldErrors
object[]
Identifies the JSON request field.
The problem associated with the field.
{
"error": {
"code": "string",
"message": "string",
"details": [
"string"
],
"fieldErrors": [
{
"field": "string",
"error": "string"
}
]
}
}