List Orders

API Version: 3.0.0

Fetch a transaction list with date range and other filters. Use this endpoint to retrieve a paginated list of orders.

Navigate to Developers → API Keys → Add new API key → Select Hosted Solution in the Channel Dropdown to generate your API credentials.

Endpoint

Method	URL
GET	`https://api.payorc.com/orders/v1/transaction-list`

Please use the test credentials for sandbox testing.

Headers

Header	Type	Required	Description
`merchant-key`	String	Yes	Your merchant API key (e.g., `live-D111PIS13YK`)
`merchant-secret`	String	Yes	Your merchant API secret (e.g., `sec-JI11G0P13Z0`)

Query Parameters

Parameter	Type	Required	Description
`page`	Integer	No	Page number (starts from 1). When provided, pagination is applied
`perpage`	Integer	No	Records per page (default `100`, max `100`)
`p_order_id`	String	No	Filter by PayOrc order ID
`transaction_id`	String	No	Filter by transaction / payment ID
`status`	String	No	Filter by order status (e.g. `CAPTURED`, `AUTHORISED`, `VOID`, `REFUNDED`)
`payment_method`	String	No	Filter by payment mode / method value stored on the order
`payment_method_id`	String	No	Filter by card PAN / payment method id
`m_payment_token`	String	No	Filter by card token
`card_bin`	String	No	Filter by card BIN (first digits)
`processor`	String	No	Filter by PSP processor code
`currency_code`	String	No	Filter by ISO currency code
`from_date`	String	No	Start date (`YYYY-MM-DD`)
`to_date`	String	No	End date (`YYYY-MM-DD`)
`min_amount`	String	No	Minimum transaction amount
`max_amount`	String	No	Maximum transaction amount
`m_customer_id`	String	No	Filter by merchant customer ID
`customer_email`	String	No	Filter by customer email
`customer_mobile`	String	No	Filter by customer mobile
`customer_country`	String	No	Filter by billing country

Use status, not status_code. The API ignores status_code.

Code Examples

Example 1: List with pagination

curl --location 'https://api.payorc.com/orders/v1/transaction-list?page=1&perpage=10' \
--header 'merchant-key: {merchant-key}' \
--header 'merchant-secret: {merchant-secret}'

Example 2: Filter by Status and Date Range

curl --location 'https://api.payorc.com/orders/v1/transaction-list?status=CAPTURED&from_date=2024-01-01&to_date=2024-12-31&page=1&perpage=50' \
--header 'merchant-key: {merchant-key}' \
--header 'merchant-secret: {merchant-secret}'

Response — Success (200)

{
    "data": [
        {
            "m_order_id": "123460",
            "p_order_id": "1000012020",
            "p_request_id": 1000011100,
            "psp_ref_id": "cac9b7ca-3e84-46b1-88f4-1df276b82847",
            "transaction_id": "1000012325",
            "psp_txn_id": "583090c6-4e9f-440d-9bfc-13153de0a5cd",
            "transaction_date": "17-01-2025 09:43:08",
            "status": "CAPTURED",
            "currency": "AED",
            "amount": "310.01",
            "amount_captured": "310.01",
            "psp": "NI",
            "payment_method": "DEBIT CARD",
            "m_customer_id": "1234",
            "m_payment_token": "REhzWEgxTXl1cXlJVHNOUHljWHZZQT09",
            "payment_method_data": {
                "scheme": "VISA",
                "card_country": "POLAND",
                "card_type": "DEBIT",
                "masked_pan": "411111******1111"
            },
            "apm_name": "",
            "apm_identifier": "",
            "sub_merchant_identifier": "0000001185",
            "channel": "HOSTED",
            "channel_id": "1",
            "parameters": [
                {"alpha": ""},
                {"beta": ""},
                {"gamma": ""},
                {"delta": ""},
                {"epsilon": ""}
            ],
            "custom_data": [
                {"alpha": ""},
                {"beta": ""},
                {"gamma": ""},
                {"delta": ""},
                {"epsilon": ""}
            ]
        }
    ],
    "message": "Successfully fetched list",
    "status": "success",
    "code": "00",
    "total_records": 1990
}

Response Fields

Field	Type	Description
`data`	Array	Array of transaction objects
`message`	String	Response message
`status`	String	`success` or `fail`
`code`	String	`00` for success
`total_records`	Integer	Total number of records matching the filter

Transaction Object

Field	Type	Description
`m_order_id`	String	Order ID provided by the merchant
`p_order_id`	String	Order ID created by PayOrc
`p_request_id`	Integer	Request ID created by PayOrc
`psp_ref_id`	String	Reference ID associated with the PSP submission
`transaction_id`	String	Transaction / payment ID
`psp_txn_id`	String	PSP transaction ID
`transaction_date`	String	Transaction timestamp
`status`	String	Current status of the transaction
`currency`	String	Currency of the transaction
`amount`	String	Transaction amount
`amount_captured`	String	Amount captured so far
`psp`	String	Payment service provider code
`payment_method`	String	Payment method used
`m_customer_id`	String	Merchant customer ID
`m_payment_token`	String	Payment token
`apm_name`	String	Alternative Payment Method name
`apm_identifier`	String	APM identifier
`sub_merchant_identifier`	String	Sub-merchant identifier
`channel`	String	Order origin / channel
`channel_id`	String	Channel identifier

Response — Error (4xx)

{
    "message": "Invalid merchant key and secret",
    "status": "fail",
    "code": "401"
}

List Orders

On this page