Toucan API Error Handling

Toucan API Errors

If the Toucan API fails, you'll receive an error in the format of the following example:

{
    "code": 400,
    "traceId": "b1c05634-12fe-4897-a061-b08e62a58747",
    "message": "Request failed",
    "errors": {
        "generalErrors": [
            "The PAN network is invalid."
        ]
    }
}

For all Toucan API errors, the code will be 400 and the message will be Request failed.

Error CodeMessageRecommended Action
SuccessThe request was successfully completed.
SystemErrorA system error occurred.Contact your Pagos account manager
NetworkErrorThe network cannot process the request.Try your request again
InvalidPropertyA property validation check has failed.Re-submit your request after correcting the input
AuthenticationFailedThe tokenization service could not authenticate the request.Check your API keys; if you can't identify an issue, contact your Pagos account manager
InvalidInputThe tokenization service could not find data linked with provided input.Check your tokenRefID; if you can't identify an issue, contact your Pagos account manager
Invalid RequestThe tokenization service could not validate the request.Review the error JSON object for more details
InvalidMerchantStatusThe merchant account is in an invalid status for the requested operation.Contact your Pagos account manager
UnavailableMerchantAccountThe merchant account is not available.Re-submit your request after correcting the input
CardEligibilityErrorThe card is not eligible for network tokenization.
InvalidPanReferenceFormatThe PAN reference format is invalid.Re-submit your request after correcting the input
InvalidPanReferenceThe requested PAN could not be found.Check your tokenRefID; if you can't identify an issue, contact your Pagos account manager
InvalidTokenReferenceFormatThe token reference format is invalid.Re-submit your request after correcting the input
InvalidTokenReferenceThe requested token could not be found.Check your tokenRefID; if you can't identify an issue, contact your Pagos account manager
NoActiveTokensThere are no active (not suspended) Tokens for the given Account PAN and consumer account.Contact your Pagos account manager
InvalidAssetReferenceThe requested asset could not be found.Contact your Pagos account manager
MetadataNotAvailableThe requested token's metadata is not available.Contact your Pagos account manager
InvalidUuidFormatThe Uuid format is invalid.Re-submit your request after correcting the input
InvalidUuidThe requested Uuid could not be found.Contact your Pagos account manager
InvalidPanFormatThe PAN format is invalid, or other data associated with the PAN was incorrect or entered incorrectly.Re-submit your request after correcting the input
InvalidPanThe PAN is invalid.Re-submit your request after correcting the input
InvalidTridThe TRID is invalid.Re-submit your request after correcting the input
InvalidTridNetworkThe TRID network in invalid.Contact your Pagos account manager
InvalidPanNetworkThe PAN network in invalid.Contact your Pagos account manager
InvalidPanExpiryFormatThe PAN expiry format is invalid.Re-submit your request after correcting the input
InvalidPanExpiryThe PAN expiry is invalid.Re-submit your request after correcting the input
InvalidTokenStatusThe current token's status doesn't support the requested operation.
ProvisionDataExpiredThe PAN information provided is considered stale.
CardVerificationFailedInvalid payment instrument or data associated with the payment instrument.
CardNotEligibleThis card cannot be used for tokenization at this moment.
CardNotAllowedThe requested action is not allowed for a given PAN.
CardDeclinedThis card is considered not eligible for tokenization at this time.
CardExpiredCard expired.
CardCancelledCard is cancelled.
IssuerNotSupportedThe Issuer of the Card provided does not support provisioning for cards they issue.
ProvisionNotAllowedFurther operations for this card are no longer allowed.
UserLockedOutFromProvisioningUser is locked out from provisioning.Contact your Pagos account manager
AccountNotFoundAccount not found.Contact your Pagos account manager
DuplicateRequestThe PAN has already been provisioned to the device or the same request is currently being processed.