Skip to main content
GET
/
get-payout-summary
/
{id}
Retrieve payout summary by order ID
curl --request GET \
  --url https://sandbox.omnispay.com/api/get-payout-summary/{id} \
  --header 'X-HMAC-Signature: <api-key>' \
  --header 'accountId: <api-key>' \
  --header 'apiKey: <api-key>'
{
  "status": "<string>",
  "message": "<string>",
  "response": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.omnispay.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Retrieve Payout Summary by Order Id.

This endpoint retrieves payout summary from the database based on the provided order ID.

​
Path Parameters

  • id (string, required):
    The unique identifier of the payout summary record to be retrieved.
    • Example: 123457
    • If a valid ID is provided, the API will return the payout summary.
📌 How it Works
The system fetches payout summary for the given ID and returns payout summary.

​
Request Headers

  • User-Agent (string, optional): The User-Agent header, which is not mandatory.

​
Example Request

GET /get-payout-summary/123457
User-Agent: Mozilla/5.0

Authorizations

​
apiKey
string
header
required
​
X-HMAC-Signature
string
header
required
​
accountId
string
header
required

Headers

​
User-Agent
string

Path Parameters

​
id
string
required

Order ID for retrieving the payout summary report

Response

OK. Payout summary retrieved successfully

​
status
string
​
message
string
​
response
object