PApawapay
split-payments

Check split payment status

Changed on
get/v2/split-payments/{splitPaymentId}

Request

  • Base URL
    https://api.sandbox.pawapay.io
  • URL
    https://api.sandbox.pawapay.io/v2/split-payments/{splitPaymentId}
  • Auth
    HTTP bearer

Path parameters

splitPaymentIdstring uuid required

The id of the split payment 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": {
    "splitPaymentId": "f4401bd2-1568-4140-bf2d-eb77d2b2b639",
    "amount": "15",
    "currency": "ZMW",
    "country": "ZMB",
    "payer": {
      "type": "MMO",
      "accountDetails": {
        "phoneNumber": "260763456789",
        "provider": "MTN_MOMO_ZMB"
      }
    },
    "clientReferenceId": "INV-123456",
    "customerMessage": "Note of 4 to 22 chars",
    "created": "2020-02-21T17:32:29Z",
    "providerTransactionId": "ABC123",
    "splits": [
      {
        "payoutId": "f4401bd2-1568-4140-bf2d-eb77d2b2b639",
        "amount": "15",
        "recipient": {
          "type": "MMO",
          "accountDetails": {
            "phoneNumber": "260763456789",
            "provider": "MTN_MOMO_ZMB"
          }
        },
        "customerMessage": "Note of 4 to 22 chars",
        "providerTransactionId": "ABC123",
        "created": "2020-02-21T17:32:29Z",
        "failureReason": {
          "failureCode": "WALLET_LIMIT_REACHED",
          "failureMessage": "The account '260973024456' has reached a transaction limit. Consult API docs for possible transaction limits."
        }
      }
    ],
    "metadata": {
      "orderId": "ORD-123456789",
      "customerId": "customer@email.com"
    },
    "failureReason": {
      "failureCode": "PAYMENT_NOT_APPROVED",
      "failureMessage": "The payer did not approve the payment."
    }
  }
}

Changes