Check remittance status

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

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](/v2/docs/providers) or dynamically using [active configuration](/v2/api-reference/toolkit/active-configuration) endpoint.
* Transaction limits apply. Find them from the [Active Configuration](/v2/api-reference/toolkit/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.


Reason for the failure:
* `NO_AUTHENTICATION` - The API token was not found in the request headers.
* `AUTHENTICATION_ERROR` - The API token in the request headers is not valid.
* `HTTP_SIGNATURE_ERROR` - The signature you have passed with the request did not pass verification.


Reason for the failure:
* `AUTHORISATION_ERROR` - The API Token in the request header is not authorised to make this request.
* `DEPOSITS_NOT_ALLOWED` - Deposits are not enabled with the provider on your pawaPay account.
* `PAYOUTS_NOT_ALLOWED` - Payouts are not enabled with the provider on your pawaPay account.
* `REMITTANCES_NOT_ALLOWED` - Remittances are not enabled with the provider on your pawaPay account.
* `REFUNDS_NOT_ALLOWED` - Refunds are not enabled with the provider on your pawaPay account.


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](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Officially_assigned_code_elements).


The timestamp of when the payment was created in the pawaPay platform. Format defined by 'date-time' in RFC3339 section 5.6 from [IETF](https://tools.ietf.org/html/rfc3339#section-5.6)

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](https://en.wikipedia.org/wiki/ISO_4217#Active_codes).

Find the supported currencies for the [provider](/v2/docs/providers).

The [active configuration](/v2/api-reference/toolkit/active-configuration) endpoint has all the providers configured for your account together with the supported currencies.


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.


The phone number (MSISDN) of the customer paying or receiving payment.
The format is described in [Wikipedia](https://en.wikipedia.org/wiki/MSISDN). 

Use [predict provider](/v2/api-reference/toolkit/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.


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

Find here a list of all the supported [providers](/v2/docs/providers). 

The [active configuration](/v2/api-reference/toolkit/active-configuration) endpoint provides the list of provider configured for your account.

You can use the [predict provider](/v2/api-reference/toolkit/predict-provider) enpoint to predict the provider to use based on the phone number (MSISDN).


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

The first name of the recipient of this remittance.

The last name of the recipient of this remittance.

Possible remittance failure codes: 
* `PAWAPAY_WALLET_OUT_OF_FUNDS` - Your pawaPay wallet does not have enough funds to complete this remittance.
* `RECIPIENT_NOT_FOUND` - The phone number specified as the receipient does not belong to the provider. 
* `WALLET_LIMIT_REACHED` - The recipient has reached a limit on their wallet that stops them from being able to accept this remittance. 
* `MANUALLY_CANCELLED` - The remittance was enqueued and subsequently cancelled from the pawaPay Dashboard or through the [Cancel Enqueued Remittance](/v2/api-reference/remittances/cancel-enqueued-remittance) endpoint.
* `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.


Description of the reason for this failure

Details about the customer who is receiving the remittance.

Details about the customer who is sending the remittance.

Possible remittance statuses: 
* `ACCEPTED` - The remittance has been **accepted** by pawaPay for processing. 
* `ENQUEUED` - The remittance has been **accepted**, but has been enqueued for processing later. Read more about [enqueued remittances](/v2/docs/remittances#handling-enqueued-remittances-and-provider-availability). 
* `PROCESSING` - The remittance has been submitted to the provider and is being processed.
* `IN_RECONCILIATION` - The remittance is being reconciled currently to determine it's final status.
* `COMPLETED` - The remittance has been successfully processed. This is a **final status.**
* `FAILED` - The remittance has been processed, but failed. This is a **final status.**. See `failureReason` for details.


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

The result of this operation.
- `FOUND` - The payment was found in pawaPay.
- `NOT_FOUND` - The payment was not found in pawaPay.


The address of the sender of this remittance.

The city of the sender of this remittance.

The country of the sender of this remittance.

The postal/zip code or the sender of this remittance.

The date of birth of the sender of this remittance.

The first name of the sender of this remittance.

The gender of the sender of this remittance.

The last name of the sender of this remittance.

The nationality of the sender of this remittance.

The occupation of the sender of this remittance.

The phone number of the sender of this remittance.

The place of birth of the sender of this remittance.

The nature of the relationship between the sender and the recipient of this remittance.

The id of the identification document used to KYC the sender of this remittance.

The type of identification document used to KYC the sender of this remittance.

The fx rate applied to the customer for this remittance.

The original amount in the original currency that is being remitted.

The currency in which the remittance originates.

The intended purpose for the funds being remitted to the recipient.

Any service and other fees paid by the customer for this remittance.

The unique reference to the transaction in your system

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


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

bearerAuth

Authentication failed. Make sure you have added the API token into the header. If using signatures, make sure they are valid.

Deposits

Payouts

Refunds

Remittances

Payment page

Wallet balances

Toolkit

Check remittance status

Authorizations

Path Parameters

Response