Skip to content

Errors

RPPS Bill Payment Services Errors

Error Code Label Description Context Status
billNotFound Bill not found. Check the transaction ID to make sure it is valid and exists.
Context:
cFiTransactionId - The transaction ID in connectFi		 
{
  "cFiTransactionId": "amplifi_6Gzh1tFquVCAKof441jLsm"
}
 400
rppsBillerNotFound Biller was not found or has been archived. Check the biller ID to make sure it is valid and exists.
If the biller ID exists in the billers list, but has been archived, then the biller is not currently active to accept RPPS bill payments.
Context:
billerId - The biller ID		 
{
  "billerId": ""
}
 400
rppsAccountNumber Need to send only one of accountNumber or accountNumberEncrypted. Use accountNumber or accountNumberEncrypted but not both. - 400
rppsAccountNumberEncrypted The account number for this account must be encrypted. The account number for this account must be encrypted. - 400
rppsBillStatus This transaction does not have a valid status for the requested action. This transaction does not have a valid status for the requested action.
Context:
cFiTransactionId - The transaction ID in connectFi
cFiAggregatorId - The cFiAggregatorId in connectFi
entityStatus - The current transaction status		 
{
  "cFiTransactionId": "entity_123456789abcdefghi1234",
  "cFiAggregatorId": "entityName",
  "entityStatus": "Processing"
}
 400
rppsDecryptAccountNumber Unable to decrypt accountNumberEncrypted. Check to make sure that the public keys used to encrypt this account number are current and consistent with the instance used. - 400
rppsIsReversal User does not have access for bill reversal. This user is not authorized to reverse bill payment transactions. - 401
rppsMaskMatch Biller mask match error. Check the masks array to ensure that the account number mask used is valid for this biller.
Context:
billerId - The biller ID,
masks - An array of the account number masks accepted by this biller		 
{
  "billerId": "1234567890",
  "masks": [
    {
      "recordType": "",
      "mask_key": "",
      "record_effective_date": "",
      "mask_length": "",
      "mask": "",
      "exception_mask": ""
    }
  ]
}
 400
rppsNoEncryptedPAN An unencrypted PAN was detected. An unencrypted PAN was detected. PANs must be encrypted. - 400

Error Examples

