Wiipo

2.0info: 1.0.0 Boletos Service description: Wiipo Boletos Service x-senior-domain: Wiipo x-senior-domain-path: wiipo x-senior-service-path: boleto contact: email: power@wiipo.comhost: api.wiipo.com /boletosecurityDefinitions: {}schemes:- https- application/json- application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /{boleto_id}/history: get: description: API responsável por retornar um array com o histórico de alterações no boleto summary: Retorna uma listagem do histórico do boleto tags: – Dados do boleto operationId: Retornaumalistagemdohistóricodoboleto deprecated: false – application/json parameters: – #/parameters/clientId – name: boleto_id in: path required: true type: string description: Identificador único do boleto responses: 200: description: Sucesso ao buscar os dados schema: #/definitions/History headers: {} 400: description: Falha ao buscar os dados schema: #/definitions/Fail 401: description: Unauthorized schema: #/definitions/GenericError 403: description: Forbidden schema: #/definitions/GenericError 500: description: Erro Interno do servidor schema: #/definitions/GenericError /{boleto_id}/issued/history: get: description: API responsável pela listagem do histórico de emissões/atualizações do boleto, se ele está aguardando cancelamento, cancelado, ou aguardando pagamento. summary: Lista o histórico de emissões/atualizações do boleto tags: – Dados do boleto operationId: Listaohistóricodeemissões/atualizaçõesdoboleto deprecated: false – application/json parameters: – #/parameters/clientId – name: boleto_id in: path required: true type: string format: uuid description: UUID do boleto responses: 200: description: Sucesso ao buscar os dados schema: type: array items: #/definitions/IssuedHistory headers: {} 400: description: Falha ao buscar os dados schema: #/definitions/Fail 401: description: Unauthorized schema: #/definitions/GenericError 403: description: Forbidden schema: #/definitions/GenericError 500: description: Erro Interno do servidor schema: #/definitions/GenericError /{boleto_id}/details: get: description: API responsável por retornar os dados do boleto summary: Retorna todos os detalhes do boleto tags: – Dados do boleto operationId: Retornatodososdetalhesdoboleto deprecated: false – application/json parameters: – #/parameters/clientId – name: boleto_id in: path required: true type: string description: Identificador único do boleto responses: 200: description: Sucesso ao buscar os dados schema: #/definitions/Details headers: {} 400: description: Falha ao buscar os dados schema: #/definitions/Fail 401: description: Unauthorized schema: #/definitions/GenericError 403: description: Forbidden schema: #/definitions/GenericError 500: description: Erro Interno do servidor schema: #/definitions/GenericError /{boleto_id}/pdf: get: description: API responsável pela conversão do boleto para PDF summary: Realiza a conversão do boleto para PDF tags: – Dados do boleto operationId: RealizaaconversãodoboletoparaPDF deprecated: false – application/json parameters: – #/parameters/clientId – name: boleto_id in: path required: true type: string format: uuid description: UUID do boleto responses: 200: description: Sucesso ao buscar os dados schema: #/definitions/inline_response_200_3 headers: {} 400: description: Falha ao buscar os dados schema: #/definitions/Fail 401: description: Unauthorized schema: #/definitions/GenericError 403: description: Forbidden schema: #/definitions/GenericError 500: description: Erro Interno do servidor schema: #/definitions/GenericError /processing/start: post: description: API responsável pela criação do boleto summary: Realiza a criação do boleto tags: – Boletos operationId: Realizaacriaçãodoboleto deprecated: false – application/json parameters: – #/parameters/clientId – name: body in: body required: true description: schema: #/definitions/BoletoStruct responses: 200: description: Sucesso ao buscar os dados schema: #/definitions/inline_response_200 headers: {} 400: description: Falha ao buscar os dados schema: #/definitions/Fail 401: description: Unauthorized schema: #/definitions/GenericError 403: description: Forbidden schema: #/definitions/GenericError 500: description: Erro Interno do servidor schema: #/definitions/GenericError /{boleto_id}/cancel: post: description: API responsável pelo cancelamento do boleto summary: Realiza o cancelamento do boleto tags: – Boletos operationId: Realizaocancelamentodoboleto deprecated: false – application/json parameters: – #/parameters/clientId – name: boleto_id in: path required: true type: string description: UUID do boleto responses: 200: description: Sucesso ao buscar os dados schema: #/definitions/inline_response_200_1 headers: {} /{boleto_id}/update: put: description: API responsável pela atualização de dados do boleto summary: Realiza a atualização do boleto tags: – Boletos operationId: Realizaaatualizaçãodoboleto deprecated: false – application/json parameters: – #/parameters/clientId – name: boleto_id in: path required: true type: string description: UUID do boleto – name: body in: body required: true description: schema: #/definitions/body responses: 200: description: Sucesso ao buscar os dados schema: #/definitions/inline_response_200_2 headers: {} 400: description: Falha ao buscar os dados schema: #/definitions/Fail 401: description: Unauthorized schema: #/definitions/GenericError 403: description: Forbidden schema: #/definitions/GenericError 500: description: Erro Interno do servidor schema: #/definitions/GenericError /last-created: get: description: API responsável por buscar os últimos boletos criados conforme o paramêtro de datas informados summary: Busca os últimos boletos criados tags: – Dashboard operationId: Buscaosúltimosboletoscriados deprecated: false – application/json parameters: – #/parameters/clientId – name: days in: query required: false type: integer format: int32 description: Número de dias anteriores que deseja-se consultar, somente é aceito valores de 1 a 30 dias responses: 200: description: Sucesso ao buscar os dados schema: type: array items: #/definitions/LastCreated_inner headers: {} 400: description: Falha ao buscar os dados schema: #/definitions/Fail 401: description: Unauthorized schema: #/definitions/GenericError 403: description: Forbidden schema: #/definitions/GenericError 500: description: Erro Interno do servidor schema: #/definitions/GenericError /last-updates: get: description: API responsável por buscar os últimos boletos que foram atualizados conforme o paramêtro de datas informados summary: Busca os últimos boletos que tiveram dados atualizados tags: – Dashboard operationId: Buscaosúltimosboletosquetiveramdadosatualizados deprecated: false – application/json parameters: – #/parameters/clientId – name: days in: query required: false type: integer format: int32 description: Número de dias anteriores que deseja-se consultar, somente é aceito valores de 1 a 30 dias responses: 200: description: Sucesso ao buscar os dados schema: type: array items: #/definitions/LastUpdates_inner headers: {} 400: description: Falha ao buscar os dados schema: #/definitions/Fail 401: description: Unauthorized schema: #/definitions/GenericError 403: description: Forbidden schema: #/definitions/GenericError 500: description: Erro Interno do servidor schema: #/definitions/GenericError /expiration: get: description: API responsável por buscar os boletos que venceram nos últimos dias informado pelo parâmetro summary: Busca os boletos que já venceram tags: – Dashboard operationId: Buscaosboletosquejávenceram deprecated: false – application/json parameters: – #/parameters/clientId – name: days in: query required: false type: integer format: int32 description: Número de dias anteriores que deseja-se consultar, somente é aceito valores de 1 a 30 dias responses: 200: description: Sucesso ao buscar os dados schema: type: array items: #/definitions/Expiration_inner headers: {} 400: description: Falha ao buscar os dados schema: #/definitions/Fail 401: description: Unauthorized schema: #/definitions/GenericError 403: description: Forbidden schema: #/definitions/GenericError 500: description: Erro Interno do servidor schema: #/definitions/GenericErrordefinitions: History: History type: object properties: history: type: array items: #/definitions/History_history Details: Details type: object properties: boleto: #/definitions/Details_boleto IssuedHistory: IssuedHistory type: object properties: id: example: 04b852c5-0523-45b4-85bf-c72f26e06460 type: string status: example: canceled type: string LastCreated_inner: LastCreated_inner type: object properties: id: example: 87349a9f-db01-410e-ad1c-37016a6a8fcf type: string created_at: example: 2020-11-17T12:49:55.396Z type: string customer_name: example: Cliente teste type: string customer_tax_number: example: 66792941000113 type: string total: example: 3.00 type: string due_at: example: 2020-11-10T20:08:17.073Z type: string status: example: waiting_payment type: string LastUpdates_inner: LastUpdates_inner type: object properties: id: example: d0eedf2e-ba23-46ba-a579-29161b7aa974 type: string key: example: 120;3;165;01 type: string customer_name: example: Filial 3 – Mercado type: string customer_tax_number: example: 80680093000181 type: string created_at: example: 2020-11-20T15:07:40.642Z type: string updated_at: example: 2020-11-20T15:07:43.663Z type: string total: example: 110.00 type: string due_at: example: 2020-11-21T02:59:59.000Z type: string status: example: waiting_payment type: string Expiration_inner: Expiration_inner type: object properties: id: example: 87349a9f-db01-410e-ad1c-37016a6a8fcf type: string created_at: example: 2020-11-17T12:49:55.396Z type: string customer_name: example: Cliente teste type: string customer_tax_number: example: 66792941000113 type: string total: example: 3.00 type: string due_at: example: 2020-11-10T20:08:17.073Z type: string status: example: payed type: string BoletoStruct: BoletoStruct type: object properties: async: example: false type: boolean supplier: #/definitions/BoletoStruct_supplier titles: type: array items: #/definitions/BoletoStruct_titles Fail: Fail type: object properties: message: type: string category: type: string messages: type: array items: #/definitions/Fail_messages GenericError: GenericError type: object properties: message: type: string category: type: string inline_response_200: inline_response_200 type: object properties: message: example: Boletos are being processed type: string boletos: type: array items: type: object inline_response_200_1: inline_response_200_1 type: object properties: boleto_id: type: string message: example: Boleto cancellation successfully queued type: string body: body type: object properties: value: type: number format: double targetEmails: type: array items: type: string dueDate: description: Data no padrão ISO type: string interest: type: object discount: type: object lateFee: type: object customData: type: object description: type: string async: example: false type: boolean inline_response_200_2: inline_response_200_2 type: object properties: message: example: Boleto are being processed type: string boleto: description: Dados do boleto atualizado type: object inline_response_200_3: inline_response_200_3 type: object properties: pdf: description: Retorna um array de bytes type: array items: type: number format: double History_status_detail: History_status_detail type: object properties: messages: type: array items: type: string History_history: History_history type: object properties: id: example: ff70d7d3-0b05-4ece-af6d-1a156c1eb08e type: string status_message: example: Emissão sincronizada type: string status_detail: #/definitions/History_status_detail status_timestamp: example: 2020-11-14T20:23:50.370Z type: string status_category: example: issuance_synchronized type: string status_category_description: example: Emissão sincronizada type: string status_category_error: example: false type: boolean Details_boleto_general_interest_data: Details_boleto_general_interest_data type: object properties: mode: example: DAILY_PERCENTAGE type: string percentage: example: 0.17 type: string start_date: example: 2021-01-03T02:59:59.000Z type: string Details_boleto_general_latefee_data: Details_boleto_general_latefee_data type: object properties: mode: example: PERCENTAGE type: string percentage: example: 3.0 type: string start_date: example: 2021-01-03T02:59:59.000Z type: string Details_boleto_general_custom_data: Details_boleto_general_custom_data type: object properties: client: example: 102 type: number format: double series: type: string company: example: 1 type: number format: double invoice: example: 0 type: number format: double titleType: example: 001 type: string subsidiary: example: 1 type: number format: double titleNumber: example: WIIP-SAND-A-060 type: string Details_boleto_general: Details_boleto_general type: object properties: id: example: 6a5d41d3-5489-4c91-a404-c1274d143324 type: string supplier: example: 2cbc9af0-2f8b-41a7-ae93-f4fbed19627d type: string customer: example: 7d7ad012-fd96-48ad-a65a-3177cdc40ca0 type: string interest_data: #/definitions/Details_boleto_general_interest_data discount_data: type: string latefee_data: #/definitions/Details_boleto_general_latefee_data custom_data: #/definitions/Details_boleto_general_custom_data value: example: 69.549999999999997 type: number format: double dueAt: example: 2020-12-29T02:59:59+00:00 type: string status: example: eba76c4c-d9b9-4a14-a749-8736acacd624 type: string createdAt: example: 2020-11-14T19:35:18.222783+00:00 type: string key: example: 1;1;WIIP-SAND-A-060;001 type: string tags: type: array items: type: string description: example: Título: WIIP-SAND-A-060 type: string dueAtText: example: 28/12/2020 type: string targetEmails: type: array items: type: string Details_boleto_status_detail_partnerdata: Details_boleto_status_detail_partnerdata type: object properties: bankCode: example: 341 type: string billetId: example: 8a64ae293c7e4e039745fccdeda48842 type: string transactionId: example: 3295bd98757c4847a30dcd996fecc16c type: string bankWalletCode: example: 109 type: string billetDocumentNumber: example: 7709200 type: string billetReferenceNumber: example: 7709200 type: string Details_boleto_status_detail: Details_boleto_status_detail type: object properties: md5: example: 802b1cda29dbe41169d7382b97daab49 type: string file: example: https://example.com/payslip.html type: string barcode: example: 34191090737092007893131339210002284830000006955 type: string messages: type: array items: type: string ournumber: example: 109/07709200-8 type: string partnerdata: #/definitions/Details_boleto_status_detail_partnerdata Details_boleto_status: Details_boleto_status type: object properties: id: example: eba76c4c-d9b9-4a14-a749-8736acacd624 type: string boleto: example: 6a5d41d3-5489-4c91-a404-c1274d143324 type: string category: example: waiting_payment type: string message: example: Aguardando pagamento type: string detail: #/definitions/Details_boleto_status_detail createdAt: example: 2020-11-14T20:09:36.13892+00:00 type: string Details_boleto_status_category: Details_boleto_status_category type: object properties: id: example: waiting_payment type: string description: example: Aguardando pagamento type: string createdAt: example: 2020-10-07T20:11:40.182239+00:00 type: string is_error: example: false type: boolean Details_boleto_issuance: Details_boleto_issuance type: object properties: id: example: eae8842d-a668-4f30-a9d1-302886e72a54 type: string boleto: example: 6a5d41d3-5489-4c91-a404-c1274d143324 type: string barcode: example: 34191090737092007893131339210002284830000006955 type: string ournumber: example: 109/07709200-8 type: string file: example: https://example.com/payslip.html type: string status: example: eba76c4c-d9b9-4a14-a749-8736acacd624 type: string createdAt: example: 2020-11-14T20:09:36.234261+00:00 type: string partner_data: #/definitions/Details_boleto_status_detail_partnerdata md5: example: 802b1cda29dbe41169d7382b97daab49 type: string Details_boleto_supplier: Details_boleto_supplier type: object properties: id: example: 2cbc9af0-2f8b-41a7-ae93-f4fbed19627d type: string email: example: example@example.com type: string name: example: EXAMPLE LTDA type: string taxnumber: example: 21813091000100 type: string address: example: Rua São Paulo, 825 type: string neighborhood: example: Victor Konder type: string city: example: Blumenau type: string state: example: SC type: string postal_code: example: 89012001 type: string country_code: example: BR type: string is_supplier: example: true type: boolean createdAt: example: 2020-11-10T01:16:30.874529+00:00 type: string target_supplier: example: 18adcc26-6d95-4afa-9c2e-7efe5fd4935a type: string Details_boleto: Details_boleto type: object properties: general: #/definitions/Details_boleto_general status: #/definitions/Details_boleto_status status_category: #/definitions/Details_boleto_status_category issuance: #/definitions/Details_boleto_issuance payment: type: object supplier: #/definitions/Details_boleto_supplier customer: #/definitions/Details_boleto_customer BoletoStruct_supplier: BoletoStruct_supplier type: object properties: taxNumber: description: CNPJ ou CPF example: 16398973000160 type: string bankAccount: type: string Details_boleto_customer: Details_boleto_customer type: object properties: id: example: 7d7ad012-fd96-48ad-a65a-3177cdc40ca0 type: string email: example: example@wiipo.com type: string name: example: Vicente Martim Lage type: string taxnumber: example: 71619829000115 type: string address: example: Praca Dom Pedro Ii type: string neighborhood: example: Centro type: string city: example: Blumenau type: string state: example: SC type: string postal_code: example: 89012001 type: string country_code: example: BR type: string is_supplier: example: false type: boolean createdAt: example: 2020-11-10T01:16:30.874529+00:00 type: string BoletoStruct_interest: BoletoStruct_interest type: object properties: mode: type: string amount: example: 120.00 type: string percentage: example: 10.0 type: string start_date: type: string BoletoStruct_discount: BoletoStruct_discount type: object properties: mode: type: string amount: example: 120.00 type: string percentage: example: 10.0 type: string limit_date: type: string BoletoStruct_customer: BoletoStruct_customer type: object properties: type: type: string taxNumber: description: CNPJ ou CPF example: 16398973000160 type: string name: type: string address: type: string neighborhood: type: string city: type: string zipCode: type: string state: type: string country: type: string BoletoStruct_titles: BoletoStruct_titles type: object properties: key: type: string value: type: number format: double targetEmails: type: array items: type: string dueDate: description: Data no padrão ISO type: string paymentLimitDate: description: Data no padrão ISO (Opcional) – Para definir a data máxima para pagamento, opera de forma exclusiva, desta forma é necessário, por exemplo, caso queria o recebimento até a data de vencimento, passar o seu valor como um dia posterior a data de vencimento type: string interest: #/definitions/BoletoStruct_interest discount: #/definitions/BoletoStruct_discount lateFee: #/definitions/BoletoStruct_interest customData: type: object description: type: string customer: #/definitions/BoletoStruct_customer Fail_params: Fail_params type: object properties: path: type: string Fail_messages: Fail_messages type: object properties: name: type: string path: type: string type: type: string errors: type: array items: type: string inner: type: array items: type: string message: type: string params: #/definitions/Fail_paramstags:- name: Dados do boleto description: Endpoints para obtenção de dados sobre um boleto em específico- name: Boletos description: Endpoints referente aos estados (emissão, atualização, cancelamento) dos boletos- name: Dashboard description: Endpoints relacionados ao dashboard sobre os boletos