1. Balance

You can authorize Paywall with your own access credentials through the supported PayOut providers to perform balance checks.

Balance Check

GET {{Base Address}}/api/paywall/payout/balance

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

Important: In order to use the Payout - 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.
payoutconnectionid	int	Yes	Connected provider identity (Id) information

The response from the service.

Parameter	Type	Description
Body	object	JSON containing details about the balance information (optional).
ErrorCode	int	Error code. Returns '0' if the operation is successful.
Result	bool	It returns a true or false value. If the operation is successful, it returns 'true'.
Message	string	If the operation is unsuccessful, this is the specified message for the error, providing language support according to the locale parameter.

JSON

{
    "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
    }
}