GET /merchant/provider/available

Get all available APM providers ---- [auth scope: merchant]

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

currencyanyOptional

The currency, in ISO 4217 format.

Responses

200

Returns a list of available APM providers

application/json

isActivebooleanRequired

The state of the merchant's integration with the APM provider.

createdAtstringRequired

The date of the activation of the APM integration.

updatedAtstringRequired

The date of an update to the APM integration.

userNamestringRequired

The name of the user that handled this integration.

providerNamestringRequired

The name of the APM provider.

imageUrlstringRequired

The url to the image of the APM provider.

maxAmountnumberRequired

The maximum amount the APM provider is eligible for

minAmountnumberRequired

The minimum amount the APM provider is eligible for

interestRatenumberRequired

The interest rate of the APM provider

prioritynumberRequired

Provider order based on merchant preference

lateFeesAllowedbooleanRequired

Late fee

customerFeesAllowedbooleanRequired

Customer Fee alloweed

interestRateAllowedbooleanRequired

Interest Rate allowed

lateFeesstringRequired

Late fee allowed

customerFeesstringRequired

Customer Fee

lateFeesCustomTextstringRequired

late fees custom text

customerFeesCustomTextstringRequired

customer fees custom text

providerFeesnumberRequired

Provider Fees Flat Rate

providerFeesPercentagenumberRequired

Provider Fees Percentage Rate

customerFeesFlatnumberRequired

Customer Fees Flat Rate

customerFeesPercentagenumberRequired

Customer Fees Percentage Rate

surchargeCapnumberRequired

The cap on surcharge amount

currencystringRequired

Supported currencies

callbackUrlUseDefaultbooleanRequired

Use default callback URL

callbackRawResponsebooleanRequired

Callback raw response

callbackEnabledbooleanRequired

Enable callback

callbackUrlstringRequired

Callback URL

friendlyNamestringRequired

Providers friendly name

descriptionstringRequired

description about provider

marketingNamestringRequired

Providers Marketing name

mpgsIdentifierstringRequired

Identifier for MPGS

preferredDisplayModestringRequired

Preferred display mode for payment

incontextDisplayModestringRequired

Incontext display mode for payment

connectorstringRequired

Connector Text for Providers

messagestringRequired

Message for Providers

channelNamestringRequired

Channel Name

channelAliasstringRequired

Channel Alias

signupDescriptionstringRequired

Signup description for Providers

supportDescriptionstringRequired

Support description for Providers

signupLinkstringRequired

Signup link for Providers

supportLinkstringRequired

Support link for Providers

logoUrlstringRequired

Logo url for Providers

customProviderLogostringRequired

Custom Logo for Provider

widgetLogoLabelstringRequired

The label for the widget logo of the APM provider.

merchantIdstringRequired

The ID of the merchant associated with the provider.

apiKeyReferencestringRequired

The API key reference for the APM provider.

get/merchant/provider/available

GET /merchant/provider/available HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Returns a list of available APM providers

[
  {
    "isActive": true,
    "createdAt": "text",
    "updatedAt": "text",
    "userName": "text",
    "providerName": "text",
    "imageUrl": "text",
    "maxAmount": 1,
    "minAmount": 1,
    "interestRate": 1,
    "priority": 1,
    "lateFeesAllowed": true,
    "customerFeesAllowed": true,
    "interestRateAllowed": true,
    "lateFees": "text",
    "customerFees": "text",
    "lateFeesCustomText": "text",
    "customerFeesCustomText": "text",
    "providerFees": 1,
    "providerFeesPercentage": 1,
    "customerFeesFlat": 1,
    "customerFeesPercentage": 1,
    "surchargeCap": 1,
    "currency": "text",
    "checkoutConfig": {
      "content": "text",
      "iframeUrl": "text",
      "button": {
        "type": "text",
        "text": "text",
        "color": "text",
        "background": "text",
        "position": "text",
        "size": "text"
      },
      "termsCondition": {
        "type": "text",
        "content": "text",
        "linkText": "text"
      }
    },
    "productDetailsConfig": {
      "content": "text"
    },
    "callbackUrlUseDefault": true,
    "callbackRawResponse": true,
    "callbackEnabled": true,
    "callbackUrl": "text",
    "friendlyName": "text",
    "description": "text",
    "marketingName": "text",
    "mpgsIdentifier": "text",
    "preferredDisplayMode": "text",
    "incontextDisplayMode": "text",
    "popupOverlayConfig": {
      "title": "Payment in progress",
      "message": "Click anywhere to continue payment!"
    },
    "connector": "text",
    "message": "text",
    "channelName": "text",
    "channelAlias": "text",
    "signupDescription": "text",
    "supportDescription": "text",
    "signupLink": "text",
    "supportLink": "text",
    "logoUrl": "text",
    "customProviderLogo": "text",
    "widgetLogoLabel": "text",
    "merchantId": "text",
    "apiKeyReference": "text"
  }
]