Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

Use this method to mark payments as synchronized with an external system. 

Tip

Valid Tokens: Company.


Filter by label (Content by label)
showLabelsfalse
max5
titleRelated Articles
cqllabel in ( "payment-api" , "payment" , "invoice" , "company-token" , "invoice-additional-charges" , "checkout-ecommerce" )

Request


URL: 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)

An array containing Komet Sales internal Payment IDs to mark as synchronized.


paymentId (required)(integer: 20)

Komet Sales internal Payment ID. 

You can get this ID using the payment.list API method.


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

Response


status (integer:1)

Transaction status.

Valid values: 1 = Success | 0 = Failure


payments (array)

An array containing payments with their status response. 


message (string:500)

Transaction status description.


status (integer:1)

Transaction status.

Valid values: 1 = Success | 0 = Failure


paymentId (integer: 20)

Payment ID.


Code Block
{
    "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
        }
    ]
}
We've encountered an issue exporting this macro. Please try exporting this page again later.