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

# List payouts

Returns a paginated list of all payouts for the authenticated company. Results can be narrowed down by campaign, payout order, or recipient email. 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/payouts": {
      "get": {
        "summary": "List payouts",
        "tags": [
          "Payouts"
        ],
        "description": "Returns a paginated list of all payouts for the authenticated company. Results can be narrowed down by campaign, payout order, or recipient email. Total result count is provided via the `total-count` response header.",
        "security": [
          {
            "X-Api-Token": []
          }
        ],
        "parameters": [
          {
            "name": "campaign_id",
            "in": "query",
            "required": false,
            "description": "Filter results to payouts belonging to a specific campaign",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "payout_order_id",
            "in": "query",
            "required": false,
            "description": "Filter results to payouts belonging to a specific payout order",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "recipient[email]",
            "in": "query",
            "required": false,
            "description": "Filter results to payouts issued to a specific recipient email address",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "type",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "gift_cards",
                "crypto"
              ]
            },
            "description": "Filter results to a single payout type. Returns both types when omitted."
          }
        ],
        "responses": {
          "200": {
            "description": "List of payouts",
            "content": {
              "application/json": {
                "example": [
                  {
                    "id": "9d77a384-9df7-45da-88dd-1f0fbaa21b88",
                    "type": "gift_card",
                    "status": "processing",
                    "created_at": "2026-10-05T10:22:13.021Z",
                    "gift_card": {
                      "brand_id": "f57977d3-d5c1-47db-8994-769c7a6f68aa",
                      "brand": "Brand 23",
                      "amount": 25,
                      "currency": "GBP",
                      "countries": []
                    },
                    "deduction": {
                      "amount": 25,
                      "currency": "GBP"
                    },
                    "recipient": {
                      "name": "John Doe",
                      "email": "recipient1@example.com"
                    },
                    "provider_reference": null
                  }
                ],
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "required": [
                      "id",
                      "status",
                      "created_at",
                      "gift_card",
                      "deduction",
                      "recipient",
                      "provider_reference"
                    ],
                    "properties": {
                      "id": {
                        "type": "string",
                        "description": "Unique payout identifier"
                      },
                      "status": {
                        "type": "string",
                        "enum": [
                          "processing",
                          "fulfilled",
                          "failed"
                        ],
                        "description": "Current processing status of the payout"
                      },
                      "created_at": {
                        "type": "string",
                        "format": "date-time",
                        "description": "Timestamp when the payout was created"
                      },
                      "gift_card": {
                        "type": "object",
                        "required": [
                          "brand_id",
                          "brand",
                          "amount",
                          "currency",
                          "countries"
                        ],
                        "properties": {
                          "brand_id": {
                            "type": "string",
                            "description": "Unique identifier of the gift card brand"
                          },
                          "brand": {
                            "type": "string",
                            "description": "Display name of the gift card brand"
                          },
                          "amount": {
                            "type": "number",
                            "description": "Face value of the issued gift card"
                          },
                          "currency": {
                            "type": "string",
                            "description": "ISO currency code of the gift card"
                          },
                          "countries": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "description": "ISO country codes where this gift card is redeemable"
                          }
                        }
                      },
                      "deduction": {
                        "type": "object",
                        "required": [
                          "amount",
                          "currency"
                        ],
                        "properties": {
                          "amount": {
                            "type": "number",
                            "nullable": true,
                            "description": "Amount deducted from your balance. Null if not yet settled."
                          },
                          "currency": {
                            "type": "string",
                            "description": "ISO currency code of the deduction"
                          }
                        }
                      },
                      "recipient": {
                        "type": "object",
                        "required": [
                          "name",
                          "email"
                        ],
                        "properties": {
                          "name": {
                            "type": "string",
                            "nullable": true,
                            "description": "Full name of the recipient"
                          },
                          "email": {
                            "type": "string",
                            "description": "Email address of the recipient"
                          }
                        }
                      },
                      "provider_reference": {
                        "type": "string",
                        "nullable": true,
                        "description": "Reference ID returned by the gift card provider. Null while the payout is still processing."
                      }
                    }
                  }
                }
              }
            }
          },
          "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"
                    }
                  }
                }
              }
            }
          },
          "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"
          ]
        }
      }
    }
  ]
}
```