Refunds

Refund Request API

To request for a Zapper refund, the Zapper ID (unique Zapper payment identifier) is required. The Zapper ID may be obtained in 1 of 2 ways:

  1. Zapper provides the Zapper ID in the body of a payment notification. An integration may store the Zapper ID against the payment and retrieve it if necessary for the refund request.

  2. The Customer may be asked to provide the Zapper ID referring to the "Payment History" on the Zapper application.

post
Refunds

https://api.zapper.com/business/api/v1/merchants/{merchantId}/refunds
This endpoint allows you to request a Zapper refund on the customer's behalf.
Request
Response
Request
Path Parameters
merchantId
required
string
The merchant identifier.
Headers
Authorization
required
string
Bearer <integration authentication token>
Query Parameters
zapperId
required
string
The Zapper payment identifier
Body Parameters
invoiceCreatedUTCDate
optional
string
The UTC date when the invoice was created.
invoiceExternalReference
optional
string
The external reference for an invoice (e.g. The merchant's invoice reference)
origin Reference
optional
string
The unique identifier for the integration
origin
optional
string
The integration source (e.g the name of the integration/POS/store to help identify the integration)
amount
required
string
The refund amount being requested in cents (must not exceed the processed amount)
Response
200: OK
Refund request successful.
400: Bad Request
Invalid Zapper ID or amount requested is greater than processed amount
403: Forbidden
Authorization token not provided or invalid
{
"Message": "User is not authorized to access this resource with an explicit deny"
}
500: Internal Server Error
Internal Server Error