# Listar intercambios {% admonition type="warning" name="Próximamente" %} Este endpoint está actualmente en desarrollo. Por lo tanto, pueden ocurrir cambios menores o errores. Si encuentras algún problema, por favor contacta a tu representante de Belvo. {% /admonition %} ## ▶️ Uso Con el método List Exchanges, puedes: 1. [Requerido] Listar intercambios relacionados con un link.id específico (usando el parámetro de consulta link). 2. Obtener los detalles de un exchange.id específico (usando el parámetro de consulta id). ## 🔦 Filtrado de Respuestas Consulta la lista de campos a continuación por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrando respuestas. ## 📖 Paginación Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta page_size para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta page para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de Paginación. Endpoint: GET /api/br/exchanges/ Version: 1.223.0 Security: basicAuth ## Query parameters: - `link` (string, required) El link.id por el que deseas filtrar. Example: "8848bd0c-9c7e-4f53-a732-ec896b11d4c4" - `id` (string) Devuelve información solo para este recurso id. Example: "24ccab1d-3a86-4136-a6eb-e04bf52b356f" - `link__in` (array) Devuelve resultados solo para estos link.ids. Example: ["5722d0ba-69d7-42dc-8ff5-33767b83c5d6"] - `id__in` (array) Devuelve información para estos ids de recursos. Example: ["6b3dea0f-be29-49d1-aabe-1a6d588642e6"] - `page_size` (integer) Indica cuántos resultados devolver por página. Por defecto, devolvemos 100 resultados por página. ℹ️ El número mínimo de resultados devueltos por página es 1 y el máximo es 1000. Si introduces un valor mayor que 1000, nuestra API usará por defecto el valor máximo (1000). Example: 100 - `page` (integer) Un número de página dentro del conjunto de resultados paginados. Example: 1 - `omit` (string) Omite ciertos campos para que no se devuelvan en la respuesta. Para más información, consulta nuestro artículo del DevPortal Filtrando respuestas. - `fields` (string) Devuelve solo los campos especificados en la respuesta. Para obtener más información, consulta nuestro artículo del DevPortal Filtrando respuestas. - `collected_at` (string) Devuelve los elementos que fueron recuperados de la institución en esta fecha (YYYY-MM-DD o marca de tiempo completa ISO-8601). Example: "2022-05-01" - `collected_at__gt` (string) Devuelve los elementos que fueron recuperados de la institución después de esta fecha (YYYY-MM-DD o marca de tiempo completa en formato ISO-8601). Example: "2022-05-05" - `collected_at__gte` (string) Devolver los elementos que fueron recuperados de la institución en o después de esta fecha (YYYY-MM-DD o marca de tiempo completa ISO-8601). Example: "2022-05-04" - `collected_at__lt` (string) Devolver los elementos que fueron recuperados de la institución antes de esta fecha (YYYY-MM-DD o marca de tiempo completa ISO-8601). Example: "2022-04-01" - `collected_at__lte` (string) Devuelve los elementos que fueron recuperados de la institución en o antes de esta fecha (YYYY-MM-DD o marca de tiempo completa ISO-8601). Example: "2022-03-30" - `collected_at__range` (array) Devolver elementos que fueron recuperados de la institución entre dos fechas (YYYY-MM-DD o marca de tiempo completa ISO-8601). El primer valor indica el inicio del rango y el segundo valor indica el final del rango. Example: ["2022-01-01","2022-12-31"] - `created_at` (string) Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo en esta fecha (en formato YYYY-MM-DD). Example: "2022-05-05" - `created_at__gt` (string) Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo después de esta fecha (en formato YYYY-MM-DD). Example: "2022-05-05" - `created_at__gte` (string) Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo después o en esta fecha (en formato YYYY-MM-DD). Example: "2022-05-04" - `created_at__lt` (string) Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo antes de esta fecha (en formato YYYY-MM-DD). Example: "2022-04-01" - `created_at__lte` (string) Devuelve los elementos que se actualizaron por última vez en la base de datos de Belvo antes o en esta fecha (en formato YYYY-MM-DD). Example: "2022-03-30" - `created_at__range` (array) Devolver cuentas que fueron actualizadas por última vez en la base de datos de Belvo entre dos fechas (en formato YYYY-MM-DD). El primer valor indica el inicio del rango y el segundo valor indica el final del rango. Example: ["2022-01-01","2022-12-31"] ## Response 200 fields (application/json): - `count` (integer) El número total de resultados en tu cuenta de Belvo. Example: 130 - `next` (string,null) La URL a la siguiente página de resultados. Cada página consta de hasta 100 elementos. Si no hay suficientes resultados para una página adicional, el valor es null. En nuestro ejemplo de documentación, usamos {endpoint} como un valor de marcador de posición. En producción, este valor será reemplazado por el endpoint real que estás utilizando actualmente (por ejemplo, accounts o owners). Example: "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2" - `previous` (string,null) La URL a la página anterior de resultados. Si no hay una página anterior, el valor es null. - `results` (array) Un arreglo de objetos de exchange. - `results.id` (string, required) Identificador único de Belvo para el elemento actual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `results.link` (string,null, required) El link.id al que pertenecen los datos. Example: "30cb4806-6e00-48a4-91c9-ca55968576c8" - `results.created_at` (string, required) La marca de tiempo ISO-8601 de cuando se creó el punto de datos en la base de datos de Belvo. Example: "2022-02-09T08:45:50.406032Z" - `results.collected_at` (string, required) La marca de tiempo ISO-8601 cuando se recopiló el punto de datos. Example: "2022-02-09T08:45:50.406032Z" - `results.operation_identifier` (string, required) El identificador único de la red para la operación de intercambio. Example: "92792126019929240" - `results.operation_number` (string,null) El número de registro de operación de 12 dígitos del Banco Central de Brasil (Bacen). Esto puede ser null si la operación aún no ha sido registrada. Example: "393874649456" - `results.operation_type` (string, required) El tipo de operación de cambio. Devolvemos uno de los siguientes valores de enum: - COMPRA - Comprar (el cliente está comprando moneda extranjera) - VENDA - Vender (el cliente está vendiendo moneda extranjera) Enum: "COMPRA", "VENDA" - `results.operation_requested_at` (string, required) La marca de tiempo ISO-8601 cuando se contrató la operación de intercambio. Example: "2023-03-07T08:30:00Z" - `results.authorized_institution_identifier` (integer, required) El CNPJ de la institución autorizada para llevar a cabo la operación. Example: 11225860000140 - `results.authorized_institution_name` (string, required) El nombre de la institución autorizada. Example: "AGENCIA CORRETORA" - `results.intermediary_institution_identifier` (integer,null) El CNPJ de la institución intermediaria, si se utilizó una. Example: 11225860000140 - `results.intermediary_institution_name` (string,null) El nombre de la institución intermediaria. Debe estar presente si intermediary_institution_identifier está disponible. Example: "AGENCIA CORRETORA" - `results.operation_due_date` (string, required) La fecha de liquidación programada actualmente para la operación, en formato YYYY-MM-DD. > Nota: Este campo se actualiza si se realizan cambios en la operación de intercambio. Example: "2018-02-15" - `results.local_operation_tax_amount` (number, required) El tipo de cambio aplicado a la operación. Example: 1.3 - `results.local_operation_tax_currency` (string, required) El código de moneda de tres letras (ISO-4217) para la tasa de cambio. Example: "BRL" - `results.local_operation_value_amount` (number, required) El valor total de la operación en moneda local. Example: 1000.04 - `results.local_operation_value_currency` (string, required) El código de moneda de tres letras (ISO-4217) para la moneda local. Example: "BRL" - `results.foreign_operation_value_amount` (number, required) El valor total de la operación en la moneda extranjera. Example: 1000.04 - `results.foreign_operation_value_currency` (string, required) El código de moneda de tres letras (ISO-4217) para la moneda extranjera. Example: "USD" - `results.operation_outstanding_balance_amount` (number,null) El saldo pendiente por liquidar, en la moneda extranjera. En el caso de que la operación de cambio esté programada para liquidarse dentro de los dos días posteriores a operation_requested_at, este valor puede ser null. Example: 1000.04 - `results.operation_outstanding_balance_currency` (string,null) La moneda del saldo pendiente. Obligatorio si operation_outstanding_balance_amount no es null. Example: "USD" - `results.tev_amount_amount` (number,null) El "All-in Rate" (Valor Efetivo Total/Total Effective Cost), que representa el costo total de la operación. Es requerido cuando se programa que la operación se liquide dentro de los dos días posteriores a operation_requested_at y no excede los $100,000 USD. Example: 1000.000004 - `results.tev_amount_currency` (string,null) La moneda del VET (siempre BRL). Obligatorio si tev_amount_amount no es null. Example: "BRL" - `results.local_currency_advance_percentage` (number,null) El porcentaje del valor de la moneda extranjera que se otorgó al cliente por adelantado. En el caso de que la operación de cambio esté programada para liquidarse dentro de los dos días posteriores a operation_requested_at, este valor puede ser null. Example: 0.12 - `results.settlement_method` (string,null, required) El método de entrega para la moneda extranjera. Devolvemos uno de los siguientes valores del enum: - CARTA_CREDITO_A_VISTA (Código 10) - Carta de crédito a la vista - CARTA_CREDITO_A_PRAZO (Código 15) - Carta de crédito a plazo - CONTA_DEPOSITO (Código 20) - Cuenta de depósito - CONTA_DEPOSITO_MOEDA_ESTRANGEIRA_PAIS (Código 21) - Cuenta de depósito en moneda extranjera en el país - CONTA_DEPOSITO_EXPORTADOR_MANTIDA_NO_EXTERIOR (Código 22) - Cuenta de depósito del exportador mantenida en el exterior - CONTA_DEPOSITO_OU_PAGAMENTO_EXPORTADOR_INSTITUICAO_EXTERIOR (Código 23) - Cuenta de depósito o pago al exportador en institución extranjera - CONVENIO_PAGAMENTOS_E_CREDITOS_RECIPROCOS (Código 25) - Convenio de pagos y créditos recíprocos - CHEQUE (Código 30) - Cheque - ESPECIE_CHEQUES_VIAGEM (Código 50) - Efectivo o cheques de viajero - CARTAO_PREPAGO (Código 55) - Tarjeta prepaga - TELETRANSMISSAO (Código 65) - Transferencia electrónica - TITULOS_VALORES (Código 75) - Títulos/bonos - SIMBOLICA (Código 90) - Simbólica - SEM_MOVIMENTACAO_VALORES (Código 91) - Sin movimiento de fondos - DEMAIS (Código 99) - Otros - OUTRO_NAO_MAPEADO_OFB - Otro no mapeado por Open Finance Brazil - null Enum: "CONTA_DEPOSITO_MOEDA_ESTRANGEIRA_PAIS", "CONTA_DEPOSITO_OU_PAGAMENTO_EXPORTADOR_INSTITUICAO_EXTERIOR", "ESPECIE_CHEQUES_VIAGEM", "CARTAO_PREPAGO", "TELETRANSMISSAO", "SEM_MOVIMENTACAO_VALORES", "DEMAIS", "CARTA_CREDITO_A_VISTA", "CARTA_CREDITO_A_PRAZO", "CONTA_DEPOSITO", "CHEQUE", "TITULOS_VALORES", "SIMBOLICA", "CONTA_DEPOSITO_EXPORTADOR_MANTIDA_NO_EXTERIOR", "CONVENIO_PAGAMENTOS_E_CREDITOS_RECIPROCOS", "OUTRO_NAO_MAPEADO_OFB", null - `results.operation_category_code` (string, required) El código de 5 dígitos del Banco Central que clasifica la "naturaleza" de la operación. Este código debe cumplir con los códigos de naturaleza referenciados en la Resolución 277 o Circular 3690, según corresponda al contrato de cambio. Example: "90302" ## Response 403 fields (application/json): - `code` (string) Un código de error único (access_to_resource_denied) que te permite clasificar y manejar el error de manera programática. ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar 403 access_to_resource_denied. Example: "access_to_resource_denied" - `message` (string) Una breve descripción del error. Para los errores access_to_resource_denied, la descripción es: - You don't have access to this resource.. Example: "You don't have access to this resource." - `request_id` (string) Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones. Example: "9e7b283c6efa449c9c028a16b5c249fb" ## Response 408 fields (application/json): - `code` (string) Un código de error único (request_timeout) que te permite clasificar y manejar el error de manera programática. ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar errores 408 request_timeout. Example: "request_timeout" - `message` (string) Una breve descripción del error. Para los errores de request_timeout, la descripción es: - The request timed out, you can retry asking for less data by changing your query parameters. Example: "The request timed out, you can retry asking for less data by changing your query parameters" - `request_id` (string) Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones. Example: "9e7b283c6efa449c9c028a16b5c249fb" ## Response 500 fields (application/json): - `code` (string) Un código de error único (unexpected_error) que te permite clasificar y manejar el error de manera programática. ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar errores 500 unexpected_error. Example: "unexpected_error" - `message` (string) Una breve descripción del error. Para los errores unexpected_error, la descripción es: - Belvo no puede procesar la solicitud debido a un problema interno del sistema o a una respuesta no soportada de una institución. Example: "Belvo is unable to process the request due to an internal system issue or to an unsupported response from an institution" - `request_id` (string) Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: [a-f0-9]{32}). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones. Example: "9e7b283c6efa449c9c028a16b5c249fb"