After submitting a call, you receive a response message to inform you that your request was received and processed.
Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.
HTTP Responses
200 - OK The request has succeeded.
Show more Show less The unique identifier of the webhook setting.
The status of the webhook setting. Possible values:
active : You receive a balance webhook if any of the conditions in this setting are met.inactive : You do not receive a balance webhook even if the conditions in this settings are met. The resource about whose balance change you want to get notified.
Show children Hide children
The unique identifier of the target.type. This can be the ID of your:
balance platform
account holder
account holder's balance account
The resource for which you want to receive notifications. Possible values:
balancePlatform : receive notifications about balance changes in your entire balance platform.
accountHolder : receive notifications about balance changes of a specific user.
balanceAccount : receive notifications about balance changes in a specific balance account.
The type of the webhook setting.
400 - Bad Request A problem reading or understanding the request.
Show more Show less A human-readable explanation specific to this occurrence of the problem.
Unique business error code.
A URI that identifies the specific occurrence of the problem if applicable.
Array of fields with validation errors when applicable.
Show children Hide children
The field that has an invalid value.
Description of the validation error.
The unique reference for the request.
A short, human-readable summary of the problem type.
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
401 - Unauthorized Authentication required.
Show more Show less A human-readable explanation specific to this occurrence of the problem.
Unique business error code.
A URI that identifies the specific occurrence of the problem if applicable.
Array of fields with validation errors when applicable.
Show children Hide children
The field that has an invalid value.
Description of the validation error.
The unique reference for the request.
A short, human-readable summary of the problem type.
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
403 - Forbidden Insufficient permissions to process the request.
Show more Show less A human-readable explanation specific to this occurrence of the problem.
Unique business error code.
A URI that identifies the specific occurrence of the problem if applicable.
Array of fields with validation errors when applicable.
Show children Hide children
The field that has an invalid value.
Description of the validation error.
The unique reference for the request.
A short, human-readable summary of the problem type.
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
404 - Not Found The payment was not found
Show more Show less A human-readable explanation specific to this occurrence of the problem.
Unique business error code.
A URI that identifies the specific occurrence of the problem if applicable.
Array of fields with validation errors when applicable.
Show children Hide children
The field that has an invalid value.
Description of the validation error.
The unique reference for the request.
A short, human-readable summary of the problem type.
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
422 - Unprocessable Entity A request validation error.
Show more Show less A human-readable explanation specific to this occurrence of the problem.
Unique business error code.
A URI that identifies the specific occurrence of the problem if applicable.
Array of fields with validation errors when applicable.
Show children Hide children
The field that has an invalid value.
Description of the validation error.
The unique reference for the request.
A short, human-readable summary of the problem type.
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
500 - Internal Server Error The server could not process the request.
Show more Show less A human-readable explanation specific to this occurrence of the problem.
Unique business error code.
A URI that identifies the specific occurrence of the problem if applicable.
Array of fields with validation errors when applicable.
Show children Hide children
The field that has an invalid value.
Description of the validation error.
The unique reference for the request.
A short, human-readable summary of the problem type.
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.