Billpay error codes

Error envelope

A failed request usually returns this body:

Error response

{
  "error_type": "PAYEE_ID_INVALID",
  "error_message": "Payee ID Invalid"
}

Field	Description
`error_type`	The type of error
`error_message`	Error description in human-readable form

Error type	Error message	Kind of error
`INVALID_REQUEST`	We can’t process your request	Operative
`INTERNAL_ERROR`	There was an error while processing your request	Operative
`PAYEE_ID_INVALID`	Payee ID Invalid	Operative
`PAYEE_SERVICE_UNAVAILABLE`	Payee service is not available at this time, retry in 5 minutes	Operative
`PAYER_ACCOUNT_INVALID`	Invalid payer account	Operative
`PAYER_ACCOUNT_NOT_FOUND`	Payer account not found for the Payee	Operative
`CANNOT_FULFILL_REQUEST`	We cannot currently fulfill requests for this Payee	Integration
`AMOUNT_INSUFFICIENT`	The Payee minimum amount was not met	Operative
`AMOUNT_FORMAT_INVALID`	The amount format is incorrect	Operative
`TOPUP_AMOUNT_NOT_AVAILABLE`	The Topup amount is not available	Integration
`CURRENCY_INVALID`	The Payee does not accept this currency	Operative
`PAYEE_TIMEOUT`	Payee service is not responding at this time	Integration
`PAYEE_CONNECTION_ERROR`	Error with the Payee connection	Integration
`UPLOAD_FILE_S3_FAILED`	The file upload to s3 bucket failed	Operative

The payee endpoints use different bodies for some errors:

Status	Endpoint	Body
`401`	List Payees, Get Payee Details	`{ "errors": ["Access denied"] }`
`404`	Get Payee Details	`{ "error": "Couldn't find Payee with 'id'=00000000-0000-0000-0000-000000000000" }`