Results Object

The result object is a common object that will be present on every API response and provides a standardised way to identify the status of your API call.

The result object contains a status object that represents the current status of the request, and a codes array that provides specific details relating to the status.

Below is a table of each status value and a brief description of what it means.

status	HTTP Code	description
ok	200	Used in non-transaction requests to indicate the request was completed successfully.
pending	200	The resource creation was completed, however it is part of an asynchronous process that has not finished in full. An updated status can be queried using the Id, or received via webhooks.
approved	200	The transaction was processed successfully and approved.
declined	200	The transaction was declined by the banking network.
validation_error	400	The API request made by the client has validation issues and cannot be processed.
system_error	500	A system error occurred when processing the request and it could not be completed.
Forbidden	403	A 403 Forbidden HTTP response will be returned when you attempt to access a resource without valid authentication. When this happens an empty body will be returned.
Not Found	404	A 404 Not Found HTTP response will be returned when you attempt to retrieve a resource that cannot be found. When this happens an empty body will be returned.

"result": {
    "status": "ok"
}

"result": {
    "status": "pending"
}

"result": {
    "status": "approved"
}

"result": {
    "status": "declined",
    "codes": [
        {
            "id": "D10002",
            "message": "target_account_blocked"
        }
    ]
}

"result": {
    "status": "validation_error",
    "codes": [
        {
            "id": "V10004",
            "message": "body_reference_invalid"
        }
    ]
}

"result": {
    "status": "system_error",
    "codes": [
        {
            "id": "S10000",
            "message": "system_error"
        }
    ]
}