Transaction History
Transaction history provides the ability to retrieve a list of all transactions that have been processed.
get
https://apps.zapper.com
/api/v1/merchants/{merchantId}/payments
Get List Payment History by Date range
get
https://apps.zapper.com
/api/v1/merchants/{merchantId}/payments/{zapperId}
Get Payment by Merchant Id and Zapper ID
FIeld | DataType | Description |
merchantId | number | The ID of the Merchant (MID) |
merchantName | string | Name of merchant |
merchantSiteId | number | The ID of the site where the transaction was made |
transactionUTCDate | string | UTC Date and time of the transaction |
paymentReference | string | Zapper's payment reference (Zapper ID) |
customer | string | Name of the customer who made the transaction |
currencySymbol | string | The currency symbol that was paid by the customer |
currencyISOCode | string | The currency ISO code that was paid by the customer |
paymentStatus | string | The outcome of the payment |
invoicedAmount | decimal | The amount of the bill (Bill Amount) |
customerInvoicedAmount | decimal | The amount the customer is electing to pay to the merchant(Customer Bill Amount) |
tipAmount | decimal | The tip amount paid by the customer |
serviceChargeAmount | number | An additional amount added to a bill by a merchant |
redeemedVouchers | A list of redeemed vouchers amounts and who is liable respectively | |
processedAmount | decimal | The amount that was processed by Zapper on behalf of the merchant |
customerPaidAmount | decimal | The Amount that goes off the customer payment methods (excluding vouchers) |
processingFeeAmount | number | The processing fee that was charged by Zapper for the transaction |
processingPercentageFee | decimal | The percentage rate charged by Zapper for processing the transaction |
processingFixedFee | decimal | The fixed amount charged by Zapper for processing the transaction |
processingFeeTax | decimal | The Tax amount that is included in the processing fee |
settlementAmount | decimal | The amount that was settled to the merchant for the transaction |
settlementStatus | Status to indicate whether the transaction has been settled to the merchant | |
settlementUTCDate | string | UTC date that the transaction was settled to a merchants account |
paymentMethodType | The type of payment used by the customer (Payment Method) | |
invoiceExternalReference | string | Merchant's invoice reference |
externalTransactionId | string | The brand id of the payment gateway. |
invoiceReference | string | A Unique identifier that is sent by the merchant |
otherReferences | Custom fields that are completed by merchants customers |
Field | DataType | Description |
name | string | Name of the voucher that was redeemed |
amount | decimal | The amount that was redeemed |
liable | string | liability of the redeemed voucher (zapper | merchant) |
Field | DataType | Description |
name | string | The name of the reference |
value | string | The value of the reference |
Value | Description |
pending | The payment not yet settled |
settled | The payment has been settled to the merchant |
void | The transaction has been void |
not applicable | The payment is not applicable for settlement (processing | Failed) |
Value | Description |
mastercard | The type of payment used by the customer |
visa | The type of payment used by the customer |
voucher | The voucher is used as the payment method |
external | The payment was processed by an external entity |
Last modified 1mo ago