PEpeachpayments
Status

Query payment status

Query the status of a payment.

For more information, see the documentation, and for sample calls, see the public Postman collection.

get/api/payments/{paymentId}

Request

  • Base URL
    https://sandbox-l.ppay.io
  • URL
    https://sandbox-l.ppay.io/api/payments/{paymentId}
  • Auth
    HTTP bearer

Response

Payment status successfully retrieved.

Example response

{
  "payment": {
    "id": "b95d6888-591b-4538-b508-6102cf1259c9",
    "payment": {
      "linkId": "G56F5_ll",
      "linkUrl": "https://l.ppay.io/af6c33cce7fabefb",
      "amount": 123.45,
      "status": "completed",
      "currency": "ZAR",
      "merchantInvoiceId": "INV90001",
      "entityId": "8ac7a4ca77a64c9c0177af52972c13bd",
      "notes": "Please pay this at your earliest convenience.",
      "expiryTime": "2021-10-27T12:45:27Z",
      "batchId": "421e1e63-ddd5-46ec-8812-74eda861259b"
    },
    "source": "API",
    "createdAt": "2021-10-27T12:35:27Z",
    "updatedAt": "2021-10-27T12:45:43Z",
    "customer": {
      "givenName": "Grace",
      "surname": "Nkosi",
      "email": "grace.nkosi@example.com",
      "mobile": "+27123456789",
      "whatsapp": "+27123456789",
      "billing": {
        "street1": "123 Example Street",
        "city": "Cape Town",
        "state": "Western Cape",
        "postalCode": "7000",
        "country": "ZA"
      }
    },
    "options": {
      "emailCc": "ccexample@example.com",
      "emailBcc": "bccexample@example.com",
      "notificationUrl": "https://example.com/example-webhook/"
    },
    "checkout": {
      "defaultPaymentMethod": "CARD",
      "paymentType": "DB",
      "registrationId": "8ac7a4a180223d220180227b2cf649f0",
      "checkoutId": "d6a8014a622a442aad90c72320419b2b",
      "transactionUniqueId": "450bf3b1-c479-4b30-99ca-5b598a889b8f",
      "resultCode": "000.100.110",
      "paymentBrand": "VISA"
    }
  },
  "audit": [
    {
      "oldStatus": "initiated",
      "newStatus": "processing",
      "timestamp": "2021-10-27T12:45:43Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.