Skip to content

Errors

Error Examples

Error Description Parameters/Request Body Response Body
400 acquiring/register referenceExists Error REQUEST BODY
{
  "reference": "extRefTCardId101",
  "card": {
    "encryptedData":
"Snbx7y1UUwOjJ44jUA0OjHWz184mpK5dqaHGGHz
QML7_d6FolgQ25VEq4UusvmSSMCziNF8h7wq2Gjz
JXMO3YghuuYqIw_2VvObd0TevFnjfFGL30qMM8GY
2Q6BzRuXRdHMuy6qT4SPypJnDXbleHeEvjtzGSZ5
zLlYp9BboyKU0oFGmT0P-_j4TQ2AHSnOF17bM5AZ
GkdKBzNBTLREKbMKev5ZF6ot1oAoeau9EldgOs74
vBiKhGoUKSIbJl5E9cOXUmWCrUriblStRQkA-JSU
EhkuZnReOEM83VEeVvaHYVtcxXydpIo55ecPg6EO
TMlO41UDu3dExos0ssOVSUg",
    "keyId": "je87i6-C2QJS7PHUAbJPqw"
  },
  "owner": {
    "name": {
      "first": "John",
      "middle": "M",
      "last": "Doe",
      "suffix": "III"
    },
    "address": {
      "addressLine1": "1346 Pleasant Ave",
      "addressLine2": "Apt A123",
      "city": "Salt Lake City",
      "state": "UT",
      "postalCode": "12345",
      "country": "US"
    },
    "phone": {
      "countryCode": "1",
      "number": "5556667777"
    }
  }
}		 RESPONSE BODY
{
    "requestId":
"b0603380819c11ee9b7427220cc6c212",
    "code": "referenceExists",
    "context": {
        "reference": "extRefTCardId101",
        "entityId":
"tcrd_4X6jiiEDEOFEVLGJ4cvwRQ"
    },
    "message": "Reference already exists."
}
400 acquiring/register requestValidateError - Missing required property REQUEST BODY
{
  "reference": "extRefTCardId102",
  "owner": {
    "name": {
      "first": "John",
      "middle": "M",
      "last": "Doe",
      "suffix": "III"
    },
    "address": {
      "addressLine1": "1346 Pleasant Ave",
      "addressLine2": "Apt A123",
      "city": "Salt Lake City",
      "state": "UT",
      "postalCode": "12345",
      "country": "US"
    },
    "phone": {
      "countryCode": "1",
      "number": "5556667777"
    }
  }
}		 RESPONSE BODY
{
    "requestId":
"cece4550819c11ee9b7427220cc6c212",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "",
            "schemaPath": "#/required",
            "keyword": "required",
            "params": {
                "missingProperty": "card"
            },
            "message": "must have required property
'card'"
        }
    ]
}
400 acquiring/register extToucan Error 1 Invalid keyId REQUEST BODY
{
  "reference": "extRefTCardId103",
  "card": {
    "encryptedData":
"Snbx7y1UUwOjJ44jUA0OjHWz184mpK5dqaHGGHz
QML7_d6FolgQ25VEq4UusvmSSMCziNF8h7wq2Gjz
JXMO3YghuuYqIw_2VvObd0TevFnjfFGL30qMM8GY
2Q6BzRuXRdHMuy6qT4SPypJnDXbleHeEvjtzGSZ5
zLlYp9BboyKU0oFGmT0P-_j4TQ2AHSnOF17bM5AZ
GkdKBzNBTLREKbMKev5ZF6ot1oAoeau9EldgOs74
vBiKhGoUKSIbJl5E9cOXUmWCrUriblStRQkA-JSU
EhkuZnReOEM83VEeVvaHYVtcxXydpIo55ecPg6EO
TMlO41UDu3dExos0ssOVSUg",
    "keyId": "unknownKeyID"
  },
  "owner": {
    "name": {
      "first": "John",
      "middle": "M",
      "last": "Doe",
      "suffix": "III"
    },
    "address": {
      "addressLine1": "1346 Pleasant Ave",
      "addressLine2": "Apt A123",
      "city": "Salt Lake City",
      "state": "UT",
      "postalCode": "12345",
      "country": "US"
    },
    "phone": {
      "countryCode": "1",
      "number": "5556667777"
    }
  }
}		 RESPONSE BODY
{
    "requestId":
"ef1731a0819c11ee9b7427220cc6c212",
    "code": "extToucan",
    "subCode": 400,
    "context": {
        "errorCode": "3C3E1402"
    },
    "message": "card.keyID"
}
400 acquiring/register extToucan Error 2 Other Error - example invalid encryptedData value REQUEST BODY
{
  "reference": "extRefTCardId104",
  "card": {
    "encryptedData":
"invalidEncryptionData",
    "keyId": "je87i6-C2QJS7PHUAbJPqw"
  },
  "owner": {
    "name": {
      "first": "John",
      "middle": "M",
      "last": "Doe",
      "suffix": "III"
    },
    "address": {
      "addressLine1": "1346 Pleasant Ave",
      "addressLine2": "Apt A123",
      "city": "Salt Lake City",
      "state": "UT",
      "postalCode": "12345",
      "country": "US"
    },
    "phone": {
      "countryCode": "1",
      "number": "5556667777"
    }
  }
}		 RESPONSE BODY
{
    "requestId":
"09dd4a10819d11ee9b7427220cc6c212",
    "code": "extToucan",
    "subCode": 500,
    "context": {
        "errorCode": "3C3E3300"
    },
    "message": ""
}
400 acquiring/pull cardNotFound Error REQUEST BODY
{
  "reference": "exrnl2TnId2601",
  "cFiCardId": "unknownCardId",
  "amount": 10.01,
  "currency": "USD",
  "narrative": "For invoice #123",
  "softDescriptor": {
    "name": "Sample Merchant",
    "address": {
      "addressLine1": "1346 Pleasant Ave",
      "addressLine2": "Apt A123",
      "city": "Salt Lake City",
      "state": "PA",
      "postalCode": "12345",
      "country": "US"
    },
    "phone": {
      "countryCode": "1",
      "number": "5556667777"
    },
    "email": "merchant@sample.com"
  } 
}		 RESPONSE BODY
{
    "requestId":
"01d9e4b0796c11eeb5658f28ab5fe311",
    "code": "cardNotFound",
    "context": {
        "cFiCardId": "unknownCardId"
    },
    "message": "Card not found"
}
400 acquiring/pull requestValidateError - Value below minimum allowed REQUEST BODY
{
  "reference": "exrnl2TnId2602",
  "cFiCardId":
"tcrd_1AXvpht43m432u6UHpu07w",
  "amount": -10.01,
  "currency": "USD",
  "narrative": "For invoice #123",
  "softDescriptor": {
    "name": "Sample Merchant",
    "address": {
      "addressLine1": "1346 Pleasant Ave",
      "addressLine2": "Apt A123",
      "city": "Salt Lake City",
      "state": "PA",
      "postalCode": "12345",
      "country": "US"
    },
    "phone": {
      "countryCode": "1",
      "number": "5556667777"
    },
    "email": "merchant@sample.com"
  } 
}		 RESPONSE BODY
{
    "requestId":
"19172480796c11eeb5658f28ab5fe311",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "/amount",
            "schemaPath":
"common#/definitions/amount/exclusiveMin
imum",
            "keyword": "exclusiveMinimum",
            "params": {
                "comparison": ">",
                "limit": 0
            },
            "message": "must be > 0"
        }
    ]
}
400 acquiring/pull requestValidateError - Field exceeds max length REQUEST BODY
{
  "reference": "exrnl2TnId2602",
  "cFiCardId":
"tcrd_1AXvpht43m432u6UHpu07w",
  "amount": 10.01,
  "currency": "USD",
  "narrative": "For invoice #123",
  "softDescriptor": {
    "name": "Sample Merchant",
    "address": {
      "addressLine1": "1346 Pleasant
Aveddddddddddddddddddddddddddddddddddddd
dddddddddddddddddddddddddddddddddddddddd
ddddddddddddddddddddddddddddddd",
      "addressLine2": "Apt A123",
      "city": "Salt Lake City",
      "state": "PA",
      "postalCode": "12345",
      "country": "US"
    },
    "phone": {
      "countryCode": "1",
      "number": "5556667777"
    },
    "email": "merchant@sample.com"
  } 
}		 RESPONSE BODY
{
    "requestId":
"34f2a490796c11eeb5658f28ab5fe311",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath":
"/softDescriptor/address/addressLine1",
            "schemaPath":
"common#/definitions/commonStr50Req/maxL
ength",
            "keyword": "maxLength",
            "params": {
                "limit": 50
            },
            "message": "must NOT have more than 50
characters"
        }
    ]
}
400 acquiring/pull requestValidateError - Missing required property REQUEST BODY
{
  "reference": "exrnl2TnId2603",
  "amount": 10.01,
  "currency": "USD",
  "narrative": "For invoice #123",
  "softDescriptor": {
    "name": "Sample Merchant",
    "address": {
      "addressLine1": "1346 Pleasant Ave",
      "addressLine2": "Apt A123",
      "city": "Salt Lake City",
      "state": "PA",
      "postalCode": "12345",
      "country": "US"
    },
    "phone": {
      "countryCode": "1",
      "number": "5556667777"
    },
    "email": "merchant@sample.com"
  } 
}		 RESPONSE BODY
{
    "requestId":
"567ac8c0819d11ee9b7427220cc6c212",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "",
            "schemaPath": "#/required",
            "keyword": "required",
            "params": {
                "missingProperty": "cFiCardId"
            },
            "message": "must have required property
'cFiCardId'"
        }
    ]
}
400 acquiring/pull referenceExists Error REQUEST BODY
{
  "reference": "exrnl2TnId2602",
  "cFiCardId":
"tcrd_1AXvpht43m432u6UHpu07w",
  "amount": 10.01,
  "currency": "USD",
  "narrative": "For invoice #123",
  "softDescriptor": {
    "name": "Sample Merchant",
    "address": {
      "addressLine1": "1346 Pleasant Ave",
      "addressLine2": "Apt A123",
      "city": "Salt Lake City",
      "state": "PA",
      "postalCode": "12345",
      "country": "US"
    },
    "phone": {
      "countryCode": "1",
      "number": "5556667777"
    },
    "email": "merchant@sample.com"
  } 
}		 RESPONSE BODY
{
    "requestId":
"30936a40819d11ee9b7427220cc6c212",
    "code": "referenceExists",
    "context": {
        "reference": "exrnl2TnId2602",
        "entityId":
"CLIENTID_7DaTiGX2UPeEJ0cEZmJFcK"
    },
    "message": "Reference already exists."
}
400 acquiring/pull toucanSettlementAccountNotFound Error REQUEST BODY
{
  "reference": "exrnl2TnId2602",
  "cFiCardId":
"tcrd_1AXvpht43m432u6UHpu07w",
  "amount": 10.01,
  "currency": "USD",
  "narrative": "For invoice #123",
  "softDescriptor": {
    "name": "Sample Merchant",
    "address": {
      "addressLine1": "1346 Pleasant Ave",
      "addressLine2": "Apt A123",
      "city": "Salt Lake City",
      "state": "PA",
      "postalCode": "12345",
      "country": "US"
    },
    "phone": {
      "countryCode": "1",
      "number": "5556667777"
    },
    "email": "merchant@sample.com"
  } 
}		 RESPONSE BODY
{
    "requestId":
"9794d220684c11ee8df9d847b134c812",
    "code":
"toucanSettlementAccountNotFound",
    "context": {
        "cFiAggregatorId": "amplifi"
    },
    "message": "Aggregator doesn't have
toucanSettlementAccount attribute."
}
400 acquiring/pull extToucan Error Transaction Declined REQUEST BODY
{
  "reference": "exrnl2TnId2603",
  "cFiCardId":
"tcrd_1AXvpht43m432u6UHpu07w",
  "amount": 100.01,
  "currency": "USD",
  "narrative": "For invoice #123",
  "softDescriptor": {
    "name": "Sample Merchant",
    "address": {
      "addressLine1": "1346 Pleasant Ave",
      "addressLine2": "Apt A123",
      "city": "Salt Lake City",
      "state": "PA",
      "postalCode": "12345",
      "country": "US"
    },
    "phone": {
      "countryCode": "1",
      "number": "5556667777"
    },
    "email": "merchant@sample.com"
  } 
}		 RESPONSE BODY
{
    "requestId":
"856a0330819d11ee9b7427220cc6c212",
    "code": "extToucan",
    "context": {
        "status": "Declined",
        "cFiTransactionId":
"CLIENTID_43Lp1m2725LvwteeBo22bg",
        "cFiAggregatorId": "CLIENTID",
        "reference": "exrnl2TnId2603"
    },
    "message": "Transaction Limit" //If the
transaction is declined, the message and/or
responseCode (if included) indicates the
reason as defined by ISO 8583. See
https://developers.google.com/standard-p
ayments/v1/fops/card/response-codes for a
list of codes.
}
400 acquiring/pull moduleDisabled Error Contact PayGears support to enable push-pull services REQUEST BODY
{
  "reference": "exrnl2TnId2605",
  "cFiCardId":
"tcrd_1AXvpht43m432u6UHpu07w",
  "amount": 10.01,
  "currency": "USD",
  "narrative": "For invoice #123",
  "softDescriptor": {
    "name": "Sample Merchant",
    "address": {
      "addressLine1": "1346 Pleasant Ave",
      "addressLine2": "Apt A123",
      "city": "Salt Lake City",
      "state": "PA",
      "postalCode": "12345",
      "country": "US"
    },
    "phone": {
      "countryCode": "1",
      "number": "5556667777"
    },
    "email": "merchant@sample.com"
  } 
}		 RESPONSE BODY
{
    "requestId":
"7816912094f411eea89d7100487c0512",
    "code": "moduleDisabled",
    "message": "Module toucan is disabled"
}
400 acquiring/transactions-query requestValidateError - Must not have fewer than minimum characters REQUEST BODY
{
    "cFiTransactionIds": [
        ""
    ]
}		 RESPONSE BODY
{
    "requestId":
"6a882ed0796d11eeb5658f28ab5fe311",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "/cFiTransactionIds/0",
            "schemaPath":
"common#/definitions/id/minLength",
            "keyword": "minLength",
            "params": {
                "limit": 1
            },
            "message": "must NOT have fewer than 1
characters"
        },
        {
            "instancePath": "",
            "schemaPath": "#/oneOf/1/required",
            "keyword": "required",
            "params": {
                "missingProperty": "references"
            },
            "message": "must have required property
'references'"
        },
        {
            "instancePath": "",
            "schemaPath": "#/oneOf",
            "keyword": "oneOf",
            "params": {
                "passingSchemas": null
            },
            "message": "must match exactly one schema in
oneOf"
        }
    ]
}
400 acquiring/transactions-query requestValidateError - Must not have fewer than minimum items REQUEST BODY
{
    "cFiTransactionIds": [  ]
}		 RESPONSE BODY
{
    "requestId":
"8c6046a0796d11eeb5658f28ab5fe311",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "/cFiTransactionIds",
            "schemaPath":
"#/oneOf/0/properties/cFiTransactionIds/
minItems",
            "keyword": "minItems",
            "params": {
                "limit": 1
            },
            "message": "must NOT have fewer than 1 items"
        },
        {
            "instancePath": "",
            "schemaPath": "#/oneOf/1/required",
            "keyword": "required",
            "params": {
                "missingProperty": "references"
            },
            "message": "must have required property
'references'"
        },
        {
            "instancePath": "",
            "schemaPath": "#/oneOf",
            "keyword": "oneOf",
            "params": {
                "passingSchemas": null
            },
            "message": "must match exactly one schema in
oneOf"
        }
    ]
}
400 acquiring/transactions-query requestValidateError - Must match exactly 1 schema REQUEST BODY
{
    "cFiTransactionIds": [
        "CLIENTID_6C1dj5cgIHVRAZBRFKJ5ES"
    ],
    "references": ["exrnl2TnId2600"]
}		 RESPONSE BODY
{
    "requestId":
"950a623094f811eea89d7100487c0512",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "",
            "schemaPath":
"#/oneOf/0/additionalProperties",
            "keyword": "additionalProperties",
            "params": {
                "additionalProperty": "references"
            },
            "message": "must NOT have additional
properties"
        },
        {
            "instancePath": "",
            "schemaPath":
"#/oneOf/1/additionalProperties",
            "keyword": "additionalProperties",
            "params": {
                "additionalProperty":
"cFiTransactionIds"
            },
            "message": "must NOT have additional
properties"
        },
        {
            "instancePath": "",
            "schemaPath": "#/oneOf",
            "keyword": "oneOf",
            "params": {
                "passingSchemas": null
            },
            "message": "must match exactly one schema in
oneOf"
        }
    ]
}
400 acquiring/transactions-query requestValidateError - Must have required property to fit exactly 1 schema REQUEST BODY
{
    
}		 RESPONSE BODY
{
    "requestId":
"c2cd9fc094f811eea89d7100487c0512",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "",
            "schemaPath": "#/oneOf/0/required",
            "keyword": "required",
            "params": {
                "missingProperty": "cFiTransactionIds"
            },
            "message": "must have required property
'cFiTransactionIds'"
        },
        {
            "instancePath": "",
            "schemaPath": "#/oneOf/1/required",
            "keyword": "required",
            "params": {
                "missingProperty": "references"
            },
            "message": "must have required property
'references'"
        },
        {
            "instancePath": "",
            "schemaPath": "#/oneOf",
            "keyword": "oneOf",
            "params": {
                "passingSchemas": null
            },
            "message": "must match exactly one schema in
oneOf"
        }
    ]
}
400 acquiring/list greaterNumberOfRecords Error REQUEST BODY
{
  "dateCreateFrom":
"2023-04-01T18:57:25.957Z",
  "dateCreateTo":
"2024-05-10T18:57:25.957Z",
  "status": "Complete",
  "numberOfRecords": 1001,
  "skipRecords": 0
}		 RESPONSE BODY
{
    "requestId":
"e5200b30796e11eeb5658f28ab5fe311",
    "code": "greaterNumberOfRecords",
    "context": {
        "maxNumberOfRecords": 1000
    },
    "message": "The numberOfRecords field is
greater than the request limit"
}
400 acquiring/list requestValidateError - Must be an allowed value REQUEST BODY
{
  "dateCreateFrom":
"2023-04-01T18:57:25.957Z",
  "dateCreateTo":
"2024-05-10T18:57:25.957Z",
  "status": "OtherStatus",
  "numberOfRecords": 1000,
  "skipRecords": 0
}		 RESPONSE BODY
{
    "requestId":
"f8af5e30796e11eeb5658f28ab5fe311",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "/status",
            "schemaPath":
"#/properties/status/enum",
            "keyword": "enum",
            "params": {
                "allowedValues": [
                    "Unknown",
                    "Manual",
                    "Initiated",
                    "Complete",
                    "Declined"
                ]
            },
            "message": "must be equal to one of the allowed
values"
        }
    ]
}
400 acquiring/reversal transactionNotFound Error REQUEST BODY
{
  "cFiTransactionId": "unknownId"
}		 RESPONSE BODY
{
    "requestId":
"76a19b10796e11eeb5658f28ab5fe311",
    "code": "transactionNotFound",
    "context": {
        "cFiTransactionId": "unknownId"
    },
    "message": "Transaction not found."
}
400 acquiring/reversal requestValidateError - Must not have fewer than minimum characters REQUEST BODY
{
  "cFiTransactionId": ""
}		 RESPONSE BODY
{
    "requestId":
"84231840796e11eeb5658f28ab5fe311",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "/cFiTransactionId",
            "schemaPath":
"common#/definitions/id/minLength",
            "keyword": "minLength",
            "params": {
                "limit": 1
            },
            "message": "must NOT have fewer than 1
characters"
        }
    ]
}
400 acquiring/reversal requestValidateError - Missing required property REQUEST BODY
{
}		 RESPONSE BODY
{
    "requestId":
"921cf9c0796e11eeb5658f28ab5fe311",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "",
            "schemaPath": "#/required",
            "keyword": "required",
            "params": {
                "missingProperty": "cFiTransactionId"
            },
            "message": "must have required property
'cFiTransactionId'"
        }
    ]
}
400 acquiring/reversal requestValidateError - Must not have additional properties REQUEST BODY
{
  "cFiTransactionId":
"CLIENTID_7DaTiGX2UPeEJ0cEZmJFcK",
  "someAdditionalProperty": "value"
}		 RESPONSE BODY
{
    "requestId":
"b21ca810796e11eeb5658f28ab5fe311",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "",
            "schemaPath": "#/additionalProperties",
            "keyword": "additionalProperties",
            "params": {
                "additionalProperty":
"someAdditionalProperty"
            },
            "message": "must NOT have additional
properties"
        }
    ]
}
400 acquiring/reversal toucanCannotReverseError Error REQUEST BODY
{
  "cFiTransactionId":
"CLIENTID_7DaTiGX2UPeEJ0cEZmJFcK"
}		 RESPONSE BODY
{
    "requestId":
"21fff5f0819f11ee9b7427220cc6c212",
    "code": "toucanCannotReverseError",
    "context": {
        "cFiTransactionId":
"CLIENTID_7DaTiGX2UPeEJ0cEZmJFcK"
    },
    "message": "This transaction is already
reversed (reversal)"
}