---
agentTools:
  projectIndex: https://zafepay.readme.io/llms.txt
---

# Single payment buyers

The list of all buyers that are inscribed to a specific Single Payment.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Onlypays",
    "version": "1"
  },
  "servers": [
    {
      "url": "https://api.staging.zafepay.com/api"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "x-bearer-format": "bearer"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/v1/integration/single_payments/{single_payment_id}/single_payment_buyers": {
      "get": {
        "summary": "Single payment buyers",
        "description": "The list of all buyers that are inscribed to a specific Single Payment.",
        "operationId": "single-payment-buyers",
        "parameters": [
          {
            "name": "Authorization",
            "in": "header",
            "description": "Header to access api endpoints (Check the authentication section).",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "description": "Single payment buyer status filter",
            "schema": {
              "type": "string",
              "enum": [
                "pending",
                "active",
                "indebt",
                "canceled",
                "finished"
              ]
            }
          },
          {
            "name": "statement_status",
            "in": "query",
            "description": "Installments status filter",
            "schema": {
              "type": "string",
              "enum": [
                "pending",
                "paid",
                "expired",
                "refunded",
                "processing_payment",
                "processing_refund",
                "refunded_manually"
              ]
            }
          },
          {
            "name": "payment_start_date",
            "in": "query",
            "description": "Filter Buyer with minimum payment date",
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "payment_end_date",
            "in": "query",
            "description": "Filter Buyer with maximum payment date",
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number to retrieve from a paginated collection",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 1
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"data\": [\n        {\n            \"id\": \"77f11da2-1ddc-4247-bc3b-0881723da677\",\n            \"buyer\": {\n                \"id\": \"0d27afe0-7a02-41e1-9494-a955c21c0a3a\",\n                \"created_at\": \"2023-10-10T12:35:13\",\n                \"email\": \"jhonsmith@gmail.com\",\n                \"external_id\": \"customer003\",\n                \"name\": \"Jhon Smith\",\n                \"updated_at\": \"2023-10-10T12:40:11\"\n            },\n            \"created_at\": \"2023-10-11T18:29:42\",\n            \"external_id\": \"sp001\",\n            \"extra_fields\": {\n                \"Age\": \"26\"\n            },\n            \"installment\": {\n                \"id\": \"2839e9db-ebfa-4819-a42c-abef5b669c96\",\n                \"amount\": 79970,\n                \"created_at\": \"2023-10-11T18:29:42\",\n                \"currency\": \"CLP\",\n                \"due_date\": null,\n                \"payment_date\": null,\n                \"status\": \"pending\",\n                \"updated_at\": \"2023-10-11T18:29:42\"\n            },\n            \"single_payment_id\": \"5d58d855-09ee-4087-bba3-3a000d36c1ea\",\n            \"status\": \"active\",\n            \"updated_at\": \"2023-10-11T18:29:42\"\n        }\n    ]\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "example": "77f11da2-1ddc-4247-bc3b-0881723da677"
                          },
                          "buyer": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "example": "0d27afe0-7a02-41e1-9494-a955c21c0a3a"
                              },
                              "created_at": {
                                "type": "string",
                                "example": "2023-10-10T12:35:13"
                              },
                              "email": {
                                "type": "string",
                                "example": "jhonsmith@gmail.com"
                              },
                              "external_id": {
                                "type": "string",
                                "example": "customer003"
                              },
                              "name": {
                                "type": "string",
                                "example": "Jhon Smith"
                              },
                              "updated_at": {
                                "type": "string",
                                "example": "2023-10-10T12:40:11"
                              }
                            }
                          },
                          "created_at": {
                            "type": "string",
                            "example": "2023-10-11T18:29:42"
                          },
                          "external_id": {
                            "type": "string",
                            "example": "sp001"
                          },
                          "extra_fields": {
                            "type": "object",
                            "properties": {
                              "Age": {
                                "type": "string",
                                "example": "26"
                              }
                            }
                          },
                          "installment": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "example": "2839e9db-ebfa-4819-a42c-abef5b669c96"
                              },
                              "amount": {
                                "type": "integer",
                                "example": 79970,
                                "default": 0
                              },
                              "created_at": {
                                "type": "string",
                                "example": "2023-10-11T18:29:42"
                              },
                              "currency": {
                                "type": "string",
                                "example": "CLP"
                              },
                              "due_date": {},
                              "payment_date": {},
                              "status": {
                                "type": "string",
                                "example": "pending"
                              },
                              "updated_at": {
                                "type": "string",
                                "example": "2023-10-11T18:29:42"
                              }
                            }
                          },
                          "single_payment_id": {
                            "type": "string",
                            "example": "5d58d855-09ee-4087-bba3-3a000d36c1ea"
                          },
                          "status": {
                            "type": "string",
                            "example": "active"
                          },
                          "updated_at": {
                            "type": "string",
                            "example": "2023-10-11T18:29:42"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false,
        "security": []
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "64c97d0ad3b2f2002d150a5d:6525fa5b21a11a01d9e134f6"
}
```