Get FIRS Payment Means

Endpoint Description

This endpoint retrieves the available payment means for a specific business identified by businessId.

Request

Method

URL

Copy to Clipboard

Path Parameters

businessId (string): The unique identifier for the business whose payment means are being queried.

Response

  • Status Code: 200 OK
  • Content-Type: application/json
  • Response Structure:
    • responseCode (string): A code indicating the status of the response.
    • responseMessage (string): A message providing additional details about the response.
    • data (array): An array containing objects that represent the available payment means.
      • Each object in the data array includes:
        • code (string): The code associated with the payment mean.
        • value (string): The descriptive value of the payment mean.

Notes

  • Ensure that the businessId is valid and corresponds to an existing business to receive accurate results.
  • The response will include a list of payment means, which can be used for processing payments related to the specified business.

Request

Path Params

Field Type Required Description Example
stage string required –
businessId string required (Required) businessId

Header Params

Header Params Type Required Description Example
X-Business-Key string required (Required) X-Business-Key BK-26EDE24BAC50475FAACC5EA6339F0863-DEV-B2Z6QCEHI3X9
Accept string required — */*

Response

Response Status

  • 200 OK

  • 401 Unauthorized

  • 403 Forbidden

  • 404 Not Found