Receive Check - Sellercloud API Docs

Overview

This endpoint allows you to receive a check payment for a single existing sales order. To consume it, you must be an Authenticated User. Once you have obtained a valid token, you must pass it to the call. Additionally, you need a valid ID of an existing order.

Endpoint

An example of this endpoint for server XX:

https:// xx.api.sellercloud.com/rest/api/Orders/{orderID}/ReceiveCheck

For your server, the endpoint will be:

https:// {your_server_id}.api.sellercloud.com/rest/api/Orders/{orderID}/ReceiveCheck

Request

Method Type: HttpPut
Authorization: Use Bearer Token + token received from token authentication
Header info: Content-Type: application/json
Path: Valid Sellercloud ID of a sales order.
Parameters (body):


Parameter	Data Type	Description	Is Required
Amount	decimal	Amount received via check.	yes
Notes	string	Additional notes for the payment.	no
CheckNumber	string	Number of the check.	yes

Request Body

{
  "Amount": 0,
  "Notes": "string",
  "CheckNumber": "string"
}

Response

If the user is authenticated and provides a valid Order ID, the response will be Status Code 200 => OK.
If the user is not authenticated, the response will be Status Code 401 => Not Valid Token.
In case of an error, the response will be Status Code 500 => Internal Server Error.