3. Initiate Payment (Key)"

Initiate Payment

POST {{Base Adres}}/api/paywall/apm/pay/bykey

Important: In order to use the APM Payment Initiation service, you need to send the 'apikeypublic' and 'apiclientpublic' parameters in the 'Header' field. PaymentAPI Address

Service needs to be sent (HEADERS) The parameters are as follows:

Parameter	Type	Required	Description
apikeypublic	string	Yes	The Public Key obtained from the merchant panel.
apiclientpublic	string	Yes	The Public Client obtained from the merchant panel.

Service needs to be sent (BODY) The parameters are as follows:

Parameter	Type	Required	Description
ApmKey	string	Yes	The Key information of the APM provider. See: APM
CurrencyId	int	Yes	The currency in which the payment is intended to be connected Bkz: Currency
MerchantUniqueCode	string	Yes	The unique number you have generated for the payment.
MerchantSuccessBackUrl	string	Yes	The address to which the successful result of your payment will be communicated. The response will be received in the Post Body.
MerchantFailBackUrl	string	Yes	The address where the successful outcome of your payment will be conveyed. The response will be received in the Post Body.
Amount	decimal	Yes	The payment amount.
Description	string	Yes	Payment description. Depending on the provider, this description may be displayed on the payment screen.

An example JSON file to be sent for service is as follows:

JSON

{
    "ApmKey": "Papara",
    "CurrencyId": 1,
    "MerchantUniqueCode": "TESTMERCHANTUNIQUECODE",
    "MerchantSuccessBackUrl": "https://webhook.site/38a6fa6f-3414-40db-b2a7-a6c38894b6a3",
    "MerchantFailBackUrl": "https://webhook.site/38a6fa6f-3414-40db-b2a7-a6c38894b6a3",
    "Amount": 1,
    "Description": "test"
}

The parameters returned from the service are as follows:

Parameter	Type	Description
ErrorCode	int	Error code. If the operation is successful, it returns '0'.
Result	bool	It returns a boolean value, where it returns 'true' if the operation is successful.
Message	string	If the operation is unsuccessful, it provides an error message specific to that error, with language support based on the 'locale' parameter.
Body	Object	If the operation is unsuccessful, it provides a detailed object regarding the error.

JSON

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "RedirectUrl": "https://dev-payment-agent.itspaywall.com/paywall/callbackapm?UniqueNumber=dd224827-8433-45f7-9454-97025e57fa9e",
        "Transaction": {
            "ApmTransactionId": 29,
            "UniqueCode": "dd224827-8433-45f7-9454-97025e57fa9e",
            "MerchantUniqueCode": "TESTMERCHANTUNIQUECODE",
            "Amount": 1.0
        }
    }
}