v1

latestOpenAPI 3.0.02026-07-2627149175.2 KB

deposits

Check deposit status

get/v2/deposits/{depositId}

Path parameters

depositIdstring uuid required

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

Response

Request has been processed by PawaPay

status'FOUND' | 'NOT_FOUND' required

The result of this operation.

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

Example response

{
  "data": {
    "depositId": "f4401bd2-1568-4140-bf2d-eb77d2b2b639",
    "amount": "15",
    "currency": "ZMW",
    "country": "ZMB",
    "payer": {
      "type": "MMO",
      "accountDetails": {
        "phoneNumber": "260763456789",
        "provider": "MTN_MOMO_ZMB"
      }
    },
    "customerMessage": "Note of 4 to 22 chars",
    "clientReferenceId": "INV-123456",
    "created": "2020-02-21T17:32:29Z",
    "providerTransactionId": "ABC123",
    "failureReason": {
      "failureCode": "INSUFFICIENT_BALANCE",
      "failureMessage": "The customer does not have enough funds to complete this payment."
    },
    "metadata": {
      "orderId": "ORD-123456789",
      "customerId": "customer@email.com"
    }
  }
}