List orders

GET /v0/orders

List orders

cURL

curl --request GET \
  --url https://api.paygentic.io/v0/orders \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.paygentic.io/v0/orders"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paygentic.io/v0/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.paygentic.io/v0/orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.paygentic.io/v0/orders"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.paygentic.io/v0/orders")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paygentic.io/v0/orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "order",
      "merchantId": "<string>",
      "customerId": "<string>",
      "resellerId": "<string>",
      "taxExempt": true,
      "sellingEntity": "<string>",
      "currency": "<string>",
      "cancelledAt": "2023-11-07T05:31:56Z",
      "termStartDate": "2023-11-07T05:31:56Z",
      "termEndDate": "2023-11-07T05:31:56Z",
      "totalAmount": "<string>",
      "defaultPaymentTermDays": 123,
      "metadata": {},
      "lineItems": [
        {
          "id": "<string>",
          "object": "order_line_item",
          "orderId": "<string>",
          "quantity": "<string>",
          "listUnitPrice": "<string>",
          "discountUnitAmount": "<string>",
          "unitPrice": "<string>",
          "totalPrice": "<string>",
          "termStartDate": "2023-11-07T05:31:56Z",
          "termEndDate": "2023-11-07T05:31:56Z",
          "metadata": {},
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "itemId": "<string>",
          "description": "<string>"
        }
      ],
      "billingSchedules": [
        {
          "id": "<string>",
          "object": "billing_schedule",
          "merchantId": "<string>",
          "startDate": "2023-11-07T05:31:56Z",
          "endDate": "2023-11-07T05:31:56Z",
          "billingAnchor": "2023-11-07T05:31:56Z",
          "metadata": {},
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "orderId": "<string>",
          "subscriptionId": "<string>",
          "paymentTermDays": 123
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "closeDate": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

Authorizations

Authorization · string · header · required

API key authentication

Query Parameters

merchantId · string

Filter by merchant

customerId · string

Filter by customer

status · enum<string>

Filter by status

Available options: draft, pending, approved, rejected, cancelled

type · enum<string>

Filter by type

Available options: new_business, renewal, expansion

limit · integer · default: 50

Required range: 1 <= x <= 100

offset · integer · default: 0

Required range: x >= 0

Response

200

application/json

List of orders

object · enum<string> · required

Available options: list

data · object[] · required

Show child attributes

pagination · object · required

Offset-based pagination response.

Show child attributes