Formats

JSON or XML

The gateway accepts and answers both. It answers in JSON by default, and in XML to callers that speak XML, deciding in this order:

?format=json or ?format=xml on the request.
An Accept header naming only one of them.
The format of the request body.
JSON.

JSON uses camelCase member names and leaves empty ones out:

{ "respStat": "A", "retRef": "277127012209", "amount": "2.40", "tipAmount": "0.40" }

The same in XML:

<AuthCardResponse><RespStat>A</RespStat><RetRef>277127012209</RetRef><Amount>2.40</Amount><TipAmount>0.40</TipAmount></AuthCardResponse>

Send JSON with Content-Type: application/json, XML with application/xml.

Results

`respStat`	Meaning
`A`	Approved
`B`	Retry
`C`	Declined
`E`	Error, with the reason in `respMessage`

Errors use the same shape, so the register can show why:

{ "respStat": "E", "respMessage": "POS Gateway isn't turned on at Main Street." }

HTTP	When
`200`	Any answer above, including declines and errors.
`400` (no body)	A required field is missing.
`401`	The key is unknown, wrong or revoked.
`429`	Too many requests from one address (more than 120 a minute).

A customer cancelling on the terminal answers Operation cancelled by customer. Every response names the gateway version that handled it in the X-Mojo-Gateway-Version header.

Get started

POS Gateway API

Mojo Payments CLI

POS guides

JSON or XML

Results

​JSON or XML

​Results

JSON or XML

Results