v1

latestOpenAPI 3.0.02026-07-2627149175.2 KB

checkouts

Check checkout status

get/v2/checkouts/{checkoutId}

Path parameters

checkoutIdstring uuid required

The id of the checkout 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": {
    "checkoutId": "f4401bd2-1568-4140-bf2d-eb77d2b2b639",
    "redirectUrl": "https://payment.example.com/checkout/afb57b93-7849-49aa-babb-4c3ccbfe3d79",
    "returnUrl": "https://merchant.example.com/checkout-result",
    "defaultLanguage": "en",
    "countries": [
      "ZMB",
      "CIV"
    ],
    "expiresAfter": 60,
    "amounts": [
      {
        "country": "ZMB",
        "currency": "ZMW",
        "amount": "15"
      }
    ],
    "payer": {
      "type": "MMO",
      "accountDetails": {
        "phoneNumber": "260763456789",
        "provider": "MTN_MOMO_ZMB",
        "allowCustomerToOverride": true
      }
    },
    "clientReferenceId": "INV-123456",
    "created": "2020-02-21T17:32:29Z",
    "providerTransactionId": "ABC123",
    "deposit": {
      "depositId": "f4401bd2-1568-4140-bf2d-eb77d2b2b639",
      "created": "2020-02-21T17:32:29Z",
      "providerTransactionId": "ABC123",
      "failureReason": {
        "failureCode": "PAYMENT_NOT_APPROVED",
        "failureMessage": "The payer did not approve the payment."
      },
      "amount": "15",
      "currency": "ZMW",
      "country": "ZMB",
      "payer": {
        "type": "MMO",
        "accountDetails": {
          "phoneNumber": "260763456789",
          "provider": "MTN_MOMO_ZMB"
        }
      },
      "customerMessage": "Note of 4 to 22 chars",
      "metadata": {
        "orderId": "ORD-123456789",
        "customerId": "customer@email.com"
      }
    },
    "depositsHistory": [
      {
        "depositId": "f4401bd2-1568-4140-bf2d-eb77d2b2b639",
        "created": "2020-02-21T17:32:29Z",
        "providerTransactionId": "ABC123",
        "failureReason": {
          "failureCode": "PAYMENT_NOT_APPROVED",
          "failureMessage": "The payer did not approve the payment."
        },
        "amount": "15",
        "currency": "ZMW",
        "country": "ZMB",
        "payer": {
          "type": "MMO",
          "accountDetails": {
            "phoneNumber": "260763456789",
            "provider": "MTN_MOMO_ZMB"
          }
        },
        "customerMessage": "Note of 4 to 22 chars",
        "metadata": {
          "orderId": "ORD-123456789",
          "customerId": "customer@email.com"
        }
      }
    ],
    "metadata": {
      "orderId": "ORD-123456789",
      "customerId": "customer@email.com"
    },
    "reason": {
      "en": "GOODS PURCHASE"
    },
    "checkoutCode": "PPGAFB57B93"
  }
}

All 27 operations