Request to get a scheme token and its status
- Production environmenthttps://api-services.pxp.io/api/v1/token-vault/{ownerType}/{ownerId}/vaults/scheme-tokens/{schemeTokenId}
- Sandbox environmenthttps://api-services.test.pxp.io/api/v1/token-vault/{ownerType}/{ownerId}/vaults/scheme-tokens/{schemeTokenId}
curl -i -X GET \
https://api-services.pxp.io/api/v1/token-vault/MerchantGroup/MERCHANT-GROUP-1/vaults/scheme-tokens/7f46c09d-d1d1-4f94-9a88-6e8ac32e6341Successful retrieval of the scheme token
The unique scheme token ID generated by PXP. It is used as a reference to extract the schemeTokenNumber.
A unique identifier token provided by the external payment scheme. This token allows merchants to process payments through different payment service providers (PSPs) or transaction service providers (TSPs). The token facilitates interoperability between different PSPs, enabling merchants to seamlessly integrate with and use various payment processing services.
The payment account reference associated with the scheme token.
The scheme token number represents a scheme token issued by Visa or Mastercard, used for subsequent transaction processing. This token enhances security and facilitates recurring transactions, providing a secure and efficient alternative to sharing sensitive card details.
The expiry month of the card, as a number from 1 to 12. Typically zero-padded to two digits (for example, 03).
{ "schemeTokenId": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "schemeTokenProvider": "Visa", "schemeTokenProcurementState": "Completed", "externalSchemeTokenId": "ext-123456789", "status": "Active", "paymentAccountReference": "acc-987654321", "schemeTokenNumber": "1234567812345678", "expiryMonth": "12", "expiryYear": "2025" }