API Error Codes

What each prefix means

Use this table to know what each code prefix represents and what to do when you receive one.

Prefix	Category	What to do
NAUT-	Authentication or authorization failure	Refresh your credentials and retry. If the failure repeats, check your client ID/secret and tenant configuration.
SCHM-	Request schema validation failure	Fix the offending field (location is in the field value) and retry.
RULE-	Business rule violation	Do not retry as-is. Review the rule named in the error description and adjust the request.
SRVR-	Transient server error	Retry with exponential backoff. If it persists, contact support with the code and request ID.

Auth

Code	Description
NAUT-00001	Token validation failed: invalid or malformed token.
NAUT-00002	Token validation failed: token cannot be used on production endpoints.
NAUT-00003	Token validation failed: token cannot be used on sandbox endpoints.
NAUT-00004	Authentication failed: Invalid client credentials provided.
NAUT-00005	Authorization failed: Tenant security attributes are inactive.
NAUT-00006	Authorization failed: Tenant account is currently paused.
NAUT-00007	Authorization failed: Tenant is not subscribed to this product.
NAUT-00008	Authorization failed: Insufficient permissions for this operation.
SRVR-00001	An internal error occurred. Please retry later or contact support if needed.

Accounts

Code	Description
RULE-10001	No accounts found for the specified tenant and region.
RULE-10002	Account identifier not found for the specified tenant and region.
RULE-10003	accountIdentifier.type and accountIdentifier.value must be provided together; the same applies to branchIdentifier.type and branchIdentifier.value.
SCHM-10001	The request did not match the API schema.
SCHM-10002	A required field is missing from the request.
SCHM-10003	The field value does not match the required format.
SCHM-10004	The field value is shorter than the minimum length.
SCHM-10005	The field value exceeds the maximum length.
SCHM-10006	The numeric value is outside the allowed range.
SCHM-10007	The field value is not in the set of allowed values.
SCHM-10008	The field value is rejected by the schema.
SRVR-10001	An internal error occurred. Please retry later or contact support if needed.

Transactions

Code	Description
SCHM-20001	The request did not match the API schema.
SCHM-20002	A required field is missing from the request.
SCHM-20003	The field value does not match the required format.
SCHM-20004	The field value is shorter than the minimum length.
SCHM-20005	The field value exceeds the maximum length.
SCHM-20006	The numeric value is outside the allowed range.
SCHM-20007	The field value is not in the set of allowed values.
SCHM-20008	The field value is rejected by the schema.
SRVR-20001	An internal error occurred. Please retry later or contact support if needed.

Counterparties

Code	Description
RULE-30001	Counterparty reference already exists for this tenant.
RULE-30002	Counterparty not found for the specified reference.
RULE-30003	Counterparty state must be ACTIVE to perform this operation.
RULE-30004	When 'accountType' is 'BANK_ACCOUNT', fields 'country', 'currency', and 'branchIdentifier' are required.
RULE-30005	The 'branchIdentifier.type' is not valid for the account 'currency' (EUR requires 'BIC', GBP requires 'SORT', USD requires 'ROUTING', INR requires 'IFSC').
RULE-30006	When 'currency' is 'INR', 'branchIdentifier.type' must be 'IFSC'.
RULE-30007	When 'currency' is 'USD', 'branchIdentifier.type' must be 'ROUTING'.
RULE-30008	The 'accountIdentifier.type' is not valid for the account 'currency' (EUR requires 'IBAN'; GBP and USD require 'ID').
RULE-30009	When 'currency' is 'INR' or 'USD', 'accountIdentifier.type' must be 'ID'.
RULE-30010	Duplicate account in request body: 'accountIdentifier.type' and 'value' combination appears more than once.
RULE-30011	'accountIdentifier.type' and 'accountIdentifier.value' must be supplied together.
RULE-30012	'branchIdentifier.type' and 'branchIdentifier.value' must be supplied together.
SCHM-30001	The request did not match the API schema.
SCHM-30002	A required field is missing from the request.
SCHM-30003	The field value does not match the required format.
SCHM-30004	The field value is shorter than the minimum length.
SCHM-30005	The field value exceeds the maximum length.
SCHM-30006	The numeric value is outside the allowed range.
SCHM-30007	The field value is not in the set of allowed values.
SCHM-30008	The field value is rejected by the schema.
SRVR-30001	An internal error occurred. Please retry later or contact support if needed.

Payouts

