Detail

This endpoint retrieves the details of a payment gateway based on the provided name and status.

Request Parameters

name (query parameter) - The name of the payment gateway (e.g. "Paystack")

status (query parameter) - The status of the payment gateway (e.g. "test" or "live")

Response

The response for this request is a JSON object with the following properties:

name (string) - The name of the payment gateway

status (string) - The status of the payment gateway

publicKey (string) - The public key of the payment gateway

errorCode (integer) - The error code, if any

errorMessage (string) - The error message, if any

Sample Response

{
    "name": "Paystack",
    "status": "Test",
    "publicKey": "pk_test_9jkbv3b342f7dda21e1468e223bf35fd256utyer",
    "errorCode": 0,
    "errorMessage": "Successfully retrieved payment gateway detail."
}

JSON Schema

The response for this request can be documented as a JSON schema:

{
    "type": "object",
    "properties": {
        "name": {"type": "string"},
        "status": {"type": "string"},
        "publicKey": {"type": "string"},
        "errorCode": {"type": "integer"},
        "errorMessage": {"type": "string"}
    }
}

curl --location --request GET 'https://guestapi.roomability.io/Paygateway/Detail?name=Paystack&status=test' \ --header 'X-API-Key: {{api-key}}' \ --header 'Content-Type: application/json' \ --data-raw '{}'

{ "name": "Paystack", "status": "Test", "publicKey": "pk_test_9jkbv3b342f7dda21e1468e223bf35fd256utyer", "errorCode": 0, "errorMessage": "Successfully retrieved payment gateway detail." }

Request Parameters#

Response#

Sample Response#

JSON Schema#

Request

Responses

Request Parameters

Response

Sample Response

JSON Schema