Receive Check

Overview

In order to receive payment via check, you can do it by calling endpoint described in this article.

In order to consume the endpoint you must:

  • Be authenticated user

For information on how you can authenticate, see: Authentication

As soon as you do authentication and receive a valid token, it needs to be passed on the next call

  • Have valid ID of an existing order

Endpoint

Example for such endpoint for TT server is https://tt.api.sellercloud.com/rest/api/orders/{orderID}/receiveCheck/

For your server 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
  • Body data:

    ParameterData TypeDescriptionIs Required
    orderIDintegerID of existing order.yes
    AmountdecimalAmount received via check. Mandatory field.yes
    NotesstringAdditional notes for the payment. Optional field.no
    CheckNumberstringNumber of the check. Mandatory field.yes

Response

  • If server error appears, then response will be with status code 500 => Internal Server Error
  • If payment is successful, response will be with status code 200 => Ok

Was this article helpful?

Next
Mark Orders as Exported or Not Exported