Iugu Resource Search API
The Resource Search API from Iugu — 1 operation(s) for resource search.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/iugu:iugu-resource-search-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: faturas Resource Search API
version: '1.0'
servers:
- url: https://api.iugu.com/v1
security:
- sec0: []
tags:
- name: Resource Search
paths:
/resource_search:
get:
summary: Buscar Fatura por IDs externos
description: Permite consultar uma Fatura através dos valores informados nos parâmetros `external_id`, `order_id`, `end_to_end` ou `digitable_line`.
operationId: buscar-fatura-por-ids-externos
parameters:
- name: query_field
in: query
description: Tipo de ID que procura. Sendo `external_id`, `order_id`, `end_to_end` ou `digitable_line`.
required: true
schema:
type: string
- name: value
in: query
description: Valor a ser procurado.
required: true
schema:
type: string
responses:
'200':
description: '200'
content:
application/json:
examples:
Result:
value: "{\n \"referenceable_id\": \"AB1136DB52934C629DEE3CAC141C0C3E\",\n \"referenceable_type\": \"Invoice\",\n \"resource\": {\n \"id\": \"AB1136DB52934C629DEE3CAC141C0C3E\",\n \"due_date\": \"2025-02-18\",\n \"currency\": \"BRL\",\n \"discount_cents\": null,\n \"email\": \"email@iug.com\",\n \"items_total_cents\": 300,\n \"notification_url\": null,\n \"return_url\": null,\n \"status\": \"paid\",\n \"tax_cents\": null,\n \"total_cents\": 300,\n \"total_paid_cents\": 300,\n \"taxes_paid_cents\": 3,\n \"paid_at\": \"2025-02-18T16:26:19-03:00\",\n \"paid_cents\": 300,\n \"cc_emails\": null,\n \"financial_return_date\": null,\n \"payable_with\": \"pix\",\n \"overpaid_cents\": null,\n \"ignore_due_email\": null,\n \"ignore_canceled_email\": null,\n \"advance_fee_cents\": null,\n \"commission_cents\": 0,\n \"early_payment_discount\": false,\n \"order_id\": null,\n \"updated_at\": \"2025-02-18T16:26:20-03:00\",\n \"credit_card_brand\": null,\n \"credit_card_bin\": null,\n \"credit_card_last_4\": null,\n \"credit_card_captured_at\": null,\n \"credit_card_tid\": null,\n \"external_reference\": null,\n \"max_installments_value\": null,\n \"payer_name\": null,\n \"payer_email\": null,\n \"payer_cpf_cnpj\": null,\n \"payer_phone\": null,\n \"payer_phone_prefix\": null,\n \"payer_address_zip_code\": null,\n \"payer_address_street\": null,\n \"payer_address_district\": null,\n \"payer_address_city\": null,\n \"payer_address_state\": null,\n \"payer_address_number\": null,\n \"payer_address_complement\": null,\n \"payer_address_country\": null,\n \"late_payment_fine\": 0,\n \"late_payment_fine_cents\": null,\n \"split_id\": null,\n \"external_payment_id\": null,\n \"external_payment_description\": null,\n \"payment_booklet_id\": null,\n \"subscription_id\": null,\n \"variables\": [\n {\n \"variable\": \"payment_method\",\n \"value\": \"iugu_pix\"\n },\n {\n \"variable\": \"total_views\",\n \"value\": \"1\"\n }\n ],\n \"custom_variables\": [],\n \"logs\": [\n {\n \"id\": \"BE101B1EC8D647C7AEC59B9BEA947103\",\n \"description\": \"Email de Recibo enviado!\",\n \"notes\": \"Recibo enviado com sucesso para: email@iug.com\",\n \"created_at\": \"18/02, 16:26\"\n },\n {\n \"id\": \"9CA70A27A1BA4D6B975D8A9C9CAC1503\",\n \"description\": \"Fatura paga com sucesso!\",\n \"notes\": \"Fatura paga com Pix por: Nome do Pagador, 111.222.333 44\",\n \"created_at\": \"18/02, 16:26\"\n },\n {\n \"id\": \"177753D821294492B52BAE6D701E3A89\",\n \"description\": \"QrCode visualizado!\",\n \"notes\": \"Fatura visualizada!!\",\n \"created_at\": \"18/02, 16:26\"\n },\n {\n \"id\": \"0200F316D5984E33A866DAAB6A1E1432\",\n \"description\": \"Fatura criada com sucesso!\",\n \"notes\": \"Fatura criada!\",\n \"created_at\": \"18/02, 16:15\"\n },\n {\n \"id\": \"FB5B0151D0F5496087A08AAF56479668\",\n \"description\": \"Email de Fatura enviado!\",\n \"notes\": \"Fatura enviada com sucesso para: email@iug.com\",\n \"created_at\": \"18/02, 16:15\"\n }\n ],\n \"credit_card_transaction\": null,\n \"account_id\": \"44C5DC6376804D1FA792CBCA382105C1\",\n \"bank_account_branch\": \"0001\",\n \"bank_account_number\": \"2739435-0\",\n \"account_name\": \"Nome da Conta\",\n \"secure_id\": \"ab1136db-5293-4c62-9dee-3cac141c0c3e-9329\",\n \"secure_url\": \"https://checkout.iugu.com/invoices/-5293-4c62-9dee-3cac141c0c3e-9329\",\n \"customer_id\": null,\n \"customer_ref\": null,\n \"customer_name\": null,\n \"user_id\": null,\n \"total\": \"R$ 3,00\",\n \"taxes_paid\": \"R$ 0,03\",\n \"total_paid\": \"R$ 3,00\",\n \"total_overpaid\": \"R$ 0,00\",\n \"total_refunded\": \"R$ 0,00\",\n \"fine_cents\": 0,\n \"commission\": \"R$ 0,00\",\n \"fines_on_occurrence_day\": \"R$ 0,00\",\n \"total_on_occurrence_day\": \"R$ 3,00\",\n \"fines_on_occurrence_day_cents\": 0,\n \"total_on_occurrence_day_cents\": 300,\n \"refunded_cents\": 0,\n \"remaining_captured_cents\": 300,\n \"advance_fee\": null,\n \"estimated_advance_fee\": null,\n \"paid\": \"R$ 3,00\",\n \"original_payment_id\": null,\n \"double_payment_id\": null,\n \"per_day_interest\": false,\n \"per_day_interest_value\": null,\n \"per_day_interest_cents\": 0,\n \"interest\": null,\n \"discount\": null,\n \"duplicated_invoice_id\": null,\n \"bank_slip_extra_due\": 10,\n \"created_at\": \"18/02, 16:15\",\n \"created_at_iso\": \"2025-02-18T16:15:32-03:00\",\n \"authorized_at\": null,\n \"authorized_at_iso\": null,\n \"expired_at\": null,\n \"expired_at_iso\": null,\n \"refunded_at\": null,\n \"refunded_at_iso\": null,\n \"canceled_at\": null,\n \"canceled_at_iso\": null,\n \"protested_at\": null,\n \"protested_at_iso\": null,\n \"chargeback_at\": null,\n \"chargeback_at_iso\": null,\n \"occurrence_date\": \"2025-02-18\",\n \"refundable\": true,\n \"installments\": null,\n \"transaction_number\": null,\n \"payment_method\": \"iugu_pix\",\n \"financial_return_dates\": null,\n \"bank_slip\": null,\n \"pix\": {\n \"qrcode\": \"https://faturas.iugu.com/qr_code/ab1136db-5293-4c62-9dee-3cac141c0c3e-9329\",\n \"qrcode_text\": \"00020101021226840014br.gov.bcb.pix2562qr.iugu.com/public/payload/v2/AB1136DB52934C629DEE3CAC141C0C3E52040000530398654043.005802BR5924NOME DA CONTA6009SAO PAULO62070503***6304EC4D\",\n \"status\": \"paid\",\n \"payer_cpf_cnpj\": \"11122233344\",\n \"payer_name\": \"Nome do Pagador\",\n \"end_to_end_id\": \"A12331202502181926Vc0JrA0RiSK\",\n \"end_to_end_refund_id\": null,\n \"account_number_last_digits\": \"5132\"\n },\n \"items\": [\n {\n \"id\": \"9A989E79E6094548B10E7A356A06E7DF\",\n \"description\": \"Item\",\n \"price_cents\": 300,\n \"quantity\": 1,\n \"created_at\": \"2025-02-18T16:15:32-03:00\",\n \"updated_at\": \"2025-02-18T16:15:32-03:00\",\n \"price\": \"R$ 3,00\"\n }\n ],\n \"early_payment_discounts\": [],\n \"split_rules\": null\n }\n}"
schema:
type: object
properties:
referenceable_id:
type: string
example: AB1136DB52934C629DEE3CAC141C0C3E
referenceable_type:
type: string
example: Invoice
resource:
type: object
properties:
id:
type: string
example: AB1136DB52934C629DEE3CAC141C0C3E
due_date:
type: string
example: '2025-02-18'
currency:
type: string
example: BRL
discount_cents: {}
email:
type: string
example: email@iug.com
items_total_cents:
type: integer
example: 300
default: 0
notification_url: {}
return_url: {}
status:
type: string
example: paid
tax_cents: {}
total_cents:
type: integer
example: 300
default: 0
total_paid_cents:
type: integer
example: 300
default: 0
taxes_paid_cents:
type: integer
example: 3
default: 0
paid_at:
type: string
example: '2025-02-18T16:26:19-03:00'
paid_cents:
type: integer
example: 300
default: 0
cc_emails: {}
financial_return_date: {}
payable_with:
type: string
example: pix
overpaid_cents: {}
ignore_due_email: {}
ignore_canceled_email: {}
advance_fee_cents: {}
commission_cents:
type: integer
example: 0
default: 0
early_payment_discount:
type: boolean
example: false
default: true
order_id: {}
updated_at:
type: string
example: '2025-02-18T16:26:20-03:00'
credit_card_brand: {}
credit_card_bin: {}
credit_card_last_4: {}
credit_card_captured_at: {}
credit_card_tid: {}
external_reference: {}
max_installments_value: {}
payer_name: {}
payer_email: {}
payer_cpf_cnpj: {}
payer_phone: {}
payer_phone_prefix: {}
payer_address_zip_code: {}
payer_address_street: {}
payer_address_district: {}
payer_address_city: {}
payer_address_state: {}
payer_address_number: {}
payer_address_complement: {}
payer_address_country: {}
late_payment_fine:
type: integer
example: 0
default: 0
late_payment_fine_cents: {}
split_id: {}
external_payment_id: {}
external_payment_description: {}
payment_booklet_id: {}
subscription_id: {}
variables:
type: array
items:
type: object
properties:
variable:
type: string
example: payment_method
value:
type: string
example: iugu_pix
custom_variables:
type: array
items:
type: object
properties: {}
logs:
type: array
items:
type: object
properties:
id:
type: string
example: BE101B1EC8D647C7AEC59B9BEA947103
description:
type: string
example: Email de Recibo enviado!
notes:
type: string
example: 'Recibo enviado com sucesso para: email@iug.com'
created_at:
type: string
example: 18/02, 16:26
credit_card_transaction: {}
account_id:
type: string
example: 44C5DC6376804D1FA792CBCA382105C1
bank_account_branch:
type: string
example: '0001'
bank_account_number:
type: string
example: 2739435-0
account_name:
type: string
example: Nome da Conta
secure_id:
type: string
example: ab1136db-5293-4c62-9dee-3cac141c0c3e-9329
secure_url:
type: string
example: https://checkout.iugu.com/invoices/-5293-4c62-9dee-3cac141c0c3e-9329
customer_id: {}
customer_ref: {}
customer_name: {}
user_id: {}
total:
type: string
example: R$ 3,00
taxes_paid:
type: string
example: R$ 0,03
total_paid:
type: string
example: R$ 3,00
total_overpaid:
type: string
example: R$ 0,00
total_refunded:
type: string
example: R$ 0,00
fine_cents:
type: integer
example: 0
default: 0
commission:
type: string
example: R$ 0,00
fines_on_occurrence_day:
type: string
example: R$ 0,00
total_on_occurrence_day:
type: string
example: R$ 3,00
fines_on_occurrence_day_cents:
type: integer
example: 0
default: 0
total_on_occurrence_day_cents:
type: integer
example: 300
default: 0
refunded_cents:
type: integer
example: 0
default: 0
remaining_captured_cents:
type: integer
example: 300
default: 0
advance_fee: {}
estimated_advance_fee: {}
paid:
type: string
example: R$ 3,00
original_payment_id: {}
double_payment_id: {}
per_day_interest:
type: boolean
example: false
default: true
per_day_interest_value: {}
per_day_interest_cents:
type: integer
example: 0
default: 0
interest: {}
discount: {}
duplicated_invoice_id: {}
bank_slip_extra_due:
type: integer
example: 10
default: 0
created_at:
type: string
example: 18/02, 16:15
created_at_iso:
type: string
example: '2025-02-18T16:15:32-03:00'
authorized_at: {}
authorized_at_iso: {}
expired_at: {}
expired_at_iso: {}
refunded_at: {}
refunded_at_iso: {}
canceled_at: {}
canceled_at_iso: {}
protested_at: {}
protested_at_iso: {}
chargeback_at: {}
chargeback_at_iso: {}
occurrence_date:
type: string
example: '2025-02-18'
refundable:
type: boolean
example: true
default: true
installments: {}
transaction_number: {}
payment_method:
type: string
example: iugu_pix
financial_return_dates: {}
bank_slip: {}
pix:
type: object
properties:
qrcode:
type: string
example: https://faturas.iugu.com/qr_code/ab1136db-5293-4c62-9dee-3cac141c0c3e-9329
qrcode_text:
type: string
example: 00020101021226840014br.gov.bcb.pix2562qr.iugu.com/public/payload/v2/AB1136DB52934C629DEE3CAC141C0C3E52040000530398654043.005802BR5924NOME DA CONTA6009SAO PAULO62070503***6304EC4D
status:
type: string
example: paid
payer_cpf_cnpj:
type: string
example: '11122233344'
payer_name:
type: string
example: Nome do Pagador
end_to_end_id:
type: string
example: A12331202502181926Vc0JrA0RiSK
end_to_end_refund_id: {}
account_number_last_digits:
type: string
example: '5132'
items:
type: array
items:
type: object
properties:
id:
type: string
example: 9A989E79E6094548B10E7A356A06E7DF
description:
type: string
example: Item
price_cents:
type: integer
example: 300
default: 0
quantity:
type: integer
example: 1
default: 0
created_at:
type: string
example: '2025-02-18T16:15:32-03:00'
updated_at:
type: string
example: '2025-02-18T16:15:32-03:00'
price:
type: string
example: R$ 3,00
early_payment_discounts:
type: array
items:
type: object
properties: {}
split_rules: {}
'400':
description: '400'
content:
application/json:
examples:
Result:
value: '{}'
schema:
type: object
properties: {}
tags:
- Resource Search
components:
securitySchemes:
sec0:
type: apiKey
name: api_token
in: query
x-readme-fauxas: true
x-provenance:
method: searched
source: https://dev.iugu.com/reference
harvested: '2026-10-14'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://dev.iugu.com/reference/buscar-fatura-por-id-externos-de-subcontas.md
- https://dev.iugu.com/reference/buscar-fatura-por-ids-externos.md
- https://dev.iugu.com/reference/buscar-fatura.md
- https://dev.iugu.com/reference/buscar-um-agendamento-de-pix-automatico.md
- https://dev.iugu.com/reference/cancelar-agendamento-pix-automatico.md
- https://dev.iugu.com/reference/cancelar-pix-automatico.md
- https://dev.iugu.com/reference/cancelar.md
- https://dev.iugu.com/reference/capturar-fatura.md
- https://dev.iugu.com/reference/considerar-fatura-paga-externamente.md
- https://dev.iugu.com/reference/consultar-cancelamento-de-pix-automatico.md
- https://dev.iugu.com/reference/consultar-pix-automatico.md
- https://dev.iugu.com/reference/criar-fatura.md
- https://dev.iugu.com/reference/enviar-por-email.md
- https://dev.iugu.com/reference/gerar-segunda-via.md
- https://dev.iugu.com/reference/listar-cancelamentos-de-pix-automatico.md
- https://dev.iugu.com/reference/listar-faturas.md
- https://dev.iugu.com/reference/listar-pix-automatico.md
- https://dev.iugu.com/reference/pix-automatico-jornada-2.md
- https://dev.iugu.com/reference/reembolsar-fatura.md
- https://dev.iugu.com/reference/solicitar-retentativa-de-agendamento.md
- https://dev.iugu.com/reference/validate-signature.md
merge:
pages: 21
deduped: 20
conflicts_kept_first: 0