1. Account/Balance Check

You can view the account/balance details of the provider you have connected to Paywall for card production (if available).

Account/Balance Check

GET {{Base Address}}/api/paywall/card/production/balance

Simply making a request to the address provided above will suffice. You can use the 'Base Address' as you wish for both the Test environment and the Production environment.

Important: In order to use the Card Production Provider - Account/Balance Check service, you need to send the 'apikeyprivate' and 'apiclientprivate' parameters in the 'Header' field.

PaymentAPI Address

The header information that needs to be sent to the service is as follows:

Parameter
Type
Compulsory
Description

apikeyprivate

string

Yes

The Private Key obtained from the merchant panel.

apiclientprivate

string

Yes

The Private Client obtained from the merchant panel.

cardproductionkey

int

Yes

The key information of the connected provider.

The response returned from the service:

Parameter
Type
Description

Body

object

The JSON containing details about the account/balance information (optional).

ErrorCode

int

Error code. If the transaction is successful, it returns a value of '0'.

Result

bool

It returns either true or false. If the transaction is successful, it returns 'true'.

Message

string

If the transaction is unsuccessful, this is the message specified for the error, providing language support based on the 'locale' parameter.

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "Balances": [
            {
                "TotalBalance": 249961.82,
                "LockedBalance": 0.0,
                "AvailableBalance": 249961.82
            }
        ],
        "ProviderDump": "{PROVIDERJSONDUMP}",
        "ProviderHttpStatus": 200,
        "ProviderConnectedId": 17,
        "ProviderId": 2,
        "ProviderKey": "ProviderKey",
        "CurrencyId": 1
    }
}

Last updated