Azeez Muibi
125 lines
3.0 KiB
JSON
125 lines
3.0 KiB
JSON
{
|
|
"get": {
|
|
"tags": ["Transaction Offers"],
|
|
"summary": "Get all transaction offers with optional filtering",
|
|
"description": "Retrieve transaction offers with various filter options including customer ID, transaction ID, offer ID, etc.",
|
|
"operationId": "getTransactionOffers",
|
|
"parameters": [
|
|
{
|
|
"name": "customer_id",
|
|
"in": "query",
|
|
"description": "Filter by customer ID",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"example": "CUST123"
|
|
},
|
|
{
|
|
"name": "transaction_id",
|
|
"in": "query",
|
|
"description": "Filter by transaction ID",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"example": "TRX123456"
|
|
},
|
|
{
|
|
"name": "offer_id",
|
|
"in": "query",
|
|
"description": "Filter by offer ID",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"example": "OFFER456"
|
|
},
|
|
{
|
|
"name": "product_id",
|
|
"in": "query",
|
|
"description": "Filter by product ID",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"example": "PROD789"
|
|
},
|
|
{
|
|
"name": "original_transaction",
|
|
"in": "query",
|
|
"description": "Filter by original transaction ID",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"example": "TRX789012"
|
|
},
|
|
{
|
|
"name": "start_date",
|
|
"in": "query",
|
|
"description": "Filter by start date (ISO format)",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"example": "2023-01-01T00:00:00Z"
|
|
},
|
|
{
|
|
"name": "end_date",
|
|
"in": "query",
|
|
"description": "Filter by end date (ISO format)",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"example": "2023-12-31T23:59:59Z"
|
|
},
|
|
{
|
|
"name": "page",
|
|
"in": "query",
|
|
"description": "Page number for pagination",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer",
|
|
"default": 1,
|
|
"minimum": 1
|
|
},
|
|
"example": 1
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "Number of items per page (max 100)",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer",
|
|
"default": 20,
|
|
"minimum": 1,
|
|
"maximum": 100
|
|
},
|
|
"example": 20
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful operation",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "../schemas/TransactionOffersResponse.json"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid request"
|
|
},
|
|
"500": {
|
|
"description": "Internal server error"
|
|
}
|
|
}
|
|
}
|
|
} |