Receive payment via credit card

Overview

In order to receive payment via credit card, 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}/ReceivePayment/

For your server endpoint will be:

https://{your_server_id}.api.sellercloud.com/rest/api/orders/{orderID}/ReceivePayment/

Request

  • Method Type: HttpPut
  • Authorization: Use Bearer Token + token received from token authentication
  • Header info: Content-Type: application/json
  • Body data:

    Parameter Data Type Description Is Required
    orderID integer ID of existing order. yes
    Amount decimal Amount to receive. Mandatory field. yes
    Notes string Additional notes for the payment. Optional field. no
    CardName string Name of the card holder. Yes
    CardNumber string Card number. Mandatory. Yes
    Month int Expiration month. Mandatory Yes
    Year int Expiration Year. Mandatory Yes
    CVV int CVV code. Mandatory 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?

Receive payment via credit card

Overview

In order to receive payment via credit card, 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}/ReceivePayment/

For your server endpoint will be:

https://{your_server_id}.api.sellercloud.com/rest/api/orders/{orderID}/ReceivePayment/

Request

  • Method Type: HttpPut
  • Authorization: Use Bearer Token + token received from token authentication
  • Header info: Content-Type: application/json
  • Body data:

    Parameter Data Type Description Is Required
    orderID integer ID of existing order. yes
    Amount decimal Amount to receive. Mandatory field. yes
    Notes string Additional notes for the payment. Optional field. no
    CardName string Name of the card holder. Yes
    CardNumber string Card number. Mandatory. Yes
    Month int Expiration month. Mandatory Yes
    Year int Expiration Year. Mandatory Yes
    CVV int CVV code. Mandatory 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?