Skip to main content
If you have configured callbacks, PawaPay will POST a callback to your configured callback URL for each refund when it reaches a final status. Read more about handling callbacks and callback URLs. If you have not configured callbacks, you can always call our Check Refund Status endpoint to get the latest status and details of a specific refund request.

​
Headers

Following headers are only included if you have enabled signed callbacks.Read more about how to implement signed callbacks.
​
string
SHA256 or SHA-512 hash of the request body.
​
String
Signature of the request according to RFC-9421.
​
String
Signature input according to RFC-9421.
​
String
Timestamp when signature was created. This is a custom field and is not part of RFC-9421.
​
String
Expected signature algorithm of the response according to RFC-9421.
​
String
Expected digest algorithm of the response according to RFC-9421.

​
Body

​
refundId
string<uuid>
required

A UUIDv4 based ID specified by you, that uniquely identifies the refund.

Required string length: 36
Example:

"f4401bd2-1568-4140-bf2d-eb77d2b2b639"

​
status
enum<string>
required

The final status of the payment.

  • COMPLETED - The payment has been successfully processed.
  • FAILED - The payment request has been processed, but failed.
Available options:
COMPLETED,
FAILED
​
amount
string
required

The amount to be collected (deposit) or disbursed (payout or refund).

Amount must follow below requirements or the request will be rejected:

  • Between zero and two decimal places can be supplied, depending on what the specific MMO supports. Learn about all MMO supported decimal places.
  • The minimum and maximum amount depends on the limits of the specific MMO. You can find them from the Active Configuration endpoint.
  • Leading zeroes are not permitted except where the value is less than 1. For any value less than one, one and only one leading zero must be supplied.
  • Trailing zeroes are permitted.

Valid examples: 5, 5.0, 5.00, 5.5, 5.55, 5555555, 0.5

Not valid examples: 5., 5.555, 5555555555555555555, .5, -5.5, 00.5, 00.00, 00001.32

Required string length: 1 - 23
Pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
Example:

"15"

​
currency
string
required

The currency in which the amount is specified.

Format must be the ISO 4217 three character currency code in upper case. Read more from Wikipedia.

You can find all the supported currencies that the specific correspondent supports from here.

The active configuration endpoint provides the list of correspondents configured for your account together with the currencies.

Example:

"ZMW"

​
country
string
required

The country in which the MMO operates.

Format is ISO 3166-1 alpha-3, three character country code in upper case. Read more from Wikipedia.

Example:

"ZMB"

​
correspondent
string
required

The correspondent code refers to the specific MMO that the specified phone number (MSISDN) has an active mobile money wallet with.

You can find all the supported correspondents listed here.

The active configuration endpoint provides the list of correspondents configured for your account.

You can use the predict correspondent enpoint to predict the correct correspondent to use based on the phone number (MSISDN).

Example:

"MTN_MOMO_ZMB"

​
recipient
object
required

The phone number (MSISDN) of the recipient or payer must be specified as the value of the address.

​
customerTimestamp
string<date-time>
required

The timestamp for when you initiated the refund process. Format defined by 'date-time' in RFC3339 section 5.6 from IETF

Example:

"2020-02-21T17:32:28Z"

​
created
string<date-time>
required

The timestamp of when the refund was created in the PawaPay platform. Format defined by 'date-time' in RFC3339 section 5.6 from IETF

Example:

"2020-02-21T17:32:29Z"

​
statementDescription
string

Short description for the transaction. Depending on the specific MMO performing the transaction this message may be visible to the customer in the SMS receipt or within their transaction history.

Must be between 4 and 22 alphanumeric characters.

Required string length: 4 - 22
Pattern: ^[a-zA-Z0-9 ]+$
Example:

"Note of 4 to 22 chars"

​
receivedByRecipient
string<date-time>

When the payment was received by the recipient. Format defined by 'date-time' in RFC3339 section 5.6 from IETF

Example:

"2020-02-21T17:32:30Z"

​
correspondentIds
object

The financial ids used by the MMO to uniquely identify this payment

Example:
​
failureReason
object
​
metadata
object

The metadata that was provided in the original initation request in a JSON object format.

Example: