openapi: 3.2.0 info: title: Iugu Customers API version: '1.0' description: 'Operations tagged Customers across 2 of this provider''s published API definitions: iugu-clientes-openapi.yml, iugu-formas-de-pagamento-do-cliente-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://api.iugu.com/v1 security: - sec0: [] tags: - name: Customers paths: /customers: post: summary: Criar Cliente description: 'Essa chamada cria um objeto cliente. A propriedade zip_code realiza uma pré-consulta e valida se existe um endereço valido para o cliente, porém caso não seja retornado os dados do endereço completo do cliente, será apresentado um erro ao tentar criar o cliente informando que falta alguma informação, pois não conseguimos obter nessa pré consulta.' operationId: criar-cliente requestBody: content: application/json: schema: type: object required: - email - name properties: email: type: string description: Email do cliente name: type: string description: Nome do cliente notes: type: string description: Notas phone: type: integer description: Número do Telefone - 9 dígitos format: int32 phone_prefix: type: integer description: Prefixo, apenas números - 3 dígitos (obrigatório caso preencha "phone") format: int32 cpf_cnpj: type: string description: CPF ou CNPJ do cliente. Obrigatório para emissão de boletos registrados.
**Aceito o campo alfanumérico apenas para CNPJ**. cc_emails: type: string description: Endereços de E-mail para cópia separados por vírgula zip_code: type: string description: CEP. Obrigatório para emissão de boletos registrados number: type: string description: Número do endereço (obrigatório caso "zip_code" seja enviado). street: type: string description: Rua. Obrigatório caso CEP seja incompleto. city: type: string description: Cidade state: type: string description: Estado district: type: string description: Bairro. Obrigatório caso CEP seja incompleto. complement: type: string description: Complemento de endereço. Ponto de referência. custom_variables: type: array description: Variáveis Personalizadas items: properties: name: type: string description: Nome da variável value: type: string description: Valor da variável type: object responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"id\": \"6A7BE09792BA40CFB13AA504367E5E12\",\n \"email\": \"email@iugu.com\",\n \"name\": \"Nome do Cliente\",\n \"notes\": \"Nota sobre este cliente\",\n \"created_at\": \"2025-04-03T12:04:38-03:00\",\n \"updated_at\": \"2025-04-03T12:04:38-03:00\",\n \"cc_emails\": null,\n \"cpf_cnpj\": \"11343675030\",\n \"zip_code\": \"13056-344\",\n \"number\": \"60\",\n \"complement\": null,\n \"phone\": \"972312345\",\n \"phone_prefix\": \"11\",\n \"custom_variables\": [\n {\n \"name\": \"My-var\",\n \"value\": \"var\"\n }\n ],\n \"payment_methods\": [],\n \"default_payment_method_id\": null,\n \"proxy_payments_from_customer_id\": null,\n \"city\": \"Campinas\",\n \"state\": \"SP\",\n \"district\": \"Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu)\",\n \"street\": \"Rua Antônio Nunes\"\n}" schema: type: object properties: id: type: string example: 6A7BE09792BA40CFB13AA504367E5E12 email: type: string example: email@iugu.com name: type: string example: Nome do Cliente notes: type: string example: Nota sobre este cliente created_at: type: string example: '2025-04-03T12:04:38-03:00' updated_at: type: string example: '2025-04-03T12:04:38-03:00' cc_emails: {} cpf_cnpj: type: string example: '11343675030' zip_code: type: string example: 13056-344 number: type: string example: '60' complement: {} phone: type: string example: '972312345' phone_prefix: type: string example: '11' custom_variables: type: array items: type: object properties: name: type: string example: My-var value: type: string example: var payment_methods: type: array items: type: object properties: {} default_payment_method_id: {} proxy_payments_from_customer_id: {} city: type: string example: Campinas state: type: string example: SP district: type: string example: Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu) street: type: string example: Rua Antônio Nunes '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} tags: - Customers get: summary: Listar Clientes description: 'Retorna uma lista com os clientes cadastrados em sua conta, ordenados pela data de criação, do mais recente para o mais antigo. O campo totalItems indica a quantidade de registros retornados nesta página (igual ao tamanho de items ). Para detectar o fim da listagem, compare items.length com limit : se for menor, não há mais páginas.' operationId: listar-cliente parameters: - name: limit in: query description: Limita o número de registros retornados em até 100, que é o padrão de retorno desta chamada. Também utilizado em paginação. schema: type: integer format: int32 - name: start in: query description: Quantos registros pular do início da pesquisa. schema: type: integer format: int32 - name: created_at_from in: query description: Registros criados a partir desta data passada no parâmetro. Formato (AAAA-MM-DDThh:mm:ss-03:00) schema: type: string format: date - name: created_at_to in: query description: Registros criados até esta data passada no parâmetro. Formato (AAAA-MM-DDThh:mm:ss-03:00) schema: type: string format: date - name: query in: query description: Neste parâmetro pode ser passado um texto para pesquisa como e-mail, nome, anotações e variáveis customizadas. Ao usar este parâmetro, necessário usar paginação (limit, start, etc). schema: type: string - name: updated_since in: query description: Registros atualizados desde o valor passado no parâmetro. Formato (AAAA-MM-DDThh:mm:ss-03:00) schema: type: string format: date - in: query name: updated_until schema: type: string format: date description: 'Retorna apenas registros atualizados até a data/hora informada. Formato (AAAA-MM-DDThh:mm:ss-03:00) ' responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"items\": [\n {\n \"id\": \"6A7BE09792BA40CFB13AA504367E5E12\",\n \"email\": \"email@iugu.com\",\n \"name\": \"Nome do Cliente\",\n \"notes\": \"Nota sobre este cliente\",\n \"created_at\": \"2025-04-03T12:04:38-03:00\",\n \"updated_at\": \"2025-04-03T12:07:31-03:00\",\n \"cc_emails\": null,\n \"cpf_cnpj\": \"11343675030\",\n \"zip_code\": \"13056-344\",\n \"number\": \"60\",\n \"complement\": \"APTO 1702\",\n \"phone\": \"972312345\",\n \"phone_prefix\": \"11\",\n \"custom_variables\": [\n {\n \"name\": \"My-var\",\n \"value\": \"var\"\n }\n ],\n \"payment_methods\": [],\n \"default_payment_method_id\": null,\n \"proxy_payments_from_customer_id\": null,\n \"city\": \"Campinas\",\n \"state\": \"SP\",\n \"district\": \"Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu)\",\n \"street\": \"Rua Antônio Nunes\"\n },\n {\n \"id\": \"A154F9AFE336432AAB2A89F5DDE3B3E8\",\n \"email\": \"daizem.laurindo@iugu.com\",\n \"name\": \"Daizem Teste\",\n \"notes\": \"\",\n \"created_at\": \"2025-03-11T14:06:41-03:00\",\n \"updated_at\": \"2025-03-11T14:06:41-03:00\",\n \"cc_emails\": \"\",\n \"cpf_cnpj\": \"94741465004\",\n \"zip_code\": \"15230970\",\n \"number\": \"123\",\n \"complement\": \"\",\n \"phone\": \"\",\n \"phone_prefix\": \"\",\n \"custom_variables\": [],\n \"payment_methods\": [],\n \"default_payment_method_id\": null,\n \"proxy_payments_from_customer_id\": null,\n \"city\": \"Adolfo\",\n \"state\": \"SP\",\n \"district\": \"Centro\",\n \"street\": \"Rua Castro Alves\"\n },\n {\n \"id\": \"72C4FC7582E3498798E9A165F0161726\",\n \"email\": \"api@mutualpsp.com\",\n \"name\": \"mutualpsp\",\n \"notes\": null,\n \"created_at\": \"2025-02-05T03:15:09-03:00\",\n \"updated_at\": \"2025-02-05T03:15:09-03:00\",\n \"cc_emails\": null,\n \"cpf_cnpj\": null,\n \"zip_code\": null,\n \"number\": null,\n \"complement\": null,\n \"phone\": null,\n \"phone_prefix\": null,\n \"custom_variables\": [],\n \"payment_methods\": [],\n \"default_payment_method_id\": null,\n \"proxy_payments_from_customer_id\": null,\n \"city\": null,\n \"state\": null,\n \"district\": null,\n \"street\": null\n }\n ],\n \"totalItems\": 57\n}" schema: type: object properties: items: type: array items: type: object properties: id: type: string example: 6A7BE09792BA40CFB13AA504367E5E12 email: type: string example: email@iugu.com name: type: string example: Nome do Cliente notes: type: string example: Nota sobre este cliente created_at: type: string example: '2025-04-03T12:04:38-03:00' updated_at: type: string example: '2025-04-03T12:07:31-03:00' cc_emails: {} cpf_cnpj: type: string example: '11343675030' zip_code: type: string example: 13056-344 number: type: string example: '60' complement: type: string example: APTO 1702 phone: type: string example: '972312345' phone_prefix: type: string example: '11' custom_variables: type: array items: type: object properties: name: type: string example: My-var value: type: string example: var payment_methods: type: array items: type: object properties: {} default_payment_method_id: {} proxy_payments_from_customer_id: {} city: type: string example: Campinas state: type: string example: SP district: type: string example: Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu) street: type: string example: Rua Antônio Nunes totalItems: type: integer example: 57 default: 0 '400': description: '400' content: application/json: examples: Result: value: '{ "errors": "Paginação profunda (start > 100) requer ao menos um filtro identificador para escopar a busca." }' schema: type: object properties: {} tags: - Customers servers: - url: https://api.iugu.com/v1 /customers/{id}: put: summary: Editar Cliente description: Alterar os dados de um Cliente. Quaisquer parâmetros não informados não serão alterados. operationId: alterar-cliente parameters: - name: id in: path description: ID do cliente schema: type: string required: true requestBody: content: application/json: schema: type: object properties: email: type: string description: Email do cliente name: type: string description: Nome do cliente notes: type: string description: Notas phone: type: integer description: Número do Telefone - 9 dígitos format: int32 phone_prefix: type: integer description: Prefixo, apenas números - 3 dígitos (obrigatório caso preencha "phone") format: int32 cpf_cnpj: type: string description: CPF ou CNPJ do cliente.
**Aceito o campo alfanumérico apenas para CNPJ**. cc_emails: type: string description: Endereços de E-mail para cópia separados por vírgula zip_code: type: string description: CEP number: type: string description: Número do endereço (obrigatório caso zip_code seja enviado) street: type: string description: Rua city: type: string description: Cidade state: type: string description: Estado district: type: string description: Bairro complement: type: string description: Complemento de endereço. Ponto de referência. default_payment_method_id: type: string description: ID da Forma de Pagamento padrão do cliente, "id" obtido em "Listar formas de pagamentos", quando preenchido, vai fazer cobranças automáticas das faturas geradas para este cliente, na data do vencimento ou após vencimento. Enviar "null" para desvincular o cartão das cobranças automáticas. custom_variables: type: array description: Variáveis Personalizadas, adicionar, alterar ou remover. Para remover, envie "name:$valor" + "_destroy:true" - $valor é a própria chave para remoção do item. items: properties: name: type: string description: Nome da variável value: type: string description: Valor da variável _destroy: type: boolean description: '"true" ou "false"' type: object responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"id\": \"6A7BE09792BA40CFB13AA504367E5E12\",\n \"email\": \"email@iugu.com\",\n \"name\": \"Nome do Cliente\",\n \"notes\": \"Nota sobre este cliente\",\n \"created_at\": \"2025-04-03T12:04:38-03:00\",\n \"updated_at\": \"2025-04-03T12:07:31-03:00\",\n \"cc_emails\": null,\n \"cpf_cnpj\": \"11343675030\",\n \"zip_code\": \"13056-344\",\n \"number\": \"60\",\n \"complement\": \"APTO 1702\",\n \"phone\": \"972312345\",\n \"phone_prefix\": \"11\",\n \"custom_variables\": [\n {\n \"name\": \"My-var\",\n \"value\": \"var\"\n }\n ],\n \"payment_methods\": [],\n \"default_payment_method_id\": null,\n \"proxy_payments_from_customer_id\": null,\n \"city\": \"Campinas\",\n \"state\": \"SP\",\n \"district\": \"Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu)\",\n \"street\": \"Rua Antônio Nunes\"\n}" schema: type: object properties: id: type: string example: 6A7BE09792BA40CFB13AA504367E5E12 email: type: string example: email@iugu.com name: type: string example: Nome do Cliente notes: type: string example: Nota sobre este cliente created_at: type: string example: '2025-04-03T12:04:38-03:00' updated_at: type: string example: '2025-04-03T12:07:31-03:00' cc_emails: {} cpf_cnpj: type: string example: '11343675030' zip_code: type: string example: 13056-344 number: type: string example: '60' complement: type: string example: APTO 1702 phone: type: string example: '972312345' phone_prefix: type: string example: '11' custom_variables: type: array items: type: object properties: name: type: string example: My-var value: type: string example: var payment_methods: type: array items: type: object properties: {} default_payment_method_id: {} proxy_payments_from_customer_id: {} city: type: string example: Campinas state: type: string example: SP district: type: string example: Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu) street: type: string example: Rua Antônio Nunes '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} tags: - Customers get: summary: Buscar Cliente description: Retorna os dados de um cliente operationId: buscar-cliente parameters: - name: id in: path description: ID do cliente schema: type: string required: true responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"id\": \"6A7BE09792BA40CFB13AA504367E5E12\",\n \"email\": \"email@iugu.com\",\n \"name\": \"Nome do Cliente\",\n \"notes\": \"Nota sobre este cliente\",\n \"created_at\": \"2025-04-03T12:04:38-03:00\",\n \"updated_at\": \"2025-04-03T12:07:31-03:00\",\n \"cc_emails\": null,\n \"cpf_cnpj\": \"11343675030\",\n \"zip_code\": \"13056-344\",\n \"number\": \"60\",\n \"complement\": \"APTO 1702\",\n \"phone\": \"972312345\",\n \"phone_prefix\": \"11\",\n \"custom_variables\": [\n {\n \"name\": \"My-var\",\n \"value\": \"var\"\n }\n ],\n \"payment_methods\": [],\n \"default_payment_method_id\": null,\n \"proxy_payments_from_customer_id\": null,\n \"city\": \"Campinas\",\n \"state\": \"SP\",\n \"district\": \"Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu)\",\n \"street\": \"Rua Antônio Nunes\"\n}" schema: type: object properties: id: type: string example: 6A7BE09792BA40CFB13AA504367E5E12 email: type: string example: email@iugu.com name: type: string example: Nome do Cliente notes: type: string example: Nota sobre este cliente created_at: type: string example: '2025-04-03T12:04:38-03:00' updated_at: type: string example: '2025-04-03T12:07:31-03:00' cc_emails: {} cpf_cnpj: type: string example: '11343675030' zip_code: type: string example: 13056-344 number: type: string example: '60' complement: type: string example: APTO 1702 phone: type: string example: '972312345' phone_prefix: type: string example: '11' custom_variables: type: array items: type: object properties: name: type: string example: My-var value: type: string example: var payment_methods: type: array items: type: object properties: {} default_payment_method_id: {} proxy_payments_from_customer_id: {} city: type: string example: Campinas state: type: string example: SP district: type: string example: Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu) street: type: string example: Rua Antônio Nunes '400': description: '400' content: application/json: examples: Customer Not Found: value: "{\n \"errors\": \"Customer Not Found\"\n}" schema: type: object properties: errors: type: string example: Customer Not Found deprecated: false tags: - Customers delete: summary: Remover Cliente description: Remove permanentemente um cliente. Porém, não permite remover clientes com assinaturas vinculadas. operationId: remover-cliente parameters: - name: id in: path description: ID do cliente schema: type: string required: true responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"id\": \"6A7BE09792BA40CFB13AA504367E5E12\",\n \"email\": \"email@iugu.com\",\n \"name\": \"Nome do Cliente\",\n \"notes\": \"Nota sobre este cliente\",\n \"created_at\": \"2025-04-03T12:04:38-03:00\",\n \"updated_at\": \"2025-04-03T12:07:31-03:00\",\n \"cc_emails\": null,\n \"cpf_cnpj\": \"11343675030\",\n \"zip_code\": \"13056-344\",\n \"number\": \"60\",\n \"complement\": \"APTO 1702\",\n \"phone\": \"972312345\",\n \"phone_prefix\": \"11\",\n \"custom_variables\": [],\n \"payment_methods\": [],\n \"default_payment_method_id\": null,\n \"proxy_payments_from_customer_id\": null,\n \"city\": \"Campinas\",\n \"state\": \"SP\",\n \"district\": \"Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu)\",\n \"street\": \"Rua Antônio Nunes\"\n}" schema: type: object properties: id: type: string example: 6A7BE09792BA40CFB13AA504367E5E12 email: type: string example: email@iugu.com name: type: string example: Nome do Cliente notes: type: string example: Nota sobre este cliente created_at: type: string example: '2025-04-03T12:04:38-03:00' updated_at: type: string example: '2025-04-03T12:07:31-03:00' cc_emails: {} cpf_cnpj: type: string example: '11343675030' zip_code: type: string example: 13056-344 number: type: string example: '60' complement: type: string example: APTO 1702 phone: type: string example: '972312345' phone_prefix: type: string example: '11' custom_variables: type: array items: type: object properties: {} payment_methods: type: array items: type: object properties: {} default_payment_method_id: {} proxy_payments_from_customer_id: {} city: type: string example: Campinas state: type: string example: SP district: type: string example: Dic I (Conjunto Habitacional Monsenhor Luiz Fernando Abreu) street: type: string example: Rua Antônio Nunes '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Customers servers: - url: https://api.iugu.com/v1 /customers/{customer_id}/payment_methods: post: summary: Criar Forma de Pagamento description: Cria uma forma de pagamento de cliente. operationId: criar-forma-de-pagamento parameters: - name: customer_id in: path description: ID do Cliente schema: type: string required: true requestBody: content: application/json: schema: type: object required: - description - token properties: description: type: string description: Descrição token: type: string description: Token de Pagamento criar set_as_default: type: boolean description: Se "true" define esta Forma de Pagamento como padrão do Cliente, ou seja, para executar cobranças automáticas no cartão salvo. responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"id\": \"9F9977E32DC74DC18266FD02454AB4F5\",\n \"description\": \"Meu Master Roxinho\",\n \"item_type\": \"credit_card\",\n \"customer_id\": \"3B926491FC954603B886BC279A769D99\",\n \"data\": {\n \"brand\": \"Master\",\n \"holder_name\": \"NOME NO KARTÃO\",\n \"display_number\": \"XXXX-XXXX-XXXX-4444\",\n \"bin\": \"555555\",\n \"year\": 2030,\n \"month\": 12,\n \"last_digits\": \"4444\",\n \"first_digits\": \"555555\",\n \"masked_number\": \"XXXX-XXXX-XXXX-4444\",\n \"fingerprint\": \"39124eb1-9813-ee72-f5df-75725cd9a5c0\",\n \"issuer\": \"Informação não disponivel\",\n \"card_type\": \"Multiplo\",\n \"foreign_card\": \"t\"\n }\n}" schema: type: object properties: id: type: string example: 9F9977E32DC74DC18266FD02454AB4F5 description: type: string example: Meu Master Roxinho item_type: type: string example: credit_card customer_id: type: string example: 3B926491FC954603B886BC279A769D99 data: type: object properties: brand: type: string example: Master holder_name: type: string example: NOME NO KARTÃO display_number: type: string example: XXXX-XXXX-XXXX-4444 bin: type: string example: '555555' year: type: integer example: 2030 default: 0 month: type: integer example: 12 default: 0 last_digits: type: string example: '4444' first_digits: type: string example: '555555' masked_number: type: string example: XXXX-XXXX-XXXX-4444 fingerprint: type: string example: 39124eb1-9813-ee72-f5df-75725cd9a5c0 issuer: type: string example: Informação não disponivel card_type: type: string example: Multiplo foreign_card: type: string example: t '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Customers get: summary: Listar Formas de Pagamento description: Retorna uma lista com todas as formas de pagamento de determinado cliente. operationId: listar-forma-de-pagamento parameters: - name: customer_id in: path description: ID do cliente schema: type: string required: true responses: '200': description: '200' content: application/json: examples: Result: value: "[\n {\n \"id\": \"D9AB8F1888A2844387DBEB638BC9144C\",\n \"description\": \"Meu Cartão Laranjinha\",\n \"item_type\": \"credit_card\",\n \"customer_id\": \"590259547ED341C78A6DC0D377B4BC92\",\n \"data\": {\n \"bin\": \"411111\",\n \"year\": 2030,\n \"month\": 12,\n \"brand\": \"Visa\",\n \"holder_name\": \"NOME NO KARTÃO\",\n \"display_number\": \"XXXX-XXXX-XXXX-2341\",\n \"fingerprint\": \"9813-ee72-f5df-75725cd9a5c0-39124eb1\",\n \"remote_ip\": null,\n \"billing_address\": null,\n \"issuer\": \"Informação não disponivel\",\n \"issuer_code\": \"\",\n \"card_type\": \"Multiplo\",\n \"foreign_card\": \"t\"\n }\n },\n {\n \"id\": \"7DBEB638BC9144D9AB8F1888A284438C\",\n \"description\": \"Meu Cartão Roxinho\",\n \"item_type\": \"credit_card\",\n \"customer_id\": \"590259547ED341C78A6DC0D377B4BC92\",\n \"data\": {\n \"bin\": \"411111\",\n \"year\": 2030,\n \"month\": 12,\n \"brand\": \"Visa\",\n \"holder_name\": \"NOME NO KARTÃO\",\n \"display_number\": \"XXXX-XXXX-XXXX-1111\",\n \"fingerprint\": \"39124eb1-9813-ee72-f5df-75725cd9a5c0\",\n \"remote_ip\": null,\n \"billing_address\": null,\n \"issuer\": \"Informação não disponivel\",\n \"issuer_code\": \"\",\n \"card_type\": \"Multiplo\",\n \"foreign_card\": \"t\"\n }\n }\n]" schema: type: array items: type: object properties: id: type: string example: D9AB8F1888A2844387DBEB638BC9144C description: type: string example: Meu Cartão Laranjinha item_type: type: string example: credit_card customer_id: type: string example: 590259547ED341C78A6DC0D377B4BC92 data: type: object properties: bin: type: string example: '411111' year: type: integer example: 2030 default: 0 month: type: integer example: 12 default: 0 brand: type: string example: Visa holder_name: type: string example: NOME NO KARTÃO display_number: type: string example: XXXX-XXXX-XXXX-2341 fingerprint: type: string example: 9813-ee72-f5df-75725cd9a5c0-39124eb1 remote_ip: {} billing_address: {} issuer: type: string example: Informação não disponivel issuer_code: type: string example: '' card_type: type: string example: Multiplo foreign_card: type: string example: t '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Customers servers: - url: https://api.iugu.com/v1 /customers/{customer_id}/payment_methods/{id}: put: summary: Editar Forma de Pagamento description: Altera os dados de uma Forma de Pagamento, quaisquer parâmetros não informados não serão alterados. operationId: alterar-forma-de-pagamento parameters: - name: customer_id in: path description: ID do cliente schema: type: string required: true - name: id in: path description: ID da forma de pagamento schema: type: string required: true requestBody: content: application/json: schema: type: object properties: description: type: string description: Descrição responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"id\": \"9F9977E32DC74DC18266FD02454AB4F5\",\n \"description\": \"Meu Master Roxinho\",\n \"item_type\": \"credit_card\",\n \"customer_id\": \"3B926491FC954603B886BC279A769D99\",\n \"data\": {\n \"brand\": \"Master\",\n \"holder_name\": \"NOME NO KARTÃO\",\n \"display_number\": \"XXXX-XXXX-XXXX-4444\",\n \"bin\": \"555555\",\n \"year\": 2030,\n \"month\": 12,\n \"last_digits\": \"4444\",\n \"first_digits\": \"555555\",\n \"masked_number\": \"XXXX-XXXX-XXXX-4444\",\n \"fingerprint\": \"39124eb1-9813-ee72-f5df-75725cd9a5c0\",\n \"issuer\": \"Informação não disponivel\",\n \"card_type\": \"Multiplo\",\n \"foreign_card\": \"t\"\n }\n}" schema: type: object properties: id: type: string example: 9F9977E32DC74DC18266FD02454AB4F5 description: type: string example: Meu Master Roxinho item_type: type: string example: credit_card customer_id: type: string example: 3B926491FC954603B886BC279A769D99 data: type: object properties: brand: type: string example: Master holder_name: type: string example: NOME NO KARTÃO display_number: type: string example: XXXX-XXXX-XXXX-4444 bin: type: string example: '555555' year: type: integer example: 2030 default: 0 month: type: integer example: 12 default: 0 last_digits: type: string example: '4444' first_digits: type: string example: '555555' masked_number: type: string example: XXXX-XXXX-XXXX-4444 fingerprint: type: string example: 39124eb1-9813-ee72-f5df-75725cd9a5c0 issuer: type: string example: Informação não disponivel card_type: type: string example: Multiplo foreign_card: type: string example: t '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Customers get: summary: Buscar Forma de Pagamento description: Retorna os dados de uma Forma de Pagamento de um Cliente operationId: buscar-forma-de-pagamento parameters: - name: customer_id in: path description: ID do cliente schema: type: string required: true - name: id in: path description: ID da forma de pagamento schema: type: string required: true responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"id\": \"9F9977E32DC74DC18266FD02454AB4F5\",\n \"description\": \"Meu Master Roxinho\",\n \"item_type\": \"credit_card\",\n \"customer_id\": \"3B926491FC954603B886BC279A769D99\",\n \"data\": {\n \"brand\": \"Master\",\n \"holder_name\": \"NOME NO KARTÃO\",\n \"display_number\": \"XXXX-XXXX-XXXX-4444\",\n \"bin\": \"555555\",\n \"year\": 2030,\n \"month\": 12,\n \"last_digits\": \"4444\",\n \"first_digits\": \"555555\",\n \"masked_number\": \"XXXX-XXXX-XXXX-4444\",\n \"fingerprint\": \"39124eb1-9813-ee72-f5df-75725cd9a5c0\",\n \"issuer\": \"Informação não disponivel\",\n \"card_type\": \"Multiplo\",\n \"foreign_card\": \"t\"\n }\n}" schema: type: object properties: id: type: string example: 9F9977E32DC74DC18266FD02454AB4F5 description: type: string example: Meu Master Roxinho item_type: type: string example: credit_card customer_id: type: string example: 3B926491FC954603B886BC279A769D99 data: type: object properties: brand: type: string example: Master holder_name: type: string example: NOME NO KARTÃO display_number: type: string example: XXXX-XXXX-XXXX-4444 bin: type: string example: '555555' year: type: integer example: 2030 default: 0 month: type: integer example: 12 default: 0 last_digits: type: string example: '4444' first_digits: type: string example: '555555' masked_number: type: string example: XXXX-XXXX-XXXX-4444 fingerprint: type: string example: 39124eb1-9813-ee72-f5df-75725cd9a5c0 issuer: type: string example: Informação não disponivel card_type: type: string example: Multiplo foreign_card: type: string example: t '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} '404': description: '404' content: application/json: examples: Result: value: "{\n \"errors\": \"Customer payment method Not Found\"\n}" schema: type: object properties: errors: type: string example: Customer payment method Not Found deprecated: false tags: - Customers delete: summary: Remover Forma de Pagamento description: Remove permanentemente uma forma de pagamento de um cliente. operationId: remover-forma-de-pagamento parameters: - name: customer_id in: path description: ID do cliente schema: type: string required: true - name: id in: path description: ID da forma de pagamento schema: type: string required: true responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"id\": \"2715312643B649D98830AAE0344A1A08\",\n \"description\": \"Meu cartão do Banco Roxo\",\n \"item_type\": \"credit_card\",\n \"customer_id\": \"590259547ED341C78A6DC0D377B4BC92\",\n \"data\": {\n \"bin\": \"411111\",\n \"year\": 2030,\n \"month\": 12,\n \"brand\": \"Visa\",\n \"holder_name\": \"NOME SOBRENOME\",\n \"display_number\": \"XXXX-XXXX-XXXX-1111\",\n \"fingerprint\": \"39124eb1-9813-ee72-f5df-75725cd9a5c0\",\n \"remote_ip\": null,\n \"billing_address\": null,\n \"issuer\": \"Informação não disponivel\",\n \"issuer_code\": \"\",\n \"card_type\": \"Multiplo\",\n \"foreign_card\": \"t\"\n }\n}" schema: type: object properties: id: type: string example: 2715312643B649D98830AAE0344A1A08 description: type: string example: Meu cartão do Banco Roxo item_type: type: string example: credit_card customer_id: type: string example: 590259547ED341C78A6DC0D377B4BC92 data: type: object properties: bin: type: string example: '411111' year: type: integer example: 2030 default: 0 month: type: integer example: 12 default: 0 brand: type: string example: Visa holder_name: type: string example: NOME SOBRENOME display_number: type: string example: XXXX-XXXX-XXXX-1111 fingerprint: type: string example: 39124eb1-9813-ee72-f5df-75725cd9a5c0 remote_ip: {} billing_address: {} issuer: type: string example: Informação não disponivel issuer_code: type: string example: '' card_type: type: string example: Multiplo foreign_card: type: string example: t '400': description: '400' content: application/json: examples: Result: value: '{}' schema: type: object properties: {} deprecated: false tags: - Customers servers: - url: https://api.iugu.com/v1 components: securitySchemes: sec0: type: apiKey in: query name: api_token x-refined-from: - iugu-clientes-openapi.yml - iugu-formas-de-pagamento-do-cliente-openapi.yml 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/antecipar-recebiveis.md - https://dev.iugu.com/reference/consultar-unidade-de-recebiveis.md - https://dev.iugu.com/reference/listar-recebiveis.md - https://dev.iugu.com/reference/listar-unidade-de-recebiveis.md merge: pages: 4 deduped: 3 conflicts_kept_first: 0