2. Start

Within the scope of the marketplace, you can trigger your pending payouts in the pool and issue a payment order through this service.

Initiate Payment Order

POST {{Base Adres}}/api/paywall/marketplace/manual/trigger/start

Important: To use the Initiate Payment Order service, you must include the apikeypublic and apiclientpublic parameters in the Header section. PaymentAPI Address

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

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

Parameter	Type	Compolsory	Description
CurrencyId	short	Yes	Currency
DateFrom	datetime	Yes	Start date Format: yyyy-MM-dd
DateTo	datetime	Yes	Start date Format: yyyy-MM-dd
TestMode	bool	No	Under normal conditions, the payment initiation service allows the DateTo parameter to have a maximum value of yesterday’s date. For example, for a payment order given on 2024-05-05, the maximum allowed DateTo would be 2024-05-04, since payments may still be processed for today. However, when TestMode is set to true, this validation is bypassed.
SkipExistsControl	bool	No	Attention should be paid to the DateFrom and DateTo values in the issued distribution orders. If a payment order is issued with a DateFrom of 2024-05-01 and a DateTo of 2025-05-30, and this order is successfully completed, another order cannot be issued for the same dates or any date within that range. However, you may bypass this validation if needed. In cases where this validation is bypassed, all risk management responsibilities lie with the merchant.

The sample JSON to be sent to the service and example code are as follows:

JSON

{
    "CurrencyId": 1,
    "DateFrom": "2024-07-04",
    "DateTo": "2024-07-06",
    "TestMode": false,
    "SkipExistsControl": false
}

C#

GO

Java

PHP

Python

Ruby

TypeScript

Curl

Response returned from the service:

Parameter	Type	Description
ErrorCode	int	Error code. Returns '0' if the operation is successful.
Result	bool	Returns either true or false. Returns 'true' if the operation is successful.
Message	string	If the operation fails, this is the error message provided. It offers language support based on the locale parameter.
Body	object	Operation detail information

JSON

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "JobId": "2501b2de-1e4f-48f9-8263-5bc51b92e193", // İşlem takip kodu
        "DateFrom": "2024-06-01T00:00:00",
        "DateTo": "2024-06-07T00:00:00",
        "Earning": 9400.0000,
        "Count": 1
    }
}