{"reference": "00000000-0000-0000-0000-000000000000","paymentReference": "4G3GR707EW0QZ0G1M0","merchantName": "Zapper Merchant","status": 1,"paymentMethodLabel": "**** 0002","currencyISOCode": "ZAR","invoicedAmount": 1000,"amount": 1000,"tipAmount": 200,"processedAmount": 1200,"modifiedUTCDate": "0001-01-01T00:00:00.000Z","errors": [{"errorReference": 10,"message": "Your transaction has been declined by your bank",}]}
​
{"payments": [{"reference": "00000000-0000-0000-0000-000000000000","invoiceReference": "00000000-0000-0000-0000-000000000000","invoiceExternalReference": "00000000-0000-0000-0000-000000000000","merchantName": "SyliviaBiller548655","currencyISOCode": "ZAR","invoicedAmount": 1000,"paymentReference": "XGKGE3020Q2E8Y4NRD","paymentUTCDate": "2020-10-06T00:00:00.0Z","paymentMethodType": "Card","paymentMethodDescription": "**** 0002","status": "success","tipAmount": 200,"processedAmount": 1200,"customer": {"id": "14c5c567-b062-47ea-b448-06b1a296900a"},"siteReference": "24054","errors": null}],"previousPage": "/v1/payments?customerReference=14c5c567-b062-47ea-b448-06b1a296900a&page=1&pageSize=20","nextPage": "/v1/payments?customerReference=14c5c567-b062-47ea-b448-06b1a296900a&page=3&pageSize=20",}
​
​
Field | DataType | Description |
payments | array | List of payments. |
previousPage | string optional | Link to the previous page. The link is provided when then page number is greater than 1 |
nextPage | string optional | Link to the next page. The link is provided when there a next page. |
Field | DataType | Description |
reference | string | A unique reference for the payment. |
invoiceReference | string optional | Zapper's invoice reference. |
invoiceExternalReference | string optional | Merchant's invoice reference. |
merchantName | string | Merchant name. |
currencyISOCode | string | The Currency ISO code of the invoice. |
invoicedAmount | number | The invoiced amount in cents. |
paymentReference | string | Zapper's payment reference. |
paymentUTCDate | string | The date of the payment. |
paymentMethodType | string | Payment method type for processing the payment. |
paymentMethodDescription | string | The masked value of the payment method. |
status | string | The status of the payment. |
verificationUrl | string optional | The URL to invoke additional verification when the status is 3 - VerificationRequired. |
tipAmount | number | The tip amount paid by the customer in cents. |
processedAmount | number | The amount processed for the request. Including tip. |
customer | object | The customer's details. |
siteReference | string | The identifier of the point of sale till. This is required for the routing of Zapper payments and invoices. |
errors | array | List of errors related to the transaction. |
Value | Description |
processing | The transaction is processing. |
success | The transaction completed successfully. |
failed | The transaction failed during processing. |
verificationRequired | The transaction verification. A URL will be returned in the response. |
Field | Datatype | Required | Description |
id | string | yes | A unique reference for the customer |
firstName | string optional | Yes | Name of the customer. |
lastName | string optional | Yes | Last name of the customer |
Field | Type | Description |
errorReference | string | The error identifier. This value can be quoted when contacting support. |
message | string | The message regarding the error. |