GET
/
orders
/
payments
curl --request GET \
  --url https://services.commercengine.dev/api/v1/x2yh61zw4k/admin/orders/payments \
  --header 'Authorization: Bearer <token>'
{
  "message": "<string>",
  "success": true,
  "content": {
    "payments": [
      {
        "transaction_type": "payment",
        "transaction_date": "2023-11-07T05:31:56Z",
        "transaction_amount": 123,
        "settled_amount": 0,
        "unsettled_amount": 0,
        "reference_number": "<string>",
        "payment_method": "Credit Card",
        "payment_mode": "Bank-Transfer",
        "payment_gateway": "Bank-Transfer",
        "status": "settled",
        "customer_id": "<string>",
        "customer_name": "<string>"
      }
    ],
    "pagination": {
      "total_records": 123,
      "total_pages": 123,
      "previous_page": "<any>",
      "limit": 123,
      "next_page": "<any>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer

page number of pagination list

Required range: x > 1
​
limit
integer

no of rows per page

Required range: x > 1
​
sort_by
string

JSON string format: {"field1":"asc", "field2":"desc"}

​
filters
string

JSON - array of objects

​
search
string

search keyword

Response

200 - application/json
OK
​
message
string
​
success
boolean
​
content
object
Create a segmentCreate payment