{"openapi":"3.1.0","info":{"title":"API V1","version":"1.0"},"servers":[{"url":"https://api.v2.medusapay.com.br/v1"}],"components":{"securitySchemes":{"sec0":{"type":"http","scheme":"basic"}}},"security":[{"sec0":[]}],"paths":{"/transactions":{"post":{"summary":"Criar transação","description":"Para criar uma transação, use a rota /transactions, tanto para cartão de crédito, boleto ou PIX.","operationId":"criar-transacao","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["amount","paymentMethod","customer","items"],"properties":{"amount":{"type":"integer","description":"Valor em centavos (500 = R$ 5,00)","format":"int32"},"paymentMethod":{"type":"string","description":"Meio de pagamento. Valores possíveis: **credit_card**, **boleto**, **pix**."},"card":{"type":"object","description":"Informações do cartão do cliente. **Obrigatório** caso **paymentMethod** seja **credit_card**.","required":["id","hash","number","holderName","expirationMonth","expirationYear"],"properties":{"id":{"type":"integer","description":"ID do cartão. Obs: Caso seja passado o ID, os outros campos do objeto card são dispensáveis.","format":"int32"},"hash":{"type":"string","description":"Hash do cartão. Obs: A hash é válida por apenas 5 minutos. Não a armazene em seu banco de dados. Caso seja passado a hash, os outros campos do objeto card são dispensáveis."},"number":{"type":"string","description":"Número do cartão."},"holderName":{"type":"string","description":"Nome do portador do cartão."},"expirationMonth":{"type":"integer","description":"Mês de expiração.","format":"int32"},"expirationYear":{"type":"integer","description":"Ano de expiração.","format":"int32"},"cvv":{"type":"string","description":"CVV do cartão."}}},"installments":{"type":"integer","description":"Quantidade de parcelas. **Obrigatório** caso **paymentMethod** seja **credit_card**.","format":"int32"},"customer":{"type":"object","description":"Dados do cliente.","required":["name","email"],"properties":{"id":{"type":"string","description":"ID do cliente previamente criado. Não é necessário informar os outros campos caso o ID esteja preenchido."},"name":{"type":"string","description":"Nome do cliente."},"email":{"type":"string","description":"E-mail do cliente."},"document":{"type":"object","description":"Documento do cliente.","required":["number","type"],"properties":{"number":{"type":"string","description":"Número do documento."},"type":{"type":"string","description":"Tipo do documento. Valores possíveis: cpf, cnpj"}}},"phone":{"type":"string","description":"Telefone do cliente. Deve ser passado no formato 1199999999."},"externalRef":{"type":"string","description":"Referência do cliente em sua API."}}},"shipping":{"type":"object","description":"Dados de entrega.","required":["fee"],"properties":{"fee":{"type":"integer","description":"Taxa de entrega. **Não é cobrada a mais no valor total da transação.**","format":"int32"},"address":{"type":"object","description":"Endereço de entrega.","required":["street","streetNumber","zipCode","neighborhood","city","state","country"],"properties":{"street":{"type":"string","description":"Rua"},"streetNumber":{"type":"string","description":"Número"},"complement":{"type":"string","description":"Complemento"},"zipCode":{"type":"string","description":"CEP"},"neighborhood":{"type":"string","description":"Bairro"},"city":{"type":"string","description":"Cidade"},"state":{"type":"string","description":"Estado (2 dígitos em letra maiúscula, exemplo: **SP**)"},"country":{"type":"string","description":"País (2 dígitos, exemplo: **br**)"}}}}},"items":{"type":"array","description":"Lista de itens da transação.","items":{"properties":{"title":{"type":"string","description":"Título do item."},"unitPrice":{"type":"integer","description":"Preço unitário em centavos. Ex: R$ 5,00 = 500.","format":"int32"},"quantity":{"type":"integer","description":"Quantidade do item na transação.","format":"int32"},"tangible":{"type":"boolean","description":"Se o item é físico."},"externalRef":{"type":"string","description":"Referência do item em sua API."}},"required":["title","unitPrice","quantity","tangible"],"type":"object"}},"boleto":{"type":"object","description":"Informações sobre a expiração do boleto.","properties":{"expiresInDays":{"type":"integer","description":"Tempo de expiração do boleto em dias.","format":"int32"}}},"pix":{"type":"object","description":"Informações sobre a expiração do PIX.","properties":{"expiresInDays":{"type":"integer","description":"Tempo de expiração do PIX em dias.","format":"int32"}}},"postbackUrl":{"type":"string","description":"URL em sua API que receberá atualizações da transação."},"metadata":{"type":"string","description":"Metadados para facilitar a visualização e controle das transações."},"traceable":{"type":"boolean","description":"Se o status de entrega será gerenciado pelo painel. O padrão é **false**"},"ip":{"type":"string","description":"IP do cliente."},"splits":{"type":"array","description":"Regras de divisão da transação.","items":{"properties":{"recipientId":{"type":"integer","description":"ID do recebedor.","format":"int32"},"amount":{"type":"integer","description":"Valor da transação em centavos.","format":"int32"},"chargeProcessingFee":{"type":"boolean","description":"Se o recebedor será cobrado das taxas da criação da transação. Default ```true``` para todos os recebedores da transação."}},"required":["recipientId","amount"],"type":"object"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n\t\"id\": 282,\n\t\"amount\": 10000,\n\t\"refundedAmount\": 0,\n\t\"companyId\": 2,\n\t\"installments\": 12,\n\t\"paymentMethod\": \"credit_card\",\n\t\"status\": \"paid\",\n\t\"postbackUrl\": null,\n\t\"metadata\": null,\n\t\"traceable\": false,\n\t\"secureId\": \"a4594817-be48-4a23-81aa-4bb01f95fe78\",\n\t\"secureUrl\": \"https://link.compra.com.br/pagar/a4594817-be48-4a23-81aa-4bb01f95fe78\",\n\t\"createdAt\": \"2022-07-18T09:54:22.000Z\",\n\t\"updatedAt\": \"2022-07-18T09:54:22.000Z\",\n\t\"paidAt\": \"2022-07-18T09:54:22.000Z\",\n\t\"ip\": null,\n\t\"externalRef\": null,\n\t\"customer\": {\n\t\t\"id\": 1,\n\t\t\"externalRef\": null,\n\t\t\"name\": \"Gabryel\",\n\t\t\"email\": \"gabryel@hotmail.com\",\n\t\t\"phone\": \"11999999999\",\n\t\t\"birthdate\": null,\n\t\t\"createdAt\": \"2022-05-26T19:17:48.000Z\",\n\t\t\"document\": {\n\t\t\t\"number\": \"12345678910\",\n\t\t\t\"type\": \"cpf\"\n\t\t},\n\t\t\"address\": {\n\t\t\t\"street\": \"Rua República Argentina\",\n\t\t\t\"streetNumber\": \"4214\",\n\t\t\t\"complement\": null,\n\t\t\t\"zipCode\": \"11065030\",\n\t\t\t\"neighborhood\": \"Pompéia\",\n\t\t\t\"city\": \"Santos\",\n\t\t\t\"state\": \"SP\",\n\t\t\t\"country\": \"BR\"\n\t\t}\n\t},\n\t\"card\": {\n\t\t\"id\": 147,\n\t\t\"brand\": \"visa\",\n\t\t\"holderName\": \"GABRYEL FERREIRA\",\n\t\t\"lastDigits\": \"1111\",\n\t\t\"expirationMonth\": 3,\n\t\t\"expirationYear\": 2028,\n\t\t\"reusable\": true,\n\t\t\"createdAt\": \"2022-07-17T18:08:11.000Z\"\n\t},\n\t\"boleto\": null,\n\t\"pix\": null,\n\t\"shipping\": null,\n\t\"refusedReason\": null,\n\t\"items\": [\n\t\t{\n\t\t\t\"externalRef\": null,\n\t\t\t\"title\": \"b456\",\n\t\t\t\"unitPrice\": 100,\n\t\t\t\"quantity\": 1,\n\t\t\t\"tangible\": false\n\t\t}\n\t],\n\t\"splits\": [\n\t\t{\n\t\t\t\"recipientId\": 1,\n\t\t\t\"amount\": 10000,\n\t\t\t\"netAmount\": 9400\n\t\t}\n\t],\n\t\"refunds\": [],\n\t\"delivery\": null,\n\t\"fee\": {\n\t\t\"fixedAmount\": 200,\n\t\t\"spreadPercentage\": 4,\n\t\t\"estimatedFee\": 600,\n\t\t\"netAmount\": 9400\n\t}\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":282,"default":0},"amount":{"type":"integer","example":10000,"default":0},"refundedAmount":{"type":"integer","example":0,"default":0},"companyId":{"type":"integer","example":2,"default":0},"installments":{"type":"integer","example":12,"default":0},"paymentMethod":{"type":"string","example":"credit_card"},"status":{"type":"string","example":"paid"},"postbackUrl":{},"metadata":{},"traceable":{"type":"boolean","example":false,"default":true},"secureId":{"type":"string","example":"a4594817-be48-4a23-81aa-4bb01f95fe78"},"secureUrl":{"type":"string","example":"https://link.compra.com.br/pagar/a4594817-be48-4a23-81aa-4bb01f95fe78"},"createdAt":{"type":"string","example":"2022-07-18T09:54:22.000Z"},"updatedAt":{"type":"string","example":"2022-07-18T09:54:22.000Z"},"paidAt":{"type":"string","example":"2022-07-18T09:54:22.000Z"},"ip":{},"externalRef":{},"customer":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"externalRef":{},"name":{"type":"string","example":"Gabryel"},"email":{"type":"string","example":"gabryel@hotmail.com"},"phone":{"type":"string","example":"11999999999"},"birthdate":{},"createdAt":{"type":"string","example":"2022-05-26T19:17:48.000Z"},"document":{"type":"object","properties":{"number":{"type":"string","example":"12345678910"},"type":{"type":"string","example":"cpf"}}},"address":{"type":"object","properties":{"street":{"type":"string","example":"Rua República Argentina"},"streetNumber":{"type":"string","example":"4214"},"complement":{},"zipCode":{"type":"string","example":"11065030"},"neighborhood":{"type":"string","example":"Pompéia"},"city":{"type":"string","example":"Santos"},"state":{"type":"string","example":"SP"},"country":{"type":"string","example":"BR"}}}}},"card":{"type":"object","properties":{"id":{"type":"integer","example":147,"default":0},"brand":{"type":"string","example":"visa"},"holderName":{"type":"string","example":"GABRYEL FERREIRA"},"lastDigits":{"type":"string","example":"1111"},"expirationMonth":{"type":"integer","example":3,"default":0},"expirationYear":{"type":"integer","example":2028,"default":0},"reusable":{"type":"boolean","example":true,"default":true},"createdAt":{"type":"string","example":"2022-07-17T18:08:11.000Z"}}},"boleto":{},"pix":{},"shipping":{},"refusedReason":{},"items":{"type":"array","items":{"type":"object","properties":{"externalRef":{},"title":{"type":"string","example":"b456"},"unitPrice":{"type":"integer","example":100,"default":0},"quantity":{"type":"integer","example":1,"default":0},"tangible":{"type":"boolean","example":false,"default":true}}}},"splits":{"type":"array","items":{"type":"object","properties":{"recipientId":{"type":"integer","example":1,"default":0},"amount":{"type":"integer","example":10000,"default":0},"netAmount":{"type":"integer","example":9400,"default":0}}}},"refunds":{"type":"array","items":{"type":"object","properties":{}}},"delivery":{},"fee":{"type":"object","properties":{"fixedAmount":{"type":"integer","example":200,"default":0},"spreadPercentage":{"type":"integer","example":4,"default":0},"estimatedFee":{"type":"integer","example":600,"default":0},"netAmount":{"type":"integer","example":9400,"default":0}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"get":{"summary":"Listar transações","description":"","operationId":"listar-transacoes","parameters":[{"name":"id","in":"query","description":"ID da transação.","schema":{"type":"integer","format":"int32"}},{"name":"paymentMethods","in":"query","description":"Forma de pagamento. Valores possíveis: **credit_card, boleto, pix**. Caso envie mais de 1, enviar separado por vírgula.","schema":{"type":"string"}},{"name":"status","in":"query","description":"Status da transação. Valores possíveis: **processing, authorized, paid, refunded, waiting_payment, refused, chargedback, canceled, in_protest, partially_paid**. Caso envie mais de 1, enviar separado por vírgula.","schema":{"type":"string"}},{"name":"deliveryStatus","in":"query","description":"Status de entrega. Valores possíveis: **waiting, in_transit, delivered**. Caso envie mais de 1, enviar separado por vírgula.","schema":{"type":"string"}},{"name":"installments","in":"query","description":"Número de parcelas (de 1 a 12). Caso envie mais de 1, enviar separado por vírgula.","schema":{"type":"string"}},{"name":"name","in":"query","description":"Nome do cliente.","schema":{"type":"string"}},{"name":"email","in":"query","description":"E-mail do cliente.","schema":{"type":"string"}},{"name":"documentNumber","in":"query","description":"Número do documento do cliente.","schema":{"type":"string"}},{"name":"phone","in":"query","description":"Telefone do cliente.","schema":{"type":"string"}},{"name":"traceable","in":"query","description":"Status de entrega da transação gerenciada pelo painel.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n\t\"id\": 282,\n\t\"amount\": 10000,\n\t\"refundedAmount\": 0,\n\t\"companyId\": 2,\n\t\"installments\": 12,\n\t\"paymentMethod\": \"credit_card\",\n\t\"status\": \"paid\",\n\t\"postbackUrl\": null,\n\t\"metadata\": null,\n\t\"traceable\": false,\n\t\"secureId\": \"a4594817-be48-4a23-81aa-4bb01f95fe78\",\n\t\"secureUrl\": \"https://link.compra.com.br/pagar/a4594817-be48-4a23-81aa-4bb01f95fe78\",\n\t\"createdAt\": \"2022-07-18T09:54:22.000Z\",\n\t\"updatedAt\": \"2022-07-18T09:54:22.000Z\",\n\t\"paidAt\": \"2022-07-18T09:54:22.000Z\",\n\t\"ip\": null,\n\t\"externalRef\": null,\n\t\"customer\": {\n\t\t\"id\": 1,\n\t\t\"externalRef\": null,\n\t\t\"name\": \"Gabryel\",\n\t\t\"email\": \"gabryel@hotmail.com\",\n\t\t\"phone\": \"11999999999\",\n\t\t\"birthdate\": null,\n\t\t\"createdAt\": \"2022-05-26T19:17:48.000Z\",\n\t\t\"document\": {\n\t\t\t\"number\": \"12345678910\",\n\t\t\t\"type\": \"cpf\"\n\t\t},\n\t\t\"address\": {\n\t\t\t\"street\": \"Rua República Argentina\",\n\t\t\t\"streetNumber\": \"4214\",\n\t\t\t\"complement\": null,\n\t\t\t\"zipCode\": \"11065030\",\n\t\t\t\"neighborhood\": \"Pompéia\",\n\t\t\t\"city\": \"Santos\",\n\t\t\t\"state\": \"SP\",\n\t\t\t\"country\": \"BR\"\n\t\t}\n\t},\n\t\"card\": {\n\t\t\"id\": 147,\n\t\t\"brand\": \"visa\",\n\t\t\"holderName\": \"GABRYEL FERREIRA\",\n\t\t\"lastDigits\": \"1111\",\n\t\t\"expirationMonth\": 3,\n\t\t\"expirationYear\": 2028,\n\t\t\"reusable\": true,\n\t\t\"createdAt\": \"2022-07-17T18:08:11.000Z\"\n\t},\n\t\"boleto\": null,\n\t\"pix\": null,\n\t\"shipping\": null,\n\t\"refusedReason\": null,\n\t\"items\": [\n\t\t{\n\t\t\t\"externalRef\": null,\n\t\t\t\"title\": \"b456\",\n\t\t\t\"unitPrice\": 100,\n\t\t\t\"quantity\": 1,\n\t\t\t\"tangible\": false\n\t\t}\n\t],\n\t\"splits\": [\n\t\t{\n\t\t\t\"recipientId\": 1,\n\t\t\t\"amount\": 10000,\n\t\t\t\"netAmount\": 9400\n\t\t}\n\t],\n\t\"refunds\": [],\n\t\"delivery\": null,\n\t\"fee\": {\n\t\t\"fixedAmount\": 200,\n\t\t\"spreadPercentage\": 4,\n\t\t\"estimatedFee\": 600,\n\t\t\"netAmount\": 9400\n\t}\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":282,"default":0},"amount":{"type":"integer","example":10000,"default":0},"refundedAmount":{"type":"integer","example":0,"default":0},"companyId":{"type":"integer","example":2,"default":0},"installments":{"type":"integer","example":12,"default":0},"paymentMethod":{"type":"string","example":"credit_card"},"status":{"type":"string","example":"paid"},"postbackUrl":{},"metadata":{},"traceable":{"type":"boolean","example":false,"default":true},"secureId":{"type":"string","example":"a4594817-be48-4a23-81aa-4bb01f95fe78"},"secureUrl":{"type":"string","example":"https://link.compra.com.br/pagar/a4594817-be48-4a23-81aa-4bb01f95fe78"},"createdAt":{"type":"string","example":"2022-07-18T09:54:22.000Z"},"updatedAt":{"type":"string","example":"2022-07-18T09:54:22.000Z"},"paidAt":{"type":"string","example":"2022-07-18T09:54:22.000Z"},"ip":{},"externalRef":{},"customer":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"externalRef":{},"name":{"type":"string","example":"Gabryel"},"email":{"type":"string","example":"gabryel@hotmail.com"},"phone":{"type":"string","example":"11999999999"},"birthdate":{},"createdAt":{"type":"string","example":"2022-05-26T19:17:48.000Z"},"document":{"type":"object","properties":{"number":{"type":"string","example":"12345678910"},"type":{"type":"string","example":"cpf"}}},"address":{"type":"object","properties":{"street":{"type":"string","example":"Rua República Argentina"},"streetNumber":{"type":"string","example":"4214"},"complement":{},"zipCode":{"type":"string","example":"11065030"},"neighborhood":{"type":"string","example":"Pompéia"},"city":{"type":"string","example":"Santos"},"state":{"type":"string","example":"SP"},"country":{"type":"string","example":"BR"}}}}},"card":{"type":"object","properties":{"id":{"type":"integer","example":147,"default":0},"brand":{"type":"string","example":"visa"},"holderName":{"type":"string","example":"GABRYEL FERREIRA"},"lastDigits":{"type":"string","example":"1111"},"expirationMonth":{"type":"integer","example":3,"default":0},"expirationYear":{"type":"integer","example":2028,"default":0},"reusable":{"type":"boolean","example":true,"default":true},"createdAt":{"type":"string","example":"2022-07-17T18:08:11.000Z"}}},"boleto":{},"pix":{},"shipping":{},"refusedReason":{},"items":{"type":"array","items":{"type":"object","properties":{"externalRef":{},"title":{"type":"string","example":"b456"},"unitPrice":{"type":"integer","example":100,"default":0},"quantity":{"type":"integer","example":1,"default":0},"tangible":{"type":"boolean","example":false,"default":true}}}},"splits":{"type":"array","items":{"type":"object","properties":{"recipientId":{"type":"integer","example":1,"default":0},"amount":{"type":"integer","example":10000,"default":0},"netAmount":{"type":"integer","example":9400,"default":0}}}},"refunds":{"type":"array","items":{"type":"object","properties":{}}},"delivery":{},"fee":{"type":"object","properties":{"fixedAmount":{"type":"integer","example":200,"default":0},"spreadPercentage":{"type":"integer","example":4,"default":0},"estimatedFee":{"type":"integer","example":600,"default":0},"netAmount":{"type":"integer","example":9400,"default":0}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/transactions/{id}":{"get":{"summary":"Buscar transação","description":"","operationId":"buscar-transacao","parameters":[{"name":"id","in":"path","description":"ID da transação.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n\t\"id\": 282,\n\t\"amount\": 10000,\n\t\"refundedAmount\": 0,\n\t\"companyId\": 2,\n\t\"installments\": 12,\n\t\"paymentMethod\": \"credit_card\",\n\t\"status\": \"paid\",\n\t\"postbackUrl\": null,\n\t\"metadata\": null,\n\t\"traceable\": false,\n\t\"secureId\": \"a4594817-be48-4a23-81aa-4bb01f95fe78\",\n\t\"secureUrl\": \"https://link.compra.com.br/pagar/a4594817-be48-4a23-81aa-4bb01f95fe78\",\n\t\"createdAt\": \"2022-07-18T09:54:22.000Z\",\n\t\"updatedAt\": \"2022-07-18T09:54:22.000Z\",\n\t\"paidAt\": \"2022-07-18T09:54:22.000Z\",\n\t\"ip\": null,\n\t\"externalRef\": null,\n\t\"customer\": {\n\t\t\"id\": 1,\n\t\t\"externalRef\": null,\n\t\t\"name\": \"Gabryel\",\n\t\t\"email\": \"gabryel@hotmail.com\",\n\t\t\"phone\": \"11999999999\",\n\t\t\"birthdate\": null,\n\t\t\"createdAt\": \"2022-05-26T19:17:48.000Z\",\n\t\t\"document\": {\n\t\t\t\"number\": \"12345678910\",\n\t\t\t\"type\": \"cpf\"\n\t\t},\n\t\t\"address\": {\n\t\t\t\"street\": \"Rua República Argentina\",\n\t\t\t\"streetNumber\": \"4214\",\n\t\t\t\"complement\": null,\n\t\t\t\"zipCode\": \"11065030\",\n\t\t\t\"neighborhood\": \"Pompéia\",\n\t\t\t\"city\": \"Santos\",\n\t\t\t\"state\": \"SP\",\n\t\t\t\"country\": \"BR\"\n\t\t}\n\t},\n\t\"card\": {\n\t\t\"id\": 147,\n\t\t\"brand\": \"visa\",\n\t\t\"holderName\": \"GABRYEL FERREIRA\",\n\t\t\"lastDigits\": \"1111\",\n\t\t\"expirationMonth\": 3,\n\t\t\"expirationYear\": 2028,\n\t\t\"reusable\": true,\n\t\t\"createdAt\": \"2022-07-17T18:08:11.000Z\"\n\t},\n\t\"boleto\": null,\n\t\"pix\": null,\n\t\"shipping\": null,\n\t\"refusedReason\": null,\n\t\"items\": [\n\t\t{\n\t\t\t\"externalRef\": null,\n\t\t\t\"title\": \"b456\",\n\t\t\t\"unitPrice\": 100,\n\t\t\t\"quantity\": 1,\n\t\t\t\"tangible\": false\n\t\t}\n\t],\n\t\"splits\": [\n\t\t{\n\t\t\t\"recipientId\": 1,\n\t\t\t\"amount\": 10000,\n\t\t\t\"netAmount\": 9400\n\t\t}\n\t],\n\t\"refunds\": [],\n\t\"delivery\": null,\n\t\"fee\": {\n\t\t\"fixedAmount\": 200,\n\t\t\"spreadPercentage\": 4,\n\t\t\"estimatedFee\": 600,\n\t\t\"netAmount\": 9400\n\t}\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":282,"default":0},"amount":{"type":"integer","example":10000,"default":0},"refundedAmount":{"type":"integer","example":0,"default":0},"companyId":{"type":"integer","example":2,"default":0},"installments":{"type":"integer","example":12,"default":0},"paymentMethod":{"type":"string","example":"credit_card"},"status":{"type":"string","example":"paid"},"postbackUrl":{},"metadata":{},"traceable":{"type":"boolean","example":false,"default":true},"secureId":{"type":"string","example":"a4594817-be48-4a23-81aa-4bb01f95fe78"},"secureUrl":{"type":"string","example":"https://link.compra.com.br/pagar/a4594817-be48-4a23-81aa-4bb01f95fe78"},"createdAt":{"type":"string","example":"2022-07-18T09:54:22.000Z"},"updatedAt":{"type":"string","example":"2022-07-18T09:54:22.000Z"},"paidAt":{"type":"string","example":"2022-07-18T09:54:22.000Z"},"ip":{},"externalRef":{},"customer":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"externalRef":{},"name":{"type":"string","example":"Gabryel"},"email":{"type":"string","example":"gabryel@hotmail.com"},"phone":{"type":"string","example":"11999999999"},"birthdate":{},"createdAt":{"type":"string","example":"2022-05-26T19:17:48.000Z"},"document":{"type":"object","properties":{"number":{"type":"string","example":"12345678910"},"type":{"type":"string","example":"cpf"}}},"address":{"type":"object","properties":{"street":{"type":"string","example":"Rua República Argentina"},"streetNumber":{"type":"string","example":"4214"},"complement":{},"zipCode":{"type":"string","example":"11065030"},"neighborhood":{"type":"string","example":"Pompéia"},"city":{"type":"string","example":"Santos"},"state":{"type":"string","example":"SP"},"country":{"type":"string","example":"BR"}}}}},"card":{"type":"object","properties":{"id":{"type":"integer","example":147,"default":0},"brand":{"type":"string","example":"visa"},"holderName":{"type":"string","example":"GABRYEL FERREIRA"},"lastDigits":{"type":"string","example":"1111"},"expirationMonth":{"type":"integer","example":3,"default":0},"expirationYear":{"type":"integer","example":2028,"default":0},"reusable":{"type":"boolean","example":true,"default":true},"createdAt":{"type":"string","example":"2022-07-17T18:08:11.000Z"}}},"boleto":{},"pix":{},"shipping":{},"refusedReason":{},"items":{"type":"array","items":{"type":"object","properties":{"externalRef":{},"title":{"type":"string","example":"b456"},"unitPrice":{"type":"integer","example":100,"default":0},"quantity":{"type":"integer","example":1,"default":0},"tangible":{"type":"boolean","example":false,"default":true}}}},"splits":{"type":"array","items":{"type":"object","properties":{"recipientId":{"type":"integer","example":1,"default":0},"amount":{"type":"integer","example":10000,"default":0},"netAmount":{"type":"integer","example":9400,"default":0}}}},"refunds":{"type":"array","items":{"type":"object","properties":{}}},"delivery":{},"fee":{"type":"object","properties":{"fixedAmount":{"type":"integer","example":200,"default":0},"spreadPercentage":{"type":"integer","example":4,"default":0},"estimatedFee":{"type":"integer","example":600,"default":0},"netAmount":{"type":"integer","example":9400,"default":0}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"put":{"summary":"Atualizar transação de teste","description":"Para alterar o status de uma transação no ambiente de testes e receber postbacks, use esse endpoint.","operationId":"atualizar-transacao-de-teste","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["status"],"properties":{"status":{"type":"string","description":"Status da transação. Valores possíveis: ```paid```, ```chargedback```"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n\t\"id\": 282,\n\t\"amount\": 10000,\n\t\"refundedAmount\": 0,\n\t\"companyId\": 2,\n\t\"installments\": 12,\n\t\"paymentMethod\": \"credit_card\",\n\t\"status\": \"paid\",\n\t\"postbackUrl\": null,\n\t\"metadata\": null,\n\t\"traceable\": false,\n\t\"secureId\": \"a4594817-be48-4a23-81aa-4bb01f95fe78\",\n\t\"secureUrl\": \"https://link.compra.com.br/pagar/a4594817-be48-4a23-81aa-4bb01f95fe78\",\n\t\"createdAt\": \"2022-07-18T09:54:22.000Z\",\n\t\"updatedAt\": \"2022-07-18T09:54:22.000Z\",\n\t\"paidAt\": \"2022-07-18T09:54:22.000Z\",\n\t\"ip\": null,\n\t\"externalRef\": null,\n\t\"customer\": {\n\t\t\"id\": 1,\n\t\t\"externalRef\": null,\n\t\t\"name\": \"Gabryel\",\n\t\t\"email\": \"gabryel@hotmail.com\",\n\t\t\"phone\": \"11999999999\",\n\t\t\"birthdate\": null,\n\t\t\"createdAt\": \"2022-05-26T19:17:48.000Z\",\n\t\t\"document\": {\n\t\t\t\"number\": \"12345678910\",\n\t\t\t\"type\": \"cpf\"\n\t\t},\n\t\t\"address\": {\n\t\t\t\"street\": \"Rua República Argentina\",\n\t\t\t\"streetNumber\": \"4214\",\n\t\t\t\"complement\": null,\n\t\t\t\"zipCode\": \"11065030\",\n\t\t\t\"neighborhood\": \"Pompéia\",\n\t\t\t\"city\": \"Santos\",\n\t\t\t\"state\": \"SP\",\n\t\t\t\"country\": \"BR\"\n\t\t}\n\t},\n\t\"card\": {\n\t\t\"id\": 147,\n\t\t\"brand\": \"visa\",\n\t\t\"holderName\": \"GABRYEL FERREIRA\",\n\t\t\"lastDigits\": \"1111\",\n\t\t\"expirationMonth\": 3,\n\t\t\"expirationYear\": 2028,\n\t\t\"reusable\": true,\n\t\t\"createdAt\": \"2022-07-17T18:08:11.000Z\"\n\t},\n\t\"boleto\": null,\n\t\"pix\": null,\n\t\"shipping\": null,\n\t\"refusedReason\": null,\n\t\"items\": [\n\t\t{\n\t\t\t\"externalRef\": null,\n\t\t\t\"title\": \"b456\",\n\t\t\t\"unitPrice\": 100,\n\t\t\t\"quantity\": 1,\n\t\t\t\"tangible\": false\n\t\t}\n\t],\n\t\"splits\": [\n\t\t{\n\t\t\t\"recipientId\": 1,\n\t\t\t\"amount\": 10000,\n\t\t\t\"netAmount\": 9400\n\t\t}\n\t],\n\t\"refunds\": [],\n\t\"delivery\": null,\n\t\"fee\": {\n\t\t\"fixedAmount\": 200,\n\t\t\"spreadPercentage\": 4,\n\t\t\"estimatedFee\": 600,\n\t\t\"netAmount\": 9400\n\t}\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":282,"default":0},"amount":{"type":"integer","example":10000,"default":0},"refundedAmount":{"type":"integer","example":0,"default":0},"companyId":{"type":"integer","example":2,"default":0},"installments":{"type":"integer","example":12,"default":0},"paymentMethod":{"type":"string","example":"credit_card"},"status":{"type":"string","example":"paid"},"postbackUrl":{},"metadata":{},"traceable":{"type":"boolean","example":false,"default":true},"secureId":{"type":"string","example":"a4594817-be48-4a23-81aa-4bb01f95fe78"},"secureUrl":{"type":"string","example":"https://link.compra.com.br/pagar/a4594817-be48-4a23-81aa-4bb01f95fe78"},"createdAt":{"type":"string","example":"2022-07-18T09:54:22.000Z"},"updatedAt":{"type":"string","example":"2022-07-18T09:54:22.000Z"},"paidAt":{"type":"string","example":"2022-07-18T09:54:22.000Z"},"ip":{},"externalRef":{},"customer":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"externalRef":{},"name":{"type":"string","example":"Gabryel"},"email":{"type":"string","example":"gabryel@hotmail.com"},"phone":{"type":"string","example":"11999999999"},"birthdate":{},"createdAt":{"type":"string","example":"2022-05-26T19:17:48.000Z"},"document":{"type":"object","properties":{"number":{"type":"string","example":"12345678910"},"type":{"type":"string","example":"cpf"}}},"address":{"type":"object","properties":{"street":{"type":"string","example":"Rua República Argentina"},"streetNumber":{"type":"string","example":"4214"},"complement":{},"zipCode":{"type":"string","example":"11065030"},"neighborhood":{"type":"string","example":"Pompéia"},"city":{"type":"string","example":"Santos"},"state":{"type":"string","example":"SP"},"country":{"type":"string","example":"BR"}}}}},"card":{"type":"object","properties":{"id":{"type":"integer","example":147,"default":0},"brand":{"type":"string","example":"visa"},"holderName":{"type":"string","example":"GABRYEL FERREIRA"},"lastDigits":{"type":"string","example":"1111"},"expirationMonth":{"type":"integer","example":3,"default":0},"expirationYear":{"type":"integer","example":2028,"default":0},"reusable":{"type":"boolean","example":true,"default":true},"createdAt":{"type":"string","example":"2022-07-17T18:08:11.000Z"}}},"boleto":{},"pix":{},"shipping":{},"refusedReason":{},"items":{"type":"array","items":{"type":"object","properties":{"externalRef":{},"title":{"type":"string","example":"b456"},"unitPrice":{"type":"integer","example":100,"default":0},"quantity":{"type":"integer","example":1,"default":0},"tangible":{"type":"boolean","example":false,"default":true}}}},"splits":{"type":"array","items":{"type":"object","properties":{"recipientId":{"type":"integer","example":1,"default":0},"amount":{"type":"integer","example":10000,"default":0},"netAmount":{"type":"integer","example":9400,"default":0}}}},"refunds":{"type":"array","items":{"type":"object","properties":{}}},"delivery":{},"fee":{"type":"object","properties":{"fixedAmount":{"type":"integer","example":200,"default":0},"spreadPercentage":{"type":"integer","example":4,"default":0},"estimatedFee":{"type":"integer","example":600,"default":0},"netAmount":{"type":"integer","example":9400,"default":0}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/transactions/{id}/delivery":{"put":{"summary":"Alterar status de entrega","description":"","operationId":"alterar-status-de-entrega","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["status"],"properties":{"status":{"type":"string","description":"Status de entrega. Valores possíveis: **waiting, in_transit, delivered.**"},"trackingCode":{"type":"string","description":"Código de rastreio."}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n\t\"id\": 282,\n\t\"amount\": 10000,\n\t\"refundedAmount\": 0,\n\t\"companyId\": 2,\n\t\"installments\": 12,\n\t\"paymentMethod\": \"credit_card\",\n\t\"status\": \"paid\",\n\t\"postbackUrl\": null,\n\t\"metadata\": null,\n\t\"traceable\": false,\n\t\"secureId\": \"a4594817-be48-4a23-81aa-4bb01f95fe78\",\n\t\"secureUrl\": \"https://link.compra.com.br/pagar/a4594817-be48-4a23-81aa-4bb01f95fe78\",\n\t\"createdAt\": \"2022-07-18T09:54:22.000Z\",\n\t\"updatedAt\": \"2022-07-18T09:54:22.000Z\",\n\t\"paidAt\": \"2022-07-18T09:54:22.000Z\",\n\t\"ip\": null,\n\t\"externalRef\": null,\n\t\"customer\": {\n\t\t\"id\": 1,\n\t\t\"externalRef\": null,\n\t\t\"name\": \"Gabryel\",\n\t\t\"email\": \"gabryel@hotmail.com\",\n\t\t\"phone\": \"11999999999\",\n\t\t\"birthdate\": null,\n\t\t\"createdAt\": \"2022-05-26T19:17:48.000Z\",\n\t\t\"document\": {\n\t\t\t\"number\": \"12345678910\",\n\t\t\t\"type\": \"cpf\"\n\t\t},\n\t\t\"address\": {\n\t\t\t\"street\": \"Rua República Argentina\",\n\t\t\t\"streetNumber\": \"4214\",\n\t\t\t\"complement\": null,\n\t\t\t\"zipCode\": \"11065030\",\n\t\t\t\"neighborhood\": \"Pompéia\",\n\t\t\t\"city\": \"Santos\",\n\t\t\t\"state\": \"SP\",\n\t\t\t\"country\": \"BR\"\n\t\t}\n\t},\n\t\"card\": {\n\t\t\"id\": 147,\n\t\t\"brand\": \"visa\",\n\t\t\"holderName\": \"GABRYEL FERREIRA\",\n\t\t\"lastDigits\": \"1111\",\n\t\t\"expirationMonth\": 3,\n\t\t\"expirationYear\": 2028,\n\t\t\"reusable\": true,\n\t\t\"createdAt\": \"2022-07-17T18:08:11.000Z\"\n\t},\n\t\"boleto\": null,\n\t\"pix\": null,\n\t\"shipping\": null,\n\t\"refusedReason\": null,\n\t\"items\": [\n\t\t{\n\t\t\t\"externalRef\": null,\n\t\t\t\"title\": \"b456\",\n\t\t\t\"unitPrice\": 100,\n\t\t\t\"quantity\": 1,\n\t\t\t\"tangible\": false\n\t\t}\n\t],\n\t\"splits\": [\n\t\t{\n\t\t\t\"recipientId\": 1,\n\t\t\t\"amount\": 10000,\n\t\t\t\"netAmount\": 9400\n\t\t}\n\t],\n\t\"refunds\": [],\n\t\"delivery\": null,\n\t\"fee\": {\n\t\t\"fixedAmount\": 200,\n\t\t\"spreadPercentage\": 4,\n\t\t\"estimatedFee\": 600,\n\t\t\"netAmount\": 9400\n\t}\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":282,"default":0},"amount":{"type":"integer","example":10000,"default":0},"refundedAmount":{"type":"integer","example":0,"default":0},"companyId":{"type":"integer","example":2,"default":0},"installments":{"type":"integer","example":12,"default":0},"paymentMethod":{"type":"string","example":"credit_card"},"status":{"type":"string","example":"paid"},"postbackUrl":{},"metadata":{},"traceable":{"type":"boolean","example":false,"default":true},"secureId":{"type":"string","example":"a4594817-be48-4a23-81aa-4bb01f95fe78"},"secureUrl":{"type":"string","example":"https://link.compra.com.br/pagar/a4594817-be48-4a23-81aa-4bb01f95fe78"},"createdAt":{"type":"string","example":"2022-07-18T09:54:22.000Z"},"updatedAt":{"type":"string","example":"2022-07-18T09:54:22.000Z"},"paidAt":{"type":"string","example":"2022-07-18T09:54:22.000Z"},"ip":{},"externalRef":{},"customer":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"externalRef":{},"name":{"type":"string","example":"Gabryel"},"email":{"type":"string","example":"gabryel@hotmail.com"},"phone":{"type":"string","example":"11999999999"},"birthdate":{},"createdAt":{"type":"string","example":"2022-05-26T19:17:48.000Z"},"document":{"type":"object","properties":{"number":{"type":"string","example":"12345678910"},"type":{"type":"string","example":"cpf"}}},"address":{"type":"object","properties":{"street":{"type":"string","example":"Rua República Argentina"},"streetNumber":{"type":"string","example":"4214"},"complement":{},"zipCode":{"type":"string","example":"11065030"},"neighborhood":{"type":"string","example":"Pompéia"},"city":{"type":"string","example":"Santos"},"state":{"type":"string","example":"SP"},"country":{"type":"string","example":"BR"}}}}},"card":{"type":"object","properties":{"id":{"type":"integer","example":147,"default":0},"brand":{"type":"string","example":"visa"},"holderName":{"type":"string","example":"GABRYEL FERREIRA"},"lastDigits":{"type":"string","example":"1111"},"expirationMonth":{"type":"integer","example":3,"default":0},"expirationYear":{"type":"integer","example":2028,"default":0},"reusable":{"type":"boolean","example":true,"default":true},"createdAt":{"type":"string","example":"2022-07-17T18:08:11.000Z"}}},"boleto":{},"pix":{},"shipping":{},"refusedReason":{},"items":{"type":"array","items":{"type":"object","properties":{"externalRef":{},"title":{"type":"string","example":"b456"},"unitPrice":{"type":"integer","example":100,"default":0},"quantity":{"type":"integer","example":1,"default":0},"tangible":{"type":"boolean","example":false,"default":true}}}},"splits":{"type":"array","items":{"type":"object","properties":{"recipientId":{"type":"integer","example":1,"default":0},"amount":{"type":"integer","example":10000,"default":0},"netAmount":{"type":"integer","example":9400,"default":0}}}},"refunds":{"type":"array","items":{"type":"object","properties":{}}},"delivery":{},"fee":{"type":"object","properties":{"fixedAmount":{"type":"integer","example":200,"default":0},"spreadPercentage":{"type":"integer","example":4,"default":0},"estimatedFee":{"type":"integer","example":600,"default":0},"netAmount":{"type":"integer","example":9400,"default":0}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/customers":{"post":{"summary":"Criar cliente","description":"Para operações de cliente, use a rota /customers.","operationId":"criar-cliente","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","email","document"],"properties":{"name":{"type":"string","description":"Nome do cliente."},"email":{"type":"string","description":"E-mail do cliente."},"document":{"type":"object","description":"Documento do cliente.","required":["number","type"],"properties":{"number":{"type":"string","description":"Número do documento."},"type":{"type":"string","description":"Tipo do documento. Valores possíveis: cpf, cnpj"}}},"phone":{"type":"string","description":"Telefone do cliente."},"externalRef":{"type":"string","description":"Referência do cliente em sua API."},"address":{"type":"object","description":"Endereço do cliente.","required":["street","streetNumber","zipCode","neighborhood","city","state","country"],"properties":{"street":{"type":"string","description":"Rua"},"streetNumber":{"type":"string","description":"Número"},"complement":{"type":"string","description":"Complemento"},"zipCode":{"type":"string","description":"CEP"},"neighborhood":{"type":"string","description":"Bairro"},"city":{"type":"string","description":"Cidade"},"state":{"type":"string","description":"Estado (2 dígitos em letra maiúscula, exemplo: **SP**)"},"country":{"type":"string","description":"País (2 dígitos, exemplo: **br**)"}}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"id\": 23,\n    \"externalRef\": null,\n    \"name\": \"Bruce Wayne\",\n    \"email\": \"atendimento@peterparker.com\",\n    \"phone\": null,\n    \"createdAt\": \"2021-09-19T04:05:55.000Z\",\n    \"document\": {\n        \"id\": 3,\n        \"number\": \"11111111111\",\n        \"type\": \"cpf\"\n    },\n    \"address\": {\n        \"id\": 99,\n        \"street\": \"Avenida Paulista\",\n        \"streetNumber\": \"807\",\n        \"complement\": null,\n        \"zipCode\": \"01311941\",\n        \"neighborhood\": \"Bela Vista\",\n        \"city\": \"São Paulo\",\n        \"state\": \"SP\",\n        \"country\": \"br\"\n    },\n    \"revenue\": {\n        \"totalAmount\": 990,\n        \"totalCount\": 1,\n        \"cardAmount\": 990,\n        \"cardCount\": 1,\n        \"pixAmount\": 0,\n        \"pixCount\": 0,\n        \"boletoAmount\": 0,\n        \"boletoCount\": 0,\n        \"chargebackAmount\": 0,\n        \"chargebackCount\": 0,\n        \"refundAmount\": 0,\n        \"refundCount\": 0,\n        \"createdAt\": \"2021-09-19T04:05:55.000Z\"\n    }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":23,"default":0},"externalRef":{},"name":{"type":"string","example":"Bruce Wayne"},"email":{"type":"string","example":"atendimento@peterparker.com"},"phone":{},"createdAt":{"type":"string","example":"2021-09-19T04:05:55.000Z"},"document":{"type":"object","properties":{"id":{"type":"integer","example":3,"default":0},"number":{"type":"string","example":"11111111111"},"type":{"type":"string","example":"cpf"}}},"address":{"type":"object","properties":{"id":{"type":"integer","example":99,"default":0},"street":{"type":"string","example":"Avenida Paulista"},"streetNumber":{"type":"string","example":"807"},"complement":{},"zipCode":{"type":"string","example":"01311941"},"neighborhood":{"type":"string","example":"Bela Vista"},"city":{"type":"string","example":"São Paulo"},"state":{"type":"string","example":"SP"},"country":{"type":"string","example":"br"}}},"revenue":{"type":"object","properties":{"totalAmount":{"type":"integer","example":990,"default":0},"totalCount":{"type":"integer","example":1,"default":0},"cardAmount":{"type":"integer","example":990,"default":0},"cardCount":{"type":"integer","example":1,"default":0},"pixAmount":{"type":"integer","example":0,"default":0},"pixCount":{"type":"integer","example":0,"default":0},"boletoAmount":{"type":"integer","example":0,"default":0},"boletoCount":{"type":"integer","example":0,"default":0},"chargebackAmount":{"type":"integer","example":0,"default":0},"chargebackCount":{"type":"integer","example":0,"default":0},"refundAmount":{"type":"integer","example":0,"default":0},"refundCount":{"type":"integer","example":0,"default":0},"createdAt":{"type":"string","example":"2021-09-19T04:05:55.000Z"}}}}}}}}},"deprecated":false},"get":{"summary":"Listar clientes","description":"","operationId":"listar-clientes","responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"[\n    {\n        \"id\": 23,\n        \"externalRef\": null,\n        \"name\": \"Bruce Wayne\",\n        \"email\": \"atendimento@peterparker.com\",\n        \"phone\": null,\n        \"createdAt\": \"2021-09-19T04:05:55.000Z\",\n        \"revenue\": {\n            \"totalAmount\": 990,\n            \"totalCount\": 1,\n            \"cardAmount\": 990,\n            \"cardCount\": 1,\n            \"pixAmount\": 0,\n            \"pixCount\": 0,\n            \"boletoAmount\": 0,\n            \"boletoCount\": 0,\n            \"chargebackAmount\": 0,\n            \"chargebackCount\": 0,\n            \"refundAmount\": 0,\n            \"refundCount\": 0,\n            \"createdAt\": \"2021-09-19T04:05:55.000Z\"\n        }\n    }\n]"}},"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":23,"default":0},"externalRef":{},"name":{"type":"string","example":"Bruce Wayne"},"email":{"type":"string","example":"atendimento@peterparker.com"},"phone":{},"createdAt":{"type":"string","example":"2021-09-19T04:05:55.000Z"},"revenue":{"type":"object","properties":{"totalAmount":{"type":"integer","example":990,"default":0},"totalCount":{"type":"integer","example":1,"default":0},"cardAmount":{"type":"integer","example":990,"default":0},"cardCount":{"type":"integer","example":1,"default":0},"pixAmount":{"type":"integer","example":0,"default":0},"pixCount":{"type":"integer","example":0,"default":0},"boletoAmount":{"type":"integer","example":0,"default":0},"boletoCount":{"type":"integer","example":0,"default":0},"chargebackAmount":{"type":"integer","example":0,"default":0},"chargebackCount":{"type":"integer","example":0,"default":0},"refundAmount":{"type":"integer","example":0,"default":0},"refundCount":{"type":"integer","example":0,"default":0},"createdAt":{"type":"string","example":"2021-09-19T04:05:55.000Z"}}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/customers/{id}":{"get":{"summary":"Buscar cliente","description":"","operationId":"buscar-cliente","parameters":[{"name":"id","in":"path","description":"ID do cliente.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"id\": 23,\n    \"externalRef\": null,\n    \"name\": \"Bruce Wayne\",\n    \"email\": \"atendimento@peterparker.com\",\n    \"phone\": null,\n    \"createdAt\": \"2021-09-19T04:05:55.000Z\",\n    \"document\": {\n        \"id\": 3,\n        \"number\": \"11111111111\",\n        \"type\": \"cpf\"\n    },\n    \"address\": {\n        \"id\": 99,\n        \"street\": \"Avenida Paulista\",\n        \"streetNumber\": \"807\",\n        \"complement\": null,\n        \"zipCode\": \"01311941\",\n        \"neighborhood\": \"Bela Vista\",\n        \"city\": \"São Paulo\",\n        \"state\": \"SP\",\n        \"country\": \"br\"\n    },\n    \"revenue\": {\n        \"totalAmount\": 990,\n        \"totalCount\": 1,\n        \"cardAmount\": 990,\n        \"cardCount\": 1,\n        \"pixAmount\": 0,\n        \"pixCount\": 0,\n        \"boletoAmount\": 0,\n        \"boletoCount\": 0,\n        \"chargebackAmount\": 0,\n        \"chargebackCount\": 0,\n        \"refundAmount\": 0,\n        \"refundCount\": 0,\n        \"createdAt\": \"2021-09-19T04:05:55.000Z\"\n    }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":23,"default":0},"externalRef":{},"name":{"type":"string","example":"Bruce Wayne"},"email":{"type":"string","example":"atendimento@peterparker.com"},"phone":{},"createdAt":{"type":"string","example":"2021-09-19T04:05:55.000Z"},"document":{"type":"object","properties":{"id":{"type":"integer","example":3,"default":0},"number":{"type":"string","example":"11111111111"},"type":{"type":"string","example":"cpf"}}},"address":{"type":"object","properties":{"id":{"type":"integer","example":99,"default":0},"street":{"type":"string","example":"Avenida Paulista"},"streetNumber":{"type":"string","example":"807"},"complement":{},"zipCode":{"type":"string","example":"01311941"},"neighborhood":{"type":"string","example":"Bela Vista"},"city":{"type":"string","example":"São Paulo"},"state":{"type":"string","example":"SP"},"country":{"type":"string","example":"br"}}},"revenue":{"type":"object","properties":{"totalAmount":{"type":"integer","example":990,"default":0},"totalCount":{"type":"integer","example":1,"default":0},"cardAmount":{"type":"integer","example":990,"default":0},"cardCount":{"type":"integer","example":1,"default":0},"pixAmount":{"type":"integer","example":0,"default":0},"pixCount":{"type":"integer","example":0,"default":0},"boletoAmount":{"type":"integer","example":0,"default":0},"boletoCount":{"type":"integer","example":0,"default":0},"chargebackAmount":{"type":"integer","example":0,"default":0},"chargebackCount":{"type":"integer","example":0,"default":0},"refundAmount":{"type":"integer","example":0,"default":0},"refundCount":{"type":"integer","example":0,"default":0},"createdAt":{"type":"string","example":"2021-09-19T04:05:55.000Z"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/company":{"get":{"summary":"Dados da empresa","description":"Para operações da empresa, use a rota /company.","operationId":"dados-da-empresa","responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"id\": 2,\n    \"userId\": 1,\n    \"legalName\": \"Gabryel Ferreira\",\n    \"blocked\": false,\n    \"invoiceDescriptor\": \"Gabryel\",\n    \"commercialName\": null,\n    \"createdAt\": \"2022-05-26T19:06:35.000Z\",\n    \"uploadedDocuments\": false,\n    \"user\": {\n        \"id\": 1,\n        \"email\": \"gabryel.ferreira@hotmail.com\",\n        \"phone\": \"11999999999\",\n        \"name\": \"Gabryel\",\n        \"isEmailVerified\": true,\n        \"isPhoneVerified\": false,\n        \"isAdmin\": true,\n        \"isMaster\": true,\n        \"createdAt\": \"2022-05-26T19:03:23.000Z\"\n    },\n    \"document\": {\n        \"id\": 3,\n        \"number\": \"12345678910\",\n        \"type\": \"cpf\"\n    },\n    \"permissions\": {\n        \"id\": 1,\n        \"companyId\": 2,\n        \"isCreditCardAvailable\": true,\n        \"isBoletoAvailable\": true,\n        \"isPixAvailable\": true,\n        \"transferEnabled\": true,\n        \"transferPriceCents\": 200,\n        \"anticipationEnabled\": true,\n        \"anticipatableVolumePercentage\": 100,\n        \"anticipationPricePercent\": 2,\n        \"minAnticipatableDays\": 2,\n        \"createdAt\": \"2022-05-26T19:06:35.000Z\"\n    },\n    \"details\": {\n        \"id\": 1,\n        \"averageRevenue\": 5000,\n        \"averageTicket\": 500,\n        \"physicalProducts\": true,\n        \"productsDescription\": \"Produtos fera\",\n        \"siteUrl\": \"www.fera.com\",\n        \"phone\": \"11999999999\",\n        \"email\": \"gabryel.ferreira@hotmail.com\",\n        \"createdAt\": \"2022-05-26T19:06:35.000Z\"\n    },\n    \"legalRepresentative\": {\n        \"id\": 1,\n        \"name\": \"Gabryel Ferreira\",\n        \"phone\": \"11999999999\",\n        \"motherName\": \"Ana Paula do Nascimento\",\n        \"birthdate\": \"1998-07-03\",\n        \"createdAt\": \"2022-05-26T19:06:35.000Z\",\n        \"document\": {\n            \"id\": 4,\n            \"number\": \"12345678910\",\n            \"type\": \"cpf\"\n        }\n    },\n    \"socialContract\": null,\n    \"partnerDocument\": null,\n    \"address\": {\n        \"id\": 2,\n        \"street\": \"Avenida Presidente Wilson\",\n        \"streetNumber\": \"42\",\n        \"complement\": null,\n        \"zipCode\": \"11065200\",\n        \"neighborhood\": \"Gonzaga\",\n        \"city\": \"Santos\",\n        \"state\": \"SP\",\n        \"country\": \"br\"\n    },\n    \"revenue\": {\n        \"totalAmount\": 133501,\n        \"totalCount\": 20,\n        \"cardAmount\": 103501,\n        \"cardCount\": 17,\n        \"pixAmount\": 30000,\n        \"pixCount\": 3,\n        \"boletoAmount\": 0,\n        \"boletoCount\": 0,\n        \"chargebackAmount\": 0,\n        \"chargebackCount\": 0,\n        \"refundAmount\": 66979,\n        \"refundCount\": 11,\n        \"createdAt\": \"2022-05-26T19:06:35.000Z\"\n    },\n    \"defaultRecipient\": {\n        \"id\": 1,\n        \"legalName\": \"Gabryel Ferreira\",\n        \"createdAt\": \"2022-05-26T19:06:35.000Z\",\n        \"document\": {\n            \"id\": 5,\n            \"number\": \"12345678910\",\n            \"type\": \"cpf\"\n        },\n        \"transferSettings\": {\n            \"id\": 1,\n            \"transferEnabled\": true,\n            \"automaticAnticipationEnabled\": true,\n            \"anticipatableVolumePercentage\": 100,\n            \"createdAt\": \"2022-05-26T19:06:35.000Z\"\n        },\n        \"balance\": {\n            \"available\": 6470,\n            \"updatedAt\": \"2022-06-02T01:37:48.000Z\"\n        }\n    }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":2,"default":0},"userId":{"type":"integer","example":1,"default":0},"legalName":{"type":"string","example":"Gabryel Ferreira"},"blocked":{"type":"boolean","example":false,"default":true},"invoiceDescriptor":{"type":"string","example":"Gabryel"},"commercialName":{},"createdAt":{"type":"string","example":"2022-05-26T19:06:35.000Z"},"uploadedDocuments":{"type":"boolean","example":false,"default":true},"user":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"email":{"type":"string","example":"gabryel.ferreira@hotmail.com"},"phone":{"type":"string","example":"11999999999"},"name":{"type":"string","example":"Gabryel"},"isEmailVerified":{"type":"boolean","example":true,"default":true},"isPhoneVerified":{"type":"boolean","example":false,"default":true},"isAdmin":{"type":"boolean","example":true,"default":true},"isMaster":{"type":"boolean","example":true,"default":true},"createdAt":{"type":"string","example":"2022-05-26T19:03:23.000Z"}}},"document":{"type":"object","properties":{"id":{"type":"integer","example":3,"default":0},"number":{"type":"string","example":"12345678910"},"type":{"type":"string","example":"cpf"}}},"permissions":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"companyId":{"type":"integer","example":2,"default":0},"isCreditCardAvailable":{"type":"boolean","example":true,"default":true},"isBoletoAvailable":{"type":"boolean","example":true,"default":true},"isPixAvailable":{"type":"boolean","example":true,"default":true},"transferEnabled":{"type":"boolean","example":true,"default":true},"transferPriceCents":{"type":"integer","example":200,"default":0},"anticipationEnabled":{"type":"boolean","example":true,"default":true},"anticipatableVolumePercentage":{"type":"integer","example":100,"default":0},"anticipationPricePercent":{"type":"integer","example":2,"default":0},"minAnticipatableDays":{"type":"integer","example":2,"default":0},"createdAt":{"type":"string","example":"2022-05-26T19:06:35.000Z"}}},"details":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"averageRevenue":{"type":"integer","example":5000,"default":0},"averageTicket":{"type":"integer","example":500,"default":0},"physicalProducts":{"type":"boolean","example":true,"default":true},"productsDescription":{"type":"string","example":"Produtos fera"},"siteUrl":{"type":"string","example":"www.fera.com"},"phone":{"type":"string","example":"11999999999"},"email":{"type":"string","example":"gabryel.ferreira@hotmail.com"},"createdAt":{"type":"string","example":"2022-05-26T19:06:35.000Z"}}},"legalRepresentative":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"name":{"type":"string","example":"Gabryel Ferreira"},"phone":{"type":"string","example":"11999999999"},"motherName":{"type":"string","example":"Ana Paula do Nascimento"},"birthdate":{"type":"string","example":"1998-07-03"},"createdAt":{"type":"string","example":"2022-05-26T19:06:35.000Z"},"document":{"type":"object","properties":{"id":{"type":"integer","example":4,"default":0},"number":{"type":"string","example":"12345678910"},"type":{"type":"string","example":"cpf"}}}}},"socialContract":{},"partnerDocument":{},"address":{"type":"object","properties":{"id":{"type":"integer","example":2,"default":0},"street":{"type":"string","example":"Avenida Presidente Wilson"},"streetNumber":{"type":"string","example":"42"},"complement":{},"zipCode":{"type":"string","example":"11065200"},"neighborhood":{"type":"string","example":"Gonzaga"},"city":{"type":"string","example":"Santos"},"state":{"type":"string","example":"SP"},"country":{"type":"string","example":"br"}}},"revenue":{"type":"object","properties":{"totalAmount":{"type":"integer","example":133501,"default":0},"totalCount":{"type":"integer","example":20,"default":0},"cardAmount":{"type":"integer","example":103501,"default":0},"cardCount":{"type":"integer","example":17,"default":0},"pixAmount":{"type":"integer","example":30000,"default":0},"pixCount":{"type":"integer","example":3,"default":0},"boletoAmount":{"type":"integer","example":0,"default":0},"boletoCount":{"type":"integer","example":0,"default":0},"chargebackAmount":{"type":"integer","example":0,"default":0},"chargebackCount":{"type":"integer","example":0,"default":0},"refundAmount":{"type":"integer","example":66979,"default":0},"refundCount":{"type":"integer","example":11,"default":0},"createdAt":{"type":"string","example":"2022-05-26T19:06:35.000Z"}}},"defaultRecipient":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"legalName":{"type":"string","example":"Gabryel Ferreira"},"createdAt":{"type":"string","example":"2022-05-26T19:06:35.000Z"},"document":{"type":"object","properties":{"id":{"type":"integer","example":5,"default":0},"number":{"type":"string","example":"12345678910"},"type":{"type":"string","example":"cpf"}}},"transferSettings":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"transferEnabled":{"type":"boolean","example":true,"default":true},"automaticAnticipationEnabled":{"type":"boolean","example":true,"default":true},"anticipatableVolumePercentage":{"type":"integer","example":100,"default":0},"createdAt":{"type":"string","example":"2022-05-26T19:06:35.000Z"}}},"balance":{"type":"object","properties":{"available":{"type":"integer","example":6470,"default":0},"updatedAt":{"type":"string","example":"2022-06-02T01:37:48.000Z"}}}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"put":{"summary":"Atualizar dados da empresa","description":"","operationId":"atualizar-dados-da-empresa","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["invoiceDescriptor","details"],"properties":{"invoiceDescriptor":{"type":"string","description":"Nome na fatura."},"details":{"type":"object","description":"Detalhes da empresa e operação.","required":["averageRevenue","averageTicket","physicalProducts","productsDescription","siteUrl","phone","email"],"properties":{"averageRevenue":{"type":"number","description":"Faturamento médio por mês.","format":"float"},"averageTicket":{"type":"number","description":"Ticket médio.","format":"float"},"physicalProducts":{"type":"boolean","description":"A empresa vende produtos físicos?","default":true},"productsDescription":{"type":"string","description":"Produtos vendidos pela empresa."},"siteUrl":{"type":"string","description":"Site da empresa."},"phone":{"type":"string","description":"Telefone para contato."},"email":{"type":"string","description":"E-mail para contato."}}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"id\": 2,\n    \"userId\": 1,\n    \"legalName\": \"Gabryel Ferreira\",\n    \"blocked\": false,\n    \"invoiceDescriptor\": \"Gabryel\",\n    \"commercialName\": null,\n    \"createdAt\": \"2022-05-26T19:06:35.000Z\",\n    \"uploadedDocuments\": false,\n    \"user\": {\n        \"id\": 1,\n        \"email\": \"gabryel.ferreira@hotmail.com\",\n        \"phone\": \"11999999999\",\n        \"name\": \"Gabryel\",\n        \"isEmailVerified\": true,\n        \"isPhoneVerified\": false,\n        \"isAdmin\": true,\n        \"isMaster\": true,\n        \"createdAt\": \"2022-05-26T19:03:23.000Z\"\n    },\n    \"document\": {\n        \"id\": 3,\n        \"number\": \"12345678910\",\n        \"type\": \"cpf\"\n    },\n    \"permissions\": {\n        \"id\": 1,\n        \"companyId\": 2,\n        \"isCreditCardAvailable\": true,\n        \"isBoletoAvailable\": true,\n        \"isPixAvailable\": true,\n        \"transferEnabled\": true,\n        \"transferPriceCents\": 200,\n        \"anticipationEnabled\": true,\n        \"anticipatableVolumePercentage\": 100,\n        \"anticipationPricePercent\": 2,\n        \"minAnticipatableDays\": 2,\n        \"createdAt\": \"2022-05-26T19:06:35.000Z\"\n    },\n    \"details\": {\n        \"id\": 1,\n        \"averageRevenue\": 5000,\n        \"averageTicket\": 500,\n        \"physicalProducts\": true,\n        \"productsDescription\": \"Produtos fera\",\n        \"siteUrl\": \"www.fera.com\",\n        \"phone\": \"11999999999\",\n        \"email\": \"gabryel.ferreira@hotmail.com\",\n        \"createdAt\": \"2022-05-26T19:06:35.000Z\"\n    },\n    \"legalRepresentative\": {\n        \"id\": 1,\n        \"name\": \"Gabryel Ferreira\",\n        \"phone\": \"11999999999\",\n        \"motherName\": \"Ana Paula do Nascimento\",\n        \"birthdate\": \"1998-07-03\",\n        \"createdAt\": \"2022-05-26T19:06:35.000Z\",\n        \"document\": {\n            \"id\": 4,\n            \"number\": \"12345678910\",\n            \"type\": \"cpf\"\n        }\n    },\n    \"socialContract\": null,\n    \"partnerDocument\": null,\n    \"address\": {\n        \"id\": 2,\n        \"street\": \"Avenida Presidente Wilson\",\n        \"streetNumber\": \"42\",\n        \"complement\": null,\n        \"zipCode\": \"11065200\",\n        \"neighborhood\": \"Gonzaga\",\n        \"city\": \"Santos\",\n        \"state\": \"SP\",\n        \"country\": \"br\"\n    },\n    \"revenue\": {\n        \"totalAmount\": 133501,\n        \"totalCount\": 20,\n        \"cardAmount\": 103501,\n        \"cardCount\": 17,\n        \"pixAmount\": 30000,\n        \"pixCount\": 3,\n        \"boletoAmount\": 0,\n        \"boletoCount\": 0,\n        \"chargebackAmount\": 0,\n        \"chargebackCount\": 0,\n        \"refundAmount\": 66979,\n        \"refundCount\": 11,\n        \"createdAt\": \"2022-05-26T19:06:35.000Z\"\n    },\n    \"defaultRecipient\": {\n        \"id\": 1,\n        \"legalName\": \"Gabryel Ferreira\",\n        \"createdAt\": \"2022-05-26T19:06:35.000Z\",\n        \"document\": {\n            \"id\": 5,\n            \"number\": \"12345678910\",\n            \"type\": \"cpf\"\n        },\n        \"transferSettings\": {\n            \"id\": 1,\n            \"transferEnabled\": true,\n            \"automaticAnticipationEnabled\": true,\n            \"anticipatableVolumePercentage\": 100,\n            \"createdAt\": \"2022-05-26T19:06:35.000Z\"\n        },\n        \"balance\": {\n            \"available\": 6470,\n            \"updatedAt\": \"2022-06-02T01:37:48.000Z\"\n        }\n    }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":2,"default":0},"userId":{"type":"integer","example":1,"default":0},"legalName":{"type":"string","example":"Gabryel Ferreira"},"blocked":{"type":"boolean","example":false,"default":true},"invoiceDescriptor":{"type":"string","example":"Gabryel"},"commercialName":{},"createdAt":{"type":"string","example":"2022-05-26T19:06:35.000Z"},"uploadedDocuments":{"type":"boolean","example":false,"default":true},"user":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"email":{"type":"string","example":"gabryel.ferreira@hotmail.com"},"phone":{"type":"string","example":"11999999999"},"name":{"type":"string","example":"Gabryel"},"isEmailVerified":{"type":"boolean","example":true,"default":true},"isPhoneVerified":{"type":"boolean","example":false,"default":true},"isAdmin":{"type":"boolean","example":true,"default":true},"isMaster":{"type":"boolean","example":true,"default":true},"createdAt":{"type":"string","example":"2022-05-26T19:03:23.000Z"}}},"document":{"type":"object","properties":{"id":{"type":"integer","example":3,"default":0},"number":{"type":"string","example":"12345678910"},"type":{"type":"string","example":"cpf"}}},"permissions":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"companyId":{"type":"integer","example":2,"default":0},"isCreditCardAvailable":{"type":"boolean","example":true,"default":true},"isBoletoAvailable":{"type":"boolean","example":true,"default":true},"isPixAvailable":{"type":"boolean","example":true,"default":true},"transferEnabled":{"type":"boolean","example":true,"default":true},"transferPriceCents":{"type":"integer","example":200,"default":0},"anticipationEnabled":{"type":"boolean","example":true,"default":true},"anticipatableVolumePercentage":{"type":"integer","example":100,"default":0},"anticipationPricePercent":{"type":"integer","example":2,"default":0},"minAnticipatableDays":{"type":"integer","example":2,"default":0},"createdAt":{"type":"string","example":"2022-05-26T19:06:35.000Z"}}},"details":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"averageRevenue":{"type":"integer","example":5000,"default":0},"averageTicket":{"type":"integer","example":500,"default":0},"physicalProducts":{"type":"boolean","example":true,"default":true},"productsDescription":{"type":"string","example":"Produtos fera"},"siteUrl":{"type":"string","example":"www.fera.com"},"phone":{"type":"string","example":"11999999999"},"email":{"type":"string","example":"gabryel.ferreira@hotmail.com"},"createdAt":{"type":"string","example":"2022-05-26T19:06:35.000Z"}}},"legalRepresentative":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"name":{"type":"string","example":"Gabryel Ferreira"},"phone":{"type":"string","example":"11999999999"},"motherName":{"type":"string","example":"Ana Paula do Nascimento"},"birthdate":{"type":"string","example":"1998-07-03"},"createdAt":{"type":"string","example":"2022-05-26T19:06:35.000Z"},"document":{"type":"object","properties":{"id":{"type":"integer","example":4,"default":0},"number":{"type":"string","example":"12345678910"},"type":{"type":"string","example":"cpf"}}}}},"socialContract":{},"partnerDocument":{},"address":{"type":"object","properties":{"id":{"type":"integer","example":2,"default":0},"street":{"type":"string","example":"Avenida Presidente Wilson"},"streetNumber":{"type":"string","example":"42"},"complement":{},"zipCode":{"type":"string","example":"11065200"},"neighborhood":{"type":"string","example":"Gonzaga"},"city":{"type":"string","example":"Santos"},"state":{"type":"string","example":"SP"},"country":{"type":"string","example":"br"}}},"revenue":{"type":"object","properties":{"totalAmount":{"type":"integer","example":133501,"default":0},"totalCount":{"type":"integer","example":20,"default":0},"cardAmount":{"type":"integer","example":103501,"default":0},"cardCount":{"type":"integer","example":17,"default":0},"pixAmount":{"type":"integer","example":30000,"default":0},"pixCount":{"type":"integer","example":3,"default":0},"boletoAmount":{"type":"integer","example":0,"default":0},"boletoCount":{"type":"integer","example":0,"default":0},"chargebackAmount":{"type":"integer","example":0,"default":0},"chargebackCount":{"type":"integer","example":0,"default":0},"refundAmount":{"type":"integer","example":66979,"default":0},"refundCount":{"type":"integer","example":11,"default":0},"createdAt":{"type":"string","example":"2022-05-26T19:06:35.000Z"}}},"defaultRecipient":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"legalName":{"type":"string","example":"Gabryel Ferreira"},"createdAt":{"type":"string","example":"2022-05-26T19:06:35.000Z"},"document":{"type":"object","properties":{"id":{"type":"integer","example":5,"default":0},"number":{"type":"string","example":"12345678910"},"type":{"type":"string","example":"cpf"}}},"transferSettings":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"transferEnabled":{"type":"boolean","example":true,"default":true},"automaticAnticipationEnabled":{"type":"boolean","example":true,"default":true},"anticipatableVolumePercentage":{"type":"integer","example":100,"default":0},"createdAt":{"type":"string","example":"2022-05-26T19:06:35.000Z"}}},"balance":{"type":"object","properties":{"available":{"type":"integer","example":6470,"default":0},"updatedAt":{"type":"string","example":"2022-06-02T01:37:48.000Z"}}}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/balance/available":{"get":{"summary":"Obter saldo disponível","description":"Para operações de saldo, use a rota /balance.","operationId":"obter-saldo","parameters":[{"name":"recipientId","in":"query","description":"ID do recebedor. Caso não seja enviado, será usado o recebedor principal da empresa.","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"amount\": 1000,\n    \"recipientId\": 327\n}"}},"schema":{"type":"object","properties":{"amount":{"type":"integer","example":1000,"default":0},"recipientId":{"type":"integer","example":327,"default":0}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/transactions/{id}/refund":{"post":{"summary":"Estornar transação","description":"","operationId":"estornar-transacao","parameters":[{"name":"id","in":"path","description":"ID da transação.","schema":{"type":"integer","format":"int32"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"amount":{"type":"integer","description":"Valor do estorno. Caso não seja informado, será considerado o valor da transação ou o valor restante para estorno.","format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n\t\"id\": 282,\n\t\"amount\": 10000,\n\t\"refundedAmount\": 0,\n\t\"companyId\": 2,\n\t\"installments\": 12,\n\t\"paymentMethod\": \"credit_card\",\n\t\"status\": \"paid\",\n\t\"postbackUrl\": null,\n\t\"metadata\": null,\n\t\"traceable\": false,\n\t\"secureId\": \"a4594817-be48-4a23-81aa-4bb01f95fe78\",\n\t\"secureUrl\": \"https://link.compra.com.br/pagar/a4594817-be48-4a23-81aa-4bb01f95fe78\",\n\t\"createdAt\": \"2022-07-18T09:54:22.000Z\",\n\t\"updatedAt\": \"2022-07-18T09:54:22.000Z\",\n\t\"paidAt\": \"2022-07-18T09:54:22.000Z\",\n\t\"ip\": null,\n\t\"externalRef\": null,\n\t\"customer\": {\n\t\t\"id\": 1,\n\t\t\"externalRef\": null,\n\t\t\"name\": \"Gabryel\",\n\t\t\"email\": \"gabryel@hotmail.com\",\n\t\t\"phone\": \"11999999999\",\n\t\t\"birthdate\": null,\n\t\t\"createdAt\": \"2022-05-26T19:17:48.000Z\",\n\t\t\"document\": {\n\t\t\t\"number\": \"12345678910\",\n\t\t\t\"type\": \"cpf\"\n\t\t},\n\t\t\"address\": {\n\t\t\t\"street\": \"Rua República Argentina\",\n\t\t\t\"streetNumber\": \"4214\",\n\t\t\t\"complement\": null,\n\t\t\t\"zipCode\": \"11065030\",\n\t\t\t\"neighborhood\": \"Pompéia\",\n\t\t\t\"city\": \"Santos\",\n\t\t\t\"state\": \"SP\",\n\t\t\t\"country\": \"BR\"\n\t\t}\n\t},\n\t\"card\": {\n\t\t\"id\": 147,\n\t\t\"brand\": \"visa\",\n\t\t\"holderName\": \"GABRYEL FERREIRA\",\n\t\t\"lastDigits\": \"1111\",\n\t\t\"expirationMonth\": 3,\n\t\t\"expirationYear\": 2028,\n\t\t\"reusable\": true,\n\t\t\"createdAt\": \"2022-07-17T18:08:11.000Z\"\n\t},\n\t\"boleto\": null,\n\t\"pix\": null,\n\t\"shipping\": null,\n\t\"refusedReason\": null,\n\t\"items\": [\n\t\t{\n\t\t\t\"externalRef\": null,\n\t\t\t\"title\": \"b456\",\n\t\t\t\"unitPrice\": 100,\n\t\t\t\"quantity\": 1,\n\t\t\t\"tangible\": false\n\t\t}\n\t],\n\t\"splits\": [\n\t\t{\n\t\t\t\"recipientId\": 1,\n\t\t\t\"amount\": 10000,\n\t\t\t\"netAmount\": 9400\n\t\t}\n\t],\n\t\"refunds\": [],\n\t\"delivery\": null,\n\t\"fee\": {\n\t\t\"fixedAmount\": 200,\n\t\t\"spreadPercentage\": 4,\n\t\t\"estimatedFee\": 600,\n\t\t\"netAmount\": 9400\n\t}\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":282,"default":0},"amount":{"type":"integer","example":10000,"default":0},"refundedAmount":{"type":"integer","example":0,"default":0},"companyId":{"type":"integer","example":2,"default":0},"installments":{"type":"integer","example":12,"default":0},"paymentMethod":{"type":"string","example":"credit_card"},"status":{"type":"string","example":"paid"},"postbackUrl":{},"metadata":{},"traceable":{"type":"boolean","example":false,"default":true},"secureId":{"type":"string","example":"a4594817-be48-4a23-81aa-4bb01f95fe78"},"secureUrl":{"type":"string","example":"https://link.compra.com.br/pagar/a4594817-be48-4a23-81aa-4bb01f95fe78"},"createdAt":{"type":"string","example":"2022-07-18T09:54:22.000Z"},"updatedAt":{"type":"string","example":"2022-07-18T09:54:22.000Z"},"paidAt":{"type":"string","example":"2022-07-18T09:54:22.000Z"},"ip":{},"externalRef":{},"customer":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"externalRef":{},"name":{"type":"string","example":"Gabryel"},"email":{"type":"string","example":"gabryel@hotmail.com"},"phone":{"type":"string","example":"11999999999"},"birthdate":{},"createdAt":{"type":"string","example":"2022-05-26T19:17:48.000Z"},"document":{"type":"object","properties":{"number":{"type":"string","example":"12345678910"},"type":{"type":"string","example":"cpf"}}},"address":{"type":"object","properties":{"street":{"type":"string","example":"Rua República Argentina"},"streetNumber":{"type":"string","example":"4214"},"complement":{},"zipCode":{"type":"string","example":"11065030"},"neighborhood":{"type":"string","example":"Pompéia"},"city":{"type":"string","example":"Santos"},"state":{"type":"string","example":"SP"},"country":{"type":"string","example":"BR"}}}}},"card":{"type":"object","properties":{"id":{"type":"integer","example":147,"default":0},"brand":{"type":"string","example":"visa"},"holderName":{"type":"string","example":"GABRYEL FERREIRA"},"lastDigits":{"type":"string","example":"1111"},"expirationMonth":{"type":"integer","example":3,"default":0},"expirationYear":{"type":"integer","example":2028,"default":0},"reusable":{"type":"boolean","example":true,"default":true},"createdAt":{"type":"string","example":"2022-07-17T18:08:11.000Z"}}},"boleto":{},"pix":{},"shipping":{},"refusedReason":{},"items":{"type":"array","items":{"type":"object","properties":{"externalRef":{},"title":{"type":"string","example":"b456"},"unitPrice":{"type":"integer","example":100,"default":0},"quantity":{"type":"integer","example":1,"default":0},"tangible":{"type":"boolean","example":false,"default":true}}}},"splits":{"type":"array","items":{"type":"object","properties":{"recipientId":{"type":"integer","example":1,"default":0},"amount":{"type":"integer","example":10000,"default":0},"netAmount":{"type":"integer","example":9400,"default":0}}}},"refunds":{"type":"array","items":{"type":"object","properties":{}}},"delivery":{},"fee":{"type":"object","properties":{"fixedAmount":{"type":"integer","example":200,"default":0},"spreadPercentage":{"type":"integer","example":4,"default":0},"estimatedFee":{"type":"integer","example":600,"default":0},"netAmount":{"type":"integer","example":9400,"default":0}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/transfers":{"post":{"summary":"Criar transferência","description":"","operationId":"criar-transferencia","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["amount"],"properties":{"amount":{"type":"integer","description":"Valor da transferência em centavos.","format":"int32"},"postbackUrl":{"type":"string","description":"URL em sua API que receberá atualizações da transferência."},"bankAccount":{"type":"object","description":"Conta bancária. Caso não seja informada, será usada a conta principal do recebedor.","required":["bankCode","agencyNumber","accountNumber","accountDigit","type","legalName","documentNumber","documentType"],"properties":{"bankCode":{"type":"string","description":"Código do banco."},"agencyNumber":{"type":"string","description":"Número da agência."},"accountNumber":{"type":"string","description":"Número da conta."},"accountDigit":{"type":"string","description":"Dígito da conta."},"type":{"type":"string","description":"Tipo da conta. Valores possíveis: **conta_corrente, conta_poupanca.**"},"legalName":{"type":"string","description":"Razão social."},"documentNumber":{"type":"string","description":"CPF/CNPJ da conta bancária. Deve ser o mesmo do recebedor."},"documentType":{"type":"string","description":"Tipo do documento. Valores possíveis: **cpf, cnpj.**"}}},"pixKey":{"type":"string","description":"Chave PIX de destino. Caso não seja informada, será usada a conta bancária principal do recebedor."},"recipientId":{"type":"integer","description":"ID do recebedor. Caso não seja enviado, será utilizado o recebedor primário da empresa.","format":"int32"},"externalRef":{"type":"string","description":"Referência da transferência em sua API."}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"id\": 1068,\n    \"companyId\": 2,\n    \"recipientId\": 1,\n    \"description\": null,\n    \"amount\": 1000,\n    \"fee\": 290,\n    \"status\": \"pending\",\n    \"failReason\": null,\n    \"postbackUrl\": null,\n    \"pixKey\": \"a29d4c00-2bdf-4263-86dd-5d435e3c074d\",\n    \"pixEnd2EndId\": null,\n    \"metadata\": null,\n    \"receiptUrl\": null,\n    \"createdAt\": \"2023-09-06T13:56:37.000Z\",\n    \"updatedAt\": \"2023-09-06T13:56:37.000Z\",\n    \"transferredAt\": null,\n    \"externalRef\": null,\n    \"queueProcess\": true,\n    \"processedAt\": null,\n    \"secureId\": \"33ae7d6b-ddba-403b-bc2b-f27383ccbad9\",\n    \"attempts\": 0,\n    \"nextAttemptAt\": null,\n    \"bankAccount\": null\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":1068,"default":0},"companyId":{"type":"integer","example":2,"default":0},"recipientId":{"type":"integer","example":1,"default":0},"description":{},"amount":{"type":"integer","example":1000,"default":0},"fee":{"type":"integer","example":290,"default":0},"status":{"type":"string","example":"pending"},"failReason":{},"postbackUrl":{},"pixKey":{"type":"string","example":"a29d4c00-2bdf-4263-86dd-5d435e3c074d"},"pixEnd2EndId":{},"metadata":{},"receiptUrl":{},"createdAt":{"type":"string","example":"2023-09-06T13:56:37.000Z"},"updatedAt":{"type":"string","example":"2023-09-06T13:56:37.000Z"},"transferredAt":{},"externalRef":{},"queueProcess":{"type":"boolean","example":true,"default":true},"processedAt":{},"secureId":{"type":"string","example":"33ae7d6b-ddba-403b-bc2b-f27383ccbad9"},"attempts":{"type":"integer","example":0,"default":0},"nextAttemptAt":{},"bankAccount":{}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/transfers/{id}":{"get":{"summary":"Buscar transferência","description":"","operationId":"buscar-transferência","parameters":[{"name":"id","in":"path","description":"ID da transferência.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"id\": 1068,\n    \"companyId\": 2,\n    \"recipientId\": 1,\n    \"description\": null,\n    \"amount\": 1000,\n    \"fee\": 290,\n    \"status\": \"success\",\n    \"failReason\": null,\n    \"postbackUrl\": null,\n    \"pixKey\": \"a29d4c00-2bdf-4263-86dd-5d435e3c074d\",\n    \"pixEnd2EndId\": \"E277287121G6I8886MF02JNCUGGLELRP\",\n    \"metadata\": null,\n    \"receiptUrl\": null,\n    \"createdAt\": \"2023-09-06T13:56:37.000Z\",\n    \"updatedAt\": \"2023-09-06T13:56:37.000Z\",\n    \"transferredAt\": null,\n    \"externalRef\": null,\n    \"queueProcess\": true,\n    \"processedAt\": null,\n    \"secureId\": \"33ae7d6b-ddba-403b-bc2b-f27383ccbad9\",\n    \"attempts\": 0,\n    \"nextAttemptAt\": null,\n    \"bankAccount\": null\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":1068,"default":0},"companyId":{"type":"integer","example":2,"default":0},"recipientId":{"type":"integer","example":1,"default":0},"description":{},"amount":{"type":"integer","example":1000,"default":0},"fee":{"type":"integer","example":290,"default":0},"status":{"type":"string","example":"success"},"failReason":{},"postbackUrl":{},"pixKey":{"type":"string","example":"a29d4c00-2bdf-4263-86dd-5d435e3c074d"},"pixEnd2EndId":{"type":"string","example":"E277287121G6I8886MF02JNCUGGLELRP"},"metadata":{},"receiptUrl":{},"createdAt":{"type":"string","example":"2023-09-06T13:56:37.000Z"},"updatedAt":{"type":"string","example":"2023-09-06T13:56:37.000Z"},"transferredAt":{},"externalRef":{},"queueProcess":{"type":"boolean","example":true,"default":true},"processedAt":{},"secureId":{"type":"string","example":"33ae7d6b-ddba-403b-bc2b-f27383ccbad9"},"attempts":{"type":"integer","example":0,"default":0},"nextAttemptAt":{},"bankAccount":{}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/recipients":{"post":{"summary":"Criar recebedor","description":"","operationId":"criar-recebedor","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["legalName","document","transferSettings","bankAccount"],"properties":{"legalName":{"type":"string","description":"Razão social."},"document":{"type":"object","description":"CPF/CNPJ do recebedor.","required":["number","type"],"properties":{"number":{"type":"string","description":"Número do documento."},"type":{"type":"string","description":"Tipo do documento. Valores possíveis: cpf, cnpj"}}},"transferSettings":{"type":"object","description":"Regras de transferência.","required":["transferEnabled","automaticAnticipationEnabled","anticipatableVolumePercentage"],"properties":{"transferEnabled":{"type":"boolean","description":"Transferência habilitada."},"automaticAnticipationEnabled":{"type":"boolean","description":"Antecipação automática habilitada."},"anticipatableVolumePercentage":{"type":"integer","description":"Volume antecipável.","format":"int32"}}},"bankAccount":{"type":"object","description":"Conta bancária.","required":["bankCode","agencyNumber","accountNumber","accountDigit","type","legalName","documentNumber","documentType"],"properties":{"bankCode":{"type":"string","description":"Código do banco."},"agencyNumber":{"type":"string","description":"Número da agência."},"accountNumber":{"type":"string","description":"Número da conta."},"accountDigit":{"type":"string","description":"Dígito da conta."},"type":{"type":"string","description":"Tipo da conta. Valores possíveis: **conta_corrente, conta_poupanca.**"},"legalName":{"type":"string","description":"Razão social."},"documentNumber":{"type":"string","description":"CPF/CNPJ da conta bancária. Deve ser o mesmo do recebedor."},"documentType":{"type":"string","description":"Tipo do documento. Valores possíveis: **cpf, cnpj.**"}}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"id\": 8,\n    \"legalName\": \"Louis Armstrong\",\n    \"createdAt\": \"2022-06-05T16:31:14.000Z\",\n    \"document\": {\n        \"id\": 26,\n        \"number\": \"12345678910\",\n        \"type\": \"cpf\"\n    },\n    \"transferSettings\": {\n        \"id\": 8,\n        \"transferEnabled\": false,\n        \"automaticAnticipationEnabled\": false,\n        \"anticipatableVolumePercentage\": 100,\n        \"createdAt\": \"2022-06-05T16:31:14.000Z\"\n    }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":8,"default":0},"legalName":{"type":"string","example":"Louis Armstrong"},"createdAt":{"type":"string","example":"2022-06-05T16:31:14.000Z"},"document":{"type":"object","properties":{"id":{"type":"integer","example":26,"default":0},"number":{"type":"string","example":"12345678910"},"type":{"type":"string","example":"cpf"}}},"transferSettings":{"type":"object","properties":{"id":{"type":"integer","example":8,"default":0},"transferEnabled":{"type":"boolean","example":false,"default":true},"automaticAnticipationEnabled":{"type":"boolean","example":false,"default":true},"anticipatableVolumePercentage":{"type":"integer","example":100,"default":0},"createdAt":{"type":"string","example":"2022-06-05T16:31:14.000Z"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"get":{"summary":"Listar recebedores","description":"","operationId":"listar-recebedores","responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"[\n    {\n        \"id\": 8,\n        \"legalName\": \"Louis Armstrong\",\n        \"createdAt\": \"2022-06-05T16:31:14.000Z\",\n        \"document\": {\n            \"id\": 26,\n            \"number\": \"12345678910\",\n            \"type\": \"cpf\"\n        },\n        \"transferSettings\": {\n            \"id\": 8,\n            \"transferEnabled\": false,\n            \"automaticAnticipationEnabled\": false,\n            \"anticipatableVolumePercentage\": 100,\n            \"createdAt\": \"2022-06-05T16:31:14.000Z\"\n        }\n    }\n]"}},"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":8,"default":0},"legalName":{"type":"string","example":"Louis Armstrong"},"createdAt":{"type":"string","example":"2022-06-05T16:31:14.000Z"},"document":{"type":"object","properties":{"id":{"type":"integer","example":26,"default":0},"number":{"type":"string","example":"12345678910"},"type":{"type":"string","example":"cpf"}}},"transferSettings":{"type":"object","properties":{"id":{"type":"integer","example":8,"default":0},"transferEnabled":{"type":"boolean","example":false,"default":true},"automaticAnticipationEnabled":{"type":"boolean","example":false,"default":true},"anticipatableVolumePercentage":{"type":"integer","example":100,"default":0},"createdAt":{"type":"string","example":"2022-06-05T16:31:14.000Z"}}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/recipients/{id}":{"get":{"summary":"Buscar recebedor","description":"","operationId":"buscar-recebedor","parameters":[{"name":"id","in":"path","description":"ID do recebedor.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"id\": 8,\n    \"legalName\": \"Louis Armstrong\",\n    \"createdAt\": \"2022-06-05T16:31:14.000Z\",\n    \"document\": {\n        \"id\": 26,\n        \"number\": \"12345678910\",\n        \"type\": \"cpf\"\n    },\n    \"transferSettings\": {\n        \"id\": 8,\n        \"transferEnabled\": false,\n        \"automaticAnticipationEnabled\": false,\n        \"anticipatableVolumePercentage\": 100,\n        \"createdAt\": \"2022-06-05T16:31:14.000Z\"\n    }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":8,"default":0},"legalName":{"type":"string","example":"Louis Armstrong"},"createdAt":{"type":"string","example":"2022-06-05T16:31:14.000Z"},"document":{"type":"object","properties":{"id":{"type":"integer","example":26,"default":0},"number":{"type":"string","example":"12345678910"},"type":{"type":"string","example":"cpf"}}},"transferSettings":{"type":"object","properties":{"id":{"type":"integer","example":8,"default":0},"transferEnabled":{"type":"boolean","example":false,"default":true},"automaticAnticipationEnabled":{"type":"boolean","example":false,"default":true},"anticipatableVolumePercentage":{"type":"integer","example":100,"default":0},"createdAt":{"type":"string","example":"2022-06-05T16:31:14.000Z"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"put":{"summary":"Atualizar recebedor","description":"","operationId":"atualizar-recebedor","parameters":[{"name":"id","in":"path","description":"ID do recebedor.","schema":{"type":"integer","format":"int32"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["legalName"],"properties":{"legalName":{"type":"string","description":"Razão social."},"transferSettings":{"type":"object","description":"Regras de transferência.","properties":{}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"id\": 8,\n    \"legalName\": \"Louis Armstrong\",\n    \"createdAt\": \"2022-06-05T16:31:14.000Z\",\n    \"document\": {\n        \"id\": 26,\n        \"number\": \"12345678910\",\n        \"type\": \"cpf\"\n    },\n    \"transferSettings\": {\n        \"id\": 8,\n        \"transferEnabled\": false,\n        \"automaticAnticipationEnabled\": false,\n        \"anticipatableVolumePercentage\": 100,\n        \"createdAt\": \"2022-06-05T16:31:14.000Z\"\n    }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":8,"default":0},"legalName":{"type":"string","example":"Louis Armstrong"},"createdAt":{"type":"string","example":"2022-06-05T16:31:14.000Z"},"document":{"type":"object","properties":{"id":{"type":"integer","example":26,"default":0},"number":{"type":"string","example":"12345678910"},"type":{"type":"string","example":"cpf"}}},"transferSettings":{"type":"object","properties":{"id":{"type":"integer","example":8,"default":0},"transferEnabled":{"type":"boolean","example":false,"default":true},"automaticAnticipationEnabled":{"type":"boolean","example":false,"default":true},"anticipatableVolumePercentage":{"type":"integer","example":100,"default":0},"createdAt":{"type":"string","example":"2022-06-05T16:31:14.000Z"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/checkouts":{"post":{"summary":"Criar checkout","description":"Para criar um checkout, informe o valor total, os itens do carrinho e os métodos de pagamento que estarão disponíveis. Após isso, redirecione seu usuário para a **secureUrl** que você receberá como resposta.\n\nAo passar um **postbackUrl**, você receberá atualizações em sua API quando uma transação for confirmada nesse checkout. Após isso, nenhuma outra transação poderá ser criada a partir desse checkout, apenas a transação que já foi criada poderá ter o status atualizado.\n\nVocê pode consultar o formato que receberá o postback [aqui](/reference/formato-dos-postbacks#section-checkout).\n\nPara atualizar o status de transações de teste, consulte [aqui](/reference/atualizar-transação-de-teste).","operationId":"criar-checkout","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["amount","items","settings","splits"],"properties":{"amount":{"type":"integer","description":"Valor em centavos (500 = R$ 5,00)","format":"int32"},"postbackUrl":{"type":"string","description":"URL de sua API que receberá atualizações do checkout."},"items":{"type":"array","description":"Itens no checkout.","items":{"properties":{"title":{"type":"string","description":"Título do item."},"unitPrice":{"type":"integer","description":"Preço unitário em centavos. Ex: R$ 5,00 = 500.","format":"int32"},"quantity":{"type":"integer","description":"Quantidade do item na transação.","format":"int32"},"tangible":{"type":"boolean","description":"Se o item é físico."},"externalRef":{"type":"string","description":"Referência do item em sua API."}},"required":["title","unitPrice","quantity","tangible"],"type":"object"}},"settings":{"type":"object","description":"Configurações do checkout.","required":["defaultPaymentMethod","requestAddress","requestPhone","traceable"],"properties":{"defaultPaymentMethod":{"type":"string","description":"Meio de pagamento que aparecerá selecionado previamente no checkout. Valores possíveis: *credit_card, boleto, pix*."},"requestAddress":{"type":"boolean","description":"Se será solicitado o endereço no checkout."},"requestPhone":{"type":"boolean","description":"Se será solicitado o telefone no checkout."},"traceable":{"type":"boolean","description":"Se o status de entrega será gerenciado pelo painel."},"boleto":{"type":"object","description":"Configurações de boleto.","required":["enabled","expiresInDays"],"properties":{"enabled":{"type":"boolean","description":"Se a opção de boleto estará habilitada."},"expiresInDays":{"type":"integer","description":"Dias para expiração do boleto.","format":"int32"}}},"pix":{"type":"object","description":"Configurações de Pix.","required":["enabled","expiresInDays"],"properties":{"enabled":{"type":"boolean","description":"Se a opção de Pix estará habilitada."},"expiresInDays":{"type":"integer","description":"Dias para expiração do Pix.","format":"int32"}}},"card":{"type":"object","description":"Configurações de cartão.","required":["enabled","freeInstallments","maxInstallments"],"properties":{"enabled":{"type":"boolean","description":"Se a opção de cartão estará habilitada."},"freeInstallments":{"type":"integer","description":"Parcelas sem juros.","format":"int32"},"maxInstallments":{"type":"integer","description":"Máximo de parcelas.","format":"int32"}}}}},"description":{"type":"string","description":"Descrição apenas para sua visualização, não aparece para o cliente final."},"splits":{"type":"array","description":"Regras de divisão da transação. **Obs: Na criação do checkout não é feita a validação do recipientId. Essa validação é feita apenas quando um pagamento for realizado a partir desse checkout**.","items":{"properties":{"recipientId":{"type":"integer","description":"ID do recebedor.","format":"int32"},"amount":{"type":"integer","description":"Valor da transação em centavos.","format":"int32"},"chargeProcessingFee":{"type":"boolean","description":"Se o recebedor será cobrado das taxas da criação da transação. Default ```true``` para todos os recebedores da transação."}},"required":["recipientId","amount"],"type":"object"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n\t\"id\": 3,\n\t\"companyId\": 2,\n\t\"description\": null,\n\t\"amount\": 1000,\n\t\"secureId\": \"019c2702-6fbe-4199-b21c-c9342888d6ec\",\n\t\"secureUrl\": \"https://link.sandbox.hopysplit.com.br/checkout/019c2702-6fbe-4199-b21c-c9342888d6ec\",\n\t\"postbackUrl\": \"https://617fc9352fd1a9b8bd51a3a99cdce57d.m.pipedream.net\",\n\t\"createdAt\": \"2022-08-02T18:04:04.000Z\",\n\t\"settings\": {\n\t\t\"defaultPaymentMethod\": \"credit_card\",\n\t\t\"requestAddress\": false,\n\t\t\"requestPhone\": true,\n\t\t\"requestDocument\": true,\n\t\t\"traceable\": false,\n\t\t\"card\": {\n\t\t\t\"enabled\": true,\n\t\t\t\"freeInstallments\": 1,\n\t\t\t\"maxInstallments\": 12\n\t\t},\n\t\t\"boleto\": {\n\t\t\t\"enabled\": false,\n\t\t\t\"expiresInDays\": 2\n\t\t},\n\t\t\"pix\": {\n\t\t\t\"enabled\": true,\n\t\t\t\"expiresInDays\": 2\n\t\t}\n\t},\n\t\"items\": [\n\t\t{\n\t\t\t\"externalRef\": null,\n\t\t\t\"title\": \"Hamburgão\",\n\t\t\t\"unitPrice\": 3000,\n\t\t\t\"quantity\": 1,\n\t\t\t\"tangible\": true\n\t\t}\n\t],\n\t\"transaction\": null,\n\t\"splits\": [\n\t\t{\n\t\t\t\"recipientId\": 1,\n\t\t\t\"amount\": 500\n\t\t},\n\t\t{\n\t\t\t\"recipientId\": 2,\n\t\t\t\"amount\": 200\n\t\t},\n\t\t{\n\t\t\t\"recipientId\": 3,\n\t\t\t\"amount\": 300\n\t\t}\n\t]\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":3,"default":0},"companyId":{"type":"integer","example":2,"default":0},"description":{},"amount":{"type":"integer","example":1000,"default":0},"secureId":{"type":"string","example":"019c2702-6fbe-4199-b21c-c9342888d6ec"},"secureUrl":{"type":"string","example":"https://link.sandbox.hopysplit.com.br/checkout/019c2702-6fbe-4199-b21c-c9342888d6ec"},"postbackUrl":{"type":"string","example":"https://617fc9352fd1a9b8bd51a3a99cdce57d.m.pipedream.net"},"createdAt":{"type":"string","example":"2022-08-02T18:04:04.000Z"},"settings":{"type":"object","properties":{"defaultPaymentMethod":{"type":"string","example":"credit_card"},"requestAddress":{"type":"boolean","example":false,"default":true},"requestPhone":{"type":"boolean","example":true,"default":true},"requestDocument":{"type":"boolean","example":true,"default":true},"traceable":{"type":"boolean","example":false,"default":true},"card":{"type":"object","properties":{"enabled":{"type":"boolean","example":true,"default":true},"freeInstallments":{"type":"integer","example":1,"default":0},"maxInstallments":{"type":"integer","example":12,"default":0}}},"boleto":{"type":"object","properties":{"enabled":{"type":"boolean","example":false,"default":true},"expiresInDays":{"type":"integer","example":2,"default":0}}},"pix":{"type":"object","properties":{"enabled":{"type":"boolean","example":true,"default":true},"expiresInDays":{"type":"integer","example":2,"default":0}}}}},"items":{"type":"array","items":{"type":"object","properties":{"externalRef":{},"title":{"type":"string","example":"Hamburgão"},"unitPrice":{"type":"integer","example":3000,"default":0},"quantity":{"type":"integer","example":1,"default":0},"tangible":{"type":"boolean","example":true,"default":true}}}},"transaction":{},"splits":{"type":"array","items":{"type":"object","properties":{"recipientId":{"type":"integer","example":1,"default":0},"amount":{"type":"integer","example":500,"default":0}}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/checkouts/{id}":{"get":{"summary":"Buscar checkout por ID","description":"","operationId":"buscar-checkout-por-id","parameters":[{"name":"id","in":"path","description":"ID do checkout.","schema":{"type":"integer","format":"int32"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n    \"id\": 686401,\n    \"type\": \"checkout\",\n    \"objectId\": \"3\",\n    \"url\": \"https://test.com\",\n    \"data\": {\n        \"id\": 3,\n        \"companyId\": 2,\n        \"description\": null,\n        \"amount\": 1000,\n        \"secureId\": \"019c2702-6fbe-4199-b21c-c9342888d6ec\",\n        \"secureUrl\": \"https://link.compra.com.br/checkout/019c2702-6fbe-4199-b21c-c9342888d6ec\",\n        \"postbackUrl\": \"https://test.com\",\n        \"createdAt\": \"2022-08-02T18:04:04.000Z\",\n        \"settings\": {\n            \"defaultPaymentMethod\": \"credit_card\",\n            \"requestAddress\": false,\n            \"requestPhone\": true,\n            \"requestDocument\": true,\n            \"traceable\": false,\n            \"card\": {\n                \"enabled\": true,\n                \"freeInstallments\": 1,\n                \"maxInstallments\": 12\n            },\n            \"boleto\": {\n                \"enabled\": false,\n                \"expiresInDays\": 2\n            },\n            \"pix\": {\n                \"enabled\": true,\n                \"expiresInDays\": 2\n            }\n        },\n        \"items\": [\n            {\n                \"externalRef\": null,\n                \"title\": \"Hamburgão\",\n                \"unitPrice\": 3000,\n                \"quantity\": 1,\n                \"tangible\": true\n            }\n        ],\n        \"splits\": [],\n        \"transaction\": {\n            \"id\": 282,\n            \"amount\": 10000,\n            \"refundedAmount\": 0,\n            \"companyId\": 2,\n            \"installments\": 12,\n            \"paymentMethod\": \"credit_card\",\n            \"status\": \"paid\",\n            \"postbackUrl\": null,\n            \"metadata\": null,\n            \"traceable\": false,\n            \"secureId\": \"a4594817-be48-4a23-81aa-4bb01f95fe78\",\n            \"secureUrl\": \"https://link.compra.com.br/pagar/a4594817-be48-4a23-81aa-4bb01f95fe78\",\n            \"createdAt\": \"2022-07-18T09:54:22.000Z\",\n            \"updatedAt\": \"2022-07-18T09:54:22.000Z\",\n            \"paidAt\": \"2022-07-18T09:54:22.000Z\",\n            \"ip\": null,\n            \"externalRef\": null,\n            \"customer\": {\n                \"id\": 1,\n                \"externalRef\": null,\n                \"name\": \"Gabryel\",\n                \"email\": \"gabryel@hotmail.com\",\n                \"phone\": \"11999999999\",\n                \"birthdate\": null,\n                \"createdAt\": \"2022-05-26T19:17:48.000Z\",\n                \"document\": {\n                    \"number\": \"12345678910\",\n                    \"type\": \"cpf\"\n                },\n                \"address\": {\n                    \"street\": \"Rua República Argentina\",\n                    \"streetNumber\": \"4214\",\n                    \"complement\": null,\n                    \"zipCode\": \"11065030\",\n                    \"neighborhood\": \"Pompéia\",\n                    \"city\": \"Santos\",\n                    \"state\": \"SP\",\n                    \"country\": \"BR\"\n                }\n            },\n            \"card\": {\n                \"id\": 147,\n                \"brand\": \"visa\",\n                \"holderName\": \"GABRYEL FERREIRA\",\n                \"lastDigits\": \"1111\",\n                \"expirationMonth\": 3,\n                \"expirationYear\": 2028,\n                \"reusable\": true,\n                \"createdAt\": \"2022-07-17T18:08:11.000Z\"\n            },\n            \"boleto\": null,\n            \"pix\": null,\n            \"shipping\": null,\n            \"refusedReason\": null,\n            \"items\": [\n                {\n                    \"externalRef\": null,\n                    \"title\": \"b456\",\n                    \"unitPrice\": 100,\n                    \"quantity\": 1,\n                    \"tangible\": false\n                }\n            ],\n            \"splits\": [\n                {\n                    \"recipientId\": 1,\n                    \"amount\": 10000,\n                    \"netAmount\": 9400\n                }\n            ],\n            \"refunds\": [],\n            \"delivery\": null,\n            \"fee\": {\n                \"fixedAmount\": 200,\n                \"spreadPercentage\": 4,\n                \"estimatedFee\": 600,\n                \"netAmount\": 9400\n            }\n        }\n    }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":686401,"default":0},"type":{"type":"string","example":"checkout"},"objectId":{"type":"string","example":"3"},"url":{"type":"string","example":"https://test.com"},"data":{"type":"object","properties":{"id":{"type":"integer","example":3,"default":0},"companyId":{"type":"integer","example":2,"default":0},"description":{},"amount":{"type":"integer","example":1000,"default":0},"secureId":{"type":"string","example":"019c2702-6fbe-4199-b21c-c9342888d6ec"},"secureUrl":{"type":"string","example":"https://link.compra.com.br/checkout/019c2702-6fbe-4199-b21c-c9342888d6ec"},"postbackUrl":{"type":"string","example":"https://test.com"},"createdAt":{"type":"string","example":"2022-08-02T18:04:04.000Z"},"settings":{"type":"object","properties":{"defaultPaymentMethod":{"type":"string","example":"credit_card"},"requestAddress":{"type":"boolean","example":false,"default":true},"requestPhone":{"type":"boolean","example":true,"default":true},"requestDocument":{"type":"boolean","example":true,"default":true},"traceable":{"type":"boolean","example":false,"default":true},"card":{"type":"object","properties":{"enabled":{"type":"boolean","example":true,"default":true},"freeInstallments":{"type":"integer","example":1,"default":0},"maxInstallments":{"type":"integer","example":12,"default":0}}},"boleto":{"type":"object","properties":{"enabled":{"type":"boolean","example":false,"default":true},"expiresInDays":{"type":"integer","example":2,"default":0}}},"pix":{"type":"object","properties":{"enabled":{"type":"boolean","example":true,"default":true},"expiresInDays":{"type":"integer","example":2,"default":0}}}}},"items":{"type":"array","items":{"type":"object","properties":{"externalRef":{},"title":{"type":"string","example":"Hamburgão"},"unitPrice":{"type":"integer","example":3000,"default":0},"quantity":{"type":"integer","example":1,"default":0},"tangible":{"type":"boolean","example":true,"default":true}}}},"splits":{"type":"array","items":{"type":"object","properties":{}}},"transaction":{"type":"object","properties":{"id":{"type":"integer","example":282,"default":0},"amount":{"type":"integer","example":10000,"default":0},"refundedAmount":{"type":"integer","example":0,"default":0},"companyId":{"type":"integer","example":2,"default":0},"installments":{"type":"integer","example":12,"default":0},"paymentMethod":{"type":"string","example":"credit_card"},"status":{"type":"string","example":"paid"},"postbackUrl":{},"metadata":{},"traceable":{"type":"boolean","example":false,"default":true},"secureId":{"type":"string","example":"a4594817-be48-4a23-81aa-4bb01f95fe78"},"secureUrl":{"type":"string","example":"https://link.compra.com.br/pagar/a4594817-be48-4a23-81aa-4bb01f95fe78"},"createdAt":{"type":"string","example":"2022-07-18T09:54:22.000Z"},"updatedAt":{"type":"string","example":"2022-07-18T09:54:22.000Z"},"paidAt":{"type":"string","example":"2022-07-18T09:54:22.000Z"},"ip":{},"externalRef":{},"customer":{"type":"object","properties":{"id":{"type":"integer","example":1,"default":0},"externalRef":{},"name":{"type":"string","example":"Gabryel"},"email":{"type":"string","example":"gabryel@hotmail.com"},"phone":{"type":"string","example":"11999999999"},"birthdate":{},"createdAt":{"type":"string","example":"2022-05-26T19:17:48.000Z"},"document":{"type":"object","properties":{"number":{"type":"string","example":"12345678910"},"type":{"type":"string","example":"cpf"}}},"address":{"type":"object","properties":{"street":{"type":"string","example":"Rua República Argentina"},"streetNumber":{"type":"string","example":"4214"},"complement":{},"zipCode":{"type":"string","example":"11065030"},"neighborhood":{"type":"string","example":"Pompéia"},"city":{"type":"string","example":"Santos"},"state":{"type":"string","example":"SP"},"country":{"type":"string","example":"BR"}}}}},"card":{"type":"object","properties":{"id":{"type":"integer","example":147,"default":0},"brand":{"type":"string","example":"visa"},"holderName":{"type":"string","example":"GABRYEL FERREIRA"},"lastDigits":{"type":"string","example":"1111"},"expirationMonth":{"type":"integer","example":3,"default":0},"expirationYear":{"type":"integer","example":2028,"default":0},"reusable":{"type":"boolean","example":true,"default":true},"createdAt":{"type":"string","example":"2022-07-17T18:08:11.000Z"}}},"boleto":{},"pix":{},"shipping":{},"refusedReason":{},"items":{"type":"array","items":{"type":"object","properties":{"externalRef":{},"title":{"type":"string","example":"b456"},"unitPrice":{"type":"integer","example":100,"default":0},"quantity":{"type":"integer","example":1,"default":0},"tangible":{"type":"boolean","example":false,"default":true}}}},"splits":{"type":"array","items":{"type":"object","properties":{"recipientId":{"type":"integer","example":1,"default":0},"amount":{"type":"integer","example":10000,"default":0},"netAmount":{"type":"integer","example":9400,"default":0}}}},"refunds":{"type":"array","items":{"type":"object","properties":{}}},"delivery":{},"fee":{"type":"object","properties":{"fixedAmount":{"type":"integer","example":200,"default":0},"spreadPercentage":{"type":"integer","example":4,"default":0},"estimatedFee":{"type":"integer","example":600,"default":0},"netAmount":{"type":"integer","example":9400,"default":0}}}}}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}}},"x-readme":{"headers":[],"explorer-enabled":true,"proxy-enabled":true},"x-readme-fauxas":true}