Code	Description
RULE-40001	A payout link or counterparty already exists for the supplied identifier / reference.
RULE-40002	Account identifier not found for the specified tenant and region.
RULE-40004	Payout link ID not found.
RULE-40005	Counterparty not found by reference.
RULE-40006	Counterparty state must be ACTIVE.
RULE-40007	Target counterparty has no active accounts linked.
RULE-40009	Payout link ID to cancel was not found.
RULE-40011	Payout link ID not found.
RULE-40012	UK payouts are available in sandbox only.
RULE-40013	The supplied accountHolderName does not match the counterparty on record for this counterpartyReference.
RULE-40014	verificationAttempts must not be provided when accountVerificationOption is NO_VERIFICATION.
SCHM-40001	The request did not match the API schema.
SCHM-40002	A required field is missing from the request.
SCHM-40003	The field value does not match the required format.
SCHM-40004	The field value is shorter than the minimum length.
SCHM-40005	The field value exceeds the maximum length.
SCHM-40006	The numeric value is outside the allowed range.
SCHM-40007	The field value is not in the set of allowed values.
SCHM-40008	The field value is rejected by the schema.
SRVR-40001	An internal error occurred. Please retry later or contact support if needed.
SRVR-40002	An internal error occurred. Please retry later or contact support if needed.
SRVR-40003	An internal error occurred. Please retry later or contact support if needed.
SRVR-40005	An internal error occurred. Please retry later or contact support if needed.

Mandates

Code	Description
RULE-50001	The tenant has not completed the SEPA mandate setup required before mandates can be created.
RULE-50002	The supplied creditor identifier does not match a creditor configured for this tenant.
RULE-50003	The supplied creditor name does not match the registered creditor for this tenant.
RULE-50004	The requested status is inconsistent with the start date: APPROVED requires a future startDate, ACTIVE requires a startDate of today.
RULE-50005	The mandate schedule is invalid: the start date is in the past, or the type/amount combination is not allowed for the requested scheduling.
RULE-50006	The mandate is not in a state that permits this operation (already cancelled, already expired, or not active).
RULE-50007	A mandate with this mandateReference already exists for the tenant.
RULE-50008	The referenced counterparty or account could not be found for the tenant.
SCHM-50001	The request did not match the API schema.
SCHM-50002	A required field is missing from the request.
SCHM-50003	The field value does not match the required format.
SCHM-50004	The field value is shorter than the minimum length.
SCHM-50005	The field value exceeds the maximum length.
SCHM-50006	The numeric value is outside the allowed range.
SCHM-50007	The field value is not in the set of allowed values.
SCHM-50008	The field value is rejected by the schema.
SRVR-50001	An internal error occurred. Please retry later or contact support if needed.

Direct Debit

Code	Description
RULE-60001	A direct-debit collection with this collectionReference already exists for the tenant.
RULE-60002	The referenced mandate is not in a state that permits collections (not found, not active, cancelled, or expired).
RULE-60003	The collectionDate is not valid for the mandate (before its start date, after its end date, or in the past).
RULE-60004	The requested sequenceType is not allowed for this mandate's type or current state.
RULE-60005	amountMin cannot be greater than amountMax.
RULE-60006	initiatedFrom must be less than or equal to initiatedTo.
SCHM-60001	The request did not match the API schema.
SCHM-60002	A required field is missing from the request.
SCHM-60003	The field value does not match the required format.
SCHM-60004	The field value is shorter than the minimum length.
SCHM-60005	The field value exceeds the maximum length.
SCHM-60006	The numeric value is outside the allowed range.
SCHM-60007	The field value is not in the set of allowed values.
SCHM-60008	The field value is rejected by the schema.
SRVR-60001	An internal error occurred. Please retry later or contact support if needed.

Bills

Code	Description
RULE-70001	A bill with this uniqueReferenceIdentifier already exists for the tenant.
RULE-70002	A linked credit note with this uniqueReferenceIdentifier already exists for the tenant.
RULE-70003	The bill is already VOID and cannot be modified. VOID is a terminal state.
RULE-70004	The bill is PAID and cannot be modified.
RULE-70005	The bill is PROCESSING and cannot be modified while a payment is in progress.
RULE-70006	issueDate must not be later than dueDate.
RULE-70007	Linked credit note issueDate must not be later than its dueDate.
RULE-70008	fromDueDate must not be later than toDueDate.
RULE-70009	openAmount cannot be greater than the bill's existing open amount.
RULE-70010	openAmount must be 0 when status is set to CLOF or VOID.
RULE-70011	status must be CLOF or VOID when openAmount is set to 0.
SCHM-70001	The request did not match the API schema.
SCHM-70002	A required field is missing from the request.
SCHM-70003	The field value does not match the required format.
SCHM-70004	The field value is shorter than the minimum length.
SCHM-70005	The field value exceeds the maximum length.
SCHM-70006	The numeric value is outside the allowed range.
SCHM-70007	The field value is not in the set of allowed values.
SCHM-70008	The field value is rejected by the schema.
SRVR-70001	An internal error occurred. Please retry later or contact support if needed.