Message Body Structure

All endpoint request and response bodies are formatted as JSON and follow the REST conventions unless explicitly noted otherwise.

Responses to all HTTP requests except DELETE always contain a data section.

Data section

The data section contains contains the resource data that is the subject of the call. For all API methods except List calls, the data section in responses contains a single resource or a subset of it. For List calls, the data section contains an array of multiple resources along with a count of the total number of resources.

{
    "ok": true,
    "data": {
        "token": "part_cjes76vsemvj3obsnc30",
        "org_id": "org_79580427-c976-40fc-ac02-43e314870e8f",
        "domain": "safepay",
        "name": "Safepay Core Domain",
        "created_at": {
            "seconds": 1692255131
        },
        "updated_at": {
            "seconds": 1692255131
        }
    }
}

ok

This parameter will always be present to indicate whether the request was processed without any errors. Its type is a boolean

data.token

This parameter will always be present and is the unique identifier of the resource that was created or fetched. It is a string composed of two parts concatenated by an underscore. The first part is a short descriptor of the resource while the second part is a unique XID

data.created_at

This parameter is conditionally present and denotes the time in UNIX seconds for when the resource was created

data.updated_at

This parameter is conditionally present and denotes the time in UNIX seconds for when the resource was updated

Errors and Status Codes

The Paylias API supports a number of different HTTP status codes and provides error messages to help you find out why something went wrong when it does.

Paylias uses the following HTTP status codes:

Examples of a response with errors

{
    "code": "error.bad_request",
    "message": "admin_email: cannot be blank."
}

Record Types

The Paylias API supports a number of record types which represent the type of resource for a subscription.

The table below gives an overview of different record types supported by the Paylias API: