Skip to main content

PaymentGateway

Detailed information about a payment gateway, including merchant configuration and parameters.

idstring

Unique identifier for the payment gateway.

namestring

The display name of the payment gateway (e.g., "Visa", "Mastercard", "Edenred").

typeint32

The type of payment gateway.

Possible values: [0, 1, 2]

paymentActionPaymentGateways.CheckoutAction

The type of checkout action required by the payment gateway.

Possible values: [OTP, REDIRECT, DROPIN]

imagestringnullable

URL of the image to display for this payment gateway.

checkoutImagestringnullable

URL of the image to display for this payment gateway in the checkout page.

iconstringnullable

URL of the icon to display for this payment gateway.

isActiveboolean

Indicates whether this payment gateway is currently active and available for use.

merchantConfiguration object

Merchant-specific configuration for this payment gateway.

defaultPaymentGatewayIdstringnullable

The ID of the default payment gateway to use if no specific gateway is selected.

isFallbackboolean

Indicates whether this payment gateway should be used as a fallback option when other gateways fail.

parameters object[]nullable

An array of configuration parameters for this payment gateway.

  • Array [
  • idstring

    Unique identifier for this parameter.

    friendlyNamestring

    A human-readable name for this parameter.

    isSecretboolean

    Indicates whether this parameter contains sensitive information that should be masked or hidden.

    valuestringnullable

    The current value of this parameter. May be null if not configured.

  • ]
  • PaymentGateway
    {
    "id": "string",
    "name": "string",
    "type": 0,
    "paymentAction": "OTP",
    "image": "string",
    "checkoutImage": "string",
    "icon": "string",
    "isActive": true,
    "merchantConfiguration": {
    "defaultPaymentGatewayId": "string",
    "isFallback": true
    },
    "parameters": [
    {
    "id": "string",
    "friendlyName": "string",
    "isSecret": true,
    "value": "string"
    }
    ]
    }