> For the complete documentation index, see [llms.txt](https://readme.streampayments.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://readme.streampayments.io/readme/api-reference/models-1.md).

# Models

## The DisburseRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"Payout API","version":"1.0"},"components":{"schemas":{"DisburseRequestDto":{"required":["amount","currencyCode","description","receiver","receivingInstitution","transactionId","transferType"],"type":"object","properties":{"currencyCode":{"pattern":"[A-Z]{3}","type":"string","description":"Código ISO 4217 de la moneda (3 letras)"},"transactionId":{"maxLength":50,"minLength":1,"type":"string","description":"Identificador único de la transacción. Alfanumérico de 1 a 50 caracteres"},"description":{"maxLength":100,"minLength":1,"type":"string","description":"Descripción del pago. De 1 a 100 caracteres"},"amount":{"type":"string","description":"Monto del pago en formato string numérico"},"transferType":{"pattern":"WALLET|BANK","type":"string","description":"Tipo de transferencia (p.ej. WALLET, BANK)"},"receiver":{"$ref":"#/components/schemas/ReceiverDto"},"receivingInstitution":{"$ref":"#/components/schemas/ReceivingInstitutionDto"},"extraInformation":{"$ref":"#/components/schemas/ExtraInformationDto"}},"description":"DTO para solicitar un desembolso de pago"},"ReceiverDto":{"required":["documentNumber","documentType","email","lastName","name"],"type":"object","properties":{"name":{"maxLength":50,"minLength":1,"type":"string","description":"Nombre del receptor"},"lastName":{"maxLength":50,"minLength":1,"type":"string","description":"Apellido del receptor"},"userName":{"maxLength":30,"minLength":0,"type":"string","description":"Nombre de usuario del receptor"},"email":{"type":"string","description":"Correo electrónico del receptor"},"documentNumber":{"type":"string","description":"Número de documento del receptor"},"documentType":{"pattern":"DT\\d{2}","type":"string","description":"Tipo de documento del receptor"},"customId":{"maxLength":30,"minLength":0,"type":"string","description":"Identificador personalizado del receptor"}},"description":"DTO con información del receptor del desembolso"},"ReceivingInstitutionDto":{"required":["institutionCode"],"type":"object","properties":{"institutionCode":{"type":"string","description":"Código de la institución que procesa el pago"},"accountType":{"pattern":"AT001|AT002","type":"string","description":"Tipo de cuenta para transferencias propias (AT001=Cuenta de ahorros, AT002=Cuenta corriente)"},"accountNumber":{"pattern":"\\d+","type":"string","description":"Número de cuenta para transferencias bancarias propias"},"cciNumber":{"pattern":"\\d{20}","type":"string","description":"Número de CCI para pagos interbancarios"},"phoneNumber":{"pattern":"\\d{9}","type":"string","description":"Número de teléfono para pagos por WALLET"}},"description":"    DTO con información de la institución receptora del pago.\n    Para CCI: institutionCode + cciNumber.\n    Para WALLET: institutionCode + phoneNumber.\n    Para cuentas propias: accountNumber + accountType + institutionCode.\n"},"ExtraInformationDto":{"type":"object","properties":{"referenceId":{"maxLength":20,"minLength":0,"type":"string","description":"Identificador de referencia externo asociado al pago"},"extraInfo":{"maxLength":100,"minLength":0,"type":"string","description":"Información adicional personalizada para el desembolso"}},"description":"DTO con información adicional opcional para el desembolso"}}}}
```

## The ExtraInformationDto object

```json
{"openapi":"3.0.1","info":{"title":"Payout API","version":"1.0"},"components":{"schemas":{"ExtraInformationDto":{"type":"object","properties":{"referenceId":{"maxLength":20,"minLength":0,"type":"string","description":"Identificador de referencia externo asociado al pago"},"extraInfo":{"maxLength":100,"minLength":0,"type":"string","description":"Información adicional personalizada para el desembolso"}},"description":"DTO con información adicional opcional para el desembolso"}}}}
```

## The ReceiverDto object

```json
{"openapi":"3.0.1","info":{"title":"Payout API","version":"1.0"},"components":{"schemas":{"ReceiverDto":{"required":["documentNumber","documentType","email","lastName","name"],"type":"object","properties":{"name":{"maxLength":50,"minLength":1,"type":"string","description":"Nombre del receptor"},"lastName":{"maxLength":50,"minLength":1,"type":"string","description":"Apellido del receptor"},"userName":{"maxLength":30,"minLength":0,"type":"string","description":"Nombre de usuario del receptor"},"email":{"type":"string","description":"Correo electrónico del receptor"},"documentNumber":{"type":"string","description":"Número de documento del receptor"},"documentType":{"pattern":"DT\\d{2}","type":"string","description":"Tipo de documento del receptor"},"customId":{"maxLength":30,"minLength":0,"type":"string","description":"Identificador personalizado del receptor"}},"description":"DTO con información del receptor del desembolso"}}}}
```

## The ReceivingInstitutionDto object

```json
{"openapi":"3.0.1","info":{"title":"Payout API","version":"1.0"},"components":{"schemas":{"ReceivingInstitutionDto":{"required":["institutionCode"],"type":"object","properties":{"institutionCode":{"type":"string","description":"Código de la institución que procesa el pago"},"accountType":{"pattern":"AT001|AT002","type":"string","description":"Tipo de cuenta para transferencias propias (AT001=Cuenta de ahorros, AT002=Cuenta corriente)"},"accountNumber":{"pattern":"\\d+","type":"string","description":"Número de cuenta para transferencias bancarias propias"},"cciNumber":{"pattern":"\\d{20}","type":"string","description":"Número de CCI para pagos interbancarios"},"phoneNumber":{"pattern":"\\d{9}","type":"string","description":"Número de teléfono para pagos por WALLET"}},"description":"    DTO con información de la institución receptora del pago.\n    Para CCI: institutionCode + cciNumber.\n    Para WALLET: institutionCode + phoneNumber.\n    Para cuentas propias: accountNumber + accountType + institutionCode.\n"}}}}
```

## The CreatePayoutResponse object

```json
{"openapi":"3.0.1","info":{"title":"Payout API","version":"1.0"},"components":{"schemas":{"CreatePayoutResponse":{"type":"object","properties":{"merchantCode":{"type":"string"},"currencyCode":{"type":"string"},"countryCode":{"type":"string"},"transactionId":{"type":"string"},"amount":{"type":"string"},"createdDate":{"type":"string"},"msgDescription":{"type":"string"},"payout_id":{"type":"string"}}}}}}
```

## The PayoutResponse object

```json
{"openapi":"3.0.1","info":{"title":"Payout API","version":"1.0"},"components":{"schemas":{"PayoutResponse":{"type":"object","properties":{"payoutId":{"type":"string"},"merchantCode":{"type":"string"},"currencyCode":{"type":"string"},"countryCode":{"type":"string"},"transactionId":{"type":"string"},"description":{"type":"string"},"amount":{"type":"string"},"chargeType":{"type":"string"},"referenceId":{"type":"string"},"extraInfo":{"type":"string"},"receiver":{"$ref":"#/components/schemas/Receiver"},"receivingBank":{"$ref":"#/components/schemas/ReceivingBank"},"processingData":{"$ref":"#/components/schemas/ProcessBank"},"chargeTypeId":{"type":"string"},"errorCode":{"type":"string"},"errorMessage":{"type":"string"},"status":{"type":"string"},"statusAt":{"type":"string"},"creationAt":{"type":"string"},"updateAt":{"type":"string"},"payoutGroupId":{"type":"integer","format":"int32"}}},"Receiver":{"type":"object","properties":{"name":{"type":"string"},"lastName":{"type":"string"},"documentNumber":{"type":"string"},"documentType":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"},"userName":{"type":"string"},"customId":{"type":"string"}}},"ReceivingBank":{"type":"object","properties":{"bankCode":{"type":"string"},"accountNumber":{"type":"string"},"accountNumberCci":{"type":"string"},"accountType":{"type":"string"}}},"ProcessBank":{"type":"object","properties":{"code":{"type":"string"},"description":{"type":"string"},"extraInformation":{"type":"string"}}}}}}
```

## The ProcessBank object

```json
{"openapi":"3.0.1","info":{"title":"Payout API","version":"1.0"},"components":{"schemas":{"ProcessBank":{"type":"object","properties":{"code":{"type":"string"},"description":{"type":"string"},"extraInformation":{"type":"string"}}}}}}
```

## The Receiver object

```json
{"openapi":"3.0.1","info":{"title":"Payout API","version":"1.0"},"components":{"schemas":{"Receiver":{"type":"object","properties":{"name":{"type":"string"},"lastName":{"type":"string"},"documentNumber":{"type":"string"},"documentType":{"type":"string"},"phoneNumber":{"type":"string"},"email":{"type":"string"},"userName":{"type":"string"},"customId":{"type":"string"}}}}}}
```

## The ReceivingBank object

```json
{"openapi":"3.0.1","info":{"title":"Payout API","version":"1.0"},"components":{"schemas":{"ReceivingBank":{"type":"object","properties":{"bankCode":{"type":"string"},"accountNumber":{"type":"string"},"accountNumberCci":{"type":"string"},"accountType":{"type":"string"}}}}}}
```

## The AccountBalanceResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"Payout API","version":"1.0"},"components":{"schemas":{"AccountBalanceResponseDto":{"type":"object","properties":{"merchantCode":{"type":"string","description":"Código de la entidad"},"countryCode":{"type":"string","description":"Código del país ISO 3166-1 alpha-2"},"currencyCode":{"type":"string","description":"Código ISO 4217 de la moneda"},"accountType":{"type":"string","description":"Tipo de saldo. SINGLE: fondeo a una única cuenta; MULTIPLE: manejo de saldo por banco"},"accountingBalance":{"type":"number","description":"Saldo contable total"},"availableBalance":{"type":"number","description":"Saldo disponible"},"bankBalances":{"type":"object","properties":{"institutionCode":{"type":"string","description":"Código del banco"},"accountingBalance":{"type":"number","description":"Saldo contable de este banco"},"availableBalance":{"type":"number","description":"Saldo disponible de este banco"}},"description":"Saldo por banco"}},"description":"DTO de respuesta con el saldo de la cuenta"}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://readme.streampayments.io/readme/api-reference/models-1.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.