1. Perform Reconciliation

The Perform Reconciliation service retrieves daily figures from your system and returns whether the reconciliation was successful as a response.

Perform Reconciliation

POST {{Base Address}}/api/paywall/private/vpos/reconciliation/reconcile

Important: To use the Perform Reconciliation service, you must include the apikeyprivate and apiclientprivate parameters in the Header.

PaymentPrivateAPI Address

Parameter	Type	Compolsory	Description
apikeyprivate	string	Yes	The Private Key obtained from the merchant panel.
apiclientprivate	string	Yes	The Private Client obtained from the merchant panel.

Daily reconciliation can be performed after 00:30 (midnight) of the following day.

Example: The reconciliation for 06.06.2024 can be performed after 07.06.2024 00:30.

Once a reconciliation request is successfully completed, another reconciliation request for the same day cannot be submitted. If the reconciliation fails, a new request for the same day can be submitted with different values.

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

Parameter	Type	Compolsory	Description
Date	Date	Yes	Reconciliation date in yyyy-MM-dd format
TotalCount	int	Yes	Total number of transactions in your system
TotalAmount	decimal	Yes	Total transaction amount in your system
SuccessfulCount	int	Yes	Total number of successful transactions in your system
SuccessfulAmount	decimal	Yes	Total amount of successful transactions in your system
UnsuccessfulCount	int	Yes	Total number of failed transactions in your system
UnsuccessfulAmount	decimal	Yes	Total amount of failed transactions in your system
RefundCount	int	Yes	Total number of refunds in your system
RefundAmount	decimal	Yes	Total refund amount in your system
PartialRefundCount	int	Yes	Total number of partial refunds in your system
PartialRefundAmount	decimal	Yes	Total amount of partial refunds in your system
CancelCount	int	Yes	Total number of cancellations in your system
CancelAmount	decimal	Yes	Total cancellation amount in your system

JSON

{
    "Date": "2024-05-07",
    "TotalCount": 4,
    "TotalAmount": 46.00,
    "SuccessfulCount": 0,
    "SuccessfulAmount": 0.00,
    "UnsuccessfulCount": 1,
    "UnsuccessfulAmount": 13.00,
    "RefundCount": 0,
    "RefundAmount": 0.00,
    "PartialRefundCount": 0,
    "PartialRefundAmount": 0.00,
    "CancelCount": 0,
    "CancelAmount": 0.00
}

C#

// Soon

GO

// Soon

Java

// Soon

PHP

// Soon

Python

// Soon

Ruby

// Soon

TypeScript

// Soon

Curl

// Soon

Response returned from the service:

Parameter	Type	Description
Body	object	Detailed information about the reconciliation process is returned. You can create your objects using the information below
ErrorCode	int	Error code. Returns '0' if the operation is successful
Result	bool	Returns true or false. If the operation is successful, it returns true
Message	string	If the operation fails, it returns the relevant error message and provides language support based on the locale parameter

JSON

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "Reconciliation result is success",
    "Body": {
        "IsReconciled": true,
        "IsSaved": true,
        "ExistsReconciliation": false,
        "OperationDateTime": "2024-06-07T20:11:55.3150056+03:00",
        "ReconciliationDate": "2024-06-07T20:11:55.3160313+03:00",
        "Merchant": {
            "TotalCount": 4,
            "TotalAmount": 46.00,
            "SuccessfulCount": 0,
            "SuccessfulAmount": 0.00,
            "UnsuccessfulCount": 1,
            "UnsuccessfulAmount": 13.00,
            "RefundCount": 0,
            "RefundAmount": 0.00,
            "PartialRefundCount": 0,
            "PartialRefundAmount": 0.00,
            "CancelCount": 0,
            "CancelAmount": 0.00
        },
        "Paywall": {
            "EndOfDayId": 3417,
            "TotalCount": 4,
            "TotalAmount": 46.00,
            "SuccessfulCount": 0,
            "SuccessfulAmount": 0.00,
            "UnsuccessfulCount": 1,
            "UnsuccessfulAmount": 13.00,
            "RefundCount": 0,
            "RefundAmount": 0.00,
            "PartialRefundCount": 0,
            "PartialRefundAmount": 0.00,
            "CancelCount": 0,
            "CancelAmount": 0.00
        }
    }
}