API Reference and Guides

Status Codes & Error Messages

HTTP status codes

HTTP codes sent from the Send Payments API can be any of the standard HTTP status codes, but generally they will be from the following subset of codes.

Errors

Error responses generally include a body with the following schema:

Body parameter key (JSON)

Underlying data type

Description

message	String	Human readable description of the HTTP error response.
errors	Array[Object]	An array of error objects.
error/message	String	Human readable description of the specific error object. Where the key value must be a value from an Enum or a List, then the message will include the allowed values.
error/type	Enum	The type name of the error object.
error/field (Only present for ValidationErrors)	String	The name of the key that does not pass the validation requirement.

Example error message

JSON

 {
  "message": "Request contained errors",
  "errors": [
    {
      "field": "body.physicalAddress.country(Errors of type ValidationError only)",
      "message": "body.physicalAddress.country must be one of the following values: AU, GG, MC, AT, HK, NL, BE, HU, NZ, BG, IS, NO, CA, IN, PL, KY, IE, PT, CN, IM, HR, IL, RO, CY, IT, SG, CZ, JP, SK, DK, JE, SI, EE, KR, ZA, FI, LV, ES, FR, LI, SE, GF, LT, CH, DE, LU, TW, GI, MT, GB, GR, MQ, GP",
      "type": "ValidationError"
    },
    {
        "message": "body.termsAndConditionsAccepted is a required field",
        "field": "body.termsAndConditionsAccepted",
        "type": "ValidationError"
    },
    {
        "message": "body has unspecified keys: statusCode",
        "field": "body",
        "type": "ValidationError"
    }
  ]
}

Data validation errors

The body of each request sent to our system is checked for validity before we attempt to process it. Some of the checks we do are:

Checking data types.
Checking Enum and List values.
Checking that required or conditionally required keys are present.
Checking for keys that should not be present.

200

Response to successful GET request.

201

Created

Response to successful POST request - New resource created. The body parameter of the response will include the newly created resource.

204

No Content

Response to successful DELETE request - The resource specified in the request has been successfully deleted. The body parameter of the response will NOT include the deleted resource.

400

Bad Request

Response to invalid POST request - The new resource has NOT been created. The body parameter of the response will NOT include the specified resource from the request but will include the details of the error(s) that caused the request to fail.

401

Unauthorized

Indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.

404

Not Found

Response to an unsuccessful GET request or POST request that includes a specific target resource. e.g. Where the target resource does not exist or is hidden by the server.

422

Unprocessable Entity

Response to a valid but unsuccessful POST request (ie due to business rule violation) - The new resource has NOT been created. The body parameter of the response will NOT include the specified resource from the request but will include the details of the error(s) that caused the request to fail.

409

Conflict

The request could not be completed due to a conflict with the current state of the target resource. e.g. Where the resource already exists.

500

Internal Server Error

The server encountered an unexpected condition that prevented it from fulfilling the request.

Sections

Status Codes & Error Messages

HTTP status codes

Errors

Data validation errors

Not Seeing What You're Looking For?

What made this section unhelpful for you?

Status Codes

What made this section unhelpful for you?