Get payment

Returns a single payment.

HTTP request

GET https://pos.snapscan.io/merchant/api/v1/payments/{id}

curl -u your-api-key: "https://pos.snapscan.io/merchant/api/v1/payments/1"

The above command returns JSON structured like this:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": 1,
  "status": "completed",
  "date": "1999-12-31T23:00:00Z",
  "totalAmount": 1000,
  "tipAmount": 0,
  "requiredAmount": 1000,
  "snapCode": "STB115",
  "snapCodeReference": "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "userReference": "John Doe",
  "merchantReference": "INV001",
  "statementReference": "SNAPSCAN 20150109",
  "authCode": "123456",
  "extra": null,
  "deviceSerialNumber": "R28K10HBQTX",
  "transactionType": "payment"
}

Route parameters

The id route parameter is required.

Response codes