Skip to main content

Get payment page by reference

This endpoint retrieves a payment page by its reference.

Endpoint​

GET PaymentPages/GetPageByReference/{{ reference }}

Headers​

Authorization: Bearer

To authorize this API request, you need to include your privateKey as a bearer token. This is done by setting the Authorization header in your request. The header should have the format:

Authorization: "Bearer privateKey"

See how to find your private key on your dashboard here.

Request Params​

  • reference (string, required): The reference of the payment page.
Response (200) - Success
  {
    "responseCode": "00",
    "responseMessage": "Fetched payment pages successfully",
    "data": {
      "id": 16,
      "businessName": "Emino Group",
      "pageName": "Paybridge testing",
      "amount": 0,
      "isFixedAmount": false,
      "isPhoneNumberRequired": false,
      "paymentPageLink": "https://pay.paybridge.africa/pay/paybridge-testinggg",
      "isTestMode": false,
      "additionalFields": "[]",
      "isActive": true,
      "paymentPageLinkReference": "paybridge-testinggg",
      "dateCreated": "2024-11-20T10:04:37.67",
      "isDeleted": false
    }
  }