Check refund status

Get the current status of the refund based on its refundId.

Authorizations

Authorization

string

header

required

See Authentication.

Path Parameters

refundId

string<uuid>

required

The id of the refund that you are performing this operation on.

Required string length: 36

Response

Request has been processed by pawaPay

status

enum<string>

required

The result of this operation.

FOUND - The payment was found in pawaPay.
NOT_FOUND - The payment was not found in pawaPay.

Available options:

FOUND,

NOT_FOUND

data

object

Show child attributes

data.refundId

string<uuid>

required

The unique ID for this payment in pawaPay as specified by you during initiation.

Required string length: 36

Example:

"f4401bd2-1568-4140-bf2d-eb77d2b2b639"

data.status

enum<string>

required

Possible refund statuses:

ACCEPTED - The refund has been accepted by pawaPay for processing.
ENQUEUED - The refund has been accepted, but has been enqueued for processing later. Read more about enqueued refunds.
PROCESSING - The refund has been submitted to the provider and is being processed.
IN_RECONCILIATION - The refund is being reconciled currently to determine it's final status.
COMPLETED - The refund has been successfully processed. This is a final status.
FAILED - The refund has been processed, but failed. This is a final status.. See failureReason for details.

Available options:

ACCEPTED,

ENQUEUED,

PROCESSING,

IN_RECONCILIATION,

COMPLETED,

FAILED

data.amount

string

required

The amount of the payment.

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

Not all providers support decimals. Find which ones do from providers or dynamically using active configuration endpoint.
Transaction limits apply. 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.

Required string length: 1 - 23

Example:

"15"

data.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.

Find the supported currencies for the provider.

The active configuration endpoint has all the providers configured for your account together with the supported currencies.

Example:

"ZMW"

data.country

string

required

The country in which the payment was initiated.

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

Required string length: 3

Example:

"ZMB"

data.recipient

object

required

Details about the customer who is paying or receiving the payment.

Show child attributes

data.recipient.type

enum<string>

required

The type of account involved in the transaction. At the moment, only MMO is supported.

Available options:

MMO

Example:

"MMO"

data.recipient.accountDetails

object

required

Show child attributes

data.recipient.accountDetails.phoneNumber

string

required

The phone number (MSISDN) of the customer paying or receiving payment. The format is described in Wikipedia.

Use predict provider to validate and sanitise the phone number.

Phone number validation has following rules:

Only digits without whitespaces or any other separators or prefixes like '+'.
Should not start with zero.
Country code is mandatory.
Should not exceed or be less than the valid length of specified country.

Example:

"260763456789"

data.recipient.accountDetails.provider

string

required

The provider represents the mobile money operator or processor that can process payments.

Find here a list of all the supported providers.

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

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

Example:

"MTN_MOMO_ZMB"

data.created

string<date-time>

required

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

Example:

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

data.customerMessage

string

A short narration for the transaction. Depending on the 'provider', this message may be visible to the customer in the SMS receipt or within their transaction history.

Defaults to your company name as registered on your pawaPay account trimmed to fit the length limitations.

Required string length: 4 - 22

Example:

"Note of 4 to 22 chars"

data.providerTransactionId

string

The unique ID for this payment assigned by the provider. The customer would see this ID on their SMS receipt and transaction history.

Example:

"ABC123"

data.failureReason

object

Show child attributes

data.failureReason.failureCode

enum<string>

required

Possible refund failure codes:

PAWAPAY_WALLET_OUT_OF_FUNDS - Your pawaPay wallet does not have enough funds to complete this refund.
RECIPIENT_NOT_FOUND - The phone number specified for the receipient does not belong to the provider.
WALLET_LIMIT_REACHED - The recipient has reached a limit on their wallet that stops them from receiving this refund.
UNSPECIFIED_FAILURE - The provider confirmed the payment has failed, but did not provide any information about the reason of the failure.
UNKNOWN_ERROR - An unknown error has occured.

Available options:

PAWAPAY_WALLET_OUT_OF_FUNDS,

RECIPIENT_NOT_FOUND,

WALLET_LIMIT_REACHED,

UNSPECIFIED_FAILURE,

UNKNOWN_ERROR

Example:

"WALLET_LIMIT_REACHED"

data.failureReason.failureMessage

string

Description of the reason for this failure

Example:

"Recipient's address is blocked"

data.metadata

object

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

Show child attributes

data.metadata.additionalProperties

string

Each passed in metadata field will be a property of the metadata JSON object.

Example:

{
  "orderId": "ORD-123456789",
  "customerId": "[email protected]"
}

Deposits

Payouts

Refunds

Remittances

Payment page

Finances

Toolkit

Authorizations

Path Parameters

Response