Check deposit status

Get deposit status using the depositId from your initial deposit request. A list containing at most one Deposit is returned. This operation can be used to confirm the current status of a deposit.

Authorizations

Authorization

string

header

required

See Authentication.

Path Parameters

depositId

string<uuid>

required

The depositId of the deposit transaction.

Required string length: 36

Response

Request has been processed by pawaPay

depositId

string<uuid>

required

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

Required string length: 36

Example:

"f4401bd2-1568-4140-bf2d-eb77d2b2b639"

status

enum<string>

required

Possible deposit statuses:

ACCEPTED - The deposit request has been accepted by pawaPay for processing.
SUBMITTED - The deposit request has been submitted to the MMO and is being processed.
COMPLETED - The deposit request has been successfully processed. This is a final state.
FAILED - The deposit request has been processed, but failed. This is a final state.

Available options:

ACCEPTED,

SUBMITTED,

COMPLETED,

FAILED

requestedAmount

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

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"

payer

object

required

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

Show child attributes

payer.type

enum<string>

required

The type of financial address. At the moment, only MSISDN is supported as the financial address.

Available options:

MSISDN

Example:

"MSISDN"

payer.address

object

required

Show child attributes

payer.address.value

string

required

The phone number (MSISDN) of the payer or recipient. The format is described in Wikipedia.

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

Valid examples for Zambia: 260763456789

Not valid examples for Zambia: +260763456789, 260 763 456789, 260-7634-56789, 0260763456789, 2607634567, 260763456789543, 999558708954, 37255870895

Example:

"260763456789"

customerTimestamp

string<date-time>

required

The timestamp for when you initiated the deposit 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 deposit 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

Example:

"Note of 4 to 22 chars"

depositedAmount

string

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

Example:

"15"

respondedByPayer

string<date-time>

When the MMO responded to this deposit request. Format defined by 'date-time' in RFC3339 section 5.6 from IETF

Example:

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

correspondentIds

object

The unique ID for this financial transaction assigned by the MMO.

Show child attributes

correspondentIds.{key}

string

Example:

{
  "MTN_INIT": "ABC123",
  "MTN_FINAL": "DEF456"
}

suspiciousActivityReport

object[]

Show child attributes

suspiciousActivityReport.activityType

enum<string>

required

Represents a suspicious activity category.

AMOUNT_DISCREPANCY - Indicates that there is a discrepancy between requested and actual deposit amount.

Available options:

AMOUNT_DISCREPANCY

Example:

"AMOUNT_DISCREPANCY"

suspiciousActivityReport.comment

string

required

Example:

"There is a discrepancy between requested and actual deposit amount."

failureReason

object

Show child attributes

failureReason.failureCode

enum<string>

required

Possible deposit failure codes:

PAYER_NOT_FOUND - The phone number specified as the Payer does not belong to the MMO specified as the correspondent.
PAYMENT_NOT_APPROVED - Payer did not approve the payment.
PAYER_LIMIT_REACHED - Payer has reached a transaction limit of their mobile money wallet.
INSUFFICIENT_BALANCE - Payer does not have enough funds.
TRANSACTION_ALREADY_IN_PROCESS - Payer already has an unfinalized transaction being processed by the MMO.
OTHER_ERROR - Any other error. Please refer to failureMessage.

Available options:

PAYER_NOT_FOUND,

PAYMENT_NOT_APPROVED,

PAYER_LIMIT_REACHED,

INSUFFICIENT_BALANCE,

TRANSACTION_ALREADY_IN_PROCESS,

OTHER_ERROR

Example:

"OTHER_ERROR"

failureReason.failureMessage

string

Additional optional failure message

Example:

"Payers address is blocked"

metadata

object

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

Show child attributes

metadata.value of fieldName

string

Each passed in metadata field will be a property of the metadata JSON object. The key will be the 'fieldName' and the value will be 'fieldValue'.

Example:

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

Deposits

Payouts

Refunds

Payment page

Wallet balances

Toolkit

Authorizations

Path Parameters

Response