Receive Check

Updated 2 weeks ago ​by nussi

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:
        {
            "OrderID": 13232,
            "model": 
                   {
                       "Amount": 100,
                       "Notes": "received payment via check",
                       "CheckNumber": "39393838488383"
                   }
        }

    Parameter

    Data Type

    Description

    Is Required

    orderID

    integer

    ID of existing order.

    yes

    Amount

    decimal

    Amount received via check. Mandatory field.

    yes

    Notes

    string

    Additional notes for the payment. Optional field.

    no

    CheckNumber

    string

    Number 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

How did we do?