---
updatedAt: 2026-04-21T20:06:09.000Z
agentTools:
  projectIndex: https://docs.gifq.com/llms.txt
---

# List payout orders

Returns a paginated list of all payout orders for the authenticated company. Results can be narrowed down by status or campaign. Total result count is provided via the `total-count` response header.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "GIFQ External API Reference",
    "version": "v1",
    "description": "Public API documentation for GIFQ external partners."
  },
  "components": {
    "securitySchemes": {
      "X-Api-Token": {
        "type": "apiKey",
        "name": "X-Api-Token",
        "in": "header",
        "description": "API token for authentication"
      }
    }
  },
  "paths": {
    "/api/payout-orders": {
      "get": {
        "summary": "List payout orders",
        "tags": [
          "Payout Orders"
        ],
        "description": "Returns a paginated list of all payout orders for the authenticated company. Results can be narrowed down by status or campaign. Total result count is provided via the `total-count` response header.",
        "security": [
          {
            "X-Api-Token": []
          }
        ],
        "parameters": [
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Filter by payout order status. Accepted values: `pending`, `processing`, `completed`, `failed`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "campaign_id",
            "in": "query",
            "required": false,
            "description": "Filter results to payout orders belonging to a specific campaign",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "List of payout orders",
            "content": {
              "application/json": {
                "example": [
                  {
                    "id": "9f15af6b-d81a-428a-96a3-2f3fef6e9770",
                    "campaign_id": "41f6f67b-d1f4-40e6-8703-84bd38c60680",
                    "total_amount": 500,
                    "subtotal": 0,
                    "fx_fee_amount": 0,
                    "currency": "GBP",
                    "status": "completed",
                    "created_at": "2026-10-05T10:22:20.888Z",
                    "updated_at": "2026-10-05T10:22:20.888Z",
                    "recipients_summary": {
                      "total": 0,
                      "remaining_amount": 0
                    }
                  },
                  {
                    "id": "5856559a-5fad-4ad7-be2f-52906b8761f1",
                    "campaign_id": "41f6f67b-d1f4-40e6-8703-84bd38c60680",
                    "total_amount": 500,
                    "subtotal": 0,
                    "fx_fee_amount": 0,
                    "currency": "GBP",
                    "status": "pending",
                    "created_at": "2026-10-05T10:22:20.887Z",
                    "updated_at": "2026-10-05T10:22:20.887Z",
                    "recipients_summary": {
                      "total": 0,
                      "remaining_amount": 0
                    }
                  }
                ],
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "id",
                      "campaign_id",
                      "total_amount",
                      "subtotal",
                      "fx_fee_amount",
                      "currency",
                      "status",
                      "created_at",
                      "updated_at",
                      "recipients_summary"
                    ],
                    "properties": {
                      "id": {
                        "type": "string",
                        "description": "Unique payout order identifier"
                      },
                      "campaign_id": {
                        "type": "string",
                        "description": "ID of the campaign this payout order belongs to"
                      },
                      "total_amount": {
                        "type": "number",
                        "description": "Total amount charged to your wallet, including fees"
                      },
                      "subtotal": {
                        "type": "number",
                        "description": "Sum of all recipient gift card amounts before fees"
                      },
                      "fx_fee_amount": {
                        "type": "number",
                        "description": "Foreign exchange fee applied when the wallet currency differs from recipient currencies"
                      },
                      "currency": {
                        "type": "string",
                        "description": "ISO currency code of the wallet charged for this order"
                      },
                      "status": {
                        "type": "string",
                        "enum": [
                          "pending",
                          "processing",
                          "completed",
                          "failed"
                        ],
                        "description": "Current processing status of the payout order"
                      },
                      "created_at": {
                        "type": "string",
                        "format": "date-time",
                        "description": "Timestamp when the payout order was created"
                      },
                      "updated_at": {
                        "type": "string",
                        "format": "date-time",
                        "description": "Timestamp when the payout order was last updated"
                      },
                      "recipients_summary": {
                        "type": "object",
                        "required": [
                          "total",
                          "remaining_amount"
                        ],
                        "description": "Aggregated summary of recipients in this order",
                        "properties": {
                          "total": {
                            "type": "integer",
                            "description": "Total number of recipients in this order"
                          },
                          "remaining_amount": {
                            "type": "number",
                            "description": "Combined remaining unredeemed amount across all recipients"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Missing or incorrect API token",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "example": {
                    "message": "Unauthorized",
                    "status": "error"
                  },
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    },
                    "status": {
                      "type": "string",
                      "example": "error"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Access denied",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "example": {
                    "message": "Forbidden",
                    "status": "error"
                  },
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    },
                    "status": {
                      "type": "string",
                      "example": "error"
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "Validation failed — unrecognized status value",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "example": {
                    "message": "Invalid status filter",
                    "status": "error"
                  },
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Error message"
                    },
                    "status": {
                      "type": "string",
                      "example": "error"
                    }
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too many requests",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "Too many requests. Try again later."
                    },
                    "status": {
                      "type": "string",
                      "example": "error"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://{environment}.gifq.com",
      "variables": {
        "environment": {
          "default": "api-sandbox",
          "enum": [
            "api",
            "api-sandbox"
          ]
        }
      }
    }
  ]
}
```