v1

latestOpenAPI 3.0.02026-07-2627149175.2 KB

remittances

Check remittance status

get/v2/remittances/{remittanceId}

Path parameters

remittanceIdstring uuid required

The id of the remittance 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": {
    "remittanceId": "f4401bd2-1568-4140-bf2d-eb77d2b2b639",
    "amount": "15",
    "currency": "ZMW",
    "country": "ZMB",
    "recipient": {
      "type": "MMO",
      "accountDetails": {
        "phoneNumber": "260763456789",
        "provider": "MTN_MOMO_ZMB"
      },
      "recipientDetails": {
        "firstName": "John",
        "lastName": "Doe"
      }
    },
    "sender": {
      "transactionDetails": {
        "transactionReference": "de83150a-5916-48a2-b048-bd85e022cb55",
        "originalAmount": "100",
        "originalCurrency": "USD",
        "buyFxRate": "23.88",
        "senderFees": "1",
        "purposeOfFunds": "FAMILY_SUPPORT",
        "sourceOfFunds": "SALARY"
      },
      "senderDetails": {
        "firstName": "Jane",
        "lastName": "Doe",
        "nationality": "USA",
        "gender": "FEMALE",
        "phoneNumber": "12124567890",
        "dateOfBirth": "1977-12-31",
        "placeOfBirth": "USA",
        "occupation": "Project manager",
        "relationshipRecipient": "PARTNER",
        "address": {
          "addressLine": "1476 Sandhill Rd",
          "postalCode": "84058",
          "city": "Orem",
          "country": "USA"
        },
        "identification": {
          "type": "PASSPORT",
          "number": "E00007730"
        }
      }
    },
    "customerMessage": "Note of 4 to 22 chars",
    "created": "2020-02-21T17:32:29Z",
    "providerTransactionId": "ABC123",
    "failureReason": {
      "failureCode": "WALLET_LIMIT_REACHED",
      "failureMessage": "Recipient's address is blocked"
    },
    "metadata": {
      "orderId": "ORD-123456789",
      "customerId": "customer@email.com"
    }
  }
}