1. List of Connected Providers

You can use this method to list APM providers that you have activated through the Paywall panel and enabled the 'List with API' feature.

List my APMs

GET {{Base Adres}}/api/paywall/apm/list

Important: To use the APM Listing service, you need to include 'apikeypublic' and 'apiclientpublic' parameters in the 'Header' field.

PaymentAPI Address

The parameters that need to be sent to the service are as follows:

Parameter (Headers)
Type
Compulsory
Description

apikeypublic

string

Yes

The Public Key obtained from the merchant panel.

apiclientpublic

string

Yes

The Public Client obtained from the merchant panel.

currencyid

int

Yes

The currency in which the payment is intended to be processed.

externalid

string

No

The External ID provided during APM connection.

focusedfeature

string

No

It specifies in which mode the payment flow is desired to be executed. For example, if 'qr' is specified, the list of providers supporting QR payments is shared from the Paywall account.

Bkz: List

distinctduplicates

bool

No

If sent as true, duplicate connections belonging to the same provider in the list are reduced to a single entry.

The parameters returned from the service are as follows:

Parameter
Type
Description

ConnectionId

int

The connection identifier of the provider. It is used when initiating a payment with the Payment Id information.

Logo

string

The provider logo. It can be used to display on your own payment screen.

ProviderKey

string

The provider's keyword in Paywall. It is used when initiating a payment with the Payment Key information.

ProviderName

string

The name of the provider.

CategoryName

string

The category of the provider.

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": [
        {
            "ProviderId": 1,
            "ProviderKey": "ProviderKey",
            "ProviderName": "ProviderName",
            "CategoryName": "Cüzdan",
            "ConnectionId": 62,
            "ExternalIdSupport": false,
            "ExternalId": "",
            "Logo": "https://itspaywall.s3.eu-west-2.amazonaws.com/98585041ec304050913860a1cebb56a7.png",
            "Features": {
                "OtpBased": true,
                "QrBased": true,
                "CheckoutBased": true,
                "DirectPayBased": true
            }
        }
    ]
}

Last updated