Receive Manual Payment

Updated 2 weeks ago ​by nussi

Overview

In order to receive manual payment, 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}/receiveManualPayment/

For your server endpoint will be:

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

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": "receiving manual payment note",
    "PaymentMethod": "4",
    "ReferenceNumber": "test reference number"
    }
    }

    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

    PaymentMethod

    enum

    Mandatory field specifying if received by cash, email, paypal, gift certificate etc.

    For info about all options: check at the bottom of the article.

    yes

    ReferenceNumber

    string

    Reference number.

    Reference number is optional only for Cash and PayPal methods.

    For other methods its mandatory field.

    Depends

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

Payment Methods

{
Cash = 0,
Email = 1,
GiftCertificate = 2,
Other = 3,
PayPal = 4,
PurchaseOrder = 5,
Telephone = 6,
Wire = 7
}


How did we do?