Retrieve details about a specific scheme token.
Use the following request to create a gateway token.
curl -i -X GET \
https://api-services.pxp.io/api/v1/token-vault/MerchantGroup/MERCHANT-GROUP-1/vaults/scheme-tokens/46cae041-de60-44cc-8539-c482d83e38fb| Parameter | Description |
|---|---|
ownerIdstring (0 to 20 characters) required | The unique identifier of the entity that owns the token. |
ownerTypestring (enum) required | The type of entity that owns the token. Possible values:
|
schemeTokenIdstring (UUID) required | The unique scheme token identifier generated by PXP. |
If your request is successful, you'll receive a 200 response that includes the scheme token's procurement state and current status.
{
"schemeTokenId": "46cae041-de60-44cc-8539-c482d83e38fb",
"schemeTokenProvider": "Mastercard",
"schemeTokenProcurementState": "Completed",
"externalSchemeTokenId": "fef14b0a-dd75-4a8e-8b4f-51a0fae82a21",
"status": "ACTIVE",
"paymentAccountReference": "50010P4G3SYR1Q9RJVY18EDBHWQZT",
"schemeTokenNumber": "5186151969829924",
"expiryMonth": "4",
"expiryYear": "2027"
}| Parameter | Description |
|---|---|
schemeTokenIdstring (UUID) | The unique scheme token identifier generated by PXP. |
schemeTokenProviderstring | The name of the scheme token provider. |
schemeTokenProcurementStatestring | The procurement state of the scheme token. Possible values:
|
externalSchemeTokenIdstring or null | 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.. |
statusstring or null | The status of the scheme token. Possible values:
|
paymentAccountReferencestring or null | The payment account reference associated with the scheme token. |
schemeTokenNumberstring or null | 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. |
expiryMonthstring (1-2 characters) | The expiry month of the card associated with the token. |
expiryYearstring (4 characters) | The expiry year of the card associated with the token. |