---
updatedAt: 2026-04-06T17:19:31.000Z
agentTools:
  projectIndex: https://docs.pagar.me/v2/llms.txt
---

# Retornando Contratos

| Campo           | Descrição                       |
| :-------------- | :------------------------------ |
| Key             | Chave do contrato (contractKey) |
| contractHolder  | Credor                          |
| contractType    | Tipo de contrato                |
| isCanceled      | Ativo                           |
| createdAt       | Data da criação                 |
| bankAccount     | Domicílio Bancário              |
| tradeRepository | Registradora do credor          |
| PaymentScheme   | Arranjo de pagamento            |

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "api-settings",
    "version": "2"
  },
  "servers": [
    {
      "url": "https://api.pagar.me/1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "x-default": "",
        "type": "apiKey",
        "name": "api_key",
        "in": "query"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/register/settlement_obligations/contracts": {
      "get": {
        "summary": "Retornando Contratos",
        "description": "",
        "operationId": "retornando-contratos",
        "parameters": [
          {
            "name": "api_key",
            "in": "query",
            "description": "api_key do cliente",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "recipient_id",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "initial_expected_settlement_date",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "final_expected_settlement_date",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "format": "date"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "[\n    {\n        \"key\": \"016546874e-9571-9rt7-b789-1161r16r1618\",\n        \"contract_type\": \"OwnershipAssignment\",\n        \"created_at\": \"2023-09-01T18:23:00.867373Z\",\n        \"is_canceled\": false,\n        \"contract_holder\": \"20898464000024\",\n        \"bank_accounts\": [\n            {\n                \"branch\": \"0011\",\n                \"account\": \"018757\",\n                \"account_digit\": \"9\",\n                \"account_type\": \"CC\",\n                \"ispb\": \"012678971\",\n                \"document_type\": \"CNPJ\",\n                \"document_number\": \"20898464000024\"\n            }\n        ],\n        \"trade_repository\": \"310258107000093\"\n    }\n]"
                  }
                },
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "key": {
                        "type": "string",
                        "example": "016546874e-9571-9rt7-b789-1161r16r1618"
                      },
                      "contract_type": {
                        "type": "string",
                        "example": "OwnershipAssignment"
                      },
                      "created_at": {
                        "type": "string",
                        "example": "2023-09-01T18:23:00.867373Z"
                      },
                      "is_canceled": {
                        "type": "boolean",
                        "example": false,
                        "default": true
                      },
                      "contract_holder": {
                        "type": "string",
                        "example": "20898464000024"
                      },
                      "bank_accounts": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "branch": {
                              "type": "string",
                              "example": "0011"
                            },
                            "account": {
                              "type": "string",
                              "example": "018757"
                            },
                            "account_digit": {
                              "type": "string",
                              "example": "9"
                            },
                            "account_type": {
                              "type": "string",
                              "example": "CC"
                            },
                            "ispb": {
                              "type": "string",
                              "example": "012678971"
                            },
                            "document_type": {
                              "type": "string",
                              "example": "CNPJ"
                            },
                            "document_number": {
                              "type": "string",
                              "example": "20898464000024"
                            }
                          }
                        }
                      },
                      "trade_repository": {
                        "type": "string",
                        "example": "310258107000093"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```