Get Started

Table - General Error Codes

any resource
Bad request' indicates that a request is not accepted due to validation error. Specific error code and optional DeveloperMessage will indicate a specific reason. This is based on the updates to the HTTP specification.
                              400 Bad Request
Indicates that requested resource is not available
                              404 Not Found
Indicates that request is not authenticated
                              401 Unauthorized
Indicates that request is not authorized or that request is understood, but it has been refused or access is not allowed. Specific error code and optional DeveloperMessage will indicate a specific reason
                              403 Forbidden
{"errorId":"<GUID like value>",
If during processing a request an internal error has occurred, API will respond with genetic 500 HTTP status code and optionally might provide error reference (errorId) to be communicated to API support for the investigation and an optional DeveloperMessage
                              500 Internal Server Error
{"errorId":"<GUID like
any resource POST
Used to create new resource on MassPay side. It's expected that request won't have resource ID as it will be generated and that a response will have ID or IDs of created resources. Examples of resources created by POST are quote and order.

201 Created{<resource specific payload>}

any resource PUT
Used to submit existing on a caller side resource to MassPay. It's expected that request will include resource ID. For new ID a resource will saved on MassPay side as submitted. For existing ID, resource's data will be updated with the submitted data assuming resource state allows an update. Examples of resources pushed to MassPay batch and payment.
                              200 OK
{<resource specific
any resource GET
GET method can support additional filter parameters (where specified by GET definition for a resource):

fields : allows to specify which defined for resource fields should be included into the resource representation; comma separated list of fields.

For complex structure, dotted notation should be used, like''.

Resource's 'id' field and value will always be returned (can't be omitted).

status : allows to filter output collection of resources by specific resource status;

ids : allows to specify resources should be returned by providing their Ids, in a comma separated format; if a resource is not found by id value, 'NotFound' status will be returned for a specified id;

sortBy: allows to sort output resources by a submitted resource field in ascending (default) or descending order. Default sort is by resource ID value in ascending order.

extend: request to extend resource's with additional details (or with another resource)

/ping GET

Ping resource is not defined as a separate resource but it's supported and can be used to test connectivity

                              200 OK
"<developer message>"
isSuccessful: <true/false
serverUtcTime: "<timestamp>"