Error Description Parameters/Request Body Response Body
400 transfer-to/bills/initiate accountNumberEncrypted ENCRYPTED requestValidateError - Missing required property REQUEST BODY
{
  "amount": 7.15,
  "currency": "USD",
  "reference": "extTrnBill301",
  "accountNumberEncrypted":
"cM+tJN2eJ8mjMRbBVruQ4Y6lAm8wfJ8q9p+JMnsbBfou
NfNXGZXDAtSwKQCP0tF/xS1bH1OxW74adeMHebZ/s+wy4
icqF/vt5ncPdw/ZYUNuQpqBIWDQGnFrWje19sNpwPup65
BXMQ2MVYR8YURdQ7luukrU1hFIcNZ02iLNmeWScOloPXq
nInspTmKaArk+G8WiK7iiAmCjJzyHlIJxLVbj+5cg/d5D
LjItPp34LsmBtSCwHEtdlpN0bC78JQy96AkpEWnacnFG7
Da+9e5ZBRMRbvrldkJHtM8uqErxV/1ZB1rPy91yq4jhkn
yyrpauZFCZSlsnFfaXtiexO0I7kg==",
  "firstName": "Joe",
  "lastName": "Doe",
    "deliveryTimeCode" : "N",
    "webhookUrl":
"https://your_webhook_url/extTrnBill301",
    "narrative": "Your message here"
}		 RESPONSE BODY
{
    "requestId":
"031beb80797511eeb5658f28ab5fe311",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "",
            "schemaPath": "#/oneOf/0/required",
            "keyword": "required",
            "params": {
                "missingProperty": "billerId"
            },
            "message": "must have required property
'billerId'"
        },
        {
            "instancePath": "",
            "schemaPath": "#/oneOf/1/required",
            "keyword": "required",
            "params": {
                "missingProperty": "billerId"
            },
            "message": "must have required property
'billerId'"
        },
        {
            "instancePath": "",
            "schemaPath": "#/oneOf",
            "keyword": "oneOf",
            "params": {
                "passingSchemas": null
            },
            "message": "must match exactly one schema in oneOf"
        }
    ]
}
400 transfer-to/bills/initiate accountNumberEncrypted ENCRYPTED requestValidateError - Must be greater than allowed minimum REQUEST BODY
{
  "amount": -7.15,
  "currency": "USD",
  "reference": "extTrnBill302",
  "billerId": "9000005588",
  "accountNumberEncrypted":
"cM+tJN2eJ8mjMRbBVruQ4Y6lAm8wfJ8q9p+JMnsbBfou
NfNXGZXDAtSwKQCP0tF/xS1bH1OxW74adeMHebZ/s+wy4
icqF/vt5ncPdw/ZYUNuQpqBIWDQGnFrWje19sNpwPup65
BXMQ2MVYR8YURdQ7luukrU1hFIcNZ02iLNmeWScOloPXq
nInspTmKaArk+G8WiK7iiAmCjJzyHlIJxLVbj+5cg/d5D
LjItPp34LsmBtSCwHEtdlpN0bC78JQy96AkpEWnacnFG7
Da+9e5ZBRMRbvrldkJHtM8uqErxV/1ZB1rPy91yq4jhkn
yyrpauZFCZSlsnFfaXtiexO0I7kg==",
  "firstName": "Joe",
  "lastName": "Doe",
    "deliveryTimeCode" : "N",
    "webhookUrl":
"https://your_webhook_url/extTrnBill302",
    "narrative": "Your message here"
}		 RESPONSE BODY
{
    "requestId":
"16086ed0797511eeb5658f28ab5fe311",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "",
            "schemaPath": "#/oneOf/0/required",
            "keyword": "required",
            "params": {
                "missingProperty": "legalName"
            },
            "message": "must have required property
'legalName'"
        },
        {
            "instancePath": "/amount",
            "schemaPath":
"common#/definitions/amount/exclusiveMinimum"
,
            "keyword": "exclusiveMinimum",
            "params": {
                "comparison": ">",
                "limit": 0
            },
            "message": "must be > 0"
        },
        {
            "instancePath": "",
            "schemaPath": "#/oneOf",
            "keyword": "oneOf",
            "params": {
                "passingSchemas": null
            },
            "message": "must match exactly one schema in oneOf"
        }
    ]
}
400 transfer-to/bills/initiate rppsBillerNotFound Error REQUEST BODY
{
  "amount": 7.15,
  "currency": "USD",
  "reference": "extTrnBill302",
  "billerId": "123456789",
  "accountNumberEncrypted":
"cM+tJN2eJ8mjMRbBVruQ4Y6lAm8wfJ8q9p+JMnsbBfou
NfNXGZXDAtSwKQCP0tF/xS1bH1OxW74adeMHebZ/s+wy4
icqF/vt5ncPdw/ZYUNuQpqBIWDQGnFrWje19sNpwPup65
BXMQ2MVYR8YURdQ7luukrU1hFIcNZ02iLNmeWScOloPXq
nInspTmKaArk+G8WiK7iiAmCjJzyHlIJxLVbj+5cg/d5D
LjItPp34LsmBtSCwHEtdlpN0bC78JQy96AkpEWnacnFG7
Da+9e5ZBRMRbvrldkJHtM8uqErxV/1ZB1rPy91yq4jhkn
yyrpauZFCZSlsnFfaXtiexO0I7kg==",
  "firstName": "Joe",
  "lastName": "Doe",
    "deliveryTimeCode" : "N",
    "webhookUrl":
"https://your_webhook_url/extTrnBill302",
    "narrative": "Your message here"
}		 RESPONSE BODY
{
    "requestId":
"361f691081a111ee9b7427220cc6c212",
    "code": "rppsBillerNotFound",
    "context": {
        "billerId": "123456789"
    },
    "message": "Biller was not found or has been
archived."
}
400 transfer-to/bills/initiate transactionReference Error REQUEST BODY
{
  "amount": 7.15,
  "currency": "USD",
  "reference": "extTrnBill302",
  "billerId": "9000005588",
  "accountNumberEncrypted":
"cM+tJN2eJ8mjMRbBVruQ4Y6lAm8wfJ8q9p+JMnsbBfou
NfNXGZXDAtSwKQCP0tF/xS1bH1OxW74adeMHebZ/s+wy4
icqF/vt5ncPdw/ZYUNuQpqBIWDQGnFrWje19sNpwPup65
BXMQ2MVYR8YURdQ7luukrU1hFIcNZ02iLNmeWScOloPXq
nInspTmKaArk+G8WiK7iiAmCjJzyHlIJxLVbj+5cg/d5D
LjItPp34LsmBtSCwHEtdlpN0bC78JQy96AkpEWnacnFG7
Da+9e5ZBRMRbvrldkJHtM8uqErxV/1ZB1rPy91yq4jhkn
yyrpauZFCZSlsnFfaXtiexO0I7kg==",
  "firstName": "Joe",
  "lastName": "Doe",
    "deliveryTimeCode" : "N",
    "webhookUrl":
"https://your_webhook_url/extTrnBill302",
    "narrative": "Your message here"
}		 RESPONSE BODY
{
    "requestId":
"4c10ef0081a111ee9b7427220cc6c212",
    "code": "transactionReference",
    "context": {
        "reference": "extTrnBill302",
        "status": "Initiated",
        "cFiAggregatorId": "CLIENTID",
        "cFiTransactionId":
"CLIENTID_2gNM0PqrmYsdjuqvY6RV51",
        "amount": 7.15
    },
    "message": "Entered reference exists for a
different transaction."
}
400 transfer-to/bills/initiate rppsAccountNumber Error REQUEST BODY
{
  "amount": 7.15,
  "currency": "USD",
  "reference": "extTrnBill302",
  "billerId": "9000005588",
  "accountNumberEncrypted":
"cM+tJN2eJ8mjMRbBVruQ4Y6lAm8wfJ8q9p+JMnsbBfou
NfNXGZXDAtSwKQCP0tF/xS1bH1OxW74adeMHebZ/s+wy4
icqF/vt5ncPdw/ZYUNuQpqBIWDQGnFrWje19sNpwPup65
BXMQ2MVYR8YURdQ7luukrU1hFIcNZ02iLNmeWScOloPXq
nInspTmKaArk+G8WiK7iiAmCjJzyHlIJxLVbj+5cg/d5D
LjItPp34LsmBtSCwHEtdlpN0bC78JQy96AkpEWnacnFG7
Da+9e5ZBRMRbvrldkJHtM8uqErxV/1ZB1rPy91yq4jhkn
yyrpauZFCZSlsnFfaXtiexO0I7kg==",
  "accountNumber": "123456789",
    "firstName": "Joe",
  "lastName": "Doe",
    "deliveryTimeCode" : "N",
    "webhookUrl":
"https://your_webhook_url/extTrnBill302",
    "narrative": "Your message here"
}		 RESPONSE BODY
{
    "requestId":
"786de5d081a111ee9b7427220cc6c212",
    "code": "rppsAccountNumber",
    "message": "Need to send only one of accountNumber
or accountNumberEncrypted."
}
400 transfer-to/bills/cancel rppsBillStatus Error REQUEST BODY
{
  "cFiTransactionId":
"evolve_TbF8Zve81HWYfmmlT3ASR",
    "description": "Cancelling a transaction"
}		 RESPONSE BODY
{
    "requestId":
"d8439300f72211ee839d8a066d814b12",
    "code": "rppsBillStatus",
    "context": {
        "cFiTransactionId":
"evolve_TbF8Zve81HWYfmmlT3ASR"
    },
    "message": "This transaction does not have a valid
status for the requested action."
}
400 transfer-to/bills/execute requestValidateError - Must not have fewer than minimum characters REQUEST BODY
{
  "cFiTransactionId": ""
}		 RESPONSE BODY
{
    "requestId":
"df3ff7f0797511eeb5658f28ab5fe311",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "/cFiTransactionId",
            "schemaPath":
"common#/definitions/id/minLength",
            "keyword": "minLength",
            "params": {
                "limit": 1
            },
            "message": "must NOT have fewer than 1 characters"
        }
    ]
}
400 transfer-to/bills/execute requestValidateError - Missing required property REQUEST BODY
{
}		 RESPONSE BODY
{
    "requestId":
"72d975e0797611eeb5658f28ab5fe311",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "",
            "schemaPath": "#/required",
            "keyword": "required",
            "params": {
                "missingProperty": "cFiTransactionId"
            },
            "message": "must have required property
'cFiTransactionId'"
        }
    ]
}
400 transfer-to/bills/execute billNotFound Error REQUEST BODY
{
  "cFiTransactionId": "unknownId"
}		 RESPONSE BODY
{
    "requestId":
"9da99b0081a111ee9b7427220cc6c212",
    "code": "billNotFound",
    "context": {
        "cFiTransactionId": "unknownId"
    },
    "message": "Bill not found."
}
400 transfer-to/bills/execute rppsBillStatus Error REQUEST BODY
{
  "cFiTransactionId":
"CLIENTID_3uyExblcBiwbG6yQYDkDtw"
}		 RESPONSE BODY
{
    "requestId":
"c7dd222081a111ee9b7427220cc6c212",
    "code": "rppsBillStatus",
    "context": {
        "cFiTransactionId":
"CLIENTID_3uyExblcBiwbG6yQYDkDtw",
        "cFiAggregatorId": "CLIENTID",
        "entityStatus": "Sent"
    },
    "message": "This transaction does not have a valid
status for the requested action."
}
400 transfer-to/bills/query requestValidateError - Must not have fewer than allowed minimum characters REQUEST BODY
{
  "cFiTransactionIds": [
"CLIENTID_3uyExblcBiwbG6yQYDkDtw","" ]
}		 RESPONSE BODY
{
    "requestId":
"548de030797611eeb5658f28ab5fe311",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "/cFiTransactionIds/1",
            "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 transfer-to/bills/query requestValidateError - Must not have fewer than allowed minimum items REQUEST BODY
{
  "cFiTransactionIds": [  ]
}		 RESPONSE BODY
{
    "requestId":
"82b2ecd0797611eeb5658f28ab5fe311",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "/cFiTransactionIds",
            "schemaPath":
"#/oneOf/0/properties/cFiTransactionIds/minIt
ems",
            "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 transfer-to/bills/query requestValidateError - Must not have both references and cFiTransactionIds REQUEST BODY
{
    "cFiTransactionIds": [
"CLIENTID_3uyExblcBiwbG6yQYDkDtw","CLIENTID_7
aPxTlvNmzwPZKZEQSXGIW" ],
  "references": [
"extTrnBill403","extTrnBill300" ]
}		 RESPONSE BODY
{
    "requestId":
"abae839081a211ee9b7427220cc6c212",
    "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 transfer-to/bills/query requestValidateError - Must not have more than max items REQUEST BODY
{
  "cFiTransactionIds": [
"CLIENTID_3uyExblcBiwbG6yQYDkDtw","CLIENTID_7
aPxTlvNmzwPZKZEQSXGIW","CLIENTID_3uyExblcBiwb
G6yQYDkDtw","CLIENTID_7aPxTlvNmzwPZKZEQSXGIW"
,"CLIENTID_3uyExblcBiwbG6yQYDkDtw","CLIENTID_
7aPxTlvNmzwPZKZEQSXGIW","CLIENTID_3uyExblcBiw
bG6yQYDkDtw","CLIENTID_7aPxTlvNmzwPZKZEQSXGIW
","CLIENTID_3uyExblcBiwbG6yQYDkDtw","CLIENTID
_7aPxTlvNmzwPZKZEQSXGIW","CLIENTID_3uyExblcBi
wbG6yQYDkDtw","CLIENTID_7aPxTlvNmzwPZKZEQSXGI
W","CLIENTID_3uyExblcBiwbG6yQYDkDtw","CLIENTI
D_7aPxTlvNmzwPZKZEQSXGIW","CLIENTID_3uyExblcB
iwbG6yQYDkDtw","CLIENTID_7aPxTlvNmzwPZKZEQSXG
IW","CLIENTID_3uyExblcBiwbG6yQYDkDtw","CLIENT
ID_7aPxTlvNmzwPZKZEQSXGIW","CLIENTID_3uyExblc
BiwbG6yQYDkDtw","CLIENTID_7aPxTlvNmzwPZKZEQSX
GIW","CLIENTID_3uyExblcBiwbG6yQYDkDtw","CLIEN
TID_7aPxTlvNmzwPZKZEQSXGIW" ]
}		 RESPONSE BODY
{
    "requestId":
"3ad6eec0950a11eea89d7100487c0512",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "/cFiTransactionIds",
            "schemaPath":
"#/oneOf/0/properties/cFiTransactionIds/maxIt
ems",
            "keyword": "maxItems",
            "params": {
                "limit": 20
            },
            "message": "must NOT have more than 20 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 transfer-to/bills/list requestValidateError - Must be an allowed value REQUEST BODY
{
  "dateCreateFrom": "2023-02-01T14:27:33.684Z",
  "dateCreateTo": "2024-05-15T14:27:33.684Z",
    "status": "otherStatus",
    "numberOfRecords": 1000,
    "skipRecords": 0
}		 RESPONSE BODY
{
    "requestId":
"658ceb60797611eeb5658f28ab5fe311",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "/status",
            "schemaPath": "#/properties/status/enum",
            "keyword": "enum",
            "params": {
                "allowedValues": [
                    "Initiated",
                    "Processing",
                    "Sent",
                    "Complete",
                    "Settled",
                    "Declined",
                    "Unknown",
                    "DecryptError"
                ]
            },
            "message": "must be equal to one of the allowed
values"
        }
    ]
}
400 transfer-to/bills/list greaterNumberOfRecords Error REQUEST BODY
{
  "dateCreateFrom": "2023-02-01T14:27:33.684Z",
  "dateCreateTo": "2024-05-15T14:27:33.684Z",
    "status": "Initiated",
    "numberOfRecords": 1001,
    "skipRecords": 0
}		 RESPONSE BODY
{
    "requestId":
"94efcf30797611eeb5658f28ab5fe311",
    "code": "greaterNumberOfRecords",
    "context": {
        "maxNumberOfRecords": 1000
    },
    "message": "The numberOfRecords field is greater
than the request limit"
}
400 transfer-to/bills/summary requestValidateError - Missing required property REQUEST BODY
{
}		 RESPONSE BODY
{
    "requestId":
"a5dd0010797611eeb5658f28ab5fe311",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "",
            "schemaPath": "#/required",
            "keyword": "required",
            "params": {
                "missingProperty": "date"
            },
            "message": "must have required property 'date'"
        }
    ]
}
400 transfer-to/bills/summary requestValidateError - Must match pattern REQUEST BODY
{
  "date": "10-12-2023"
}		 RESPONSE BODY
{
    "requestId":
"6a82986081a311ee9b7427220cc6c212",
    "code": "requestValidateError",
    "context": [
        {
            "instancePath": "/date",
            "schemaPath":
"common#/definitions/dateOnly/pattern",
            "keyword": "pattern",
            "params": {
                "pattern": "^\d{4}-\d{2}-\d{2}$"
            },
            "message": "must match pattern
\"^\d{4}-\d{2}-\d{2}$\""
        }
    ]
}