Create scheme token

Convert card details into a scheme token.

Create a scheme token

POST

/v1/token-vault/{ownerType}/{ownerId}/vaults/scheme-tokens

Request example

Use the following request to create a scheme token.

curl -i -X POST \
  https://api-services.pxp.io/api/v1/token-vault/MerchantGroup/MERCHANT-GROUP-1/vaults/scheme-tokens \
  -H 'Content-Type: application/json' \
  -d '{
    "primaryAccountNumber": "4111111111111111111",
    "expiryMonth": "03",
    "expiryYear": "2025",
    "cardVerificationCode": "123",
    "holderName": "Mr John Doe"
  }'

Path parameters

Parameter	Description
`ownerId` string (0 to 20 characters) required	The unique identifier of the entity that owns the token.
`ownerType` string (enum) required	The type of entity that owns the token. Possible values: `Referrer` `MerchantGroup` `Merchant` `Site`

Body parameters

Parameter	Description
`primaryAccountNumber` string required	The unique number assigned to a payment card, such as a credit or debit card. This number typically contains 16 digits, structured in a specific format to indicate the card network, issuing bank, and account number.
`expiryMonth` string (1 to 2 characters) required	The expiry month of the card.
`expiryYear` string (4 characters) required	The expiry year of the card.
`cardVerificationCode` string (3-4 characters) or null	The Card Verification Code (CVC) associated with the payment card, a security feature for transactions where the card is not physically present. The security code is typically a 3 or 4 digit number found on the card, used to verify that the cardholder is in possession of the card during non-face-to-face transactions.
`holderName` string required	The full name of the individual who owns the payment card. This is printed on the physical card and is used to verify the cardholder's identity. It should be treated with confidentiality to safeguard the cardholder's privacy and prevent potential misuse.

Response example

If your request is successful, you'll receive a 200 response containing a schemeTokenId.

{
  "schemeTokenId": "46cae041-de60-44cc-8539-c482d83e38fa",
  "fundingSource": "Debit"
}

Parameter	Description
`schemeTokenId` string	The unique scheme token ID generated by PXP. It's used as a reference to extract the `schemeTokenNumber`.
`fundingSource` string	The funding source type.