Overview

This method allows you to mark payments as synchronized with an external system. 

Request

https://api.kometsales.com/api/payment.mark.sync

  • Method: POST
  • Content-Type: application/json


Input Parameters:

  • authenticationToken (required)(string:50): Komet Sales security token.
  • payments (required) (array): list of payments IDs from Komet Sales that you want to mark as synchronized. 
    • paymentId (required)(integer: 20): Payment Id. In order to get these IDs, you can use the payment.list API method.

Sample
{
    "authenticationToken":"token_info_goes_here",
    "payments":[
		{"paymentId": 450545},
		{"paymentId": 451181},
		{"paymentId": 47873233}
	]
}

Response

Output:

  • status (integer:1): transaction status. 1 for success or 0 for failure.
  • payments (array): list of payments with their corresponding response. 
    • message (string:500): description of the status of the transaction.
    • status (integer:1): transaction status. 1 for success or 0 for failure.
    • paymentId (integer: 20): Payment Id.

Output example
{
    "status": "1",
    "payments": [
		{
            "message": "The payment was successfully synchronized",
            "status": "1",
            "paymentId": 450545
        },
        {
            "message": "The payment was cancelled",
            "status": "0",
            "paymentId": 451181
        },
        {
            "message": "The payment doesn't exist",
            "status": "0",
            "paymentId": 47873233
        }
    ]
}
Related Articles