Get apps integration payment gateway with brand

Gets the list of the app integration payment gateways by the current brand.

get

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

403

The user's access was denied.

application/json

429

The user has exceeded the rate limit.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/app-integrations/payment-gateway HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": [
    {
      "appIntegration": {
        "type": "PaymentGateway",
        "name": "Stripe",
        "domain": "https://stripe.com",
        "description": "Stripe payment gateway",
        "logoURL": null,
        "status": "Active",
        "id": "sApKpllz4sAplsmzha"
      },
      "name": null,
      "ipnListenerLink": "https://example.com/ipn-listener",
      "cancelLinkWithoutLogin": "https://example.com/cancel-no-login",
      "cancelLink": "https://example.com/cancel",
      "returnLink": "https://example.com/return",
      "publicKey": "public-key-example",
      "privateKey": "private-key-example",
      "description": "Example Payment Gateway",
      "notes": "This is a sample payment gateway for testing purposes.",
      "testMode": true,
      "isDefault": false,
      "status": "Inactive",
      "id": "sApKpllz4sAplsmzha"
    }
  ],
  "errors": []
}