--- title: "Pagar.me v5 API (Legado)" url: "https://devcenter.stone.com.br/apis/v5-docs-legacy/versions/b9aaff36-6dcc-4353-8398-836d6c13dfa5" --- # Pagar.me v5 API (Legado) OpenAPI specification document. ```json {"openapi":"3.1.0","info":{"title":"Pagar.me v5 API (Legado)","version":"5.0.0","description":"API legada Pagar.me v5 — pedidos, cobranças, clientes, cartões, assinaturas, recebedores, transferências.","contact":{"name":"Suporte Pagar.me","url":"https://pagarme.helpjuice.com/pt_BR/pagarme20"}},"servers":[{"url":"https://api.stone.com.br/core/v5"}],"components":{"securitySchemes":{"sec0":{"type":"http","scheme":"basic"}}},"security":[{"sec0":[]}],"paths":{"/customers":{"post":{"summary":"Criar cliente","description":"","operationId":"criar-cliente-1","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Nome do cliente. Max: 64 caracteres."},"email":{"type":"string","description":"E-mail do cliente. Max: 64 caracteres"},"code":{"type":"string","description":"Código de referência do cliente no sistema da loja. Max: 52 caracteres"},"document":{"type":"string","description":"CPF, CNPJ ou PASSPORT do cliente. Max: 16 caracteres para CPF e CNPJ e Max: 50 caracteres para PASSPORT"},"document_type":{"type":"string","description":"Tipo de documento. Valores possíveis: CPF, CNPJ ou PASSPORT."},"type":{"type":"string","description":"Tipo de cliente. Valores possíveis: **individual** (pessoa física) ou **company** (pessoa jurídica).
**Obrigatório**, caso o `document` seja enviado."},"gender":{"type":"string","description":"Sexo do cliente . Valores possíveis: **male** ou **female**"},"address":{"type":"object","description":"Endereço do cliente.","properties":{"country":{"type":"string","description":"País (Código do país no formato ISO 3166-1 alpha-2)(2 digitos)"},"state":{"type":"string","description":"Estado (Código do estado no formato ISO 3166-2)."},"city":{"type":"string","description":"Cidade."},"zip_code":{"type":"string","description":"Código Postal (CEP) (Apenas numérico)."},"line_1":{"type":"string","description":"Dados principais do endereço. Neste campo deve ser informado Número, Rua, Bairro, nesta ordem e separados por vírgula."},"line_2":{"type":"string","description":"Dados complementares do endereço. Neste campo pode ser informado complemento, referências."}}},"phones":{"type":"object","description":"Telefones do cliente. [Saiba mais sobre o telefones](https://docs.pagar.me/reference#telefones-1)","properties":{"home_phone":{"type":"object","description":"Telefone residencial do cliente.","properties":{"country_code":{"type":"string","description":"Código do País (Apenas numérico)."},"area_code":{"type":"string","description":"Código da área (Apenas numérico)."},"number":{"type":"string","description":"Número do telefone (Apenas numérico)."}}},"mobile_phone":{"type":"object","description":"Telefone celular do cliente.","properties":{"country_code":{"type":"string","description":"Código do País (Apenas numérico)."},"area_code":{"type":"string","description":"Código da área (Apenas numérico)."},"number":{"type":"string","description":"Número do telefone (Apenas numérico)."}}}}},"birthdate":{"type":"string","description":"Data de nascimento do cliente.","default":"mm/dd/aaa","format":"date"},"metadata":{"type":"string","description":"Objeto chave/valor utilizado para armazenar informações adicionais sobre o cliente. [Saiba mais sobre metadata](https://docs.pagar.me/reference/metadata-1)"}}},"examples":{"Request Example":{"value":{"name":"Tony Stark","email":"tonystarkk@avengers.com","code":"MY_CUSTOMER_001","document":"93095135270","type":"individual","document_type":"CPF","gender":"male","address":{"line_1":"375, Av. General Justo, Centro","line_2":"8º andar","zip_code":"20021130","city":"Rio de Janeiro","state":"RJ","country":"BR"},"birthdate":"05/03/1984","phones":{"home_phone":{"country_code":"55","area_code":"21","number":"000000000"},"mobile_phone":{"country_code":"55","area_code":"21","number":"000000000"}},"metadata":{"company":"Avengers"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"cus_QA5V47r9c0Im3dzN\",\n \"name\": \"Tony Stark\",\n \"email\": \"tonystarkk@avengers.com\",\n \"code\": \"MY_CUSTOMER_001\",\n \"document\": \"93095135270\",\n \"document_type\": \"CPF\", \n \"type\": \"individual\",\n \"gender\": \"male\",\n \"delinquent\": false,\n \"address\": {\n \"id\": \"addr_KewjagEfrCbY1doZ\",\n \"line_1\": \"375, Av. General Justo, Centro\",\n \"line_2\": \"8º andar\",\n \"zip_code\": \"20021130\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BR\",\n \"status\": \"active\",\n \"created_at\": \"2017-09-22T15:36:46Z\",\n \"updated_at\": \"2018-04-03T17:46:20Z\"\n },\n \"created_at\": \"2017-09-22T15:36:46Z\",\n \"updated_at\": \"2018-04-03T17:46:20Z\",\n \"birthdate\": \"1984-05-03T00:00:00Z\",\n \"phones\": {\n \"home_phone\": {\n \"country_code\": \"55\",\n \"number\": \"000000000\",\n \"area_code\": \"21\"\n },\n \"mobile_phone\": {\n \"country_code\": \"55\",\n \"number\": \"000000000\",\n \"area_code\": \"21\"\n }\n },\n \"metadata\": {\n \"id\": \"my_customer_id\",\n \"company\": \"Avengers\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"cus_QA5V47r9c0Im3dzN"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"tonystarkk@avengers.com"},"code":{"type":"string","example":"MY_CUSTOMER_001"},"document":{"type":"string","example":"93095135270"},"document_type":{"type":"string","example":"CPF"},"type":{"type":"string","example":"individual"},"gender":{"type":"string","example":"male"},"delinquent":{"type":"boolean","example":false,"default":true},"address":{"type":"object","properties":{"id":{"type":"string","example":"addr_KewjagEfrCbY1doZ"},"line_1":{"type":"string","example":"375, Av. General Justo, Centro"},"line_2":{"type":"string","example":"8º andar"},"zip_code":{"type":"string","example":"20021130"},"city":{"type":"string","example":"Rio de Janeiro"},"state":{"type":"string","example":"RJ"},"country":{"type":"string","example":"BR"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-09-22T15:36:46Z"},"updated_at":{"type":"string","example":"2018-04-03T17:46:20Z"}}},"created_at":{"type":"string","example":"2017-09-22T15:36:46Z"},"updated_at":{"type":"string","example":"2018-04-03T17:46:20Z"},"birthdate":{"type":"string","example":"1984-05-03T00:00:00Z"},"phones":{"type":"object","properties":{"home_phone":{"type":"object","properties":{"country_code":{"type":"string","example":"55"},"number":{"type":"string","example":"000000000"},"area_code":{"type":"string","example":"21"}}},"mobile_phone":{"type":"object","properties":{"country_code":{"type":"string","example":"55"},"number":{"type":"string","example":"000000000"},"area_code":{"type":"string","example":"21"}}}}},"metadata":{"type":"object","properties":{"id":{"type":"string","example":"my_customer_id"},"company":{"type":"string","example":"Avengers"}}}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"The request is invalid.\",\n \"errors\": {\n \"customer.name\": [\n \"The name field is required.\"\n ]\n },\n \"request\": {\n \"email\": \"tonystarkk@avengers.com\",\n \"code\": \"MY_CUSTOMER_001\",\n \"document\": \"123456789\",\n \"type\": \"individual\",\n \"address\": {\n \"line_1\": \"375, Av. General Justo, Centro\",\n \"line_2\": \"8º andar\",\n \"zip_code\": \"20021130\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BR\"\n },\n \"birthdate\": \"1984-05-03T00:00:00Z\",\n \"phones\": {\n \"home_phone\": {\n \"country_code\": \"55\",\n \"number\": \"000000000\",\n \"area_code\": \"21\"\n },\n \"mobile_phone\": {\n \"country_code\": \"55\",\n \"number\": \"000000000\",\n \"area_code\": \"21\"\n }\n },\n \"gender\": \"male\",\n \"metadata\": {\n \"company\": \"Avengers\"\n }\n }\n}"}}}}}},"deprecated":false},"get":{"summary":"Listar clientes","description":"Este recurso permite a obtenção da **carteira de clientes** do lojista. Pode ser utilizados alguns parâmetros como filtro da listagem","operationId":"listar-clientes-1","parameters":[{"name":"name","in":"query","description":"Nome do cliente","schema":{"type":"string"}},{"name":"document","in":"query","description":"CPF ou CNPJ do cliente. Max: 16 caracteres","schema":{"type":"string"}},{"name":"email","in":"query","description":"E-mail do cliente","schema":{"type":"string"}},{"name":"gender","in":"query","description":"Sexo do cliente . Valores possíveis: **male** ou **female**","schema":{"type":"string"}},{"name":"page","in":"query","description":"Página atual.","schema":{"type":"integer","format":"int32","default":1}},{"name":"size","in":"query","description":"Quantidade de itens por página.","schema":{"type":"integer","format":"int32","default":10}},{"name":"code","in":"query","description":"Código do cliente no sistema do lojista","schema":{"type":"string","default":"10"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"data\": [\n {\n \"id\": \"cus_n2Y17zAt67s2Oplg\",\n \"name\": \"Monitor\",\n \"gender\": \"male\",\n \"email\": \"9bfdfb6b-405f-489e-a4e0-b66101c86743@pagar.me\",\n \"delinquent\": false,\n \"created_at\": \"2017-04-19T17:43:10Z\",\n \"updated_at\": \"2017-04-19T17:43:10Z\"\n },\n {\n \"id\": \"cus_Z7DvZNpUZhYlvndR\",\n \"name\": \"Monitor\",\n \"gender\": \"female\",\n \"email\": \"c17b44be-85a8-4a1c-a9d1-5e0109cb4ece@pagar.me\",\n \"delinquent\": false,\n \"created_at\": \"2017-04-19T17:42:51Z\",\n \"updated_at\": \"2017-04-19T17:42:51Z\"\n }\n ],\n \"paging\": {\n \"total\": 545797,\n \"next\": \"https://api.stone.com.br:4443/core/v1/customers?page=2&size=10\"\n }\n}"}}}}},"401":{"description":"401","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Authorization has been denied for this request.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Authorization has been denied for this request."}}}}}}},"deprecated":false}},"/customers/{customer_id}":{"get":{"summary":"Obter cliente","description":"","operationId":"obter-cliente-1","parameters":[{"name":"customer_id","in":"path","description":"Código do cliente. Formato `cus_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"cus_6l5dMWZ0hkHZ4XnE\",\n \"name\": \"Wonderful Woman\",\n \"email\": \"wonderfulwoman@avengers.com\",\n \t\"gender\": \"female\",\n \"delinquent\": false,\n \"address\": {\n \"id\": \"addr_ONzp3ZbTvfDJ35k9\",\n \"line_1\": \"375, Av. General Justo, Centro\",\n \"line_2\": \"8º andar\",\n \"zip_code\": \"20021130\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BR\",\n \"status\": \"active\",\n \"created_at\": \"2017-08-22T19:50:44Z\",\n \"updated_at\": \"2017-08-22T19:50:44Z\"\n },\n \"created_at\": \"2017-08-22T19:50:44Z\",\n \"updated_at\": \"2017-08-22T19:50:51Z\",\n \"phones\": {},\n \"metadata\": {\n \"company\": \"Avengers\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"cus_6l5dMWZ0hkHZ4XnE"},"name":{"type":"string","example":"Wonderful Woman"},"email":{"type":"string","example":"wonderfulwoman@avengers.com"},"gender":{"type":"string","example":"female"},"delinquent":{"type":"boolean","example":false,"default":true},"address":{"type":"object","properties":{"id":{"type":"string","example":"addr_ONzp3ZbTvfDJ35k9"},"line_1":{"type":"string","example":"375, Av. General Justo, Centro"},"line_2":{"type":"string","example":"8º andar"},"zip_code":{"type":"string","example":"20021130"},"city":{"type":"string","example":"Rio de Janeiro"},"state":{"type":"string","example":"RJ"},"country":{"type":"string","example":"BR"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-08-22T19:50:44Z"},"updated_at":{"type":"string","example":"2017-08-22T19:50:44Z"}}},"created_at":{"type":"string","example":"2017-08-22T19:50:44Z"},"updated_at":{"type":"string","example":"2017-08-22T19:50:51Z"},"phones":{"type":"object","properties":{}},"metadata":{"type":"object","properties":{"company":{"type":"string","example":"Avengers"}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Customer not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Customer not found."}}}}}}},"deprecated":false},"put":{"summary":"Editar cliente","description":"","operationId":"editar-cliente-1","parameters":[{"name":"customer_id","in":"path","description":"Código do cliente. Formato `cus_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Nome do cliente. Max: 64 caracteres."},"email":{"type":"string","description":"E-mail do cliente. Max: 64 caracteres"},"code":{"type":"string","description":"Código de referência do cliente no sistema da loja. Max: 52 caracteres"},"document":{"type":"string","description":"CPF, CNPJ ou PASSAPORTE do cliente. Max: 16 caracteres para CPF e CNPJ e Max: 50 caracteres para PASSAPORTE"},"document_type":{"type":"string","description":"Tipo de documento. Valores possíveis: CPF, CNPJ ou PASSPORT."},"type":{"type":"string","description":"Tipo de cliente. Valores possíveis: **individual** (pessoa física) ou **company** (pessoa jurídica).
**Obrigatório**, caso o `document` seja enviado."},"gender":{"type":"string","description":"Sexo do cliente . Valores possíveis: **male** ou **female**"},"address":{"type":"object","description":"Endereço do cliente. [Saiba mais sobre endereços](https://docs.pagar.me/reference/endere%C3%A7os)","properties":{}},"phone":{"type":"object","description":"Telefones do cliente. [Saiba mais sobre o telefones](https://docs.pagar.me/reference#telefones-1)","properties":{}},"birthdate":{"type":"string","description":"Data de nascimento do cliente.","format":"date"},"metadata":{"type":"string","description":"Objeto chave/valor utilizado para armazenar informações adicionais sobre o cliente. [Saiba mais sobre metadata](https://docs.pagar.me/reference/metadata-1)"}}},"examples":{"Request Example":{"value":{"name":"Peter Parker","email":"parker@avengers.com","gender":"male"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"cus_6l5dMWZ0hkHZ4XnE\",\n \"name\": \"Peter Parker\",\n \"email\": \"parker@avengers.com\",\n \"document\": \"26224451990\",\n \"gender\": \"male\",\n \"type\": \"individual\",\n \"delinquent\": false,\n \"created_at\": \"2017-05-02T23:26:49Z\",\n \"updated_at\": \"2017-05-02T23:28:16Z\",\n \"phones\": {\n \"home_phone\": {\n \"country_code\": \"55\",\n \"number\": \"0000002000\",\n \"area_code\": \"021\"\n }\n },\n \"metadata\": {\n \"id\": \"my_customer_id\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"cus_6l5dMWZ0hkHZ4XnE"},"name":{"type":"string","example":"Peter Parker"},"email":{"type":"string","example":"parker@avengers.com"},"document":{"type":"string","example":"26224451990"},"gender":{"type":"string","example":"male"},"type":{"type":"string","example":"individual"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2017-05-02T23:26:49Z"},"updated_at":{"type":"string","example":"2017-05-02T23:28:16Z"},"phones":{"type":"object","properties":{"home_phone":{"type":"object","properties":{"country_code":{"type":"string","example":"55"},"number":{"type":"string","example":"0000002000"},"area_code":{"type":"string","example":"021"}}}}},"metadata":{"type":"object","properties":{"id":{"type":"string","example":"my_customer_id"}}}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"The request is invalid.\",\n \"errors\": {\n \"customer.name\": [\n \"The name field is required.\"\n ]\n },\n \"request\": {\n \"email\": \"tonystarkk@avengers.com\",\n \"code\": \"MY_CUSTOMER_001\",\n \"document\": \"123456789\",\n \"type\": \"individual\",\n \"address\": {\n \"line_1\": \"375, Av. General Justo, Centro\",\n \"line_2\": \"8º andar\",\n \"zip_code\": \"20021130\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BR\"\n },\n \"birthdate\": \"1984-05-03T00:00:00Z\",\n \"phones\": {\n \"home_phone\": {\n \"country_code\": \"55\",\n \"number\": \"000000000\",\n \"area_code\": \"21\"\n },\n \"mobile_phone\": {\n \"country_code\": \"55\",\n \"number\": \"000000000\",\n \"area_code\": \"21\"\n }\n },\n \"gender\": \"male\",\n \"metadata\": {\n \"company\": \"Avengers\"\n }\n }\n}"}}}}}},"deprecated":false}},"/customers/{customer_id}/cards":{"post":{"summary":"Criar cartão","description":"Este recurso cria um `card` associado ao `customer` através do `customer_id` informado.","operationId":"criar-cartão","parameters":[{"name":"customer_id","in":"path","description":"Código do cliente. Formato: `cus_XXXXXXXXXXXXXXXX`","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["number","holder_name","exp_month","exp_year","cvv"],"properties":{"number":{"type":"string","description":"Número do cartão. Entre 13 e 19 caracteres"},"holder_name":{"type":"string","description":"Nome do portador como está impresso no cartão. Máximo de 64 caracteres (Caracteres especiais e números não são aceitos)"},"holder_document":{"type":"string","description":"CPF ou CNPJ do portador do cartão. Obrigatório caso o tipo do cartão seja voucher (bandeiras **VR** ou **Pluxee**)."},"exp_month":{"type":"integer","description":"Mês de validade do cartão. Valor entre 1 e 12 (inclusive)","format":"int32"},"exp_year":{"type":"integer","description":"Ano de validade do cartão. Formatos **yy** ou **yyyy**. Ex: 23 ou 2023.","format":"int32"},"cvv":{"type":"string","description":"Código de segurança do cartão. O campo aceita 4 ou 3 caracteres, variando por bandeira."},"brand":{"type":"string","description":"Bandeira do cartão. Para cartões de crédito, temos como valores possíveis: **elo**, **mastercard**, **visa**, **amex**, **jcb**, **aura**, **hipercard**, **diners**, **unionpay** ou **discover**."},"label":{"type":"string","description":"Indica a label do cartão"},"billing_address_id":{"type":"string","description":"Código do endereço de cobrança. Max: 36 caracteres.<>**Opcional**, pode ser utilizado no lugar do `billing_address`."},"billing_address":{"type":"object","description":"Endereço de cobrança.","properties":{"line_1":{"type":"string","description":"Linha 1 do endereço. (Número, Rua, e Bairro - Nesta ordem e separados por vírgula) Max: 256 caracteres."},"line_2":{"type":"string","description":"Linha 2 do endereço. (Complemento - Andar, Sala, Apto). Max: 128 caracteres."},"zip_code":{"type":"string","description":"CEP. Max: 16 caracteres."},"city":{"type":"string","description":"Cidade. Max: 64 caracteres."},"state":{"type":"string","description":"Código do estado no formato ISO 3166-2."},"country":{"type":"string","description":"Código do país no formato ISO 3166-1 alpha-2."}}},"options":{"type":"object","description":"Objeto com opções para a criação do cartão. Um exemplo de opção que pode ser adicionada ao cartão é o `verify_card` : `true`, que informa que haverá uma validação do cartão antes da utilização (Zero Dollar Auth).","properties":{}},"metadata":{"type":"string","description":"Objeto chave/valor utilizado para armazenar informações adicionais sobre o cartão. [Saiba mais sobre metadata](https://docs.pagar.me/reference/metadata-1)"},"token":{"type":"string","description":"Pode ser enviado no lugar dos dados do cartão, caso este já tenha sido tokenizado previamente. [Saiba mais sobre criação de token de cartão.](https://docs.pagar.me/reference/criar-token-cart%C3%A3o-1)"}}},"examples":{"Request Example":{"value":{"number":"4000000000000010","holder_name":"Tony Stark","holder_document":"93095135270","exp_month":1,"exp_year":30,"cvv":"351","brand":"Mastercard","label":"Sua bandeira","billing_address":{"line_1":"375, Av. General Osorio, Centro","line_2":"7º Andar","zip_code":"220000111","city":"Rio de Janeiro","state":"RJ","country":"BR"},"options":{"verify_card":true}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"card_8ELY0AwVF9HDa3jK\",\n \"first_six_digits\": \"542501\",\n \"last_four_digits\": \"7793\",\n \"brand\": \"Mastercard\",\n \"holder_name\": \"Tony Stark\",\n \"holder_document\": \"93095135270\",\n \"exp_month\": 1,\n \"exp_year\": 2030,\n \"status\": \"active\",\n \"label\": \"Sua bandeira\",\n \"created_at\": \"2017-07-07T19:50:33Z\",\n \"updated_at\": \"2017-07-07T19:50:33Z\",\n \"billing_address\": {\n \"zip_code\": \"220000111\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BR\",\n \"line_1\": \"375, Av. General Osorio, Centro\",\n \"line_2\": \"7º Andar\"\n },\n \"customer\": {\n \"id\": \"cus_yoqONwOJI1IBNbjl\",\n \"name\": \"Tony Stark\",\n \"email\": \"0fee2dc5-e440-4dd1-9cd6-9c2bc90533d0@avengers.com\",\n \"document\": \"93095135270\",\n \"type\": \"individual\",\n \"delinquent\": false,\n \"created_at\": \"2017-07-07T19:50:23Z\",\n \"updated_at\": \"2017-07-07T19:50:23Z\",\n \"phones\": {\n \"home_phone\": {\n \"country_code\": \"55\",\n \"number\": \"000000000\",\n \"area_code\": \"21\"\n },\n \"mobile_phone\": {\n \"country_code\": \"55\",\n \"number\": \"000000000\",\n \"area_code\": \"21\"\n }\n },\n \"metadata\": {\n \"company\": \"Avengers\"\n }\n },\n \"type\": \"credit\"\n}"},"OK - Network Token":{"value":"{\n \"id\": \"card_ej6MVD4sYLUBVy92\",\n \"first_six_digits\": \"400000\",\n \"last_four_digits\": \"0010\",\n \"brand\": \"Visa\",\n \"holder_name\": \"Tony Stark\",\n \"holder_document\": \"93095135270\",\n \"exp_month\": 1,\n \"exp_year\": 2030,\n \"status\": \"active\",\n \"type\": \"credit\",\n \"created_at\": \"2023-03-17T14:01:48Z\",\n \"updated_at\": \"2023-03-17T14:01:48Z\",\n \"billing_address\": {\n \"zip_code\": \"220000111\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BR\",\n \"line_1\": \"375, Av. General Osorio, Centro\",\n \"line_2\": \"7º Andar\"\n },\n \"network_token\": {\n \"token_unique_reference\": \"ea90e8e8-af1d-4f22-a2f0-a54d5f8b55b5\",\n \"status\": \"active\"\n },\n \"customer\": {\n \"id\": \"cus_9oYdjPACaAUXgJq0\",\n \"name\": \"Tony Stark\",\n \"email\": \"tonystarkk@avengers.com\",\n \"code\": \"MY_CUSTOMER_001\",\n \"document\": \"93095135270\",\n \"document_type\": \"cpf\",\n \"type\": \"individual\",\n \"gender\": \"male\",\n \"delinquent\": false,\n \"created_at\": \"2023-03-17T14:01:45Z\",\n \"updated_at\": \"2023-03-17T14:01:45Z\",\n \"birthdate\": \"1984-05-03T00:00:00Z\",\n \"phones\": {\n \"home_phone\": {\n \"country_code\": \"55\",\n \"number\": \"000000000\",\n \"area_code\": \"21\"\n },\n \"mobile_phone\": {\n \"country_code\": \"55\",\n \"number\": \"000000000\",\n \"area_code\": \"21\"\n }\n },\n \"metadata\": {\n \"company\": \"Avengers\"\n }\n }\n}"}},"schema":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","example":"card_8ELY0AwVF9HDa3jK"},"first_six_digits":{"type":"string","example":"542501"},"last_four_digits":{"type":"string","example":"7793"},"brand":{"type":"string","example":"Mastercard"},"holder_name":{"type":"string","example":"Tony Stark"},"holder_document":{"type":"string","example":"93095135270"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":2030,"default":0},"status":{"type":"string","example":"active"},"label":{"type":"string","example":"Sua bandeira"},"created_at":{"type":"string","example":"2017-07-07T19:50:33Z"},"updated_at":{"type":"string","example":"2017-07-07T19:50:33Z"},"billing_address":{"type":"object","properties":{"zip_code":{"type":"string","example":"220000111"},"city":{"type":"string","example":"Rio de Janeiro"},"state":{"type":"string","example":"RJ"},"country":{"type":"string","example":"BR"},"line_1":{"type":"string","example":"375, Av. General Osorio, Centro"},"line_2":{"type":"string","example":"7º Andar"}}},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_yoqONwOJI1IBNbjl"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"0fee2dc5-e440-4dd1-9cd6-9c2bc90533d0@avengers.com"},"document":{"type":"string","example":"93095135270"},"type":{"type":"string","example":"individual"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2017-07-07T19:50:23Z"},"updated_at":{"type":"string","example":"2017-07-07T19:50:23Z"},"phones":{"type":"object","properties":{"home_phone":{"type":"object","properties":{"country_code":{"type":"string","example":"55"},"number":{"type":"string","example":"000000000"},"area_code":{"type":"string","example":"21"}}},"mobile_phone":{"type":"object","properties":{"country_code":{"type":"string","example":"55"},"number":{"type":"string","example":"000000000"},"area_code":{"type":"string","example":"21"}}}}},"metadata":{"type":"object","properties":{"company":{"type":"string","example":"Avengers"}}}}},"type":{"type":"string","example":"credit"}}},{"title":"OK - Network Token","type":"object","properties":{"id":{"type":"string","example":"card_ej6MVD4sYLUBVy92"},"first_six_digits":{"type":"string","example":"400000"},"last_four_digits":{"type":"string","example":"0010"},"brand":{"type":"string","example":"Visa"},"holder_name":{"type":"string","example":"Tony Stark"},"holder_document":{"type":"string","example":"93095135270"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":2030,"default":0},"status":{"type":"string","example":"active"},"type":{"type":"string","example":"credit"},"created_at":{"type":"string","example":"2023-03-17T14:01:48Z"},"updated_at":{"type":"string","example":"2023-03-17T14:01:48Z"},"billing_address":{"type":"object","properties":{"zip_code":{"type":"string","example":"220000111"},"city":{"type":"string","example":"Rio de Janeiro"},"state":{"type":"string","example":"RJ"},"country":{"type":"string","example":"BR"},"line_1":{"type":"string","example":"375, Av. General Osorio, Centro"},"line_2":{"type":"string","example":"7º Andar"}}},"network_token":{"type":"object","properties":{"token_unique_reference":{"type":"string","example":"ea90e8e8-af1d-4f22-a2f0-a54d5f8b55b5"},"status":{"type":"string","example":"active"}}},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_9oYdjPACaAUXgJq0"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"tonystarkk@avengers.com"},"code":{"type":"string","example":"MY_CUSTOMER_001"},"document":{"type":"string","example":"93095135270"},"document_type":{"type":"string","example":"cpf"},"type":{"type":"string","example":"individual"},"gender":{"type":"string","example":"male"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2023-03-17T14:01:45Z"},"updated_at":{"type":"string","example":"2023-03-17T14:01:45Z"},"birthdate":{"type":"string","example":"1984-05-03T00:00:00Z"},"phones":{"type":"object","properties":{"home_phone":{"type":"object","properties":{"country_code":{"type":"string","example":"55"},"number":{"type":"string","example":"000000000"},"area_code":{"type":"string","example":"21"}}},"mobile_phone":{"type":"object","properties":{"country_code":{"type":"string","example":"55"},"number":{"type":"string","example":"000000000"},"area_code":{"type":"string","example":"21"}}}}},"metadata":{"type":"object","properties":{"company":{"type":"string","example":"Avengers"}}}}}}}]}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Customer not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Customer not found."}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"The request is invalid.\",\n \"errors\": {\n \"card\": [\n \"The card expiration date is invalid.\"\n ]\n },\n \"request\": {\n \"number\": \"5425019448107793\",\n \"last_four_digits\": \"7793\",\n \"brand\": \"Mastercard\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"cvv\": \"123\",\n \"billing_address\": {\n \"zip_code\": \"220000111\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BR\",\n \"line_1\": \"375, Av. General Osorio, Centro\",\n \"line_2\": \"7º Andar\"\n },\n \"options\": {\n \"verify_card\": true\n }\n }\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The request is invalid."},"errors":{"type":"object","properties":{"card":{"type":"array","items":{"type":"string","example":"The card expiration date is invalid."}}}},"request":{"type":"object","properties":{"number":{"type":"string","example":"5425019448107793"},"last_four_digits":{"type":"string","example":"7793"},"brand":{"type":"string","example":"Mastercard"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":1,"default":0},"cvv":{"type":"string","example":"123"},"billing_address":{"type":"object","properties":{"zip_code":{"type":"string","example":"220000111"},"city":{"type":"string","example":"Rio de Janeiro"},"state":{"type":"string","example":"RJ"},"country":{"type":"string","example":"BR"},"line_1":{"type":"string","example":"375, Av. General Osorio, Centro"},"line_2":{"type":"string","example":"7º Andar"}}},"options":{"type":"object","properties":{"verify_card":{"type":"boolean","example":true,"default":true}}}}}}}}}}},"deprecated":false},"get":{"summary":"Listar cartão","description":"Este recurso permite a recuperação da **Wallet** contendo todos os cartões do cliente através do seu identificador (`customer_id`).","operationId":"listar-cartão","parameters":[{"name":"customer_id","in":"path","description":"Código do cliente. Formato: `cus_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"data\": [\n {\n \"id\": \"card_onv508NKF3uy98lx\",\n \"first_six_digits\": \"542501\",\n \"last_four_digits\": \"8229\",\n \"brand\": \"Amex\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 2030,\n \"status\": \"active\",\n \"created_at\": \"2017-03-28T22:09:43Z\",\n \"updated_at\": \"2017-03-28T22:09:43Z\",\n \"billing_address\": {\n \"line_1\": \"10880, Malibu Point, Malibu Central\",\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\"\n }\n }, \n {\n \"id\": \"card_k8HDT5sof8CS53KS\",\n \"first_six_digits\": \"411193\",\n \"last_four_digits\": \"6203\",\n \"brand\": \"Visa\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 2030,\n \"status\": \"active\",\n \"created_at\": \"2017-03-29T22:09:43Z\",\n \"updated_at\": \"2017-03-29T22:09:43Z\",\n \"billing_address\": {\n \"line_1\": \"10880, Malibu Point, Malibu Central\",\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\"\n }\n }\n ],\n \"paging\": {\n \"total\": 2\n }\n}"}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Card not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Card not found."}}}}}}},"deprecated":false}},"/customers/{customer_id}/cards/{card_id}":{"get":{"summary":"Obter cartão","description":"Possibilita a recuperação de um `card` através dos identificadores do cartão (`card_id`) e do cliente associado (`customer_id`), informados por parâmetro.","operationId":"obter-cartão","parameters":[{"name":"customer_id","in":"path","description":"Código do cliente. Formato: `cus_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true},{"name":"card_id","in":"path","description":"Código do cartão. Formato: `card_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"card_8ELY0AwVF9HDa3jK\",\n \"first_six_digits\": \"542501\",\n \"last_four_digits\": \"7793\",\n \"brand\": \"Mastercard\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 2030,\n \"status\": \"active\",\n \"created_at\": \"2017-07-07T19:50:33Z\",\n \"updated_at\": \"2017-07-07T19:50:33Z\",\n \"billing_address\": {\n \"line_1\": \"10880, Malibu Point, Malibu Central\",\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\"\n },\n \"customer\": {\n \"id\": \"cus_yoqONwOJI1IBNbjl\",\n \"name\": \"Tony Stark\",\n \"email\": \"0fee2dc5-e440-4dd1-9cd6-9c2bc90533d0@avengers.com\",\n \"document\": \"93095135270\",\n \"type\": \"individual\",\n \"delinquent\": false,\n \"created_at\": \"2017-07-07T19:50:23Z\",\n \"updated_at\": \"2017-07-07T19:50:23Z\",\n \"phones\": {\n \"home_phone\": {\n \"country_code\": \"55\",\n \"number\": \"000000000\",\n \"area_code\": \"21\"\n },\n \"mobile_phone\": {\n \"country_code\": \"55\",\n \"number\": \"000000000\",\n \"area_code\": \"21\"\n }\n },\n \"metadata\": {\n \"company\": \"Avengers\"\n }\n },\n \"type\": \"credit\"\n}"},"OK - Network Token":{"value":"{\n \"id\": \"card_ej6MVD4sYLUBVy92\",\n \"first_six_digits\": \"400000\",\n \"last_four_digits\": \"0010\",\n \"brand\": \"Visa\",\n \"holder_name\": \"Tony Stark\",\n \"holder_document\": \"93095135270\",\n \"exp_month\": 1,\n \"exp_year\": 2030,\n \"status\": \"active\",\n \"type\": \"credit\",\n \"created_at\": \"2023-03-17T14:01:48Z\",\n \"updated_at\": \"2023-03-17T14:01:48Z\",\n \"billing_address\": {\n \"zip_code\": \"220000111\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BR\",\n \"line_1\": \"375, Av. General Osorio, Centro\",\n \"line_2\": \"7º Andar\"\n },\n \"network_token\": {\n \"token_unique_reference\": \"ea90e8e8-af1d-4f22-a2f0-a54d5f8b55b5\",\n \"status\": \"active\"\n },\n \"customer\": {\n \"id\": \"cus_9oYdjPACaAUXgJq0\",\n \"name\": \"Tony Stark\",\n \"email\": \"tonystarkk@avengers.com\",\n \"code\": \"MY_CUSTOMER_001\",\n \"document\": \"93095135270\",\n \"document_type\": \"cpf\",\n \"type\": \"individual\",\n \"gender\": \"male\",\n \"delinquent\": false,\n \"created_at\": \"2023-03-17T14:01:45Z\",\n \"updated_at\": \"2023-03-17T14:01:45Z\",\n \"birthdate\": \"1984-05-03T00:00:00Z\",\n \"phones\": {\n \"home_phone\": {\n \"country_code\": \"55\",\n \"number\": \"000000000\",\n \"area_code\": \"21\"\n },\n \"mobile_phone\": {\n \"country_code\": \"55\",\n \"number\": \"000000000\",\n \"area_code\": \"21\"\n }\n },\n \"metadata\": {\n \"company\": \"Avengers\"\n }\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"card_ej6MVD4sYLUBVy92"},"first_six_digits":{"type":"string","example":"400000"},"last_four_digits":{"type":"string","example":"0010"},"brand":{"type":"string","example":"Visa"},"holder_name":{"type":"string","example":"Tony Stark"},"holder_document":{"type":"string","example":"93095135270"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":2030,"default":0},"status":{"type":"string","example":"active"},"type":{"type":"string","example":"credit"},"created_at":{"type":"string","example":"2023-03-17T14:01:48Z"},"updated_at":{"type":"string","example":"2023-03-17T14:01:48Z"},"billing_address":{"type":"object","properties":{"zip_code":{"type":"string","example":"220000111"},"city":{"type":"string","example":"Rio de Janeiro"},"state":{"type":"string","example":"RJ"},"country":{"type":"string","example":"BR"},"line_1":{"type":"string","example":"375, Av. General Osorio, Centro"},"line_2":{"type":"string","example":"7º Andar"}}},"network_token":{"type":"object","properties":{"token_unique_reference":{"type":"string","example":"ea90e8e8-af1d-4f22-a2f0-a54d5f8b55b5"},"status":{"type":"string","example":"active"}}},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_9oYdjPACaAUXgJq0"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"tonystarkk@avengers.com"},"code":{"type":"string","example":"MY_CUSTOMER_001"},"document":{"type":"string","example":"93095135270"},"document_type":{"type":"string","example":"cpf"},"type":{"type":"string","example":"individual"},"gender":{"type":"string","example":"male"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2023-03-17T14:01:45Z"},"updated_at":{"type":"string","example":"2023-03-17T14:01:45Z"},"birthdate":{"type":"string","example":"1984-05-03T00:00:00Z"},"phones":{"type":"object","properties":{"home_phone":{"type":"object","properties":{"country_code":{"type":"string","example":"55"},"number":{"type":"string","example":"000000000"},"area_code":{"type":"string","example":"21"}}},"mobile_phone":{"type":"object","properties":{"country_code":{"type":"string","example":"55"},"number":{"type":"string","example":"000000000"},"area_code":{"type":"string","example":"21"}}}}},"metadata":{"type":"object","properties":{"company":{"type":"string","example":"Avengers"}}}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Card not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Card not found."}}}}}}},"deprecated":false},"put":{"summary":"Editar cartão","description":"Com o verbo _HTTP PUT_, através do identificador do cartão (`card_id`) e do identificador do cliente ao qual o mesmo está associado (`customer_id`) é possível alterar dados do cartão informado.","operationId":"editar-cartão","parameters":[{"name":"customer_id","in":"path","description":"Código do cliente. Formato: `cus_XXXXXXXXXXXXXXXX`","schema":{"type":"string"},"required":true},{"name":"card_id","in":"path","description":"Código do Cartão. Formato: `card_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["exp_month","exp_year"],"properties":{"holder_name":{"type":"string","description":"Nome do portador como está impresso no cartão. Máximo de 64 caracteres (Caracteres especiais e números não são aceitos)"},"holder_document":{"type":"string","description":"CPF ou CNPJ do portador do cartão. Obrigatório caso o tipo do cartão seja voucher (bandeiras **VR** ou **Pluxee**)."},"exp_month":{"type":"integer","description":"Mês de validade do cartão. Valor entre 1 e 12 (inclusive)","format":"int32"},"exp_year":{"type":"integer","description":"Ano de validade do cartão. Formatos **yy** ou **yyyy**. Ex: 23 ou 2023.","format":"int32"},"billing_address_id":{"type":"string","description":"Código do endereço de cobrança. Max: 36 caracteres.<>**Opcional**, pode ser utilizado no lugar do `billing_address`."},"billing_address":{"type":"object","description":"Endereço de cobrança.","properties":{}},"metadata":{"type":"object","description":"Objeto chave/valor utilizado para armazenar informações adicionais sobre o cartão. [Saiba mais sobre metadata](https://docs.mundipagg.com/v1/reference#metadata)","properties":{}}}},"examples":{"Request Example":{"value":{"holder_name":"Peter Parker","exp_month":12,"exp_year":2030,"billing_address":{"line_1":"375, Av. General Osorio, Centro","line_2":"7º Andar","zip_code":"220000111","city":"Rio de Janeiro","state":"RJ","country":"BR"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"card_oXpOkr1Sy3UQm7P9\",\n \"first_six_digits\": \"542501\",\n \"last_four_digits\": \"7793\",\n \"brand\": \"Mastercard\",\n \"holder_name\": \"Peter Parker\",\n \"exp_month\": 12,\n \"exp_year\": 2030,\n \"status\": \"active\",\n \"created_at\": \"2018-04-03T20:54:58Z\",\n \"updated_at\": \"2018-04-04T12:25:32Z\",\n \"billing_address\": {\n \"zip_code\": \"220000111\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BR\",\n \"line_1\": \"375, Av. General Osorio, Centro\",\n \"line_2\": \"7º Andar\"\n },\n \"customer\": {\n \"id\": \"cus_lNXOjXVSLZC4rQom\",\n \"name\": \"Tony Stark\",\n \"email\": \"14a2f1a5-79a8-4b2b-a658-d4f931b0e02e@avengers.com\",\n \"document\": \"93095135270\",\n \"type\": \"individual\",\n \"delinquent\": false,\n \"created_at\": \"2018-04-03T20:11:48Z\",\n \"updated_at\": \"2018-04-03T20:11:48Z\",\n \"phones\": {\n \"home_phone\": {\n \"country_code\": \"55\",\n \"number\": \"000000000\",\n \"area_code\": \"21\"\n },\n \"mobile_phone\": {\n \"country_code\": \"55\",\n \"number\": \"000000000\",\n \"area_code\": \"21\"\n }\n },\n \"metadata\": {\n \"company\": \"Avengers\"\n }\n },\n \"type\": \"credit\"\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"card_oXpOkr1Sy3UQm7P9"},"first_six_digits":{"type":"string","example":"542501"},"last_four_digits":{"type":"string","example":"7793"},"brand":{"type":"string","example":"Mastercard"},"holder_name":{"type":"string","example":"Peter Parker"},"exp_month":{"type":"integer","example":12,"default":0},"exp_year":{"type":"integer","example":2030,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2018-04-03T20:54:58Z"},"updated_at":{"type":"string","example":"2018-04-04T12:25:32Z"},"billing_address":{"type":"object","properties":{"zip_code":{"type":"string","example":"220000111"},"city":{"type":"string","example":"Rio de Janeiro"},"state":{"type":"string","example":"RJ"},"country":{"type":"string","example":"BR"},"line_1":{"type":"string","example":"375, Av. General Osorio, Centro"},"line_2":{"type":"string","example":"7º Andar"}}},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_lNXOjXVSLZC4rQom"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"14a2f1a5-79a8-4b2b-a658-d4f931b0e02e@avengers.com"},"document":{"type":"string","example":"93095135270"},"type":{"type":"string","example":"individual"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2018-04-03T20:11:48Z"},"updated_at":{"type":"string","example":"2018-04-03T20:11:48Z"},"phones":{"type":"object","properties":{"home_phone":{"type":"object","properties":{"country_code":{"type":"string","example":"55"},"number":{"type":"string","example":"000000000"},"area_code":{"type":"string","example":"21"}}},"mobile_phone":{"type":"object","properties":{"country_code":{"type":"string","example":"55"},"number":{"type":"string","example":"000000000"},"area_code":{"type":"string","example":"21"}}}}},"metadata":{"type":"object","properties":{"company":{"type":"string","example":"Avengers"}}}}},"type":{"type":"string","example":"credit"}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Card not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Card not found."}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"The request is invalid.\",\n \"errors\": {\n \"card.exp_date\": [\n \"The card expiration date is invalid.\"\n ]\n },\n \"request\": {\n \"holder_name\": \"Peter Parker\",\n \"exp_month\": 12,\n \"billing_address\": {\n \"zip_code\": \"220000111\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BR\",\n \"line_1\": \"375, Av. General Osorio, Centro\",\n \"line_2\": \"7º Andar\",\n \"globalType\": true\n }\n }\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The request is invalid."},"errors":{"type":"object","properties":{"card.exp_date":{"type":"array","items":{"type":"string","example":"The card expiration date is invalid."}}}},"request":{"type":"object","properties":{"holder_name":{"type":"string","example":"Peter Parker"},"exp_month":{"type":"integer","example":12,"default":0},"billing_address":{"type":"object","properties":{"zip_code":{"type":"string","example":"220000111"},"city":{"type":"string","example":"Rio de Janeiro"},"state":{"type":"string","example":"RJ"},"country":{"type":"string","example":"BR"},"line_1":{"type":"string","example":"375, Av. General Osorio, Centro"},"line_2":{"type":"string","example":"7º Andar"},"globalType":{"type":"boolean","example":true,"default":true}}}}}}}}}}},"deprecated":false},"delete":{"summary":"Excluir cartão","description":"Com o verbo _HTTP DELETE_, através do identificador do cartão (`card_id`) e do identificador do cliente (`customer_id`) ao qual o cartão está associado, é possível remover o cartão da **Wallet** do cliente.","operationId":"excluir-cartão","parameters":[{"name":"customer_id","in":"path","description":"Código do cliente. Formato: `cus_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true},{"name":"card_id","in":"path","description":"Código do cartão. Formato: `card_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"card_OBojZD1IvGcPq8gl\",\n \"first_six_digits\": \"542501\",\n \"last_four_digits\": \"7793\",\n \"brand\": \"Mastercard\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 2022,\n \"status\": \"deleted\",\n \"created_at\": \"2018-04-04T12:43:16Z\",\n \"updated_at\": \"2018-04-04T12:43:30Z\",\n \"deleted_at\": \"2018-04-04T12:43:30Z\",\n \"billing_address\": {\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"line_1\": \"10880, Malibu Point, Malibu Central\"\n },\n \"customer\": {\n \"id\": \"cus_9El4qnTEKFKQoV7r\",\n \"name\": \"Tony Stark\",\n \"email\": \"609671d7-7b1b-4b31-b3e0-1709cc8d9637@avengers.com\",\n \"document\": \"93095135270\",\n \"type\": \"individual\",\n \"delinquent\": false,\n \"created_at\": \"2018-04-04T12:05:08Z\",\n \"updated_at\": \"2018-04-04T12:05:08Z\",\n \"phones\": {\n \"home_phone\": {\n \"country_code\": \"55\",\n \"number\": \"000000000\",\n \"area_code\": \"21\"\n },\n \"mobile_phone\": {\n \"country_code\": \"55\",\n \"number\": \"000000000\",\n \"area_code\": \"21\"\n }\n },\n \"metadata\": {\n \"company\": \"Avengers\"\n }\n },\n \"type\": \"credit\"\n}"},"OK - Network Token":{"value":"{\n \"id\": \"card_ej6MVD4sYLUBVy92\",\n \"first_six_digits\": \"400000\",\n \"last_four_digits\": \"0010\",\n \"brand\": \"Visa\",\n \"holder_name\": \"Tony Stark\",\n \"holder_document\": \"93095135270\",\n \"exp_month\": 1,\n \"exp_year\": 2030,\n \"status\": \"deleted\",\n \"type\": \"credit\",\n \"created_at\": \"2023-03-17T14:01:48Z\",\n \"updated_at\": \"2023-03-17T14:09:20Z\",\n \"deleted_at\": \"2023-03-17T14:09:20Z\",\n \"billing_address\": {\n \"zip_code\": \"220000111\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BR\",\n \"line_1\": \"375, Av. General Osorio, Centro\",\n \"line_2\": \"7º Andar\"\n },\n \"network_token\": {\n \"token_unique_reference\": \"ea90e8e8-af1d-4f22-a2f0-a54d5f8b55b5\",\n \"status\": \"inactive\"\n },\n \"customer\": {\n \"id\": \"cus_9oYdjPACaAUXgJq0\",\n \"name\": \"Tony Stark\",\n \"email\": \"tonystarkk@avengers.com\",\n \"code\": \"MY_CUSTOMER_001\",\n \"document\": \"93095135270\",\n \"document_type\": \"cpf\",\n \"type\": \"individual\",\n \"gender\": \"male\",\n \"delinquent\": false,\n \"created_at\": \"2023-03-17T14:01:45Z\",\n \"updated_at\": \"2023-03-17T14:01:45Z\",\n \"birthdate\": \"1984-05-03T00:00:00Z\",\n \"phones\": {\n \"home_phone\": {\n \"country_code\": \"55\",\n \"number\": \"000000000\",\n \"area_code\": \"21\"\n },\n \"mobile_phone\": {\n \"country_code\": \"55\",\n \"number\": \"000000000\",\n \"area_code\": \"21\"\n }\n },\n \"metadata\": {\n \"company\": \"Avengers\"\n }\n }\n}"}},"schema":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","example":"card_OBojZD1IvGcPq8gl"},"first_six_digits":{"type":"string","example":"542501"},"last_four_digits":{"type":"string","example":"7793"},"brand":{"type":"string","example":"Mastercard"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":2022,"default":0},"status":{"type":"string","example":"deleted"},"created_at":{"type":"string","example":"2018-04-04T12:43:16Z"},"updated_at":{"type":"string","example":"2018-04-04T12:43:30Z"},"deleted_at":{"type":"string","example":"2018-04-04T12:43:30Z"},"billing_address":{"type":"object","properties":{"zip_code":{"type":"string","example":"90265"},"city":{"type":"string","example":"Malibu"},"state":{"type":"string","example":"CA"},"country":{"type":"string","example":"US"},"line_1":{"type":"string","example":"10880, Malibu Point, Malibu Central"}}},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_9El4qnTEKFKQoV7r"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"609671d7-7b1b-4b31-b3e0-1709cc8d9637@avengers.com"},"document":{"type":"string","example":"93095135270"},"type":{"type":"string","example":"individual"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2018-04-04T12:05:08Z"},"updated_at":{"type":"string","example":"2018-04-04T12:05:08Z"},"phones":{"type":"object","properties":{"home_phone":{"type":"object","properties":{"country_code":{"type":"string","example":"55"},"number":{"type":"string","example":"000000000"},"area_code":{"type":"string","example":"21"}}},"mobile_phone":{"type":"object","properties":{"country_code":{"type":"string","example":"55"},"number":{"type":"string","example":"000000000"},"area_code":{"type":"string","example":"21"}}}}},"metadata":{"type":"object","properties":{"company":{"type":"string","example":"Avengers"}}}}},"type":{"type":"string","example":"credit"}}},{"title":"OK - Network Token","type":"object","properties":{"id":{"type":"string","example":"card_ej6MVD4sYLUBVy92"},"first_six_digits":{"type":"string","example":"400000"},"last_four_digits":{"type":"string","example":"0010"},"brand":{"type":"string","example":"Visa"},"holder_name":{"type":"string","example":"Tony Stark"},"holder_document":{"type":"string","example":"93095135270"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":2030,"default":0},"status":{"type":"string","example":"deleted"},"type":{"type":"string","example":"credit"},"created_at":{"type":"string","example":"2023-03-17T14:01:48Z"},"updated_at":{"type":"string","example":"2023-03-17T14:09:20Z"},"deleted_at":{"type":"string","example":"2023-03-17T14:09:20Z"},"billing_address":{"type":"object","properties":{"zip_code":{"type":"string","example":"220000111"},"city":{"type":"string","example":"Rio de Janeiro"},"state":{"type":"string","example":"RJ"},"country":{"type":"string","example":"BR"},"line_1":{"type":"string","example":"375, Av. General Osorio, Centro"},"line_2":{"type":"string","example":"7º Andar"}}},"network_token":{"type":"object","properties":{"token_unique_reference":{"type":"string","example":"ea90e8e8-af1d-4f22-a2f0-a54d5f8b55b5"},"status":{"type":"string","example":"inactive"}}},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_9oYdjPACaAUXgJq0"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"tonystarkk@avengers.com"},"code":{"type":"string","example":"MY_CUSTOMER_001"},"document":{"type":"string","example":"93095135270"},"document_type":{"type":"string","example":"cpf"},"type":{"type":"string","example":"individual"},"gender":{"type":"string","example":"male"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2023-03-17T14:01:45Z"},"updated_at":{"type":"string","example":"2023-03-17T14:01:45Z"},"birthdate":{"type":"string","example":"1984-05-03T00:00:00Z"},"phones":{"type":"object","properties":{"home_phone":{"type":"object","properties":{"country_code":{"type":"string","example":"55"},"number":{"type":"string","example":"000000000"},"area_code":{"type":"string","example":"21"}}},"mobile_phone":{"type":"object","properties":{"country_code":{"type":"string","example":"55"},"number":{"type":"string","example":"000000000"},"area_code":{"type":"string","example":"21"}}}}},"metadata":{"type":"object","properties":{"company":{"type":"string","example":"Avengers"}}}}}}}]}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Card not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Card not found."}}}}}}},"deprecated":false}},"/customers/{customer_id}/cards/{card_id}/renew":{"post":{"summary":"Renovar cartão","description":"Com o verbo _HTTP POST_, através do identificador do cartão (`card_id`) e do identificador do cliente (`customer_id`) ao qual o cartão está associado, é possível renovar o cartão da **Wallet** do cliente, utilizando a funcionalidade manual do Card Updater.","operationId":"renovar-cartão-1","parameters":[{"name":"customer_id","in":"path","description":"Código do cliente. Formato: `cus_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true},{"name":"card_id","in":"path","description":"Código do cartão. Formato: `card_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"card_MgwPAXnU7rHW5mNj\",\n \"first_six_digits\": \"519645\",\n \"last_four_digits\": \"5475\",\n \"brand\": \"Mastercard\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 3,\n \"exp_year\": 2020,\n \"status\": \"active\",\n \"type\": \"credit\",\n \"is_renewed\": true,\n \"created_at\": \"2018-06-22T22:49:48Z\",\n \"updated_at\": \"2018-06-22T22:49:48Z\",\n \"billing_address\": {\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"line_1\": \"10880, Malibu Point, Malibu Central\"\n },\n \"customer\": {\n \"id\": \"cus_BzRmLzQHEyurPkKo\",\n \"name\": \"Tony Stark\",\n \"email\": \"203b6f70-61ec-4f30-b00a-8a1823500ab4@avengers.com\",\n \"document\": \"93095135270\",\n \"type\": \"individual\",\n \"delinquent\": false,\n \"created_at\": \"2018-06-22T21:36:49Z\",\n \"updated_at\": \"2018-06-22T21:36:49Z\",\n \"phones\": {\n \"home_phone\": {\n \"country_code\": \"55\",\n \"number\": \"000000000\",\n \"area_code\": \"21\"\n },\n \"mobile_phone\": {\n \"country_code\": \"55\",\n \"number\": \"000000000\",\n \"area_code\": \"21\"\n }\n },\n \"metadata\": {\n \"company\": \"Avengers\"\n }\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"card_MgwPAXnU7rHW5mNj"},"first_six_digits":{"type":"string","example":"519645"},"last_four_digits":{"type":"string","example":"5475"},"brand":{"type":"string","example":"Mastercard"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":3,"default":0},"exp_year":{"type":"integer","example":2020,"default":0},"status":{"type":"string","example":"active"},"type":{"type":"string","example":"credit"},"is_renewed":{"type":"boolean","example":true,"default":true},"created_at":{"type":"string","example":"2018-06-22T22:49:48Z"},"updated_at":{"type":"string","example":"2018-06-22T22:49:48Z"},"billing_address":{"type":"object","properties":{"zip_code":{"type":"string","example":"90265"},"city":{"type":"string","example":"Malibu"},"state":{"type":"string","example":"CA"},"country":{"type":"string","example":"US"},"line_1":{"type":"string","example":"10880, Malibu Point, Malibu Central"}}},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_BzRmLzQHEyurPkKo"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"203b6f70-61ec-4f30-b00a-8a1823500ab4@avengers.com"},"document":{"type":"string","example":"93095135270"},"type":{"type":"string","example":"individual"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2018-06-22T21:36:49Z"},"updated_at":{"type":"string","example":"2018-06-22T21:36:49Z"},"phones":{"type":"object","properties":{"home_phone":{"type":"object","properties":{"country_code":{"type":"string","example":"55"},"number":{"type":"string","example":"000000000"},"area_code":{"type":"string","example":"21"}}},"mobile_phone":{"type":"object","properties":{"country_code":{"type":"string","example":"55"},"number":{"type":"string","example":"000000000"},"area_code":{"type":"string","example":"21"}}}}},"metadata":{"type":"object","properties":{"company":{"type":"string","example":"Avengers"}}}}}}}}}},"412":{"description":"412","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Could not renew card.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Could not renew card."}}}}}}},"deprecated":false}},"/tokens":{"post":{"summary":"Criar Token cartão","description":"","operationId":"criar-token-cartão-1","parameters":[{"name":"appId","in":"query","description":"Chave publica da conta.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["type","card"],"properties":{"type":{"type":"string","description":"Tipo do cartão"},"card":{"type":"object","description":"Informações do cartão a ser tokenizado.","required":["number","exp_month","exp_year"],"properties":{"number":{"type":"string","description":"Número do cartão. Entre 13 e 19 caracteres"},"holder_name":{"type":"string","description":"Nome do portador como está impresso no cartão. Máximo de 64 caracteres (Caracteres especiais e números não são aceitos)"},"holder_document":{"type":"string","description":"CPF ou CNPJ do portador do cartão. Obrigatório caso o tipo do cartão seja voucher (bandeiras VR ou Pluxee)."},"exp_month":{"type":"string","description":"Mês de validade do cartão. Valor entre 1 e 12 (inclusive)"},"exp_year":{"type":"string","description":"Ano de validade do cartão. Formatos yy ou yyyy. Ex: 23 ou 2023."},"cvv":{"type":"string","description":"Código de segurança do cartão. O campo aceita 4 ou 3 caracteres, variando por bandeira."},"brand":{"type":"string","description":"(Opcional) Bandeira do cartão. Para cartões de crédito, temos como valores possíveis: Elo, Mastercard, Visa, Amex, ou Hipercard. Para voucher, temos como valores possíveis: Alelo, VR ou Pluxee."},"label":{"type":"string","description":"Indica a label do cartão"}}}}},"examples":{"Request Example":{"value":{"type":"card","card":{"number":"4000000000000010","holder_name":"Tony Stark","exp_month":1,"exp_year":30,"cvv":"651","label":"Sua bandeira"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"token_zVw7rqvHEPH8XlbE\",\n \"type\": \"card\",\n \"created_at\": \"2018-06-18T18:48:58Z\",\n \"expires_at\": \"2018-06-18T18:49:58Z\",\n \"card\": {\n \"last_four_digits\": \"5580\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 30,\n \"brand\": \"Visa\",\n \"label\": \"Sua bandeira\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"token_zVw7rqvHEPH8XlbE"},"type":{"type":"string","example":"card"},"created_at":{"type":"string","example":"2018-06-18T18:48:58Z"},"expires_at":{"type":"string","example":"2018-06-18T18:49:58Z"},"card":{"type":"object","properties":{"last_four_digits":{"type":"string","example":"5580"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":30,"default":0},"brand":{"type":"string","example":"Visa"},"label":{"type":"string","example":"Sua bandeira"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Could not renew card.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Could not renew card."}}}}}}},"deprecated":false,"security":[]}},"/customers/{customer_id}/addresses":{"post":{"summary":"Criar endereço","description":"Para a criação de um `address` é necessário informar o `customer_id` do cliente ao qual será associado o endereço.","operationId":"criar-endereço-1","parameters":[{"name":"customer_id","in":"path","description":"Código do cliente. Formato: `cus_XXXXXXXXXXXXXXXX`","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["line_1","zip_code","city","state","country"],"properties":{"line_1":{"type":"string","description":"Linha 1 do endereço. (Número, Rua, e Bairro - Nesta ordem e separados por vírgula) Max: 256 caracteres."},"line_2":{"type":"string","description":"Linha 2 do endereço. (Complemento - Andar, Sala, Apto). Max: 128 caracteres."},"zip_code":{"type":"string","description":"CEP. Max: 16 caracteres. (Apenas numérico)"},"city":{"type":"string","description":"Cidade. Max: 64 caracteres."},"state":{"type":"string","description":"Código do estado no formato ISO 3166-2. Saiba mais sobre ISO 3166-2"},"country":{"type":"string","description":"Código do país no formato ISO 3166-1 alpha-2. Saiba mais sobre ISO 3166-1 alpha-2"},"metadata":{"type":"string","description":"Objeto chave/valor utilizado para armazenar informações adicionais sobre o endereço. [Saiba mais sobre metadata](https://docs.mundipagg.com/v1/reference#metadata)"}}},"examples":{"Request Example":{"value":{"line_1":"375, Av. General Justo, Centro","line_2":"8º andar","zip_code":"20021130","city":"Rio de Janeiro","state":"RJ","country":"BR","metadata":{"id":"my_address_id"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"addr_Pn5x69LCWhrANX2o\",\n \"line_1\": \"375, Av. General Justo, Centro\",\n \"line_2\": \"8º andar\",\n \"zip_code\": \"20021130\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BR\",\n \"status\": \"active\",\n \"created_at\": \"2017-04-19T17:49:36Z\",\n \"updated_at\": \"2017-04-19T17:49:36Z\",\n \"customer\": {\n \"id\": \"cus_aEkwKv0SmNHMR931\",\n \"name\": \"Luke Skywalker\",\n \"email\": \"lskywalker@r2d2.com\",\n \"document\": \"26224451990\",\n \"type\": \"individual\",\n \"delinquent\": false,\n \"created_at\": \"2017-04-04T19:41:31Z\",\n \"updated_at\": \"2017-04-19T17:44:47Z\",\n \"metadata\": {\n \"id\": \"my_customer_id\"\n }\n },\n \"metadata\": {\n \"id\": \"my_address_id\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"addr_Pn5x69LCWhrANX2o"},"line_1":{"type":"string","example":"375, Av. General Justo, Centro"},"line_2":{"type":"string","example":"8º andar"},"zip_code":{"type":"string","example":"20021130"},"city":{"type":"string","example":"Rio de Janeiro"},"state":{"type":"string","example":"RJ"},"country":{"type":"string","example":"BR"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-19T17:49:36Z"},"updated_at":{"type":"string","example":"2017-04-19T17:49:36Z"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_aEkwKv0SmNHMR931"},"name":{"type":"string","example":"Luke Skywalker"},"email":{"type":"string","example":"lskywalker@r2d2.com"},"document":{"type":"string","example":"26224451990"},"type":{"type":"string","example":"individual"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2017-04-04T19:41:31Z"},"updated_at":{"type":"string","example":"2017-04-19T17:44:47Z"},"metadata":{"type":"object","properties":{"id":{"type":"string","example":"my_customer_id"}}}}},"metadata":{"type":"object","properties":{"id":{"type":"string","example":"my_address_id"}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Customer not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Customer not found."}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"The request is invalid.\",\n \"errors\": {\n \"address.line_1\": [\n \"The line_1 field is required.\"\n ]\n },\n \"request\": {\n \"zip_code\": \"90265\",\n \"city\": \"Teresópolis\",\n \"state\": \"RJ\",\n \"country\": \"BR\",\n \"line_2\": \"sala 23\",\n \"globalType\": true\n }\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The request is invalid."},"errors":{"type":"object","properties":{"address.line_1":{"type":"array","items":{"type":"string","example":"The line_1 field is required."}}}},"request":{"type":"object","properties":{"zip_code":{"type":"string","example":"90265"},"city":{"type":"string","example":"Teresópolis"},"state":{"type":"string","example":"RJ"},"country":{"type":"string","example":"BR"},"line_2":{"type":"string","example":"sala 23"},"globalType":{"type":"boolean","example":true,"default":true}}}}}}}}},"deprecated":false},"get":{"summary":"Listar endereços","description":"Este recurso permite a recuperação dos endereços de um determinado cliente através do seu identificador(`customer_id`). Pode ser utilizados alguns parâmetros como filtro da listagem.","operationId":"listar-endereços-1","parameters":[{"name":"customer_id","in":"path","description":"Código do cliente. Formato: `cus_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true},{"name":"page","in":"query","description":"Página atual.","schema":{"type":"integer","format":"int32","default":1}},{"name":"size","in":"query","description":"Quantidade de itens.","schema":{"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"data\": [\n {\n \"id\": \"addr_84BkRGZBtWiYJ9ox\",\n \"line_1\": \"10882, Malibu Point, Central Malibu\",\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"status\": \"active\",\n \"created_at\": \"2017-04-19T17:49:05Z\",\n \"updated_at\": \"2017-04-19T17:49:05Z\"\n },\n {\n \"id\": \"addr_yQAlePAumWuBa3qJ\",\n \"line_1\": \"375, Av. General Justo, Centro\",\n \"line_2\": \"9º andar\",\n \"zip_code\": \"20021130\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BR\",\n \"status\": \"active\",\n \"created_at\": \"2017-04-04T19:41:31Z\",\n \"updated_at\": \"2017-04-04T19:41:31Z\"\n }\n ],\n \"paging\": {\n \"total\": 2\n }\n}"}},"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"addr_84BkRGZBtWiYJ9ox"},"line_1":{"type":"string","example":"10882, Malibu Point, Central Malibu"},"zip_code":{"type":"string","example":"90265"},"city":{"type":"string","example":"Malibu"},"state":{"type":"string","example":"CA"},"country":{"type":"string","example":"US"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-19T17:49:05Z"},"updated_at":{"type":"string","example":"2017-04-19T17:49:05Z"}}}},"paging":{"type":"object","properties":{"total":{"type":"integer","example":2,"default":0}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Customer not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Customer not found."}}}}}}},"deprecated":false}},"/customers/{customer_id}/addresses/{address_id}":{"get":{"summary":"Obter endereço","description":"Através dos identificadores do cliente (`customer_id`) e do endereço (`address_id`) é possível obter o endereço do cliente.","operationId":"obter-endereço-1","parameters":[{"name":"customer_id","in":"path","description":"Código do cliente. Formato: `cus_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true},{"name":"address_id","in":"path","description":"Código do endereço. Formato: `addr_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"addr_Pn5x69LCWhrANX2o\",\n \"line_1\": \"375, Av. General Justo, Centro\",\n \"line_2\": \"10º andar\",\n \"zip_code\": \"20021130\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BR\",\n \"status\": \"deleted\",\n \"created_at\": \"2017-04-19T17:49:36Z\",\n \"updated_at\": \"2017-04-19T17:50:18Z\",\n \"deleted_at\": \"2017-04-19T17:50:34Z\",\n \"customer\": {\n \"id\": \"cus_aEkwKv0SmNHMR931\",\n \"name\": \"Luke Skywalker\",\n \"email\": \"lskywalker@r2d2.com\",\n \"document\": \"26224451990\",\n \"type\": \"individual\",\n \"delinquent\": false,\n \"created_at\": \"2017-04-04T19:41:31Z\",\n \"updated_at\": \"2017-04-19T17:44:47Z\",\n \"metadata\": {\n \"id\": \"my_customer_id\"\n }\n },\n \"metadata\": {\n \"id\": \"work\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"addr_Pn5x69LCWhrANX2o"},"line_1":{"type":"string","example":"375, Av. General Justo, Centro"},"line_2":{"type":"string","example":"10º andar"},"zip_code":{"type":"string","example":"20021130"},"city":{"type":"string","example":"Rio de Janeiro"},"state":{"type":"string","example":"RJ"},"country":{"type":"string","example":"BR"},"status":{"type":"string","example":"deleted"},"created_at":{"type":"string","example":"2017-04-19T17:49:36Z"},"updated_at":{"type":"string","example":"2017-04-19T17:50:18Z"},"deleted_at":{"type":"string","example":"2017-04-19T17:50:34Z"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_aEkwKv0SmNHMR931"},"name":{"type":"string","example":"Luke Skywalker"},"email":{"type":"string","example":"lskywalker@r2d2.com"},"document":{"type":"string","example":"26224451990"},"type":{"type":"string","example":"individual"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2017-04-04T19:41:31Z"},"updated_at":{"type":"string","example":"2017-04-19T17:44:47Z"},"metadata":{"type":"object","properties":{"id":{"type":"string","example":"my_customer_id"}}}}},"metadata":{"type":"object","properties":{"id":{"type":"string","example":"work"}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Address not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Address not found."}}}}}}},"deprecated":false},"put":{"summary":"Editar endereço","description":"Com o verbo _HTTP PUT_, através dos identificadores do cliente (`customer_id`) e do endereço (`address_id`) é possível atualizar informações complementares do endereço.","operationId":"editar-endereço-1","parameters":[{"name":"customer_id","in":"path","description":"Código do cliente. Formato: `cus_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true},{"name":"address_id","in":"path","description":"Código do endereço. Formato: `addr_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"line_2":{"type":"string","description":"Linha 2 do endereço. (Complemento - Andar, Sala, Apto). Max: 128 caracteres."},"metadata":{"type":"string","description":"Objeto chave/valor utilizado para armazenar informações adicionais sobre o endereço. [Saiba mais sobre metadata](https://docs.pagar.me/reference/metadata-1)."}}},"examples":{"Request Example":{"value":{"line_2":"10º andar","metadata":{"id":"work"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"addr_Pn5x69LCWhrANX2o\",\n \"line_1\": \"375, Av. General Justo, Centro\",\n \"line_2\": \"10º andar\",\n \"zip_code\": \"20021130\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BR\",\n \"status\": \"active\",\n \"created_at\": \"2017-04-19T17:49:36Z\",\n \"updated_at\": \"2017-04-19T17:50:18Z\",\n \"customer\": {\n \"id\": \"cus_aEkwKv0SmNHMR931\",\n \"name\": \"Luke Skywalker\",\n \"email\": \"lskywalker@r2d2.com\",\n \"document\": \"26224451990\",\n \"type\": \"individual\",\n \"delinquent\": false,\n \"created_at\": \"2017-04-04T19:41:31Z\",\n \"updated_at\": \"2017-04-19T17:44:47Z\",\n \"metadata\": {\n \"id\": \"my_customer_id\"\n }\n },\n \"metadata\": {\n \"id\": \"work\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"addr_Pn5x69LCWhrANX2o"},"line_1":{"type":"string","example":"375, Av. General Justo, Centro"},"line_2":{"type":"string","example":"10º andar"},"zip_code":{"type":"string","example":"20021130"},"city":{"type":"string","example":"Rio de Janeiro"},"state":{"type":"string","example":"RJ"},"country":{"type":"string","example":"BR"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-19T17:49:36Z"},"updated_at":{"type":"string","example":"2017-04-19T17:50:18Z"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_aEkwKv0SmNHMR931"},"name":{"type":"string","example":"Luke Skywalker"},"email":{"type":"string","example":"lskywalker@r2d2.com"},"document":{"type":"string","example":"26224451990"},"type":{"type":"string","example":"individual"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2017-04-04T19:41:31Z"},"updated_at":{"type":"string","example":"2017-04-19T17:44:47Z"},"metadata":{"type":"object","properties":{"id":{"type":"string","example":"my_customer_id"}}}}},"metadata":{"type":"object","properties":{"id":{"type":"string","example":"work"}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Address not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Address not found."}}}}}}},"deprecated":false},"delete":{"summary":"Excluir endereço","description":"Com o verbo _HTTP DELETE_, através do identificador do endereço(`address_id`) e do identificador do cliente (`customer_id`) ao qual o endereço está associado, é possível remover o endereço da **Wallet** do cliente.","operationId":"excluir-endereço-1","parameters":[{"name":"customer_id","in":"path","description":"Código do cliente. Formato: `cus_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true},{"name":"address_id","in":"path","description":"Código do endereço. Formato: `addr_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"addr_GEjbAjaUK9h1PRLa\",\n \"line_1\": \"10882, Malibu Point, Central Malibu\",\n \"street\": \"Malibu Point\",\n \"number\": \"10882\",\n \"zip_code\": \"90265\",\n \"neighborhood\": \"Central Malibu\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"status\": \"deleted\",\n \"created_at\": \"2018-12-14T18:57:18Z\",\n \"updated_at\": \"2018-12-14T18:58:36Z\",\n \"deleted_at\": \"2018-12-14T18:58:36Z\",\n \"customer\": {\n \"id\": \"cus_lMyKPqXiRhR8w9Dr\",\n \"name\": \"Tony Stark\",\n \"email\": \"17cdffc1-d919-4530-9427-c82ba5b5c77f@avengers.com\",\n \"document\": \"93095135270\",\n \"type\": \"individual\",\n \"delinquent\": false,\n \"created_at\": \"2018-12-14T17:55:36Z\",\n \"updated_at\": \"2018-12-14T17:55:36Z\",\n \"phones\": {\n \"home_phone\": {\n \"country_code\": \"55\",\n \"number\": \"000000000\",\n \"area_code\": \"21\"\n },\n \"mobile_phone\": {\n \"country_code\": \"55\",\n \"number\": \"000000000\",\n \"area_code\": \"21\"\n }\n },\n \"metadata\": {\n \"company\": \"Avengers\"\n }\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"addr_GEjbAjaUK9h1PRLa"},"line_1":{"type":"string","example":"10882, Malibu Point, Central Malibu"},"street":{"type":"string","example":"Malibu Point"},"number":{"type":"string","example":"10882"},"zip_code":{"type":"string","example":"90265"},"neighborhood":{"type":"string","example":"Central Malibu"},"city":{"type":"string","example":"Malibu"},"state":{"type":"string","example":"CA"},"country":{"type":"string","example":"US"},"status":{"type":"string","example":"deleted"},"created_at":{"type":"string","example":"2018-12-14T18:57:18Z"},"updated_at":{"type":"string","example":"2018-12-14T18:58:36Z"},"deleted_at":{"type":"string","example":"2018-12-14T18:58:36Z"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_lMyKPqXiRhR8w9Dr"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"17cdffc1-d919-4530-9427-c82ba5b5c77f@avengers.com"},"document":{"type":"string","example":"93095135270"},"type":{"type":"string","example":"individual"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2018-12-14T17:55:36Z"},"updated_at":{"type":"string","example":"2018-12-14T17:55:36Z"},"phones":{"type":"object","properties":{"home_phone":{"type":"object","properties":{"country_code":{"type":"string","example":"55"},"number":{"type":"string","example":"000000000"},"area_code":{"type":"string","example":"21"}}},"mobile_phone":{"type":"object","properties":{"country_code":{"type":"string","example":"55"},"number":{"type":"string","example":"000000000"},"area_code":{"type":"string","example":"21"}}}}},"metadata":{"type":"object","properties":{"company":{"type":"string","example":"Avengers"}}}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Address not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Address not found."}}}}}}},"deprecated":false}},"/orders":{"post":{"summary":"Criar pedido com split","description":"Para realizar pedidos com split, você deve criar um objeto order com o objeto split. \nPara formar o objeto split, você deve primeiramente cadastrar recebedores. \nO objeto order com split possui os seguintes atributos:","operationId":"criar-pedido-com-split-1","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["items","payments"],"properties":{"code":{"type":"string","description":"Código identificador do pedido no sistema da loja. Max: 52 caracteres."},"items":{"type":"array","description":"Itens do pedido. [Saiba mais sobre itens do pedido](https://docs.pagar.me/reference/item-do-pedido-1)","items":{"properties":{"amount":{"type":"integer","description":"Valor unitário. Obrigatoriamente maior que zero.","format":"int32"},"description":{"type":"string","description":"Descrição do item."},"quantity":{"type":"integer","description":"Quantidade de itens.","format":"int32"},"code":{"type":"string","description":"Código do item no sistema da loja."}},"required":["code"],"type":"object"}},"customer_id":{"type":"string","description":"Código do cliente."},"customer":{"type":"object","description":"Dados do cliente. Obrigatório caso o **customer_id** não seja informado. [Saiba mais sobre clientes](https://docs.pagar.me/reference/clientes-1)","required":["name"],"properties":{"name":{"type":"string","description":"Nome do cliente. Max: 64 caracteres."},"type":{"type":"string","description":"Tipo de cliente. Valores possíveis: individual (pessoa física) ou company (pessoa jurídica). Obrigatório, caso o document seja enviado."},"email":{"type":"string","description":"E-mail do cliente. Max: 64 caracteres."},"code":{"type":"string","description":"Código de referência do cliente no sistema da loja. Max: 52 caracteres."},"document":{"type":"string","description":"CPF, CNPJ ou PASSAPORTE do cliente. Max: 16 caracteres para CPF e CNPJ e Max: 50 caracteres para PASSAPORTE."},"document_type":{"type":"string","description":"Tipo de documento. Valores possíveis: \"CPF\", \"CNPJ\" ou \"PASSPORT\"."},"gender":{"type":"string","description":"Sexo do cliente . Valores possíveis: male ou female."},"address":{"type":"object","description":"Endereço do cliente.","properties":{"country":{"type":"string","description":"País (Código do país no formato ISO 3166-1 alpha-2)(2 digitos)"},"state":{"type":"string","description":"Estado (Código do estado no formato ISO 3166-2)."},"city":{"type":"string","description":"Cidade."},"zip_code":{"type":"string","description":"Código Postal (CEP) (Apenas numérico)."},"line_1":{"type":"string","description":"Dados principais do endereço. Neste campo deve ser informado Número, Rua, Bairro, nesta ordem e separados por vírgula."},"line_2":{"type":"string","description":"Dados complementares do endereço. Neste campo pode ser informado complemento, referências."}}},"phones":{"type":"object","description":"Telefone residencial do cliente.","properties":{"home_phone":{"type":"object","description":"Telefone residencial do cliente.","properties":{"country_code":{"type":"string","description":"Código do País (Apenas numérico)."},"area_code":{"type":"string","description":"Código da área (Apenas numérico)."},"number":{"type":"string","description":"Número do telefone (Apenas numérico)."}}},"mobile_phone":{"type":"object","description":"Telefone celular do cliente.","properties":{"country_code":{"type":"string","description":"Código do País (Apenas numérico)."},"area_code":{"type":"string","description":"Código da área (Apenas numérico)."},"number":{"type":"string","description":"Número do telefone (Apenas numérico)."}}}}},"birthdate":{"type":"string","description":"Data de nascimento do cliente.","format":"date"},"metadata":{"type":"string","description":"Objeto chave/valor utilizado para armazenar informações adicionais sobre o cliente."}}},"shipping":{"type":"object","description":"Dados para entrega.","properties":{"amount":{"type":"integer","description":"Valor da entrega.","format":"int32"},"description":{"type":"string","description":"Descrição da entrega."},"recipient_name":{"type":"string","description":"Destinatário da entrega."},"recipient_phone":{"type":"string","description":"Telefone do destinatário."},"address":{"type":"object","description":"Endereço de entrega","properties":{"country":{"type":"string","description":"País (Código do país no formato ISO 3166-1 alpha-2)(2 digitos)"},"state":{"type":"string","description":"Estado (Código do estado no formato ISO 3166-2)."},"city":{"type":"string","description":"Cidade."},"zip_code":{"type":"string","description":"Código Postal (CEP) (Apenas numérico)."},"line_1":{"type":"string","description":"Dados principais do endereço. Neste campo deve ser informado Número, Rua, Bairro, nesta ordem e separados por vírgula."},"line_2":{"type":"string","description":"Dados complementares do endereço. Neste campo pode ser informado complemento, referências."}}}}},"payments":{"type":"array","description":"Lista de dados de pagamento. [Saiba mais sobre pagamentos.](https://docs.pagar.me/reference/vis%C3%A3o-geral-sobre-pagamento)","items":{"properties":{"payment_method":{"type":"string","description":"Meio de pagamento. Valores possíveis: credit_card, boleto, Pix, Debit Card"},"credit_card":{"type":"object","description":"Dados sobre o pagamento com cartão de crédito (obrigatório caso o payment_method seja credit_card).","properties":{"operation_type":{"type":"string","description":"Indica se a transação deve ser capturada \"auth_and_capture\", autorizada \"auth_only\", ou pré autorizada \"pre_auth\"."},"installments":{"type":"integer","description":"Quantidade de parcelas. Se a transação for uma recorrência, o número de parcelas deverá ser 1.","format":"int32"},"statement_descriptor":{"type":"string","description":"Texto exibido na fatura do cartão. Max: 22 caracteres para clientes Gateway; 13 para clientes PSP"},"card":{"type":"object","description":"Cartão de crédito.","required":["number","holder_name","exp_month","exp_year"],"properties":{"number":{"type":"string","description":"Número do cartão. Entre 13 e 19 caracteres"},"holder_name":{"type":"string","description":"Nome do portador como está impresso no cartão. Máximo de 64 caracteres (Caracteres especiais e números não são aceitos)"},"holder_document":{"type":"string","description":"CPF ou CNPJ do portador do cartão. Obrigatório caso o tipo do cartão seja voucher (bandeiras VR ou Pluxee)."},"exp_month":{"type":"integer","description":"Mês de validade do cartão. Valor entre 1 e 12 (inclusive)","format":"int32"},"exp_year":{"type":"integer","description":"Ano de validade do cartão. Formatos yy ou yyyy. Ex: 23 ou 2023.","format":"int32"},"cvv":{"type":"string","description":"Código de segurança do cartão. O campo aceita 4 ou 3 caracteres, variando por bandeira."},"brand":{"type":"string","description":"(Opcional) Bandeira do cartão. Para cartões de crédito, temos como valores possíveis: Elo, Mastercard, Visa, Amex, ou Hipercard. Para voucher, temos como valores possíveis: Alelo, Ticket, VR ou Pluxee."},"label":{"type":"string","description":"Indica a label do cartão"},"billing_address_id":{"type":"string","description":"Código do endereço de cobrança. Max: 36 caracteres.<>Opcional, pode ser utilizado no lugar do billing_address."},"billing_address":{"type":"object","properties":{"line_1":{"type":"string","description":"Linha 1 do endereço. (Número, Rua, e Bairro - Nesta ordem e separados por vírgula) Max: 256 caracteres."},"line_2":{"type":"string","description":"Linha 2 do endereço. (Complemento - Andar, Sala, Apto). Max: 128 caracteres."},"zip_code":{"type":"string","description":"CEP. Max: 16 caracteres."},"city":{"type":"string","description":"Cidade. Max: 64 caracteres."},"state":{"type":"string","description":"Código do estado no formato ISO 3166-2."},"country":{"type":"string","description":"Código do país no formato ISO 3166-1 alpha-2."}}}}},"network_token":{"type":"object","description":"Token de bandeira.","properties":{"number":{"type":"string","description":"Número do Network Token. Entre 13 e 19 caracteres. Ex: 4190000000000069"},"holder_name":{"type":"string","description":"Nome do portador como está impresso no cartão. Máximo de 64 caracteres (Caracteres especiais e números não são aceitos)"},"exp_month":{"type":"integer","description":"Mês de validade do Network Token. Valor entre 1 e 12 (inclusive)","format":"int32"},"exp_year":{"type":"integer","description":"Ano de validade do Network Token. Formatos yy ou yyyy. Ex: 23 ou 2023.","format":"int32"},"cryptograms":{"type":"string","description":"Criptograma de autenticação para Network Token. Pode enviar mais de um, caso queira em uma lista de strings. Formato em base64. Ex: ANfQt43bddROAAEnSAMhAAADFA===="}}},"card_id":{"type":"string","description":"identificador do cartão de um cliente."},"card_token":{"type":"string","description":"token do cartão gerado pelo checkout transparente"},"recurrence_cycle":{"type":"string","description":"Informa se o pedido é referente a uma recorrência externa. Possíveis valores: `first` ou `subsequent`."},"initiated_type":{"type":"string","description":"Identificador do tipo de transação avulsa. Valores possíveis: `partial_shipment` (Remessa Parcial), `related_or_delayed_charge` (Cobrança Atrasada), `no_show` (Multa) ou `retry` (Retentativa). Valores possíveis: `standing_order` (Ordem Permanente), `instalment` (Parcelamento) ou `subscription` (Assinatura convencional com valor e frequência fixa). [Mais detalhes](https://docs.pagar.me/page/mitcit-transa%C3%A7%C3%B5es-card-on-file-mastercard)."},"recurrence_model":{"type":"string","description":"Identificador do tipo de recorrência. Valores possíveis: `standing_order` (Ordem Permanente), `instalment` (Parcelamento) ou `subscription` (Assinatura convencional com valor e frequência fixa). Valores possíveis: `standing_order` (Ordem Permanente), `instalment` (Parcelamento) ou `subscription` (Assinatura convencional com valor e frequência fixa). [Mais detalhes](https://docs.pagar.me/page/mitcit-transa%C3%A7%C3%B5es-card-on-file-mastercard)."},"payment_origin":{"type":"object","description":"Identificador da primeira cobrança de uma recorrência. [Mais detalhes](https://docs.pagar.me/docs/api-v5-identificador-de-recorr%C3%AAncia-para-assinaturas-externas).","properties":{"charge_id":{"type":"string","description":"Identificador da cobrança"},"brand_id":{"type":"string","description":"Identificador da bandeira"}}}}},"boleto":{"type":"object","description":"Dados sobre o pagamento com boleto (obrigatório caso o payment_method seja boleto).","properties":{"bank":{"type":"string","description":"Código do banco. 001 (Banco do Brasil); 033 (Santander); 237 (Bradesco); 341 (Itau); 745 (Citibank) e 104 (Caixa Econômica Federal)."},"instructions":{"type":"string","description":"Instruções do boleto. Max: 256 caracteres."},"due_at":{"type":"string","description":"Data de vencimento. (Opcional)"},"nosso_numero":{"type":"string","description":"Número que identifica unicamente um boleto para uma conta."},"type":{"type":"string","description":"Tipo de espécie do boleto.DM (Duplicata Mercantil) e BDP (Boleto de proposta)"},"document_number":{"type":"string","description":"Identificador do boleto. Max: 16 caracteres."},"interest":{"type":"object","description":"Aplicação do juros sobre o boleto.","required":["days","type","amount"],"properties":{"days":{"type":"integer","description":"Dias após a expiração do boleto quando o juros deve ser cobrado.","format":"int32"},"type":{"type":"string","description":"Tipo de divisão. Os valores possíveis são flat ou percentage."},"amount":{"type":"string","description":"Valor em porcentagem ou em centavos da taxa de juros que será cobrada ao mês."}}},"fine":{"type":"object","description":"Aplicação da multa sobre o boleto.","required":["days","type","amount"],"properties":{"days":{"type":"integer","description":"Dias após a expiração do boleto quando a multa deve ser cobrada.","format":"int32"},"type":{"type":"string","description":"Tipo de divisão. Os valores possíveis são flat ou percentage."},"amount":{"type":"integer","description":"Valor em porcentagem ou em centavos que será cobrada na multa.","format":"int32"}}},"discount":{"type":"object","description":"Objeto raiz de desconto por antecipação. Exclusivo PSP.","properties":{"type":{"type":"string","description":"Tipo do desconto: \"percentage\" (% sobre o total) ou \"flat\" (centavos). Aplica-se a todas as regras do array."},"rules":{"type":"array","description":"Lista de regras de desconto ordenadas por limit_date crescente.","items":{"properties":{"limit_date":{"type":"string","description":"Data limite da regra. Formato YYYY-MM-DD. Deve ser anterior ao due_at do boleto."},"amount":{"type":"integer","description":"Valor do desconto. Se type: percentage: entre 0.01 e 100 (ex: 15.00 = 15%). Se type: flat: inteiro em centavos, mín. 1 (ex: 500 = R$5,00).","format":"int32"}},"type":"object"}}}}}},"debit_card":{"type":"object","description":"Dados sobre o pagamento com cartão de débito (obrigatório caso o payment_method seja debit_card).","properties":{"statement_descriptor":{"type":"string","description":"Texto exibido na fatura do cartão. Max: 22 caracteres."},"card":{"type":"object","required":["number","holder_name","exp_month","exp_year"],"properties":{"number":{"type":"string","description":"Número do cartão. Entre 13 e 19 caracteres"},"holder_name":{"type":"string","description":"Nome do portador como está impresso no cartão. Máximo de 64 caracteres (Caracteres especiais e números não são aceitos)"},"holder_document":{"type":"string","description":"CPF ou CNPJ do portador do cartão. Obrigatório caso o tipo do cartão seja voucher (bandeiras VR ou Pluxee)."},"exp_month":{"type":"integer","description":"Mês de validade do cartão. Valor entre 1 e 12 (inclusive)","format":"int32"},"exp_year":{"type":"integer","description":"Ano de validade do cartão. Formatos yy ou yyyy. Ex: 23 ou 2023.","format":"int32"},"cvv":{"type":"string","description":"Código de segurança do cartão. O campo aceita 4 ou 3 caracteres, variando por bandeira."},"brand":{"type":"string","description":"(Opcional) Bandeira do cartão. Para cartões de crédito, temos como valores possíveis: Elo, Mastercard, Visa, Amex, ou Hipercard. Para voucher, temos como valores possíveis: Alelo, Ticket, VR ou Pluxee."},"label":{"type":"string","description":"Indica a label do cartão"},"billing_address_id":{"type":"string","description":"Código do endereço de cobrança. Max: 36 caracteres.<>Opcional, pode ser utilizado no lugar do billing_address."},"billing_address":{"type":"object","properties":{"line_1":{"type":"string","description":"Linha 1 do endereço. (Número, Rua, e Bairro - Nesta ordem e separados por vírgula) Max: 256 caracteres."},"line_2":{"type":"string","description":"Linha 2 do endereço. (Complemento - Andar, Sala, Apto). Max: 128 caracteres."},"zip_code":{"type":"string","description":"CEP. Max: 16 caracteres."},"city":{"type":"string","description":"Cidade. Max: 64 caracteres."},"state":{"type":"string","description":"Código do estado no formato ISO 3166-2."},"country":{"type":"string","description":"Código do país no formato ISO 3166-1 alpha-2."}}}}},"card_id":{"type":"string","description":"identificador do cartão de um cliente."},"card_token":{"type":"string","description":"token do cartão gerado pelo checkout transparente"},"network_token":{"type":"object","description":"Token de bandeira.","properties":{"number":{"type":"string","description":"Número do Network Token. Entre 13 e 19 caracteres. Ex: 4190000000000069"},"holder_name":{"type":"string","description":"Nome do portador como está impresso no cartão. Máximo de 64 caracteres (Caracteres especiais e números não são aceitos)"},"exp_month":{"type":"integer","description":"Mês de validade do Network Token. Valor entre 1 e 12 (inclusive)","format":"int32"},"exp_year":{"type":"integer","description":"Ano de validade do Network Token. Formatos yy ou yyyy. Ex: 23 ou 2023.","format":"int32"},"cryptograms":{"type":"string","description":"Criptograma de autenticação para Network Token. Pode enviar mais de um, caso queira em uma lista de strings. Formato em base64. Ex: ANfQt43bddROAAEnSAMhAAADFA===="}}},"initiated_type":{"type":"string","description":"Identificador do tipo de transação avulsa. Valores possíveis: `partial_shipment` (Remessa Parcial), `related_or_delayed_charge` (Cobrança Atrasada), `no_show` (Multa) ou `retry` (Retentativa)."},"recurrence_model":{"type":"string","description":"Identificador do tipo de recorrência. Valores possíveis: `standing_order` (Ordem Permanente), `instalment` (Parcelamento) ou `subscription` (Assinatura convencional com valor e frequência fixa)."}}},"split":{"type":"array","description":"Dados para o split de pagamentos.","items":{"properties":{"amount":{"type":"integer","description":"Valor destinado ao recebedor.","format":"int32"},"recipient_id":{"type":"string","description":"Código do recebedor. Formato: rp_XXXXXXXXXXXXXXXX."},"type":{"type":"string","description":"Tipo de divisão. Os valores possíveis são flat ou percentage."},"options":{"type":"object","description":"Informações da responsabilidade do recebedor na transação.","properties":{"charge_processing_fee":{"type":"boolean","description":"Indica se o recebedor vinculado à regra será cobrado pelas taxas da transação"},"charge_remainder_fee":{"type":"boolean","description":"Indica se o recebedor vinculado à regra irá receber o restante dos recebíveis após uma divisão"},"liable":{"type":"boolean","description":"Indica se o recebedor é responsável pela transação em caso de chargeback."}}}},"type":"object"}}},"type":"object"}},"closed":{"type":"boolean","description":"Informa se o pedido será criado **aberto** ou **fechado**"},"metadata":{"type":"string","description":"Objeto chave/valor utilizado para armazenar informações adicionais sobre o pedido."}}},"examples":{"Request Example":{"value":{"items":[{"amount":100,"description":"Chaveiro do Tesseract","quantity":1,"code":"12345"}],"customer":{"name":"Tony Stark","email":"Tony@Avangers.com"},"payments":[{"payment_method":"credit_card","credit_card":{"installments":1,"statement_descriptor":"AVENGERS","card":{"number":"342793631858229","holder_name":"Tony Stark","exp_month":1,"exp_year":30,"cvv":"3531","billing_address":{"line_1":"10880, Malibu Point, Malibu Central","zip_code":"90265","city":"Malibu","state":"CA","country":"US"}}},"split":[{"amount":50,"recipient_id":"rp_5yGwpMGckBHVYmb6","type":"percentage","options":{"charge_processing_fee":true,"charge_remainder_fee":true,"liable":true}},{"amount":50,"type":"percentage","recipient_id":"rp_yLnAyVpHbQIqZxwO","options":{"charge_processing_fee":false,"charge_remainder_fee":false,"liable":false}}]}]}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"ch_NW0ABG5HQikn3Lv4\",\n \"code\": \"487FO9HYV3\",\n \"gateway_id\": \"3554818\",\n \"amount\": 100,\n \"paid_amount\": 100,\n \"status\": \"paid\",\n \"currency\": \"BRL\",\n \"payment_method\": \"credit_card\",\n \"paid_at\": \"2018-05-22T18:38:22Z\",\n \"created_at\": \"2018-05-22T18:38:08Z\",\n \"updated_at\": \"2018-05-22T18:38:08Z\",\n \"customer\": {\n \"id\": \"cus_dgLJ8jmURSe0DQ0N\",\n \"name\": \"Tony Stark\",\n \"email\": \"tony0@avengers.com\",\n \"delinquent\": false,\n \"created_at\": \"2018-05-22T18:38:06Z\",\n \"updated_at\": \"2018-05-22T18:38:06Z\",\n \"phones\": {}\n },\n \"last_transaction\": {\n \"id\": \"tran_1lLxVjc3JCXVxnED\",\n \"transaction_type\": \"credit_card\",\n \"gateway_id\": \"3554818\",\n \"amount\": 100,\n \"status\": \"captured\",\n \"success\": true,\n \"installments\": 1,\n \"statement_descriptor\": \"AVENGERS\",\n \"acquirer_name\": \"pagarme\",\n \"acquirer_tid\": \"3554818\",\n \"acquirer_nsu\": \"3554818\",\n \"acquirer_return_code\": \"0000\",\n \"operation_type\": \"auth_and_capture\",\n \"card\": {\n \"id\": \"card_nKojDZnNIjh9D5z1\",\n \"first_six_digits\": \"401118\",\n \"last_four_digits\": \"5580\",\n \"brand\": \"Visa\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 2030,\n \"status\": \"active\",\n \"created_at\": \"2018-05-22T18:38:11Z\",\n \"updated_at\": \"2018-05-22T18:38:11Z\",\n \"type\": \"credit\"\n },\n \"created_at\": \"2018-05-22T18:38:13Z\",\n \"updated_at\": \"2018-05-22T18:38:13Z\",\n \"gateway_response\": {\n \"code\": \"200\"\n },\n \"split\": [\n {\n \"id\": \"sr_1qeQrB3s1synMW45\",\n \"type\": \"percentage\",\n \"gateway_id\": \"sr_ck5gv9dr3005di96euc53hcsc\",\n \"amount\": 50,\n \"recipient\": {\n \"id\": \"rp_5yGwpMGckBHVYmb6\",\n \"name\": \"First recipient\",\n \"email\": \"first_recipient@pagar.me\",\n \"document\": \"12728994706\",\n \"description\": \"Descrição do recebedor 1\",\n \"type\": \"individual\",\n \"status\": \"active\",\n \"created_at\": \"2020-01-02T20:23:14Z\",\n \"updated_at\": \"2020-01-02T20:23:14Z\"\n },\n \"options\": {\n \"liable\": true,\n \"charge_processing_fee\": true,\n \"charge_remainder_fee\": true\n }\n },\n {\n \"id\": \"sr_nmywGvbhalUnMVGd\",\n \"type\": \"percentage\",\n \"gateway_id\": \"sr_ck5gv9dr4005ei96emuw9z1hc\",\n \"amount\": 50,\n \"recipient\": {\n \"id\": \"rp_yLnAyVpHbQIqZxwO\",\n \"name\": \"Second recipient\",\n \"email\": \"second_recipient@pagar.me\",\n \"document\": \"15313587000166\",\n \"description\": \"Descrição do recebedor 2\",\n \"type\": \"company\",\n \"status\": \"active\",\n \"created_at\": \"2020-01-02T20:23:17Z\",\n \"updated_at\": \"2020-01-02T20:23:17Z\"\n },\n \"options\": {\n \"liable\": false,\n \"charge_processing_fee\": false,\n \"charge_remainder_fee\": false\n }\n }\n ]\n },\n \"metadata\": {\n \"code\": \"123\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"ch_NW0ABG5HQikn3Lv4"},"code":{"type":"string","example":"487FO9HYV3"},"gateway_id":{"type":"string","example":"3554818"},"amount":{"type":"integer","example":100,"default":0},"paid_amount":{"type":"integer","example":100,"default":0},"status":{"type":"string","example":"paid"},"currency":{"type":"string","example":"BRL"},"payment_method":{"type":"string","example":"credit_card"},"paid_at":{"type":"string","example":"2018-05-22T18:38:22Z"},"created_at":{"type":"string","example":"2018-05-22T18:38:08Z"},"updated_at":{"type":"string","example":"2018-05-22T18:38:08Z"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_dgLJ8jmURSe0DQ0N"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"tony0@avengers.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2018-05-22T18:38:06Z"},"updated_at":{"type":"string","example":"2018-05-22T18:38:06Z"},"phones":{"type":"object","properties":{}}}},"last_transaction":{"type":"object","properties":{"id":{"type":"string","example":"tran_1lLxVjc3JCXVxnED"},"transaction_type":{"type":"string","example":"credit_card"},"gateway_id":{"type":"string","example":"3554818"},"amount":{"type":"integer","example":100,"default":0},"status":{"type":"string","example":"captured"},"success":{"type":"boolean","example":true,"default":true},"installments":{"type":"integer","example":1,"default":0},"statement_descriptor":{"type":"string","example":"AVENGERS"},"acquirer_name":{"type":"string","example":"pagarme"},"acquirer_tid":{"type":"string","example":"3554818"},"acquirer_nsu":{"type":"string","example":"3554818"},"acquirer_return_code":{"type":"string","example":"0000"},"operation_type":{"type":"string","example":"auth_and_capture"},"card":{"type":"object","properties":{"id":{"type":"string","example":"card_nKojDZnNIjh9D5z1"},"first_six_digits":{"type":"string","example":"401118"},"last_four_digits":{"type":"string","example":"5580"},"brand":{"type":"string","example":"Visa"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":2030,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2018-05-22T18:38:11Z"},"updated_at":{"type":"string","example":"2018-05-22T18:38:11Z"},"type":{"type":"string","example":"credit"}}},"created_at":{"type":"string","example":"2018-05-22T18:38:13Z"},"updated_at":{"type":"string","example":"2018-05-22T18:38:13Z"},"gateway_response":{"type":"object","properties":{"code":{"type":"string","example":"200"}}},"split":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"sr_1qeQrB3s1synMW45"},"type":{"type":"string","example":"percentage"},"gateway_id":{"type":"string","example":"sr_ck5gv9dr3005di96euc53hcsc"},"amount":{"type":"integer","example":50,"default":0},"recipient":{"type":"object","properties":{"id":{"type":"string","example":"rp_5yGwpMGckBHVYmb6"},"name":{"type":"string","example":"First recipient"},"email":{"type":"string","example":"first_recipient@pagar.me"},"document":{"type":"string","example":"12728994706"},"description":{"type":"string","example":"Descrição do recebedor 1"},"type":{"type":"string","example":"individual"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2020-01-02T20:23:14Z"},"updated_at":{"type":"string","example":"2020-01-02T20:23:14Z"}}},"options":{"type":"object","properties":{"liable":{"type":"boolean","example":true,"default":true},"charge_processing_fee":{"type":"boolean","example":true,"default":true},"charge_remainder_fee":{"type":"boolean","example":true,"default":true}}}}}}}},"metadata":{"type":"object","properties":{"code":{"type":"string","example":"123"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"get":{"summary":"Listar pedidos","description":"","operationId":"listar-pedidos","parameters":[{"name":"code","in":"query","description":"Código de referência do pedido no sistema da loja.","schema":{"type":"string"}},{"name":"status","in":"query","description":"Status do pedido. Valores possíveis: **pending**, **paid**, **canceled** ou **failed**","schema":{"type":"string"}},{"name":"customer_id","in":"query","description":"Código do cliente.","schema":{"type":"string"}},{"name":"created_since","in":"query","description":"Data de início do período de criação a ser listado.","schema":{"type":"string","format":"date"}},{"name":"created_until","in":"query","description":"Data de final do período de criação a ser listado.","schema":{"type":"string","format":"date"}},{"name":"page","in":"query","description":"Página atual.","schema":{"type":"integer","format":"int32","default":1}},{"name":"size","in":"query","description":"Quantidade de itens.","schema":{"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"data\": [\n {\n \"id\": \"or_28dN9w7CLU79kDjL\",\n \"code\": \"62LVFN7I4R\",\n \"amount\": 2990,\n \"currency\": \"BRL\",\n \"closed\": true,\n \"items\": [\n {\n \"id\": \"oi_d478RMAS3bC74PrL\",\n \"description\": \"Chaveiro do Tesseract\",\n \"amount\": 2990,\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-04-19T16:01:09Z\",\n \"updated_at\": \"2017-04-19T16:01:09Z\"\n }\n ],\n \"customer\": {\n \"id\": \"cus_eaEXlZvhBfeGlDOm\",\n \"name\": \"Tony Stark\",\n \"email\": \"f1492621-4f39-45f7-adfb-82a373a0a85c@avengers.com\",\n \"delinquent\": false,\n \"created_at\": \"2017-04-19T16:01:09Z\",\n \"updated_at\": \"2017-04-19T16:01:09Z\"\n },\n \"status\": \"paid\",\n \"created_at\": \"2017-04-19T16:01:09Z\",\n \"updated_at\": \"2017-04-19T16:01:11Z\",\n \"closed_at\": \"2017-04-19T16:01:11Z\",\n \"charges\": [\n {\n \"id\": \"ch_gmnW101c9YTvQVLB\",\n \"code\": \"62LVFN7I4R\",\n \"gateway_id\": \"ef5e977b-93d2-485a-b15d-36e5eb3d8cf5\",\n \"amount\": 2990,\n \"status\": \"paid\",\n \"currency\": \"BRL\",\n \"payment_method\": \"credit_card\",\n \"paid_at\": \"2017-04-19T16:01:11Z\",\n \"created_at\": \"2017-04-19T16:01:09Z\",\n \"updated_at\": \"2017-04-19T16:01:09Z\",\n \"customer\": {\n \"id\": \"cus_eaEXlZvhBfeGlDOm\",\n \"name\": \"Tony Stark\",\n \"email\": \"f1492621-4f39-45f7-adfb-82a373a0a85c@avengers.com\",\n \"delinquent\": false,\n \"created_at\": \"2017-04-19T16:01:09Z\",\n \"updated_at\": \"2017-04-19T16:01:09Z\"\n }\n }\n ]\n },\n {\n \"id\": \"or_dW6vZoJfLhw3Rb10\",\n \"code\": \"65JGU05FX0\",\n \"amount\": 2990,\n \"currency\": \"BRL\",\n \"closed\": true,\n \"items\": [\n {\n \"id\": \"oi_zYGxV8rU36HPWQMg\",\n \"description\": \"Chaveiro do Tesseract\",\n \"amount\": 2990,\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-04-19T15:58:23Z\",\n \"updated_at\": \"2017-04-19T15:58:23Z\"\n }\n ],\n \"customer\": {\n \"id\": \"cus_rG3592i17uQgxK2Q\",\n \"name\": \"Tony Stark\",\n \"email\": \"5d76b138-2963-40f7-ba71-c9ae2cc65518@avengers.com\",\n \"delinquent\": false,\n \"created_at\": \"2017-04-19T15:58:23Z\",\n \"updated_at\": \"2017-04-19T15:58:23Z\"\n },\n \"status\": \"failed\",\n \"created_at\": \"2017-04-19T15:58:23Z\",\n \"updated_at\": \"2017-04-19T15:58:24Z\",\n \"closed_at\": \"2017-04-19T15:58:24Z\",\n \"charges\": [\n {\n \"id\": \"ch_nM5PkjcyLUa6Nr1w\",\n \"code\": \"65JGU05FX0\",\n \"amount\": 2990,\n \"status\": \"failed\",\n \"currency\": \"BRL\",\n \"payment_method\": \"credit_card\",\n \"created_at\": \"2017-04-19T15:58:23Z\",\n \"updated_at\": \"2017-04-19T15:58:24Z\",\n \"customer\": {\n \"id\": \"cus_rG3592i17uQgxK2Q\",\n \"name\": \"Tony Stark\",\n \"email\": \"5d76b138-2963-40f7-ba71-c9ae2cc65518@avengers.com\",\n \"delinquent\": false,\n \"created_at\": \"2017-04-19T15:58:23Z\",\n \"updated_at\": \"2017-04-19T15:58:23Z\"\n }\n }\n ]\n }\n ],\n \"paging\": {\n \"total\": 406,\n \"next\": \"https://api.stone.com.br/core/v1/orders?page=2&size=2\"\n }\n}"}},"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"or_28dN9w7CLU79kDjL"},"code":{"type":"string","example":"62LVFN7I4R"},"amount":{"type":"integer","example":2990,"default":0},"currency":{"type":"string","example":"BRL"},"closed":{"type":"boolean","example":true,"default":true},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"oi_d478RMAS3bC74PrL"},"description":{"type":"string","example":"Chaveiro do Tesseract"},"amount":{"type":"integer","example":2990,"default":0},"quantity":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-19T16:01:09Z"},"updated_at":{"type":"string","example":"2017-04-19T16:01:09Z"}}}},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_eaEXlZvhBfeGlDOm"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"f1492621-4f39-45f7-adfb-82a373a0a85c@avengers.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2017-04-19T16:01:09Z"},"updated_at":{"type":"string","example":"2017-04-19T16:01:09Z"}}},"status":{"type":"string","example":"paid"},"created_at":{"type":"string","example":"2017-04-19T16:01:09Z"},"updated_at":{"type":"string","example":"2017-04-19T16:01:11Z"},"closed_at":{"type":"string","example":"2017-04-19T16:01:11Z"},"charges":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"ch_gmnW101c9YTvQVLB"},"code":{"type":"string","example":"62LVFN7I4R"},"gateway_id":{"type":"string","example":"ef5e977b-93d2-485a-b15d-36e5eb3d8cf5"},"amount":{"type":"integer","example":2990,"default":0},"status":{"type":"string","example":"paid"},"currency":{"type":"string","example":"BRL"},"payment_method":{"type":"string","example":"credit_card"},"paid_at":{"type":"string","example":"2017-04-19T16:01:11Z"},"created_at":{"type":"string","example":"2017-04-19T16:01:09Z"},"updated_at":{"type":"string","example":"2017-04-19T16:01:09Z"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_eaEXlZvhBfeGlDOm"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"f1492621-4f39-45f7-adfb-82a373a0a85c@avengers.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2017-04-19T16:01:09Z"},"updated_at":{"type":"string","example":"2017-04-19T16:01:09Z"}}}}}}}}},"paging":{"type":"object","properties":{"total":{"type":"integer","example":406,"default":0},"next":{"type":"string","example":"https://api.stone.com.br/core/v1/orders?page=2&size=2"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/charges":{"post":{"summary":"Incluir cobrança no pedido","description":"Enquanto um pedido estiver **aberto**, é possível adicionar novas cobranças utilizando o `order_id` na criação de uma cobrança.","operationId":"incluir-cobrança-no-pedido","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["order_id","amount","payment"],"properties":{"order_id":{"type":"string","description":"Código do pedido"},"amount":{"type":"integer","description":"Valor da cobrança em centavos","format":"int32"},"payment":{"type":"object","description":"Dados sobre pagamento.","properties":{"payment_method":{"type":"string","description":"Meio de pagamento. Valores possíveis: credit_card, boleto, voucher, bank_transfer, safety_pay, cash, pix","default":"credit_card"},"credit_card":{"type":"object","description":"Dados sobre o pagamento com cartão de crédito (obrigatório caso o payment_method seja credit_card)","properties":{"operation_type":{"type":"string","description":"Indica se a transação deve ser capturada \"auth_and_capture\", autorizada \"auth_only\", ou pré autorizada \"pre_auth\"."},"installments":{"type":"integer","description":"Quantidade de parcelas. Se a transação for uma recorrência, o número de parcelas deverá ser 1.","format":"int32"},"statement_descriptor":{"type":"string","description":"Texto exibido na fatura do cartão. Max: 22 caracteres para clientes Gateway; 13 para clientes PSP"},"card":{"type":"object","description":"Cartão de crédito.","required":["number","holder_name","exp_month","exp_year"],"properties":{"number":{"type":"string","description":"Número do cartão. Entre 13 e 19 caracteres"},"holder_name":{"type":"string","description":"Nome do portador como está impresso no cartão. Máximo de 64 caracteres (Caracteres especiais e números não são aceitos)"},"holder_document":{"type":"string","description":"CPF ou CNPJ do portador do cartão. Obrigatório caso o tipo do cartão seja voucher (bandeiras VR ou Pluxee)."},"exp_month":{"type":"integer","description":"Mês de validade do cartão. Valor entre 1 e 12 (inclusive)","format":"int32"},"exp_year":{"type":"integer","description":"Ano de validade do cartão. Formatos yy ou yyyy. Ex: 23 ou 2023.","format":"int32"},"cvv":{"type":"string","description":"Código de segurança do cartão. O campo aceita 4 ou 3 caracteres, variando por bandeira."},"brand":{"type":"string","description":"(Opcional) Bandeira do cartão. Para cartões de crédito, temos como valores possíveis: Elo, Mastercard, Visa, Amex, ou Hipercard. Para voucher, temos como valores possíveis: Alelo, Ticket, VR ou Pluxee."},"label":{"type":"string","description":"Indica a label do cartão"},"billing_address_id":{"type":"string","description":"Código do endereço de cobrança. Max: 36 caracteres.<>Opcional, pode ser utilizado no lugar do billing_address."},"billing_address":{"type":"object","properties":{"line_1":{"type":"string","description":"Linha 1 do endereço. (Número, Rua, e Bairro - Nesta ordem e separados por vírgula) Max: 256 caracteres."},"line_2":{"type":"string","description":"Linha 2 do endereço. (Complemento - Andar, Sala, Apto). Max: 128 caracteres."},"zip_code":{"type":"string","description":"CEP. Max: 16 caracteres."},"city":{"type":"string","description":"Cidade. Max: 64 caracteres."},"state":{"type":"string","description":"Código do estado no formato ISO 3166-2."},"country":{"type":"string","description":"Código do país no formato ISO 3166-1 alpha-2."}}}}},"network_token":{"type":"object","description":"Token de bandeira.","properties":{"number":{"type":"string","description":"Número do Network Token. Entre 13 e 19 caracteres. Ex: 4190000000000069"},"holder_name":{"type":"string","description":"Nome do portador como está impresso no cartão. Máximo de 64 caracteres (Caracteres especiais e números não são aceitos)"},"exp_month":{"type":"integer","description":"Mês de validade do Network Token. Valor entre 1 e 12 (inclusive)","format":"int32"},"exp_year":{"type":"integer","description":"Ano de validade do Network Token. Formatos yy ou yyyy. Ex: 23 ou 2023.","format":"int32"},"cryptograms":{"type":"string","description":"Criptograma de autenticação para Network Token. Pode enviar mais de um, caso queira em uma lista de strings. Formato em base64. Ex: ANfQt43bddROAAEnSAMhAAADFA===="}}},"card_id":{"type":"string","description":"identificador do cartão de um cliente."},"card_token":{"type":"string","description":"token do cartão gerado pelo checkout transparente"},"recurrence_cycle":{"type":"string","description":"Informa se o pedido é referente a uma recorrência externa. Possíveis valores: `first` ou `subsequent`."},"initiated_type":{"type":"string","description":"Identificador do tipo de transação avulsa. Valores possíveis: `partial_shipment` (Remessa Parcial), `related_or_delayed_charge` (Cobrança Atrasada), `no_show` (Multa) ou `retry` (Retentativa). Valores possíveis: `standing_order` (Ordem Permanente), `instalment` (Parcelamento) ou `subscription` (Assinatura convencional com valor e frequência fixa). [Mais detalhes](https://docs.pagar.me/page/mitcit-transa%C3%A7%C3%B5es-card-on-file-mastercard)."},"recurrence_model":{"type":"string","description":"Identificador do tipo de recorrência. Valores possíveis: `standing_order` (Ordem Permanente), `instalment` (Parcelamento) ou `subscription` (Assinatura convencional com valor e frequência fixa). Valores possíveis: `standing_order` (Ordem Permanente), `instalment` (Parcelamento) ou `subscription` (Assinatura convencional com valor e frequência fixa). [Mais detalhes](https://docs.pagar.me/page/mitcit-transa%C3%A7%C3%B5es-card-on-file-mastercard)."},"payment_origin":{"type":"object","description":"Identificador da primeira cobrança de uma recorrência. [Mais detalhes](https://docs.pagar.me/docs/api-v5-identificador-de-recorr%C3%AAncia-para-assinaturas-externas).","properties":{"charge_id":{"type":"string","description":"Identificador da cobrança"},"brand_id":{"type":"string","description":"Identificador da bandeira"}}}}},"voucher":{"type":"object","description":"Dados sobre o pagamento com voucher (obrigatório caso o payment_method seja voucher)","properties":{"statement_descriptor":{"type":"string","description":"Texto exibido na fatura do cartão. Max: 22 caracteres."},"card":{"type":"object","description":"Cartão voucher.","required":["number","holder_name","exp_month","exp_year"],"properties":{"number":{"type":"string","description":"Número do cartão. Entre 13 e 19 caracteres"},"holder_name":{"type":"string","description":"Nome do portador como está impresso no cartão. Máximo de 64 caracteres (Caracteres especiais e números não são aceitos)"},"holder_document":{"type":"string","description":"CPF ou CNPJ do portador do cartão. Obrigatório caso o tipo do cartão seja voucher (bandeiras VR ou Pluxee)."},"exp_month":{"type":"integer","description":"Mês de validade do cartão. Valor entre 1 e 12 (inclusive)","format":"int32"},"exp_year":{"type":"integer","description":"Ano de validade do cartão. Formatos yy ou yyyy. Ex: 23 ou 2023.","format":"int32"},"cvv":{"type":"string","description":"Código de segurança do cartão. O campo aceita 4 ou 3 caracteres, variando por bandeira."},"brand":{"type":"string","description":"(Opcional) Bandeira do cartão. Para cartões de crédito, temos como valores possíveis: Elo, Mastercard, Visa, Amex, ou Hipercard. Para voucher, temos como valores possíveis: Alelo, Ticket, VR ou Pluxee."},"label":{"type":"string","description":"Indica a label do cartão"},"billing_address_id":{"type":"string","description":"Código do endereço de cobrança. Max: 36 caracteres.<>Opcional, pode ser utilizado no lugar do billing_address."},"billing_address":{"type":"object","properties":{"line_1":{"type":"string","description":"Linha 1 do endereço. (Número, Rua, e Bairro - Nesta ordem e separados por vírgula) Max: 256 caracteres."},"line_2":{"type":"string","description":"Linha 2 do endereço. (Complemento - Andar, Sala, Apto). Max: 128 caracteres."},"zip_code":{"type":"string","description":"CEP. Max: 16 caracteres."},"city":{"type":"string","description":"Cidade. Max: 64 caracteres."},"state":{"type":"string","description":"Código do estado no formato ISO 3166-2."},"country":{"type":"string","description":"Código do país no formato ISO 3166-1 alpha-2."}}}}},"card_id":{"type":"string","description":"identificador do cartão de um cliente"},"card_token":{"type":"string","description":"token do cartão gerado pelo checkout transparente"},"card.holder_document":{"type":"string","description":"Número do documento do portador do cartão. Este campo deverá ser enviado dentro do objeto card e é obrigatório para voucher."}}},"boleto":{"type":"object","description":"Dados sobre o pagamento com boleto (obrigatório caso o payment_method seja boleto).","properties":{"bank":{"type":"string","description":"Código do banco. 001 (Banco do Brasil); 033 (Santander); 237 (Bradesco); 341 (Itau); 745 (Citibank) e 104 (Caixa Econômica Federal)."},"instructions":{"type":"string","description":"Instruções do boleto. Max: 256 caracteres."},"due_at":{"type":"string","description":"Data de vencimento. (Opcional)"},"nosso_numero":{"type":"string","description":"Número que identifica unicamente um boleto para uma conta."},"type":{"type":"string","description":"Tipo de espécie do boleto.DM (Duplicata Mercantil) e BDP (Boleto de proposta)"},"document_number":{"type":"string","description":"Identificador do boleto. Max: 16 caracteres."},"interest":{"type":"object","description":"Aplicação do juros sobre o boleto.","required":["days","type","amount"],"properties":{"days":{"type":"integer","description":"Dias após a expiração do boleto quando o juros deve ser cobrado.","format":"int32"},"type":{"type":"string","description":"Tipo de divisão. Os valores possíveis são flat ou percentage."},"amount":{"type":"string","description":"Valor em porcentagem ou em centavos da taxa de juros que será cobrada ao mês."}}},"fine":{"type":"object","description":"Aplicação da multa sobre o boleto.","required":["days","type","amount"],"properties":{"days":{"type":"integer","description":"Dias após a expiração do boleto quando a multa deve ser cobrada.","format":"int32"},"type":{"type":"string","description":"Tipo de divisão. Os valores possíveis são flat ou percentage."},"amount":{"type":"integer","description":"Valor em porcentagem ou em centavos que será cobrada na multa.","format":"int32"}}},"discount":{"type":"object","description":"Objeto raiz de desconto por antecipação. Exclusivo PSP.","properties":{"type":{"type":"string","description":"Tipo do desconto: \"percentage\" (% sobre o total) ou \"flat\" (centavos). Aplica-se a todas as regras do array."},"rules":{"type":"array","description":"Lista de regras de desconto ordenadas por limit_date crescente.","items":{"properties":{"limit_date":{"type":"string","description":"Data limite da regra. Formato YYYY-MM-DD. Deve ser anterior ao due_at do boleto."},"amount":{"type":"integer","description":"Valor do desconto. Se type: percentage: entre 0.01 e 100 (ex: 15.00 = 15%). Se type: flat: inteiro em centavos, mín. 1 (ex: 500 = R$5,00).","format":"int32"}},"type":"object"}}}}}},"bank_transfer":{"type":"object","description":"Dados sobre o pagamento com transferência entre contas bancárias. (obrigatório caso o payment_method seja bank_transfer)","properties":{"bank":{"type":"string","description":"Código do Banco. 001 (Banco do Brasil); 237 (Bradesco) e 341 (Itau)."}}},"Pix":{"type":"object","description":"Dados sobre o pagamento com pix (obrigatório caso o payment_method seja pix)","properties":{"expires_in":{"type":"integer","description":"Data de expiração do Pix em segundos.","format":"int32"},"expires_at":{"type":"string","description":"Data de expiração do Pix. (Opcional | Mandatório caso não enviado o expires_in) [Formato: YYYY-MM-DDThh:mm:ss] UTC","format":"date"},"additional_information":{"type":"object","description":"Objeto chave/valor utilizado para adicionar informações sobre o pagamento. Esses dados serão visíveis para o consumidor na hora do pagamento.","properties":{"Name":{"type":"string","description":"Nome utilizado para adicionar informações sobre o pagamento."},"Value":{"type":"string","description":"Valor utilizado para adicionar informações sobre o pagamento."}}}}},"amount":{"type":"integer","description":"Valor da cobrança em centavos","format":"int32"},"split":{"type":"array","items":{"properties":{"amount":{"type":"integer","description":"Valor destinado ao recebedor.","format":"int32"},"recipient_id":{"type":"string","description":"Código do recebedor. Formato: rp_XXXXXXXXXXXXXXXX."},"type":{"type":"string","description":"Tipo de divisão. Os valores possíveis são flat ou percentage."},"options":{"type":"object","description":"Informações da responsabilidade do recebedor na transação.","properties":{"charge_processing_fee":{"type":"boolean","description":"Indica se o recebedor vinculado à regra será cobrado pelas taxas da transação"},"charge_remainder_fee":{"type":"boolean","description":"Indica se o recebedor vinculado à regra irá receber o restante dos recebíveis após uma divisão"},"liable":{"type":"boolean","description":"Indica se o recebedor é responsável pela transação em caso de chargeback."}}}},"type":"object"}},"cash":{"type":"object","description":"Dados sobre o pagamento com cash(obrigatório caso o payment_method seja cash).","properties":{"description":{"type":"string","description":"Descrição do pagamento. Max: 256 caracteres."},"confirm":{"type":"boolean","description":"Indica se o pagamento será confirmado no ato da criação da cobrança ou se deve ser confirmado posteriormente."},"":{"type":"string"}}}}},"due_at":{"type":"string","description":"Data de vencimento da cobrança.","format":"date"},"customer_id":{"type":"string","description":"Código do cliente."},"customer":{"type":"object","description":"Dados do cliente. Se nem o **customer_id** nem o **customer** forem informados, será considerado o mesmo cliente do pedido.","properties":{}},"metadata":{"type":"string","description":"Objeto chave/valor utilizado para armazenar informações adicionais sobre a cobrança."}}},"examples":{"Request Example":{"value":{"order_id":"or_gnvV6V1VTgspL4JB","amount":2990,"payment":{"payment_method":"credit_card","credit_card":{"installments":1,"statement_descriptor":"AVENGERS","card":{"number":"342793631858229","holder_name":"Tony Stark","exp_month":1,"exp_year":30,"cvv":"3531","billing_address":{"zip_code":"90265","city":"Malibu","state":"CA","country":"US","line_1":"10880, Malibu Point, Malibu Central"}}}}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"ch_xyRZw5XCLhl3ENjP\",\n \"code\": \"LM4AVYSYQ9\",\n \"gateway_id\": \"769e2123-a634-46dc-8bba-529bba7fb726\",\n \"amount\": 2990,\n \"status\": \"paid\",\n \"currency\": \"BRL\",\n \"payment_method\": \"credit_card\",\n \"due_at\": \"2017-04-05T00:00:00\",\n \"paid_at\": \"2017-04-05T05:51:44\",\n \"created_at\": \"2017-04-05T05:51:37\",\n \"updated_at\": \"2017-04-05T05:51:37\",\n \"order\": {\n \"id\": \"or_gnvV6V1VTgspL4JB\",\n \"code\": \"MW6JTXGA2V\",\n \"amount\": 2990,\n \"currency\": \"BRL\",\n \"closed\": false,\n \"status\": \"pending\",\n \"created_at\": \"2017-04-05T05:51:09\",\n \"updated_at\": \"2017-04-05T05:51:09\"\n },\n \"customer\": {\n \"id\": \"cus_o9m12XMfrWtYKdLM\",\n \"name\": \"Tony Stark\",\n \"email\": \"e44655d3-455a-47bd-a86b-4f537aad95b5@avengers.com\",\n \"delinquent\": false,\n \"created_at\": \"2017-04-05T05:51:09\",\n \"updated_at\": \"2017-04-05T05:51:09\"\n },\n \"last_transaction\": {\n \"id\": \"tran_Bo9LkGUjjiBXLpWk\",\n \"transaction_type\": \"credit_card\",\n \"funding_source\": \"prepaid\",\n \"gateway_id\": \"3b0764c0-6940-4961-bac1-db5be550448a\",\n \"amount\": 2990,\n \"status\": \"captured\",\n \"success\": true,\n \"installments\": 1,\n \"statement_descriptor\": \"AVENGERS\",\n \"acquirer_name\": \"simulator\",\n \"acquirer_affiliation_code\": \"12345\",\n \"acquirer_tid\": \"270896\",\n \"acquirer_nsu\": \"813228\",\n \"acquirer_auth_code\": \"984353\",\n \"acquirer_message\": \"Pagarme|Transação autorizada com sucesso\",\n \"acquirer_return_code\": \"0\",\n \"operation_type\": \"auth_and_capture\",\n \"credit_card\": {\n \"id\": \"card_09eV0PrfQKClNVOd\",\n \"last_four_digits\": \"8229\",\n \"brand\": \"Amex\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 2030,\n \"status\": \"active\",\n \"created_at\": \"2017-04-05T05:51:37\",\n \"updated_at\": \"2017-04-05T05:51:37\",\n \"billing_address\": {\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"line_1\": \"10880, Malibu Point, Malibu Central\"\n }\n },\n \"created_at\": \"2017-04-05T05:51:37\",\n \"updated_at\": \"2017-04-05T05:51:37\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"ch_xyRZw5XCLhl3ENjP"},"code":{"type":"string","example":"LM4AVYSYQ9"},"gateway_id":{"type":"string","example":"769e2123-a634-46dc-8bba-529bba7fb726"},"amount":{"type":"integer","example":2990,"default":0},"status":{"type":"string","example":"paid"},"currency":{"type":"string","example":"BRL"},"payment_method":{"type":"string","example":"credit_card"},"due_at":{"type":"string","example":"2017-04-05T00:00:00"},"paid_at":{"type":"string","example":"2017-04-05T05:51:44"},"created_at":{"type":"string","example":"2017-04-05T05:51:37"},"updated_at":{"type":"string","example":"2017-04-05T05:51:37"},"order":{"type":"object","properties":{"id":{"type":"string","example":"or_gnvV6V1VTgspL4JB"},"code":{"type":"string","example":"MW6JTXGA2V"},"amount":{"type":"integer","example":2990,"default":0},"currency":{"type":"string","example":"BRL"},"closed":{"type":"boolean","example":false,"default":true},"status":{"type":"string","example":"pending"},"created_at":{"type":"string","example":"2017-04-05T05:51:09"},"updated_at":{"type":"string","example":"2017-04-05T05:51:09"}}},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_o9m12XMfrWtYKdLM"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"e44655d3-455a-47bd-a86b-4f537aad95b5@avengers.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2017-04-05T05:51:09"},"updated_at":{"type":"string","example":"2017-04-05T05:51:09"}}},"last_transaction":{"type":"object","properties":{"id":{"type":"string","example":"tran_Bo9LkGUjjiBXLpWk"},"transaction_type":{"type":"string","example":"credit_card"},"funding_source":{"type":"string","example":"prepaid"},"gateway_id":{"type":"string","example":"3b0764c0-6940-4961-bac1-db5be550448a"},"amount":{"type":"integer","example":2990,"default":0},"status":{"type":"string","example":"captured"},"success":{"type":"boolean","example":true,"default":true},"installments":{"type":"integer","example":1,"default":0},"statement_descriptor":{"type":"string","example":"AVENGERS"},"acquirer_name":{"type":"string","example":"simulator"},"acquirer_affiliation_code":{"type":"string","example":"12345"},"acquirer_tid":{"type":"string","example":"270896"},"acquirer_nsu":{"type":"string","example":"813228"},"acquirer_auth_code":{"type":"string","example":"984353"},"acquirer_message":{"type":"string","example":"Pagarme|Transação autorizada com sucesso"},"acquirer_return_code":{"type":"string","example":"0"},"operation_type":{"type":"string","example":"auth_and_capture"},"credit_card":{"type":"object","properties":{"id":{"type":"string","example":"card_09eV0PrfQKClNVOd"},"last_four_digits":{"type":"string","example":"8229"},"brand":{"type":"string","example":"Amex"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":2030,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-05T05:51:37"},"updated_at":{"type":"string","example":"2017-04-05T05:51:37"},"billing_address":{"type":"object","properties":{"zip_code":{"type":"string","example":"90265"},"city":{"type":"string","example":"Malibu"},"state":{"type":"string","example":"CA"},"country":{"type":"string","example":"US"},"line_1":{"type":"string","example":"10880, Malibu Point, Malibu Central"}}}}},"created_at":{"type":"string","example":"2017-04-05T05:51:37"},"updated_at":{"type":"string","example":"2017-04-05T05:51:37"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"get":{"summary":"Listar cobranças","description":"","operationId":"listar-cobranças","parameters":[{"name":"code","in":"query","description":"Código de referência da cobrança no sistema da loja","schema":{"type":"string"}},{"name":"status","in":"query","description":"Status da cobrança. Valores possíveis: **pending**, **paid**, **canceled**, **processing**, **failed**, **overpaid** ou **underpaid**","schema":{"type":"string"}},{"name":"payment_method","in":"query","description":"Meio de pagamento. Valores possíveis: **credit_card**, **boleto**, **bank_transfer**, **safetypay** ou **voucher**","schema":{"type":"string"}},{"name":"customer_id","in":"query","description":"Código do cliente.","schema":{"type":"string"}},{"name":"order_id","in":"query","description":"Código do pedido.","schema":{"type":"string"}},{"name":"created_since","in":"query","description":"Data de início do período de criação a ser listado.","schema":{"type":"string"}},{"name":"created_until","in":"query","description":"Data de final do período de criação a ser listado.","schema":{"type":"string","format":"date"}},{"name":"page","in":"query","description":"Página atual.","schema":{"type":"integer","format":"int32","default":1}},{"name":"size","in":"query","description":"Quantidade de itens por página.","schema":{"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"data\": [\n {\n \"id\": \"ch_NLJjZ99IoHXKgk38\",\n \"code\": \"N1OJFMGA0M\",\n \"amount\": 1490,\n \"paid_amount\": 1490,\n \"status\": \"paid\",\n \"currency\": \"BRL\",\n \"payment_method\": \"credit_card\",\n \"paid_at\": \"2019-01-22T14:49:45Z\",\n \"created_at\": \"2019-01-22T14:49:44Z\",\n \"updated_at\": \"2019-01-22T14:49:44Z\",\n \"customer\": {\n \"id\": \"cus_PYwJvWgOTmiqvW8m\",\n \"name\": \"Tony Stark\",\n \"email\": \"toinhodalua@nasa.com\",\n \"delinquent\": false,\n \"created_at\": \"2019-01-18T11:50:37Z\",\n \"updated_at\": \"2019-01-18T15:46:38Z\",\n \"phones\": {}\n },\n \"last_transaction\": {\n \"id\": \"tran_DvedVaeSWLfKDwXj\",\n \"transaction_type\": \"credit_card\",\n \"funding_source\": \"prepaid\",\n \"gateway_id\": \"775844a3-5c04-4ad2-a8d7-86cdcb42e8e7\",\n \"amount\": 1490,\n \"status\": \"captured\",\n \"success\": true,\n \"installments\": 1,\n \"statement_descriptor\": \"AVENGERS\",\n \"acquirer_tid\": \"30e4f16b-5cf9-4173-aa0b-756cbbd5af35\",\n \"acquirer_nsu\": \"30e4f16b-5cf9-4173-aa0b-756cbbd5af35\",\n \"acquirer_auth_code\": \"859\",\n \"acquirer_message\": \"Transação capturada com sucesso\",\n \"acquirer_return_code\": \"00\",\n \"operation_type\": \"auth_and_capture\",\n \"card\": {\n \"id\": \"card_jdK2O53TqfnxwRDY\",\n \"first_six_digits\": \"400000\",\n \"last_four_digits\": \"0010\",\n \"brand\": \"Visa\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 2030,\n \"status\": \"active\",\n \"type\": \"credit\",\n \"created_at\": \"2019-01-18T12:25:41Z\",\n \"updated_at\": \"2019-01-22T14:39:01Z\",\n \"billing_address\": {\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"line_1\": \"10880, Malibu Point, Malibu Central\"\n }\n },\n \"created_at\": \"2019-01-22T14:49:44Z\",\n \"updated_at\": \"2019-01-22T14:49:44Z\",\n \"gateway_response\": {\n \"code\": \"200\",\n \"errors\": []\n }\n },\n \"metadata\": {\n \"code\": \"123\"\n }\n },\n {\n \"id\": \"ch_Vm6ewLmiY1cK4XQP\",\n \"code\": \"M5JLAW0I6R\",\n \"amount\": 1490,\n \"paid_amount\": 1490,\n \"status\": \"paid\",\n \"currency\": \"BRL\",\n \"payment_method\": \"credit_card\",\n \"paid_at\": \"2019-01-22T14:49:41Z\",\n \"created_at\": \"2019-01-22T14:49:40Z\",\n \"updated_at\": \"2019-01-22T14:49:40Z\",\n \"customer\": {\n \"id\": \"cus_PYwJvWgOTmiqvW8m\",\n \"name\": \"Tony Stark\",\n \"email\": \"toinhodalua@nasa.com\",\n \"delinquent\": false,\n \"created_at\": \"2019-01-18T11:50:37Z\",\n \"updated_at\": \"2019-01-18T15:46:38Z\",\n \"phones\": {}\n },\n \"last_transaction\": {\n \"id\": \"tran_N9ZaxANIVdHz1JPY\",\n \"transaction_type\": \"credit_card\",\n \"funding_source\": \"credit\",\n \"gateway_id\": \"b4fe6901-7cb3-4e10-b1c5-5d606281c030\",\n \"amount\": 1490,\n \"status\": \"captured\",\n \"success\": true,\n \"installments\": 1,\n \"statement_descriptor\": \"AVENGERS\",\n \"acquirer_tid\": \"2117421a-bb5f-4181-83db-31f2b06d78e8\",\n \"acquirer_nsu\": \"2117421a-bb5f-4181-83db-31f2b06d78e8\",\n \"acquirer_auth_code\": \"481\",\n \"acquirer_message\": \"Transação capturada com sucesso\",\n \"acquirer_return_code\": \"00\",\n \"operation_type\": \"auth_and_capture\",\n \"card\": {\n \"id\": \"card_jdK2O53TqfnxwRDY\",\n \"first_six_digits\": \"400000\",\n \"last_four_digits\": \"0010\",\n \"brand\": \"Visa\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 2020,\n \"status\": \"active\",\n \"type\": \"credit\",\n \"created_at\": \"2019-01-18T12:25:41Z\",\n \"updated_at\": \"2019-01-22T14:39:01Z\",\n \"billing_address\": {\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"line_1\": \"10880, Malibu Point, Malibu Central\"\n }\n },\n \"created_at\": \"2019-01-22T14:49:41Z\",\n \"updated_at\": \"2019-01-22T14:49:41Z\",\n \"gateway_response\": {\n \"code\": \"200\",\n \"errors\": []\n }\n },\n \"metadata\": {\n \"code\": \"123\"\n }\n }\n ],\n \"paging\": {\n \"total\": 80,\n \"next\": \"https://api.stone.com.br/core/v1/charges?page=2&size=2\"\n }\n}"}},"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"ch_NLJjZ99IoHXKgk38"},"code":{"type":"string","example":"N1OJFMGA0M"},"amount":{"type":"integer","example":1490,"default":0},"paid_amount":{"type":"integer","example":1490,"default":0},"status":{"type":"string","example":"paid"},"currency":{"type":"string","example":"BRL"},"payment_method":{"type":"string","example":"credit_card"},"paid_at":{"type":"string","example":"2019-01-22T14:49:45Z"},"created_at":{"type":"string","example":"2019-01-22T14:49:44Z"},"updated_at":{"type":"string","example":"2019-01-22T14:49:44Z"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_PYwJvWgOTmiqvW8m"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"toinhodalua@nasa.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2019-01-18T11:50:37Z"},"updated_at":{"type":"string","example":"2019-01-18T15:46:38Z"},"phones":{"type":"object","properties":{}}}},"last_transaction":{"type":"object","properties":{"id":{"type":"string","example":"tran_DvedVaeSWLfKDwXj"},"transaction_type":{"type":"string","example":"credit_card"},"funding_source":{"type":"string","example":"prepaid"},"gateway_id":{"type":"string","example":"775844a3-5c04-4ad2-a8d7-86cdcb42e8e7"},"amount":{"type":"integer","example":1490,"default":0},"status":{"type":"string","example":"captured"},"success":{"type":"boolean","example":true,"default":true},"installments":{"type":"integer","example":1,"default":0},"statement_descriptor":{"type":"string","example":"AVENGERS"},"acquirer_tid":{"type":"string","example":"30e4f16b-5cf9-4173-aa0b-756cbbd5af35"},"acquirer_nsu":{"type":"string","example":"30e4f16b-5cf9-4173-aa0b-756cbbd5af35"},"acquirer_auth_code":{"type":"string","example":"859"},"acquirer_message":{"type":"string","example":"Transação capturada com sucesso"},"acquirer_return_code":{"type":"string","example":"00"},"operation_type":{"type":"string","example":"auth_and_capture"},"card":{"type":"object","properties":{"id":{"type":"string","example":"card_jdK2O53TqfnxwRDY"},"first_six_digits":{"type":"string","example":"400000"},"last_four_digits":{"type":"string","example":"0010"},"brand":{"type":"string","example":"Visa"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":2030,"default":0},"status":{"type":"string","example":"active"},"type":{"type":"string","example":"credit"},"created_at":{"type":"string","example":"2019-01-18T12:25:41Z"},"updated_at":{"type":"string","example":"2019-01-22T14:39:01Z"},"billing_address":{"type":"object","properties":{"zip_code":{"type":"string","example":"90265"},"city":{"type":"string","example":"Malibu"},"state":{"type":"string","example":"CA"},"country":{"type":"string","example":"US"},"line_1":{"type":"string","example":"10880, Malibu Point, Malibu Central"}}}}},"created_at":{"type":"string","example":"2019-01-22T14:49:44Z"},"updated_at":{"type":"string","example":"2019-01-22T14:49:44Z"},"gateway_response":{"type":"object","properties":{"code":{"type":"string","example":"200"},"errors":{"type":"array","items":{"type":"object","properties":{}}}}}}},"metadata":{"type":"object","properties":{"code":{"type":"string","example":"123"}}}}}},"paging":{"type":"object","properties":{"total":{"type":"integer","example":80,"default":0},"next":{"type":"string","example":"https://api.stone.com.br/core/v1/charges?page=2&size=2"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/orders/{order_id}":{"get":{"summary":"Obter pedido","description":"","operationId":"obter-pedido","parameters":[{"name":"order_id","in":"path","description":"Código identificador do pedido no sistema da loja. Max: 52 caracteres.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"or_28dN9w7CLU79kDjL\",\n \"code\": \"62LVFN7I4R\",\n \"amount\": 2990,\n \"currency\": \"BRL\",\n \"closed\": true,\n \"items\": [\n {\n \"id\": \"oi_d478RMAS3bC74PrL\",\n \"description\": \"Chaveiro do Tesseract\",\n \"amount\": 2990,\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-04-19T16:01:09Z\",\n \"updated_at\": \"2017-04-19T16:01:09Z\"\n }\n ],\n \"customer\": {\n \"id\": \"cus_eaEXlZvhBfeGlDOm\",\n \"name\": \"Tony Stark\",\n \"email\": \"f1492621-4f39-45f7-adfb-82a373a0a85c@avengers.com\",\n \"delinquent\": false,\n \"created_at\": \"2017-04-19T16:01:09Z\",\n \"updated_at\": \"2017-04-19T16:01:09Z\"\n },\n \"status\": \"paid\",\n \"created_at\": \"2017-04-19T16:01:09Z\",\n \"updated_at\": \"2017-04-19T16:01:11Z\",\n \"closed_at\": \"2017-04-19T16:01:11Z\",\n \"charges\": [\n {\n \"id\": \"ch_gmnW101c9YTvQVLB\",\n \"code\": \"62LVFN7I4R\",\n \"gateway_id\": \"ef5e977b-93d2-485a-b15d-36e5eb3d8cf5\",\n \"amount\": 2990,\n \"status\": \"paid\",\n \"currency\": \"BRL\",\n \"payment_method\": \"credit_card\",\n \"paid_at\": \"2017-04-19T16:01:11Z\",\n \"created_at\": \"2017-04-19T16:01:09Z\",\n \"updated_at\": \"2017-04-19T16:01:09Z\",\n \"customer\": {\n \"id\": \"cus_eaEXlZvhBfeGlDOm\",\n \"name\": \"Tony Stark\",\n \"email\": \"f1492621-4f39-45f7-adfb-82a373a0a85c@avengers.com\",\n \"delinquent\": false,\n \"created_at\": \"2017-04-19T16:01:09Z\",\n \"updated_at\": \"2017-04-19T16:01:09Z\"\n },\n \"last_transaction\": {\n \"id\": \"tran_3RYbBQjcnEcwrGp0\",\n \"transaction_type\": \"credit_card\",\n \"funding_source\": \"prepaid\",\n \"gateway_id\": \"ddab707d-72ba-49f9-b356-f0b9ebfa3039\",\n \"amount\": 2990,\n \"status\": \"captured\",\n \"success\": true,\n \"installments\": 1,\n \"statement_descriptor\": \"AVENGERS\",\n \"acquirer_name\": \"simulator\",\n \"acquirer_affiliation_code\": \"12345\",\n \"acquirer_tid\": \"431837\",\n \"acquirer_nsu\": \"512784\",\n \"acquirer_auth_code\": \"233215\",\n \"acquirer_message\": \"Simulator|Transação de simulação autorizada com sucesso\",\n \"acquirer_return_code\": \"0\",\n \"operation_type\": \"auth_and_capture\",\n \"card\": {\n \"id\": \"card_6xk9deAu2I2MdPzJ\",\n \"first_six_digits\": \"402400\",\n \"last_four_digits\": \"8229\",\n \"brand\": \"Amex\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 2018,\n \"status\": \"active\",\n \"created_at\": \"2017-04-19T16:01:09Z\",\n \"updated_at\": \"2017-04-19T16:01:09Z\",\n \"billing_address\": {\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"line_1\": \"10880, Malibu Point, Malibu Central\"\n },\n \"type\": \"credit\"\n },\n \"created_at\": \"2017-04-19T16:01:09Z\",\n \"updated_at\": \"2017-04-19T16:01:09Z\",\n \"gateway_response\": {\n \"code\": \"201\"\n }\n }\n }\n ]\n}"},"OK - Network Token":{"value":"{\n \"id\": \"or_5aEYRKmIwvTqpgoQ\",\n \"code\": \"Y387TKKF3L\",\n \"amount\": 2990,\n \"currency\": \"BRL\",\n \"closed\": true,\n \"items\": [\n {\n \"id\": \"oi_gBLrzX1u3pHQMoEM\",\n \"type\": \"product\",\n \"description\": \"Chaveiro do Tesseract\",\n \"amount\": 2990,\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2023-03-17T14:20:27Z\",\n \"updated_at\": \"2023-03-17T14:20:27Z\"\n }\n ],\n \"customer\": {\n \"id\": \"cus_K1oa3LKTZSlW6O7d\",\n \"name\": \"Tony Stark\",\n \"email\": \"avengerstark@ligadajustica.com.br\",\n \"delinquent\": false,\n \"created_at\": \"2023-03-17T14:19:22Z\",\n \"updated_at\": \"2023-03-17T14:19:22Z\",\n \"phones\": {}\n },\n \"status\": \"paid\",\n \"created_at\": \"2023-03-17T14:20:27Z\",\n \"updated_at\": \"2023-03-17T14:20:28Z\",\n \"closed_at\": \"2023-03-17T14:20:27Z\",\n \"charges\": [\n {\n \"id\": \"ch_Ljvke06fdSErl62x\",\n \"code\": \"Y387TKKF3L\",\n \"amount\": 2990,\n \"paid_amount\": 2990,\n \"status\": \"paid\",\n \"currency\": \"BRL\",\n \"payment_method\": \"credit_card\",\n \"paid_at\": \"2023-03-17T14:20:28Z\",\n \"created_at\": \"2023-03-17T14:20:28Z\",\n \"updated_at\": \"2023-03-17T14:20:28Z\",\n \"customer\": {\n \"id\": \"cus_K1oa3LKTZSlW6O7d\",\n \"name\": \"Tony Stark\",\n \"email\": \"avengerstark@ligadajustica.com.br\",\n \"delinquent\": false,\n \"created_at\": \"2023-03-17T14:19:22Z\",\n \"updated_at\": \"2023-03-17T14:19:22Z\",\n \"phones\": {}\n },\n \"last_transaction\": {\n \"operation_key\": \"409945098\",\n \"id\": \"tran_xbEM0pRmUASgBYAq\",\n \"transaction_type\": \"credit_card\",\n \"gateway_id\": \"95e3e8f1-c5fc-4d62-8f0b-80bdc66d3e42\",\n \"amount\": 2990,\n \"status\": \"captured\",\n \"success\": true,\n \"installments\": 1,\n \"installment_type\": \"merchant\",\n \"statement_descriptor\": \"AVENGERS\",\n \"acquirer_name\": \"simulator\",\n \"acquirer_tid\": \"894247649\",\n \"acquirer_nsu\": \"49640\",\n \"acquirer_auth_code\": \"169\",\n \"acquirer_message\": \"Transação capturada com sucesso\",\n \"acquirer_return_code\": \"00\",\n \"entry_mode\": \"ecommerce\",\n \"operation_type\": \"auth_and_capture\",\n \"card\": {\n \"id\": \"card_DwER6M8Cl9hPKAOb\",\n \"first_six_digits\": \"400000\",\n \"last_four_digits\": \"0010\",\n \"brand\": \"Visa\",\n \"holder_name\": \"Homelander\",\n \"exp_month\": 12,\n \"exp_year\": 2025,\n \"status\": \"active\",\n \"type\": \"credit\",\n \"created_at\": \"2023-03-17T14:19:43Z\",\n \"updated_at\": \"2023-03-17T14:19:43Z\",\n \"billing_address\": {\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"line_1\": \"10880, Malibu Point, Malibu Central\"\n },\n \"network_token\": {\n \"token_unique_reference\": \"9cb80642-e3b6-4b30-b233-c54a4857cbf0\",\n \"status\": \"active\"\n }\n },\n \"payment_type\": \"Token\",\n \"created_at\": \"2023-03-17T14:20:28Z\",\n \"updated_at\": \"2023-03-17T14:20:28Z\",\n \"gateway_response\": {\n \"code\": \"200\",\n \"errors\": []\n },\n \"antifraud_response\": {},\n \"metadata\": {}\n }\n }\n ],\n \"checkouts\": []\n}"}},"schema":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","example":"or_28dN9w7CLU79kDjL"},"code":{"type":"string","example":"62LVFN7I4R"},"amount":{"type":"integer","example":2990,"default":0},"currency":{"type":"string","example":"BRL"},"closed":{"type":"boolean","example":true,"default":true},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"oi_d478RMAS3bC74PrL"},"description":{"type":"string","example":"Chaveiro do Tesseract"},"amount":{"type":"integer","example":2990,"default":0},"quantity":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-19T16:01:09Z"},"updated_at":{"type":"string","example":"2017-04-19T16:01:09Z"}}}},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_eaEXlZvhBfeGlDOm"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"f1492621-4f39-45f7-adfb-82a373a0a85c@avengers.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2017-04-19T16:01:09Z"},"updated_at":{"type":"string","example":"2017-04-19T16:01:09Z"}}},"status":{"type":"string","example":"paid"},"created_at":{"type":"string","example":"2017-04-19T16:01:09Z"},"updated_at":{"type":"string","example":"2017-04-19T16:01:11Z"},"closed_at":{"type":"string","example":"2017-04-19T16:01:11Z"},"charges":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"ch_gmnW101c9YTvQVLB"},"code":{"type":"string","example":"62LVFN7I4R"},"gateway_id":{"type":"string","example":"ef5e977b-93d2-485a-b15d-36e5eb3d8cf5"},"amount":{"type":"integer","example":2990,"default":0},"status":{"type":"string","example":"paid"},"currency":{"type":"string","example":"BRL"},"payment_method":{"type":"string","example":"credit_card"},"paid_at":{"type":"string","example":"2017-04-19T16:01:11Z"},"created_at":{"type":"string","example":"2017-04-19T16:01:09Z"},"updated_at":{"type":"string","example":"2017-04-19T16:01:09Z"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_eaEXlZvhBfeGlDOm"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"f1492621-4f39-45f7-adfb-82a373a0a85c@avengers.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2017-04-19T16:01:09Z"},"updated_at":{"type":"string","example":"2017-04-19T16:01:09Z"}}},"last_transaction":{"type":"object","properties":{"id":{"type":"string","example":"tran_3RYbBQjcnEcwrGp0"},"transaction_type":{"type":"string","example":"credit_card"},"funding_source":{"type":"string","example":"prepaid"},"gateway_id":{"type":"string","example":"ddab707d-72ba-49f9-b356-f0b9ebfa3039"},"amount":{"type":"integer","example":2990,"default":0},"status":{"type":"string","example":"captured"},"success":{"type":"boolean","example":true,"default":true},"installments":{"type":"integer","example":1,"default":0},"statement_descriptor":{"type":"string","example":"AVENGERS"},"acquirer_name":{"type":"string","example":"simulator"},"acquirer_affiliation_code":{"type":"string","example":"12345"},"acquirer_tid":{"type":"string","example":"431837"},"acquirer_nsu":{"type":"string","example":"512784"},"acquirer_auth_code":{"type":"string","example":"233215"},"acquirer_message":{"type":"string","example":"Simulator|Transação de simulação autorizada com sucesso"},"acquirer_return_code":{"type":"string","example":"0"},"operation_type":{"type":"string","example":"auth_and_capture"},"card":{"type":"object","properties":{"id":{"type":"string","example":"card_6xk9deAu2I2MdPzJ"},"first_six_digits":{"type":"string","example":"402400"},"last_four_digits":{"type":"string","example":"8229"},"brand":{"type":"string","example":"Amex"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":2018,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-19T16:01:09Z"},"updated_at":{"type":"string","example":"2017-04-19T16:01:09Z"},"billing_address":{"type":"object","properties":{"zip_code":{"type":"string","example":"90265"},"city":{"type":"string","example":"Malibu"},"state":{"type":"string","example":"CA"},"country":{"type":"string","example":"US"},"line_1":{"type":"string","example":"10880, Malibu Point, Malibu Central"}}},"type":{"type":"string","example":"credit"}}},"created_at":{"type":"string","example":"2017-04-19T16:01:09Z"},"updated_at":{"type":"string","example":"2017-04-19T16:01:09Z"},"gateway_response":{"type":"object","properties":{"code":{"type":"string","example":"201"}}}}}}}}}},{"title":"OK - Network Token","type":"object","properties":{"id":{"type":"string","example":"or_5aEYRKmIwvTqpgoQ"},"code":{"type":"string","example":"Y387TKKF3L"},"amount":{"type":"integer","example":2990,"default":0},"currency":{"type":"string","example":"BRL"},"closed":{"type":"boolean","example":true,"default":true},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"oi_gBLrzX1u3pHQMoEM"},"type":{"type":"string","example":"product"},"description":{"type":"string","example":"Chaveiro do Tesseract"},"amount":{"type":"integer","example":2990,"default":0},"quantity":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2023-03-17T14:20:27Z"},"updated_at":{"type":"string","example":"2023-03-17T14:20:27Z"}}}},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_K1oa3LKTZSlW6O7d"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"avengerstark@ligadajustica.com.br"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2023-03-17T14:19:22Z"},"updated_at":{"type":"string","example":"2023-03-17T14:19:22Z"},"phones":{"type":"object","properties":{}}}},"status":{"type":"string","example":"paid"},"created_at":{"type":"string","example":"2023-03-17T14:20:27Z"},"updated_at":{"type":"string","example":"2023-03-17T14:20:28Z"},"closed_at":{"type":"string","example":"2023-03-17T14:20:27Z"},"charges":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"ch_Ljvke06fdSErl62x"},"code":{"type":"string","example":"Y387TKKF3L"},"amount":{"type":"integer","example":2990,"default":0},"paid_amount":{"type":"integer","example":2990,"default":0},"status":{"type":"string","example":"paid"},"currency":{"type":"string","example":"BRL"},"payment_method":{"type":"string","example":"credit_card"},"paid_at":{"type":"string","example":"2023-03-17T14:20:28Z"},"created_at":{"type":"string","example":"2023-03-17T14:20:28Z"},"updated_at":{"type":"string","example":"2023-03-17T14:20:28Z"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_K1oa3LKTZSlW6O7d"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"avengerstark@ligadajustica.com.br"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2023-03-17T14:19:22Z"},"updated_at":{"type":"string","example":"2023-03-17T14:19:22Z"},"phones":{"type":"object","properties":{}}}},"last_transaction":{"type":"object","properties":{"operation_key":{"type":"string","example":"409945098"},"id":{"type":"string","example":"tran_xbEM0pRmUASgBYAq"},"transaction_type":{"type":"string","example":"credit_card"},"gateway_id":{"type":"string","example":"95e3e8f1-c5fc-4d62-8f0b-80bdc66d3e42"},"amount":{"type":"integer","example":2990,"default":0},"status":{"type":"string","example":"captured"},"success":{"type":"boolean","example":true,"default":true},"installments":{"type":"integer","example":1,"default":0},"installment_type":{"type":"string","example":"merchant"},"statement_descriptor":{"type":"string","example":"AVENGERS"},"acquirer_name":{"type":"string","example":"simulator"},"acquirer_tid":{"type":"string","example":"894247649"},"acquirer_nsu":{"type":"string","example":"49640"},"acquirer_auth_code":{"type":"string","example":"169"},"acquirer_message":{"type":"string","example":"Transação capturada com sucesso"},"acquirer_return_code":{"type":"string","example":"00"},"entry_mode":{"type":"string","example":"ecommerce"},"operation_type":{"type":"string","example":"auth_and_capture"},"card":{"type":"object","properties":{"id":{"type":"string","example":"card_DwER6M8Cl9hPKAOb"},"first_six_digits":{"type":"string","example":"400000"},"last_four_digits":{"type":"string","example":"0010"},"brand":{"type":"string","example":"Visa"},"holder_name":{"type":"string","example":"Homelander"},"exp_month":{"type":"integer","example":12,"default":0},"exp_year":{"type":"integer","example":2025,"default":0},"status":{"type":"string","example":"active"},"type":{"type":"string","example":"credit"},"created_at":{"type":"string","example":"2023-03-17T14:19:43Z"},"updated_at":{"type":"string","example":"2023-03-17T14:19:43Z"},"billing_address":{"type":"object","properties":{"zip_code":{"type":"string","example":"90265"},"city":{"type":"string","example":"Malibu"},"state":{"type":"string","example":"CA"},"country":{"type":"string","example":"US"},"line_1":{"type":"string","example":"10880, Malibu Point, Malibu Central"}}},"network_token":{"type":"object","properties":{"token_unique_reference":{"type":"string","example":"9cb80642-e3b6-4b30-b233-c54a4857cbf0"},"status":{"type":"string","example":"active"}}}}},"payment_type":{"type":"string","example":"Token"},"created_at":{"type":"string","example":"2023-03-17T14:20:28Z"},"updated_at":{"type":"string","example":"2023-03-17T14:20:28Z"},"gateway_response":{"type":"object","properties":{"code":{"type":"string","example":"200"},"errors":{"type":"array","items":{"type":"object","properties":{}}}}},"antifraud_response":{"type":"object","properties":{}},"metadata":{"type":"object","properties":{}}}}}}},"checkouts":{"type":"array","items":{"type":"object","properties":{}}}}}]}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Order not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Order not found."}}}}}}},"deprecated":false}},"/orders/{order_id}/closed":{"patch":{"summary":"Fechar um pedido","description":"Utilizado para fechar um pedido para que não seja mais possível adicionar cobranças.","operationId":"fechar-um-pedido","parameters":[{"name":"order_id","in":"path","description":"Código do pedido.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["status"],"properties":{"status":{"type":"string","description":"Status final do pedido. Valores possíveis: **paid**, **canceled** ou **failed**. Caso não enviado, valor default será **paid**."}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"or_koMvlQOTMCb9dpPO\",\n \"code\": \"O8YDFPZUM3\",\n \"amount\": 2990,\n \"currency\": \"BRL\",\n \"closed\": true,\n \"items\": [\n {\n \"id\": \"oi_jkW1MBc9MtKdzK20\",\n \"description\": \"Bolinho de feijoada\",\n \"amount\": 2990,\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-06-06T16:03:41Z\",\n \"updated_at\": \"2017-06-06T16:03:41Z\"\n }\n ],\n \"customer\": {\n \"id\": \"cus_mBloKMLnswtD4O3a\",\n \"name\": \"Tony Stark\",\n \"email\": \"avengerstark@ligadajustica.com.br\",\n \"delinquent\": false,\n \"created_at\": \"2016-10-07T19:50:39Z\",\n \"updated_at\": \"2017-06-06T16:03:40Z\",\n \"phones\": {},\n \"metadata\": {\n \"company\": \"Pagar.me\",\n \"nome_da_mae\": \"Maria\"\n }\n },\n \"status\": \"paid\",\n \"created_at\": \"2017-06-06T16:03:40Z\",\n \"updated_at\": \"2017-06-06T16:03:40Z\",\n \"closed_at\": \"2017-06-06T16:03:47Z\"\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"or_koMvlQOTMCb9dpPO"},"code":{"type":"string","example":"O8YDFPZUM3"},"amount":{"type":"integer","example":2990,"default":0},"currency":{"type":"string","example":"BRL"},"closed":{"type":"boolean","example":true,"default":true},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"oi_jkW1MBc9MtKdzK20"},"description":{"type":"string","example":"Bolinho de feijoada"},"amount":{"type":"integer","example":2990,"default":0},"quantity":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-06-06T16:03:41Z"},"updated_at":{"type":"string","example":"2017-06-06T16:03:41Z"}}}},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_mBloKMLnswtD4O3a"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"avengerstark@ligadajustica.com.br"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2016-10-07T19:50:39Z"},"updated_at":{"type":"string","example":"2017-06-06T16:03:40Z"},"phones":{"type":"object","properties":{}},"metadata":{"type":"object","properties":{"company":{"type":"string","example":"Pagar.me"},"nome_da_mae":{"type":"string","example":"Maria"}}}}},"status":{"type":"string","example":"paid"},"created_at":{"type":"string","example":"2017-06-06T16:03:40Z"},"updated_at":{"type":"string","example":"2017-06-06T16:03:40Z"},"closed_at":{"type":"string","example":"2017-06-06T16:03:47Z"}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/orders/{order_id}/items":{"post":{"summary":"Incluir item","description":"Quando um pedido está **aberto**, você pode incluir itens nele.","operationId":"incluir-item","parameters":[{"name":"order_id","in":"path","description":"Código do pedido.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["amount","description","quantity"],"properties":{"amount":{"type":"integer","description":"Valor do item.","format":"int32"},"code":{"type":"string","description":"Código do item no sistema da loja. Max: 52 caracteres. Obrigatório para transações de split"},"description":{"type":"string","description":"Descrição do item. Max: 256 caracteres."},"quantity":{"type":"string","description":"Quantidade de itens."},"category":{"type":"string","description":"Categoria do item. Max: 64 caracteres."}}},"examples":{"Request Example":{"value":{"amount":1090,"description":"Caneca Zero Grau","quantity":1,"seller":{"document":"26224451990","name":"Stark Industries","code":"STRK_01","description":"Changing the world for a better future.","address":{"line_1":"10880, Malibu Point, Malibu Central","zip_code":"90265","city":"Malibu","state":"CA","country":"US"}}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"oi_ZD2lNDKcORty1pzw\",\n \"description\": \"Caneca Zero Grau\",\n \"amount\": 1090,\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-10-05T20:24:38Z\",\n \"updated_at\": \"2017-10-05T20:24:38Z\",\n \"order\": {\n \"id\": \"or_oO7vgpeh1rF4DX3A\",\n \"code\": \"7W86TKXIO1\",\n \"amount\": 5170,\n \"currency\": \"BRL\",\n \"closed\": false,\n \"status\": \"pending\",\n \"created_at\": \"2017-10-05T19:41:29Z\",\n \"updated_at\": \"2017-10-05T19:41:29Z\"\n },\n \"seller\": {\n \"id\": \"sl_jY3D2MziacQnR01W\",\n \"name\": \"Stark Industries\",\n \"code\": \"STRK_01\",\n \"document\": \"26224451990\",\n \"description\": \"Changing the world for a better future.\",\n \"status\": \"active\",\n \"created_at\": \"2017-10-05T20:24:38Z\",\n \"updated_at\": \"2017-10-05T20:24:38Z\",\n \"address\": {\n \"line_1\": \"10880, Malibu Point, Malibu Central\",\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\"\n },\n \"metadata\": {}\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"oi_ZD2lNDKcORty1pzw"},"description":{"type":"string","example":"Caneca Zero Grau"},"amount":{"type":"integer","example":1090,"default":0},"quantity":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-10-05T20:24:38Z"},"updated_at":{"type":"string","example":"2017-10-05T20:24:38Z"},"order":{"type":"object","properties":{"id":{"type":"string","example":"or_oO7vgpeh1rF4DX3A"},"code":{"type":"string","example":"7W86TKXIO1"},"amount":{"type":"integer","example":5170,"default":0},"currency":{"type":"string","example":"BRL"},"closed":{"type":"boolean","example":false,"default":true},"status":{"type":"string","example":"pending"},"created_at":{"type":"string","example":"2017-10-05T19:41:29Z"},"updated_at":{"type":"string","example":"2017-10-05T19:41:29Z"}}},"seller":{"type":"object","properties":{"id":{"type":"string","example":"sl_jY3D2MziacQnR01W"},"name":{"type":"string","example":"Stark Industries"},"code":{"type":"string","example":"STRK_01"},"document":{"type":"string","example":"26224451990"},"description":{"type":"string","example":"Changing the world for a better future."},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-10-05T20:24:38Z"},"updated_at":{"type":"string","example":"2017-10-05T20:24:38Z"},"address":{"type":"object","properties":{"line_1":{"type":"string","example":"10880, Malibu Point, Malibu Central"},"zip_code":{"type":"string","example":"90265"},"city":{"type":"string","example":"Malibu"},"state":{"type":"string","example":"CA"},"country":{"type":"string","example":"US"}}},"metadata":{"type":"object","properties":{}}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"delete":{"summary":"Remover todos os itens","description":"Quando um pedido está **aberto**, você pode remover todos os itens dele.","operationId":"remover-todos-os-itens","parameters":[{"name":"order_id","in":"path","description":"Código do pedido.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"or_5OKyl9fNwIKDzjWJ\",\n \"code\": \"7P03S0FOQN\",\n \"currency\": \"BRL\",\n \"closed\": false,\n \"customer\": {\n \"id\": \"cus_oWQOPg5tJF8ml0ny\",\n \"name\": \"Tony Stark\",\n \"email\": \"9fb571fc-79c3-4293-aafd-61fd8afa6c38@avengers.com\",\n \"delinquent\": false,\n \"created_at\": \"2017-04-05T03:54:42\",\n \"updated_at\": \"2017-04-05T03:54:42\"\n },\n \"status\": \"pending\",\n \"created_at\": \"2017-04-05T03:54:42\",\n \"updated_at\": \"2017-04-05T03:54:42\"\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"or_5OKyl9fNwIKDzjWJ"},"code":{"type":"string","example":"7P03S0FOQN"},"currency":{"type":"string","example":"BRL"},"closed":{"type":"boolean","example":false,"default":true},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_oWQOPg5tJF8ml0ny"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"9fb571fc-79c3-4293-aafd-61fd8afa6c38@avengers.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2017-04-05T03:54:42"},"updated_at":{"type":"string","example":"2017-04-05T03:54:42"}}},"status":{"type":"string","example":"pending"},"created_at":{"type":"string","example":"2017-04-05T03:54:42"},"updated_at":{"type":"string","example":"2017-04-05T03:54:42"}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Order not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Order not found."}}}}}}},"deprecated":false}},"/orders/{order_id}/items/{item_id}":{"put":{"summary":"Editar item do pedido","description":"Quando um pedido está **aberto**, você pode editar os itens dele.","operationId":"editar-item-do-pedido","parameters":[{"name":"order_id","in":"path","description":"Código do pedido","schema":{"type":"string"},"required":true},{"name":"item_id","in":"path","description":"Código do item do pedido","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["amount","description","quantity"],"properties":{"amount":{"type":"integer","description":"Valor do item.","format":"int32"},"description":{"type":"string","description":"Descrição do item. Max: 256 caracteres."},"quantity":{"type":"integer","description":"Quantidade de itens.","format":"int32"},"category":{"type":"string","description":"Categoria do item. Max: 64 caracteres."}}},"examples":{"Request Example":{"value":{"amount":1090,"description":"Água com gás","quantity":2}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"oi_AQKqAnGhQGsYd1b6\",\n \"description\": \"Água com gás\",\n \"amount\": 1090,\n \"quantity\": 2,\n \"status\": \"active\",\n \"created_at\": \"2017-04-05T03:55:48\",\n \"updated_at\": \"2017-04-05T05:05:14\",\n \"order\": {\n \"id\": \"or_5OKyl9fNwIKDzjWJ\",\n \"code\": \"7P03S0FOQN\",\n \"amount\": 6260,\n \"currency\": \"BRL\",\n \"closed\": false,\n \"status\": \"pending\",\n \"created_at\": \"2017-04-05T03:54:42\",\n \"updated_at\": \"2017-04-05T03:54:42\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"oi_AQKqAnGhQGsYd1b6"},"description":{"type":"string","example":"Água com gás"},"amount":{"type":"integer","example":1090,"default":0},"quantity":{"type":"integer","example":2,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-05T03:55:48"},"updated_at":{"type":"string","example":"2017-04-05T05:05:14"},"order":{"type":"object","properties":{"id":{"type":"string","example":"or_5OKyl9fNwIKDzjWJ"},"code":{"type":"string","example":"7P03S0FOQN"},"amount":{"type":"integer","example":6260,"default":0},"currency":{"type":"string","example":"BRL"},"closed":{"type":"boolean","example":false,"default":true},"status":{"type":"string","example":"pending"},"created_at":{"type":"string","example":"2017-04-05T03:54:42"},"updated_at":{"type":"string","example":"2017-04-05T03:54:42"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"delete":{"summary":"Deletar item","description":"Quando um pedido está **aberto**, você pode excluir itens dele.","operationId":"deletar-item","parameters":[{"name":"order_id","in":"path","description":"Códido do pedido.","schema":{"type":"string"},"required":true},{"name":"item_id","in":"path","description":"Código do item do pedido.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"oi_AQKqAnGhQGsYd1b6\",\n \"description\": \"Caneca Zero Grau\",\n \"amount\": 1090,\n \"quantity\": 2,\n \"status\": \"deleted\",\n \"created_at\": \"2017-04-05T03:55:48\",\n \"updated_at\": \"2017-04-05T05:05:14\",\n \"deleted_at\": \"2017-04-05T05:30:34\",\n \"order\": {\n \"id\": \"or_5OKyl9fNwIKDzjWJ\",\n \"code\": \"7P03S0FOQN\",\n \"amount\": 4080,\n \"currency\": \"BRL\",\n \"closed\": false,\n \"status\": \"pending\",\n \"created_at\": \"2017-04-05T03:54:42\",\n \"updated_at\": \"2017-04-05T03:54:42\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"oi_AQKqAnGhQGsYd1b6"},"description":{"type":"string","example":"Caneca Zero Grau"},"amount":{"type":"integer","example":1090,"default":0},"quantity":{"type":"integer","example":2,"default":0},"status":{"type":"string","example":"deleted"},"created_at":{"type":"string","example":"2017-04-05T03:55:48"},"updated_at":{"type":"string","example":"2017-04-05T05:05:14"},"deleted_at":{"type":"string","example":"2017-04-05T05:30:34"},"order":{"type":"object","properties":{"id":{"type":"string","example":"or_5OKyl9fNwIKDzjWJ"},"code":{"type":"string","example":"7P03S0FOQN"},"amount":{"type":"integer","example":4080,"default":0},"currency":{"type":"string","example":"BRL"},"closed":{"type":"boolean","example":false,"default":true},"status":{"type":"string","example":"pending"},"created_at":{"type":"string","example":"2017-04-05T03:54:42"},"updated_at":{"type":"string","example":"2017-04-05T03:54:42"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"oi_ZR3AjrjFwsg2A7bz\",\n \"description\": \"Caneca Zero Grau\",\n \"amount\": 1090,\n \"quantity\": 1,\n \"status\": \"deleted\",\n \"created_at\": \"2017-04-05T05:33:29\",\n \"updated_at\": \"2017-04-05T05:33:29\",\n \"deleted_at\": \"2017-04-05T05:33:38\",\n \"order\": {\n \"id\": \"or_5OKyl9fNwIKDzjWJ\",\n \"code\": \"7P03S0FOQN\",\n \"amount\": 4080,\n \"currency\": \"BRL\",\n \"closed\": false,\n \"status\": \"pending\",\n \"created_at\": \"2017-04-05T03:54:42\",\n \"updated_at\": \"2017-04-05T03:54:42\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"oi_ZR3AjrjFwsg2A7bz"},"description":{"type":"string","example":"Caneca Zero Grau"},"amount":{"type":"integer","example":1090,"default":0},"quantity":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"deleted"},"created_at":{"type":"string","example":"2017-04-05T05:33:29"},"updated_at":{"type":"string","example":"2017-04-05T05:33:29"},"deleted_at":{"type":"string","example":"2017-04-05T05:33:38"},"order":{"type":"object","properties":{"id":{"type":"string","example":"or_5OKyl9fNwIKDzjWJ"},"code":{"type":"string","example":"7P03S0FOQN"},"amount":{"type":"integer","example":4080,"default":0},"currency":{"type":"string","example":"BRL"},"closed":{"type":"boolean","example":false,"default":true},"status":{"type":"string","example":"pending"},"created_at":{"type":"string","example":"2017-04-05T03:54:42"},"updated_at":{"type":"string","example":"2017-04-05T03:54:42"}}}}}}}}},"deprecated":false},"get":{"summary":"Obter item do pedido","description":"Obter um item especifico dentro de um pedido especifico.","operationId":"obter-item-do-pedido","parameters":[{"name":"order_id","in":"path","description":"Código do pedido.","schema":{"type":"string"},"required":true},{"name":"item_id","in":"path","description":"Código do item do pedido.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"oi_gJ4RZVujNFDVRwpn\",\n \"description\": \"Chaveiro do Tesseract\",\n \"amount\": 2990,\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-12-18T16:49:43Z\",\n \"updated_at\": \"2017-12-18T16:49:43Z\",\n \"order\": {\n \"id\": \"or_WpJzPeCwQtlYrEGO\",\n \"code\": \"ELVRSL8S7Z\",\n \"amount\": 2990,\n \"currency\": \"BRL\",\n \"closed\": true,\n \"status\": \"paid\",\n \"created_at\": \"2017-12-18T16:49:43Z\",\n \"updated_at\": \"2017-12-18T16:49:44Z\",\n \"closed_at\": \"2017-12-18T16:49:44Z\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"oi_gJ4RZVujNFDVRwpn"},"description":{"type":"string","example":"Chaveiro do Tesseract"},"amount":{"type":"integer","example":2990,"default":0},"quantity":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-12-18T16:49:43Z"},"updated_at":{"type":"string","example":"2017-12-18T16:49:43Z"},"order":{"type":"object","properties":{"id":{"type":"string","example":"or_WpJzPeCwQtlYrEGO"},"code":{"type":"string","example":"ELVRSL8S7Z"},"amount":{"type":"integer","example":2990,"default":0},"currency":{"type":"string","example":"BRL"},"closed":{"type":"boolean","example":true,"default":true},"status":{"type":"string","example":"paid"},"created_at":{"type":"string","example":"2017-12-18T16:49:43Z"},"updated_at":{"type":"string","example":"2017-12-18T16:49:44Z"},"closed_at":{"type":"string","example":"2017-12-18T16:49:44Z"}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Order not found.\"\n}"}},"schema":{"oneOf":[{"type":"object","properties":{"message":{"type":"string","example":"Item not found."}}},{"type":"object","properties":{"message":{"type":"string","example":"Order not found."}}}]}}}}},"deprecated":false}},"/charges/{charge_id}/capture":{"post":{"summary":"Capturar cobrança com split","description":"Rota para capturar uma cobrança com split, definindo a regra de split e os recebedor que irão participar da divisão dos pagamentos.","operationId":"capturar-cobrança-com-split-1","parameters":[{"name":"charge_id","in":"path","description":"Código da cobrança.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"amount":{"type":"integer","description":"Valor a ser capturado. Caso não seja informado, será considerado o valor total da cobrança.","format":"int32"},"split":{"type":"array","description":"Lista de regras de split.","items":{"properties":{"amount":{"type":"integer","description":"Valor destinado ao recebedor.","format":"int32"},"recipient_id":{"type":"string","description":"Código do recebedor. Formato: rp_XXXXXXXXXXXXXXXX."},"type":{"type":"string","description":"Tipo de divisão. Os valores possíveis são flat ou percentage."},"options":{"type":"object","description":"Informações da responsabilidade do recebedor na transação.","properties":{"charge_processing_fee":{"type":"boolean","description":"Indica se o recebedor vinculado à regra será cobrado pelas taxas da transação"},"charge_remainder_fee":{"type":"boolean","description":"Indica se o recebedor vinculado à regra irá receber o restante dos recebíveis após uma divisão"},"liable":{"type":"boolean","description":"Indica se o recebedor é responsável pela transação em caso de chargeback."}}}},"type":"object"}}}},"examples":{"Request Example":{"value":{"amount":100,"split":[{"amount":50,"recipient_id":"rp_5yGwpMGckBHVYmb6","type":"percentage","options":{"charge_processing_fee":true,"charge_remainder_fee":true,"liable":true}},{"amount":50,"type":"percentage","recipient_id":"rp_yLnAyVpHbQIqZxwO","options":{"charge_processing_fee":false,"charge_remainder_fee":false,"liable":false}}]}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"ch_WOoyJ6u3kUzGyj46\",\n \"code\": \"G11LT7MHVL\",\n \"gateway_id\": \"3910377\",\n \"amount\": 100,\n \"paid_amount\": 100,\n \"status\": \"paid\",\n \"currency\": \"BRL\",\n \"payment_method\": \"credit_card\",\n \"paid_at\": \"2018-07-11T17:08:54Z\",\n \"canceled_at\": \"2018-07-11T17:09:04Z\",\n \"created_at\": \"2018-07-11T17:08:52Z\",\n \"updated_at\": \"2018-07-11T17:09:04Z\",\n \"customer\": {\n \"id\": \"cus_OXr6LKGhwruEE1mj\",\n \"name\": \"Tony Stark\",\n \"email\": \"89d47975-5fb2-4452-8044-7c3be5718d53@avengers.com\",\n \"delinquent\": false,\n \"created_at\": \"2018-07-11T17:08:51Z\",\n \"updated_at\": \"2018-07-11T17:08:51Z\",\n \"phones\": {}\n },\n \"last_transaction\": {\n \"id\": \"tran_p6yAVj8S8szqAB4d\",\n \"transaction_type\": \"credit_card\",\n \"gateway_id\": \"3910377\",\n \"amount\": 100,\n \"status\": \"captured\",\n \"success\": true,\n \"acquirer_name\": \"pagarme\",\n \"acquirer_tid\": \"3910377\",\n \"acquirer_nsu\": \"3910377\",\n \"acquirer_return_code\": \"0000\",\n \"operation_type\": \"cancel\",\n \"card\": {\n \"id\": \"card_Rp2BADgtNmSpY5oW\",\n \"first_six_digits\": \"401118\",\n \"last_four_digits\": \"5580\",\n \"brand\": \"Visa\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 2020,\n \"status\": \"active\",\n \"type\": \"credit\",\n \"created_at\": \"2018-07-11T17:08:52Z\",\n \"updated_at\": \"2018-07-11T17:08:52Z\"\n },\n \"created_at\": \"2018-07-11T17:09:00Z\",\n \"updated_at\": \"2018-07-11T17:09:00Z\",\n \"gateway_response\": {\n \"code\": \"200\"\n },\n \"split\": [\n {\n \"id\": \"sr_R2qmlNaViJiLQAwg\",\n \"type\": \"percentage\",\n \"gateway_id\": \"sr_ck5gvkaia0061q36dfxqmrh1j\",\n \"amount\": 50,\n \"recipient\": {\n \"id\": \"rp_5yGwpMGckBHVYmb6\",\n \"name\": \"First recipient\",\n \"email\": \"first_recipient@pagar.me\",\n \"document\": \"12728994706\",\n \"description\": \"Descrição do recebedor 1\",\n \"type\": \"individual\",\n \"status\": \"active\",\n \"created_at\": \"2020-01-02T20:23:14Z\",\n \"updated_at\": \"2020-01-02T20:23:14Z\"\n },\n \"options\": {\n \"liable\": true,\n \"charge_processing_fee\": true,\n \"charge_remainder_fee\": true\n }\n },\n {\n \"id\": \"sr_yrkGYXw0ijuaxAX8\",\n \"type\": \"percentage\",\n \"gateway_id\": \"sr_ck5gvkaia0062q36dioccqnec\",\n \"amount\": 50,\n \"recipient\": {\n \"id\": \"rp_yLnAyVpHbQIqZxwO\",\n \"name\": \"Second recipient\",\n \"email\": \"second_recipient@pagar.me\",\n \"document\": \"15313587000166\",\n \"description\": \"Descrição do recebedor 2\",\n \"type\": \"company\",\n \"status\": \"active\",\n \"created_at\": \"2020-01-02T20:23:17Z\",\n \"updated_at\": \"2020-01-02T20:23:17Z\"\n },\n \"options\": {\n \"liable\": false,\n \"charge_processing_fee\": false,\n \"charge_remainder_fee\": false\n }\n }\n ]\n },\n \"metadata\": {\n \"code\": \"123\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"ch_WOoyJ6u3kUzGyj46"},"code":{"type":"string","example":"G11LT7MHVL"},"gateway_id":{"type":"string","example":"3910377"},"amount":{"type":"integer","example":100,"default":0},"paid_amount":{"type":"integer","example":100,"default":0},"status":{"type":"string","example":"paid"},"currency":{"type":"string","example":"BRL"},"payment_method":{"type":"string","example":"credit_card"},"paid_at":{"type":"string","example":"2018-07-11T17:08:54Z"},"canceled_at":{"type":"string","example":"2018-07-11T17:09:04Z"},"created_at":{"type":"string","example":"2018-07-11T17:08:52Z"},"updated_at":{"type":"string","example":"2018-07-11T17:09:04Z"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_OXr6LKGhwruEE1mj"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"89d47975-5fb2-4452-8044-7c3be5718d53@avengers.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2018-07-11T17:08:51Z"},"updated_at":{"type":"string","example":"2018-07-11T17:08:51Z"},"phones":{"type":"object","properties":{}}}},"last_transaction":{"type":"object","properties":{"id":{"type":"string","example":"tran_p6yAVj8S8szqAB4d"},"transaction_type":{"type":"string","example":"credit_card"},"gateway_id":{"type":"string","example":"3910377"},"amount":{"type":"integer","example":100,"default":0},"status":{"type":"string","example":"captured"},"success":{"type":"boolean","example":true,"default":true},"acquirer_name":{"type":"string","example":"pagarme"},"acquirer_tid":{"type":"string","example":"3910377"},"acquirer_nsu":{"type":"string","example":"3910377"},"acquirer_return_code":{"type":"string","example":"0000"},"operation_type":{"type":"string","example":"cancel"},"card":{"type":"object","properties":{"id":{"type":"string","example":"card_Rp2BADgtNmSpY5oW"},"first_six_digits":{"type":"string","example":"401118"},"last_four_digits":{"type":"string","example":"5580"},"brand":{"type":"string","example":"Visa"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":2020,"default":0},"status":{"type":"string","example":"active"},"type":{"type":"string","example":"credit"},"created_at":{"type":"string","example":"2018-07-11T17:08:52Z"},"updated_at":{"type":"string","example":"2018-07-11T17:08:52Z"}}},"created_at":{"type":"string","example":"2018-07-11T17:09:00Z"},"updated_at":{"type":"string","example":"2018-07-11T17:09:00Z"},"gateway_response":{"type":"object","properties":{"code":{"type":"string","example":"200"}}},"split":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"sr_R2qmlNaViJiLQAwg"},"type":{"type":"string","example":"percentage"},"gateway_id":{"type":"string","example":"sr_ck5gvkaia0061q36dfxqmrh1j"},"amount":{"type":"integer","example":50,"default":0},"recipient":{"type":"object","properties":{"id":{"type":"string","example":"rp_5yGwpMGckBHVYmb6"},"name":{"type":"string","example":"First recipient"},"email":{"type":"string","example":"first_recipient@pagar.me"},"document":{"type":"string","example":"12728994706"},"description":{"type":"string","example":"Descrição do recebedor 1"},"type":{"type":"string","example":"individual"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2020-01-02T20:23:14Z"},"updated_at":{"type":"string","example":"2020-01-02T20:23:14Z"}}},"options":{"type":"object","properties":{"liable":{"type":"boolean","example":true,"default":true},"charge_processing_fee":{"type":"boolean","example":true,"default":true},"charge_remainder_fee":{"type":"boolean","example":true,"default":true}}}}}}}},"metadata":{"type":"object","properties":{"code":{"type":"string","example":"123"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/charges/{charge_id}":{"get":{"summary":"Obter cobrança","description":"","operationId":"obter-cobrança","parameters":[{"name":"charge_id","in":"path","description":"Código da cobrança.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"ch_6NXoYXyiNfP3A54l\",\n \"code\": \"ABCDE123\",\n \"amount\": 1490,\n \"paid_amount\": 1490,\n \"status\": \"paid\",\n \"currency\": \"BRL\",\n \"payment_method\": \"credit_card\",\n \"paid_at\": \"2019-01-22T14:31:36Z\",\n \"created_at\": \"2019-01-22T14:30:12Z\",\n \"updated_at\": \"2019-01-22T14:31:36Z\",\n \"customer\": {\n \"id\": \"cus_PYwJvWgOTmiqvW8m\",\n \"name\": \"Tony Stark\",\n \"email\": \"toinhodalua@nasa.com\",\n \"delinquent\": false,\n \"created_at\": \"2019-01-18T11:50:37Z\",\n \"updated_at\": \"2019-01-18T15:46:38Z\",\n \"phones\": {}\n },\n \"last_transaction\": {\n \"id\": \"tran_QGXDnycJdHKnoVa3\",\n \"transaction_type\": \"credit_card\",\n \"funding_source\": \"prepaid\",\n \"amount\": 1490,\n \"status\": \"captured\",\n \"success\": true,\n \"installments\": 1,\n \"statement_descriptor\": \"AVENGERS\",\n \"acquirer_tid\": \"cb42d188-aca6-46f2-a2c9-046cb6342f5d\",\n \"acquirer_nsu\": \"cb42d188-aca6-46f2-a2c9-046cb6342f5d\",\n \"acquirer_auth_code\": \"416\",\n \"acquirer_message\": \"Transação capturada com sucesso\",\n \"acquirer_return_code\": \"00\",\n \"operation_type\": \"capture\",\n \"card\": {\n \"id\": \"card_jdK2O53TqfnxwRDY\",\n \"first_six_digits\": \"400000\",\n \"last_four_digits\": \"0010\",\n \"brand\": \"Visa\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 2020,\n \"status\": \"active\",\n \"type\": \"credit\",\n \"created_at\": \"2019-01-18T12:25:41Z\",\n \"updated_at\": \"2019-01-22T14:30:12Z\"\n },\n \"created_at\": \"2019-01-22T14:31:36Z\",\n \"updated_at\": \"2019-01-22T14:31:36Z\",\n \"gateway_response\": {\n \"code\": \"200\",\n \"errors\": []\n }\n },\n \"metadata\": {\n \"code\": \"123\"\n }\n}"},"OK - Network Token":{"value":"{\n \"id\": \"ch_Ljvke06fdSErl62x\",\n \"code\": \"Y387TKKF3L\",\n \"amount\": 2990,\n \"paid_amount\": 2990,\n \"status\": \"paid\",\n \"currency\": \"BRL\",\n \"payment_method\": \"credit_card\",\n \"paid_at\": \"2023-03-17T14:20:28Z\",\n \"created_at\": \"2023-03-17T14:20:28Z\",\n \"updated_at\": \"2023-03-17T14:20:28Z\",\n \"order\": {\n \"id\": \"or_5aEYRKmIwvTqpgoQ\",\n \"code\": \"Y387TKKF3L\",\n \"amount\": 2990,\n \"closed\": true,\n \"created_at\": \"2023-03-17T14:20:27Z\",\n \"updated_at\": \"2023-03-17T14:20:28Z\",\n \"closed_at\": \"2023-03-17T14:20:27Z\",\n \"currency\": \"BRL\",\n \"status\": \"paid\",\n \"customer_id\": \"cus_K1oa3LKTZSlW6O7d\"\n },\n \"customer\": {\n \"id\": \"cus_K1oa3LKTZSlW6O7d\",\n \"name\": \"Tony Stark\",\n \"email\": \"avengerstark@ligadajustica.com.br\",\n \"delinquent\": false,\n \"created_at\": \"2023-03-17T14:19:22Z\",\n \"updated_at\": \"2023-03-17T14:19:22Z\",\n \"phones\": {}\n },\n \"last_transaction\": {\n \"operation_key\": \"409945098\",\n \"id\": \"tran_xbEM0pRmUASgBYAq\",\n \"transaction_type\": \"credit_card\",\n \"gateway_id\": \"95e3e8f1-c5fc-4d62-8f0b-80bdc66d3e42\",\n \"amount\": 2990,\n \"status\": \"captured\",\n \"success\": true,\n \"installments\": 1,\n \"installment_type\": \"merchant\",\n \"statement_descriptor\": \"AVENGERS\",\n \"acquirer_name\": \"simulator\",\n \"acquirer_tid\": \"894247649\",\n \"acquirer_nsu\": \"49640\",\n \"acquirer_auth_code\": \"169\",\n \"acquirer_message\": \"Transação capturada com sucesso\",\n \"acquirer_return_code\": \"00\",\n \"entry_mode\": \"ecommerce\",\n \"operation_type\": \"auth_and_capture\",\n \"card\": {\n \"id\": \"card_DwER6M8Cl9hPKAOb\",\n \"first_six_digits\": \"400000\",\n \"last_four_digits\": \"0010\",\n \"brand\": \"Visa\",\n \"holder_name\": \"Homelander\",\n \"exp_month\": 12,\n \"exp_year\": 2025,\n \"status\": \"active\",\n \"type\": \"credit\",\n \"created_at\": \"2023-03-17T14:19:43Z\",\n \"updated_at\": \"2023-03-17T14:19:43Z\",\n \"billing_address\": {\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"line_1\": \"10880, Malibu Point, Malibu Central\"\n },\n \"network_token\": {\n \"token_unique_reference\": \"9cb80642-e3b6-4b30-b233-c54a4857cbf0\",\n \"status\": \"active\"\n }\n },\n \"payment_type\": \"Token\",\n \"created_at\": \"2023-03-17T14:20:28Z\",\n \"updated_at\": \"2023-03-17T14:20:28Z\",\n \"gateway_response\": {\n \"code\": \"200\",\n \"errors\": []\n },\n \"antifraud_response\": {},\n \"metadata\": {}\n }\n}"}},"schema":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","example":"ch_6NXoYXyiNfP3A54l"},"code":{"type":"string","example":"ABCDE123"},"amount":{"type":"integer","example":1490,"default":0},"paid_amount":{"type":"integer","example":1490,"default":0},"status":{"type":"string","example":"paid"},"currency":{"type":"string","example":"BRL"},"payment_method":{"type":"string","example":"credit_card"},"paid_at":{"type":"string","example":"2019-01-22T14:31:36Z"},"created_at":{"type":"string","example":"2019-01-22T14:30:12Z"},"updated_at":{"type":"string","example":"2019-01-22T14:31:36Z"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_PYwJvWgOTmiqvW8m"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"toinhodalua@nasa.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2019-01-18T11:50:37Z"},"updated_at":{"type":"string","example":"2019-01-18T15:46:38Z"},"phones":{"type":"object","properties":{}}}},"last_transaction":{"type":"object","properties":{"id":{"type":"string","example":"tran_QGXDnycJdHKnoVa3"},"transaction_type":{"type":"string","example":"credit_card"},"funding_source":{"type":"string","example":"prepaid"},"amount":{"type":"integer","example":1490,"default":0},"status":{"type":"string","example":"captured"},"success":{"type":"boolean","example":true,"default":true},"installments":{"type":"integer","example":1,"default":0},"statement_descriptor":{"type":"string","example":"AVENGERS"},"acquirer_tid":{"type":"string","example":"cb42d188-aca6-46f2-a2c9-046cb6342f5d"},"acquirer_nsu":{"type":"string","example":"cb42d188-aca6-46f2-a2c9-046cb6342f5d"},"acquirer_auth_code":{"type":"string","example":"416"},"acquirer_message":{"type":"string","example":"Transação capturada com sucesso"},"acquirer_return_code":{"type":"string","example":"00"},"operation_type":{"type":"string","example":"capture"},"card":{"type":"object","properties":{"id":{"type":"string","example":"card_jdK2O53TqfnxwRDY"},"first_six_digits":{"type":"string","example":"400000"},"last_four_digits":{"type":"string","example":"0010"},"brand":{"type":"string","example":"Visa"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":2020,"default":0},"status":{"type":"string","example":"active"},"type":{"type":"string","example":"credit"},"created_at":{"type":"string","example":"2019-01-18T12:25:41Z"},"updated_at":{"type":"string","example":"2019-01-22T14:30:12Z"}}},"created_at":{"type":"string","example":"2019-01-22T14:31:36Z"},"updated_at":{"type":"string","example":"2019-01-22T14:31:36Z"},"gateway_response":{"type":"object","properties":{"code":{"type":"string","example":"200"},"errors":{"type":"array","items":{"type":"object","properties":{}}}}}}},"metadata":{"type":"object","properties":{"code":{"type":"string","example":"123"}}}}},{"title":"OK - Network Token","type":"object","properties":{"id":{"type":"string","example":"ch_Ljvke06fdSErl62x"},"code":{"type":"string","example":"Y387TKKF3L"},"amount":{"type":"integer","example":2990,"default":0},"paid_amount":{"type":"integer","example":2990,"default":0},"status":{"type":"string","example":"paid"},"currency":{"type":"string","example":"BRL"},"payment_method":{"type":"string","example":"credit_card"},"paid_at":{"type":"string","example":"2023-03-17T14:20:28Z"},"created_at":{"type":"string","example":"2023-03-17T14:20:28Z"},"updated_at":{"type":"string","example":"2023-03-17T14:20:28Z"},"order":{"type":"object","properties":{"id":{"type":"string","example":"or_5aEYRKmIwvTqpgoQ"},"code":{"type":"string","example":"Y387TKKF3L"},"amount":{"type":"integer","example":2990,"default":0},"closed":{"type":"boolean","example":true,"default":true},"created_at":{"type":"string","example":"2023-03-17T14:20:27Z"},"updated_at":{"type":"string","example":"2023-03-17T14:20:28Z"},"closed_at":{"type":"string","example":"2023-03-17T14:20:27Z"},"currency":{"type":"string","example":"BRL"},"status":{"type":"string","example":"paid"},"customer_id":{"type":"string","example":"cus_K1oa3LKTZSlW6O7d"}}},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_K1oa3LKTZSlW6O7d"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"avengerstark@ligadajustica.com.br"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2023-03-17T14:19:22Z"},"updated_at":{"type":"string","example":"2023-03-17T14:19:22Z"},"phones":{"type":"object","properties":{}}}},"last_transaction":{"type":"object","properties":{"operation_key":{"type":"string","example":"409945098"},"id":{"type":"string","example":"tran_xbEM0pRmUASgBYAq"},"transaction_type":{"type":"string","example":"credit_card"},"gateway_id":{"type":"string","example":"95e3e8f1-c5fc-4d62-8f0b-80bdc66d3e42"},"amount":{"type":"integer","example":2990,"default":0},"status":{"type":"string","example":"captured"},"success":{"type":"boolean","example":true,"default":true},"installments":{"type":"integer","example":1,"default":0},"installment_type":{"type":"string","example":"merchant"},"statement_descriptor":{"type":"string","example":"AVENGERS"},"acquirer_name":{"type":"string","example":"simulator"},"acquirer_tid":{"type":"string","example":"894247649"},"acquirer_nsu":{"type":"string","example":"49640"},"acquirer_auth_code":{"type":"string","example":"169"},"acquirer_message":{"type":"string","example":"Transação capturada com sucesso"},"acquirer_return_code":{"type":"string","example":"00"},"entry_mode":{"type":"string","example":"ecommerce"},"operation_type":{"type":"string","example":"auth_and_capture"},"card":{"type":"object","properties":{"id":{"type":"string","example":"card_DwER6M8Cl9hPKAOb"},"first_six_digits":{"type":"string","example":"400000"},"last_four_digits":{"type":"string","example":"0010"},"brand":{"type":"string","example":"Visa"},"holder_name":{"type":"string","example":"Homelander"},"exp_month":{"type":"integer","example":12,"default":0},"exp_year":{"type":"integer","example":2025,"default":0},"status":{"type":"string","example":"active"},"type":{"type":"string","example":"credit"},"created_at":{"type":"string","example":"2023-03-17T14:19:43Z"},"updated_at":{"type":"string","example":"2023-03-17T14:19:43Z"},"billing_address":{"type":"object","properties":{"zip_code":{"type":"string","example":"90265"},"city":{"type":"string","example":"Malibu"},"state":{"type":"string","example":"CA"},"country":{"type":"string","example":"US"},"line_1":{"type":"string","example":"10880, Malibu Point, Malibu Central"}}},"network_token":{"type":"object","properties":{"token_unique_reference":{"type":"string","example":"9cb80642-e3b6-4b30-b233-c54a4857cbf0"},"status":{"type":"string","example":"active"}}}}},"payment_type":{"type":"string","example":"Token"},"created_at":{"type":"string","example":"2023-03-17T14:20:28Z"},"updated_at":{"type":"string","example":"2023-03-17T14:20:28Z"},"gateway_response":{"type":"object","properties":{"code":{"type":"string","example":"200"},"errors":{"type":"array","items":{"type":"object","properties":{}}}}},"antifraud_response":{"type":"object","properties":{}},"metadata":{"type":"object","properties":{}}}}}}]}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"delete":{"summary":"Cancelar cobrança","description":"Rota para cancelar uma cobrança. O corpo é opcional: `amount` define o valor a cancelar (sem ele, vale o total da cobrança), `bank_account` é obrigatório apenas no estorno de boleto e `split` define as regras de split e os recebedores que irão participar da divisão dos pagamentos.","operationId":"cancelar-cobrança-com-split-1","parameters":[{"name":"charge_id","in":"path","description":"Código da cobrança.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"amount":{"type":"integer","description":"Valor a ser cancelado. Caso não seja informado, será considerado o valor total da cobrança.","format":"int32"},"split":{"type":"array","description":"Lista de regras de split.","items":{"properties":{"amount":{"type":"integer","description":"Valor destinado ao recebedor.","format":"int32"},"recipient_id":{"type":"string","description":"Código do recebedor. Formato: rp_XXXXXXXXXXXXXXXX."},"type":{"type":"string","description":"Tipo de divisão. Os valores possíveis são flat ou percentage."},"options":{"type":"object","description":"Informações da responsabilidade do recebedor na transação.","properties":{"charge_processing_fee":{"type":"boolean","description":"Indica se o recebedor vinculado à regra será cobrado pelas taxas da transação"},"charge_remainder_fee":{"type":"boolean","description":"Indica se o recebedor vinculado à regra irá receber o restante dos recebíveis após uma divisão"},"liable":{"type":"boolean","description":"Indica se o recebedor é responsável pela transação em caso de chargeback."}}}},"type":"object"}},"bank_account":{"type":"object","description":"Dados da conta bancária do comprador. Somente utilizado para estorno de boleto, onde é um parâmetro obrigatório.","required":["holder_name","holder_type","holder_document","bank","branch_number","account_number","account_check_digit","type"],"properties":{"holder_name":{"type":"string","description":"Nome do titular da conta."},"holder_type":{"type":"string","description":"Tipo de titular. Valores possíveis são **individual** (pessoa física) ou **company** (pessoa jurídica)."},"holder_document":{"type":"string","description":"Número do documento do titular da conta. Deve ser igual ao documento do recebedor."},"bank":{"type":"string","description":"Código do banco."},"branch_number":{"type":"string","description":"Número da agência."},"branch_check_digit":{"type":"string","description":"Código verificador da agência."},"account_number":{"type":"string","description":"Número da conta. Máximo 13 caracteres numéricos."},"account_check_digit":{"type":"string","description":"Código verificador da conta."},"type":{"type":"string","description":"Tipo da conta. Valores possíveis são **checking** (conta corrente) ou **savings** (conta poupança)."}}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Cancelamento com split":{"value":"{\n \"id\": \"ch_bz6VONxuriWqXY0l\",\n \"code\": \"Q7KA3GIZDV\",\n \"gateway_id\": \"7628472\",\n \"amount\": 200,\n \"paid_amount\": 200,\n \"canceled_amount\": 200,\n \"status\": \"canceled\",\n \"currency\": \"BRL\",\n \"payment_method\": \"credit_card\",\n \"paid_at\": \"2020-01-16T15:14:27Z\",\n \"canceled_at\": \"2020-01-16T16:03:49Z\",\n \"created_at\": \"2020-01-16T15:14:21Z\",\n \"updated_at\": \"2020-01-16T16:03:49Z\",\n \"order\": {\n \"id\": \"or_5QXWzjpHRfpw04Dv\",\n \"code\": \"Q7KA3GIZDV\",\n \"amount\": 200,\n \"closed\": true,\n \"created_at\": \"2020-01-16T15:14:21Z\",\n \"updated_at\": \"2020-01-16T16:03:49Z\",\n \"closed_at\": \"2020-01-16T15:14:21Z\",\n \"currency\": \"BRL\",\n \"status\": \"canceled\",\n \"customer_id\": \"cus_nmEG47zTJu88gd6R\"\n },\n \"customer\": {\n \"id\": \"cus_nmEG47zTJu88gd6R\",\n \"name\": \"Tony Stark\",\n \"email\": \"1ad6b8d7-28f7-48ee-80c4-71b087aa7d0a@avengers.com\",\n \"document\": \"93095135270\",\n \"type\": \"individual\",\n \"delinquent\": false,\n \"address\": {\n \"id\": \"addr_w9Nn7z3c3pu8XMQZ\",\n \"line_1\": \"375, Av. General Justo, Centro\",\n \"line_2\": \"8º andar\",\n \"street\": \"Av. General Justo\",\n \"number\": \"375\",\n \"complement\": \"8º andar\",\n \"zip_code\": \"70070300\",\n \"neighborhood\": \"Centro\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BR\",\n \"status\": \"active\",\n \"created_at\": \"2020-01-02T20:23:10Z\",\n \"updated_at\": \"2020-01-02T20:23:10Z\"\n },\n \"created_at\": \"2020-01-02T20:23:10Z\",\n \"updated_at\": \"2020-01-02T20:23:10Z\",\n \"phones\": {\n \"home_phone\": {\n \"country_code\": \"55\",\n \"number\": \"000000000\",\n \"area_code\": \"21\"\n },\n \"mobile_phone\": {\n \"country_code\": \"55\",\n \"number\": \"000000000\",\n \"area_code\": \"21\"\n }\n },\n \"metadata\": {\n \"company\": \"Avengers\"\n }\n },\n \"last_transaction\": {\n \"id\": \"tran_NMloP9hkEhEDRjem\",\n \"transaction_type\": \"credit_card\",\n \"gateway_id\": \"7628472\",\n \"amount\": 100,\n \"status\": \"refunded\",\n \"success\": true,\n \"installments\": 1,\n \"statement_descriptor\": \"AVENGERS\",\n \"acquirer_name\": \"pagarme\",\n \"acquirer_tid\": \"7628472\",\n \"acquirer_nsu\": \"7628472\",\n \"acquirer_return_code\": \"0000\",\n \"operation_type\": \"cancel\",\n \"card\": {\n \"id\": \"card_mYGN6wf9aUao5Vrp\",\n \"first_six_digits\": \"400000\",\n \"last_four_digits\": \"0010\",\n \"brand\": \"Visa\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 2023,\n \"status\": \"active\",\n \"type\": \"credit\",\n \"created_at\": \"2020-01-02T20:23:12Z\",\n \"updated_at\": \"2020-01-02T20:23:12Z\",\n \"billing_address\": {\n \"street\": \"Malibu Point\",\n \"number\": \"10880\",\n \"zip_code\": \"90265\",\n \"neighborhood\": \"Central Malibu\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"line_1\": \"10880, Malibu Point, Central Malibu\"\n }\n },\n \"created_at\": \"2020-01-16T16:03:49Z\",\n \"updated_at\": \"2020-01-16T16:03:49Z\",\n \"gateway_response\": {\n \"code\": \"200\",\n \"errors\": []\n },\n \"antifraud_response\": {},\n \"split\": [\n {\n \"id\": \"sr_bZwklpPh5ASw2k9n\",\n \"type\": \"percentage\",\n \"gateway_id\": \"sr_ck5gvkaia0061q36dfxqmrh1j\",\n \"amount\": 80,\n \"recipient\": {\n \"id\": \"rp_5yGwpMGckBHVYmb6\",\n \"name\": \"First recipient\",\n \"email\": \"first_recipient@pagar.me\",\n \"document\": \"12728994706\",\n \"description\": \"Descrição do recebedor 1\",\n \"type\": \"individual\",\n \"status\": \"active\",\n \"created_at\": \"2020-01-02T20:23:14Z\",\n \"updated_at\": \"2020-01-02T20:23:14Z\"\n },\n \"options\": {\n \"liable\": true,\n \"charge_processing_fee\": true,\n \"charge_remainder_fee\": true\n }\n },\n {\n \"id\": \"sr_6wk7eD6f8EfoKJEP\",\n \"type\": \"percentage\",\n \"gateway_id\": \"sr_ck5gvkaia0062q36dioccqnec\",\n \"amount\": 20,\n \"recipient\": {\n \"id\": \"rp_yLnAyVpHbQIqZxwO\",\n \"name\": \"Second recipient\",\n \"email\": \"second_recipient@pagar.me\",\n \"document\": \"15313587000166\",\n \"description\": \"Descrição do recebedor 2\",\n \"type\": \"company\",\n \"status\": \"active\",\n \"created_at\": \"2020-01-02T20:23:17Z\",\n \"updated_at\": \"2020-01-02T20:23:17Z\"\n },\n \"options\": {\n \"liable\": false,\n \"charge_processing_fee\": false,\n \"charge_remainder_fee\": false\n }\n },\n {\n \"id\": \"sr_2rd784Rt0FyPO3QK\",\n \"type\": \"percentage\",\n \"gateway_id\": \"sr_ck5gvkaia0061q36dfxqmrh1j\",\n \"amount\": 80,\n \"recipient\": {\n \"id\": \"rp_5yGwpMGckBHVYmb6\",\n \"name\": \"First recipient\",\n \"email\": \"first_recipient@pagar.me\",\n \"document\": \"12728994706\",\n \"description\": \"Descrição do recebedor 1\",\n \"type\": \"individual\",\n \"status\": \"active\",\n \"created_at\": \"2020-01-02T20:23:14Z\",\n \"updated_at\": \"2020-01-02T20:23:14Z\"\n },\n \"options\": {\n \"liable\": true,\n \"charge_processing_fee\": true,\n \"charge_remainder_fee\": true\n }\n },\n {\n \"id\": \"sr_mpQWr6ZvfEiXrxNL\",\n \"type\": \"percentage\",\n \"gateway_id\": \"sr_ck5gvkaia0062q36dioccqnec\",\n \"amount\": 20,\n \"recipient\": {\n \"id\": \"rp_yLnAyVpHbQIqZxwO\",\n \"name\": \"Second recipient\",\n \"email\": \"second_recipient@pagar.me\",\n \"document\": \"15313587000166\",\n \"description\": \"Descrição do recebedor 2\",\n \"type\": \"company\",\n \"status\": \"active\",\n \"created_at\": \"2020-01-02T20:23:17Z\",\n \"updated_at\": \"2020-01-02T20:23:17Z\"\n },\n \"options\": {\n \"liable\": false,\n \"charge_processing_fee\": false,\n \"charge_remainder_fee\": false\n }\n }\n ],\n \"metadata\": {}\n }\n}"},"Estorno de cartão de crédito":{"value":"{\n \"id\": \"ch_B4rpRdfBxsVv0NQo\",\n \"code\": \"98ZZUL0F8Z\",\n \"amount\": 1490,\n \"paid_amount\": 1490,\n \"canceled_amount\": 1490,\n \"status\": \"canceled\",\n \"currency\": \"BRL\",\n \"payment_method\": \"credit_card\",\n \"paid_at\": \"2019-01-22T14:40:47Z\",\n \"canceled_at\": \"2019-01-22T14:48:06Z\",\n \"created_at\": \"2019-01-22T14:39:35Z\",\n \"updated_at\": \"2019-01-22T14:48:06Z\",\n \"customer\": {\n \"id\": \"cus_PYwJvWgOTmiqvW8m\",\n \"name\": \"Tony Stark\",\n \"email\": \"toinhodalua@nasa.com\",\n \"delinquent\": false,\n \"created_at\": \"2019-01-18T11:50:37Z\",\n \"updated_at\": \"2019-01-18T15:46:38Z\",\n \"phones\": {}\n },\n \"last_transaction\": {\n \"id\": \"tran_3oR7lMpfEha2LYGn\",\n \"transaction_type\": \"credit_card\",\n \"funding_source\": \"prepaid\",\n \"amount\": 1490,\n \"status\": \"refunded\",\n \"success\": true,\n \"installments\": 1,\n \"statement_descriptor\": \"AVENGERS\",\n \"acquirer_tid\": \"d2b3e1ab-1b24-4d66-93c8-b304776cd782\",\n \"acquirer_nsu\": \"15044\",\n \"acquirer_auth_code\": \"743\",\n \"acquirer_message\": \"Transação capturada com sucesso\",\n \"acquirer_return_code\": \"00\",\n \"operation_type\": \"cancel\",\n \"card\": {\n \"id\": \"card_jdK2O53TqfnxwRDY\",\n \"first_six_digits\": \"400000\",\n \"last_four_digits\": \"0010\",\n \"brand\": \"Visa\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 2030,\n \"status\": \"active\",\n \"type\": \"credit\",\n \"created_at\": \"2019-01-18T12:25:41Z\",\n \"updated_at\": \"2019-01-22T14:39:01Z\",\n \"billing_address\": {\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"line_1\": \"10880, Malibu Point, Malibu Central\"\n }\n },\n \"created_at\": \"2019-01-22T14:48:06Z\",\n \"updated_at\": \"2019-01-22T14:48:06Z\",\n \"gateway_response\": {\n \"code\": \"200\",\n \"errors\": []\n }\n },\n \"metadata\": {\n \"code\": \"123\"\n }\n}"},"Estorno de boleto":{"value":"{\n \"id\": \"ch_YBEgkbYfmiW20mNL\",\n \"code\": \"1K9RBZ8AE1\",\n \"gateway_id\": \"23883236\",\n \"amount\": 2990,\n \"paid_amount\": 2990,\n \"status\": \"processing\",\n \"currency\": \"BRL\",\n \"payment_method\": \"boleto\",\n \"paid_at\": \"2023-07-03T16:23:58Z\",\n \"created_at\": \"2023-07-03T16:23:29Z\",\n \"updated_at\": \"2023-07-03T16:24:44Z\",\n \"order\": {\n \"id\": \"or_0oqY4JWizohEwWZ8\",\n \"code\": \"1K9RBZ8AE1\",\n \"amount\": 2990,\n \"closed\": true,\n \"created_at\": \"2023-07-03T16:23:29Z\",\n \"updated_at\": \"2023-07-03T16:24:44Z\",\n \"closed_at\": \"2023-07-03T16:23:29Z\",\n \"currency\": \"BRL\",\n \"status\": \"pending\",\n \"customer_id\": \"cus_7g1QJ2AidijyRlLW\"\n },\n \"customer\": {\n \"id\": \"cus_7g1QJ2AidijyRlLW\",\n \"name\": \"Claudio Jose Sergio Viana\",\n \"email\": \"claudio_viana@valeguinchos.com.br\",\n \"code\": \"1234\",\n \"document\": \"29704428685\",\n \"type\": \"individual\",\n \"delinquent\": false,\n \"address\": {\n \"id\": \"addr_mkL43lNfMfkaqgl2\",\n \"line_1\": \"375, Av. General Justo, Centro\",\n \"line_2\": \"8º andar\",\n \"zip_code\": \"20021130\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BR\",\n \"status\": \"active\",\n \"created_at\": \"2022-06-15T19:40:04Z\",\n \"updated_at\": \"2022-08-17T18:48:12Z\"\n },\n \"created_at\": \"2022-06-15T19:40:04Z\",\n \"updated_at\": \"2022-08-17T18:48:12Z\",\n \"phones\": {\n \"home_phone\": {\n \"country_code\": \"55\",\n \"number\": \"000000000\",\n \"area_code\": \"21\"\n }\n }\n },\n \"last_transaction\": {\n \"id\": \"tran_yvwnO9hJpT7GPB2e\",\n \"transaction_type\": \"boleto\",\n \"gateway_id\": \"23883236\",\n \"amount\": 2990,\n \"status\": \"pending_refund\",\n \"success\": true,\n \"paid_amount\": 2990,\n \"paid_at\": \"2023-07-03T16:23:58Z\",\n \"url\": \"https://pagar.me\",\n \"pdf\": \"https://pagar.me?format=pdf\",\n \"line\": \"1234 5678\",\n \"barcode\": \"https://api.stone.com.br/core/v5/transactions/tran_yBx3l2ysW9CAGwqa/barcode\",\n \"qr_code\": \"https://api.stone.com.br/core/v5/transactions/tran_yBx3l2ysW9CAGwqa/qrcode\",\n \"nosso_numero\": \"23883236\",\n \"type\": \"DM\",\n \"bank\": \"198\",\n \"document_number\": \"23883236\",\n \"instructions\": \"Pagar\",\n \"due_at\": \"2025-02-20T23:59:59Z\",\n \"created_at\": \"2023-07-03T16:24:43Z\",\n \"updated_at\": \"2023-07-03T16:24:43Z\",\n \"gateway_response\": {\n \"errors\": [\n {}\n ]\n },\n \"antifraud_response\": {},\n \"metadata\": {}\n }\n}"}},"schema":{"oneOf":[{"title":"Cancelamento com split","type":"object","properties":{"id":{"type":"string","example":"ch_bz6VONxuriWqXY0l"},"code":{"type":"string","example":"Q7KA3GIZDV"},"gateway_id":{"type":"string","example":"7628472"},"amount":{"type":"integer","example":200,"default":0},"paid_amount":{"type":"integer","example":200,"default":0},"canceled_amount":{"type":"integer","example":200,"default":0},"status":{"type":"string","example":"canceled"},"currency":{"type":"string","example":"BRL"},"payment_method":{"type":"string","example":"credit_card"},"paid_at":{"type":"string","example":"2020-01-16T15:14:27Z"},"canceled_at":{"type":"string","example":"2020-01-16T16:03:49Z"},"created_at":{"type":"string","example":"2020-01-16T15:14:21Z"},"updated_at":{"type":"string","example":"2020-01-16T16:03:49Z"},"order":{"type":"object","properties":{"id":{"type":"string","example":"or_5QXWzjpHRfpw04Dv"},"code":{"type":"string","example":"Q7KA3GIZDV"},"amount":{"type":"integer","example":200,"default":0},"closed":{"type":"boolean","example":true,"default":true},"created_at":{"type":"string","example":"2020-01-16T15:14:21Z"},"updated_at":{"type":"string","example":"2020-01-16T16:03:49Z"},"closed_at":{"type":"string","example":"2020-01-16T15:14:21Z"},"currency":{"type":"string","example":"BRL"},"status":{"type":"string","example":"canceled"},"customer_id":{"type":"string","example":"cus_nmEG47zTJu88gd6R"}}},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_nmEG47zTJu88gd6R"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"1ad6b8d7-28f7-48ee-80c4-71b087aa7d0a@avengers.com"},"document":{"type":"string","example":"93095135270"},"type":{"type":"string","example":"individual"},"delinquent":{"type":"boolean","example":false,"default":true},"address":{"type":"object","properties":{"id":{"type":"string","example":"addr_w9Nn7z3c3pu8XMQZ"},"line_1":{"type":"string","example":"375, Av. General Justo, Centro"},"line_2":{"type":"string","example":"8º andar"},"street":{"type":"string","example":"Av. General Justo"},"number":{"type":"string","example":"375"},"complement":{"type":"string","example":"8º andar"},"zip_code":{"type":"string","example":"70070300"},"neighborhood":{"type":"string","example":"Centro"},"city":{"type":"string","example":"Rio de Janeiro"},"state":{"type":"string","example":"RJ"},"country":{"type":"string","example":"BR"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2020-01-02T20:23:10Z"},"updated_at":{"type":"string","example":"2020-01-02T20:23:10Z"}}},"created_at":{"type":"string","example":"2020-01-02T20:23:10Z"},"updated_at":{"type":"string","example":"2020-01-02T20:23:10Z"},"phones":{"type":"object","properties":{"home_phone":{"type":"object","properties":{"country_code":{"type":"string","example":"55"},"number":{"type":"string","example":"000000000"},"area_code":{"type":"string","example":"21"}}},"mobile_phone":{"type":"object","properties":{"country_code":{"type":"string","example":"55"},"number":{"type":"string","example":"000000000"},"area_code":{"type":"string","example":"21"}}}}},"metadata":{"type":"object","properties":{"company":{"type":"string","example":"Avengers"}}}}},"last_transaction":{"type":"object","properties":{"id":{"type":"string","example":"tran_NMloP9hkEhEDRjem"},"transaction_type":{"type":"string","example":"credit_card"},"gateway_id":{"type":"string","example":"7628472"},"amount":{"type":"integer","example":100,"default":0},"status":{"type":"string","example":"refunded"},"success":{"type":"boolean","example":true,"default":true},"installments":{"type":"integer","example":1,"default":0},"statement_descriptor":{"type":"string","example":"AVENGERS"},"acquirer_name":{"type":"string","example":"pagarme"},"acquirer_tid":{"type":"string","example":"7628472"},"acquirer_nsu":{"type":"string","example":"7628472"},"acquirer_return_code":{"type":"string","example":"0000"},"operation_type":{"type":"string","example":"cancel"},"card":{"type":"object","properties":{"id":{"type":"string","example":"card_mYGN6wf9aUao5Vrp"},"first_six_digits":{"type":"string","example":"400000"},"last_four_digits":{"type":"string","example":"0010"},"brand":{"type":"string","example":"Visa"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":2023,"default":0},"status":{"type":"string","example":"active"},"type":{"type":"string","example":"credit"},"created_at":{"type":"string","example":"2020-01-02T20:23:12Z"},"updated_at":{"type":"string","example":"2020-01-02T20:23:12Z"},"billing_address":{"type":"object","properties":{"street":{"type":"string","example":"Malibu Point"},"number":{"type":"string","example":"10880"},"zip_code":{"type":"string","example":"90265"},"neighborhood":{"type":"string","example":"Central Malibu"},"city":{"type":"string","example":"Malibu"},"state":{"type":"string","example":"CA"},"country":{"type":"string","example":"US"},"line_1":{"type":"string","example":"10880, Malibu Point, Central Malibu"}}}}},"created_at":{"type":"string","example":"2020-01-16T16:03:49Z"},"updated_at":{"type":"string","example":"2020-01-16T16:03:49Z"},"gateway_response":{"type":"object","properties":{"code":{"type":"string","example":"200"},"errors":{"type":"array","items":{"type":"object","properties":{}}}}},"antifraud_response":{"type":"object","properties":{}},"split":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"sr_bZwklpPh5ASw2k9n"},"type":{"type":"string","example":"percentage"},"gateway_id":{"type":"string","example":"sr_ck5gvkaia0061q36dfxqmrh1j"},"amount":{"type":"integer","example":80,"default":0},"recipient":{"type":"object","properties":{"id":{"type":"string","example":"rp_5yGwpMGckBHVYmb6"},"name":{"type":"string","example":"First recipient"},"email":{"type":"string","example":"first_recipient@pagar.me"},"document":{"type":"string","example":"12728994706"},"description":{"type":"string","example":"Descrição do recebedor 1"},"type":{"type":"string","example":"individual"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2020-01-02T20:23:14Z"},"updated_at":{"type":"string","example":"2020-01-02T20:23:14Z"}}},"options":{"type":"object","properties":{"liable":{"type":"boolean","example":true,"default":true},"charge_processing_fee":{"type":"boolean","example":true,"default":true},"charge_remainder_fee":{"type":"boolean","example":true,"default":true}}}}}},"metadata":{"type":"object","properties":{}}}}}},{"title":"Estorno de cartão de crédito","type":"object","properties":{"id":{"type":"string","example":"ch_B4rpRdfBxsVv0NQo"},"code":{"type":"string","example":"98ZZUL0F8Z"},"amount":{"type":"integer","example":1490,"default":0},"paid_amount":{"type":"integer","example":1490,"default":0},"canceled_amount":{"type":"integer","example":1490,"default":0},"status":{"type":"string","example":"canceled"},"currency":{"type":"string","example":"BRL"},"payment_method":{"type":"string","example":"credit_card"},"paid_at":{"type":"string","example":"2019-01-22T14:40:47Z"},"canceled_at":{"type":"string","example":"2019-01-22T14:48:06Z"},"created_at":{"type":"string","example":"2019-01-22T14:39:35Z"},"updated_at":{"type":"string","example":"2019-01-22T14:48:06Z"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_PYwJvWgOTmiqvW8m"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"toinhodalua@nasa.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2019-01-18T11:50:37Z"},"updated_at":{"type":"string","example":"2019-01-18T15:46:38Z"},"phones":{"type":"object","properties":{}}}},"last_transaction":{"type":"object","properties":{"id":{"type":"string","example":"tran_3oR7lMpfEha2LYGn"},"transaction_type":{"type":"string","example":"credit_card"},"funding_source":{"type":"string","example":"prepaid"},"amount":{"type":"integer","example":1490,"default":0},"status":{"type":"string","example":"refunded"},"success":{"type":"boolean","example":true,"default":true},"installments":{"type":"integer","example":1,"default":0},"statement_descriptor":{"type":"string","example":"AVENGERS"},"acquirer_tid":{"type":"string","example":"d2b3e1ab-1b24-4d66-93c8-b304776cd782"},"acquirer_nsu":{"type":"string","example":"15044"},"acquirer_auth_code":{"type":"string","example":"743"},"acquirer_message":{"type":"string","example":"Transação capturada com sucesso"},"acquirer_return_code":{"type":"string","example":"00"},"operation_type":{"type":"string","example":"cancel"},"card":{"type":"object","properties":{"id":{"type":"string","example":"card_jdK2O53TqfnxwRDY"},"first_six_digits":{"type":"string","example":"400000"},"last_four_digits":{"type":"string","example":"0010"},"brand":{"type":"string","example":"Visa"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":2030,"default":0},"status":{"type":"string","example":"active"},"type":{"type":"string","example":"credit"},"created_at":{"type":"string","example":"2019-01-18T12:25:41Z"},"updated_at":{"type":"string","example":"2019-01-22T14:39:01Z"},"billing_address":{"type":"object","properties":{"zip_code":{"type":"string","example":"90265"},"city":{"type":"string","example":"Malibu"},"state":{"type":"string","example":"CA"},"country":{"type":"string","example":"US"},"line_1":{"type":"string","example":"10880, Malibu Point, Malibu Central"}}}}},"created_at":{"type":"string","example":"2019-01-22T14:48:06Z"},"updated_at":{"type":"string","example":"2019-01-22T14:48:06Z"},"gateway_response":{"type":"object","properties":{"code":{"type":"string","example":"200"},"errors":{"type":"array","items":{"type":"object","properties":{}}}}}}},"metadata":{"type":"object","properties":{"code":{"type":"string","example":"123"}}}}},{"title":"Estorno de boleto","type":"object","properties":{"id":{"type":"string","example":"ch_YBEgkbYfmiW20mNL"},"code":{"type":"string","example":"1K9RBZ8AE1"},"gateway_id":{"type":"string","example":"23883236"},"amount":{"type":"integer","example":2990,"default":0},"paid_amount":{"type":"integer","example":2990,"default":0},"status":{"type":"string","example":"processing"},"currency":{"type":"string","example":"BRL"},"payment_method":{"type":"string","example":"boleto"},"paid_at":{"type":"string","example":"2023-07-03T16:23:58Z"},"created_at":{"type":"string","example":"2023-07-03T16:23:29Z"},"updated_at":{"type":"string","example":"2023-07-03T16:24:44Z"},"order":{"type":"object","properties":{"id":{"type":"string","example":"or_0oqY4JWizohEwWZ8"},"code":{"type":"string","example":"1K9RBZ8AE1"},"amount":{"type":"integer","example":2990,"default":0},"closed":{"type":"boolean","example":true,"default":true},"created_at":{"type":"string","example":"2023-07-03T16:23:29Z"},"updated_at":{"type":"string","example":"2023-07-03T16:24:44Z"},"closed_at":{"type":"string","example":"2023-07-03T16:23:29Z"},"currency":{"type":"string","example":"BRL"},"status":{"type":"string","example":"pending"},"customer_id":{"type":"string","example":"cus_7g1QJ2AidijyRlLW"}}},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_7g1QJ2AidijyRlLW"},"name":{"type":"string","example":"Claudio Jose Sergio Viana"},"email":{"type":"string","example":"claudio_viana@valeguinchos.com.br"},"code":{"type":"string","example":"1234"},"document":{"type":"string","example":"29704428685"},"type":{"type":"string","example":"individual"},"delinquent":{"type":"boolean","example":false,"default":true},"address":{"type":"object","properties":{"id":{"type":"string","example":"addr_mkL43lNfMfkaqgl2"},"line_1":{"type":"string","example":"375, Av. General Justo, Centro"},"line_2":{"type":"string","example":"8º andar"},"zip_code":{"type":"string","example":"20021130"},"city":{"type":"string","example":"Rio de Janeiro"},"state":{"type":"string","example":"RJ"},"country":{"type":"string","example":"BR"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2022-06-15T19:40:04Z"},"updated_at":{"type":"string","example":"2022-08-17T18:48:12Z"}}},"created_at":{"type":"string","example":"2022-06-15T19:40:04Z"},"updated_at":{"type":"string","example":"2022-08-17T18:48:12Z"},"phones":{"type":"object","properties":{"home_phone":{"type":"object","properties":{"country_code":{"type":"string","example":"55"},"number":{"type":"string","example":"000000000"},"area_code":{"type":"string","example":"21"}}}}}}},"last_transaction":{"type":"object","properties":{"id":{"type":"string","example":"tran_yvwnO9hJpT7GPB2e"},"transaction_type":{"type":"string","example":"boleto"},"gateway_id":{"type":"string","example":"23883236"},"amount":{"type":"integer","example":2990,"default":0},"status":{"type":"string","example":"pending_refund"},"success":{"type":"boolean","example":true,"default":true},"paid_amount":{"type":"integer","example":2990,"default":0},"paid_at":{"type":"string","example":"2023-07-03T16:23:58Z"},"url":{"type":"string","example":"https://pagar.me"},"pdf":{"type":"string","example":"https://pagar.me?format=pdf"},"line":{"type":"string","example":"1234 5678"},"barcode":{"type":"string","example":"https://api.stone.com.br/core/v5/transactions/tran_yBx3l2ysW9CAGwqa/barcode"},"qr_code":{"type":"string","example":"https://api.stone.com.br/core/v5/transactions/tran_yBx3l2ysW9CAGwqa/qrcode"},"nosso_numero":{"type":"string","example":"23883236"},"type":{"type":"string","example":"DM"},"bank":{"type":"string","example":"198"},"document_number":{"type":"string","example":"23883236"},"instructions":{"type":"string","example":"Pagar"},"due_at":{"type":"string","example":"2025-02-20T23:59:59Z"},"created_at":{"type":"string","example":"2023-07-03T16:24:43Z"},"updated_at":{"type":"string","example":"2023-07-03T16:24:43Z"},"gateway_response":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{}}}}},"antifraud_response":{"type":"object","properties":{}},"metadata":{"type":"object","properties":{}}}}}}]}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/charges/{charge_id}/card":{"patch":{"summary":"Editar cartão de cobrança","description":"Esse recurso só pode ser chamado quando o cartão a ser editado teve a transação não autorizada.","operationId":"editar-cartão-de-cobrança","parameters":[{"name":"charge_id","in":"path","description":"Código da cobrança.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"update_subscription":{"type":"string","description":"Indica se o cartão da assinatura deve ser atualizado","default":"false"},"card_id":{"type":"string","description":"Código do cartão."},"card":{"type":"object","description":"Dados do cartão. [Saiba mais sobre cartões](https://docs.pagar.me/reference/cart%C3%B5es-1).","required":["number","holder_name","exp_month","exp_year"],"properties":{"number":{"type":"string","description":"Número do cartão. Entre 13 e 19 caracteres"},"holder_name":{"type":"string","description":"Nome do portador como está impresso no cartão. Máximo de 64 caracteres (Caracteres especiais e números não são aceitos)"},"holder_document":{"type":"string","description":"CPF ou CNPJ do portador do cartão. Obrigatório caso o tipo do cartão seja voucher (bandeiras VR ou Pluxee)."},"exp_month":{"type":"integer","description":"Mês de validade do cartão. Valor entre 1 e 12 (inclusive)","format":"int32"},"exp_year":{"type":"integer","description":"Ano de validade do cartão. Formatos yy ou yyyy. Ex: 23 ou 2023.","format":"int32"},"cvv":{"type":"string","description":"Código de segurança do cartão. O campo aceita 4 ou 3 caracteres, variando por bandeira."},"brand":{"type":"string","description":"(Opcional) Bandeira do cartão. Para cartões de crédito, temos como valores possíveis: Elo, Mastercard, Visa, Amex, ou Hipercard. Para voucher, temos como valores possíveis: Alelo, Ticket, VR ou Pluxee."},"label":{"type":"string","description":"Indica a label do cartão"},"billing_address_id":{"type":"string","description":"Código do endereço de cobrança. Max: 36 caracteres.<>Opcional, pode ser utilizado no lugar do billing_address."},"billing_address":{"type":"object","properties":{"line_1":{"type":"string","description":"Linha 1 do endereço. (Número, Rua, e Bairro - Nesta ordem e separados por vírgula) Max: 256 caracteres."},"line_2":{"type":"string","description":"Linha 2 do endereço. (Complemento - Andar, Sala, Apto). Max: 128 caracteres."},"zip_code":{"type":"string","description":"CEP. Max: 16 caracteres."},"city":{"type":"string","description":"Cidade. Max: 64 caracteres."},"state":{"type":"string","description":"Código do estado no formato ISO 3166-2."},"country":{"type":"string","description":"Código do país no formato ISO 3166-1 alpha-2."}}}}},"card_token":{"type":"string","description":"Token do cartão"},"initiated_type":{"type":"string","description":"Identificador do tipo de transação avulsa. Valores possíveis: `partial_shipment` (Remessa Parcial), `related_or_delayed_charge` (Cobrança Atrasada), `no_show` (Multa) ou `retry` (Retentativa). [Mais detalhes](https://docs.pagar.me/page/mitcit-transa%C3%A7%C3%B5es-card-on-file-mastercard)."},"recurrence_model":{"type":"string","description":"Identificador do tipo de recorrência. Valores possíveis: `standing_order` (Ordem Permanente), `instalment` (Parcelamento) ou `subscription` (Assinatura convencional com valor e frequência fixa). [Mais detalhes](https://docs.pagar.me/page/mitcit-transa%C3%A7%C3%B5es-card-on-file-mastercard)."},"payment_origin":{"type":"object","description":"Identificador da primeira cobrança de uma recorrência. [Mais detalhes](https://docs.pagar.me/docs/api-v5-identificador-de-recorr%C3%AAncia-para-assinaturas-externas).","properties":{"charge_id":{"type":"string","description":"Identificador da cobrança"},"brand_id":{"type":"string","description":"Identificador da bandeira"}}}}},"examples":{"Request Example":{"value":{"card":{"number":"4000000000000010","holder_name":"Tony Stark","exp_month":1,"exp_year":30,"cvv":"3531","billing_address":{"line_1":"10880, Malibu Point, Malibu Central","zip_code":"90265","city":"Malibu","state":"CA","country":"US"}}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"ch_B4rpRdfBxsVv0NQo\",\n \"code\": \"98ZZUL0F8Z\",\n \"amount\": 1490,\n \"paid_amount\": 1490,\n \"status\": \"paid\",\n \"currency\": \"BRL\",\n \"payment_method\": \"credit_card\",\n \"paid_at\": \"2019-01-22T14:40:47Z\",\n \"created_at\": \"2019-01-22T14:39:35Z\",\n \"updated_at\": \"2019-01-22T14:40:47Z\",\n \"customer\": {\n \"id\": \"cus_PYwJvWgOTmiqvW8m\",\n \"name\": \"Tony Stark\",\n \"email\": \"toinhodalua@nasa.com\",\n \"delinquent\": false,\n \"created_at\": \"2019-01-18T11:50:37Z\",\n \"updated_at\": \"2019-01-18T15:46:38Z\",\n \"phones\": {}\n },\n \"last_transaction\": {\n \"id\": \"tran_jad0jXPhotb2eNkr\",\n \"transaction_type\": \"credit_card\",\n \"funding_source\": \"prepaid\",\n \"gateway_id\": \"6f2db50c-cb32-4211-bd71-3450e4b900f7\",\n \"amount\": 1490,\n \"status\": \"captured\",\n \"success\": true,\n \"installments\": 1,\n \"statement_descriptor\": \"AVENGERS\",\n \"acquirer_tid\": \"d2b3e1ab-1b24-4d66-93c8-b304776cd782\",\n \"acquirer_nsu\": \"d2b3e1ab-1b24-4d66-93c8-b304776cd782\",\n \"acquirer_auth_code\": \"743\",\n \"acquirer_message\": \"Transação capturada com sucesso\",\n \"acquirer_return_code\": \"00\",\n \"operation_type\": \"auth_and_capture\",\n \"card\": {\n \"id\": \"card_jdK2O53TqfnxwRDY\",\n \"first_six_digits\": \"400000\",\n \"last_four_digits\": \"0010\",\n \"brand\": \"Visa\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 2030,\n \"status\": \"active\",\n \"type\": \"credit\",\n \"created_at\": \"2019-01-18T12:25:41Z\",\n \"updated_at\": \"2019-01-22T14:39:01Z\",\n \"billing_address\": {\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"line_1\": \"10880, Malibu Point, Malibu Central\"\n }\n },\n \"created_at\": \"2019-01-22T14:40:47Z\",\n \"updated_at\": \"2019-01-22T14:40:47Z\",\n \"gateway_response\": {\n \"code\": \"200\",\n \"errors\": []\n }\n },\n \"metadata\": {\n \"code\": \"123\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"ch_B4rpRdfBxsVv0NQo"},"code":{"type":"string","example":"98ZZUL0F8Z"},"amount":{"type":"integer","example":1490,"default":0},"paid_amount":{"type":"integer","example":1490,"default":0},"status":{"type":"string","example":"paid"},"currency":{"type":"string","example":"BRL"},"payment_method":{"type":"string","example":"credit_card"},"paid_at":{"type":"string","example":"2019-01-22T14:40:47Z"},"created_at":{"type":"string","example":"2019-01-22T14:39:35Z"},"updated_at":{"type":"string","example":"2019-01-22T14:40:47Z"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_PYwJvWgOTmiqvW8m"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"toinhodalua@nasa.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2019-01-18T11:50:37Z"},"updated_at":{"type":"string","example":"2019-01-18T15:46:38Z"},"phones":{"type":"object","properties":{}}}},"last_transaction":{"type":"object","properties":{"id":{"type":"string","example":"tran_jad0jXPhotb2eNkr"},"transaction_type":{"type":"string","example":"credit_card"},"funding_source":{"type":"string","example":"prepaid"},"gateway_id":{"type":"string","example":"6f2db50c-cb32-4211-bd71-3450e4b900f7"},"amount":{"type":"integer","example":1490,"default":0},"status":{"type":"string","example":"captured"},"success":{"type":"boolean","example":true,"default":true},"installments":{"type":"integer","example":1,"default":0},"statement_descriptor":{"type":"string","example":"AVENGERS"},"acquirer_tid":{"type":"string","example":"d2b3e1ab-1b24-4d66-93c8-b304776cd782"},"acquirer_nsu":{"type":"string","example":"d2b3e1ab-1b24-4d66-93c8-b304776cd782"},"acquirer_auth_code":{"type":"string","example":"743"},"acquirer_message":{"type":"string","example":"Transação capturada com sucesso"},"acquirer_return_code":{"type":"string","example":"00"},"operation_type":{"type":"string","example":"auth_and_capture"},"card":{"type":"object","properties":{"id":{"type":"string","example":"card_jdK2O53TqfnxwRDY"},"first_six_digits":{"type":"string","example":"400000"},"last_four_digits":{"type":"string","example":"0010"},"brand":{"type":"string","example":"Visa"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":2030,"default":0},"status":{"type":"string","example":"active"},"type":{"type":"string","example":"credit"},"created_at":{"type":"string","example":"2019-01-18T12:25:41Z"},"updated_at":{"type":"string","example":"2019-01-22T14:39:01Z"},"billing_address":{"type":"object","properties":{"zip_code":{"type":"string","example":"90265"},"city":{"type":"string","example":"Malibu"},"state":{"type":"string","example":"CA"},"country":{"type":"string","example":"US"},"line_1":{"type":"string","example":"10880, Malibu Point, Malibu Central"}}}}},"created_at":{"type":"string","example":"2019-01-22T14:40:47Z"},"updated_at":{"type":"string","example":"2019-01-22T14:40:47Z"},"gateway_response":{"type":"object","properties":{"code":{"type":"string","example":"200"},"errors":{"type":"array","items":{"type":"object","properties":{}}}}}}},"metadata":{"type":"object","properties":{"code":{"type":"string","example":"123"}}}}}}}},"412":{"description":"412","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"This charge may not have changed the card.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"This charge may not have changed the card."}}}}}}},"deprecated":false}},"/charges/{charge_id}/due-date":{"patch":{"summary":"Editar data de vencimento da cobrança","description":"","operationId":"editar-data-de-vencimento-da-cobrança","parameters":[{"name":"charge_id","in":"path","description":"Código da cobrança.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["due_at"],"properties":{"due_at":{"type":"string","description":"Data de vencimento.","format":"date"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"ch_9R6419s6Btvp4ykO\",\n \"code\": \"R8VI5WU79R\",\n \"gateway_id\": \"efda8d57-50d8-4b19-b2d4-873bee2e1b62\",\n \"amount\": 14900000,\n \"status\": \"pending\",\n \"currency\": \"BRL\",\n \"payment_method\": \"boleto\",\n \"due_at\": \"2017-04-04T00:00:00\",\n \"created_at\": \"2017-04-04T21:34:32\",\n \"updated_at\": \"2017-04-04T21:44:05\",\n \"customer\": {\n \"id\": \"cus_aEkwKv0SmNHMR931\",\n \"name\": \"Luke Skywalker\",\n \"email\": \"lskywalker@r2d2.com\",\n \"delinquent\": false,\n \"created_at\": \"2017-04-04T19:41:31\",\n \"updated_at\": \"2017-04-04T19:41:31\"\n },\n \"last_transaction\": {\n \"id\": \"tran_E3r7OrMh3hbjvwKj\",\n \"transaction_type\": \"boleto\",\n \"gateway_id\": \"19372a76-a8de-4017-aa91-8c9d21c34185\",\n \"amount\": 14900000,\n \"status\": \"generated\",\n \"success\": true,\n \"url\": \"https://sandbox.pagar.me/Boleto/ViewBoleto.aspx?19372a76-a8de-4017-aa91-8c9d21c34185\",\n \"pdf\": \"https://api.stone.com.br/core/v1.0/transactions/tran_E3r7OrMh3hbjvwKj/pdf\",\n \"line\": \"34191.75009 03073.581237 41234.510000 2 71240014900000\",\n \"barcode\": \"https://api.stone.com.br/core/v1.0/transactions/tran_E3r7OrMh3hbjvwKj/barcode\",\n \"qr_code\": \"https://api.stone.com.br/core/v1.0/transactions/tran_E3r7OrMh3hbjvwKj/qrcode\",\n \"nosso_numero\": \"00030735\",\n \"bank\": \"001\",\n \"document_number\": \"094408333\",\n \"created_at\": \"2017-04-04T21:44:05\",\n \"updated_at\": \"2017-04-04T21:44:05\"\n },\n \"metadata\": {\n \"id\": \"my_charge_id\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"ch_9R6419s6Btvp4ykO"},"code":{"type":"string","example":"R8VI5WU79R"},"gateway_id":{"type":"string","example":"efda8d57-50d8-4b19-b2d4-873bee2e1b62"},"amount":{"type":"integer","example":14900000,"default":0},"status":{"type":"string","example":"pending"},"currency":{"type":"string","example":"BRL"},"payment_method":{"type":"string","example":"boleto"},"due_at":{"type":"string","example":"2017-04-04T00:00:00"},"created_at":{"type":"string","example":"2017-04-04T21:34:32"},"updated_at":{"type":"string","example":"2017-04-04T21:44:05"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_aEkwKv0SmNHMR931"},"name":{"type":"string","example":"Luke Skywalker"},"email":{"type":"string","example":"lskywalker@r2d2.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2017-04-04T19:41:31"},"updated_at":{"type":"string","example":"2017-04-04T19:41:31"}}},"last_transaction":{"type":"object","properties":{"id":{"type":"string","example":"tran_E3r7OrMh3hbjvwKj"},"transaction_type":{"type":"string","example":"boleto"},"gateway_id":{"type":"string","example":"19372a76-a8de-4017-aa91-8c9d21c34185"},"amount":{"type":"integer","example":14900000,"default":0},"status":{"type":"string","example":"generated"},"success":{"type":"boolean","example":true,"default":true},"url":{"type":"string","example":"https://sandbox.pagar.me/Boleto/ViewBoleto.aspx?19372a76-a8de-4017-aa91-8c9d21c34185"},"pdf":{"type":"string","example":"https://api.stone.com.br/core/v1.0/transactions/tran_E3r7OrMh3hbjvwKj/pdf"},"line":{"type":"string","example":"34191.75009 03073.581237 41234.510000 2 71240014900000"},"barcode":{"type":"string","example":"https://api.stone.com.br/core/v1.0/transactions/tran_E3r7OrMh3hbjvwKj/barcode"},"qr_code":{"type":"string","example":"https://api.stone.com.br/core/v1.0/transactions/tran_E3r7OrMh3hbjvwKj/qrcode"},"nosso_numero":{"type":"string","example":"00030735"},"bank":{"type":"string","example":"001"},"document_number":{"type":"string","example":"094408333"},"created_at":{"type":"string","example":"2017-04-04T21:44:05"},"updated_at":{"type":"string","example":"2017-04-04T21:44:05"}}},"metadata":{"type":"object","properties":{"id":{"type":"string","example":"my_charge_id"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/charges/{charge_id}/payment-method":{"patch":{"summary":"Editar método de pagamento","description":"","operationId":"editar-método-de-pagamento","parameters":[{"name":"charge_id","in":"path","description":"Código da cobrança.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["payment_method"],"properties":{"update_subscription":{"type":"string","description":"Indica se o meio de pagamento da assinatura deve ser atualizado"},"payment_method":{"type":"string","description":"Meio de pagamento. Valores possíveis: **credit_card**, **boleto**, **voucher**, **bank_transfer** ou **safety_pay**"},"credit_card":{"type":"object","description":"Dados sobre o pagamento com cartão de crédito (obrigatório caso **payment_method** seja **credit_card**).","properties":{"operation_type":{"type":"string","description":"Indica se a transação deve ser capturada \"auth_and_capture\", autorizada \"auth_only\", ou pré autorizada \"pre_auth\"."},"installments":{"type":"integer","description":"Quantidade de parcelas. Se a transação for uma recorrência, o número de parcelas deverá ser 1.","format":"int32"},"statement_descriptor":{"type":"string","description":"Texto exibido na fatura do cartão. Max: 22 caracteres para clientes Gateway; 13 para clientes PSP"},"card":{"type":"object","description":"Cartão de crédito.","required":["number","holder_name","exp_month","exp_year"],"properties":{"number":{"type":"string","description":"Número do cartão. Entre 13 e 19 caracteres"},"holder_name":{"type":"string","description":"Nome do portador como está impresso no cartão. Máximo de 64 caracteres (Caracteres especiais e números não são aceitos)"},"holder_document":{"type":"string","description":"CPF ou CNPJ do portador do cartão. Obrigatório caso o tipo do cartão seja voucher (bandeiras VR ou Pluxee)."},"exp_month":{"type":"integer","description":"Mês de validade do cartão. Valor entre 1 e 12 (inclusive)","format":"int32"},"exp_year":{"type":"integer","description":"Ano de validade do cartão. Formatos yy ou yyyy. Ex: 23 ou 2023.","format":"int32"},"cvv":{"type":"string","description":"Código de segurança do cartão. O campo aceita 4 ou 3 caracteres, variando por bandeira."},"brand":{"type":"string","description":"(Opcional) Bandeira do cartão. Para cartões de crédito, temos como valores possíveis: Elo, Mastercard, Visa, Amex, ou Hipercard. Para voucher, temos como valores possíveis: Alelo, Ticket, VR ou Pluxee."},"label":{"type":"string","description":"Indica a label do cartão"},"billing_address_id":{"type":"string","description":"Código do endereço de cobrança. Max: 36 caracteres.<>Opcional, pode ser utilizado no lugar do billing_address."},"billing_address":{"type":"object","properties":{"line_1":{"type":"string","description":"Linha 1 do endereço. (Número, Rua, e Bairro - Nesta ordem e separados por vírgula) Max: 256 caracteres."},"line_2":{"type":"string","description":"Linha 2 do endereço. (Complemento - Andar, Sala, Apto). Max: 128 caracteres."},"zip_code":{"type":"string","description":"CEP. Max: 16 caracteres."},"city":{"type":"string","description":"Cidade. Max: 64 caracteres."},"state":{"type":"string","description":"Código do estado no formato ISO 3166-2."},"country":{"type":"string","description":"Código do país no formato ISO 3166-1 alpha-2."}}}}},"network_token":{"type":"object","description":"Token de bandeira.","properties":{"number":{"type":"string","description":"Número do Network Token. Entre 13 e 19 caracteres. Ex: 4190000000000069"},"holder_name":{"type":"string","description":"Nome do portador como está impresso no cartão. Máximo de 64 caracteres (Caracteres especiais e números não são aceitos)"},"exp_month":{"type":"integer","description":"Mês de validade do Network Token. Valor entre 1 e 12 (inclusive)","format":"int32"},"exp_year":{"type":"integer","description":"Ano de validade do Network Token. Formatos yy ou yyyy. Ex: 23 ou 2023.","format":"int32"},"cryptograms":{"type":"string","description":"Criptograma de autenticação para Network Token. Pode enviar mais de um, caso queira em uma lista de strings. Formato em base64. Ex: ANfQt43bddROAAEnSAMhAAADFA===="}}},"card_id":{"type":"string","description":"identificador do cartão de um cliente."},"card_token":{"type":"string","description":"token do cartão gerado pelo checkout transparente"},"recurrence_cycle":{"type":"string","description":"Informa se o pedido é referente a uma recorrência externa. Possíveis valores: `first` ou `subsequent`."},"initiated_type":{"type":"string","description":"Identificador do tipo de transação avulsa. Valores possíveis: `partial_shipment` (Remessa Parcial), `related_or_delayed_charge` (Cobrança Atrasada), `no_show` (Multa) ou `retry` (Retentativa). Valores possíveis: `standing_order` (Ordem Permanente), `instalment` (Parcelamento) ou `subscription` (Assinatura convencional com valor e frequência fixa). [Mais detalhes](https://docs.pagar.me/page/mitcit-transa%C3%A7%C3%B5es-card-on-file-mastercard)."},"recurrence_model":{"type":"string","description":"Identificador do tipo de recorrência. Valores possíveis: `standing_order` (Ordem Permanente), `instalment` (Parcelamento) ou `subscription` (Assinatura convencional com valor e frequência fixa). Valores possíveis: `standing_order` (Ordem Permanente), `instalment` (Parcelamento) ou `subscription` (Assinatura convencional com valor e frequência fixa). [Mais detalhes](https://docs.pagar.me/page/mitcit-transa%C3%A7%C3%B5es-card-on-file-mastercard)."},"payment_origin":{"type":"object","description":"Identificador da primeira cobrança de uma recorrência. [Mais detalhes](https://docs.pagar.me/docs/api-v5-identificador-de-recorr%C3%AAncia-para-assinaturas-externas).","properties":{"charge_id":{"type":"string","description":"Identificador da cobrança"},"brand_id":{"type":"string","description":"Identificador da bandeira"}}}}},"voucher":{"type":"object","description":"Dados sobre o pagamento com voucher (obrigatório caso **payment_method** seja **voucher**)","properties":{"statement_descriptor":{"type":"string","description":"Texto exibido na fatura do cartão. Max: 22 caracteres."},"card":{"type":"object","description":"Cartão voucher.","required":["number","holder_name","exp_month","exp_year"],"properties":{"number":{"type":"string","description":"Número do cartão. Entre 13 e 19 caracteres"},"holder_name":{"type":"string","description":"Nome do portador como está impresso no cartão. Máximo de 64 caracteres (Caracteres especiais e números não são aceitos)"},"holder_document":{"type":"string","description":"CPF ou CNPJ do portador do cartão. Obrigatório caso o tipo do cartão seja voucher (bandeiras VR ou Pluxee)."},"exp_month":{"type":"integer","description":"Mês de validade do cartão. Valor entre 1 e 12 (inclusive)","format":"int32"},"exp_year":{"type":"integer","description":"Ano de validade do cartão. Formatos yy ou yyyy. Ex: 23 ou 2023.","format":"int32"},"cvv":{"type":"string","description":"Código de segurança do cartão. O campo aceita 4 ou 3 caracteres, variando por bandeira."},"brand":{"type":"string","description":"(Opcional) Bandeira do cartão. Para cartões de crédito, temos como valores possíveis: Elo, Mastercard, Visa, Amex, ou Hipercard. Para voucher, temos como valores possíveis: Alelo, Ticket, VR ou Pluxee."},"label":{"type":"string","description":"Indica a label do cartão"},"billing_address_id":{"type":"string","description":"Código do endereço de cobrança. Max: 36 caracteres.<>Opcional, pode ser utilizado no lugar do billing_address."},"billing_address":{"type":"object","properties":{"line_1":{"type":"string","description":"Linha 1 do endereço. (Número, Rua, e Bairro - Nesta ordem e separados por vírgula) Max: 256 caracteres."},"line_2":{"type":"string","description":"Linha 2 do endereço. (Complemento - Andar, Sala, Apto). Max: 128 caracteres."},"zip_code":{"type":"string","description":"CEP. Max: 16 caracteres."},"city":{"type":"string","description":"Cidade. Max: 64 caracteres."},"state":{"type":"string","description":"Código do estado no formato ISO 3166-2."},"country":{"type":"string","description":"Código do país no formato ISO 3166-1 alpha-2."}}}}},"card_id":{"type":"string","description":"identificador do cartão de um cliente"},"card_token":{"type":"string","description":"token do cartão gerado pelo checkout transparente"},"card.holder_document":{"type":"string","description":"Número do documento do portador do cartão. Este campo deverá ser enviado dentro do objeto card e é obrigatório para voucher."}}},"boleto":{"type":"object","description":"Dados sobre o pagamento com boleto (obrigatório caso **payment_method** seja **boleto**).","properties":{"bank":{"type":"string","description":"Código do banco. 001 (Banco do Brasil); 033 (Santander); 237 (Bradesco); 341 (Itau); 745 (Citibank) e 104 (Caixa Econômica Federal)."},"instructions":{"type":"string","description":"Instruções do boleto. Max: 256 caracteres."},"due_at":{"type":"string","description":"Data de vencimento. (Opcional)"},"nosso_numero":{"type":"string","description":"Número que identifica unicamente um boleto para uma conta."},"type":{"type":"string","description":"Tipo de espécie do boleto.DM (Duplicata Mercantil) e BDP (Boleto de proposta)"},"document_number":{"type":"string","description":"Identificador do boleto. Max: 16 caracteres."},"interest":{"type":"object","description":"Aplicação do juros sobre o boleto.","required":["days","type","amount"],"properties":{"days":{"type":"integer","description":"Dias após a expiração do boleto quando o juros deve ser cobrado.","format":"int32"},"type":{"type":"string","description":"Tipo de divisão. Os valores possíveis são flat ou percentage."},"amount":{"type":"string","description":"Valor em porcentagem ou em centavos da taxa de juros que será cobrada ao mês."}}},"fine":{"type":"object","description":"Aplicação da multa sobre o boleto.","required":["days","type","amount"],"properties":{"days":{"type":"integer","description":"Dias após a expiração do boleto quando a multa deve ser cobrada.","format":"int32"},"type":{"type":"string","description":"Tipo de divisão. Os valores possíveis são flat ou percentage."},"amount":{"type":"integer","description":"Valor em porcentagem ou em centavos que será cobrada na multa.","format":"int32"}}},"discount":{"type":"object","description":"Objeto raiz de desconto por antecipação. Exclusivo PSP.","properties":{"type":{"type":"string","description":"Tipo do desconto: \"percentage\" (% sobre o total) ou \"flat\" (centavos). Aplica-se a todas as regras do array."},"rules":{"type":"array","description":"Lista de regras de desconto ordenadas por limit_date crescente.","items":{"properties":{"limit_date":{"type":"string","description":"Data limite da regra. Formato YYYY-MM-DD. Deve ser anterior ao due_at do boleto."},"amount":{"type":"integer","description":"Valor do desconto. Se type: percentage: entre 0.01 e 100 (ex: 15.00 = 15%). Se type: flat: inteiro em centavos, mín. 1 (ex: 500 = R$5,00).","format":"int32"}},"type":"object"}}}}}},"bank_transfer":{"type":"object","description":"Dados sobre o pagamento com transferência entre contas bancárias. (obrigatório caso **payment_method** seja **bank_transfer**).","properties":{"bank":{"type":"string","description":"Código do Banco. 001 (Banco do Brasil); 237 (Bradesco) e 341 (Itau)."}}},"Pix":{"type":"object","description":"Dados sobre o pagamento com Pix (obrigatório caso **payment_method** seja **Pix**).","properties":{"expires_in":{"type":"integer","description":"Data de expiração do Pix em segundos.","format":"int32"},"expires_at":{"type":"string","description":"Data de expiração do Pix. (Opcional | Mandatório caso não enviado o expires_in) [Formato: YYYY-MM-DDThh:mm:ss] UTC","format":"date"},"additional_information":{"type":"object","description":"Objeto chave/valor utilizado para adicionar informações sobre o pagamento. Esses dados serão visíveis para o consumidor na hora do pagamento.","properties":{"Name":{"type":"string","description":"Nome utilizado para adicionar informações sobre o pagamento."},"Value":{"type":"string","description":"Valor utilizado para adicionar informações sobre o pagamento."}}}}},"reuse_split":{"type":"boolean","description":"Informa se vamos repassar as regras de split para proxima transação"}}},"examples":{"Request Example":{"value":{"payment_method":"boleto","boleto":{"bank":"033","instructions":"Pagar até o vencimento","due_at":"2020-12-31"},"reuse_split":true}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"ch_PA2gLJYc9hDxRrXV\",\n \"code\": \"DPRWS1C38N\",\n \"gateway_id\": \"c22a0e61-2e3e-4317-b11f-08d03046a1a8\",\n \"amount\": 1490000,\n \"status\": \"pending\",\n \"currency\": \"BRL\",\n \"payment_method\": \"boleto\",\n \"created_at\": \"2017-10-05T19:16:51Z\",\n \"updated_at\": \"2017-10-05T19:18:39Z\",\n \"customer\": {\n \"id\": \"cus_9rOWDePfdC5qRYgE\",\n \"name\": \"Tony Stark\",\n \"email\": \"a999087b-1fa2-4ed9-8499-5065ebc2a46a@avengers.com\",\n \"delinquent\": false,\n \"created_at\": \"2017-10-05T19:16:51Z\",\n \"updated_at\": \"2017-10-05T19:16:51Z\",\n \"phones\": {}\n },\n \"last_transaction\": {\n \"id\": \"tran_OX28mah1bSP084wB\",\n \"transaction_type\": \"boleto\",\n \"gateway_id\": \"659298db-dcae-492a-afc5-47774026ca9f\",\n \"amount\": 1490000,\n \"status\": \"generated\",\n \"success\": true,\n \"url\": \"https://sandbox.pagar.me/Boleto/ViewBoleto.aspx?659298db-dcae-492a-afc5-47774026ca9f\",\n \"pdf\": \"https://api.stone.com.br/core/v1/transactions/tran_OX28mah1bSP084wB/pdf\",\n \"line\": \"34191.75009 05636.791237 41234.510000 8 84860001490000\",\n \"barcode\": \"https://api.pagar.mem/core/v1/transactions/tran_OX28mah1bSP084wB/barcode\",\n \"qr_code\": \"https://api.stone.com.br/core/v1/transactions/tran_OX28mah1bSP084wB/qrcode\",\n \"nosso_numero\": \"00056367\",\n \"bank\": \"033\",\n \"document_number\": \"071838848\",\n \"instructions\": \"Pagar até o vencimento\",\n \"due_at\": \"2020-12-31T00:00:00Z\",\n \"created_at\": \"2017-10-05T19:18:39Z\",\n \"updated_at\": \"2017-10-05T19:18:39Z\",\n \"gateway_response\": {\n \"code\": \"201\"\n }\n },\n \"metadata\": {\n \"code\": \"123\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"ch_PA2gLJYc9hDxRrXV"},"code":{"type":"string","example":"DPRWS1C38N"},"gateway_id":{"type":"string","example":"c22a0e61-2e3e-4317-b11f-08d03046a1a8"},"amount":{"type":"integer","example":1490000,"default":0},"status":{"type":"string","example":"pending"},"currency":{"type":"string","example":"BRL"},"payment_method":{"type":"string","example":"boleto"},"created_at":{"type":"string","example":"2017-10-05T19:16:51Z"},"updated_at":{"type":"string","example":"2017-10-05T19:18:39Z"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_9rOWDePfdC5qRYgE"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"a999087b-1fa2-4ed9-8499-5065ebc2a46a@avengers.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2017-10-05T19:16:51Z"},"updated_at":{"type":"string","example":"2017-10-05T19:16:51Z"},"phones":{"type":"object","properties":{}}}},"last_transaction":{"type":"object","properties":{"id":{"type":"string","example":"tran_OX28mah1bSP084wB"},"transaction_type":{"type":"string","example":"boleto"},"gateway_id":{"type":"string","example":"659298db-dcae-492a-afc5-47774026ca9f"},"amount":{"type":"integer","example":1490000,"default":0},"status":{"type":"string","example":"generated"},"success":{"type":"boolean","example":true,"default":true},"url":{"type":"string","example":"https://sandbox.pagar.me/Boleto/ViewBoleto.aspx?659298db-dcae-492a-afc5-47774026ca9f"},"pdf":{"type":"string","example":"https://api.stone.com.br/core/v1/transactions/tran_OX28mah1bSP084wB/pdf"},"line":{"type":"string","example":"34191.75009 05636.791237 41234.510000 8 84860001490000"},"barcode":{"type":"string","example":"https://api.pagar.mem/core/v1/transactions/tran_OX28mah1bSP084wB/barcode"},"qr_code":{"type":"string","example":"https://api.stone.com.br/core/v1/transactions/tran_OX28mah1bSP084wB/qrcode"},"nosso_numero":{"type":"string","example":"00056367"},"bank":{"type":"string","example":"033"},"document_number":{"type":"string","example":"071838848"},"instructions":{"type":"string","example":"Pagar até o vencimento"},"due_at":{"type":"string","example":"2020-12-31T00:00:00Z"},"created_at":{"type":"string","example":"2017-10-05T19:18:39Z"},"updated_at":{"type":"string","example":"2017-10-05T19:18:39Z"},"gateway_response":{"type":"object","properties":{"code":{"type":"string","example":"201"}}}}},"metadata":{"type":"object","properties":{"code":{"type":"string","example":"123"}}}}}}}},"412":{"description":"412","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"This charge can't have the payment method changed.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"This charge can't have the payment method changed."}}}}}}},"deprecated":false}},"/charges/{charge_id}/retry":{"post":{"summary":"Retentar uma cobrança manualmente","description":"","operationId":"retentar-uma-cobrança-manualmente","parameters":[{"name":"charge_id","in":"path","description":"Código da cobrança.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"ch_exRAY21fvNFVD9EX\",\n \"code\": \"8M2OT2SRX8\",\n \"gateway_id\": \"c5d71b01-174e-453f-8563-fd089cf7b39b\",\n \"amount\": 14900000,\n \"status\": \"failed\",\n \"currency\": \"BRL\",\n \"payment_method\": \"credit_card\",\n \"due_at\": \"2017-04-04T00:00:00\",\n \"created_at\": \"2017-04-04T22:29:33\",\n \"updated_at\": \"2017-04-04T22:29:54\",\n \"customer\": {\n \"id\": \"cus_aEkwKv0SmNHMR931\",\n \"name\": \"Luke Skywalker\",\n \"email\": \"lskywalker@r2d2.com\",\n \"delinquent\": false,\n \"created_at\": \"2017-04-04T19:41:31\",\n \"updated_at\": \"2017-04-04T19:41:31\"\n },\n \"last_transaction\": {\n \"id\": \"tran_dZm79oYT0ckRlw1o\",\n \"transaction_type\": \"credit_card\",\n \"funding_source\": \"prepaid\",\n \"gateway_id\": \"f3c316f7-3f6c-47bc-ac03-da01e51444aa\",\n \"amount\": 14900000,\n \"status\": \"not_authorized\",\n \"success\": false,\n \"installments\": 1,\n \"statement_descriptor\": \"Spotify\",\n \"acquirer_name\": \"simulator\",\n \"acquirer_affiliation_code\": \"MUNDI\",\n \"acquirer_tid\": \"\",\n \"acquirer_nsu\": \"\",\n \"acquirer_auth_code\": \"\",\n \"acquirer_message\": \"Simulator|Transação de simulação não autorizada\",\n \"acquirer_return_code\": \"1\",\n \"operation_type\": \"auth_only\",\n \"credit_card\": {\n \"id\": \"card_2bKzdEGsYYFkymqG\",\n \"first_six_digits\": \"542501\",\n \"last_four_digits\": \"5322\",\n \"brand\": \"Visa\",\n \"holder_name\": \"Luke Skywalker\",\n \"exp_month\": 5,\n \"exp_year\": 2030,\n \"status\": \"active\",\n \"created_at\": \"2017-04-04T19:41:31\",\n \"updated_at\": \"2017-04-04T19:41:31\",\n \"billing_address\": {\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"line_1\": \"10880, Malibu Point, Malibu Central\"\n }\n },\n \"created_at\": \"2017-04-04T22:29:33\",\n \"updated_at\": \"2017-04-04T22:29:33\"\n },\n \"metadata\": {\n \"id\": \"my_charge_id\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"ch_exRAY21fvNFVD9EX"},"code":{"type":"string","example":"8M2OT2SRX8"},"gateway_id":{"type":"string","example":"c5d71b01-174e-453f-8563-fd089cf7b39b"},"amount":{"type":"integer","example":14900000,"default":0},"status":{"type":"string","example":"failed"},"currency":{"type":"string","example":"BRL"},"payment_method":{"type":"string","example":"credit_card"},"due_at":{"type":"string","example":"2017-04-04T00:00:00"},"created_at":{"type":"string","example":"2017-04-04T22:29:33"},"updated_at":{"type":"string","example":"2017-04-04T22:29:54"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_aEkwKv0SmNHMR931"},"name":{"type":"string","example":"Luke Skywalker"},"email":{"type":"string","example":"lskywalker@r2d2.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2017-04-04T19:41:31"},"updated_at":{"type":"string","example":"2017-04-04T19:41:31"}}},"last_transaction":{"type":"object","properties":{"id":{"type":"string","example":"tran_dZm79oYT0ckRlw1o"},"transaction_type":{"type":"string","example":"credit_card"},"funding_source":{"type":"string","example":"prepaid"},"gateway_id":{"type":"string","example":"f3c316f7-3f6c-47bc-ac03-da01e51444aa"},"amount":{"type":"integer","example":14900000,"default":0},"status":{"type":"string","example":"not_authorized"},"success":{"type":"boolean","example":false,"default":true},"installments":{"type":"integer","example":1,"default":0},"statement_descriptor":{"type":"string","example":"Spotify"},"acquirer_name":{"type":"string","example":"simulator"},"acquirer_affiliation_code":{"type":"string","example":"MUNDI"},"acquirer_tid":{"type":"string","example":""},"acquirer_nsu":{"type":"string","example":""},"acquirer_auth_code":{"type":"string","example":""},"acquirer_message":{"type":"string","example":"Simulator|Transação de simulação não autorizada"},"acquirer_return_code":{"type":"string","example":"1"},"operation_type":{"type":"string","example":"auth_only"},"credit_card":{"type":"object","properties":{"id":{"type":"string","example":"card_2bKzdEGsYYFkymqG"},"first_six_digits":{"type":"string","example":"542501"},"last_four_digits":{"type":"string","example":"5322"},"brand":{"type":"string","example":"Visa"},"holder_name":{"type":"string","example":"Luke Skywalker"},"exp_month":{"type":"integer","example":5,"default":0},"exp_year":{"type":"integer","example":2030,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-04T19:41:31"},"updated_at":{"type":"string","example":"2017-04-04T19:41:31"},"billing_address":{"type":"object","properties":{"zip_code":{"type":"string","example":"90265"},"city":{"type":"string","example":"Malibu"},"state":{"type":"string","example":"CA"},"country":{"type":"string","example":"US"},"line_1":{"type":"string","example":"10880, Malibu Point, Malibu Central"}}}}},"created_at":{"type":"string","example":"2017-04-04T22:29:33"},"updated_at":{"type":"string","example":"2017-04-04T22:29:33"}}},"metadata":{"type":"object","properties":{"id":{"type":"string","example":"my_charge_id"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/charges/{charge_id}/confirm-payment":{"post":{"summary":"Confirmar cobrança (cash)","description":"Para a confirmação de cobranças com meio de pagamento `cash` com o status `pending`.","operationId":"confirmar-cobrança-cash","parameters":[{"name":"charge_id","in":"path","description":"Código da cobrança.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"amount":{"type":"integer","description":"Valor a ser confirmado. Caso não seja informado, será considerado o valor total da cobrança","format":"int32"},"code":{"type":"string","description":"Código da cobrança no sistema da loja. Irá atualizar o valor informado na criação da cobrança. Max: 52 caracteres"},"description":{"type":"string","description":"Descrição"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"ch_7YBoBPWCVKS3QdyM\",\n \"code\": \"WZQS3LHEKW\",\n \"gateway_id\": \"42c243c4-0b52-49f3-ba92-e8661ebc7916\",\n \"amount\": 1490,\n \"status\": \"paid\",\n \"currency\": \"BRL\",\n \"payment_method\": \"credit_card\",\n \"due_at\": \"2017-04-04T00:00:00\",\n \"paid_at\": \"2017-04-04T20:06:14\",\n \"created_at\": \"2017-04-04T20:05:39\",\n \"updated_at\": \"2017-04-04T20:06:14\",\n \"customer\": {\n \"id\": \"cus_aEkwKv0SmNHMR931\",\n \"name\": \"Luke Skywalker\",\n \"email\": \"lskywalker@r2d2.com\",\n \"delinquent\": false,\n \"created_at\": \"2017-04-04T19:41:31\",\n \"updated_at\": \"2017-04-04T19:41:31\"\n },\n \"last_transaction\": {\n \"id\": \"tran_9KYq34mcDfOnXg1Z\",\n \"transaction_type\": \"credit_card\",\n \"gateway_id\": \"d8033a7c-2d31-4840-8870-8a71bd16cacc\",\n \"amount\": 1490,\n \"status\": \"captured\",\n \"success\": true,\n \"installments\": 1,\n \"statement_descriptor\": \"Spotify\",\n \"acquirer_name\": \"simulator\",\n \"acquirer_affiliation_code\": \"MUNDI\",\n \"acquirer_tid\": \"856202\",\n \"acquirer_nsu\": \"503081\",\n \"acquirer_auth_code\": \"405205\",\n \"operation_type\": \"capture\",\n \"credit_card\": {\n \"id\": \"card_2bKzdEGsYYFkymqG\",\n \"first_six_digits\": \"542501\",\n \"last_four_digits\": \"5322\",\n \"brand\": \"Visa\",\n \"holder_name\": \"Luke Skywalker\",\n \"exp_month\": 5,\n \"exp_year\": 2017,\n \"status\": \"active\",\n \"created_at\": \"2017-04-04T19:41:31\",\n \"updated_at\": \"2017-04-04T19:41:31\",\n \"billing_address\": {\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"line_1\": \"10880, Malibu Point, Malibu Central\"\n }\n },\n \"created_at\": \"2017-04-04T20:06:14\",\n \"updated_at\": \"2017-04-04T20:06:14\"\n },\n \"metadata\": {\n \"id\": \"my_charge_id\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"ch_7YBoBPWCVKS3QdyM"},"code":{"type":"string","example":"WZQS3LHEKW"},"gateway_id":{"type":"string","example":"42c243c4-0b52-49f3-ba92-e8661ebc7916"},"amount":{"type":"integer","example":1490,"default":0},"status":{"type":"string","example":"paid"},"currency":{"type":"string","example":"BRL"},"payment_method":{"type":"string","example":"credit_card"},"due_at":{"type":"string","example":"2017-04-04T00:00:00"},"paid_at":{"type":"string","example":"2017-04-04T20:06:14"},"created_at":{"type":"string","example":"2017-04-04T20:05:39"},"updated_at":{"type":"string","example":"2017-04-04T20:06:14"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_aEkwKv0SmNHMR931"},"name":{"type":"string","example":"Luke Skywalker"},"email":{"type":"string","example":"lskywalker@r2d2.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2017-04-04T19:41:31"},"updated_at":{"type":"string","example":"2017-04-04T19:41:31"}}},"last_transaction":{"type":"object","properties":{"id":{"type":"string","example":"tran_9KYq34mcDfOnXg1Z"},"transaction_type":{"type":"string","example":"credit_card"},"gateway_id":{"type":"string","example":"d8033a7c-2d31-4840-8870-8a71bd16cacc"},"amount":{"type":"integer","example":1490,"default":0},"status":{"type":"string","example":"captured"},"success":{"type":"boolean","example":true,"default":true},"installments":{"type":"integer","example":1,"default":0},"statement_descriptor":{"type":"string","example":"Spotify"},"acquirer_name":{"type":"string","example":"simulator"},"acquirer_affiliation_code":{"type":"string","example":"MUNDI"},"acquirer_tid":{"type":"string","example":"856202"},"acquirer_nsu":{"type":"string","example":"503081"},"acquirer_auth_code":{"type":"string","example":"405205"},"operation_type":{"type":"string","example":"capture"},"credit_card":{"type":"object","properties":{"id":{"type":"string","example":"card_2bKzdEGsYYFkymqG"},"first_six_digits":{"type":"string","example":"542501"},"last_four_digits":{"type":"string","example":"5322"},"brand":{"type":"string","example":"Visa"},"holder_name":{"type":"string","example":"Luke Skywalker"},"exp_month":{"type":"integer","example":5,"default":0},"exp_year":{"type":"integer","example":2017,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-04T19:41:31"},"updated_at":{"type":"string","example":"2017-04-04T19:41:31"},"billing_address":{"type":"object","properties":{"zip_code":{"type":"string","example":"90265"},"city":{"type":"string","example":"Malibu"},"state":{"type":"string","example":"CA"},"country":{"type":"string","example":"US"},"line_1":{"type":"string","example":"10880, Malibu Point, Malibu Central"}}}}},"created_at":{"type":"string","example":"2017-04-04T20:06:14"},"updated_at":{"type":"string","example":"2017-04-04T20:06:14"}}},"metadata":{"type":"object","properties":{"id":{"type":"string","example":"my_charge_id"}}}}}}}},"412":{"description":"412","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"This charge can not be captured.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"This charge can not be captured."}}}}}}},"deprecated":false}},"/charges.":{"post":{"summary":"Criar cobrança","description":"","operationId":"criar-cobrança","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["amount","payment","customer_id","customer"],"properties":{"code":{"type":"string","description":"Código identificador da cobrança no sistema da loja."},"amount":{"type":"integer","description":"Valor da cobrança em centavos","format":"int32"},"currency":{"type":"string","description":"Moeda. Valores possíveis: **BRL**, **ARS**, **BOB**, **CLP**, **COP **, **MXN**, **PYG**, **USD **, **UYU** e **EUR**."},"payment":{"type":"object","description":"Dados sobre o pagamento. [Saiba mais sobre pagamentos](https://docs.mundipagg.com/v1/reference#pagamento-overview)","properties":{}},"customer_id":{"type":"string","description":"Código do cliente."},"customer":{"type":"object","description":"Dados do cliente. **Obrigatório** caso o customer_id não seja informado. [Saiba mais sobre clientes](https://docs.mundipagg.com/v1/reference#clientes).","properties":{}},"metadata":{"type":"string","description":"Objeto chave/valor utilizado para armazenar informações adicionais sobre a cobrança. [Saiba mais sobre metadata](https://docs.mundipagg.com/v1/reference#metadata)."}}},"examples":{"JSON (with Customer)":{"value":{"amount":1490,"customer":{"name":"Tony Stark","email":"tony@email.com"},"payment":{"payment_method":"credit_card","credit_card":{"capture":false,"installments":1,"statement_descriptor":"AVENGERS","card":{"number":"4556859837525","holder_name":"Tony Stark","exp_month":1,"exp_year":30,"cvv":"558"}}},"metadata":{"code":"123"}}},"JSON (with Customer_id)":{"value":{"amount":1490,"customer_id":"cus_4rNQ0PmHBGfJQGOw","payment":{"payment_method":"credit_card","credit_card":{"capture":false,"installments":1,"statement_descriptor":"AVENGERS","card":{"number":"4556859837525","holder_name":"Tony Stark","exp_month":1,"exp_year":30,"cvv":"558"}}},"metadata":{"code":"123"}}},"JSON (with Card_Token)":{"value":{"amount":1490,"currency":"BRL","customer":{"name":"Tony Stark","email":"TonyStark@avengeiro.com"},"payment":{"payment_method":"credit_card","credit_card":{"installments":1,"statement_descriptor":"AVENGERS","card_token":"{{token_id}}"}},"metadata":{"code":"123"}}},"JSON (Card_id + CVV)":{"value":{"amount":1490,"currency":"BRL","customer_id":"{{customer_id}}","payment":{"payment_method":"credit_card","credit_card":{"installments":1,"statement_descriptor":"AVENGERS","card_id":"{{card_id}}","card":{"cvv":"123"}}},"metadata":{"code":"123"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"ch_kp64Edig1t79NajE\",\n \"code\": \"28ZMCQWSW4\",\n \"gateway_id\": \"909f4fb7-17a2-4753-a5de-80491ffd80d3\",\n \"amount\": 1490,\n \"status\": \"pending\",\n \"currency\": \"BRL\",\n \"payment_method\": \"credit_card\",\n \"created_at\": \"2017-10-19T21:45:21Z\",\n \"updated_at\": \"2017-10-19T21:45:21Z\",\n \"customer\": {\n \"id\": \"cus_4rNQ0PmHBGfJQGOw\",\n \"name\": \"Tony Stark\",\n \"email\": \"tony@email.com\",\n \"document\": \"93095135270\",\n \"type\": \"individual\",\n \"delinquent\": false,\n \"created_at\": \"2017-10-13T19:44:17Z\",\n \"updated_at\": \"2017-10-19T21:25:57Z\",\n \"phones\": {\n \"home_phone\": {\n \"country_code\": \"55\",\n \"number\": \"000000000\",\n \"area_code\": \"21\"\n },\n \"mobile_phone\": {\n \"country_code\": \"55\",\n \"number\": \"000000000\",\n \"area_code\": \"21\"\n }\n },\n \"metadata\": {\n \"company\": \"Avengers\"\n }\n },\n \"last_transaction\": {\n \"id\": \"tran_4Rp2OQJCnxS3ydzO\",\n \"transaction_type\": \"credit_card\",\n \"gateway_id\": \"3fb26923-fc6b-4004-82b9-dd1ff2811c03\",\n \"amount\": 1490,\n \"status\": \"authorized_pending_capture\",\n \"success\": true,\n \"installments\": 1,\n \"statement_descriptor\": \"AVENGERS\",\n \"acquirer_name\": \"simulator\",\n \"acquirer_affiliation_code\": \"\",\n \"acquirer_tid\": \"241813\",\n \"acquirer_nsu\": \"999053\",\n \"acquirer_auth_code\": \"290412\",\n \"acquirer_message\": \"Simulator|Transação de simulação autorizada com sucesso\",\n \"acquirer_return_code\": \"0\",\n \"operation_type\": \"auth_only\",\n \"card\": {\n \"id\": \"card_M6ez8BUG8cbn5ndO\",\n \"first_six_digits\": \"455685\",\n \"last_four_digits\": \"7525\",\n \"brand\": \"Visa\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 2030,\n \"status\": \"active\",\n \"created_at\": \"2017-10-19T21:41:10Z\",\n \"updated_at\": \"2017-10-19T21:41:10Z\",\n \"type\": \"credit\"\n },\n \"created_at\": \"2017-10-19T21:45:21Z\",\n \"updated_at\": \"2017-10-19T21:45:21Z\",\n \"gateway_response\": {\n \"code\": \"201\"\n }\n },\n \"metadata\": {\n \"code\": \"123\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"ch_kp64Edig1t79NajE"},"code":{"type":"string","example":"28ZMCQWSW4"},"gateway_id":{"type":"string","example":"909f4fb7-17a2-4753-a5de-80491ffd80d3"},"amount":{"type":"integer","example":1490,"default":0},"status":{"type":"string","example":"pending"},"currency":{"type":"string","example":"BRL"},"payment_method":{"type":"string","example":"credit_card"},"created_at":{"type":"string","example":"2017-10-19T21:45:21Z"},"updated_at":{"type":"string","example":"2017-10-19T21:45:21Z"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_4rNQ0PmHBGfJQGOw"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"tony@email.com"},"document":{"type":"string","example":"93095135270"},"type":{"type":"string","example":"individual"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2017-10-13T19:44:17Z"},"updated_at":{"type":"string","example":"2017-10-19T21:25:57Z"},"phones":{"type":"object","properties":{"home_phone":{"type":"object","properties":{"country_code":{"type":"string","example":"55"},"number":{"type":"string","example":"000000000"},"area_code":{"type":"string","example":"21"}}},"mobile_phone":{"type":"object","properties":{"country_code":{"type":"string","example":"55"},"number":{"type":"string","example":"000000000"},"area_code":{"type":"string","example":"21"}}}}},"metadata":{"type":"object","properties":{"company":{"type":"string","example":"Avengers"}}}}},"last_transaction":{"type":"object","properties":{"id":{"type":"string","example":"tran_4Rp2OQJCnxS3ydzO"},"transaction_type":{"type":"string","example":"credit_card"},"gateway_id":{"type":"string","example":"3fb26923-fc6b-4004-82b9-dd1ff2811c03"},"amount":{"type":"integer","example":1490,"default":0},"status":{"type":"string","example":"authorized_pending_capture"},"success":{"type":"boolean","example":true,"default":true},"installments":{"type":"integer","example":1,"default":0},"statement_descriptor":{"type":"string","example":"AVENGERS"},"acquirer_name":{"type":"string","example":"simulator"},"acquirer_affiliation_code":{"type":"string","example":""},"acquirer_tid":{"type":"string","example":"241813"},"acquirer_nsu":{"type":"string","example":"999053"},"acquirer_auth_code":{"type":"string","example":"290412"},"acquirer_message":{"type":"string","example":"Simulator|Transação de simulação autorizada com sucesso"},"acquirer_return_code":{"type":"string","example":"0"},"operation_type":{"type":"string","example":"auth_only"},"card":{"type":"object","properties":{"id":{"type":"string","example":"card_M6ez8BUG8cbn5ndO"},"first_six_digits":{"type":"string","example":"455685"},"last_four_digits":{"type":"string","example":"7525"},"brand":{"type":"string","example":"Visa"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":2030,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-10-19T21:41:10Z"},"updated_at":{"type":"string","example":"2017-10-19T21:41:10Z"},"type":{"type":"string","example":"credit"}}},"created_at":{"type":"string","example":"2017-10-19T21:45:21Z"},"updated_at":{"type":"string","example":"2017-10-19T21:45:21Z"},"gateway_response":{"type":"object","properties":{"code":{"type":"string","example":"201"}}}}},"metadata":{"type":"object","properties":{"code":{"type":"string","example":"123"}}}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"The request is invalid.\",\n \"errors\": {\n \"charge.amount\": [\n \"The field amount must be greater than or equal to 1\"\n ]\n },\n \"request\": {\n \"customer\": {\n \"name\": \"Felipe Stark\",\n \"email\": \"d5c6a160-ed93-40f1-81f8-45cae47cb6e8@avengers.com\",\n \"phones\": {},\n \"metadata\": {}\n },\n \"payment\": {\n \"payment_method\": \"credit_card\",\n \"credit_card\": {\n \"installments\": 1,\n \"capture\": false,\n \"statement_descriptor\": \"AVENGERS\",\n \"card\": {\n \"number\": \"4556859837525\",\n \"last_four_digits\": \"7525\",\n \"brand\": \"Visa\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 20,\n \"cvv\": \"558\",\n \"options\": {}\n }\n }\n },\n \"metadata\": {\n \"code\": \"123\"\n }\n }\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The request is invalid."},"errors":{"type":"object","properties":{"charge.amount":{"type":"array","items":{"type":"string","example":"The field amount must be greater than or equal to 1"}}}},"request":{"type":"object","properties":{"customer":{"type":"object","properties":{"name":{"type":"string","example":"Felipe Stark"},"email":{"type":"string","example":"d5c6a160-ed93-40f1-81f8-45cae47cb6e8@avengers.com"},"phones":{"type":"object","properties":{}},"metadata":{"type":"object","properties":{}}}},"payment":{"type":"object","properties":{"payment_method":{"type":"string","example":"credit_card"},"credit_card":{"type":"object","properties":{"installments":{"type":"integer","example":1,"default":0},"capture":{"type":"boolean","example":false,"default":true},"statement_descriptor":{"type":"string","example":"AVENGERS"},"card":{"type":"object","properties":{"number":{"type":"string","example":"4556859837525"},"last_four_digits":{"type":"string","example":"7525"},"brand":{"type":"string","example":"Visa"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":20,"default":0},"cvv":{"type":"string","example":"558"},"options":{"type":"object","properties":{}}}}}}}},"metadata":{"type":"object","properties":{"code":{"type":"string","example":"123"}}}}}}}}}}},"deprecated":false}},"/paymentlinks":{"post":{"summary":"Criar link de pagamento","description":"","operationId":"create-link","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["type","payment_settings","cart_settings"],"properties":{"is_building":{"type":"boolean","description":"Define se o link de pagamento será criado com o status building ou ativo, em caso de envio do campo true tal permite que você ative um link em determinado momento posteriormente, para realizar uma ação promocional, por exemplo;","default":false},"name":{"type":"string","description":"Nome que será exibido na dashboard e ao buscar o link de pagamento através da API. Máximo de 64 caracteres."},"type":{"type":"string","description":"Define o tipo do link de pagamento a ser criado, podendo ser \"order\", para criação de pedidos, ou \"subscription\", para recorrências."},"expires_at":{"type":"string","description":"Define a data de expiração do link de pagamento. Formato ISO 8601. Caso não seja enviado o link não terá expiração por tempo. Não deve ser enviado caso o campo expires_in seja enviado.","format":"date"},"expires_in":{"type":"integer","description":"Define o tempo de expiração do link de pagamento em minutos após o mesmo estar ativo. Tempo em minutos. Caso não seja enviado, o link não terá expiração por tempo. Não deve ser enviado caso o campo expires_at seja enviado.","format":"int32"},"max_sessions":{"type":"integer","description":"Define o máximo de pedidos que o link de pagamento pode gerar, sejam eles pagos ou não. Caso não seja enviado, não haverá limite de pedidos criados.","format":"int32"},"max_paid_sessions":{"type":"integer","description":"Define o máximo de pedidos pagos que o link de pagamento pode gerar. Caso não seja enviado, não haverá limite de pagamentos.","format":"int32"},"payment_settings":{"type":"object","description":"Configurações de pagamento do link.","properties":{"accepted_payment_methods":{"type":"array","description":"Define os métodos de pagamento aceitos. Valores permitidos: \"credit_card\", \"boleto\" e \"pix\".","items":{"type":"string"}},"statement_descriptor":{"type":"string","description":"Define o identificador que irá aparecer na fatura do comprador. Limite de 13 caracteres."},"credit_card_settings":{"type":"object","description":"Define as configurações de pagamento quando cartão de crédito for selecionado. Obrigatório quando enviado \"credit_card\" em \"accepted_payment_methods\".","properties":{"operation_type":{"type":"string","description":"Indica se a transação deve ser capturada (\"auth_and_capture\") ou apenas autorizada (\"auth_only\")."},"delay_to_capture":{"type":"integer","description":"Tempo pré-definido para a captura do pagamento após autorização. Valor em xxx.","format":"int32"},"installments":{"type":"array","description":"Configurações de parcelamento do link. Não deverá ser enviado caso o campo \"installments_setup\" seja definido.","items":{"properties":{"number":{"type":"integer","description":"Número de parcelas","format":"int32"},"total":{"type":"integer","description":"Valor total que será cobrado caso essa opção de parcelamento seja selecionada, em centavos.","format":"int32"}},"required":["number","total"],"type":"object"}},"installments_setup":{"type":"object","description":"Configurações de parcelamento do link. Não deverá ser enviado caso o campo \"installments\" seja definido.","properties":{"max_installments":{"type":"integer","description":"Número máximo de parcelas permitido.","format":"int32"},"amount":{"type":"integer","description":"Valor total que será cobrado pelo link, em centavos.","format":"int32"},"interest_type":{"type":"string","description":"Tipo de cálculo utilizado para a inclusão de acréscimo de juros no parcelamento, se aplicável.","default":"simple"},"interest_rate":{"type":"integer","description":"Valor percentual que será utilizado para o acréscimo de juros no parcelamento.","format":"int32"},"customer_fee":{"type":"boolean","description":"Define se as taxas deverão ser automaticamente repassadas no parcelamento do link. Para clientes PSP, caso esse campo seja \"true\", os campos \"interest_type\" e \"interest_rate\" não devem ser enviados."},"free_installments":{"type":"integer","description":"Número de parcelas que não terão acréscimo de juros.","format":"int32"},"brand":{"type":"string","description":"Define a bandeira para recuperar as taxas do lojista. Caso o campo \"customer_fee\" seja \"true\", e os campos \"interest_type\" e \"interest_rate\" não forem informados. Apenas para clientes PSP."}}}}},"boleto_settings":{"type":"object","description":"Define as configurações de pagamento quando boleto for selecionado. Obrigatório quando enviado \"boleto\" em \"accepted_payment_methods\".","properties":{"due_at":{"type":"string","description":"Define a data de expiração do boleto gerado. Formato ISO 8601. Não deverá ser enviado caso o campo \"due_in\" seja definido.","format":"date"},"due_in":{"type":"integer","description":"Define quantidade de tempo para expiração do boleto a partir do momento que o mesmo é gerado. Valor em dias. Não deverá ser enviado caso o campo \"due_in\" seja definido.","format":"int32"},"discount":{"type":"integer","description":"Valor de desconto a ser aplicado ao boleto, em centavos. Não deve ser enviado caso o campo \"discount_percentage\" seja definido.","format":"int32"},"discount_percentage":{"type":"number","description":"Valor de desconto a ser aplicado ao boleto, em porcentagem. Não deve ser enviado caso o campo \"discount\" seja definido.","format":"double"},"instructions":{"type":"string","description":"Instruções do boleto. Máximo 255 caracteres."}}},"pix_settings":{"type":"object","description":"Define as configurações de pagamento quando pix for selecionado. Obrigatório quando enviado \"pix\" em \"accepted_payment_methods\".","properties":{"expires_in":{"type":"integer","description":"Define quantidade de tempo para expiração do pix a partir do momento que o mesmo é gerado. Valor em segundos. Não deverá ser enviado caso o campo \"expires_at\" seja definido.","format":"int32"},"expires_at":{"type":"string","description":"Define a data de expiração do pix gerado. Formato ISO 8601. Não deverá ser enviado caso o campo \"expires_in\" seja definido.","format":"date"},"discount":{"type":"integer","description":"Valor de desconto a ser aplicado ao pix, em centavos. Não deve ser enviado caso o campo \"discount_percentage\" seja definido.","format":"int32"},"discount_percentage":{"type":"number","description":"Valor de desconto a ser aplicado ao pix, em porcentagem. Não deve ser enviado caso o campo \"discount\" seja definido.","format":"double"},"additiona_information":{"type":"object","description":"Objeto chave/valor utilizado para adicionar informações sobre o pagamento. Esses dados serão visíveis para o consumidor na hora do pagamento.","properties":{"Name":{"type":"string","description":"Nome utilizado para adicionar informações sobre o pagamento."},"Value":{"type":"string","description":"Valor utilizado para adicionar informações sobre o pagamento."}}}}}}},"customer_settings":{"type":"object","description":"Define os dados do cliente, se aplicável.","properties":{"customer_id":{"type":"string","description":"Código do cliente."},"customer":{"type":"object","description":"Dados do cliente. Não deverá ser enviado caso o campo \"customer_id\" seja definido.","required":["name"],"properties":{"name":{"type":"string","description":"Nome do cliente. Max: 64 caracteres."},"type":{"type":"string","description":"Tipo de cliente. Valores possíveis: individual (pessoa física) ou company (pessoa jurídica). Obrigatório, caso o document seja enviado."},"email":{"type":"string","description":"E-mail do cliente. Max: 64 caracteres."},"code":{"type":"string","description":"Código de referência do cliente no sistema da loja. Max: 52 caracteres."},"document":{"type":"string","description":"CPF, CNPJ ou PASSAPORTE do cliente. Max: 16 caracteres para CPF e CNPJ e Max: 50 caracteres para PASSAPORTE."},"document_type":{"type":"string","description":"Tipo de documento. Valores possíveis: \"CPF\", \"CNPJ\" ou \"PASSPORT\"."},"gender":{"type":"string","description":"Sexo do cliente . Valores possíveis: male ou female."},"address":{"type":"object","description":"Endereço do cliente.","properties":{"country":{"type":"string","description":"País (Código do país no formato ISO 3166-1 alpha-2)(2 digitos)"},"state":{"type":"string","description":"Estado (Código do estado no formato ISO 3166-2)."},"city":{"type":"string","description":"Cidade."},"zip_code":{"type":"string","description":"Código Postal (CEP) (Apenas numérico)."},"line_1":{"type":"string","description":"Dados principais do endereço. Neste campo deve ser informado Número, Rua, Bairro, nesta ordem e separados por vírgula."},"line_2":{"type":"string","description":"Dados complementares do endereço. Neste campo pode ser informado complemento, referências."}}},"phones":{"type":"object","description":"Telefone residencial do cliente.","properties":{"home_phone":{"type":"object","description":"Telefone residencial do cliente.","properties":{"country_code":{"type":"string","description":"Código do País (Apenas numérico)."},"area_code":{"type":"string","description":"Código da área (Apenas numérico)."},"number":{"type":"string","description":"Número do telefone (Apenas numérico)."}}},"mobile_phone":{"type":"object","description":"Telefone celular do cliente.","properties":{"country_code":{"type":"string","description":"Código do País (Apenas numérico)."},"area_code":{"type":"string","description":"Código da área (Apenas numérico)."},"number":{"type":"string","description":"Número do telefone (Apenas numérico)."}}}}},"birthdate":{"type":"string","description":"Data de nascimento do cliente.","format":"date"},"metadata":{"type":"string","description":"Objeto chave/valor utilizado para armazenar informações adicionais sobre o cliente."}}}}},"cart_settings":{"type":"object","description":"Define os dados do carrinho que será pago pelo link de pagamento.","properties":{"shipping_cost":{"type":"integer","description":"Valor de entrega, em centavos","format":"int32"},"items":{"type":"array","description":"Define os itens que estão inclusos no carrinho que será pago pelo link.","items":{"properties":{"name":{"type":"string","description":"Nome do item."},"description":{"type":"string","description":"Descrição do item. Máximo de xxx caracteres"},"amount":{"type":"integer","description":"Valor unitário do item, em centavos.","format":"int32"},"shipping_cost":{"type":"integer","description":"Valor de entrega do item, em centavos.","format":"int32"},"default_quantity":{"type":"integer","description":"Quantidade de itens.","format":"int32"}},"required":["name","amount","default_quantity"],"type":"object"}},"recurrences":{"type":"array","description":"Define as configurações da recorrência que será gerada a partir do pagamento do link.","items":{"properties":{"plan_id":{"type":"string","description":"Id do plano com as configurações da assinatura que será gerada."},"plan":{"type":"object","description":"Dados do plano da assinatura que será gerada. Não deverá ser enviado caso o campo \"plan_id\" seja definido."},"start_in":{"type":"integer","description":"Data de início da assinatura, em dias. Não deverá ser enviado caso o campo \"start_at\" seja definido.","format":"int32"},"start_at":{"type":"string","description":"Data de início da assinatura. Não deverá ser enviado caso o campo \"start_in\" seja definido.","format":"date"}},"type":"object"}}}},"layout_settings":{"type":"object","description":"Dados de layout.","properties":{"image_url":{"type":"string","description":"Logo que será utilizado no checkout."},"primary_color":{"type":"string","description":"Cor primária que será aplicada no checkout, em hexadecimal."},"secondary_color":{"type":"string","description":"Cor secundária que será aplicada no checkout."}}},"order_code":{"type":"string","description":"Permite ao lojista informar um identificador de sua plataforma para correlação"},"split_settings":{"type":"object","description":"Define as regras de split de pagamento","properties":{"rules":{"type":"array","description":"Regras de split a serem enviadas no link de pamganeto","items":{"properties":{"recipient_id":{"type":"string","description":"Código do recebedor. Formato: re_XXXXXXXXXXXXXXXX."},"amount":{"type":"integer","description":"Valor destinado ao recebedor.","format":"int32"},"type":{"type":"string","description":"Tipo de divisão. Os valores possíveis são flat ou percentage.","default":"percentage","enum":["flat","percentage"]},"options":{"type":"object","description":"Informações da responsabilidade do recebedor na transação.","properties":{"liable":{"type":"boolean","description":"Indica se o recebedor é responsável pela transação em caso de chargeback.","default":true},"charge_processing_fee":{"type":"boolean","description":"Indica se o recebedor vinculado à regra será cobrado pelas taxas da transação","default":true},"charge_remainder_fee":{"type":"boolean","description":"Indica se o recebedor vinculado à regra irá receber o restante dos recebíveis após uma divisão","default":true}}}},"type":"object"}}}},"flow_settings":{"type":"object","properties":{"success_url":{"type":"string","default":"","description":"Define a url de redirecionamento ao final do checkout para permitir o comprador retornar a loja"}},"description":""}}},"examples":{"Link de pedido":{"value":{"payment_settings":{"accepted_payment_methods":["credit_card"],"credit_card_settings":{"operation_type":"auth_and_capture","installments":[{"number":1,"total":12000},{"number":2,"total":12000}]}},"cart_settings":{"items":[{"amount":12000,"name":"Banner","default_quantity":1}]},"name":"Banner N12345","type":"order"}},"Link de pedido (com acréscimo de juros)":{"value":{"payment_settings":{"accepted_payment_methods":["pix","boleto","credit_card"],"credit_card_settings":{"operation_type":"auth_and_capture","installments_setup":{"max_installments":12,"amount":10000,"interest_type":"simple","interest_rate":2,"free_installments":1}}},"cart_settings":{"items":[{"amount":5000,"name":"Banner","description":"Banner personalizado","default_quantity":2}]},"name":"Banner N67890 ","type":"order"}},"Link de Recorrência":{"value":{"max_paid_sessions":1,"payment_settings":{"accepted_payment_methods":["credit_card"],"credit_card_settings":{"operation_type":"auth_and_capture"}},"customer_settings":{"customer_id":"cus_8ka4RGDF9F7MvemD"},"expires_at":"2024-05-12T19:44:39.5870000Z","cart_settings":{"recurrences":[{"start_in":1,"plan_id":"plan_odzJgEyf9fqgR7Kj"}]},"name":"Banner mensal N135","type":"subscription"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"payment_settings\": {\n \"accepted_payment_methods\": [\n \"credit_card\"\n ],\n \"credit_card_settings\": {\n \"operation_type\": \"auth_and_capture\",\n \"installments\": [\n {\n \"number\": 1,\n \"total\": 12000\n },\n {\n \"number\": 2,\n \"total\": 12000\n }\n ]\n }\n },\n \"cart_settings\": {\n \"items\": [\n {\n \"amount\": 12000,\n \"name\": \"Banner\",\n \"default_quantity\": 1\n }\n ],\n \"items_total_cost\": 12000,\n \"total_cost\": 12000,\n \"shipping_cost\": 0,\n \"shipping_total_cost\": 0\n },\n \"name\": \"Banner N12345\",\n \"type\": \"order\",\n \"total_sessions\": 0,\n \"max_paid_sessions\": 0,\n \"total_paid_sessions\": 0,\n \"max_sessions\": 0,\n \"created_at\": \"2024-05-13T01:09:40.6331583Z\",\n \"url\": \"https://payment-link.pagar.me/pl_GNe8zkaO2MlBxxGcJcv0BALq9Pon514W\",\n \"updated_at\": \"2024-05-13T01:09:40.6331583Z\",\n \"id\": \"pl_GNe8zkaO2MlBxxGcJcv0BALq9Pon514W\",\n \"expires_in\": 0,\n \"status\": \"active\"\n}"}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"get":{"summary":"Obter links de pagamento","description":"","operationId":"obter-links","parameters":[{"name":"name","in":"query","description":"Nome do link de pagamento gerado.","schema":{"type":"string"}},{"name":"status","in":"query","description":"Status do link de pagamento gerado. Possíveis status: **building**, **active**, **cancelled**, **expired**","schema":{"type":"string"}},{"name":"created_since","in":"query","description":"Define o filtro de data de criação do link de pagamento para busca. Formato ISO 8601.","schema":{"type":"string","format":"date"}},{"name":"created_until","in":"query","description":"Define o filtro de data de criação do link de pagamento para busca. Formato ISO 8601.","schema":{"type":"string","format":"date"}},{"name":"page","in":"query","description":"Página a ser recuperada.","schema":{"type":"integer","format":"int32"}},{"name":"per_page","in":"query","description":"Quantidade de links de pagamento recuperados por página. Máximo 30.","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/paymentlinks/{payment_link_id}":{"get":{"summary":"Obter link de pagamento","description":"","operationId":"obter-link","parameters":[{"name":"payment_link_id","in":"path","description":"ID do link de pagamento. Exemplo: pl_gD2G97aVBqvREz3Hr4u1deLW40JlnmQ8","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/paymentlinks/{payment_link_id}/activate":{"patch":{"summary":"Ativar link de pagamento em construção","description":"","operationId":"ativar-link-de-pagamento-em-construção","parameters":[{"name":"payment_link_id","in":"path","description":"ID do link de pagamento. Exemplo: pl_gD2G97aVBqvREz3Hr4u1deLW40JlnmQ8","schema":{"type":"string"},"required":true}],"responses":{"204":{"description":"204","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/paymentlinks/{payment_link_id}/cancel":{"patch":{"summary":"Cancelar link de pagamento","description":"","operationId":"cancelar-um-link-de-pagamento","parameters":[{"name":"payment_link_id","in":"path","description":"ID do link de pagamento. Exemplo: pl_gD2G97aVBqvREz3Hr4u1deLW40JlnmQ8","schema":{"type":"string"},"required":true}],"responses":{"204":{"description":"204","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/plans":{"post":{"summary":"Criar plano","description":"Este recurso possibilita a criação de um `plan` que poderá ser utilizado futuramente para a criação de uma assinatura. Para mais detalhes consulte a [pagina principal do objeto](https://docs.pagar.me/reference/planos-1).","operationId":"criar-plano-1","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Nome do plano. Max: 64 caracteres."},"description":{"type":"string","description":"Descrição do plano."},"shippable":{"type":"boolean","description":"Indica se o plano oferece entrega."},"payment_methods":{"type":"array","description":"Meios de pagamento disponíveis para assinaturas criadas a partir do plano.
Valores possíveis: **credit_card**, **boleto** ou **debit_card**. Caso nenhum seja informado, o único meio de pagamento disponível por padrão será **credit_card**","items":{"type":"string"}},"installments":{"type":"array","description":"Opções de parcelamento disponíveis para assinaturas criadas a partir do plano.
Caso não seja informado, o plano irá disponibilizar apenas assinaturas com pagamentos à vista. O número de parcelas deverá ser 1 em recorrências.","items":{"type":"integer","format":"int32"}},"minimum_price":{"type":"integer","description":"Valor mínimo em centavos da fatura.","format":"int32"},"statement_descriptor":{"type":"string","description":"Texto exibido na fatura do cartão.
Será aplicado para assinaturas de cartão de crédito criadas a partir do plano. Max: 13 caracteres."},"currency":{"type":"string","description":"Moeda. Valores possíveis: **BRL**."},"interval":{"type":"string","description":"Frequência da recorrência. Valores possíveis: **day**,**week**, **month** ou **year**.","default":"month"},"interval_count":{"type":"integer","description":"Número de intervalos de acordo com a propriedade **interval** entre cada cobrança da assinatura.
Ex.: plano mensal = **interval_count** (1) e **interval** (month)
plano trimestral = **interval_count** (3) e **interval** (month)
plano semestral = **interval_count** (6) e** interval** (month)","default":1,"format":"int32"},"trial_period_days":{"type":"integer","description":"Dias de teste. A assinatura será iniciada após o término deste período.","format":"int32"},"billing_type":{"type":"string","description":"Tipo de cobrança. Valores possíveis: **prepaid**, **postpaid **ou **exact_day**."},"billing_days":{"type":"array","description":"Dias disponíveis para cobrança das assinaturas criadas a partir do plano. Deve ser maior ou igual a 1 e menor ou igual a 28. **Obrigatório**, caso o **billing_type** seja igual a **exact_day**.","items":{"type":"integer","format":"int32"}},"items":{"type":"array","description":"Itens do plano. [Saiba mais sobre um itens do plano](https://docs.pagar.me/reference/item-do-plano-1)","items":{"properties":{"description":{"type":"string","description":"Descrição de itens."},"quantity":{"type":"string","description":"Quantidade de itens."},"pricing_scheme":{"type":"object","description":"Esquema de precificação do item.","required":["scheme_type"],"properties":{"scheme_type":{"type":"string","description":"Esquema de precificação do item. Valores possíveis: **unit**, **package**, **volume** e **tier**. Valor default: unit","default":"Unit"},"price":{"type":"integer","description":"Valor do item. Este atributo está disponível para o scheme_type : **Unit**","format":"int32"},"mininum_price":{"type":"integer","description":"Valor mínimo a ser cobrado.","format":"int32"},"price_brackets":{"type":"array","description":"Intervalo de preços. Este atributo está disponível para os scheme_type : **package**, **volume** e **tier**.","items":{"properties":{"start_quantity":{"type":"integer","description":"Valor que define a quantidade inicial de unidades do intervalo.","format":"int32"},"end_quantity":{"type":"integer","description":"Valor que define a quantidade final de unidades do intervalo.","format":"int32"},"overage_price":{"type":"integer","description":"Valor para cálculo do preço por unidade que exceder o intervalo.","format":"int32"},"price":{"type":"integer","description":"Valor para cálculo do preço dentro do intervalo. OBS: o preço a ser cobrado do cliente será calculado de acordo com a quantidade e o scheme_type","format":"int32"}},"type":"object"}}}},"cycles":{"type":"string","description":"Indica quantas vezes o item será cobrado."}},"type":"object"}},"metadata":{"type":"string","description":"Objeto chave/valor utilizado para armazenar informações adicionais sobre o plano.
[Saiba mais sobre metadata](https://docs.pagar.me/reference/metadata-1)"},"pricing_scheme":{"type":"object","description":"Esquema de precificação.
Obrigatório na ausência de **items**.","required":["scheme_type"],"properties":{"scheme_type":{"type":"string","description":"Esquema de precificação do item. Valores possíveis: **unit**, **package**, **volume** e **tier**. Valor default: unit","default":"Unit"},"price":{"type":"integer","description":"Valor do item. Este atributo está disponível para o scheme_type : **Unit**","format":"int32"},"mininum_price":{"type":"integer","description":"Valor mínimo a ser cobrado.","format":"int32"},"price_brackets":{"type":"array","description":"Intervalo de preços. Este atributo está disponível para os scheme_type : **package**, **volume** e **tier**.","items":{"properties":{"start_quantity":{"type":"integer","description":"Valor que define a quantidade inicial de unidades do intervalo.","format":"int32"},"end_quantity":{"type":"integer","description":"Valor que define a quantidade final de unidades do intervalo.","format":"int32"},"overage_price":{"type":"integer","description":"Valor para cálculo do preço por unidade que exceder o intervalo.","format":"int32"},"price":{"type":"integer","description":"Valor para cálculo do preço dentro do intervalo. OBS: o preço a ser cobrado do cliente será calculado de acordo com a quantidade e o scheme_type","format":"int32"}},"type":"object"}}}},"quantity":{"type":"integer","description":"Quantidade para o **pricing_scheme**.
Obrigatório quando o **pricing_scheme.scheme_type** for igual a **unit**.","default":null,"format":"int32"}}},"examples":{"Request Example":{"value":{"name":"Plano Gold","currency":"BRL","interval":"month","interval_count":3,"billing_type":"prepaid","minimum_price":10000,"installments":[3],"payment_methods":["credit_card","boleto"],"items":[{"name":"Musculação","quantity":1,"pricing_scheme":{"price":18990}},{"name":"Matrícula","cycles":1,"quantity":1,"pricing_scheme":{"price":5990}}],"metadata":{"id":"my_plan_id"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"plan_0z5Jd4dFk3t9Jo4m\",\n \"name\": \"Plano Gold\",\n \"url\": \"plans/plan_0z5Jd4dFk3t9Jo4m/simu/plano-gold\",\n \"minimum_price\": 10000,\n \"interval\": \"month\",\n \"interval_count\": 3,\n \"billing_type\": \"prepaid\",\n \"payment_methods\": [\n \"credit_card\",\n \"boleto\"\n ],\n \"installments\": [\n 3\n ],\n \"status\": \"active\",\n \"status_reason\": \"null\",\n \"currency\": \"BRL\",\n \"created_at\": \"2019-01-22T17:24:02Z\",\n \"updated_at\": \"2019-01-22T17:24:02Z\",\n \"items\": [\n {\n \"id\": \"pi_d97LMgRCmOFdWREe\",\n \"name\": \"Musculação\",\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2019-01-22T17:24:02Z\",\n \"updated_at\": \"2019-01-22T17:24:02Z\",\n \"pricing_scheme\": {\n \"price\": 18990,\n \"scheme_type\": \"unit\"\n }\n },\n {\n \"id\": \"pi_2rXolMkFxRILvw1M\",\n \"name\": \"Matrícula\",\n \"quantity\": 1,\n \"status\": \"active\",\n \"cycles\": 1,\n \"created_at\": \"2019-01-22T17:24:02Z\",\n \"updated_at\": \"2019-01-22T17:24:02Z\",\n \"pricing_scheme\": {\n \"price\": 5990,\n \"scheme_type\": \"unit\"\n }\n }\n ],\n \"metadata\": {\n \"id\": \"my_plan_id\"\n }\n}"}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"The request is invalid.\",\n \"errors\": {\n \"plan.name\": [\n \"The name field is required.\"\n ]\n },\n \"request\": {\n \"payment_methods\": [\n \"credit_card\"\n ],\n \"installments\": [\n 3\n ],\n \"minimum_price\": 10000,\n \"currency\": \"BRL\",\n \"interval\": \"month\",\n \"interval_count\": 3,\n \"billing_type\": \"prepaid\",\n \"items\": [\n {\n \"name\": \"Musculação\",\n \"quantity\": 1,\n \"pricing_scheme\": {\n \"price\": 18990,\n \"scheme_type\": \"unit\"\n }\n },\n {\n \"name\": \"Matrícula\",\n \"quantity\": 1,\n \"cycles\": 1,\n \"pricing_scheme\": {\n \"price\": 5990,\n \"scheme_type\": \"unit\"\n }\n }\n ],\n \"metadata\": {\n \"id\": \"my_plan_id\"\n }\n }\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The request is invalid."},"errors":{"type":"object","properties":{"plan.name":{"type":"array","items":{"type":"string","example":"The name field is required."}}}},"request":{"type":"object","properties":{"payment_methods":{"type":"array","items":{"type":"string","example":"credit_card"}},"installments":{"type":"array","items":{"type":"integer","example":3,"default":0}},"minimum_price":{"type":"integer","example":10000,"default":0},"currency":{"type":"string","example":"BRL"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":3,"default":0},"billing_type":{"type":"string","example":"prepaid"},"items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Musculação"},"quantity":{"type":"integer","example":1,"default":0},"pricing_scheme":{"type":"object","properties":{"price":{"type":"integer","example":18990,"default":0},"scheme_type":{"type":"string","example":"unit"}}}}}},"metadata":{"type":"object","properties":{"id":{"type":"string","example":"my_plan_id"}}}}}}}}}}},"deprecated":false},"get":{"summary":"Listar planos","description":"Este recurso permite listar seus planos. Pode ser utilizados alguns parâmetros como filtro da listagem.","operationId":"listar-planos-1","parameters":[{"name":"name","in":"query","description":"Nome do plano.","schema":{"type":"string"}},{"name":"status","in":"query","description":"Status do plano.
Valores possíveis: **active**, **inactive** ou **deleted**","schema":{"type":"string"}},{"name":"created_since","in":"query","description":"Data de início do período de criação a ser listado.","schema":{"type":"string","format":"date"}},{"name":"created_until","in":"query","description":"Data final do período de criação a ser listado.","schema":{"type":"string","format":"date"}},{"name":"page","in":"query","description":"Página atual.","schema":{"type":"integer","format":"int32"}},{"name":"size","in":"query","description":"Quantidade de itens por página.","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"data\": [\n {\n \"id\": \"plan_21r4CTG0ux77Qv13\",\n \"name\": \"Plano Gold\",\n \"url\": \"/plan_21r4CTG0ux77Qv13/academia/plano-gold\",\n \"minimum_price\": 10000,\n \"currency\": \"BRL\",\n \"interval\": \"month\",\n \"interval_count\": 3,\n \"billing_type\": \"prepaid\",\n \"installments\": 3,\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\",\n \"items\": [\n {\n \"id\": \"pi_3j1EG9ousipHjcUL\",\n \"name\": \"Musculação\",\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\",\n \"pricing_scheme\": {\n \"price\": 18990,\n \"scheme_type\": \"unit\"\n }\n },\n {\n \"id\": \"pi_6ggvuaJNS2LVq1i6\",\n \"name\": \"Matrícula\",\n \"cycles\": 1,\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\",\n \"pricing_scheme\": {\n \"price\": 5990,\n \"scheme_type\": \"unit\"\n }\n }\n ],\n \"metadata\": {\n \"id\": \"my_plan_id\"\n }\n }\n ],\n \"paging\": {\n \"total_items\": 1,\n \"current_page\": 1,\n \"total_pages\": 1\n }\n}"}},"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"plan_21r4CTG0ux77Qv13"},"name":{"type":"string","example":"Plano Gold"},"url":{"type":"string","example":"/plan_21r4CTG0ux77Qv13/academia/plano-gold"},"minimum_price":{"type":"integer","example":10000,"default":0},"currency":{"type":"string","example":"BRL"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":3,"default":0},"billing_type":{"type":"string","example":"prepaid"},"installments":{"type":"integer","example":3,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2016-07-12T18:25:40Z"},"updated_at":{"type":"string","example":"2016-07-12T18:25:40Z"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"pi_3j1EG9ousipHjcUL"},"name":{"type":"string","example":"Musculação"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2016-07-12T18:25:40Z"},"updated_at":{"type":"string","example":"2016-07-12T18:25:40Z"},"pricing_scheme":{"type":"object","properties":{"price":{"type":"integer","example":18990,"default":0},"scheme_type":{"type":"string","example":"unit"}}}}}},"metadata":{"type":"object","properties":{"id":{"type":"string","example":"my_plan_id"}}}}}},"paging":{"type":"object","properties":{"total_items":{"type":"integer","example":1,"default":0},"current_page":{"type":"integer","example":1,"default":0},"total_pages":{"type":"integer","example":1,"default":0}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Plan not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Plan not found."}}}}}}},"deprecated":false}},"/plans/{plan_id}":{"get":{"summary":"Obter plano","description":"A partir do identificador de um plano criado (`plan_id`) é possível recuperar as informações deste plano.","operationId":"obter-plano-1","parameters":[{"name":"plan_id","in":"path","description":"Código do plano.
Formato: `plan_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"plan_21r4CTG0ux77Qv13\",\n \"name\": \"Plano Gold\",\n \"url\": \"/plan_21r4CTG0ux77Qv13/academia/plano-gold\",\n \"currency\": \"BRL\",\n \"interval\": \"month\",\n \"interval_count\": 3,\n \"billing_type\": \"prepaid\",\n \"installments\": 3,\n \"status\": \"active\",\n \"minimum_price\": 10000,\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\",\n \"items\": [\n {\n \"id\": \"pi_3j1EG9ousipHjcUL\",\n \"name\": \"Musculação\",\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\",\n \"pricing_scheme\": {\n \"price\": 18990,\n \t\"scheme_type\": \"unit\"\n }\n },\n {\n \"id\": \"pi_6ggvuaJNS2LVq1i6\",\n \"name\": \"Matrícula\",\n \"cycles\": 1,\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\",\n \"pricing_scheme\": {\n \"price\": 5990,\n \"scheme_type\": \"unit\"\n }\n }\n ],\n \"metadata\": {\n \"id\": \"my_plan_id\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"plan_21r4CTG0ux77Qv13"},"name":{"type":"string","example":"Plano Gold"},"url":{"type":"string","example":"/plan_21r4CTG0ux77Qv13/academia/plano-gold"},"currency":{"type":"string","example":"BRL"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":3,"default":0},"billing_type":{"type":"string","example":"prepaid"},"installments":{"type":"integer","example":3,"default":0},"status":{"type":"string","example":"active"},"minimum_price":{"type":"integer","example":10000,"default":0},"created_at":{"type":"string","example":"2016-07-12T18:25:40Z"},"updated_at":{"type":"string","example":"2016-07-12T18:25:40Z"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"pi_3j1EG9ousipHjcUL"},"name":{"type":"string","example":"Musculação"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2016-07-12T18:25:40Z"},"updated_at":{"type":"string","example":"2016-07-12T18:25:40Z"},"pricing_scheme":{"type":"object","properties":{"price":{"type":"integer","example":18990,"default":0},"scheme_type":{"type":"string","example":"unit"}}}}}},"metadata":{"type":"object","properties":{"id":{"type":"string","example":"my_plan_id"}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Plan not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Plan not found."}}}}}}},"deprecated":false},"put":{"summary":"Editar plano","description":"Com o verbo HTTP PUT, através do identificador do plano (`plan_id`) é possível atualizar os dados do plano.","operationId":"editar-plano-1","parameters":[{"name":"plan_id","in":"path","description":"Código do plano.
Formato: `plan_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","status","currency","interval","interval_count"],"properties":{"name":{"type":"string","description":"Nome do plano. Max: 64 caracteres."},"status":{"type":"string","description":"Status do plano. Valores possíveis: **active** ou **inactive**"},"description":{"type":"string","description":"Descrição do plano."},"shippable":{"type":"boolean","description":"Indica se o plano oferece entrega."},"payment_methods":{"type":"array","description":"Meios de pagamento disponíveis para assinaturas criadas a partir do plano.
Valores possíveis: **credit_card**, **boleto** ou **debit_card**. Caso nenhum seja informado, o único meio de pagamento disponível por padrão será **credit_card**","items":{"type":"string"}},"installments":{"type":"array","description":"Opções de parcelamento disponíveis para assinaturas criadas a partir do plano.
Caso não seja informado, o plano irá disponibilizar apenas assinaturas com pagamentos à vista.","items":{"type":"integer","format":"int32"}},"minimum_price":{"type":"integer","description":"Valor mínimo em centavos da fatura.","format":"int32"},"statement_descriptor":{"type":"string","description":"Texto exibido na fatura do cartão.
Será aplicado para assinaturas de cartão de crédito criadas a partir do plano."},"currency":{"type":"string","description":"Moeda. Valores possíveis: **BRL**, **ARS**, **BOB**, **CLP**, **COP **, **MXN**, **PYG**, **USD **, **UYU** e **EUR**."},"interval":{"type":"string","description":"Frequência da recorrência. Valores possíveis: **day**,**week**, **month** ou **year**.","default":"month"},"interval_count":{"type":"integer","description":"Número de intervalos de acordo com a propriedade **interval** entre cada cobrança da assinatura.
Ex.: plano mensal = **interval_count** (1) e **interval** (month)
plano trimestral = **interval_count** (3) e **interval** (month)
plano semestral = **interval_count** (6) e** interval** (month)","default":1,"format":"int32"},"trial_period_days":{"type":"integer","description":"Dias de teste. A assinatura será iniciada após o término deste período.","format":"int32"},"billing_type":{"type":"string","description":"Tipo de cobrança. Valores possíveis: **prepaid**, **postpaid **ou **exact_day**."},"billing_days":{"type":"array","description":"Dias disponíveis para cobrança das assinaturas criadas a partir do plano. Deve ser maior ou igual a 1 e menor ou igual a 28. **Obrigatório**, caso o **billing_type** seja igual a **exact_day**.","items":{"type":"integer","format":"int32"}},"items":{"type":"array","description":"Itens do plano. [Saiba mais sobre um itens do plano](https://docs.pagar.me/reference/item-do-plano-1)"},"metadata":{"type":"string","description":"Objeto chave/valor utilizado para armazenar informações adicionais sobre o plano.
[Saiba mais sobre metadata](https://docs.pagar.me/reference/metadata-1)"}}},"examples":{"Request Example":{"value":{"name":"Plano Silver","description":"Esse plano oferece acesso aos programas de musculação e todos os equipamentos e atividades coletivas terrestres.","currency":"BRL","interval":"month","interval_count":3,"billing_type":"prepaid","statement_descriptor":"SILVER","minimum_price":10000,"status":"active","payment_methods":["credit_card"]}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"plan_21r4CTG0ux77Qv13\",\n \"name\": \"Plano Gold\",\n \"description\": \"Esse plano oferece acesso aos programas de musculação e todos os equipamentos e atividades coletivas terrestres.\",\n \"url\": \"/plan_21r4CTG0ux77Qv13/academia/plano-silver\",\n \"currency\": \"BRL\",\n \"interval\": \"month\",\n \"interval_count\": 3,\n \"billing_type\": \"prepaid\",\n \"installments\": 3,\n \"statement_descriptor\": \"SILVER\",\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\",\n \"minimum_price\": 10000,\n \"items\": [\n {\n \"id\": \"pi_3j1EG9ousipHjcUL\",\n \"name\": \"Musculação\",\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\",\n \"pricing_scheme\": {\n \"price\": 18990,\n \t\"scheme_type\": \"unit\"\n }\n },\n {\n \"id\": \"pi_6ggvuaJNS2LVq1i6\",\n \"name\": \"Matrícula\",\n \"cycles\": 1,\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\",\n \"pricing_scheme\": {\n \"price\": 5990,\n \"scheme_type\": \"unit\"\n }\n }\n ],\n \"metadata\": {\n \"id\": \"my_plan_id\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"plan_21r4CTG0ux77Qv13"},"name":{"type":"string","example":"Plano Gold"},"description":{"type":"string","example":"Esse plano oferece acesso aos programas de musculação e todos os equipamentos e atividades coletivas terrestres."},"url":{"type":"string","example":"/plan_21r4CTG0ux77Qv13/academia/plano-silver"},"currency":{"type":"string","example":"BRL"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":3,"default":0},"billing_type":{"type":"string","example":"prepaid"},"installments":{"type":"integer","example":3,"default":0},"statement_descriptor":{"type":"string","example":"SILVER"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2016-07-12T18:25:40Z"},"updated_at":{"type":"string","example":"2016-07-12T18:25:40Z"},"minimum_price":{"type":"integer","example":10000,"default":0},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"pi_3j1EG9ousipHjcUL"},"name":{"type":"string","example":"Musculação"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2016-07-12T18:25:40Z"},"updated_at":{"type":"string","example":"2016-07-12T18:25:40Z"},"pricing_scheme":{"type":"object","properties":{"price":{"type":"integer","example":18990,"default":0},"scheme_type":{"type":"string","example":"unit"}}}}}},"metadata":{"type":"object","properties":{"id":{"type":"string","example":"my_plan_id"}}}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"The request is invalid.\",\n \"errors\": {\n \"plan.name\": [\n \"The name field is required.\"\n ]\n },\n \"request\": {\n \"payment_methods\": [\n \"credit_card\"\n ],\n \"installments\": [\n 3\n ],\n \"minimum_price\": 10000,\n \"currency\": \"BRL\",\n \"interval\": \"month\",\n \"interval_count\": 3,\n \"billing_type\": \"prepaid\",\n \"items\": [\n {\n \"name\": \"Musculação\",\n \"quantity\": 1,\n \"pricing_scheme\": {\n \"price\": 18990,\n \"scheme_type\": \"unit\"\n }\n },\n {\n \"name\": \"Matrícula\",\n \"quantity\": 1,\n \"cycles\": 1,\n \"pricing_scheme\": {\n \"price\": 5990,\n \"scheme_type\": \"unit\"\n }\n }\n ],\n \"metadata\": {\n \"id\": \"my_plan_id\"\n }\n }\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The request is invalid."},"errors":{"type":"object","properties":{"plan.name":{"type":"array","items":{"type":"string","example":"The name field is required."}}}},"request":{"type":"object","properties":{"payment_methods":{"type":"array","items":{"type":"string","example":"credit_card"}},"installments":{"type":"array","items":{"type":"integer","example":3,"default":0}},"minimum_price":{"type":"integer","example":10000,"default":0},"currency":{"type":"string","example":"BRL"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":3,"default":0},"billing_type":{"type":"string","example":"prepaid"},"items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Musculação"},"quantity":{"type":"integer","example":1,"default":0},"pricing_scheme":{"type":"object","properties":{"price":{"type":"integer","example":18990,"default":0},"scheme_type":{"type":"string","example":"unit"}}}}}},"metadata":{"type":"object","properties":{"id":{"type":"string","example":"my_plan_id"}}}}}}}}}}},"deprecated":false},"delete":{"summary":"Excluir plano","description":"Com o verbo HTTP DELETE, através do identificador do plano (`plan_id`) é possível excluir um plano.","operationId":"excluir-plano-1","parameters":[{"name":"plan_id","in":"path","description":"Código do plano","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"plan_21r4CTG0ux77Qv13\",\n \"name\": \"Plano Gold\",\n \"description\": \"Esse plano oferece acesso aos programas de musculação e todos os equipamentos e atividades coletivas terrestres.\",\n \"url\": \"/plan_21r4CTG0ux77Qv13/academia/plano-silver\",\n \"minimum_price\": 10000,\n \"currency\": \"BRL\",\n \"interval\": \"month\",\n \"interval_count\": 3,\n \"billing_type\": \"prepaid\",\n \"installments\": 3,\n \"statement_descriptor\": \"SILVER\",\n \"status\": \"deleted\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\",\n \"deleted_at\": \"2016-07-15T13:41:02Z\",\n \"items\": [\n {\n \"id\": \"pi_3j1EG9ousipHjcUL\",\n \"name\": \"Musculação\",\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\",\n \"pricing_scheme\": {\n \"price\": 18990,\n \t\"scheme_type\": \"unit\"\n }\n },\n {\n \"id\": \"pi_6ggvuaJNS2LVq1i6\",\n \"name\": \"Matrícula\",\n \"cycles\": 1,\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\",\n \"pricing_scheme\": {\n \"price\": 5990,\n \"scheme_type\": \"unit\"\n }\n }\n ],\n \"metadata\": {\n \"id\": \"my_plan_id\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"plan_21r4CTG0ux77Qv13"},"name":{"type":"string","example":"Plano Gold"},"description":{"type":"string","example":"Esse plano oferece acesso aos programas de musculação e todos os equipamentos e atividades coletivas terrestres."},"url":{"type":"string","example":"/plan_21r4CTG0ux77Qv13/academia/plano-silver"},"minimum_price":{"type":"integer","example":10000,"default":0},"currency":{"type":"string","example":"BRL"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":3,"default":0},"billing_type":{"type":"string","example":"prepaid"},"installments":{"type":"integer","example":3,"default":0},"statement_descriptor":{"type":"string","example":"SILVER"},"status":{"type":"string","example":"deleted"},"created_at":{"type":"string","example":"2016-07-12T18:25:40Z"},"updated_at":{"type":"string","example":"2016-07-12T18:25:40Z"},"deleted_at":{"type":"string","example":"2016-07-15T13:41:02Z"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"pi_3j1EG9ousipHjcUL"},"name":{"type":"string","example":"Musculação"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2016-07-12T18:25:40Z"},"updated_at":{"type":"string","example":"2016-07-12T18:25:40Z"},"pricing_scheme":{"type":"object","properties":{"price":{"type":"integer","example":18990,"default":0},"scheme_type":{"type":"string","example":"unit"}}}}}},"metadata":{"type":"object","properties":{"id":{"type":"string","example":"my_plan_id"}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Plan not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Plan not found."}}}}}}},"deprecated":false}},"/plans/{plan_id}/metadata":{"patch":{"summary":"Editar metadados do plano","description":"Com o verbo _HTTP PATCH_, através do identificador do plano (`plan_id`) é possível atualizar o objeto `metadata` do plano.","operationId":"editar-metadados-do-plano-1","parameters":[{"name":"plan_id","in":"path","description":"Código do plano.
Formato: `plan_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["metadata"],"properties":{"metadata":{"type":"object","description":"Objeto chave/valor utilizado para armazenar informações adicionais sobre o plano.","properties":{}}}},"examples":{"Request Example":{"value":{"metadata":{"code":"1234","company":"Avengers"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"plan_jEJWD1qF2Xf92eKv\",\n \"name\": \"Premium\",\n \"description\": \"Vá de Premium. E seja feliz!\",\n \"url\": \"/plans/plan_jEJWD1qF2Xf92eKv/pagarme-teste/premium\",\n \"statement_descriptor\": \"Spotify\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"minimum_price\": 10000,\n \"billing_type\": \"postpaid\",\n \"payment_methods\": [\n \"boleto\",\n \"credit_card\"\n ],\n \"installments\": [\n 1\n ],\n \"status\": \"active\",\n \"currency\": \"BRL\",\n \"created_at\": \"2017-08-10T21:27:08Z\",\n \"updated_at\": \"2017-08-10T21:33:24Z\",\n \"items\": [\n {\n \"id\": \"pi_JDG10BpS1sKwboXk\",\n \"name\": \"Premium\",\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-08-10T21:27:08Z\",\n \"updated_at\": \"2017-08-10T21:27:08Z\",\n \"pricing_scheme\": {\n \"price\": 1490,\n \"scheme_type\": \"unit\"\n }\n }\n ],\n \"metadata\": {\n \"code\": \"1234\",\n \"company\": \"Avengers\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"plan_jEJWD1qF2Xf92eKv"},"name":{"type":"string","example":"Premium"},"description":{"type":"string","example":"Vá de Premium. E seja feliz!"},"url":{"type":"string","example":"/plans/plan_jEJWD1qF2Xf92eKv/pagarme-teste/premium"},"statement_descriptor":{"type":"string","example":"Spotify"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"minimum_price":{"type":"integer","example":10000,"default":0},"billing_type":{"type":"string","example":"postpaid"},"payment_methods":{"type":"array","items":{"type":"string","example":"boleto"}},"installments":{"type":"array","items":{"type":"integer","example":1,"default":0}},"status":{"type":"string","example":"active"},"currency":{"type":"string","example":"BRL"},"created_at":{"type":"string","example":"2017-08-10T21:27:08Z"},"updated_at":{"type":"string","example":"2017-08-10T21:33:24Z"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"pi_JDG10BpS1sKwboXk"},"name":{"type":"string","example":"Premium"},"quantity":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-08-10T21:27:08Z"},"updated_at":{"type":"string","example":"2017-08-10T21:27:08Z"},"pricing_scheme":{"type":"object","properties":{"price":{"type":"integer","example":1490,"default":0},"scheme_type":{"type":"string","example":"unit"}}}}}},"metadata":{"type":"object","properties":{"code":{"type":"string","example":"1234"},"company":{"type":"string","example":"Avengers"}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Plan not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Plan not found."}}}}}}},"deprecated":false}},"/subscriptions":{"post":{"summary":"Criar assinatura de plano","description":"Fornecemos a possibilidade de criação de uma assinatura (`subscription`) a partir de plano (`plan`).","operationId":"criar-assinatura-de-plano-1","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["plan_id","payment_method","customer_id","customer","card"],"properties":{"code":{"type":"string","description":"Código da assinatura no sistema da loja. Máx.: 52 caracteres"},"plan_id":{"type":"string","description":"Código do plano.
Formato: `plan_XXXXXXXXXXXXXXXX`"},"payment_method":{"type":"string","description":"Meio de pagamento.
Valores possíveis: **credit_card**, **boleto** e **debit_card** ."},"start_at":{"type":"string","description":"Data de início da assinatura.
Se não for informada, a assinatura será iniciada **imediatamente**.","format":"date"},"customer_id":{"type":"string","description":"Código do cliente.
**Obrigatório** caso o `customer` não seja informado. [Saiba mais sobre clientes](https://docs.pagar.me/reference/clientes-1)."},"customer":{"type":"object","description":"Dados do cliente.
**Obrigatório** caso o `customer_id` não seja informado. [Saiba mais sobre clientes](https://docs.pagar.me/reference/clientes-1).","required":["name"],"properties":{"name":{"type":"string","description":"Nome do cliente. Max: 64 caracteres."},"type":{"type":"string","description":"Tipo de cliente. Valores possíveis: individual (pessoa física) ou company (pessoa jurídica). Obrigatório, caso o document seja enviado."},"email":{"type":"string","description":"E-mail do cliente. Max: 64 caracteres."},"code":{"type":"string","description":"Código de referência do cliente no sistema da loja. Max: 52 caracteres."},"document":{"type":"string","description":"CPF, CNPJ ou PASSAPORTE do cliente. Max: 16 caracteres para CPF e CNPJ e Max: 50 caracteres para PASSAPORTE."},"document_type":{"type":"string","description":"Tipo de documento. Valores possíveis: \"CPF\", \"CNPJ\" ou \"PASSPORT\"."},"gender":{"type":"string","description":"Sexo do cliente . Valores possíveis: male ou female."},"address":{"type":"object","description":"Endereço do cliente.","properties":{"country":{"type":"string","description":"País (Código do país no formato ISO 3166-1 alpha-2)(2 digitos)"},"state":{"type":"string","description":"Estado (Código do estado no formato ISO 3166-2)."},"city":{"type":"string","description":"Cidade."},"zip_code":{"type":"string","description":"Código Postal (CEP) (Apenas numérico)."},"line_1":{"type":"string","description":"Dados principais do endereço. Neste campo deve ser informado Número, Rua, Bairro, nesta ordem e separados por vírgula."},"line_2":{"type":"string","description":"Dados complementares do endereço. Neste campo pode ser informado complemento, referências."}}},"phones":{"type":"object","description":"Telefone residencial do cliente.","properties":{"home_phone":{"type":"object","description":"Telefone residencial do cliente.","properties":{"country_code":{"type":"string","description":"Código do País (Apenas numérico)."},"area_code":{"type":"string","description":"Código da área (Apenas numérico)."},"number":{"type":"string","description":"Número do telefone (Apenas numérico)."}}},"mobile_phone":{"type":"object","description":"Telefone celular do cliente.","properties":{"country_code":{"type":"string","description":"Código do País (Apenas numérico)."},"area_code":{"type":"string","description":"Código da área (Apenas numérico)."},"number":{"type":"string","description":"Número do telefone (Apenas numérico)."}}}}},"birthdate":{"type":"string","description":"Data de nascimento do cliente.","format":"date"},"metadata":{"type":"string","description":"Objeto chave/valor utilizado para armazenar informações adicionais sobre o cliente."}}},"card":{"type":"object","description":"Cartão que será utilizado na assinatura.
**- card_id** é o código do cartão do cliente.
**- card_token** é token do cartão gerado pelo checkout transparente.
É **obrigatório** o envio de uma dessas identificações, caso o **payment_method** seja credit_card ou debit_card.
[Saiba mais sobre cartões](https://docs.pagar.me/reference/cart%C3%B5es-1).","required":["number","holder_name","exp_month","exp_year"],"properties":{"number":{"type":"string","description":"Número do cartão. Entre 13 e 19 caracteres"},"holder_name":{"type":"string","description":"Nome do portador como está impresso no cartão. Máximo de 64 caracteres (Caracteres especiais e números não são aceitos)"},"holder_document":{"type":"string","description":"CPF ou CNPJ do portador do cartão. Obrigatório caso o tipo do cartão seja voucher (bandeiras VR ou Pluxee)."},"exp_month":{"type":"integer","description":"Mês de validade do cartão. Valor entre 1 e 12 (inclusive)","format":"int32"},"exp_year":{"type":"integer","description":"Ano de validade do cartão. Formatos yy ou yyyy. Ex: 23 ou 2023.","format":"int32"},"cvv":{"type":"string","description":"Código de segurança do cartão. O campo aceita 4 ou 3 caracteres, variando por bandeira."},"brand":{"type":"string","description":"(Opcional) Bandeira do cartão. Para cartões de crédito, temos como valores possíveis: Elo, Mastercard, Visa, Amex, ou Hipercard. Para voucher, temos como valores possíveis: Alelo, Ticket, VR ou Pluxee."},"label":{"type":"string","description":"Indica a label do cartão"},"billing_address_id":{"type":"string","description":"Código do endereço de cobrança. Max: 36 caracteres.<>Opcional, pode ser utilizado no lugar do billing_address."},"billing_address":{"type":"object","properties":{"line_1":{"type":"string","description":"Linha 1 do endereço. (Número, Rua, e Bairro - Nesta ordem e separados por vírgula) Max: 256 caracteres."},"line_2":{"type":"string","description":"Linha 2 do endereço. (Complemento - Andar, Sala, Apto). Max: 128 caracteres."},"zip_code":{"type":"string","description":"CEP. Max: 16 caracteres."},"city":{"type":"string","description":"Cidade. Max: 64 caracteres."},"state":{"type":"string","description":"Código do estado no formato ISO 3166-2."},"country":{"type":"string","description":"Código do país no formato ISO 3166-1 alpha-2."}}}}},"installments":{"type":"integer","description":"Quantidade de parcelas.
O número de parcelas deverá ser 1 em recorrências.","default":1,"format":"int32"},"discounts":{"type":"array","description":"Descontos.","items":{"properties":{"cycles":{"type":"string","description":"Número de vezes que o desconto será aplicado."},"value":{"type":"string","description":"Valor do desconto."},"discount_type":{"type":"string","description":"Tipo do desconto. Valores possíveis: flat ou percentage. Valor padrão: percentage."}},"type":"object"}},"increments":{"type":"array","description":"Incrementos","items":{"properties":{"value":{"type":"integer","description":"Valor do incremento.","format":"int32"},"cycles":{"type":"string","description":"Número de vezes que o incremento será aplicado."},"increment_type":{"type":"string","description":"Tipo do incremento. Valores possíveis: flat ou percentage. Valor padrão: percentage."}},"type":"object"}},"boleto_due_days":{"type":"integer","description":"Dias para expiração do boleto. (Caso não seja passado, será pego um valor padrão das configurações da loja)","format":"int32"},"metadata":{"type":"string","description":"Objeto chave/valor utilizado para armazenar informações adicionais sobre a assinatura.
[Saiba mais sobre metadata](https://docs.pagar.me/reference/metadata-1)."}}},"examples":{"JSON (with credit card)":{"value":{"plan_id":"plan_21r4CTG0ux77Qv13","payment_method":"credit_card","boleto_due_days":5,"customer":{"name":"Tony Stark","email":"tonystark@avengers.com"},"card":{"holder_name":"Tony Stark","number":"4532464862385322","exp_month":1,"exp_year":30,"cvv":"903","billing_address":{"line_1":"375, Av. General Justo, Centro","line_2":"8º andar","zip_code":"20021130","city":"Rio de Janeiro","state":"RJ","country":"BR"}},"discounts":[{"cycles":3,"value":10,"discount_type":"percentage"}],"increments":[{"cycles":2,"value":20,"discount_type":"percentage"}],"metadata":{"id":"my_subscription_id"}}},"JSON (with boleto)":{"value":{"plan_id":"plan_21r4CTG0ux77Qv13","customer":{"name":"Tony Stark","email":"tonystark@avengers.com"},"payment_method":"boleto"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"OK (with credit card)":{"value":"{\n \"id\": \"sub_05jkdIfGYPfN26mI\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"interval\": \"month\",\n \"interval_count\": 3,\n \"billing_type\": \"prepaid\",\n \"boleto_due_days\":5,\n \"current_cycle\": {\n \"start_at\": \"2016-07-19T00:00:00Z\",\n \"end_at\": \"2016-10-18T23:59:59Z\"\n },\n \"next_billing_at\": \"2016-10-19T00:00:00Z\",\n \"installments\": 3,\n \"customer\": {\n \"id\": \"cus_017228NmffGbA3d4\",\n \"name\": \"Luke Skywalker\",\n \"email\": \"lskywalker@r2d2.com\",\n \"delinquent\": false,\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\"\n },\n \"card\": {\n \"id\": \"card_Mome2meGz4PDNQbX\",\n \"holder_name\": \"Luke Skywalker\",\n \"masked_number\": \"453246******5322\",\n \"exp_month\": 1,\n \"exp_year\": 30,\n \"expired\": false,\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"update_at\": \"2016-07-12T18:25:40Z\",\n \"billing_address\": {\n \"id\": \"addr_Mome2meGz4PDNQbX\",\n \"line_1\": \"375, Av. General Justo, Centro\",\n \"line_2\": \"8º andar\",\n \"zip_code\": \"20021130\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BR\",\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\"\n }\n },\n \"plan\": {\n \"id\": \"plan_21r4CTG0ux77Qv13\",\n \"name\": \"Plano Gold\",\n \"url\": \"/plan_21r4CTG0ux77Qv13/academia/plano-gold\",\n \"currency\": \"BRL\",\n \"interval\": \"month\",\n \"minimum_price\": 10000,\n \"interval_count\": 3,\n \"billing_type\": \"prepaid\",\n \"installments\": 3,\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\",\n \"metadata\": {\n \"id\": \"my_plan_id\"\n }\n },\n \"discounts\": [\n {\n \"id\": \"si_k2zpBDMsOs0fDfHe\",\n \"cycles\": 3,\n \"value\": 10,\n \"discount_type\": \"percentage\",\n \"created_at\": \"2016-07-12T18:25:40Z\"\n }\n ],\n \"increments\": [\n {\n \"cycles\": 2,\n \"value\": 20,\n \"discount_type\": \"percentage\"\n }\n ],\n \"items\": [\n {\n \"id\": \"si_B6555Riyq9lj6klS\",\n \"description\": \"Musculação\",\n \"quantity\": 1,\n \"pricing_scheme\": {\n \"price\": 18990\n },\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\"\n },\n {\n \"id\": \"si_lFjtC2xYGttulJpn\",\n \"description\": \"Matrícula\",\n \"quantity\": 1,\n \"cycles\": 1,\n \"pricing_scheme\": {\n \"price\": 5990\n },\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\"\n }\n ],\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\",\n \"metadata\": {\n \"id\": \"my_subscription_id\"\n }\n}"},"OK (with boleto)":{"value":"{\n \"id\": \"sub_bpYjMr9f8sA6QJNg\",\n \"code\": \"XPLMBV9U10\",\n \"start_at\": \"2018-04-04T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"postpaid\",\n \"current_cycle\": {\n \"id\": \"cycle_j6WnJ7ei1hW68bXo\",\n \"start_at\": \"2018-04-04T00:00:00Z\",\n \"end_at\": \"2018-05-03T23:59:59Z\",\n \"billing_at\": \"2018-05-04T00:00:00Z\"\n },\n \"next_billing_at\": \"2018-05-04T00:00:00Z\",\n \"payment_method\": \"boleto\",\n \"currency\": \"BRL\",\n \"statement_descriptor\": \"Spotify\",\n \"installments\": 1,\n \"status\": \"active\",\n \"created_at\": \"2018-04-04T21:36:13Z\",\n \"updated_at\": \"2018-04-04T21:36:13Z\",\n \"customer\": {\n \"id\": \"cus_qr2AgDGiOhr61Y5L\",\n \"name\": \"Tony Stark\",\n \"email\": \"cc25e912-197c-4626-a85d-8c0597e9b157@avengers.com\",\n \"delinquent\": false,\n \"created_at\": \"2018-04-04T21:36:13Z\",\n \"updated_at\": \"2018-04-04T21:36:13Z\",\n \"phones\": {}\n },\n \"plan\": {\n \"id\": \"plan_85AK5eF15feLKM4J\",\n \"name\": \"Premium\",\n \"description\": \"Vá de Premium. E seja feliz!\",\n \"url\": \"/plans/plan_85AK5eF15feLKM4J/pagarme-teste/premium\",\n \"statement_descriptor\": \"Spotify\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"postpaid\",\n \"payment_methods\": [\n \"boleto\",\n \"credit_card\"\n ],\n \"installments\": [\n 1\n ],\n \"status\": \"active\",\n \"currency\": \"BRL\",\n \"created_at\": \"2018-04-04T21:36:09Z\",\n \"updated_at\": \"2018-04-04T21:36:09Z\"\n },\n \"items\": [\n {\n \"id\": \"si_xGw3AeYiaTJ639A6\",\n \"name\": \"Name - Premium\",\n \"description\": \"Test - Description\",\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2018-04-04T21:36:13Z\",\n \"updated_at\": \"2018-04-04T21:36:13Z\",\n \"pricing_scheme\": {\n \"price\": 1490,\n \"scheme_type\": \"unit\"\n }\n }\n ]\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"sub_bpYjMr9f8sA6QJNg"},"code":{"type":"string","example":"XPLMBV9U10"},"start_at":{"type":"string","example":"2018-04-04T00:00:00Z"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"postpaid"},"current_cycle":{"type":"object","properties":{"id":{"type":"string","example":"cycle_j6WnJ7ei1hW68bXo"},"start_at":{"type":"string","example":"2018-04-04T00:00:00Z"},"end_at":{"type":"string","example":"2018-05-03T23:59:59Z"},"billing_at":{"type":"string","example":"2018-05-04T00:00:00Z"}}},"next_billing_at":{"type":"string","example":"2018-05-04T00:00:00Z"},"payment_method":{"type":"string","example":"boleto"},"currency":{"type":"string","example":"BRL"},"statement_descriptor":{"type":"string","example":"Spotify"},"installments":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2018-04-04T21:36:13Z"},"updated_at":{"type":"string","example":"2018-04-04T21:36:13Z"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_qr2AgDGiOhr61Y5L"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"cc25e912-197c-4626-a85d-8c0597e9b157@avengers.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2018-04-04T21:36:13Z"},"updated_at":{"type":"string","example":"2018-04-04T21:36:13Z"},"phones":{"type":"object","properties":{}}}},"plan":{"type":"object","properties":{"id":{"type":"string","example":"plan_85AK5eF15feLKM4J"},"name":{"type":"string","example":"Premium"},"description":{"type":"string","example":"Vá de Premium. E seja feliz!"},"url":{"type":"string","example":"/plans/plan_85AK5eF15feLKM4J/pagarme-teste/premium"},"statement_descriptor":{"type":"string","example":"Spotify"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"postpaid"},"payment_methods":{"type":"array","items":{"type":"string","example":"boleto"}},"installments":{"type":"array","items":{"type":"integer","example":1,"default":0}},"status":{"type":"string","example":"active"},"currency":{"type":"string","example":"BRL"},"created_at":{"type":"string","example":"2018-04-04T21:36:09Z"},"updated_at":{"type":"string","example":"2018-04-04T21:36:09Z"}}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"si_xGw3AeYiaTJ639A6"},"name":{"type":"string","example":"Name - Premium"},"description":{"type":"string","example":"Test - Description"},"quantity":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2018-04-04T21:36:13Z"},"updated_at":{"type":"string","example":"2018-04-04T21:36:13Z"},"pricing_scheme":{"type":"object","properties":{"price":{"type":"integer","example":1490,"default":0},"scheme_type":{"type":"string","example":"unit"}}}}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"csharp","code":"using System.Collections.Generic;\nusing System.Web.Mvc;\nusing MundiAPI.PCL;\nusing MundiAPI.PCL.Models;\n\nnamespace MundipaggTest.Controllers {\n\n public class HomeController : Controller {\n\n public ActionResult Index () {\n\n // Secret key fornecida pela Mundipagg\n string basicAuthUserName = \"SUA_CHAVE_SECRETA\";\n // Senha em branco. Passando apenas a secret key\n string basicAuthPassword = \"\";\n\n var client = new MundiAPIClient (basicAuthUserName, basicAuthPassword);\n\n string planId = \"plan_21r4CTG0ux77Qv13\";\n\n var billinAddress = new CreateAddressRequest {\n Line1 = \"375, Av. General Justo, Centro\",\n Line2 = \"8º andar\",\n ZipCode = \"20021130\",\n City = \"Rio de Janeiro\",\n State = \"RJ\",\n Country = \"BR\"\n };\n\n var card = new CreateCardRequest {\n HolderName = \"Tony Stark\",\n Number = \"4532464862385322\",\n ExpMonth = 1,\n ExpYear = 30,\n Cvv = \"903\",\n BillingAddress = billinAddress\n };\n\n var discounts = new List {\n new CreateDiscountRequest {\n Cycles = 3,\n Value = 10,\n DiscountType = \"percentage\"\n }\n };\n\n var metadata = new Dictionary ();\n metadata.Add (\"id\", \"my_subscription_id\");\n\n var request = new CreateSubscriptionRequest {\n PlanId = planId,\n PaymentMethod = \"credit_card\",\n Currency = \"BRL\",\n Interval = \"month\",\n IntervalCount = 3,\n BillingType = \"prepaid\",\n Installments = 3,\n Customer = new CreateCustomerRequest {\n Name = \"Tony Stark\",\n Email = \"tonystark@avengers.com\"\n },\n Card = card,\n Discounts = discounts,\n Metadata = metadata\n };\n\n var response = client.Subscriptions.CreateSubscription (request);\n\n return View ();\n }\n }\n}","name":"SDK C#"}],"samples-languages":["csharp"]}},"get":{"summary":"Listar assinaturas","description":"Este recurso permite listar as assinaturas. Pode ser utilizados alguns parâmetros como filtro da listagem.","operationId":"listar-assinaturas-1","parameters":[{"name":"status","in":"query","description":"Status da assinatura.
Valores possíveis: **active**, **canceled** ou **future**","schema":{"type":"string"}},{"name":"code","in":"query","description":"Código da assinatura no sistema da loja. Máx.: 52 caracteres","schema":{"type":"string"}},{"name":"billing_type","in":"query","description":"Tipo de cobrança.
Valores possíveis: **prepaid**, **postpaid **ou **exact_day**.","schema":{"type":"string"}},{"name":"customer_id","in":"query","description":"Código do cliente. [Saiba mais sobre clientes](https://docs.pagar.me/reference/clientes-1).","schema":{"type":"string"}},{"name":"plan_id","in":"query","description":"Código do plano.
Formato: `plan_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"}},{"name":"card_id","in":"query","description":"Código do cartão.
Formato: `card_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"}},{"name":"next_billing_since","in":"query","description":"Data de início da próxima data de cobrança.","schema":{"type":"string","format":"date"}},{"name":"next_billing_until","in":"query","description":"Data final de próxima data de cobrança.","schema":{"type":"string","format":"date"}},{"name":"created_since","in":"query","description":"Data de início do período de criação a ser listado.","schema":{"type":"string","format":"date"}},{"name":"created_until","in":"query","description":"Data final do período de criação a ser listado.","schema":{"type":"string","format":"date"}},{"name":"page","in":"query","description":"Página atual","schema":{"type":"integer","format":"int32","default":1}},{"name":"size","in":"query","description":"Quantidade de itens por página.","schema":{"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"data\": [\n {\n \"id\": \"sub_05jkdIfGYPfN26mI\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"interval\": \"month\",\n \"gateway_affiliation_id\": \"C56A4180-65AA-42EC-A945-5FD21DEC0538\",\n \"boleto_due_days\": 5,\n \"minimum_price\": 10000,\n \"interval_count\": 3,\n \"billing_type\": \"prepaid\",\n \"current_cycle\": {\n \"start_at\": \"2016-07-19T00:00:00Z\",\n \"end_at\": \"2016-10-18T23:59:59Z\"\n },\n \"next_billing_at\": \"2016-10-19T00:00:00Z\",\n \"installments\": 3,\n \"customer\": {\n \"id\": \"cus_017228NmffGbA3d4\",\n \"name\": \"Luke Skywalker\",\n \"email\": \"lskywalker@r2d2.com\",\n \"delinquent\": false,\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\"\n },\n \"credit_card\": {\n \"id\": \"card_Mome2meGz4PDNQbX\",\n \"holder_name\": \"Luke Skywalker\",\n \"masked_number\": \"402400******4251\",\n \"exp_month\": 6,\n \"exp_year\": 17,\n \"expired\": false,\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"update_at\": \"2016-07-12T18:25:40Z\",\n \"billing_address\": {\n \"line_1\": \"10880, Malibu Point, Malibu Central\",\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\"\n }\n },\n \"discounts\": [\n {\n \"id\": \"si_k2zpBDMsOs0fDfHe\",\n \"cycles\": 3,\n \"value\": 10,\n \"discount_type\": \"percentage\",\n \"created_at\": \"2016-07-12T18:25:40Z\"\n }\n ],\n \"increments\": [\n {\n \"id\": \"inc_IYzpxgjsOs0fDIoP\",\n \"cycles\": 2,\n \"value\": 20,\n \"discount_type\": \"percentage\",\n \"created_at\": \"2016-07-12T18:25:40Z\"\n }\n ],\n \"items\": [\n {\n \"id\": \"si_B6555Riyq9lj6klS\",\n \"description\": \"Musculação\",\n \"quantity\": 1,\n \"pricing_scheme\": {\n \"price\": 18990,\n \"scheme_type\": \"unit\"\n },\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\"\n }\n ],\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\",\n \"metadata\": {\n \"id\": \"my_subscription_id\"\n }\n }\n ],\n \"paging\": {\n \"total_items\": 1,\n \"current_page\": 1,\n \"total_pages\": 1\n }\n}"}},"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"sub_05jkdIfGYPfN26mI"},"payment_method":{"type":"string","example":"credit_card"},"currency":{"type":"string","example":"BRL"},"interval":{"type":"string","example":"month"},"gateway_affiliation_id":{"type":"string","example":"C56A4180-65AA-42EC-A945-5FD21DEC0538"},"boleto_due_days":{"type":"integer","example":5,"default":0},"minimum_price":{"type":"integer","example":10000,"default":0},"interval_count":{"type":"integer","example":3,"default":0},"billing_type":{"type":"string","example":"prepaid"},"current_cycle":{"type":"object","properties":{"start_at":{"type":"string","example":"2016-07-19T00:00:00Z"},"end_at":{"type":"string","example":"2016-10-18T23:59:59Z"}}},"next_billing_at":{"type":"string","example":"2016-10-19T00:00:00Z"},"installments":{"type":"integer","example":3,"default":0},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_017228NmffGbA3d4"},"name":{"type":"string","example":"Luke Skywalker"},"email":{"type":"string","example":"lskywalker@r2d2.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2016-07-12T18:25:40Z"},"updated_at":{"type":"string","example":"2016-07-12T18:25:40Z"}}},"credit_card":{"type":"object","properties":{"id":{"type":"string","example":"card_Mome2meGz4PDNQbX"},"holder_name":{"type":"string","example":"Luke Skywalker"},"masked_number":{"type":"string","example":"402400******4251"},"exp_month":{"type":"integer","example":6,"default":0},"exp_year":{"type":"integer","example":17,"default":0},"expired":{"type":"boolean","example":false,"default":true},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2016-07-12T18:25:40Z"},"update_at":{"type":"string","example":"2016-07-12T18:25:40Z"},"billing_address":{"type":"object","properties":{"line_1":{"type":"string","example":"10880, Malibu Point, Malibu Central"},"zip_code":{"type":"string","example":"90265"},"city":{"type":"string","example":"Malibu"},"state":{"type":"string","example":"CA"},"country":{"type":"string","example":"US"}}}}},"discounts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"si_k2zpBDMsOs0fDfHe"},"cycles":{"type":"integer","example":3,"default":0},"value":{"type":"integer","example":10,"default":0},"discount_type":{"type":"string","example":"percentage"},"created_at":{"type":"string","example":"2016-07-12T18:25:40Z"}}}},"increments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"inc_IYzpxgjsOs0fDIoP"},"cycles":{"type":"integer","example":2,"default":0},"value":{"type":"integer","example":20,"default":0},"discount_type":{"type":"string","example":"percentage"},"created_at":{"type":"string","example":"2016-07-12T18:25:40Z"}}}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"si_B6555Riyq9lj6klS"},"description":{"type":"string","example":"Musculação"},"quantity":{"type":"integer","example":1,"default":0},"pricing_scheme":{"type":"object","properties":{"price":{"type":"integer","example":18990,"default":0},"scheme_type":{"type":"string","example":"unit"}}},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2016-07-12T18:25:40Z"},"updated_at":{"type":"string","example":"2016-07-12T18:25:40Z"}}}},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2016-07-12T18:25:40Z"},"updated_at":{"type":"string","example":"2016-07-12T18:25:40Z"},"metadata":{"type":"object","properties":{"id":{"type":"string","example":"my_subscription_id"}}}}}},"paging":{"type":"object","properties":{"total_items":{"type":"integer","example":1,"default":0},"current_page":{"type":"integer","example":1,"default":0},"total_pages":{"type":"integer","example":1,"default":0}}}}}}}},"401":{"description":"401","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Authorization has been denied for this request.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Authorization has been denied for this request."}}}}}}},"deprecated":false}},"/subscriptions/{subscription_id}":{"get":{"summary":"Obter assinatura com split","description":"Este recurso possibilita, através do identificador da assinatura (subscription_id), recuperar as informações da assinatura com Split.","operationId":"obter-assinatura-split","parameters":[{"name":"subscription_id","in":"path","description":"Código da Assinatura.
Formato: `sub_XXXXXXXXXXXXXXXX.`","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"delete":{"summary":"Cancelar assinatura","description":"Com o verbo HTTP DELETE, através do identificador da assinatura (`subscription_id`) é possível cancelar a assinatura.","operationId":"cancelar-assinatura-1","parameters":[{"name":"subscription_id","in":"path","description":"Código da assinatura.
Formato: `sub_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cancel_pending_invoices":{"type":"boolean","description":"Parâmetro que define se as cobranças e faturas pendentes dentro de uma assinatura serão canceladas automaticamente com a execução do cancelamento da assinatura","default":true}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"sub_WeEMlp2FXFMjVq3Q\",\n \"code\": \"8YNU49TD4Z\",\n \"start_at\": \"2018-04-05T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"postpaid\",\n \"boleto_due_days\":5,\n \"current_cycle\": {\n \"id\": \"cycle_6ow0JqhD5sJmMJPl\",\n \"start_at\": \"2018-04-05T00:00:00Z\",\n \"end_at\": \"2018-05-04T23:59:59Z\",\n \"billing_at\": \"2018-04-05T00:00:00Z\"\n },\n \"setup\": {\n \"id\": \"or_0Wd7bYRMSmSYy8qz\",\n \"description\": \"Inscrição\",\n \"amount\": 9990,\n \"status\": \"paid\"\n },\n \"next_billing_at\": \"2018-04-05T00:00:00Z\",\n \"payment_method\": \"boleto\",\n \"currency\": \"BRL\",\n \"statement_descriptor\": \"Spotify\",\n \"installments\": 1,\n \"status\": \"canceled\",\n \"created_at\": \"2018-04-05T03:20:16Z\",\n \"updated_at\": \"2018-04-05T12:14:06Z\",\n \"canceled_at\": \"2018-04-05T12:14:06Z\",\n \"customer\": {\n \"id\": \"cus_px3yqRSlRsVqawgj\",\n \"name\": \"Tony Stark\",\n \"email\": \"ef61ded5-9e60-40c7-89cd-a3b6e70515e8@avengers.com\",\n \"delinquent\": false,\n \"created_at\": \"2018-04-05T03:20:15Z\",\n \"updated_at\": \"2018-04-05T03:20:15Z\",\n \"phones\": {}\n },\n \"plan\": {\n \"id\": \"plan_dxVldzsgzu9rpe8v\",\n \"name\": \"Premium\",\n \"description\": \"Vá de Premium. E seja feliz!\",\n \"url\": \"/plans/plan_dxVldzsgzu9rpe8v/vodafone-teste/premium\",\n \"statement_descriptor\": \"Spotify\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"postpaid\",\n \"payment_methods\": [\n \"boleto\",\n \"credit_card\"\n ],\n \"installments\": [\n 1\n ],\n \"status\": \"active\",\n \"currency\": \"BRL\",\n \"created_at\": \"2018-04-04T22:17:16Z\",\n \"updated_at\": \"2018-04-04T22:17:16Z\"\n },\n \"items\": [\n {\n \"id\": \"si_5LPVYR1c7WuJd06l\",\n \"name\": \"Name - Premium\",\n \"description\": \"Test - Description\",\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2018-04-05T03:20:16Z\",\n \"updated_at\": \"2018-04-05T03:20:16Z\",\n \"pricing_scheme\": {\n \"price\": 1490,\n \"scheme_type\": \"unit\"\n }\n }\n ]\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"sub_WeEMlp2FXFMjVq3Q"},"code":{"type":"string","example":"8YNU49TD4Z"},"start_at":{"type":"string","example":"2018-04-05T00:00:00Z"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"postpaid"},"boleto_due_days":{"type":"integer","example":5,"default":0},"current_cycle":{"type":"object","properties":{"id":{"type":"string","example":"cycle_6ow0JqhD5sJmMJPl"},"start_at":{"type":"string","example":"2018-04-05T00:00:00Z"},"end_at":{"type":"string","example":"2018-05-04T23:59:59Z"},"billing_at":{"type":"string","example":"2018-04-05T00:00:00Z"}}},"setup":{"type":"object","properties":{"id":{"type":"string","example":"or_0Wd7bYRMSmSYy8qz"},"description":{"type":"string","example":"Inscrição"},"amount":{"type":"integer","example":9990,"default":0},"status":{"type":"string","example":"paid"}}},"next_billing_at":{"type":"string","example":"2018-04-05T00:00:00Z"},"payment_method":{"type":"string","example":"boleto"},"currency":{"type":"string","example":"BRL"},"statement_descriptor":{"type":"string","example":"Spotify"},"installments":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"canceled"},"created_at":{"type":"string","example":"2018-04-05T03:20:16Z"},"updated_at":{"type":"string","example":"2018-04-05T12:14:06Z"},"canceled_at":{"type":"string","example":"2018-04-05T12:14:06Z"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_px3yqRSlRsVqawgj"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"ef61ded5-9e60-40c7-89cd-a3b6e70515e8@avengers.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2018-04-05T03:20:15Z"},"updated_at":{"type":"string","example":"2018-04-05T03:20:15Z"},"phones":{"type":"object","properties":{}}}},"plan":{"type":"object","properties":{"id":{"type":"string","example":"plan_dxVldzsgzu9rpe8v"},"name":{"type":"string","example":"Premium"},"description":{"type":"string","example":"Vá de Premium. E seja feliz!"},"url":{"type":"string","example":"/plans/plan_dxVldzsgzu9rpe8v/vodafone-teste/premium"},"statement_descriptor":{"type":"string","example":"Spotify"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"postpaid"},"payment_methods":{"type":"array","items":{"type":"string","example":"boleto"}},"installments":{"type":"array","items":{"type":"integer","example":1,"default":0}},"status":{"type":"string","example":"active"},"currency":{"type":"string","example":"BRL"},"created_at":{"type":"string","example":"2018-04-04T22:17:16Z"},"updated_at":{"type":"string","example":"2018-04-04T22:17:16Z"}}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"si_5LPVYR1c7WuJd06l"},"name":{"type":"string","example":"Name - Premium"},"description":{"type":"string","example":"Test - Description"},"quantity":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2018-04-05T03:20:16Z"},"updated_at":{"type":"string","example":"2018-04-05T03:20:16Z"},"pricing_scheme":{"type":"object","properties":{"price":{"type":"integer","example":1490,"default":0},"scheme_type":{"type":"string","example":"unit"}}}}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Subscription not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Subscription not found."}}}}}}},"deprecated":false}},"/subscriptions/{subscription_id}/card":{"patch":{"summary":"Editar cartão da assinatura","description":"Com o verbo _HTTP PATCH_, através do identificador da assinatura (`subscription_id`) é possível atualizar o cartão utilizado para pagamento da assinatura.","operationId":"editar-cartão-da-assinatura-1","parameters":[{"name":"subscription_id","in":"path","description":"Código da assinatura.
Formato: `sub_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"card_id":{"type":"string","description":"Código do cartão.
Formato: `card_XXXXXXXXXXXXXXXX`."},"card":{"type":"string","description":"Dados do novo cartão.[Saiba mais sobre cartões](https://docs.pagar.me/reference/cart%C3%B5es-1)"}}},"examples":{"Request Example":{"value":{"card":{"number":"4532912167490007","holder_name":"Tony Stark","exp_month":6,"exp_year":30,"cvv":"474","billing_address":{"line_1":"375, Av. General Justo, Centro","line_2":"8º andar","zip_code":"20021130","city":"Rio de Janeiro","state":"RJ","country":"BR"}}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"sub_WeEMlp2FXFMjVq3Q\",\n \"code\": \"8YNU49TD4Z\",\n \"start_at\": \"2018-04-05T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"postpaid\",\n \"boleto_due_days\":5,\n \"current_cycle\": {\n \"id\": \"cycle_6ow0JqhD5sJmMJPl\",\n \"start_at\": \"2018-04-05T00:00:00Z\",\n \"end_at\": \"2018-05-04T23:59:59Z\",\n \"billing_at\": \"2018-05-05T00:00:00Z\"\n },\n \"setup\": {\n \"id\": \"or_0Wd7bYRMSmSYy8qz\",\n \"description\": \"Inscrição\",\n \"amount\": 9990,\n \"status\": \"paid\"\n },\n \"next_billing_at\": \"2018-05-05T00:00:00Z\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"statement_descriptor\": \"Spotify\",\n \"installments\": 1,\n \"status\": \"active\",\n \"created_at\": \"2018-04-05T03:20:16Z\",\n \"updated_at\": \"2018-04-05T03:20:16Z\",\n \"customer\": {\n \"id\": \"cus_px3yqRSlRsVqawgj\",\n \"name\": \"Tony Stark\",\n \"email\": \"ef61ded5-9e60-40c7-89cd-a3b6e70515e8@avengers.com\",\n \"delinquent\": false,\n \"created_at\": \"2018-04-05T03:20:15Z\",\n \"updated_at\": \"2018-04-05T03:20:15Z\",\n \"phones\": {}\n },\n \"card\": {\n \"id\": \"card_qgoM31jhLidx2nm1\",\n \"first_six_digits\": \"453291\",\n \"last_four_digits\": \"0007\",\n \"brand\": \"Visa\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 6,\n \"exp_year\": 2030,\n \"status\": \"active\",\n \"created_at\": \"2018-04-05T03:29:58Z\",\n \"updated_at\": \"2018-04-05T03:49:28Z\",\n \"billing_address\": {\n \"zip_code\": \"20021130\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BR\",\n \"line_1\": \"375, Av. General Justo, Centro\",\n \"line_2\": \"8º andar\"\n },\n \"type\": \"credit\"\n },\n \"plan\": {\n \"id\": \"plan_dxVldzsgzu9rpe8v\",\n \"name\": \"Premium\",\n \"description\": \"Vá de Premium. E seja feliz!\",\n \"url\": \"/plans/plan_dxVldzsgzu9rpe8v/vodafone-teste/premium\",\n \"statement_descriptor\": \"Spotify\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"postpaid\",\n \"payment_methods\": [\n \"boleto\",\n \"credit_card\"\n ],\n \"installments\": [\n 1\n ],\n \"status\": \"active\",\n \"currency\": \"BRL\",\n \"created_at\": \"2018-04-04T22:17:16Z\",\n \"updated_at\": \"2018-04-04T22:17:16Z\"\n },\n \"items\": [\n {\n \"id\": \"si_5LPVYR1c7WuJd06l\",\n \"name\": \"Name - Premium\",\n \"description\": \"Test - Description\",\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2018-04-05T03:20:16Z\",\n \"updated_at\": \"2018-04-05T03:20:16Z\",\n \"pricing_scheme\": {\n \"price\": 1490,\n \"scheme_type\": \"unit\"\n }\n }\n ]\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"sub_WeEMlp2FXFMjVq3Q"},"code":{"type":"string","example":"8YNU49TD4Z"},"start_at":{"type":"string","example":"2018-04-05T00:00:00Z"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"postpaid"},"boleto_due_days":{"type":"integer","example":5,"default":0},"current_cycle":{"type":"object","properties":{"id":{"type":"string","example":"cycle_6ow0JqhD5sJmMJPl"},"start_at":{"type":"string","example":"2018-04-05T00:00:00Z"},"end_at":{"type":"string","example":"2018-05-04T23:59:59Z"},"billing_at":{"type":"string","example":"2018-05-05T00:00:00Z"}}},"setup":{"type":"object","properties":{"id":{"type":"string","example":"or_0Wd7bYRMSmSYy8qz"},"description":{"type":"string","example":"Inscrição"},"amount":{"type":"integer","example":9990,"default":0},"status":{"type":"string","example":"paid"}}},"next_billing_at":{"type":"string","example":"2018-05-05T00:00:00Z"},"payment_method":{"type":"string","example":"credit_card"},"currency":{"type":"string","example":"BRL"},"statement_descriptor":{"type":"string","example":"Spotify"},"installments":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2018-04-05T03:20:16Z"},"updated_at":{"type":"string","example":"2018-04-05T03:20:16Z"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_px3yqRSlRsVqawgj"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"ef61ded5-9e60-40c7-89cd-a3b6e70515e8@avengers.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2018-04-05T03:20:15Z"},"updated_at":{"type":"string","example":"2018-04-05T03:20:15Z"},"phones":{"type":"object","properties":{}}}},"card":{"type":"object","properties":{"id":{"type":"string","example":"card_qgoM31jhLidx2nm1"},"first_six_digits":{"type":"string","example":"453291"},"last_four_digits":{"type":"string","example":"0007"},"brand":{"type":"string","example":"Visa"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":6,"default":0},"exp_year":{"type":"integer","example":2030,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2018-04-05T03:29:58Z"},"updated_at":{"type":"string","example":"2018-04-05T03:49:28Z"},"billing_address":{"type":"object","properties":{"zip_code":{"type":"string","example":"20021130"},"city":{"type":"string","example":"Rio de Janeiro"},"state":{"type":"string","example":"RJ"},"country":{"type":"string","example":"BR"},"line_1":{"type":"string","example":"375, Av. General Justo, Centro"},"line_2":{"type":"string","example":"8º andar"}}},"type":{"type":"string","example":"credit"}}},"plan":{"type":"object","properties":{"id":{"type":"string","example":"plan_dxVldzsgzu9rpe8v"},"name":{"type":"string","example":"Premium"},"description":{"type":"string","example":"Vá de Premium. E seja feliz!"},"url":{"type":"string","example":"/plans/plan_dxVldzsgzu9rpe8v/vodafone-teste/premium"},"statement_descriptor":{"type":"string","example":"Spotify"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"postpaid"},"payment_methods":{"type":"array","items":{"type":"string","example":"boleto"}},"installments":{"type":"array","items":{"type":"integer","example":1,"default":0}},"status":{"type":"string","example":"active"},"currency":{"type":"string","example":"BRL"},"created_at":{"type":"string","example":"2018-04-04T22:17:16Z"},"updated_at":{"type":"string","example":"2018-04-04T22:17:16Z"}}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"si_5LPVYR1c7WuJd06l"},"name":{"type":"string","example":"Name - Premium"},"description":{"type":"string","example":"Test - Description"},"quantity":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2018-04-05T03:20:16Z"},"updated_at":{"type":"string","example":"2018-04-05T03:20:16Z"},"pricing_scheme":{"type":"object","properties":{"price":{"type":"integer","example":1490,"default":0},"scheme_type":{"type":"string","example":"unit"}}}}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Subscription not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Subscription not found."}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"The request is invalid.\",\n \"errors\": {\n \"card.number\": [\n \"The number field is not a valid credit card number.\"\n ]\n },\n \"request\": {\n \"card\": {\n \"number\": \"4532912167490008\",\n \"last_four_digits\": \"0008\",\n \"brand\": \"Visa\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 6,\n \"exp_year\": 20,\n \"cvv\": \"474\",\n \"billing_address\": {\n \"zip_code\": \"20021130\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BR\",\n \"line_1\": \"375, Av. General Justo, Centro\",\n \"line_2\": \"8º andar\",\n \"globalType\": true\n },\n \"options\": {}\n }\n }\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The request is invalid."},"errors":{"type":"object","properties":{"card.number":{"type":"array","items":{"type":"string","example":"The number field is not a valid credit card number."}}}},"request":{"type":"object","properties":{"card":{"type":"object","properties":{"number":{"type":"string","example":"4532912167490008"},"last_four_digits":{"type":"string","example":"0008"},"brand":{"type":"string","example":"Visa"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":6,"default":0},"exp_year":{"type":"integer","example":20,"default":0},"cvv":{"type":"string","example":"474"},"billing_address":{"type":"object","properties":{"zip_code":{"type":"string","example":"20021130"},"city":{"type":"string","example":"Rio de Janeiro"},"state":{"type":"string","example":"RJ"},"country":{"type":"string","example":"BR"},"line_1":{"type":"string","example":"375, Av. General Justo, Centro"},"line_2":{"type":"string","example":"8º andar"},"globalType":{"type":"boolean","example":true,"default":true}}},"options":{"type":"object","properties":{}}}}}}}}}}}},"deprecated":false}},"/subscriptions/{subscription_id}/billing-date":{"patch":{"summary":"Editar data de faturamento da assinatura","description":"Com o verbo _HTTP PATCH_, através do identificador da assinatura (`subscription_id`) é possível atualizar a data de faturamento da assinatura.","operationId":"editar-meio-de-pagamento-da-assinatura-1","parameters":[{"name":"subscription_id","in":"path","description":"Código da assinatura.
Formato: `sub_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["next_billing_at"],"properties":{"next_billing_at":{"type":"string","description":"Próxima data de cobrança."}}},"examples":{"Request Example":{"value":{"next_billing_at":"2020-04-03"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"sub_lmxK4k0hPfJ5z58w\",\n \"code\": \"9X8HROC4E0\",\n \"start_at\": \"2017-04-03T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"prepaid\",\n \"gateway_affiliation_id\": \"C56A4180-65AA-42EC-A945-5FD21DEC0538\",\n \"boleto_due_days\":5,\n \"minimum_price\": 10000,\n \"current_cycle\": {\n \"id\": \"cycle_3zyegLyCDyTZQ6Z0\",\n \"start_at\": \"2017-04-03T00:00:00Z\",\n \"end_at\": \"2017-05-02T23:59:59\",\n \"billing_at\": \"2017-04-03T00:00:00Z\"\n },\n \"next_billing_at\": \"2017-04-05T00:00:00Z\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"statement_descriptor\": \"Spotify\",\n \"installments\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-04-03T19:04:24Z\",\n \"updated_at\": \"2017-04-03T19:04:24Z\",\n \"customer\": {\n \"id\": \"cus_J4wRXJ0U6ytZrpOx\",\n \"name\": \"Tony Stark\",\n \"email\": \"tstark@avengers.com\",\n \"delinquent\": false,\n \"created_at\": \"2016-09-28T21:04:37Z\",\n \"updated_at\": \"2017-03-22T19:06:14Z\"\n },\n \"credit_card\": {\n \"id\": \"card_pEYq7rDbFeiW8V6k\",\n \"last_four_digits\": \"8229\",\n \"brand\": \"Amex\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 2018,\n \"status\": \"active\",\n \"created_at\": \"2016-11-16T17:02:39Z\",\n \"updated_at\": \"2016-12-29T12:03:24Z\",\n \"billing_address\": {\n \"line_1\": \"10880, Malibu Point, Malibu Central\",\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\"\n }\n },\n \"plan\": {\n \"id\": \"plan_pzrg5YhjyiqBgDw3\",\n \"name\": \"Plano Premium\",\n \"description\": \"Vá de Premium. E seja feliz!\",\n \"url\": \"/plans/plan_pzrg5YhjyiqBgDw3/mundipagg-teste/plano-premium\",\n \"statement_descriptor\": \"Spotify\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"prepaid\",\n \"payment_methods\": [\n \"credit_card\"\n ],\n \"installments\": [\n 1\n ],\n \"status\": \"active\",\n \"currency\": \"BRL\",\n \"created_at\": \"2017-04-03T19:04:05Z\",\n \"updated_at\": \"2017-04-03T19:04:05Z\"\n },\n \"items\": [\n {\n \"id\": \"si_K1Mj03JPSWFwxan4\",\n \"description\": \"Bola\",\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-04-03T19:04:24Z\",\n \"updated_at\": \"2017-04-03T19:04:24Z\",\n \"pricing_scheme\": {\n \"price\": 1490,\n \"scheme_type\": \"unit\"\n }\n }\n ]\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"sub_lmxK4k0hPfJ5z58w"},"code":{"type":"string","example":"9X8HROC4E0"},"start_at":{"type":"string","example":"2017-04-03T00:00:00Z"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"prepaid"},"gateway_affiliation_id":{"type":"string","example":"C56A4180-65AA-42EC-A945-5FD21DEC0538"},"boleto_due_days":{"type":"integer","example":5,"default":0},"minimum_price":{"type":"integer","example":10000,"default":0},"current_cycle":{"type":"object","properties":{"id":{"type":"string","example":"cycle_3zyegLyCDyTZQ6Z0"},"start_at":{"type":"string","example":"2017-04-03T00:00:00Z"},"end_at":{"type":"string","example":"2017-05-02T23:59:59"},"billing_at":{"type":"string","example":"2017-04-03T00:00:00Z"}}},"next_billing_at":{"type":"string","example":"2017-04-05T00:00:00Z"},"payment_method":{"type":"string","example":"credit_card"},"currency":{"type":"string","example":"BRL"},"statement_descriptor":{"type":"string","example":"Spotify"},"installments":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-03T19:04:24Z"},"updated_at":{"type":"string","example":"2017-04-03T19:04:24Z"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_J4wRXJ0U6ytZrpOx"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"tstark@avengers.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2016-09-28T21:04:37Z"},"updated_at":{"type":"string","example":"2017-03-22T19:06:14Z"}}},"credit_card":{"type":"object","properties":{"id":{"type":"string","example":"card_pEYq7rDbFeiW8V6k"},"last_four_digits":{"type":"string","example":"8229"},"brand":{"type":"string","example":"Amex"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":2018,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2016-11-16T17:02:39Z"},"updated_at":{"type":"string","example":"2016-12-29T12:03:24Z"},"billing_address":{"type":"object","properties":{"line_1":{"type":"string","example":"10880, Malibu Point, Malibu Central"},"zip_code":{"type":"string","example":"90265"},"city":{"type":"string","example":"Malibu"},"state":{"type":"string","example":"CA"},"country":{"type":"string","example":"US"}}}}},"plan":{"type":"object","properties":{"id":{"type":"string","example":"plan_pzrg5YhjyiqBgDw3"},"name":{"type":"string","example":"Plano Premium"},"description":{"type":"string","example":"Vá de Premium. E seja feliz!"},"url":{"type":"string","example":"/plans/plan_pzrg5YhjyiqBgDw3/mundipagg-teste/plano-premium"},"statement_descriptor":{"type":"string","example":"Spotify"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"prepaid"},"payment_methods":{"type":"array","items":{"type":"string","example":"credit_card"}},"installments":{"type":"array","items":{"type":"integer","example":1,"default":0}},"status":{"type":"string","example":"active"},"currency":{"type":"string","example":"BRL"},"created_at":{"type":"string","example":"2017-04-03T19:04:05Z"},"updated_at":{"type":"string","example":"2017-04-03T19:04:05Z"}}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"si_K1Mj03JPSWFwxan4"},"description":{"type":"string","example":"Bola"},"quantity":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-03T19:04:24Z"},"updated_at":{"type":"string","example":"2017-04-03T19:04:24Z"},"pricing_scheme":{"type":"object","properties":{"price":{"type":"integer","example":1490,"default":0},"scheme_type":{"type":"string","example":"unit"}}}}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Subscription not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Subscription not found."}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"The request is invalid.\",\n \"errors\": {\n \"next_billing_at\": [\n \"The next_billing_at field is invalid.\"\n ]\n },\n \"request\": {}\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The request is invalid."},"errors":{"type":"object","properties":{"next_billing_at":{"type":"array","items":{"type":"string","example":"The next_billing_at field is invalid."}}}},"request":{"type":"object","properties":{}}}}}}}},"deprecated":false}},"/subscriptions/{subscription_id}/metadata":{"patch":{"summary":"Editar metadados da assinatura","description":"Com o verbo _HTTP PATCH_, através do identificador da assinatura (`subscription_id`) é possível atualizar o objeto `metadata` da assinatura.","operationId":"editar-metadados-da-assinatura-1","parameters":[{"name":"subscription_id","in":"path","description":"Código da assinatura.
Formato: `sub_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["metadata"],"properties":{"metadata":{"type":"string","description":"Objeto chave/valor utilizado para armazenar informações adicionais sobre a assinatura.
[Saiba mais sobre metadata](https://docs.pagar.me/reference/metadata-1)"}}},"examples":{"Request Example":{"value":{"metadata":{"code":"1234","company":"Avengers"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"sub_yOkq7oI03S7Wq741\",\n \"code\": \"V9OMHENIK6\",\n \"start_at\": \"2017-08-10T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"postpaid\",\n \"gateway_affiliation_id\": \"C56A4180-65AA-42EC-A945-5FD21DEC0538\",\n \"boleto_due_days\":5,\n \"minimum_price\": 10000,\n \"current_cycle\": {\n \"id\": \"cycle_Z82JyBgSM2iwe4Lp\",\n \"start_at\": \"2017-08-10T00:00:00Z\",\n \"end_at\": \"2017-09-09T23:59:59Z\",\n \"billing_at\": \"2017-09-10T00:00:00Z\"\n },\n \"setup\": {\n \"id\": \"or_8e0l1KGFZgIpzNVG\",\n \"description\": \"Inscrição\",\n \"amount\": 9990,\n \"status\": \"paid\"\n },\n \"next_billing_at\": \"2017-09-10T00:00:00Z\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"statement_descriptor\": \"Spotify\",\n \"installments\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-08-10T21:27:13Z\",\n \"updated_at\": \"2017-08-10T21:27:29Z\",\n \"customer\": {\n \"id\": \"cus_4jEgBpgfbIe6vnqy\",\n \"name\": \"Tony Stark\",\n \"email\": \"f95783c1-c288-4dfb-9e1f-c3b9a4d55a7b@avengers.com\",\n \"delinquent\": false,\n \"created_at\": \"2017-08-10T21:27:11Z\",\n \"updated_at\": \"2017-08-10T21:27:11Z\",\n \"phones\": {}\n },\n \"card\": {\n \"id\": \"card_bQzW0GMfnAsry6KM\",\n \"first_six_digits\": \"342793\",\n \"last_four_digits\": \"8229\",\n \"brand\": \"Amex\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 2018,\n \"status\": \"active\",\n \"created_at\": \"2017-08-10T21:27:12Z\",\n \"updated_at\": \"2017-08-10T21:27:12Z\",\n \"billing_address\": {\n \"line_1\": \"10880, Malibu Point, Malibu Central\",\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\"\n },\n \"type\": \"credit\"\n },\n \"plan\": {\n \"id\": \"plan_jEJWD1qF2Xf92eKv\",\n \"name\": \"Premium\",\n \"description\": \"Vá de Premium. E seja feliz!\",\n \"url\": \"/plans/plan_jEJWD1qF2Xf92eKv/pagarme-teste/premium\",\n \"statement_descriptor\": \"Spotify\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"postpaid\",\n \"payment_methods\": [\n \"boleto\",\n \"credit_card\"\n ],\n \"installments\": [\n 1\n ],\n \"status\": \"active\",\n \"currency\": \"BRL\",\n \"created_at\": \"2017-08-10T21:27:08Z\",\n \"updated_at\": \"2017-08-10T21:27:08Z\"\n },\n \"items\": [\n {\n \"id\": \"si_ZY8Vrapsnu9QjMde\",\n \"description\": \"Premium\",\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-08-10T21:27:14Z\",\n \"updated_at\": \"2017-08-10T21:27:14Z\",\n \"pricing_scheme\": {\n \"price\": 1490,\n \"scheme_type\": \"unit\"\n }\n }\n ],\n \"metadata\": {\n \"code\": \"1234\",\n \"company\": \"Avengers\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"sub_yOkq7oI03S7Wq741"},"code":{"type":"string","example":"V9OMHENIK6"},"start_at":{"type":"string","example":"2017-08-10T00:00:00Z"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"postpaid"},"gateway_affiliation_id":{"type":"string","example":"C56A4180-65AA-42EC-A945-5FD21DEC0538"},"boleto_due_days":{"type":"integer","example":5,"default":0},"minimum_price":{"type":"integer","example":10000,"default":0},"current_cycle":{"type":"object","properties":{"id":{"type":"string","example":"cycle_Z82JyBgSM2iwe4Lp"},"start_at":{"type":"string","example":"2017-08-10T00:00:00Z"},"end_at":{"type":"string","example":"2017-09-09T23:59:59Z"},"billing_at":{"type":"string","example":"2017-09-10T00:00:00Z"}}},"setup":{"type":"object","properties":{"id":{"type":"string","example":"or_8e0l1KGFZgIpzNVG"},"description":{"type":"string","example":"Inscrição"},"amount":{"type":"integer","example":9990,"default":0},"status":{"type":"string","example":"paid"}}},"next_billing_at":{"type":"string","example":"2017-09-10T00:00:00Z"},"payment_method":{"type":"string","example":"credit_card"},"currency":{"type":"string","example":"BRL"},"statement_descriptor":{"type":"string","example":"Spotify"},"installments":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-08-10T21:27:13Z"},"updated_at":{"type":"string","example":"2017-08-10T21:27:29Z"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_4jEgBpgfbIe6vnqy"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"f95783c1-c288-4dfb-9e1f-c3b9a4d55a7b@avengers.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2017-08-10T21:27:11Z"},"updated_at":{"type":"string","example":"2017-08-10T21:27:11Z"},"phones":{"type":"object","properties":{}}}},"card":{"type":"object","properties":{"id":{"type":"string","example":"card_bQzW0GMfnAsry6KM"},"first_six_digits":{"type":"string","example":"342793"},"last_four_digits":{"type":"string","example":"8229"},"brand":{"type":"string","example":"Amex"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":2018,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-08-10T21:27:12Z"},"updated_at":{"type":"string","example":"2017-08-10T21:27:12Z"},"billing_address":{"type":"object","properties":{"line_1":{"type":"string","example":"10880, Malibu Point, Malibu Central"},"zip_code":{"type":"string","example":"90265"},"city":{"type":"string","example":"Malibu"},"state":{"type":"string","example":"CA"},"country":{"type":"string","example":"US"}}},"type":{"type":"string","example":"credit"}}},"plan":{"type":"object","properties":{"id":{"type":"string","example":"plan_jEJWD1qF2Xf92eKv"},"name":{"type":"string","example":"Premium"},"description":{"type":"string","example":"Vá de Premium. E seja feliz!"},"url":{"type":"string","example":"/plans/plan_jEJWD1qF2Xf92eKv/pagarme-teste/premium"},"statement_descriptor":{"type":"string","example":"Spotify"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"postpaid"},"payment_methods":{"type":"array","items":{"type":"string","example":"boleto"}},"installments":{"type":"array","items":{"type":"integer","example":1,"default":0}},"status":{"type":"string","example":"active"},"currency":{"type":"string","example":"BRL"},"created_at":{"type":"string","example":"2017-08-10T21:27:08Z"},"updated_at":{"type":"string","example":"2017-08-10T21:27:08Z"}}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"si_ZY8Vrapsnu9QjMde"},"description":{"type":"string","example":"Premium"},"quantity":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-08-10T21:27:14Z"},"updated_at":{"type":"string","example":"2017-08-10T21:27:14Z"},"pricing_scheme":{"type":"object","properties":{"price":{"type":"integer","example":1490,"default":0},"scheme_type":{"type":"string","example":"unit"}}}}}},"metadata":{"type":"object","properties":{"code":{"type":"string","example":"1234"},"company":{"type":"string","example":"Avengers"}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Subscription not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Subscription not found."}}}}}}},"deprecated":false}},"/subscriptions/{subscription_id}/gateway-affiliation-id":{"patch":{"summary":"Editar afiliação da assinatura no gateway","description":"Com o verbo _HTTP PATCH_, através do identificador da assinatura (`subscription_id`) é possível atualizar a data de faturamento da assinatura.","operationId":"editar-afiliação-da-assinatura-no-gateway","parameters":[{"name":"subscription_id","in":"path","description":"Código da assinatura.
Formato: `sub_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["gateway_affiliation_id"],"properties":{"gateway_affiliation_id":{"type":"string","description":"Código da afiliação no gateway."}}},"examples":{"Request Example":{"value":{"gateway_affiliation_id":"C56A4180-65AA-42EC-A945-5FD21DEC0538"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"sub_lmxK4k0hPfJ5z58w\",\n \"code\": \"9X8HROC4E0\",\n \"start_at\": \"2017-04-03T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"prepaid\",\n \"gateway_affiliation_id\": \"C56A4180-65AA-42EC-A945-5FD21DEC0538\",\n \"boleto_due_days\":5,\n \"minimum_price\": 10000,\n \"current_cycle\": {\n \"id\": \"cycle_3zyegLyCDyTZQ6Z0\",\n \"start_at\": \"2017-04-03T00:00:00Z\",\n \"end_at\": \"2017-05-02T23:59:59\",\n \"billing_at\": \"2017-04-03T00:00:00Z\"\n },\n \"next_billing_at\": \"2017-04-05T00:00:00Z\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"statement_descriptor\": \"Spotify\",\n \"installments\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-04-03T19:04:24Z\",\n \"updated_at\": \"2017-04-03T19:04:24Z\",\n \"customer\": {\n \"id\": \"cus_J4wRXJ0U6ytZrpAx\",\n \"name\": \"Tony Stark\",\n \"email\": \"tstark@avengers.com\",\n \"delinquent\": false,\n \"created_at\": \"2016-09-28T21:04:37Z\",\n \"updated_at\": \"2017-03-22T19:06:14Z\"\n },\n \"credit_card\": {\n \"id\": \"card_pEYq7rDbFeiW8V6k\",\n \"last_four_digits\": \"8229\",\n \"brand\": \"Amex\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 2018,\n \"status\": \"active\",\n \"created_at\": \"2016-11-16T17:02:39Z\",\n \"updated_at\": \"2016-12-29T12:03:24Z\",\n \"billing_address\": {\n \"line_1\": \"10880, Malibu Point, Malibu Central\",\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\"\n }\n },\n \"plan\": {\n \"id\": \"plan_pzrg5YhjyiqBgDw3\",\n \"name\": \"Plano Premium\",\n \"description\": \"Vá de Premium. E seja feliz!\",\n \"url\": \"/plans/plan_pzrg5YhjyiqBgDw3/pagarme-teste/plano-premium\",\n \"statement_descriptor\": \"Spotify\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"prepaid\",\n \"payment_methods\": [\n \"credit_card\"\n ],\n \"installments\": [\n 1\n ],\n \"status\": \"active\",\n \"currency\": \"BRL\",\n \"created_at\": \"2017-04-03T19:04:05Z\",\n \"updated_at\": \"2017-04-03T19:04:05Z\"\n },\n \"items\": [\n {\n \"id\": \"si_K1Mj03JPSWFwxan4\",\n \"description\": \"Bola\",\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-04-03T19:04:24Z\",\n \"updated_at\": \"2017-04-03T19:04:24Z\",\n \"pricing_scheme\": {\n \"price\": 1490,\n \"scheme_type\": \"unit\"\n }\n }\n ]\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"sub_lmxK4k0hPfJ5z58w"},"code":{"type":"string","example":"9X8HROC4E0"},"start_at":{"type":"string","example":"2017-04-03T00:00:00Z"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"prepaid"},"gateway_affiliation_id":{"type":"string","example":"C56A4180-65AA-42EC-A945-5FD21DEC0538"},"boleto_due_days":{"type":"integer","example":5,"default":0},"minimum_price":{"type":"integer","example":10000,"default":0},"current_cycle":{"type":"object","properties":{"id":{"type":"string","example":"cycle_3zyegLyCDyTZQ6Z0"},"start_at":{"type":"string","example":"2017-04-03T00:00:00Z"},"end_at":{"type":"string","example":"2017-05-02T23:59:59"},"billing_at":{"type":"string","example":"2017-04-03T00:00:00Z"}}},"next_billing_at":{"type":"string","example":"2017-04-05T00:00:00Z"},"payment_method":{"type":"string","example":"credit_card"},"currency":{"type":"string","example":"BRL"},"statement_descriptor":{"type":"string","example":"Spotify"},"installments":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-03T19:04:24Z"},"updated_at":{"type":"string","example":"2017-04-03T19:04:24Z"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_J4wRXJ0U6ytZrpAx"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"tstark@avengers.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2016-09-28T21:04:37Z"},"updated_at":{"type":"string","example":"2017-03-22T19:06:14Z"}}},"credit_card":{"type":"object","properties":{"id":{"type":"string","example":"card_pEYq7rDbFeiW8V6k"},"last_four_digits":{"type":"string","example":"8229"},"brand":{"type":"string","example":"Amex"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":2018,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2016-11-16T17:02:39Z"},"updated_at":{"type":"string","example":"2016-12-29T12:03:24Z"},"billing_address":{"type":"object","properties":{"line_1":{"type":"string","example":"10880, Malibu Point, Malibu Central"},"zip_code":{"type":"string","example":"90265"},"city":{"type":"string","example":"Malibu"},"state":{"type":"string","example":"CA"},"country":{"type":"string","example":"US"}}}}},"plan":{"type":"object","properties":{"id":{"type":"string","example":"plan_pzrg5YhjyiqBgDw3"},"name":{"type":"string","example":"Plano Premium"},"description":{"type":"string","example":"Vá de Premium. E seja feliz!"},"url":{"type":"string","example":"/plans/plan_pzrg5YhjyiqBgDw3/pagarme-teste/plano-premium"},"statement_descriptor":{"type":"string","example":"Spotify"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"prepaid"},"payment_methods":{"type":"array","items":{"type":"string","example":"credit_card"}},"installments":{"type":"array","items":{"type":"integer","example":1,"default":0}},"status":{"type":"string","example":"active"},"currency":{"type":"string","example":"BRL"},"created_at":{"type":"string","example":"2017-04-03T19:04:05Z"},"updated_at":{"type":"string","example":"2017-04-03T19:04:05Z"}}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"si_K1Mj03JPSWFwxan4"},"description":{"type":"string","example":"Bola"},"quantity":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-03T19:04:24Z"},"updated_at":{"type":"string","example":"2017-04-03T19:04:24Z"},"pricing_scheme":{"type":"object","properties":{"price":{"type":"integer","example":1490,"default":0},"scheme_type":{"type":"string","example":"unit"}}}}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Subscription not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Subscription not found."}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"The request is invalid.\",\n \"errors\": {\n \"gateway_affiliation_id\": [\n \"The gateway_affiliation_id field is required.\"\n ]\n },\n \"request\": {}\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The request is invalid."},"errors":{"type":"object","properties":{"gateway_affiliation_id":{"type":"array","items":{"type":"string","example":"The gateway_affiliation_id field is required."}}}},"request":{"type":"object","properties":{}}}}}}}},"deprecated":false}},"/subscriptions/{subscription_id}/payment-method":{"patch":{"summary":"Editar meio de pagamento da assinatura","description":"Com o verbo HTTP PATCH, através do identificador da assinatura (`subscription_id`) é possível atualizar o meio de pagamento da assinatura.","operationId":"editar-meio-de-pagamento-da-assinatura","parameters":[{"name":"subscription_id","in":"path","description":"Código da assinatura.
Formato: `sub_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"payment_method":{"type":"string","description":"Meio de pagamento.
Valores possíveis: **credit_card**, **boleto**, **cash** ou **debit_card** . Deve-se adicionar o meio de pagamento após o objeto \"payment_method\""},"card":{"type":"object","description":"Dados do novo cartão.
**Obrigatório** , caso o `payment_method` escolhido seja `credit_card` e o `card_id` e o `card_token` não sejam informados.","properties":{}},"card_id":{"type":"string","description":"Código do novo cartão.
**Obrigatório** , caso o `payment_method` escolhido seja `credit_card` e o objeto `card` e o `card_token` não sejam informados."},"card_token":{"type":"string","description":"Token do novo cartão.
**Obrigatório** , caso o `payment_method` escolhido seja `credit_card` e o `card_id` e o `card` não sejam informados.
[Saiba mais token de cartão](https://docs.pagar.me/reference/criar-token-cart%C3%A3o-1)"}}},"examples":{"JSON (to boleto)":{"value":{"payment_method":"boleto"}},"JSON (to credit card by Id)":{"value":{"payment_method":"credit_card","card_id":"card_PoDev5OCEEUjRJXp"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"OK (to boleto)":{"value":"{\n \"id\": \"sub_05jkdIfGYPfN26mI\",\n \"payment_method\": \"boleto\",\n \"currency\": \"BRL\",\n \"interval\": \"month\",\n \"interval_count\": 3,\n \"billing_type\": \"prepaid\",\n \"gateway_affiliation_id\":\"C56A4180-65AA-42EC-A945-5FD21DEC0538\",\n \"boleto_due_days\":5,\n \"minimum_price\": 10000,\n \"current_period\": {\n \"start_at\": \"2016-07-19T00:00:00Z\",\n \"end_at\": \"2016-10-18T23:59:59Z\"\n },\n \"next_billing_at\": \"2016-10-19T00:00:00Z\",\n \"installments\": 3,\n \"customer\": {\n \"id\": \"cus_017228NmffGbA3d4\",\n \"name\": \"Luke Skywalker\",\n \"email\": \"lskywalker@r2d2.com\",\n \"delinquent\": false,\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\"\n },\n \"discounts\": [\n {\n \"id\": \"si_k2zpBDMsOs0fDfHe\",\n \"cycles\": 3,\n \"value\": 10,\n \"discount_type\": \"percentage\",\n \"created_at\": \"2016-07-12T18:25:40Z\"\n }\n ],\n \"increments\": [\n {\n \"id\": \"inc_IYzpxgjsOs0fDIoP\",\n \"cycles\": 2,\n \"value\": 20,\n \"discount_type\": \"percentage\",\n \"created_at\": \"2016-07-12T18:25:40Z\"\n }\n ],\n \"items\": [\n {\n \"id\": \"si_B6555Riyq9lj6klS\",\n \"description\": \"Musculação\",\n \"quantity\": 1,\n \"pricing_scheme\": {\n \"price\": 18990,\n \"scheme_type\": \"unit\"\n },\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\"\n },\n {\n \"id\": \"si_lFjtC2xYGttulJpn\",\n \"description\": \"Matrícula\",\n \"quantity\": 1,\n \"cycles\": 1,\n \"pricing_scheme\": {\n \"price\": 5990,\n \"scheme_type\": \"unit\"\n },\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\"\n }\n ],\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\",\n \"metadata\": {\n \"id\": \"my_subscription_id\"\n }\n}"},"OK (to credit card by Id)":{"value":"{\n \"id\": \"sub_WeEMlp2FXFMjVq3Q\",\n \"code\": \"8YNU49TD4Z\",\n \"start_at\": \"2018-04-05T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"postpaid\",\n \"current_cycle\": {\n \"id\": \"cycle_6ow0JqhD5sJmMJPl\",\n \"start_at\": \"2018-04-05T00:00:00Z\",\n \"end_at\": \"2018-05-04T23:59:59Z\",\n \"billing_at\": \"2018-05-05T00:00:00Z\"\n },\n \"setup\": {\n \"id\": \"or_0Wd7bYRMSmSYy8qz\",\n \"description\": \"Inscrição\",\n \"amount\": 9990,\n \"status\": \"paid\"\n },\n \"next_billing_at\": \"2018-05-05T00:00:00Z\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"statement_descriptor\": \"Spotify\",\n \"installments\": 1,\n \"status\": \"active\",\n \"created_at\": \"2018-04-05T03:20:16Z\",\n \"updated_at\": \"2018-04-05T03:20:16Z\",\n \"customer\": {\n \"id\": \"cus_px3yqRSlRsVqawgj\",\n \"name\": \"Tony Stark\",\n \"email\": \"ef61ded5-9e60-40c7-89cd-a3b6e70515e8@avengers.com\",\n \"delinquent\": false,\n \"created_at\": \"2018-04-05T03:20:15Z\",\n \"updated_at\": \"2018-04-05T03:20:15Z\",\n \"phones\": {}\n },\n \"card\": {\n \"id\": \"card_PoDev5OCEEUjRJXp\",\n \"first_six_digits\": \"542501\",\n \"last_four_digits\": \"7793\",\n \"brand\": \"Mastercard\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 2022,\n \"status\": \"active\",\n \"created_at\": \"2018-04-05T04:05:02Z\",\n \"updated_at\": \"2018-04-05T04:05:02Z\",\n \"billing_address\": {\n \"street\": \"Malibu Point\",\n \"number\": \"10880\",\n \"zip_code\": \"90265\",\n \"neighborhood\": \"Central Malibu\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"line_1\": \"10880, Malibu Point, Central Malibu\"\n },\n \"type\": \"credit\"\n },\n \"plan\": {\n \"id\": \"plan_dxVldzsgzu9rpe8v\",\n \"name\": \"Premium\",\n \"description\": \"Vá de Premium. E seja feliz!\",\n \"url\": \"/plans/plan_dxVldzsgzu9rpe8v/vodafone-teste/premium\",\n \"statement_descriptor\": \"Spotify\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"postpaid\",\n \"payment_methods\": [\n \"boleto\",\n \"credit_card\"\n ],\n \"installments\": [\n 1\n ],\n \"status\": \"active\",\n \"currency\": \"BRL\",\n \"created_at\": \"2018-04-04T22:17:16Z\",\n \"updated_at\": \"2018-04-04T22:17:16Z\"\n },\n \"items\": [\n {\n \"id\": \"si_5LPVYR1c7WuJd06l\",\n \"name\": \"Name - Premium\",\n \"description\": \"Test - Description\",\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2018-04-05T03:20:16Z\",\n \"updated_at\": \"2018-04-05T03:20:16Z\",\n \"pricing_scheme\": {\n \"price\": 1490,\n \"scheme_type\": \"unit\"\n }\n }\n ]\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"sub_WeEMlp2FXFMjVq3Q"},"code":{"type":"string","example":"8YNU49TD4Z"},"start_at":{"type":"string","example":"2018-04-05T00:00:00Z"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"postpaid"},"current_cycle":{"type":"object","properties":{"id":{"type":"string","example":"cycle_6ow0JqhD5sJmMJPl"},"start_at":{"type":"string","example":"2018-04-05T00:00:00Z"},"end_at":{"type":"string","example":"2018-05-04T23:59:59Z"},"billing_at":{"type":"string","example":"2018-05-05T00:00:00Z"}}},"setup":{"type":"object","properties":{"id":{"type":"string","example":"or_0Wd7bYRMSmSYy8qz"},"description":{"type":"string","example":"Inscrição"},"amount":{"type":"integer","example":9990,"default":0},"status":{"type":"string","example":"paid"}}},"next_billing_at":{"type":"string","example":"2018-05-05T00:00:00Z"},"payment_method":{"type":"string","example":"credit_card"},"currency":{"type":"string","example":"BRL"},"statement_descriptor":{"type":"string","example":"Spotify"},"installments":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2018-04-05T03:20:16Z"},"updated_at":{"type":"string","example":"2018-04-05T03:20:16Z"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_px3yqRSlRsVqawgj"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"ef61ded5-9e60-40c7-89cd-a3b6e70515e8@avengers.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2018-04-05T03:20:15Z"},"updated_at":{"type":"string","example":"2018-04-05T03:20:15Z"},"phones":{"type":"object","properties":{}}}},"card":{"type":"object","properties":{"id":{"type":"string","example":"card_PoDev5OCEEUjRJXp"},"first_six_digits":{"type":"string","example":"542501"},"last_four_digits":{"type":"string","example":"7793"},"brand":{"type":"string","example":"Mastercard"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":2022,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2018-04-05T04:05:02Z"},"updated_at":{"type":"string","example":"2018-04-05T04:05:02Z"},"billing_address":{"type":"object","properties":{"street":{"type":"string","example":"Malibu Point"},"number":{"type":"string","example":"10880"},"zip_code":{"type":"string","example":"90265"},"neighborhood":{"type":"string","example":"Central Malibu"},"city":{"type":"string","example":"Malibu"},"state":{"type":"string","example":"CA"},"country":{"type":"string","example":"US"},"line_1":{"type":"string","example":"10880, Malibu Point, Central Malibu"}}},"type":{"type":"string","example":"credit"}}},"plan":{"type":"object","properties":{"id":{"type":"string","example":"plan_dxVldzsgzu9rpe8v"},"name":{"type":"string","example":"Premium"},"description":{"type":"string","example":"Vá de Premium. E seja feliz!"},"url":{"type":"string","example":"/plans/plan_dxVldzsgzu9rpe8v/vodafone-teste/premium"},"statement_descriptor":{"type":"string","example":"Spotify"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"postpaid"},"payment_methods":{"type":"array","items":{"type":"string","example":"boleto"}},"installments":{"type":"array","items":{"type":"integer","example":1,"default":0}},"status":{"type":"string","example":"active"},"currency":{"type":"string","example":"BRL"},"created_at":{"type":"string","example":"2018-04-04T22:17:16Z"},"updated_at":{"type":"string","example":"2018-04-04T22:17:16Z"}}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"si_5LPVYR1c7WuJd06l"},"name":{"type":"string","example":"Name - Premium"},"description":{"type":"string","example":"Test - Description"},"quantity":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2018-04-05T03:20:16Z"},"updated_at":{"type":"string","example":"2018-04-05T03:20:16Z"},"pricing_scheme":{"type":"object","properties":{"price":{"type":"integer","example":1490,"default":0},"scheme_type":{"type":"string","example":"unit"}}}}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Subscription not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Subscription not found."}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"The request is invalid.\",\n \"errors\": {\n \"\": [\n \"The card_id, card_token or card field is required.\"\n ]\n },\n \"request\": {\n \"payment_method\": \"credit_card\"\n }\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The request is invalid."},"errors":{"type":"object","properties":{"":{"type":"array","items":{"type":"string","example":"The card_id, card_token or card field is required."}}}},"request":{"type":"object","properties":{"payment_method":{"type":"string","example":"credit_card"}}}}}}}}},"deprecated":false}},"/subscriptions/{subscription_id}/start-at":{"patch":{"summary":"Editar data de início da assinatura","description":"Com o verbo _HTTP PATCH_, através do identificador da assinatura (`subscription_id`) é possível atualizar a data de início da assinatura.","operationId":"editar-data-de-início-da-assinatura-1","parameters":[{"name":"subscription_id","in":"path","description":"Código da assinatura.
Formato: `sub_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["start_at"],"properties":{"start_at":{"type":"string","description":"Data de início da assinatura.","format":"date"}}},"examples":{"Request Example":{"value":{"start_at":"2019-01-01"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"sub_lmxK4k0hPfJ5z58w\",\n \"code\": \"9X8HROC4E0\",\n \"start_at\": \"2019-01-01T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"prepaid\",\n \"gateway_affiliation_id\": \"C56A4180-65AA-42EC-A945-5FD21DEC0538\",\n \"boleto_due_days\":5,\n \"minimum_price\": 10000,\n \"next_billing_at\": \"2019-01-01T00:00:00Z\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"statement_descriptor\": \"Spotify\",\n \"installments\": 1,\n \"status\": \"active\",\n \"created_at\": \"2018-04-03T19:04:24Z\",\n \"updated_at\": \"2018-04-03T19:04:24Z\",\n \"customer\": {\n \"id\": \"cus_J4wRXJ0U6ytZrpOx\",\n \"name\": \"Tony Stark\",\n \"email\": \"tstark@avengers.com\",\n \"delinquent\": false,\n \"created_at\": \"2016-09-28T21:04:37Z\",\n \"updated_at\": \"2017-03-22T19:06:14Z\"\n },\n \"card\": {\n \"id\": \"card_pEYq7rDbFeiW8V6k\",\n \"last_four_digits\": \"8229\",\n \"brand\": \"Amex\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 2018,\n \"status\": \"active\",\n \"created_at\": \"2016-11-16T17:02:39Z\",\n \"updated_at\": \"2016-12-29T12:03:24Z\",\n \"billing_address\": {\n \"line_1\": \"10880, Malibu Point, Malibu Central\",\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\"\n }\n },\n \"plan\": {\n \"id\": \"plan_pzrg5YhjyiqBgDw3\",\n \"name\": \"Plano Premium\",\n \"description\": \"Vá de Premium. E seja feliz!\",\n \"url\": \"/plans/plan_pzrg5YhjyiqBgDw3/pagarme-teste/plano-premium\",\n \"statement_descriptor\": \"Spotify\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"prepaid\",\n \"payment_methods\": [\n \"credit_card\"\n ],\n \"installments\": [\n 1\n ],\n \"status\": \"active\",\n \"currency\": \"BRL\",\n \"created_at\": \"2017-04-03T19:04:05Z\",\n \"updated_at\": \"2017-04-03T19:04:05Z\"\n },\n \"items\": [\n {\n \"id\": \"si_K1Mj03JPSWFwxan4\",\n \"description\": \"Bola\",\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-04-03T19:04:24Z\",\n \"updated_at\": \"2017-04-03T19:04:24Z\",\n \"pricing_scheme\": {\n \"price\": 1490,\n \"scheme_type\": \"unit\"\n }\n }\n ]\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"sub_lmxK4k0hPfJ5z58w"},"code":{"type":"string","example":"9X8HROC4E0"},"start_at":{"type":"string","example":"2019-01-01T00:00:00Z"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"prepaid"},"gateway_affiliation_id":{"type":"string","example":"C56A4180-65AA-42EC-A945-5FD21DEC0538"},"boleto_due_days":{"type":"integer","example":5,"default":0},"minimum_price":{"type":"integer","example":10000,"default":0},"next_billing_at":{"type":"string","example":"2019-01-01T00:00:00Z"},"payment_method":{"type":"string","example":"credit_card"},"currency":{"type":"string","example":"BRL"},"statement_descriptor":{"type":"string","example":"Spotify"},"installments":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2018-04-03T19:04:24Z"},"updated_at":{"type":"string","example":"2018-04-03T19:04:24Z"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_J4wRXJ0U6ytZrpOx"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"tstark@avengers.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2016-09-28T21:04:37Z"},"updated_at":{"type":"string","example":"2017-03-22T19:06:14Z"}}},"card":{"type":"object","properties":{"id":{"type":"string","example":"card_pEYq7rDbFeiW8V6k"},"last_four_digits":{"type":"string","example":"8229"},"brand":{"type":"string","example":"Amex"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":2018,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2016-11-16T17:02:39Z"},"updated_at":{"type":"string","example":"2016-12-29T12:03:24Z"},"billing_address":{"type":"object","properties":{"line_1":{"type":"string","example":"10880, Malibu Point, Malibu Central"},"zip_code":{"type":"string","example":"90265"},"city":{"type":"string","example":"Malibu"},"state":{"type":"string","example":"CA"},"country":{"type":"string","example":"US"}}}}},"plan":{"type":"object","properties":{"id":{"type":"string","example":"plan_pzrg5YhjyiqBgDw3"},"name":{"type":"string","example":"Plano Premium"},"description":{"type":"string","example":"Vá de Premium. E seja feliz!"},"url":{"type":"string","example":"/plans/plan_pzrg5YhjyiqBgDw3/pagarme-teste/plano-premium"},"statement_descriptor":{"type":"string","example":"Spotify"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"prepaid"},"payment_methods":{"type":"array","items":{"type":"string","example":"credit_card"}},"installments":{"type":"array","items":{"type":"integer","example":1,"default":0}},"status":{"type":"string","example":"active"},"currency":{"type":"string","example":"BRL"},"created_at":{"type":"string","example":"2017-04-03T19:04:05Z"},"updated_at":{"type":"string","example":"2017-04-03T19:04:05Z"}}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"si_K1Mj03JPSWFwxan4"},"description":{"type":"string","example":"Bola"},"quantity":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-03T19:04:24Z"},"updated_at":{"type":"string","example":"2017-04-03T19:04:24Z"},"pricing_scheme":{"type":"object","properties":{"price":{"type":"integer","example":1490,"default":0},"scheme_type":{"type":"string","example":"unit"}}}}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Subscription not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Subscription not found."}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"The request is invalid.\",\n \"errors\": {\n \"next_billing_at\": [\n \"The next_billing_at field is invalid.\"\n ]\n },\n \"request\": {}\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The request is invalid."},"errors":{"type":"object","properties":{"next_billing_at":{"type":"array","items":{"type":"string","example":"The next_billing_at field is invalid."}}}},"request":{"type":"object","properties":{}}}}}}}},"deprecated":false}},"/subscriptions/{subscription_id}/minimum_price":{"patch":{"summary":"Editar preço mínimo da assinatura","description":"Com o verbo HTTP PATCH, através do identificador da assinatura (`subscription_id`) é possível atualizar o minimum price da assinatura.","operationId":"editar-minimum-price-da-assinatura","parameters":[{"name":"subscription_id","in":"path","description":"Código da assinatura.
Formato: `sub_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"minimum_price":{"type":"integer","description":"Valor mínimo da assinatura em centavos.","format":"int32"}}},"examples":{"Request Example":{"value":{"minimum_price":"100"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"OK (to boleto)":{"value":"{\n \"id\": \"sub_JrvX5MpS6Niq9wzL\",\n \"code\": \"6NXQF71FJD\",\n \"start_at\": \"2022-03-10T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"prepaid\",\n \"current_cycle\": {\n \"id\": \"cycle_g6ek64cdmtE6JqVj\",\n \"start_at\": \"2022-03-10T00:00:00Z\",\n \"end_at\": \"2022-04-09T23:59:59Z\",\n \"billing_at\": \"2022-03-10T00:00:00Z\",\n \"status\": \"billed\",\n \"cycle\": 1\n },\n \"next_billing_at\": \"2022-04-10T00:00:00Z\",\n \"payment_method\": \"boleto\",\n \"currency\": \"BRL\",\n \"installments\": 1,\n \"minimum_price\": 100,\n \"status\": \"active\",\n \"boleto_due_days\": 20,\n \"created_at\": \"2022-03-10T19:42:17Z\",\n \"updated_at\": \"2022-03-10T19:42:56Z\",\n \"customer\": {\n \"id\": \"cus_EbKg5vdUK9hJ0MVX\",\n \"name\": \"Tony Stark\",\n \"email\": \"98724a80-19ef-4208-bee4-739c138eb85f@avengers.com\",\n \"delinquent\": false,\n \"created_at\": \"2022-03-10T19:42:17Z\",\n \"updated_at\": \"2022-03-10T19:42:17Z\",\n \"phones\": {}\n },\n \"items\": [\n {\n \"id\": \"si_ZO5pLyltRf80ml6B\",\n \"name\": \"Premium\",\n \"description\": \"Sem anuncios\",\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2022-03-10T19:42:17Z\",\n \"updated_at\": \"2022-03-10T19:42:17Z\",\n \"pricing_scheme\": {\n \"price\": 1490,\n \"scheme_type\": \"unit\"\n }\n },\n {\n \"id\": \"si_yNo8g7TadToJ8bPa\",\n \"name\": \"Silver\",\n \"description\": \"Com anuncios\",\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2022-03-10T19:42:17Z\",\n \"updated_at\": \"2022-03-10T19:42:17Z\",\n \"pricing_scheme\": {\n \"price\": 2000,\n \"scheme_type\": \"unit\"\n }\n }\n ]\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"sub_JrvX5MpS6Niq9wzL"},"code":{"type":"string","example":"6NXQF71FJD"},"start_at":{"type":"string","example":"2022-03-10T00:00:00Z"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"prepaid"},"current_cycle":{"type":"object","properties":{"id":{"type":"string","example":"cycle_g6ek64cdmtE6JqVj"},"start_at":{"type":"string","example":"2022-03-10T00:00:00Z"},"end_at":{"type":"string","example":"2022-04-09T23:59:59Z"},"billing_at":{"type":"string","example":"2022-03-10T00:00:00Z"},"status":{"type":"string","example":"billed"},"cycle":{"type":"integer","example":1,"default":0}}},"next_billing_at":{"type":"string","example":"2022-04-10T00:00:00Z"},"payment_method":{"type":"string","example":"boleto"},"currency":{"type":"string","example":"BRL"},"installments":{"type":"integer","example":1,"default":0},"minimum_price":{"type":"integer","example":100,"default":0},"status":{"type":"string","example":"active"},"boleto_due_days":{"type":"integer","example":20,"default":0},"created_at":{"type":"string","example":"2022-03-10T19:42:17Z"},"updated_at":{"type":"string","example":"2022-03-10T19:42:56Z"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_EbKg5vdUK9hJ0MVX"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"98724a80-19ef-4208-bee4-739c138eb85f@avengers.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2022-03-10T19:42:17Z"},"updated_at":{"type":"string","example":"2022-03-10T19:42:17Z"},"phones":{"type":"object","properties":{}}}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"si_ZO5pLyltRf80ml6B"},"name":{"type":"string","example":"Premium"},"description":{"type":"string","example":"Sem anuncios"},"quantity":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2022-03-10T19:42:17Z"},"updated_at":{"type":"string","example":"2022-03-10T19:42:17Z"},"pricing_scheme":{"type":"object","properties":{"price":{"type":"integer","example":1490,"default":0},"scheme_type":{"type":"string","example":"unit"}}}}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Subscription not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Subscription not found."}}}}}}},"deprecated":false}},"/subscriptions/{subscription_id}/manual-billing":{"post":{"summary":"Ativar faturamento manual","description":"Configuração da assinatura que indica se o faturamento será feito de forma `manual` ou `automática`.`Caso esteja ativa`, as faturas não serão geradas automaticamente pelo nosso sistema, ficando a cargo do lojista realizar o faturamento pelo endpoint [Criar Fatura](https://docs.pagar.me/reference/criar-fatura-1).","operationId":"ativar-faturamento-manual-1","parameters":[{"name":"subscription_id","in":"path","description":"Código da assinatura.
Formato: `sub_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"sub_kpWeWOBcOcpqe8jg\",\n \"code\": \"PX7ECLF6Y3\",\n \"start_at\": \"2019-05-07T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"postpaid\",\n \"next_billing_at\": \"2019-06-07T00:00:00Z\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"installments\": 1,\n \"status\": \"active\",\n \"created_at\": \"2019-05-07T21:32:28Z\",\n \"updated_at\": \"2019-05-07T21:33:22Z\",\n \"manual_billing\": true\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"sub_kpWeWOBcOcpqe8jg"},"code":{"type":"string","example":"PX7ECLF6Y3"},"start_at":{"type":"string","example":"2019-05-07T00:00:00Z"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"postpaid"},"next_billing_at":{"type":"string","example":"2019-06-07T00:00:00Z"},"payment_method":{"type":"string","example":"credit_card"},"currency":{"type":"string","example":"BRL"},"installments":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2019-05-07T21:32:28Z"},"updated_at":{"type":"string","example":"2019-05-07T21:33:22Z"},"manual_billing":{"type":"boolean","example":true,"default":true}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"delete":{"summary":"Desativar faturamento manual","description":"Configuração da assinatura que indica se o faturamento será feito de forma `manual` ou `automática`.\n`Caso esteja desativada`, as faturas serão geradas automaticamente pelo nosso sistema.","operationId":"desativar-faturamento-manual-1","parameters":[{"name":"subscription_id","in":"path","description":"Código da assinatura.
Formato: `sub_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"sub_kpWeWOBcOcpqe8jg\",\n \"code\": \"PX7ECLF6Y3\",\n \"start_at\": \"2019-05-07T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"postpaid\",\n \"next_billing_at\": \"2019-06-07T00:00:00Z\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"installments\": 1,\n \"status\": \"active\",\n \"created_at\": \"2019-05-07T21:32:28Z\",\n \"updated_at\": \"2019-05-07T21:32:38Z\"\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"sub_kpWeWOBcOcpqe8jg"},"code":{"type":"string","example":"PX7ECLF6Y3"},"start_at":{"type":"string","example":"2019-05-07T00:00:00Z"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"postpaid"},"next_billing_at":{"type":"string","example":"2019-06-07T00:00:00Z"},"payment_method":{"type":"string","example":"credit_card"},"currency":{"type":"string","example":"BRL"},"installments":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2019-05-07T21:32:28Z"},"updated_at":{"type":"string","example":"2019-05-07T21:32:38Z"}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/subscriptions2":{"post":{"summary":"Teste - Criar assinatura avulsa","description":"Fornecemos a possibilidade de criação de uma assinatura (`subscription`) sem a necessidade de criação de um plano (`plan`).","operationId":"teste-criar-assinatura-avulsa","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["payment_method","customer_id","customer","items"],"properties":{"payment_method":{"type":"string","description":"Meio de pagamento.
Valores possíveis: **credit_card**, **boleto** e **debit_card** .","default":"credit_card"},"card":{"type":"array","description":"Cartão
**- card_id** é o código do cartão do cliente.
**- card_token** é token do cartão gerado pelo checkout transparente.
É **obrigatório** o envio de uma dessas identificações, caso o **payment_method** seja credit_card ou debit_card.
[Saiba mais sobre cartões](https://docs.pagar.me/v5/reference#cart%C3%B5es).","items":{"properties":{"number":{"type":"string","description":"Número do cartão. Entre 13 e 19 caracteres"},"holder_name":{"type":"string","description":"Nome do portador como está impresso no cartão. Máximo de 64 caracteres (Caracteres especiais e números não são aceitos)"},"holder_document":{"type":"string","description":"CPF ou CNPJ do portador do cartão. Obrigatório caso o tipo do cartão seja voucher (bandeiras VR ou Pluxee)."},"exp_month":{"type":"integer","description":"Mês de validade do cartão. Valor entre 1 e 12 (inclusive)","format":"int32"},"exp_year":{"type":"integer","description":"Ano de validade do cartão. Formatos yy ou yyyy. Ex: 23 ou 2023.","format":"int32"},"cvv":{"type":"string","description":"Código de segurança do cartão. O campo aceita 4 ou 3 caracteres, variando por bandeira."},"brand":{"type":"string","description":"(Opcional) Bandeira do cartão. Para cartões de crédito, temos como valores possíveis: Elo, Mastercard, Visa, Amex, ou Hipercard. Para voucher, temos como valores possíveis: Alelo, Ticket, VR ou Pluxee."},"label":{"type":"string","description":"Indica a label do cartão"},"billing_address_id":{"type":"string","description":"Código do endereço de cobrança. Max: 36 caracteres.<>Opcional, pode ser utilizado no lugar do billing_address."},"billing_address":{"type":"object","properties":{"line_1":{"type":"string","description":"Linha 1 do endereço. (Número, Rua, e Bairro - Nesta ordem e separados por vírgula) Max: 256 caracteres."},"line_2":{"type":"string","description":"Linha 2 do endereço. (Complemento - Andar, Sala, Apto). Max: 128 caracteres."},"zip_code":{"type":"string","description":"CEP. Max: 16 caracteres."},"city":{"type":"string","description":"Cidade. Max: 64 caracteres."},"state":{"type":"string","description":"Código do estado no formato ISO 3166-2."},"country":{"type":"string","description":"Código do país no formato ISO 3166-1 alpha-2."}}}},"required":["number","holder_name","exp_month","exp_year"],"type":"object"}},"boleto_due_days":{"type":"integer","description":"Dias para expiração do boleto. (Caso não seja passado, será pego um valor padrão das configurações da loja)","format":"int32"},"code":{"type":"string","description":"Código da assinatura no sistema da loja. Máx.: 52 caracteres"},"currency":{"type":"string","description":"Moeda. Valores possíveis: **BRL**","default":"BRL"},"start_at":{"type":"string","description":"Data de início da assinatura.
Se não for informada, a assinatura será iniciada **imediatamente**."},"interval":{"type":"string","description":"Intervalo da recorrência.
Valores possíveis: **day**, **week**, **month** ou **year**.","default":"month"},"interval_count":{"type":"integer","description":"Número de intervalos de acordo com a propriedade **interval** entre cada cobrança da assinatura.
Ex.: plano mensal = **interval_count** (1) e **interval** (month)
plano trimestral = **interval_count** (3) e **interval** (month)
plano semestral = **interval_count** (6) e** interval** (month)","default":1,"format":"int32"},"minimum_price":{"type":"integer","description":"Valor mínimo em centavos da assinatura.","default":null,"format":"int32"},"billing_type":{"type":"string","description":"Tipo de cobrança.
Valores possíveis: **prepaid**, **postpaid **ou **exact_day**.","default":"prepaid"},"billing_day":{"type":"integer","description":"Dia da cobrança.
**Obrigatório**, caso o **billing_type** seja **exact_day**","format":"int32"},"installments":{"type":"integer","description":"Quantidade de parcelas.
Será aplicada caso o método de pagamento da assinatura seja cartão de crédito.","default":1,"format":"int32"},"statement_descriptor":{"type":"string","description":"Texto exibido na fatura do cartão.
Será aplicado caso o método de pagamento da assinatura seja cartão de crédito. Máx.: 13 caracteres"},"customer_id":{"type":"string","description":"Código do cliente.
**Obrigatório** caso o `customer` não seja informado. [Saiba mais sobre clientes](https://docs.pagar.me/v5/reference#clientes)"},"customer":{"type":"object","description":"Dados do cliente.
**Obrigatório** caso o `customer_id` não seja informado. [Saiba mais sobre clientes](https://docs.pagar.me/v5/reference#clientes)","required":["name"],"properties":{"name":{"type":"string","description":"Nome do cliente. Max: 64 caracteres."},"type":{"type":"string","description":"Tipo de cliente. Valores possíveis: individual (pessoa física) ou company (pessoa jurídica). Obrigatório, caso o document seja enviado."},"email":{"type":"string","description":"E-mail do cliente. Max: 64 caracteres."},"code":{"type":"string","description":"Código de referência do cliente no sistema da loja. Max: 52 caracteres."},"document":{"type":"string","description":"CPF, CNPJ ou PASSAPORTE do cliente. Max: 16 caracteres para CPF e CNPJ e Max: 50 caracteres para PASSAPORTE."},"document_type":{"type":"string","description":"Tipo de documento. Valores possíveis: \"CPF\", \"CNPJ\" ou \"PASSPORT\"."},"gender":{"type":"string","description":"Sexo do cliente . Valores possíveis: male ou female."},"address":{"type":"object","description":"Endereço do cliente.","properties":{"country":{"type":"string","description":"País (Código do país no formato ISO 3166-1 alpha-2)(2 digitos)"},"state":{"type":"string","description":"Estado (Código do estado no formato ISO 3166-2)."},"city":{"type":"string","description":"Cidade."},"zip_code":{"type":"string","description":"Código Postal (CEP) (Apenas numérico)."},"line_1":{"type":"string","description":"Dados principais do endereço. Neste campo deve ser informado Número, Rua, Bairro, nesta ordem e separados por vírgula."},"line_2":{"type":"string","description":"Dados complementares do endereço. Neste campo pode ser informado complemento, referências."}}},"phones":{"type":"object","description":"Telefone residencial do cliente.","properties":{"home_phone":{"type":"object","description":"Telefone residencial do cliente.","properties":{"country_code":{"type":"string","description":"Código do País (Apenas numérico)."},"area_code":{"type":"string","description":"Código da área (Apenas numérico)."},"number":{"type":"string","description":"Número do telefone (Apenas numérico)."}}},"mobile_phone":{"type":"object","description":"Telefone celular do cliente.","properties":{"country_code":{"type":"string","description":"Código do País (Apenas numérico)."},"area_code":{"type":"string","description":"Código da área (Apenas numérico)."},"number":{"type":"string","description":"Número do telefone (Apenas numérico)."}}}}},"birthdate":{"type":"string","description":"Data de nascimento do cliente.","format":"date"},"metadata":{"type":"string","description":"Objeto chave/valor utilizado para armazenar informações adicionais sobre o cliente."}}},"items":{"type":"array","description":"Itens do assinatura.
[Saiba mais sobre item da assinatura](https://docs.pagar.me/v5/reference#item-da-assinatura)","items":{"properties":{"name":{"type":"string","description":"Nome do item."},"quantity":{"type":"string","description":"Quantidade de itens."},"description":{"type":"string","description":"Descrição do item. Máx.: 256 caracteres"},"id":{"type":"string","description":"Código do item. Formato: pi_XXXXXXXXXXXXXXXX."},"status":{"type":"string","description":"Status do item. Valores possíveis: active, inactive ou deleted."},"created_at":{"type":"string","description":"Data de criação do item."},"updated_at":{"type":"string","description":"Data de atualização do item."},"pricing_scheme":{"type":"object","description":"Esquema de precificação do item.
[Saiba mais sobre precificação de Itens](https://docs.pagar.me/docs/price-scheme)","required":["scheme_type"],"properties":{"scheme_type":{"type":"string","description":"Esquema de precificação do item. Valores possíveis: **unit**, **package**, **volume** e **tier**. Valor default: unit","default":"Unit"},"price":{"type":"integer","description":"Valor do item. Este atributo está disponível para o scheme_type : **Unit**","format":"int32"},"mininum_price":{"type":"integer","description":"Valor mínimo a ser cobrado.","format":"int32"},"price_brackets":{"type":"array","description":"Intervalo de preços. Este atributo está disponível para os scheme_type : **package**, **volume** e **tier**.","items":{"properties":{"start_quantity":{"type":"integer","description":"Valor que define a quantidade inicial de unidades do intervalo.","format":"int32"},"end_quantity":{"type":"integer","description":"Valor que define a quantidade final de unidades do intervalo.","format":"int32"},"overage_price":{"type":"integer","description":"Valor para cálculo do preço por unidade que exceder o intervalo.","format":"int32"},"price":{"type":"integer","description":"Valor para cálculo do preço dentro do intervalo. OBS: o preço a ser cobrado do cliente será calculado de acordo com a quantidade e o scheme_type","format":"int32"}},"type":"object"}}}}},"required":["quantity","description"],"type":"object"}},"setup":{"type":"array","description":"Pedido que pode ser criado assim que a assinatura for iniciada. Ex: Pode ser utilizado como uma taxa de adesão ao serviço.","items":{"properties":{"amount":{"type":"integer","description":"Valor do setup pedido em centavos","format":"int32"},"description":{"type":"string","description":"Descrição do setup (pedidos)."},"payment":{"type":"object","description":"Pagamento do pedido, pode ser usado qualquer da nossas opções de pagamento.
[Saiba mais sobre pagamentos](https://docs.pagar.me/reference#vis%C3%A3o-geral-sobre-pagamento)","properties":{"bank":{"type":"string","description":"Código do banco. 001 (Banco do Brasil); 033 (Santander); 237 (Bradesco); 341 (Itau); 745 (Citibank) e 104 (Caixa Econômica Federal)."},"instructions":{"type":"string","description":"Instruções do boleto. Max: 256 caracteres."},"due_at":{"type":"string","description":"Data de vencimento. (Opcional)"},"nosso_numero":{"type":"string","description":"Número que identifica unicamente um boleto para uma conta."},"type":{"type":"string","description":"Tipo de espécie do boleto.DM (Duplicata Mercantil) e BDP (Boleto de proposta)"},"document_number":{"type":"string","description":"Identificador do boleto. Max: 16 caracteres."},"interest":{"type":"object","description":"Aplicação do juros sobre o boleto.","required":["days","type","amount"],"properties":{"days":{"type":"integer","description":"Dias após a expiração do boleto quando o juros deve ser cobrado.","format":"int32"},"type":{"type":"string","description":"Tipo de divisão. Os valores possíveis são flat ou percentage."},"amount":{"type":"string","description":"Valor em porcentagem ou em centavos da taxa de juros que será cobrada ao mês."}}},"fine":{"type":"object","description":"Aplicação da multa sobre o boleto.","required":["days","type","amount"],"properties":{"days":{"type":"integer","description":"Dias após a expiração do boleto quando a multa deve ser cobrada.","format":"int32"},"type":{"type":"string","description":"Tipo de divisão. Os valores possíveis são flat ou percentage."},"amount":{"type":"integer","description":"Valor em porcentagem ou em centavos que será cobrada na multa.","format":"int32"}}},"discount":{"type":"object","description":"Objeto raiz de desconto por antecipação. Exclusivo PSP.","properties":{"type":{"type":"string","description":"Tipo do desconto: \"percentage\" (% sobre o total) ou \"flat\" (centavos). Aplica-se a todas as regras do array."},"rules":{"type":"array","description":"Lista de regras de desconto ordenadas por limit_date crescente.","items":{"properties":{"limit_date":{"type":"string","description":"Data limite da regra. Formato YYYY-MM-DD. Deve ser anterior ao due_at do boleto."},"amount":{"type":"integer","description":"Valor do desconto. Se type: percentage: entre 0.01 e 100 (ex: 15.00 = 15%). Se type: flat: inteiro em centavos, mín. 1 (ex: 500 = R$5,00).","format":"int32"}},"type":"object"}}}}}}},"required":["amount","description"],"type":"object"}},"discounts":{"type":"array","description":"Descontos.","items":{"properties":{"cycles":{"type":"string","description":"Número de vezes que o desconto será aplicado."},"value":{"type":"string","description":"Valor do desconto."},"discount_type":{"type":"string","description":"Tipo do desconto. Valores possíveis: flat ou percentage. Valor padrão: percentage."}},"type":"object"}},"increments":{"type":"array","description":"Incrementos","items":{"properties":{"value":{"type":"integer","description":"Valor do incremento.","format":"int32"},"cycles":{"type":"string","description":"Número de vezes que o incremento será aplicado."},"increment_type":{"type":"string","description":"Tipo do incremento. Valores possíveis: flat ou percentage. Valor padrão: percentage."}},"type":"object"}},"gateway_affiliation_id":{"type":"string","description":"Código da afiliação no gateway."},"metadata":{"type":"object","description":"Objeto chave/valor utilizado para armazenar informações adicionais sobre a assinatura.
[Saiba mais sobre metadata](https://docs.pagar.me/v5/reference#metadata).","properties":{}}}},"examples":{"JSON (with credit card)":{"value":{"code":"123456","payment_method":"credit_card","currency":"BRL","start_at":"2025-04-03","interval":"month","interval_count":"1","minimum_price":"10000","billing_type":"exact_day","billing_day":10,"installments":5,"statement_descriptor":"Assinatura x","customer":{"name":"Tony Stark","email":"tonystark@avengers.com","type":"individual","document":"28619068040"},"card":{"holder_name":"Tony Stark","number":"4000000000000010","exp_month":1,"exp_year":30,"cvv":"903","billing_address":{"line_1":"375, Av. General Justo, Centro","line_2":"8º andar","zip_code":"20021130","city":"Rio de Janeiro","state":"RJ","country":"BR"}},"items":[{"description":"Musculação","quantity":1,"pricing_scheme":{"price":18990}}],"setup":{"amount":"2000","description":"Taxa de adesão","payment":{"payment_method":"credit_card","credit_card":{"card":{"holder_name":"Tony Stark","number":"4000000000000010","exp_month":1,"exp_year":30,"cvv":"903","billing_address":{"line_1":"375, Av. General Justo, Centro","line_2":"8º andar","zip_code":"20021130","city":"Rio de Janeiro","state":"RJ","country":"BR"}}}}},"metadata":{"id":"my_subscription_id"}}},"JSON (with boleto)":{"value":{"code":"123456","payment_method":"boleto","start_at":"2025-04-03","interval":"month","interval_count":"1","minimum_price":"10000","billing_type":"exact_day","billing_day":10,"boleto_due_days":5,"customer":{"name":"Tony Stark","email":"tonystark@avengers.com","type":"individual","document":"28619068040","address":{"line_1":"375, Av. General Justo, Centro","line_2":"8º andar","zip_code":"20021130","city":"Rio de Janeiro","state":"RJ","country":"BR"}},"items":[{"description":"Musculação","quantity":1,"pricing_scheme":{"price":18990}}],"setup":{"amount":"2000","description":"Taxa de adesão","payment":{"payment_method":"boleto","boleto":{"instructions":"Pagar até o vencimento","due_at":"2025-09-20T00:00:00Z","document_number":"47683264474","type":"DM"}}},"metadata":{"id":"my_subscription_id"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"OK (with credit card)":{"value":"{\n \"id\": \"sub_05jkdIfGYPfN26mI\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"interval\": \"month\",\n \"interval_count\": 3,\n \"gateway_affiliation_id\": \"C56A4180-65AA-42EC-A945-5FD21DEC0538\",\n \"minimum_price\": 10000,\n \"billing_type\": \"prepaid\",\n \"boleto_due_days\":5,\n \"current_period\": {\n \"start_at\": \"2016-07-19T00:00:00Z\",\n \"end_at\": \"2016-10-18T23:59:59Z\"\n },\n \"next_billing_at\": \"2016-10-19T00:00:00Z\",\n \"installments\": 3,\n \"customer\": {\n \"id\": \"cus_017228NmffGbA3d4\",\n \"name\": \"Tony Stark\",\n \"email\": \"tonystark@avengers.com\",\n \"delinquent\": false,\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\"\n },\n \"credit_card\": {\n \"id\": \"card_Mome2meGz4PDNQbX\",\n \"holder_name\": \"Tony Stark\",\n \"masked_number\": \"453246******5322\",\n \"exp_month\": 1,\n \"exp_year\": 30,\n \"expired\": false,\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"update_at\": \"2016-07-12T18:25:40Z\",\n \"billing_address\": {\n \"id\": \"addr_Mome2meGz4PDNQbX\",\n \"line_1\": \"375, Av. General Justo, Centro\",\n \"line_2\": \"8º andar\",\n \"zip_code\": \"20021130\",\n \"city\": \"Rio de Janeiro\",\n \"state\": \"RJ\",\n \"country\": \"BR\",\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\"\n }\n },\n \"discounts\": [\n {\n \"id\": \"si_k2zpBDMsOs0fDfHe\",\n \"cycles\": 3,\n \"value\": 10,\n \"discount_type\": \"percentage\",\n \"created_at\": \"2016-07-12T18:25:40Z\"\n }\n ],\n \"increments\": [\n {\n \"id\": \"inc_IYzpxgjsOs0fDIoP\",\n \"cycles\": 2,\n \"value\": 20,\n \"discount_type\": \"percentage\",\n \"created_at\": \"2016-07-12T18:25:40Z\"\n }\n ],\n \"items\": [\n {\n \"id\": \"si_B6555Riyq9lj6klS\",\n \"description\": \"Musculação\",\n \"quantity\": 1,\n \"pricing_scheme\": {\n \"price\": 18990,\n \"scheme_type\": \"unit\"\n },\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\"\n },\n {\n \"id\": \"si_lFjtC2xYGttulJpn\",\n \"description\": \"Matrícula\",\n \"quantity\": 1,\n \"cycles\": 1,\n \"pricing_scheme\": {\n \"price\": 5990,\n \"scheme_type\": \"unit\"\n },\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\"\n }\n ],\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\",\n \"metadata\": {\n \"id\": \"my_subscription_id\"\n }\n}"},"OK (with boleto)":{"value":"{\n \"id\": \"sub_8RQW76TG8SOeYZro\",\n \"code\": \"3R0ZSQ5BJ5\",\n \"start_at\": \"2018-04-04T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"prepaid\",\n \"current_cycle\": {\n \"id\": \"cycle_GvX8zgQU9NUemBm5\",\n \"start_at\": \"2018-04-04T00:00:00Z\",\n \"end_at\": \"2018-05-03T23:59:59Z\",\n \"billing_at\": \"2018-04-04T00:00:00Z\"\n },\n \"next_billing_at\": \"2018-05-04T00:00:00Z\",\n \"payment_method\": \"boleto\",\n \"currency\": \"BRL\",\n \"installments\": 1,\n \"status\": \"active\",\n \"created_at\": \"2018-04-04T20:59:01Z\",\n \"updated_at\": \"2018-04-04T20:59:01Z\",\n \"customer\": {\n \"id\": \"cus_a21Y9wCnVszRqVR5\",\n \"name\": \"Tony Stark\",\n \"email\": \"903c2a55-0ce0-47c5-8b64-fa6a3036f861@avengers.com\",\n \"delinquent\": false,\n \"created_at\": \"2018-04-04T20:59:01Z\",\n \"updated_at\": \"2018-04-04T20:59:01Z\",\n \"phones\": {}\n },\n \"items\": [\n {\n \"id\": \"si_6DOoWzDip7izX8xV\",\n \"name\": \"Premium\",\n \"description\": \"Sem anuncios\",\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2018-04-04T20:59:01Z\",\n \"updated_at\": \"2018-04-04T20:59:01Z\",\n \"pricing_scheme\": {\n \"price\": 1490,\n \"scheme_type\": \"unit\"\n }\n },\n {\n \"id\": \"si_yp9G6e2T54t0r7OB\",\n \"name\": \"Silver\",\n \"description\": \"Com anuncios\",\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2018-04-04T20:59:01Z\",\n \"updated_at\": \"2018-04-04T20:59:01Z\",\n \"pricing_scheme\": {\n \"price\": 2000,\n \"scheme_type\": \"unit\"\n }\n }\n ]\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"sub_8RQW76TG8SOeYZro"},"code":{"type":"string","example":"3R0ZSQ5BJ5"},"start_at":{"type":"string","example":"2018-04-04T00:00:00Z"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"prepaid"},"current_cycle":{"type":"object","properties":{"id":{"type":"string","example":"cycle_GvX8zgQU9NUemBm5"},"start_at":{"type":"string","example":"2018-04-04T00:00:00Z"},"end_at":{"type":"string","example":"2018-05-03T23:59:59Z"},"billing_at":{"type":"string","example":"2018-04-04T00:00:00Z"}}},"next_billing_at":{"type":"string","example":"2018-05-04T00:00:00Z"},"payment_method":{"type":"string","example":"boleto"},"currency":{"type":"string","example":"BRL"},"installments":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2018-04-04T20:59:01Z"},"updated_at":{"type":"string","example":"2018-04-04T20:59:01Z"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_a21Y9wCnVszRqVR5"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"903c2a55-0ce0-47c5-8b64-fa6a3036f861@avengers.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2018-04-04T20:59:01Z"},"updated_at":{"type":"string","example":"2018-04-04T20:59:01Z"},"phones":{"type":"object","properties":{}}}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"si_6DOoWzDip7izX8xV"},"name":{"type":"string","example":"Premium"},"description":{"type":"string","example":"Sem anuncios"},"quantity":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2018-04-04T20:59:01Z"},"updated_at":{"type":"string","example":"2018-04-04T20:59:01Z"},"pricing_scheme":{"type":"object","properties":{"price":{"type":"integer","example":1490,"default":0},"scheme_type":{"type":"string","example":"unit"}}}}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/subscriptions/{subscription_id}/items":{"post":{"summary":"Incluir item","description":"Através do identificador da assinatura (`subscription_id`) é possível incluir itens na assinatura do cliente.","operationId":"incluir-item-1","parameters":[{"name":"subscription_id","in":"path","description":"Código da assinatura.
Formato: `sub_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["description","pricing_scheme","quantity"],"properties":{"plan_item_id":{"type":"string","description":"Código do item do plano.
Max: 36 caracteres."},"description":{"type":"string","description":"Descrição do item.
Max: 256 caracteres.
**Obrigatório** caso o `plan_item_id` não seja informado."},"cycles":{"type":"integer","description":"Indica quantas vezes o item será cobrado.
Caso não seja informado, o item será cobrado até que seja excluído o desativado.","format":"int32"},"pricing_scheme":{"type":"object","description":"Esquema de precificação.
[Saiba mais sobre precificação](https://docs.pagar.me/reference/precifica%C3%A7%C3%A3o).","required":["scheme_type"],"properties":{"scheme_type":{"type":"string","description":"Esquema de precificação do item. Valores possíveis: **unit**, **package**, **volume** e **tier**. Valor default: unit","default":"Unit"},"price":{"type":"integer","description":"Valor do item. Este atributo está disponível para o scheme_type : **Unit**","format":"int32"},"mininum_price":{"type":"integer","description":"Valor mínimo a ser cobrado.","format":"int32"},"price_brackets":{"type":"array","description":"Intervalo de preços. Este atributo está disponível para os scheme_type : **package**, **volume** e **tier**.","items":{"properties":{"start_quantity":{"type":"integer","description":"Valor que define a quantidade inicial de unidades do intervalo.","format":"int32"},"end_quantity":{"type":"integer","description":"Valor que define a quantidade final de unidades do intervalo.","format":"int32"},"overage_price":{"type":"integer","description":"Valor para cálculo do preço por unidade que exceder o intervalo.","format":"int32"},"price":{"type":"integer","description":"Valor para cálculo do preço dentro do intervalo. OBS: o preço a ser cobrado do cliente será calculado de acordo com a quantidade e o scheme_type","format":"int32"}},"type":"object"}}}},"discounts":{"type":"array","description":"Descontos do item.
[Saiba mais sobre desconto](https://docs.pagar.me/reference/desconto-1)","items":{"properties":{"cycles":{"type":"string","description":"Número de vezes que o desconto será aplicado."},"value":{"type":"string","description":"Valor do desconto."},"discount_type":{"type":"string","description":"Tipo do desconto. Valores possíveis: flat ou percentage. Valor padrão: percentage."}},"type":"object"}},"quantity":{"type":"integer","description":"Quantidade de itens.
**Obrigatório** caso **pricing_scheme.scheme_type** seja **unit**","format":"int32"},"name":{"type":"string","description":"Nome do item da assinatura."},"increments":{"type":"array","description":"Incrementos do item.
[Saiba mais sobre desconto](https://docs.pagar.me/reference/incremento-1)","items":{"properties":{"value":{"type":"integer","description":"Valor do incremento.","format":"int32"},"cycles":{"type":"string","description":"Número de vezes que o incremento será aplicado."},"increment_type":{"type":"string","description":"Tipo do incremento. Valores possíveis: flat ou percentage. Valor padrão: percentage."}},"type":"object"}}}},"examples":{"Request Example":{"value":{"description":"Celular","cycles":1,"quantity":1,"pricing_scheme":{"price":99}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"si_WQEmvEEfGigkL0Zx\",\n \"description\": \"Celular\",\n \"cycles\": 1,\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-07-28T21:00:26Z\",\n \"updated_at\": \"2017-07-28T21:00:26Z\",\n \"pricing_scheme\": {\n \"price\": 99,\n \"scheme_type\": \"unit\"\n },\n \"subscription\": {\n \"id\": \"sub_z4ogwpZfdKCnGj9m\",\n \"code\": \"3670A7IQWL\",\n \"start_at\": \"2017-07-28T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 3,\n \"billing_type\": \"prepaid\",\n \"next_billing_at\": \"2017-10-28T00:00:00Z\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"installments\": 3,\n \"status\": \"active\",\n \"created_at\": \"2017-07-28T20:59:18Z\",\n \"updated_at\": \"2017-07-28T20:59:18Z\",\n \"metadata\": {\n \"id\": \"my_subscription_id\"\n }\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"si_WQEmvEEfGigkL0Zx"},"description":{"type":"string","example":"Celular"},"cycles":{"type":"integer","example":1,"default":0},"quantity":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-07-28T21:00:26Z"},"updated_at":{"type":"string","example":"2017-07-28T21:00:26Z"},"pricing_scheme":{"type":"object","properties":{"price":{"type":"integer","example":99,"default":0},"scheme_type":{"type":"string","example":"unit"}}},"subscription":{"type":"object","properties":{"id":{"type":"string","example":"sub_z4ogwpZfdKCnGj9m"},"code":{"type":"string","example":"3670A7IQWL"},"start_at":{"type":"string","example":"2017-07-28T00:00:00Z"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":3,"default":0},"billing_type":{"type":"string","example":"prepaid"},"next_billing_at":{"type":"string","example":"2017-10-28T00:00:00Z"},"payment_method":{"type":"string","example":"credit_card"},"currency":{"type":"string","example":"BRL"},"installments":{"type":"integer","example":3,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-07-28T20:59:18Z"},"updated_at":{"type":"string","example":"2017-07-28T20:59:18Z"},"metadata":{"type":"object","properties":{"id":{"type":"string","example":"my_subscription_id"}}}}}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"The request is invalid.\",\n \"errors\": {\n \"item.cycles\": [\n \"The field cycles must be greater than or equal to 1\"\n ]\n },\n \"request\": {\n \"description\": \"Celular\",\n \"cycles\": 0,\n \"quantity\": 1,\n \"pricing_scheme\": {\n \"price\": 99,\n \"scheme_type\": \"unit\"\n }\n }\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The request is invalid."},"errors":{"type":"object","properties":{"item.cycles":{"type":"array","items":{"type":"string","example":"The field cycles must be greater than or equal to 1"}}}},"request":{"type":"object","properties":{"description":{"type":"string","example":"Celular"},"cycles":{"type":"integer","example":0,"default":0},"quantity":{"type":"integer","example":1,"default":0},"pricing_scheme":{"type":"object","properties":{"price":{"type":"integer","example":99,"default":0},"scheme_type":{"type":"string","example":"unit"}}}}}}}}}}},"deprecated":false},"get":{"summary":"Listar itens de uma assinatura","description":"Este recurso permite listar as assinaturas. Pode ser utilizados alguns parâmetros como filtro da listagem.","operationId":"listar-ítens-de-uma-assinatura","parameters":[{"name":"subscription_id","in":"path","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Status da assinatura.
Valores possíveis: **active**, **deleted*"},"name":{"type":"string","description":"Nome do item da assinatura."},"description":{"type":"string","description":"Descrição do item."},"cycle":{"type":"integer","description":"Indica quantas vezes o item será cobrado.
Caso não seja informado, o item será cobrado até que seja excluído o desativado.","format":"int32"},"created_since":{"type":"string","description":"Data de início do item de criação a ser listado.","format":"date"},"created_until":{"type":"string","description":"Data final do item de criação a ser listado.","format":"date-time"},"page":{"type":"integer","description":"Página atual","default":1,"format":"int32"},"size":{"type":"integer","description":"Quantidade de itens por página.","default":10,"format":"int32"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"data\": [\n {\n \"id\": \"si_ZqbrJQ6udHLolQ5W\",\n \"description\": \"iPhone APP\",\n \"cycles\": 1,\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2018-05-25T19:23:13Z\",\n \"updated_at\": \"2018-05-25T19:23:13Z\",\n \"pricing_scheme\": {\n \"price\": 99,\n \"scheme_type\": \"unit\"\n }\n },\n {\n \"id\": \"si_aXJ02LRtgH6Rq5Z3\",\n \"name\": \"Silver\",\n \"description\": \"Com anuncios\",\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2018-05-25T19:23:06Z\",\n \"updated_at\": \"2018-05-25T19:23:06Z\",\n \"pricing_scheme\": {\n \"price\": 2000,\n \"scheme_type\": \"unit\"\n },\n \"increments\": [\n {\n \"id\": \"inc_vl89g83tGWI084xJ\",\n \"value\": 20,\n \"increment_type\": \"percentage\",\n \"status\": \"active\",\n \"created_at\": \"2018-05-25T19:23:06Z\"\n }\n ]\n },\n {\n \"id\": \"si_3n7EdJAi4xflMqAm\",\n \"name\": \"Premium\",\n \"description\": \"Sem anuncios\",\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2018-05-25T19:23:06Z\",\n \"updated_at\": \"2018-05-25T19:23:06Z\",\n \"pricing_scheme\": {\n \"price\": 1490,\n \"scheme_type\": \"unit\"\n },\n \"discounts\": [\n {\n \"id\": \"dis_pVokdVbCGFWx0lxd\",\n \"value\": 10,\n \"discount_type\": \"percentage\",\n \"description\": \"Desconto 10% Item Sem Anuncios\",\n \"status\": \"active\",\n \"created_at\": \"2018-05-25T19:23:06Z\"\n }\n ],\n \"increments\": [\n {\n \"id\": \"inc_vxkVopbf8irZ85B7\",\n \"value\": 20,\n \"increment_type\": \"percentage\",\n \"description\": \"Incremento 20% Item Sem Anuncios\",\n \"status\": \"active\",\n \"created_at\": \"2018-05-25T19:23:06Z\"\n }\n ]\n }\n ],\n \"paging\": {\n \"total\": 3\n }\n}"}},"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"si_ZqbrJQ6udHLolQ5W"},"description":{"type":"string","example":"iPhone APP"},"cycles":{"type":"integer","example":1,"default":0},"quantity":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2018-05-25T19:23:13Z"},"updated_at":{"type":"string","example":"2018-05-25T19:23:13Z"},"pricing_scheme":{"type":"object","properties":{"price":{"type":"integer","example":99,"default":0},"scheme_type":{"type":"string","example":"unit"}}}}}},"paging":{"type":"object","properties":{"total":{"type":"integer","example":3,"default":0}}}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"The request is invalid.\",\n \"errors\": {\n \"item.cycles\": [\n \"The field cycles must be greater than or equal to 1\"\n ]\n },\n \"request\": {\n \"description\": \"Celular\",\n \"cycles\": 0,\n \"quantity\": 1,\n \"pricing_scheme\": {\n \"price\": 99,\n \"scheme_type\": \"unit\"\n }\n }\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The request is invalid."},"errors":{"type":"object","properties":{"item.cycles":{"type":"array","items":{"type":"string","example":"The field cycles must be greater than or equal to 1"}}}},"request":{"type":"object","properties":{"description":{"type":"string","example":"Celular"},"cycles":{"type":"integer","example":0,"default":0},"quantity":{"type":"integer","example":1,"default":0},"pricing_scheme":{"type":"object","properties":{"price":{"type":"integer","example":99,"default":0},"scheme_type":{"type":"string","example":"unit"}}}}}}}}}}},"deprecated":false}},"/subscriptions/{subscription_id}/items/{item_id}":{"put":{"summary":"Editar item","description":"Com o verbo _HTTP PUT_, através dos identificadores do item (`subscription_item_id`) e da assinatura (`subscription_id`) associada é possível atualizar os dados do item da assinatura.","operationId":"editar-item","parameters":[{"name":"subscription_id","in":"path","description":"Código da assinatura.
Formato: `sub_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true},{"name":"item_id","in":"path","description":"Código do item da assinatura.
Formato: `si_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["quantity"],"properties":{"name":{"type":"string","description":"Nome do item da assinatura."},"description":{"type":"string","description":"Descrição do item.
Max: 256 caracteres.
**Obrigatório** caso o `plan_item_id` não seja informado."},"cycle":{"type":"integer","description":"Indica quantas vezes o item será cobrado.
Caso não seja informado, o item será cobrado até que seja excluído o desativado.","format":"int32"},"page":{"type":"integer","description":"Página atual","default":1,"format":"int32"},"size":{"type":"integer","description":"Quantidade de itens por página.","default":10,"format":"int32"},"quantity":{"type":"integer","description":"Quantidade de itens.
**Obrigatório** caso **pricing_scheme.scheme_type** seja **unit**.","format":"int32"},"pricing_scheme":{"type":"object","description":"Esquema de precificação.
[Saiba mais sobre precificação](https://docs.pagar.me/reference/precifica%C3%A7%C3%A3o)","required":["scheme_type"],"properties":{"scheme_type":{"type":"string","description":"Esquema de precificação do item. Valores possíveis: **unit**, **package**, **volume** e **tier**. Valor default: unit","default":"Unit"},"price":{"type":"integer","description":"Valor do item. Este atributo está disponível para o scheme_type : **Unit**","format":"int32"},"mininum_price":{"type":"integer","description":"Valor mínimo a ser cobrado.","format":"int32"},"price_brackets":{"type":"array","description":"Intervalo de preços. Este atributo está disponível para os scheme_type : **package**, **volume** e **tier**.","items":{"properties":{"start_quantity":{"type":"integer","description":"Valor que define a quantidade inicial de unidades do intervalo.","format":"int32"},"end_quantity":{"type":"integer","description":"Valor que define a quantidade final de unidades do intervalo.","format":"int32"},"overage_price":{"type":"integer","description":"Valor para cálculo do preço por unidade que exceder o intervalo.","format":"int32"},"price":{"type":"integer","description":"Valor para cálculo do preço dentro do intervalo. OBS: o preço a ser cobrado do cliente será calculado de acordo com a quantidade e o scheme_type","format":"int32"}},"type":"object"}}}}}},"examples":{"Request Example":{"value":{"name":"Nome - teste","description":"Telefone","cycles":3,"quantity":1,"pricing_scheme":{"price":99}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"si_mARl1OvTYcA3pG49\",\n \"description\": \"Telefone\",\n \"cycles\": 3,\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-04-04T18:56:44Z\",\n \"updated_at\": \"2017-04-04T18:57:48Z\",\n \"pricing_scheme\": {\n \"price\": 99,\n \"scheme_type\": \"unit\"\n },\n \"subscription\": {\n \"id\": \"sub_o0Jw4WYCMuPNqzGr\",\n \"code\": \"09NFPLBZY0\",\n \"start_at\": \"2017-04-04T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"postpaid\",\n \"next_billing_at\": \"2017-05-04T00:00:00Z\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"statement_descriptor\": \"Spotify\",\n \"installments\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-04-04T18:21:17\",\n \"updated_at\": \"2017-04-04T18:21:17\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"si_mARl1OvTYcA3pG49"},"description":{"type":"string","example":"Telefone"},"cycles":{"type":"integer","example":3,"default":0},"quantity":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-04T18:56:44Z"},"updated_at":{"type":"string","example":"2017-04-04T18:57:48Z"},"pricing_scheme":{"type":"object","properties":{"price":{"type":"integer","example":99,"default":0},"scheme_type":{"type":"string","example":"unit"}}},"subscription":{"type":"object","properties":{"id":{"type":"string","example":"sub_o0Jw4WYCMuPNqzGr"},"code":{"type":"string","example":"09NFPLBZY0"},"start_at":{"type":"string","example":"2017-04-04T00:00:00Z"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"postpaid"},"next_billing_at":{"type":"string","example":"2017-05-04T00:00:00Z"},"payment_method":{"type":"string","example":"credit_card"},"currency":{"type":"string","example":"BRL"},"statement_descriptor":{"type":"string","example":"Spotify"},"installments":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-04T18:21:17"},"updated_at":{"type":"string","example":"2017-04-04T18:21:17"}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Item not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Item not found."}}}}}}},"deprecated":false},"delete":{"summary":"Remover item","description":"Com o verbo _HTTP DELETE_, através dos identificadores do item (`subscription_item_id`) e da assinatura (`subscription_id`) associada é possível remover um item da assinatura.","operationId":"remover-item","parameters":[{"name":"subscription_id","in":"path","description":"Código da assinatura.
Formato: `sub_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true},{"name":"item_id","in":"path","description":"Código do item da assinatura.
Formato: `si_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"si_mARl1OvTYcA3pG49\",\n \"description\": \"Telefone\",\n \"cycles\": 3,\n \"quantity\": 1,\n \"name\":\"Nome - teste\",\n \"status\": \"deleted\",\n \"created_at\": \"2017-04-04T18:56:44Z\",\n \"updated_at\": \"2017-04-04T18:57:48Z\",\n \"deleted_at\": \"2017-04-04T19:00:44Z\",\n \"pricing_scheme\": {\n \"price\": 99,\n \"scheme_type\": \"unit\"\n },\n \"subscription\": {\n \"id\": \"sub_o0Jw4WYCMuPNqzGr\",\n \"code\": \"09NFPLBZY0\",\n \"start_at\": \"2017-04-04T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"postpaid\",\n \"next_billing_at\": \"2017-05-04T00:00:00Z\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"statement_descriptor\": \"Spotify\",\n \"installments\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-04-04T18:21:17Z\",\n \"updated_at\": \"2017-04-04T18:21:17Z\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"si_mARl1OvTYcA3pG49"},"description":{"type":"string","example":"Telefone"},"cycles":{"type":"integer","example":3,"default":0},"quantity":{"type":"integer","example":1,"default":0},"name":{"type":"string","example":"Nome - teste"},"status":{"type":"string","example":"deleted"},"created_at":{"type":"string","example":"2017-04-04T18:56:44Z"},"updated_at":{"type":"string","example":"2017-04-04T18:57:48Z"},"deleted_at":{"type":"string","example":"2017-04-04T19:00:44Z"},"pricing_scheme":{"type":"object","properties":{"price":{"type":"integer","example":99,"default":0},"scheme_type":{"type":"string","example":"unit"}}},"subscription":{"type":"object","properties":{"id":{"type":"string","example":"sub_o0Jw4WYCMuPNqzGr"},"code":{"type":"string","example":"09NFPLBZY0"},"start_at":{"type":"string","example":"2017-04-04T00:00:00Z"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"postpaid"},"next_billing_at":{"type":"string","example":"2017-05-04T00:00:00Z"},"payment_method":{"type":"string","example":"credit_card"},"currency":{"type":"string","example":"BRL"},"statement_descriptor":{"type":"string","example":"Spotify"},"installments":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-04T18:21:17Z"},"updated_at":{"type":"string","example":"2017-04-04T18:21:17Z"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/subscriptions/{subscription_id}/items/{item_id}/usages":{"post":{"summary":"Incluir uso","description":"Este recurso permite incluir um `usage` de um `items` associado a uma `subscription`.","operationId":"incluir-uso","parameters":[{"name":"subscription_id","in":"path","description":"Código da assinatura.
Formato: `sub_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true},{"name":"item_id","in":"path","description":"Código do item da assinatura.
Formato: `si_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"quantity":{"type":"integer","description":"Quantidade de usos a serem incluídos.","default":1,"format":"int32"},"description":{"type":"string","description":"Descrição do uso."},"code":{"type":"string","description":"Código de identificação no sistema do cliente"},"group":{"type":"string","description":"Código de identificação do grupo no sistema do cliente"}}},"examples":{"Request Example":{"value":{"quantity":50}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"usage_QV1gBLhalU35RNbx\",\n \"quantity\": 1,\n \"status\": \"active\",\n \"used_at\": \"2017-04-04T18:21:50Z\",\n \"created_at\": \"2017-04-04T18:21:50Z\",\n \"subscription_item\": {\n \"id\": \"si_EJ8lP61Cotbyz9jx\",\n \"description\": \"Bola\",\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-04-04T18:21:18Z\",\n \"updated_at\": \"2017-04-04T18:21:18Z\",\n \"subscription\": {\n \"id\": \"sub_o0Jw4WYCMuPNqzGr\",\n \"code\": \"09NFPLBZY0\",\n \"start_at\": \"2017-04-04T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"postpaid\",\n \"next_billing_at\": \"2017-05-04T00:00:00Z\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"statement_descriptor\": \"Spotify\",\n \"installments\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-04-04T18:21:17Z\",\n \"updated_at\": \"2017-04-04T18:21:17Z\"\n }\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"usage_QV1gBLhalU35RNbx"},"quantity":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"used_at":{"type":"string","example":"2017-04-04T18:21:50Z"},"created_at":{"type":"string","example":"2017-04-04T18:21:50Z"},"subscription_item":{"type":"object","properties":{"id":{"type":"string","example":"si_EJ8lP61Cotbyz9jx"},"description":{"type":"string","example":"Bola"},"quantity":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-04T18:21:18Z"},"updated_at":{"type":"string","example":"2017-04-04T18:21:18Z"},"subscription":{"type":"object","properties":{"id":{"type":"string","example":"sub_o0Jw4WYCMuPNqzGr"},"code":{"type":"string","example":"09NFPLBZY0"},"start_at":{"type":"string","example":"2017-04-04T00:00:00Z"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"postpaid"},"next_billing_at":{"type":"string","example":"2017-05-04T00:00:00Z"},"payment_method":{"type":"string","example":"credit_card"},"currency":{"type":"string","example":"BRL"},"statement_descriptor":{"type":"string","example":"Spotify"},"installments":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-04T18:21:17Z"},"updated_at":{"type":"string","example":"2017-04-04T18:21:17Z"}}}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Item not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Item not found."}}}}}}},"deprecated":false},"get":{"summary":"Listar uso","description":"Este recurso permite listar os usos de um item de assinatura.","operationId":"listar-uso","parameters":[{"name":"subscription_id","in":"path","description":"Código da assinatura.
Formato: `sub_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true},{"name":"item_id","in":"path","description":"Código do item da assinatura.
Formato: `si_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Código de identificação no sistema do cliente"},"group":{"type":"string","description":"Código de identificação do grupo no sistema do cliente"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"data\": [\n {\n \"id\": \"usage_QV1gBLhalU35RNbx\",\n \"quantity\": 1,\n \"status\": \"deleted\",\n \"used_at\": \"2017-04-04T18:21:50Z\",\n \"created_at\": \"2017-04-04T18:21:50Z\",\n \"deleted_at\": \"2017-04-04T18:25:08Z\"\n },\n {\n \"id\": \"usage_73ybm1nCMfRVYdxA\",\n \"quantity\": 1,\n \"description\": \"Bola\",\n \"status\": \"active\",\n \"used_at\": \"2017-04-04T00:00:00Z\",\n \"created_at\": \"2017-04-04T18:21:18Z\"\n }\n ],\n \"paging\": {\n \"total\": 2\n }\n}"}},"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"usage_QV1gBLhalU35RNbx"},"quantity":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"deleted"},"used_at":{"type":"string","example":"2017-04-04T18:21:50Z"},"created_at":{"type":"string","example":"2017-04-04T18:21:50Z"},"deleted_at":{"type":"string","example":"2017-04-04T18:25:08Z"}}}},"paging":{"type":"object","properties":{"total":{"type":"integer","example":2,"default":0}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"item not found":{"value":"{\n \"message\": \"Item not found.\"\n}"},"subsciption not found":{"value":"{\n \"message\": \"Subscription not found.\"\n}"}},"schema":{"oneOf":[{"title":"item not found","type":"object","properties":{"message":{"type":"string","example":"Item not found."}}},{"title":"subsciption not found","type":"object","properties":{"message":{"type":"string","example":"Subscription not found."}}}]}}}}},"deprecated":false}},"/subscriptions/{subscription_id}/items/{item_id}/usages/{usage_id}":{"delete":{"summary":"Remover uso","description":"Com o verbo HTTP DELETE, através dos identificadores do uso (`usage_id`), do item (`subscription_item_id`) a da assinatura associada (`subscription_id`), é possível excluir o uso do item de uma assinatura.","operationId":"remover-uso","parameters":[{"name":"subscription_id","in":"path","description":"Código da assinatura.
Formato: `sub_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true},{"name":"item_id","in":"path","description":"Código do item da assinatura.
Formato: `si_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true},{"name":"usage_id","in":"path","description":"Código do uso.
Formato: `usage_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"usage_QV1gBLhalU35RNbx\",\n \"quantity\": 1,\n \"status\": \"deleted\",\n \"used_at\": \"2017-04-04T18:21:50Z\",\n \"created_at\": \"2017-04-04T18:21:50Z\",\n \"deleted_at\": \"2017-04-04T18:24:57Z\",\n \"subscription_item\": {\n \"id\": \"si_EJ8lP61Cotbyz9jx\",\n \"description\": \"Bola\",\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-04-04T18:21:18Z\",\n \"updated_at\": \"2017-04-04T18:21:18Z\",\n \"subscription\": {\n \"id\": \"sub_o0Jw4WYCMuPNqzGr\",\n \"code\": \"09NFPLBZY0\",\n \"start_at\": \"2017-04-04T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"postpaid\",\n \"next_billing_at\": \"2017-05-04T00:00:00Z\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"statement_descriptor\": \"Spotify\",\n \"installments\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-04-04T18:21:17Z\",\n \"updated_at\": \"2017-04-04T18:21:17Z\"\n }\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"usage_QV1gBLhalU35RNbx"},"quantity":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"deleted"},"used_at":{"type":"string","example":"2017-04-04T18:21:50Z"},"created_at":{"type":"string","example":"2017-04-04T18:21:50Z"},"deleted_at":{"type":"string","example":"2017-04-04T18:24:57Z"},"subscription_item":{"type":"object","properties":{"id":{"type":"string","example":"si_EJ8lP61Cotbyz9jx"},"description":{"type":"string","example":"Bola"},"quantity":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-04T18:21:18Z"},"updated_at":{"type":"string","example":"2017-04-04T18:21:18Z"},"subscription":{"type":"object","properties":{"id":{"type":"string","example":"sub_o0Jw4WYCMuPNqzGr"},"code":{"type":"string","example":"09NFPLBZY0"},"start_at":{"type":"string","example":"2017-04-04T00:00:00Z"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"postpaid"},"next_billing_at":{"type":"string","example":"2017-05-04T00:00:00Z"},"payment_method":{"type":"string","example":"credit_card"},"currency":{"type":"string","example":"BRL"},"statement_descriptor":{"type":"string","example":"Spotify"},"installments":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-04T18:21:17Z"},"updated_at":{"type":"string","example":"2017-04-04T18:21:17Z"}}}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Usage not found.\"\n}"}},"schema":{"oneOf":[{"type":"object","properties":{"message":{"type":"string","example":"Item not found."}}},{"type":"object","properties":{"message":{"type":"string","example":"Subscription not found."}}},{"type":"object","properties":{"message":{"type":"string","example":"Usage not found."}}}]}}}}},"deprecated":false}},"/plans/{plan_id}/items":{"post":{"summary":"Incluir item","description":"Através do identificador do plano (`plan_id`) é possível incluir itens ao plano associado.","operationId":"incluir-item-2","parameters":[{"name":"plan_id","in":"path","description":"Código do plano.
Formato: `plan_XXXXXXXXXXXXXXXX`","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","pricing_scheme"],"properties":{"name":{"type":"string","description":"Nome do item.
Max.: 64 caracteres."},"description":{"type":"string","description":"Descrição do item.
Max.: 256 caracteres."},"quantity":{"type":"integer","description":"Quantidade de itens.
**Obrigatório**, caso o pricing_scheme.type for igual a **unit**.","format":"int32"},"cycles":{"type":"integer","description":"Número de ciclos durante o qual o item será cobrado. Ex: Um item com `cycles` = 1 representa que um item será cobrado apenas uma vez.
Caso não seja informado, o item será cobrado até que seja desativado.","format":"int32"},"pricing_scheme":{"type":"object","description":"Esquema de precificação.
[Saiba mais sobre precificação](https://docs.pagar.me/reference/precifica%C3%A7%C3%A3o).","required":["scheme_type"],"properties":{"scheme_type":{"type":"string","description":"Esquema de precificação do item. Valores possíveis: **unit**, **package**, **volume** e **tier**. Valor default: unit","default":"Unit"},"price":{"type":"integer","description":"Valor do item. Este atributo está disponível para o scheme_type : **Unit**","format":"int32"},"mininum_price":{"type":"integer","description":"Valor mínimo a ser cobrado.","format":"int32"},"price_brackets":{"type":"array","description":"Intervalo de preços. Este atributo está disponível para os scheme_type : **package**, **volume** e **tier**.","items":{"properties":{"start_quantity":{"type":"integer","description":"Valor que define a quantidade inicial de unidades do intervalo.","format":"int32"},"end_quantity":{"type":"integer","description":"Valor que define a quantidade final de unidades do intervalo.","format":"int32"},"overage_price":{"type":"integer","description":"Valor para cálculo do preço por unidade que exceder o intervalo.","format":"int32"},"price":{"type":"integer","description":"Valor para cálculo do preço dentro do intervalo. OBS: o preço a ser cobrado do cliente será calculado de acordo com a quantidade e o scheme_type","format":"int32"}},"type":"object"}}}}}},"examples":{"Request Example":{"value":{"name":"Avaliação física","cycles":1,"quantity":1,"pricing_scheme":{"price":9990,"scheme_type":"unit"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"pi_eBTaVnXD8Zhb8glr\",\n \"name\": \"Avaliação física\",\n \"cycles\": 1,\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\",\n \"pricing_scheme\": {\n \"price\": 9990,\n \"scheme_type\": \"unit\"\n },\n \"plan\": {\n \"id\": \"plan_21r4CTG0ux77Qv13\",\n \"name\": \"Plano Gold\",\n \"url\": \"/plan_21r4CTG0ux77Qv13/academia/plano-gold\",\n \"currency\": \"BRL\",\n \"interval\": \"month\",\n \"interval_count\": 3,\n \"billing_type\": \"prepaid\",\n \"installments\": 3,\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T17:25:40Z\",\n \"updated_at\": \"2016-07-12T17:25:40Z\",\n \"metadata\": {\n \"id\": \"my_plan_id\"\n }\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"pi_eBTaVnXD8Zhb8glr"},"name":{"type":"string","example":"Avaliação física"},"cycles":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2016-07-12T18:25:40Z"},"updated_at":{"type":"string","example":"2016-07-12T18:25:40Z"},"pricing_scheme":{"type":"object","properties":{"price":{"type":"integer","example":9990,"default":0},"scheme_type":{"type":"string","example":"unit"}}},"plan":{"type":"object","properties":{"id":{"type":"string","example":"plan_21r4CTG0ux77Qv13"},"name":{"type":"string","example":"Plano Gold"},"url":{"type":"string","example":"/plan_21r4CTG0ux77Qv13/academia/plano-gold"},"currency":{"type":"string","example":"BRL"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":3,"default":0},"billing_type":{"type":"string","example":"prepaid"},"installments":{"type":"integer","example":3,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2016-07-12T17:25:40Z"},"updated_at":{"type":"string","example":"2016-07-12T17:25:40Z"},"metadata":{"type":"object","properties":{"id":{"type":"string","example":"my_plan_id"}}}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Plan not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Plan not found."}}}}}},"412":{"description":"412","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"The request is invalid.\",\n \"errors\": {\n \"item.name\": [\n \"The name field is required.\"\n ]\n },\n \"request\": {\n \"quantity\": 1,\n \"cycles\": 1,\n \"pricing_scheme\": {\n \"price\": 99,\n \"scheme_type\": \"unit\"\n }\n }\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"The request is invalid."},"errors":{"type":"object","properties":{"item.name":{"type":"array","items":{"type":"string","example":"The name field is required."}}}},"request":{"type":"object","properties":{"quantity":{"type":"integer","example":1,"default":0},"cycles":{"type":"integer","example":1,"default":0},"pricing_scheme":{"type":"object","properties":{"price":{"type":"integer","example":99,"default":0},"scheme_type":{"type":"string","example":"unit"}}}}}}}}}}},"deprecated":false}},"/plans/{plan_id}/items/{item_id}":{"put":{"summary":"Editar item","description":"Com o verbo _HTTP PUT_, através dos identificadores do item (`plan_item_id`) e do plano (`plan_id`) associado é possível atualizar os dados do item do plano.","operationId":"editar-item-1","parameters":[{"name":"plan_id","in":"path","description":"Código do plano.
Formato: `plan_XXXXXXXXXXXXXXXX`","schema":{"type":"string"},"required":true},{"name":"item_id","in":"path","description":"Código do item do plano.
Formato: `pi_XXXXXXXXXXXXXXXX`","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","pricing_scheme","status"],"properties":{"name":{"type":"string","description":"Nome do item.
Max.: 64 caracteres."},"description":{"type":"string","description":"Descrição do item.
Max.: 256 caracteres."},"quantity":{"type":"integer","description":"Quantidade de itens.
**Obrigatório**, caso o pricing_scheme.type for igual a **unit**.","format":"int32"},"cycles":{"type":"integer","description":"Número de ciclos durante o qual o item será cobrado. Ex: Um item com `cycles` = 1 representa que um item será cobrado apenas uma vez.
Caso não seja informado, o item será cobrado até que seja desativado.","format":"int32"},"pricing_scheme":{"type":"object","description":"Esquema de precificação.
[Saiba mais sobre precificação](https://docs.pagar.me/reference/precifica%C3%A7%C3%A3o).","required":["scheme_type"],"properties":{"scheme_type":{"type":"string","description":"Esquema de precificação do item. Valores possíveis: **unit**, **package**, **volume** e **tier**. Valor default: unit","default":"Unit"},"price":{"type":"integer","description":"Valor do item. Este atributo está disponível para o scheme_type : **Unit**","format":"int32"},"mininum_price":{"type":"integer","description":"Valor mínimo a ser cobrado.","format":"int32"},"price_brackets":{"type":"array","description":"Intervalo de preços. Este atributo está disponível para os scheme_type : **package**, **volume** e **tier**.","items":{"properties":{"start_quantity":{"type":"integer","description":"Valor que define a quantidade inicial de unidades do intervalo.","format":"int32"},"end_quantity":{"type":"integer","description":"Valor que define a quantidade final de unidades do intervalo.","format":"int32"},"overage_price":{"type":"integer","description":"Valor para cálculo do preço por unidade que exceder o intervalo.","format":"int32"},"price":{"type":"integer","description":"Valor para cálculo do preço dentro do intervalo. OBS: o preço a ser cobrado do cliente será calculado de acordo com a quantidade e o scheme_type","format":"int32"}},"type":"object"}}}},"status":{"type":"string","description":"Valores possíveis: **active** ou **inactive**"}}},"examples":{"Request Example":{"value":{"name":"Avaliação física","description":"Avaliação + Exame médico","quantity":1,"cycles":1,"pricing_scheme":{"price":9990,"scheme_type":"unit"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"pi_eBTaVnXD8Zhb8glr\",\n \"name\": \"Avaliação física\",\n \"description\": \"Avaliação + Exame médico\",\n \"cycles\": 1,\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\",\n \"pricing_scheme\": {\n \"price\": 9990,\n \"scheme_type\": \"unit\"\n },\n \"plan\": {\n \"id\": \"plan_21r4CTG0ux77Qv13\",\n \"name\": \"Plano Gold\",\n \"url\": \"/plan_21r4CTG0ux77Qv13/academia/plano-gold\",\n \"currency\": \"BRL\",\n \"interval\": \"month\",\n \"interval_count\": 3,\n \"billing_type\": \"prepaid\",\n \"installments\": 3,\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T17:25:40Z\",\n \"updated_at\": \"2016-07-12T17:25:40Z\",\n \"metadata\": {\n \"id\": \"my_plan_id\"\n }\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"pi_eBTaVnXD8Zhb8glr"},"name":{"type":"string","example":"Avaliação física"},"description":{"type":"string","example":"Avaliação + Exame médico"},"cycles":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2016-07-12T18:25:40Z"},"updated_at":{"type":"string","example":"2016-07-12T18:25:40Z"},"pricing_scheme":{"type":"object","properties":{"price":{"type":"integer","example":9990,"default":0},"scheme_type":{"type":"string","example":"unit"}}},"plan":{"type":"object","properties":{"id":{"type":"string","example":"plan_21r4CTG0ux77Qv13"},"name":{"type":"string","example":"Plano Gold"},"url":{"type":"string","example":"/plan_21r4CTG0ux77Qv13/academia/plano-gold"},"currency":{"type":"string","example":"BRL"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":3,"default":0},"billing_type":{"type":"string","example":"prepaid"},"installments":{"type":"integer","example":3,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2016-07-12T17:25:40Z"},"updated_at":{"type":"string","example":"2016-07-12T17:25:40Z"},"metadata":{"type":"object","properties":{"id":{"type":"string","example":"my_plan_id"}}}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Item not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Item not found."}}}}}}},"deprecated":false},"delete":{"summary":"Remover item","description":"Com o verbo _HTTP DELETE_, através dos identificadores do item (`plan_item_id`) e do plano (`plan_id`) associado é possível remover um item do plano.","operationId":"remover-item-1","parameters":[{"name":"plan_id","in":"path","description":"Código do plano.
Formato: `plan_XXXXXXXXXXXXXXXX`","schema":{"type":"string"},"required":true},{"name":"item_id","in":"path","description":"Código do item do plano.
Formato: `pi_XXXXXXXXXXXXXXXX`","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"pi_eBTaVnXD8Zhb8glr\",\n \"name\": \"Avaliação física\",\n \"description\": \"Avaliação + Exame médico\",\n \"cycles\": 1,\n \"status\": \"deleted\",\n \"created_at\": \"2016-07-12T18:25:40Z\",\n \"updated_at\": \"2016-07-12T18:25:40Z\",\n \"deleted_at\": \"2016-07-15T13:41:02Z\",\n \"pricing_scheme\": {\n \"price\": 9990,\n \"scheme_type\": \"unit\"\n },\n \"plan\": {\n \"id\": \"plan_21r4CTG0ux77Qv13\",\n \"name\": \"Plano Gold\",\n \"url\": \"/plan_21r4CTG0ux77Qv13/academia/plano-gold\",\n \"currency\": \"BRL\",\n \"interval\": \"month\",\n \"interval_count\": 3,\n \"billing_type\": \"prepaid\",\n \"installments\": 3,\n \"status\": \"active\",\n \"created_at\": \"2016-07-12T17:25:40Z\",\n \"updated_at\": \"2016-07-12T17:25:40Z\",\n \"metadata\": {\n \"id\": \"my_plan_id\"\n }\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"pi_eBTaVnXD8Zhb8glr"},"name":{"type":"string","example":"Avaliação física"},"description":{"type":"string","example":"Avaliação + Exame médico"},"cycles":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"deleted"},"created_at":{"type":"string","example":"2016-07-12T18:25:40Z"},"updated_at":{"type":"string","example":"2016-07-12T18:25:40Z"},"deleted_at":{"type":"string","example":"2016-07-15T13:41:02Z"},"pricing_scheme":{"type":"object","properties":{"price":{"type":"integer","example":9990,"default":0},"scheme_type":{"type":"string","example":"unit"}}},"plan":{"type":"object","properties":{"id":{"type":"string","example":"plan_21r4CTG0ux77Qv13"},"name":{"type":"string","example":"Plano Gold"},"url":{"type":"string","example":"/plan_21r4CTG0ux77Qv13/academia/plano-gold"},"currency":{"type":"string","example":"BRL"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":3,"default":0},"billing_type":{"type":"string","example":"prepaid"},"installments":{"type":"integer","example":3,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2016-07-12T17:25:40Z"},"updated_at":{"type":"string","example":"2016-07-12T17:25:40Z"},"metadata":{"type":"object","properties":{"id":{"type":"string","example":"my_plan_id"}}}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Item not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Item not found."}}}}}}},"deprecated":false}},"/subscriptions/{subscription_id}/discounts":{"post":{"summary":"Incluir desconto","description":"Este recurso permite adicionar um desconto, através do identificador da assinatura (`subscription_id`).","operationId":"incluir-desconto-1","parameters":[{"name":"subscription_id","in":"path","description":"Código da assinatura.
Formato `sub_XXXXXXXXXXXXXXXX`","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["value","discount_type"],"properties":{"value":{"type":"string","description":"Valor do desconto."},"discount_type":{"type":"string","description":"Tipo do desconto.
Valores possíveis: **flat** ou **percentage**. O padrão é **percentage**"},"cycles":{"type":"string","description":"Indica quantas vezes o desconto será aplicado.
Caso não seja informado, o desconto será aplicado até que o item seja excluído"},"item_id":{"type":"string","description":"Código do item da assinatura.
Formato: `si_XXXXXXXXXXXXXXXX`
Caso seja informado, o desconto será aplicado no item. Max: 36 caracteres"}}},"examples":{"Request Example":{"value":{"value":10,"discount_type":"percentage","cycles":"1","item_id":"si_GyL1lmGU6tOXYr2O"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"dis_LP4j5dXztPSj5A02\",\n \"value\": 10,\n \"discount_type\": \"percentage\",\n \"cycles\": 1,\n \"status\": \"active\",\n \"created_at\": \"2019-05-22T14:23:55Z\",\n \"updated_at\": \"2019-05-22T14:23:55Z\",\n \"subscription\": {\n \"id\": \"sub_DvPanXLsqcQnk8e1\",\n \"code\": \"5Z7ZU01F60\",\n \"start_at\": \"2019-05-22T00:00:00Z\",\n \"interval\": \"day\",\n \"interval_count\": 1,\n \"billing_type\": \"prepaid\",\n \"next_billing_at\": \"2019-05-25T00:00:00Z\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"installments\": 1,\n \"minimum_price\": 10,\n \"status\": \"active\",\n \"boleto_due_days\": 5,\n \"created_at\": \"2019-05-22T14:05:49Z\",\n \"updated_at\": \"2019-05-22T14:21:51Z\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"dis_LP4j5dXztPSj5A02"},"value":{"type":"integer","example":10,"default":0},"discount_type":{"type":"string","example":"percentage"},"cycles":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2019-05-22T14:23:55Z"},"updated_at":{"type":"string","example":"2019-05-22T14:23:55Z"},"subscription":{"type":"object","properties":{"id":{"type":"string","example":"sub_DvPanXLsqcQnk8e1"},"code":{"type":"string","example":"5Z7ZU01F60"},"start_at":{"type":"string","example":"2019-05-22T00:00:00Z"},"interval":{"type":"string","example":"day"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"prepaid"},"next_billing_at":{"type":"string","example":"2019-05-25T00:00:00Z"},"payment_method":{"type":"string","example":"credit_card"},"currency":{"type":"string","example":"BRL"},"installments":{"type":"integer","example":1,"default":0},"minimum_price":{"type":"integer","example":10,"default":0},"status":{"type":"string","example":"active"},"boleto_due_days":{"type":"integer","example":5,"default":0},"created_at":{"type":"string","example":"2019-05-22T14:05:49Z"},"updated_at":{"type":"string","example":"2019-05-22T14:21:51Z"}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Subscription not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Subscription not found."}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"The request is invalid.\",\n \"errors\": {\n \"discount.discount_type\": [\n \"The discount_type field is invalid. Possible values are 'flat' or 'percentage'.\"\n ]\n },\n \"request\": {\n \"discount_type\": \"null\",\n \"value\": 10\n }\n}"}},"schema":{"oneOf":[{"type":"object","properties":{"message":{"type":"string","example":"The request is invalid."},"errors":{"type":"object","properties":{"discount.value":{"type":"array","items":{"type":"string","example":"The value field should be greater than the zero."}}}},"request":{"type":"object","properties":{"discount_type":{"type":"string","example":"percentage"}}}}},{"type":"object","properties":{"message":{"type":"string","example":"The request is invalid."},"errors":{"type":"object","properties":{"discount.discount_type":{"type":"array","items":{"type":"string","example":"The discount_type field is invalid. Possible values are 'flat' or 'percentage'."}}}},"request":{"type":"object","properties":{"discount_type":{"type":"string","example":"null"},"value":{"type":"integer","example":10,"default":0}}}}}]}}}}},"deprecated":false},"get":{"summary":"Listar descontos","description":"Este recurso permite listar os descontos associados a uma assinatura.","operationId":"listar-descontos-2","parameters":[{"name":"subscription_id","in":"path","description":"Código da assinatura.
Formato `sub_XXXXXXXXXXXXXXXX`","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"data\": [\n {\n \"id\": \"dis_IYzpxgjsOs0fDIoP\",\n \"value\": 20,\n \"discount_type\": \"percentage\",\n \"status\": \"active\",\n \"created_at\": \"2018-03-15T19:49:29Z\",\n \"subscription\": {\n \"id\": \"sub_Yo2VQVyeSWHKmN5k\",\n \"code\": \"Z8OXUJI3M5\",\n \"start_at\": \"2018-03-15T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"prepaid\",\n \"next_billing_at\": \"2018-04-15T00:00:00Z\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"installments\": 1,\n \"status\": \"active\",\n \"created_at\": \"2018-03-15T19:49:05Z\",\n \"updated_at\": \"2018-03-15T19:49:05Z\"\n }\n },\n {\n \"id\": \"dis_kyzpJFssOs0fIoUx\",\n \"value\": 10,\n \"discount_type\": \"percentage\",\n \"status\": \"active\",\n \"created_at\": \"2018-03-15T19:49:25Z\",\n \"subscription\": {\n \"id\": \"sub_Yo2VQVyeSWHKmN5k\",\n \"code\": \"Z8OXUJI3M5\",\n \"start_at\": \"2018-03-15T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"prepaid\",\n \"next_billing_at\": \"2018-04-15T00:00:00Z\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"installments\": 1,\n \"status\": \"active\",\n \"created_at\": \"2018-03-15T19:49:05Z\",\n \"updated_at\": \"2018-03-15T19:49:05Z\"\n }\n }\n ],\n \"paging\": {\n \"total\": 2\n }\n}"}},"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"dis_IYzpxgjsOs0fDIoP"},"value":{"type":"integer","example":20,"default":0},"discount_type":{"type":"string","example":"percentage"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2018-03-15T19:49:29Z"},"subscription":{"type":"object","properties":{"id":{"type":"string","example":"sub_Yo2VQVyeSWHKmN5k"},"code":{"type":"string","example":"Z8OXUJI3M5"},"start_at":{"type":"string","example":"2018-03-15T00:00:00Z"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"prepaid"},"next_billing_at":{"type":"string","example":"2018-04-15T00:00:00Z"},"payment_method":{"type":"string","example":"credit_card"},"currency":{"type":"string","example":"BRL"},"installments":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2018-03-15T19:49:05Z"},"updated_at":{"type":"string","example":"2018-03-15T19:49:05Z"}}}}}},"paging":{"type":"object","properties":{"total":{"type":"integer","example":2,"default":0}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Subscription not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Subscription not found."}}}}}}},"deprecated":false}},"/subscriptions/{subscription_id}/discounts/{discount_id}":{"get":{"summary":"Obter desconto","description":"Através dos identificadores da assinatura (`subscription_id`) e do desconto associado (`discount_id`) é possível recuperar as informações do desconto.","operationId":"obter-desconto-1","parameters":[{"name":"subscription_id","in":"path","description":"Código da assinatura.
Formato `sub_XXXXXXXXXXXXXXXX`","schema":{"type":"string"},"required":true},{"name":"discount_id","in":"path","description":"Código do desconto.
Formato: `dis_XXXXXXXXXXXXXXXX`","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"dis_brMgW6KCdmf2dEQ7\",\n \"value\": 10,\n \"discount_type\": \"percentage\",\n \"status\": \"active\",\n \"created_at\": \"2017-04-04T18:36:43Z\",\n \"subscription\": {\n \"id\": \"sub_o0Jw4WYCMuPNqzGr\",\n \"code\": \"09NFPLBZY0\",\n \"start_at\": \"2017-04-04T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"postpaid\",\n \"next_billing_at\": \"2017-05-04T00:00:00Z\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"statement_descriptor\": \"Spotify\",\n \"installments\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-04-04T18:21:17Z\",\n \"updated_at\": \"2017-04-04T18:21:17Z\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"dis_brMgW6KCdmf2dEQ7"},"value":{"type":"integer","example":10,"default":0},"discount_type":{"type":"string","example":"percentage"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-04T18:36:43Z"},"subscription":{"type":"object","properties":{"id":{"type":"string","example":"sub_o0Jw4WYCMuPNqzGr"},"code":{"type":"string","example":"09NFPLBZY0"},"start_at":{"type":"string","example":"2017-04-04T00:00:00Z"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"postpaid"},"next_billing_at":{"type":"string","example":"2017-05-04T00:00:00Z"},"payment_method":{"type":"string","example":"credit_card"},"currency":{"type":"string","example":"BRL"},"statement_descriptor":{"type":"string","example":"Spotify"},"installments":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-04T18:21:17Z"},"updated_at":{"type":"string","example":"2017-04-04T18:21:17Z"}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Discount not found.\"\n}"}},"schema":{"oneOf":[{"type":"object","properties":{"message":{"type":"string","example":"Subscription not found."}}},{"type":"object","properties":{"message":{"type":"string","example":"Discount not found."}}}]}}}}},"deprecated":false},"delete":{"summary":"Remover desconto","description":"Com o verbo _HTTP DELETE_, através dos identificadores do desconto (`discount_id`) e da assinatura associada (`subscription_id`) é possível remover um desconto do plano.","operationId":"remover-desconto-1","parameters":[{"name":"subscription_id","in":"path","description":"Código da assinatura.
Formato `sub_XXXXXXXXXXXXXXXX`","schema":{"type":"string"},"required":true},{"name":"discount_id","in":"path","description":"Código do desconto.
Formato: `dis_XXXXXXXXXXXXXXXX`","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"dis_kqGj1JMCaGSRm9Yz\",\n \"value\": 10,\n \"discount_type\": \"percentage\",\n \"status\": \"deleted\",\n \"created_at\": \"2017-04-04T18:40:15Z\",\n \"deleted_at\": \"2017-04-04T18:40:48Z\",\n \"subscription\": {\n \"id\": \"sub_o0Jw4WYCMuPNqzGr\",\n \"code\": \"09NFPLBZY0\",\n \"start_at\": \"2017-04-04T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"postpaid\",\n \"next_billing_at\": \"2017-05-04T00:00:00Z\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"statement_descriptor\": \"Spotify\",\n \"installments\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-04-04T18:21:17Z\",\n \"updated_at\": \"2017-04-04T18:21:17Z\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"dis_kqGj1JMCaGSRm9Yz"},"value":{"type":"integer","example":10,"default":0},"discount_type":{"type":"string","example":"percentage"},"status":{"type":"string","example":"deleted"},"created_at":{"type":"string","example":"2017-04-04T18:40:15Z"},"deleted_at":{"type":"string","example":"2017-04-04T18:40:48Z"},"subscription":{"type":"object","properties":{"id":{"type":"string","example":"sub_o0Jw4WYCMuPNqzGr"},"code":{"type":"string","example":"09NFPLBZY0"},"start_at":{"type":"string","example":"2017-04-04T00:00:00Z"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"postpaid"},"next_billing_at":{"type":"string","example":"2017-05-04T00:00:00Z"},"payment_method":{"type":"string","example":"credit_card"},"currency":{"type":"string","example":"BRL"},"statement_descriptor":{"type":"string","example":"Spotify"},"installments":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-04T18:21:17Z"},"updated_at":{"type":"string","example":"2017-04-04T18:21:17Z"}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Discount not found.\"\n}"}},"schema":{"oneOf":[{"type":"object","properties":{"message":{"type":"string","example":"Subscription not found."}}},{"type":"object","properties":{"message":{"type":"string","example":"Discount not found."}}}]}}}}},"deprecated":false}},"/subscriptions/{subscription_id}/increments":{"post":{"summary":"Incluir incremento","description":"Este recurso permite adicionar um incremento, através do identificador da assinatura (`subscription_id`).","operationId":"incluir-incremento-1","parameters":[{"name":"subscription_id","in":"path","description":"Código da assinatura.
Formato `sub_XXXXXXXXXXXXXXXX`","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["value","increment_type"],"properties":{"value":{"type":"string","description":"Valor do incremento."},"increment_type":{"type":"string","description":"Tipo do incremento.
Valores possíveis: **flat** ou **percentage**. O padrão é **percentage**"},"cycles":{"type":"integer","description":"Indica quantas vezes o incremento será aplicado.
Caso não seja informada, o incremento será aplicado até que o item seja excluído","format":"int32"},"item_id":{"type":"string","description":"Código do item da assinatura.
Formato: `si_XXXXXXXXXXXXXXXX`
Caso seja informado, o incremento será aplicado no item. Max: 36 caracteres"}}},"examples":{"Request Example":{"value":{"value":20,"increment_type":"percentage"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"inc_IYzpxgjsOs0fDIoP\",\n \"value\": 20,\n \"increment_type\": \"percentage\",\n \"status\": \"active\",\n \"created_at\": \"2017-04-04T18:36:43Z\",\n \"subscription\": {\n \"id\": \"sub_o0Jw4WYCMuPNqzGr\",\n \"code\": \"09NFPLBZY0\",\n \"start_at\": \"2017-04-04T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"postpaid\",\n \"next_billing_at\": \"2017-05-04T00:00:00Z\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"statement_descriptor\": \"Spotify\",\n \"installments\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-04-04T18:21:17Z\",\n \"updated_at\": \"2017-04-04T18:21:17Z\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"inc_IYzpxgjsOs0fDIoP"},"value":{"type":"integer","example":20,"default":0},"increment_type":{"type":"string","example":"percentage"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-04T18:36:43Z"},"subscription":{"type":"object","properties":{"id":{"type":"string","example":"sub_o0Jw4WYCMuPNqzGr"},"code":{"type":"string","example":"09NFPLBZY0"},"start_at":{"type":"string","example":"2017-04-04T00:00:00Z"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"postpaid"},"next_billing_at":{"type":"string","example":"2017-05-04T00:00:00Z"},"payment_method":{"type":"string","example":"credit_card"},"currency":{"type":"string","example":"BRL"},"statement_descriptor":{"type":"string","example":"Spotify"},"installments":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-04T18:21:17Z"},"updated_at":{"type":"string","example":"2017-04-04T18:21:17Z"}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Subscription not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Subscription not found."}}}}}},"422":{"description":"422","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"The request is invalid.\",\n \"errors\": {\n \"increment.increment_type\": [\n \"The increment_type field is invalid. Possible values are 'flat' or 'percentage'.\"\n ]\n },\n \"request\": {\n \"increment_type\": \"null\",\n \"value\": 10\n }\n}"}},"schema":{"oneOf":[{"type":"object","properties":{"message":{"type":"string","example":"The request is invalid."},"errors":{"type":"object","properties":{"increment.value":{"type":"array","items":{"type":"string","example":"The value field should be greater than the zero."}}}},"request":{"type":"object","properties":{"increment_type":{"type":"string","example":"percentage"}}}}},{"type":"object","properties":{"message":{"type":"string","example":"The request is invalid."},"errors":{"type":"object","properties":{"increment.increment_type":{"type":"array","items":{"type":"string","example":"The increment_type field is invalid. Possible values are 'flat' or 'percentage'."}}}},"request":{"type":"object","properties":{"increment_type":{"type":"string","example":"null"},"value":{"type":"integer","example":10,"default":0}}}}}]}}}}},"deprecated":false},"get":{"summary":"Listar incrementos","description":"Este recurso permite listar os incrementos associados a uma assinatura.","operationId":"listar-incrementos","parameters":[{"name":"subscription_id","in":"path","description":"Código da assinatura.
Formato `sub_XXXXXXXXXXXXXXXX`","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"data\": [\n {\n \"id\": \"inc_IYzpxgjsOs0fDIoP\",\n \"value\": 20,\n \"increment_type\": \"percentage\",\n \"status\": \"active\",\n \"created_at\": \"2018-03-15T19:49:29Z\",\n \"subscription\": {\n \"id\": \"sub_Yo2VQVyeSWHKmN5k\",\n \"code\": \"Z8OXUJI3M5\",\n \"start_at\": \"2018-03-15T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"prepaid\",\n \"next_billing_at\": \"2018-04-15T00:00:00Z\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"installments\": 1,\n \"status\": \"active\",\n \"created_at\": \"2018-03-15T19:49:05Z\",\n \"updated_at\": \"2018-03-15T19:49:05Z\"\n }\n },\n {\n \"id\": \"inc_kyzpJFssOs0fIoUx\",\n \"value\": 10,\n \"increment_type\": \"percentage\",\n \"status\": \"active\",\n \"created_at\": \"2018-03-15T19:49:25Z\",\n \"subscription\": {\n \"id\": \"sub_Yo2VQVyeSWHKmN5k\",\n \"code\": \"Z8OXUJI3M5\",\n \"start_at\": \"2018-03-15T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"prepaid\",\n \"next_billing_at\": \"2018-04-15T00:00:00Z\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"installments\": 1,\n \"status\": \"active\",\n \"created_at\": \"2018-03-15T19:49:05Z\",\n \"updated_at\": \"2018-03-15T19:49:05Z\"\n }\n }\n ],\n \"paging\": {\n \"total\": 2\n }\n}"}},"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"inc_IYzpxgjsOs0fDIoP"},"value":{"type":"integer","example":20,"default":0},"increment_type":{"type":"string","example":"percentage"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2018-03-15T19:49:29Z"},"subscription":{"type":"object","properties":{"id":{"type":"string","example":"sub_Yo2VQVyeSWHKmN5k"},"code":{"type":"string","example":"Z8OXUJI3M5"},"start_at":{"type":"string","example":"2018-03-15T00:00:00Z"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"prepaid"},"next_billing_at":{"type":"string","example":"2018-04-15T00:00:00Z"},"payment_method":{"type":"string","example":"credit_card"},"currency":{"type":"string","example":"BRL"},"installments":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2018-03-15T19:49:05Z"},"updated_at":{"type":"string","example":"2018-03-15T19:49:05Z"}}}}}},"paging":{"type":"object","properties":{"total":{"type":"integer","example":2,"default":0}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Subscription not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Subscription not found."}}}}}}},"deprecated":false}},"/subscriptions/{subscription_id}/increments/{increment_id}":{"get":{"summary":"Obter incremento","description":"Através dos identificadores da assinatura (`subscription_id`) e do incremento associado (`incremento_id`) é possível recuperar as informações do incremento.","operationId":"obter-incremento-1","parameters":[{"name":"subscription_id","in":"path","description":"Código da assinatura.
Formato `sub_XXXXXXXXXXXXXXXX`","schema":{"type":"string"},"required":true},{"name":"increment_id","in":"path","description":"Código do incremento.
Formato: `dis_XXXXXXXXXXXXXXXX`","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"inc_IYzpxgjsOs0fDIoP\",\n \"value\": 10,\n \"increment_type\": \"percentage\",\n \"status\": \"active\",\n \"created_at\": \"2017-04-04T18:36:43Z\",\n \"subscription\": {\n \"id\": \"sub_o0Jw4WYCMuPNqzGr\",\n \"code\": \"09NFPLBZY0\",\n \"start_at\": \"2017-04-04T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"postpaid\",\n \"next_billing_at\": \"2017-05-04T00:00:00Z\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"statement_descriptor\": \"Spotify\",\n \"installments\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-04-04T18:21:17Z\",\n \"updated_at\": \"2017-04-04T18:21:17Z\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"inc_IYzpxgjsOs0fDIoP"},"value":{"type":"integer","example":10,"default":0},"increment_type":{"type":"string","example":"percentage"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-04T18:36:43Z"},"subscription":{"type":"object","properties":{"id":{"type":"string","example":"sub_o0Jw4WYCMuPNqzGr"},"code":{"type":"string","example":"09NFPLBZY0"},"start_at":{"type":"string","example":"2017-04-04T00:00:00Z"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"postpaid"},"next_billing_at":{"type":"string","example":"2017-05-04T00:00:00Z"},"payment_method":{"type":"string","example":"credit_card"},"currency":{"type":"string","example":"BRL"},"statement_descriptor":{"type":"string","example":"Spotify"},"installments":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-04T18:21:17Z"},"updated_at":{"type":"string","example":"2017-04-04T18:21:17Z"}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Increment not found.\"\n}"}},"schema":{"oneOf":[{"type":"object","properties":{"message":{"type":"string","example":"Subscription not found."}}},{"type":"object","properties":{"message":{"type":"string","example":"Increment not found."}}}]}}}}},"deprecated":false},"delete":{"summary":"Remover incremento","description":"Com o verbo _HTTP DELETE_, através dos identificadores do incremento (`increment_id`) e da assinatura associada (`subscription_id`) é possível remover um incremento do plano.","operationId":"remover-incremento-1","parameters":[{"name":"subscription_id","in":"path","description":"Código da assinatura.
Formato `sub_XXXXXXXXXXXXXXXX`","schema":{"type":"string"},"required":true},{"name":"increment_id","in":"path","description":"Código do incremento.
Formato: `dis_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"inc_IYzpxgjsOs0fDIoP\",\n \"value\": 20,\n \"increment_type\": \"percentage\",\n \"status\": \"deleted\",\n \"created_at\": \"2017-04-04T18:40:15Z\",\n \"deleted_at\": \"2017-04-04T18:40:48Z\",\n \"subscription\": {\n \"id\": \"sub_o0Jw4WYCMuPNqzGr\",\n \"code\": \"09NFPLBZY0\",\n \"start_at\": \"2017-04-04T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"postpaid\",\n \"next_billing_at\": \"2017-05-04T00:00:00Z\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"statement_descriptor\": \"Spotify\",\n \"installments\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-04-04T18:21:17Z\",\n \"updated_at\": \"2017-04-04T18:21:17Z\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"inc_IYzpxgjsOs0fDIoP"},"value":{"type":"integer","example":20,"default":0},"increment_type":{"type":"string","example":"percentage"},"status":{"type":"string","example":"deleted"},"created_at":{"type":"string","example":"2017-04-04T18:40:15Z"},"deleted_at":{"type":"string","example":"2017-04-04T18:40:48Z"},"subscription":{"type":"object","properties":{"id":{"type":"string","example":"sub_o0Jw4WYCMuPNqzGr"},"code":{"type":"string","example":"09NFPLBZY0"},"start_at":{"type":"string","example":"2017-04-04T00:00:00Z"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"postpaid"},"next_billing_at":{"type":"string","example":"2017-05-04T00:00:00Z"},"payment_method":{"type":"string","example":"credit_card"},"currency":{"type":"string","example":"BRL"},"statement_descriptor":{"type":"string","example":"Spotify"},"installments":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-04T18:21:17Z"},"updated_at":{"type":"string","example":"2017-04-04T18:21:17Z"}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Increment not found.\"\n}"}},"schema":{"oneOf":[{"type":"object","properties":{"message":{"type":"string","example":"Subscription not found."}}},{"type":"object","properties":{"message":{"type":"string","example":"Increment not found."}}}]}}}}},"deprecated":false}},"/subscriptions/{subscription_id}/cycles/{cycle_id}/pay":{"post":{"summary":"Criar fatura","description":"Este recurso cria uma fatura (`invoice`) de acordo com o identificador do ciclo a ser cobrado (`cycle_id`) de um determinada assinatura (`subscription_id`).","operationId":"criar-fatura-1","parameters":[{"name":"subscription_id","in":"path","description":"Código da assinatura.
Formato: `sub_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true},{"name":"cycle_id","in":"path","description":"Código do ciclo.
Formato: `cycle_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"metadata":{"type":"string","description":"Objeto chave/valor utilizado para armazenar informações adicionais sobre a fatura. [Saiba mais sobre metadata](https://docs.pagar.me/reference/metadata-1)"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"in_6d2BVXnaUdT8DOkL\",\n \"code\": \"59QDSPB5NP\",\n \"url\": \"/invoices/in_6d2BVXnaUdT8DOkL\",\n \"amount\": 1490,\n \"status\": \"paid\",\n \"payment_method\": \"credit_card\",\n \"due_at\": \"2017-04-04T00:00:00Z\",\n \"created_at\": \"2017-04-04T15:10:35Z\",\n \"items\": [\n {\n \"name\": \"Nome - teste\",\n \"amount\": 1490,\n \"quantity\": 1,\n \"description\": \"Bola\"\n }\n ],\n \"customer\": {\n \"id\": \"cus_J4wRXJ0U6ytZrpAx\",\n \"name\": \"Tony Star8k\",\n \"email\": \"tstark@avengers.com\",\n \"delinquent\": false,\n \"created_at\": \"2016-09-28T21:04:37Z\",\n \"updated_at\": \"2017-04-04T15:08:20Z\"\n },\n \"subscription\": {\n \"id\": \"sub_KrmEXBxHVIRAJxDG\",\n \"code\": \"KERZFJ6TQZ\",\n \"start_at\": \"2017-04-04T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"postpaid\",\n \"next_billing_at\": \"2017-05-04T00:00:00Z\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"statement_descriptor\": \"Spotify\",\n \"installments\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-04-04T15:10:01Z\",\n \"updated_at\": \"2017-04-04T15:10:01Z\"\n },\n \"cycle\": {\n \"id\": \"cycle_WE1ZYoX7uEfbRar4\",\n \"start_at\": \"2017-04-04T00:00:00Z\",\n \"end_at\": \"2017-05-03T23:59:59\",\n \"billing_at\": \"2017-05-04T00:00:00Z\"\n },\n \"charge\": {\n \"id\": \"ch_x75JLo9SRFnEo6jY\",\n \"code\": \"KERZFJ6TQZ-01\",\n \"gateway_id\": \"477bcafc-194b-4aa9-bb18-6fc621e49c22\",\n \"amount\": 1490,\n \"status\": \"paid\",\n \"currency\": \"BRL\",\n \"payment_method\": \"credit_card\",\n \"due_at\": \"2017-04-04T00:00:00Z\",\n \"paid_at\": \"2017-04-04T15:10:46Z\",\n \"created_at\": \"2017-04-04T15:10:35Z\",\n \"updated_at\": \"2017-04-04T15:10:35Z\",\n \"last_transaction\": {\n \"id\": \"tran_mnVqmLOfJGhzWKzW\",\n \"transaction_type\": \"credit_card\",\n \"funding_source\": \"prepaid\",\n \"gateway_id\": \"da859279-6251-4721-9909-4d8a1142f098\",\n \"amount\": 1490,\n \"status\": \"captured\",\n \"success\": true,\n \"installments\": 1,\n \"statement_descriptor\": \"Spotify\",\n \"acquirer_name\": \"simulator\",\n \"acquirer_affiliation_code\": \"12345\",\n \"acquirer_tid\": \"704735\",\n \"acquirer_nsu\": \"999048\",\n \"acquirer_auth_code\": \"468669\",\n \"acquirer_message\": \"Simulator|Transação de simulação autorizada com sucesso\",\n \"acquirer_return_code\": \"0\",\n \"operation_type\": \"auth_and_capture\",\n \"credit_card\": {\n \"id\": \"card_pEYq7rDbFeiW8V6k\",\n \"first_six_digits\": \"542501\",\n \"last_four_digits\": \"8229\",\n \"brand\": \"Amex\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 2018,\n \"status\": \"active\",\n \"created_at\": \"2016-11-16T17:02:39Z\",\n \"updated_at\": \"2016-12-29T12:03:24Z\",\n \"billing_address\": {\n \"line_1\": \"10880, Malibu Point, Malibu Central\",\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\"\n }\n },\n \"created_at\": \"2017-04-04T15:10:35Z\",\n \"updated_at\": \"2017-04-04T15:10:35Z\"\n }\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"in_6d2BVXnaUdT8DOkL"},"code":{"type":"string","example":"59QDSPB5NP"},"url":{"type":"string","example":"/invoices/in_6d2BVXnaUdT8DOkL"},"amount":{"type":"integer","example":1490,"default":0},"status":{"type":"string","example":"paid"},"payment_method":{"type":"string","example":"credit_card"},"due_at":{"type":"string","example":"2017-04-04T00:00:00Z"},"created_at":{"type":"string","example":"2017-04-04T15:10:35Z"},"items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Nome - teste"},"amount":{"type":"integer","example":1490,"default":0},"quantity":{"type":"integer","example":1,"default":0},"description":{"type":"string","example":"Bola"}}}},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_J4wRXJ0U6ytZrpAx"},"name":{"type":"string","example":"Tony Star8k"},"email":{"type":"string","example":"tstark@avengers.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2016-09-28T21:04:37Z"},"updated_at":{"type":"string","example":"2017-04-04T15:08:20Z"}}},"subscription":{"type":"object","properties":{"id":{"type":"string","example":"sub_KrmEXBxHVIRAJxDG"},"code":{"type":"string","example":"KERZFJ6TQZ"},"start_at":{"type":"string","example":"2017-04-04T00:00:00Z"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"postpaid"},"next_billing_at":{"type":"string","example":"2017-05-04T00:00:00Z"},"payment_method":{"type":"string","example":"credit_card"},"currency":{"type":"string","example":"BRL"},"statement_descriptor":{"type":"string","example":"Spotify"},"installments":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-04T15:10:01Z"},"updated_at":{"type":"string","example":"2017-04-04T15:10:01Z"}}},"cycle":{"type":"object","properties":{"id":{"type":"string","example":"cycle_WE1ZYoX7uEfbRar4"},"start_at":{"type":"string","example":"2017-04-04T00:00:00Z"},"end_at":{"type":"string","example":"2017-05-03T23:59:59"},"billing_at":{"type":"string","example":"2017-05-04T00:00:00Z"}}},"charge":{"type":"object","properties":{"id":{"type":"string","example":"ch_x75JLo9SRFnEo6jY"},"code":{"type":"string","example":"KERZFJ6TQZ-01"},"gateway_id":{"type":"string","example":"477bcafc-194b-4aa9-bb18-6fc621e49c22"},"amount":{"type":"integer","example":1490,"default":0},"status":{"type":"string","example":"paid"},"currency":{"type":"string","example":"BRL"},"payment_method":{"type":"string","example":"credit_card"},"due_at":{"type":"string","example":"2017-04-04T00:00:00Z"},"paid_at":{"type":"string","example":"2017-04-04T15:10:46Z"},"created_at":{"type":"string","example":"2017-04-04T15:10:35Z"},"updated_at":{"type":"string","example":"2017-04-04T15:10:35Z"},"last_transaction":{"type":"object","properties":{"id":{"type":"string","example":"tran_mnVqmLOfJGhzWKzW"},"transaction_type":{"type":"string","example":"credit_card"},"funding_source":{"type":"string","example":"prepaid"},"gateway_id":{"type":"string","example":"da859279-6251-4721-9909-4d8a1142f098"},"amount":{"type":"integer","example":1490,"default":0},"status":{"type":"string","example":"captured"},"success":{"type":"boolean","example":true,"default":true},"installments":{"type":"integer","example":1,"default":0},"statement_descriptor":{"type":"string","example":"Spotify"},"acquirer_name":{"type":"string","example":"simulator"},"acquirer_affiliation_code":{"type":"string","example":"12345"},"acquirer_tid":{"type":"string","example":"704735"},"acquirer_nsu":{"type":"string","example":"999048"},"acquirer_auth_code":{"type":"string","example":"468669"},"acquirer_message":{"type":"string","example":"Simulator|Transação de simulação autorizada com sucesso"},"acquirer_return_code":{"type":"string","example":"0"},"operation_type":{"type":"string","example":"auth_and_capture"},"credit_card":{"type":"object","properties":{"id":{"type":"string","example":"card_pEYq7rDbFeiW8V6k"},"first_six_digits":{"type":"string","example":"542501"},"last_four_digits":{"type":"string","example":"8229"},"brand":{"type":"string","example":"Amex"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":2018,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2016-11-16T17:02:39Z"},"updated_at":{"type":"string","example":"2016-12-29T12:03:24Z"},"billing_address":{"type":"object","properties":{"line_1":{"type":"string","example":"10880, Malibu Point, Malibu Central"},"zip_code":{"type":"string","example":"90265"},"city":{"type":"string","example":"Malibu"},"state":{"type":"string","example":"CA"},"country":{"type":"string","example":"US"}}}}},"created_at":{"type":"string","example":"2017-04-04T15:10:35Z"},"updated_at":{"type":"string","example":"2017-04-04T15:10:35Z"}}}}}}}}}},"412":{"description":"412","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"This cycle has been billed.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"This cycle has been billed."}}}}}}},"deprecated":false}},"/invoices/{invoice_id}":{"get":{"summary":"Obter fatura","description":"Através do identificador da fatura (`invoice_id`) é possível recuperar as informação da fatura.","operationId":"obter-fatura-1","parameters":[{"name":"invoice_id","in":"path","description":"Código da fatura.
Formato: `in_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"in_qBY5VvpuEACaw5bg\",\n \"code\": \"O5D5FRSQ9O\",\n \"url\": \"/invoices/in_qBY5VvpuEACaw5bg\",\n \"amount\": 1490,\n \"total_discounts\" :1000,\n \"total_increments\" :1000,\n \"status\": \"paid\",\n \"payment_method\": \"credit_card\",\n \"due_at\": \"2017-04-19T00:00:00Z\",\n \"created_at\": \"2017-04-19T17:35:15Z\",\n \"items\": [\n {\n \"name\": \"Nome - teste\",\n \"amount\": 1490,\n \"quantity\": 1,\n \"description\": \"Premium\"\n }\n ],\n \"customer\": {\n \"id\": \"cus_mnG9AbHZmSYQRWM7\",\n \"name\": \"Tony Stark\",\n \"email\": \"38acb30a-99d9-4b12-a0aa-7305c7dd81f2@avengers.com\",\n \"delinquent\": false,\n \"created_at\": \"2017-04-19T17:35:05Z\",\n \"updated_at\": \"2017-04-19T17:35:05Z\"\n },\n \"subscription\": {\n \"id\": \"sub_OGE4Q1Miy1fd4B3z\",\n \"code\": \"R7P3FNU489\",\n \"start_at\": \"2017-04-19T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"postpaid\",\n \"next_billing_at\": \"2017-05-19T00:00:00Z\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"statement_descriptor\": \"Spotify\",\n \"installments\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-04-19T17:35:06Z\",\n \"updated_at\": \"2017-04-19T17:35:06Z\"\n },\n \"cycle\": {\n \"id\": \"cycle_5JB1vZBZimCXvaRp\",\n \"start_at\": \"2017-04-19T00:00:00Z\",\n \"end_at\": \"2017-05-18T23:59:59Z\",\n \"billing_at\": \"2017-05-19T00:00:00Z\"\n },\n \"charge\": {\n \"id\": \"ch_OGWebzPtDCOQex2r\",\n \"code\": \"R7P3FNU489-01\",\n \"gateway_id\": \"729154b2-1a94-45e0-bce8-1f6966725ee5\",\n \"amount\": 1490,\n \"status\": \"paid\",\n \"currency\": \"BRL\",\n \"payment_method\": \"credit_card\",\n \"due_at\": \"2017-04-19T00:00:00Z\",\n \"paid_at\": \"2017-04-19T17:35:16Z\",\n \"created_at\": \"2017-04-19T17:35:15Z\",\n \"updated_at\": \"2017-04-19T17:35:15Z\",\n \"last_transaction\": {\n \"id\": \"tran_EBlMxnTRmfrg0joK\",\n \"transaction_type\": \"credit_card\",\n \"funding_source\": \"prepaid\",\n \"gateway_id\": \"02bf6173-0e19-4060-836e-626c81f02749\",\n \"amount\": 1490,\n \"status\": \"captured\",\n \"success\": true,\n \"installments\": 1,\n \"statement_descriptor\": \"Spotify\",\n \"acquirer_name\": \"simulator\",\n \"acquirer_affiliation_code\": \"12345\",\n \"acquirer_tid\": \"12869\",\n \"acquirer_nsu\": \"680036\",\n \"acquirer_auth_code\": \"637781\",\n \"acquirer_message\": \"Simulator|Transação de simulação autorizada com sucesso\",\n \"acquirer_return_code\": \"0\",\n \"operation_type\": \"auth_and_capture\",\n \"card\": {\n \"id\": \"card_x8PBA3TppSDWjrgd\",\n \"first_six_digits\": \"542501\",\n \"last_four_digits\": \"8229\",\n \"brand\": \"Amex\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 2018,\n \"status\": \"active\",\n \"created_at\": \"2017-04-19T17:35:05Z\",\n \"updated_at\": \"2017-04-19T17:35:05Z\",\n \"billing_address\": {\n \"line_1\": \"10880, Malibu Point, Malibu Central\",\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\"\n },\n \"type\": \"credit\"\n },\n \"created_at\": \"2017-04-19T17:35:15Z\",\n \"updated_at\": \"2017-04-19T17:35:15Z\",\n \"gateway_response\": {\n \"code\": \"201\"\n }\n }\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"in_qBY5VvpuEACaw5bg"},"code":{"type":"string","example":"O5D5FRSQ9O"},"url":{"type":"string","example":"/invoices/in_qBY5VvpuEACaw5bg"},"amount":{"type":"integer","example":1490,"default":0},"total_discounts":{"type":"integer","example":1000,"default":0},"total_increments":{"type":"integer","example":1000,"default":0},"status":{"type":"string","example":"paid"},"payment_method":{"type":"string","example":"credit_card"},"due_at":{"type":"string","example":"2017-04-19T00:00:00Z"},"created_at":{"type":"string","example":"2017-04-19T17:35:15Z"},"items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Nome - teste"},"amount":{"type":"integer","example":1490,"default":0},"quantity":{"type":"integer","example":1,"default":0},"description":{"type":"string","example":"Premium"}}}},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_mnG9AbHZmSYQRWM7"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"38acb30a-99d9-4b12-a0aa-7305c7dd81f2@avengers.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2017-04-19T17:35:05Z"},"updated_at":{"type":"string","example":"2017-04-19T17:35:05Z"}}},"subscription":{"type":"object","properties":{"id":{"type":"string","example":"sub_OGE4Q1Miy1fd4B3z"},"code":{"type":"string","example":"R7P3FNU489"},"start_at":{"type":"string","example":"2017-04-19T00:00:00Z"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"postpaid"},"next_billing_at":{"type":"string","example":"2017-05-19T00:00:00Z"},"payment_method":{"type":"string","example":"credit_card"},"currency":{"type":"string","example":"BRL"},"statement_descriptor":{"type":"string","example":"Spotify"},"installments":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-19T17:35:06Z"},"updated_at":{"type":"string","example":"2017-04-19T17:35:06Z"}}},"cycle":{"type":"object","properties":{"id":{"type":"string","example":"cycle_5JB1vZBZimCXvaRp"},"start_at":{"type":"string","example":"2017-04-19T00:00:00Z"},"end_at":{"type":"string","example":"2017-05-18T23:59:59Z"},"billing_at":{"type":"string","example":"2017-05-19T00:00:00Z"}}},"charge":{"type":"object","properties":{"id":{"type":"string","example":"ch_OGWebzPtDCOQex2r"},"code":{"type":"string","example":"R7P3FNU489-01"},"gateway_id":{"type":"string","example":"729154b2-1a94-45e0-bce8-1f6966725ee5"},"amount":{"type":"integer","example":1490,"default":0},"status":{"type":"string","example":"paid"},"currency":{"type":"string","example":"BRL"},"payment_method":{"type":"string","example":"credit_card"},"due_at":{"type":"string","example":"2017-04-19T00:00:00Z"},"paid_at":{"type":"string","example":"2017-04-19T17:35:16Z"},"created_at":{"type":"string","example":"2017-04-19T17:35:15Z"},"updated_at":{"type":"string","example":"2017-04-19T17:35:15Z"},"last_transaction":{"type":"object","properties":{"id":{"type":"string","example":"tran_EBlMxnTRmfrg0joK"},"transaction_type":{"type":"string","example":"credit_card"},"funding_source":{"type":"string","example":"prepaid"},"gateway_id":{"type":"string","example":"02bf6173-0e19-4060-836e-626c81f02749"},"amount":{"type":"integer","example":1490,"default":0},"status":{"type":"string","example":"captured"},"success":{"type":"boolean","example":true,"default":true},"installments":{"type":"integer","example":1,"default":0},"statement_descriptor":{"type":"string","example":"Spotify"},"acquirer_name":{"type":"string","example":"simulator"},"acquirer_affiliation_code":{"type":"string","example":"12345"},"acquirer_tid":{"type":"string","example":"12869"},"acquirer_nsu":{"type":"string","example":"680036"},"acquirer_auth_code":{"type":"string","example":"637781"},"acquirer_message":{"type":"string","example":"Simulator|Transação de simulação autorizada com sucesso"},"acquirer_return_code":{"type":"string","example":"0"},"operation_type":{"type":"string","example":"auth_and_capture"},"card":{"type":"object","properties":{"id":{"type":"string","example":"card_x8PBA3TppSDWjrgd"},"first_six_digits":{"type":"string","example":"542501"},"last_four_digits":{"type":"string","example":"8229"},"brand":{"type":"string","example":"Amex"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":2018,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-19T17:35:05Z"},"updated_at":{"type":"string","example":"2017-04-19T17:35:05Z"},"billing_address":{"type":"object","properties":{"line_1":{"type":"string","example":"10880, Malibu Point, Malibu Central"},"zip_code":{"type":"string","example":"90265"},"city":{"type":"string","example":"Malibu"},"state":{"type":"string","example":"CA"},"country":{"type":"string","example":"US"}}},"type":{"type":"string","example":"credit"}}},"created_at":{"type":"string","example":"2017-04-19T17:35:15Z"},"updated_at":{"type":"string","example":"2017-04-19T17:35:15Z"},"gateway_response":{"type":"object","properties":{"code":{"type":"string","example":"201"}}}}}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Invoice not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Invoice not found."}}}}}}},"deprecated":false},"delete":{"summary":"Cancelar fatura","description":"Com o verbo _HTTP DELETE_, através do identificador da fatura (`invoice_id`), este recurso possibilita realizar o cancelamento da fatura.","operationId":"cancelar-fatura-1","parameters":[{"name":"invoice_id","in":"path","description":"Código da fatura.
Formato: `in_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"in_n87qwY1FA2SzwXDb\",\n \"code\": \"P47FWGIEZP\",\n \"url\": \"/invoices/in_n87qwY1FA2SzwXDb\",\n \"amount\": 1490,\n \"status\": \"canceled\",\n \"payment_method\": \"credit_card\",\n \"due_at\": \"2017-04-04T00:00:00Z\",\n \"canceled_at\": \"2017-04-04T15:48:48Z\",\n \"created_at\": \"2017-04-04T15:40:28Z\",\n \"items\": [\n {\n \"name\": \"Nome - teste\",\n \"amount\": 1490,\n \"quantity\": 1,\n \"description\": \"Bola\"\n }\n ],\n \"customer\": {\n \"id\": \"cus_J4wRXJ0U6ytZrpAx\",\n \"name\": \"Tony Star8k\",\n \"email\": \"tstark@avengers.com\",\n \"delinquent\": false,\n \"created_at\": \"2016-09-28T21:04:37Z\",\n \"updated_at\": \"2017-04-04T15:08:20Z\"\n },\n \"subscription\": {\n \"id\": \"sub_KrmEXBxHVIRAJxDG\",\n \"code\": \"KERZFJ6TQZ\",\n \"start_at\": \"2017-04-04T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"postpaid\",\n \"next_billing_at\": \"2017-05-04T00:00:00Z\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"statement_descriptor\": \"Spotify\",\n \"installments\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-04-04T15:10:01Z\",\n \"updated_at\": \"2017-04-04T15:10:01Z\"\n },\n \"cycle\": {\n \"id\": \"cycle_WE1ZYoX7uEfbRar4\",\n \"start_at\": \"2017-04-04T00:00:00Z\",\n \"end_at\": \"2017-05-03T23:59:59Z\",\n \"billing_at\": \"2017-05-04T00:00:00Z\"\n },\n \"charge\": {\n \"id\": \"ch_NnLXBY2sXxs0Z3Oy\",\n \"code\": \"KERZFJ6TQZ-01\",\n \"gateway_id\": \"453b685d-33aa-4fd9-a926-afd78dce2832\",\n \"status\": \"canceled\",\n \"currency\": \"BRL\",\n \"payment_method\": \"credit_card\",\n \"funding_source\": \"prepaid\",\n \"due_at\": \"2017-04-04T00:00:00Z\",\n \"paid_at\": \"2017-04-04T15:40:30Z\",\n \"canceled_at\": \"2017-04-04T15:48:48Z\",\n \"created_at\": \"2017-04-04T15:40:28Z\",\n \"updated_at\": \"2017-04-04T15:48:48Z\",\n \"last_transaction\": {\n \"id\": \"tran_jJ0n4JJsbKu88mL1\",\n \"transaction_type\": \"credit_card\",\n \"gateway_id\": \"ab76139e-2c3b-40a0-89ed-98d451821c0c\",\n \"amount\": 1490,\n \"status\": \"voided\",\n \"success\": true,\n \"acquirer_name\": \"simulator\",\n \"acquirer_affiliation_code\": \"12345\",\n \"acquirer_tid\": \"532840\",\n \"acquirer_nsu\": \"805131\",\n \"acquirer_auth_code\": \"557586\",\n \"operation_type\": \"cancel\",\n \"credit_card\": {\n \"id\": \"card_pEYq7rDbFeiW8V6k\",\n \"first_six_digits\": \"542501\",\n \"last_four_digits\": \"8229\",\n \"brand\": \"Amex\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 2018,\n \"status\": \"active\",\n \"created_at\": \"2016-11-16T17:02:39Z\",\n \"updated_at\": \"2016-12-29T12:03:24Z\",\n \"billing_address\": {\n \"line_1\": \"10880, Malibu Point, Malibu Central\",\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\" \n }\n },\n \"created_at\": \"2017-04-04T15:48:48Z\",\n \"updated_at\": \"2017-04-04T15:48:48Z\"\n }\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"in_n87qwY1FA2SzwXDb"},"code":{"type":"string","example":"P47FWGIEZP"},"url":{"type":"string","example":"/invoices/in_n87qwY1FA2SzwXDb"},"amount":{"type":"integer","example":1490,"default":0},"status":{"type":"string","example":"canceled"},"payment_method":{"type":"string","example":"credit_card"},"due_at":{"type":"string","example":"2017-04-04T00:00:00Z"},"canceled_at":{"type":"string","example":"2017-04-04T15:48:48Z"},"created_at":{"type":"string","example":"2017-04-04T15:40:28Z"},"items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Nome - teste"},"amount":{"type":"integer","example":1490,"default":0},"quantity":{"type":"integer","example":1,"default":0},"description":{"type":"string","example":"Bola"}}}},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_J4wRXJ0U6ytZrpAx"},"name":{"type":"string","example":"Tony Star8k"},"email":{"type":"string","example":"tstark@avengers.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2016-09-28T21:04:37Z"},"updated_at":{"type":"string","example":"2017-04-04T15:08:20Z"}}},"subscription":{"type":"object","properties":{"id":{"type":"string","example":"sub_KrmEXBxHVIRAJxDG"},"code":{"type":"string","example":"KERZFJ6TQZ"},"start_at":{"type":"string","example":"2017-04-04T00:00:00Z"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"postpaid"},"next_billing_at":{"type":"string","example":"2017-05-04T00:00:00Z"},"payment_method":{"type":"string","example":"credit_card"},"currency":{"type":"string","example":"BRL"},"statement_descriptor":{"type":"string","example":"Spotify"},"installments":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-04T15:10:01Z"},"updated_at":{"type":"string","example":"2017-04-04T15:10:01Z"}}},"cycle":{"type":"object","properties":{"id":{"type":"string","example":"cycle_WE1ZYoX7uEfbRar4"},"start_at":{"type":"string","example":"2017-04-04T00:00:00Z"},"end_at":{"type":"string","example":"2017-05-03T23:59:59Z"},"billing_at":{"type":"string","example":"2017-05-04T00:00:00Z"}}},"charge":{"type":"object","properties":{"id":{"type":"string","example":"ch_NnLXBY2sXxs0Z3Oy"},"code":{"type":"string","example":"KERZFJ6TQZ-01"},"gateway_id":{"type":"string","example":"453b685d-33aa-4fd9-a926-afd78dce2832"},"status":{"type":"string","example":"canceled"},"currency":{"type":"string","example":"BRL"},"payment_method":{"type":"string","example":"credit_card"},"funding_source":{"type":"string","example":"prepaid"},"due_at":{"type":"string","example":"2017-04-04T00:00:00Z"},"paid_at":{"type":"string","example":"2017-04-04T15:40:30Z"},"canceled_at":{"type":"string","example":"2017-04-04T15:48:48Z"},"created_at":{"type":"string","example":"2017-04-04T15:40:28Z"},"updated_at":{"type":"string","example":"2017-04-04T15:48:48Z"},"last_transaction":{"type":"object","properties":{"id":{"type":"string","example":"tran_jJ0n4JJsbKu88mL1"},"transaction_type":{"type":"string","example":"credit_card"},"gateway_id":{"type":"string","example":"ab76139e-2c3b-40a0-89ed-98d451821c0c"},"amount":{"type":"integer","example":1490,"default":0},"status":{"type":"string","example":"voided"},"success":{"type":"boolean","example":true,"default":true},"acquirer_name":{"type":"string","example":"simulator"},"acquirer_affiliation_code":{"type":"string","example":"12345"},"acquirer_tid":{"type":"string","example":"532840"},"acquirer_nsu":{"type":"string","example":"805131"},"acquirer_auth_code":{"type":"string","example":"557586"},"operation_type":{"type":"string","example":"cancel"},"credit_card":{"type":"object","properties":{"id":{"type":"string","example":"card_pEYq7rDbFeiW8V6k"},"first_six_digits":{"type":"string","example":"542501"},"last_four_digits":{"type":"string","example":"8229"},"brand":{"type":"string","example":"Amex"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":2018,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2016-11-16T17:02:39Z"},"updated_at":{"type":"string","example":"2016-12-29T12:03:24Z"},"billing_address":{"type":"object","properties":{"line_1":{"type":"string","example":"10880, Malibu Point, Malibu Central"},"zip_code":{"type":"string","example":"90265"},"city":{"type":"string","example":"Malibu"},"state":{"type":"string","example":"CA"},"country":{"type":"string","example":"US"}}}}},"created_at":{"type":"string","example":"2017-04-04T15:48:48Z"},"updated_at":{"type":"string","example":"2017-04-04T15:48:48Z"}}}}}}}}}},"412":{"description":"412","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"This invoice cannot be canceled.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"This invoice cannot be canceled."}}}}}}},"deprecated":false}},"/invoices":{"get":{"summary":"Listar faturas","description":"Este recurso permite listar os descontos associados a uma assinatura. Pode ser utilizados alguns parâmetros como filtro da listagem.","operationId":"listar-faturas-1","parameters":[{"name":"status","in":"query","description":"Status das faturas. Valores possíveis: **pending**, **paid**, **canceled**, **scheduled** ou **failed**","schema":{"type":"string"}},{"name":"customer_id","in":"query","description":"Código do cliente.","schema":{"type":"string"}},{"name":"subscription_id","in":"query","description":"Código da fatura.","schema":{"type":"string"}},{"name":"due_since","in":"query","description":"Data de início do período de vencimento a ser listado.","schema":{"type":"string","format":"date"}},{"name":"due_until","in":"query","description":"Data final do período de vencimento a ser listado.","schema":{"type":"string","format":"date"}},{"name":"created_since","in":"query","description":"Data de início do período de criação a ser listado.","schema":{"type":"string","format":"date"}},{"name":"created_until","in":"query","description":"Data final do período de criação a ser listado.","schema":{"type":"string","format":"date"}},{"name":"page","in":"query","description":"Página atual.","schema":{"type":"integer","format":"int32","default":1}},{"name":"size","in":"query","description":"Quantidade de itens por página.","schema":{"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"data\": [\n {\n \"id\": \"in_DnQj6J8iWhEg0MrK\",\n \"code\": \"0E6RC91AE1\",\n \"url\": \"/invoices/in_DnQj6J8iWhEg0MrK\",\n \"amount\": 1490,\n \"status\": \"paid\",\n \"payment_method\": \"credit_card\",\n \"due_at\": \"2017-04-04T00:00:00Z\",\n \"created_at\": \"2017-04-04T15:54:46Z\",\n \"items\": [\n {\n \"name\":\"Nome - teste\",\n \"amount\": 1490,\n \"quantity\": 1,\n \"description\": \"Bola\"\n }\n ],\n \"customer\": {\n \"id\": \"cus_J4wRXJ0U6ytZrpAx\",\n \"name\": \"Tony Star8k\",\n \"email\": \"tstark@avengers.com\",\n \"delinquent\": false,\n \"created_at\": \"2016-09-28T21:04:37Z\",\n \"updated_at\": \"2017-04-04T15:08:20Z\"\n },\n \"subscription\": {\n \"id\": \"sub_49O5RwPh5sl0wyqM\",\n \"code\": \"G2X5F99FXX\",\n \"start_at\": \"2017-04-04T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"postpaid\",\n \"next_billing_at\": \"2017-05-04T00:00:00Z\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"statement_descriptor\": \"Spotify\",\n \"installments\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-04-04T15:54:19Z\",\n \"updated_at\": \"2017-04-04T15:54:19Z\"\n },\n \"cycle\": {\n \"id\": \"cycle_O6vXjrvUbecMjpgq\",\n \"start_at\": \"2017-04-04T00:00:00Z\",\n \"end_at\": \"2017-05-03T23:59:59Z\",\n \"billing_at\": \"2017-05-04T00:00:00Z\"\n },\n \"charge\": {\n \"id\": \"ch_1DaVYVQCds28rOm3\",\n \"code\": \"G2X5F99FXX-01\",\n \"gateway_id\": \"1e3a21f7-ad65-4ad0-a68c-3eb37e8115c9\",\n \"amount\": 1490,\n \"status\": \"paid\",\n \"currency\": \"BRL\",\n \"payment_method\": \"credit_card\",\n \"due_at\": \"2017-04-04T00:00:00Z\",\n \"paid_at\": \"2017-04-04T15:54:49Z\",\n \"created_at\": \"2017-04-04T15:54:46Z\",\n \"updated_at\": \"2017-04-04T15:54:46Z\"\n }\n }\n ],\n \"paging\": {\n \"total\": 1\n }\n}"}},"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"in_DnQj6J8iWhEg0MrK"},"code":{"type":"string","example":"0E6RC91AE1"},"url":{"type":"string","example":"/invoices/in_DnQj6J8iWhEg0MrK"},"amount":{"type":"integer","example":1490,"default":0},"status":{"type":"string","example":"paid"},"payment_method":{"type":"string","example":"credit_card"},"due_at":{"type":"string","example":"2017-04-04T00:00:00Z"},"created_at":{"type":"string","example":"2017-04-04T15:54:46Z"},"items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Nome - teste"},"amount":{"type":"integer","example":1490,"default":0},"quantity":{"type":"integer","example":1,"default":0},"description":{"type":"string","example":"Bola"}}}},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_J4wRXJ0U6ytZrpAx"},"name":{"type":"string","example":"Tony Star8k"},"email":{"type":"string","example":"tstark@avengers.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2016-09-28T21:04:37Z"},"updated_at":{"type":"string","example":"2017-04-04T15:08:20Z"}}},"subscription":{"type":"object","properties":{"id":{"type":"string","example":"sub_49O5RwPh5sl0wyqM"},"code":{"type":"string","example":"G2X5F99FXX"},"start_at":{"type":"string","example":"2017-04-04T00:00:00Z"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"postpaid"},"next_billing_at":{"type":"string","example":"2017-05-04T00:00:00Z"},"payment_method":{"type":"string","example":"credit_card"},"currency":{"type":"string","example":"BRL"},"statement_descriptor":{"type":"string","example":"Spotify"},"installments":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-04-04T15:54:19Z"},"updated_at":{"type":"string","example":"2017-04-04T15:54:19Z"}}},"cycle":{"type":"object","properties":{"id":{"type":"string","example":"cycle_O6vXjrvUbecMjpgq"},"start_at":{"type":"string","example":"2017-04-04T00:00:00Z"},"end_at":{"type":"string","example":"2017-05-03T23:59:59Z"},"billing_at":{"type":"string","example":"2017-05-04T00:00:00Z"}}},"charge":{"type":"object","properties":{"id":{"type":"string","example":"ch_1DaVYVQCds28rOm3"},"code":{"type":"string","example":"G2X5F99FXX-01"},"gateway_id":{"type":"string","example":"1e3a21f7-ad65-4ad0-a68c-3eb37e8115c9"},"amount":{"type":"integer","example":1490,"default":0},"status":{"type":"string","example":"paid"},"currency":{"type":"string","example":"BRL"},"payment_method":{"type":"string","example":"credit_card"},"due_at":{"type":"string","example":"2017-04-04T00:00:00Z"},"paid_at":{"type":"string","example":"2017-04-04T15:54:49Z"},"created_at":{"type":"string","example":"2017-04-04T15:54:46Z"},"updated_at":{"type":"string","example":"2017-04-04T15:54:46Z"}}}}}},"paging":{"type":"object","properties":{"total":{"type":"integer","example":1,"default":0}}}}}}}},"401":{"description":"401","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Authorization has been denied for this request.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Authorization has been denied for this request."}}}}}}},"deprecated":false}},"/invoices/{invoice_id}/metadata":{"patch":{"summary":"Editar metadados da fatura","description":"Com o verbo _HTTP PATCH_, através do identificador da fatura (`invoice_id`) é possível atualizar o objeto `metadata` da fatura.","operationId":"editar-metadados-da-fatura-1","parameters":[{"name":"invoice_id","in":"path","description":"Código da fatura.
Formato: `in_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["metadata"],"properties":{"metadata":{"type":"string","description":"Objeto chave/valor utilizado para armazenar informações adicionais sobre a fatura.
[Saiba mais sobre metadata](https://docs.pagar.me/reference/metadata-1)"}}},"examples":{"Request Example":{"value":{"metadata":{"code":"1234","company":"Avengers"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"in_l9JGwX1MsNS3g614\",\n \"code\": \"X8J8HG6HR3\",\n \"url\": \"/invoices/in_l9JGwX1MsNS3g614\",\n \"amount\": 1490,\n \"status\": \"paid\",\n \"payment_method\": \"credit_card\",\n \"due_at\": \"2017-08-10T00:00:00Z\",\n \"created_at\": \"2017-08-10T16:02:40Z\",\n \"items\": [\n {\n \"name\": \"Nome - teste\",\n \"amount\": 1490,\n \"quantity\": 1,\n \"description\": \"Premium\"\n }\n ],\n \"customer\": {\n \"id\": \"cus_2j4vnqJseriZOM0G\",\n \"name\": \"Tony Stark\",\n \"email\": \"ce7bd9d7-a959-4f64-8070-896c2d968c9a@avengers.com\",\n \"delinquent\": false,\n \"created_at\": \"2017-08-10T16:02:28Z\",\n \"updated_at\": \"2017-08-10T16:02:28Z\",\n \"phones\": {}\n },\n \"subscription\": {\n \"id\": \"sub_Rg80VjCmxt4N0Oma\",\n \"code\": \"R66DU1I4PR\",\n \"start_at\": \"2017-08-10T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"postpaid\",\n \"next_billing_at\": \"2017-09-10T00:00:00Z\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"statement_descriptor\": \"Spotify\",\n \"installments\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-08-10T16:02:30Z\",\n \"updated_at\": \"2017-08-10T16:02:30Z\"\n },\n \"cycle\": {\n \"id\": \"cycle_zObQAYfOqUnMQMkB\",\n \"start_at\": \"2017-08-10T00:00:00Z\",\n \"end_at\": \"2017-09-09T23:59:59Z\",\n \"billing_at\": \"2017-09-10T00:00:00Z\"\n },\n \"charge\": {\n \"id\": \"ch_Wl2YRDrSOFq1Ax4r\",\n \"code\": \"R66DU1I4PR-01\",\n \"gateway_id\": \"798d388b-3e92-4ad1-a0be-893a2391c7fa\",\n \"amount\": 1490,\n \"paid_amount\": 1490,\n \"status\": \"paid\",\n \"currency\": \"BRL\",\n \"payment_method\": \"credit_card\",\n \"due_at\": \"2017-08-10T00:00:00Z\",\n \"paid_at\": \"2017-08-10T16:02:41Z\",\n \"created_at\": \"2017-08-10T16:02:40Z\",\n \"updated_at\": \"2017-08-10T16:02:40Z\",\n \"last_transaction\": {\n \"id\": \"tran_x7lNYXuPLS1np4n1\",\n \"transaction_type\": \"credit_card\",\n \"funding_source\": \"prepaid\",\n \"gateway_id\": \"a4f98f29-c720-4682-985e-f18234160be1\",\n \"amount\": 1490,\n \"status\": \"captured\",\n \"success\": true,\n \"installments\": 1,\n \"statement_descriptor\": \"Spotify\",\n \"acquirer_name\": \"simulator\",\n \"acquirer_affiliation_code\": \"TesteMaroto\",\n \"acquirer_tid\": \"21407\",\n \"acquirer_nsu\": \"743230\",\n \"acquirer_auth_code\": \"214846\",\n \"acquirer_message\": \"Simulator|Transação de simulação autorizada com sucesso\",\n \"acquirer_return_code\": \"0\",\n \"operation_type\": \"auth_and_capture\",\n \"card\": {\n \"id\": \"card_brVjYG5uZSrNARPg\",\n \"first_six_digits\": \"342793\",\n \"last_four_digits\": \"8229\",\n \"brand\": \"Amex\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 2018,\n \"status\": \"active\",\n \"created_at\": \"2017-08-10T16:02:28Z\",\n \"updated_at\": \"2017-08-10T16:02:28Z\",\n \"billing_address\": {\n \"line_1\": \"10880, Malibu Point, Malibu Central\",\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\"\n },\n \"type\": \"credit\"\n },\n \"created_at\": \"2017-08-10T16:02:40Z\",\n \"updated_at\": \"2017-08-10T16:02:40Z\",\n \"gateway_response\": {\n \"code\": \"201\"\n }\n }\n },\n \"metadata\": {\n \"code\": \"1234\",\n \"company\": \"Avengers\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"in_l9JGwX1MsNS3g614"},"code":{"type":"string","example":"X8J8HG6HR3"},"url":{"type":"string","example":"/invoices/in_l9JGwX1MsNS3g614"},"amount":{"type":"integer","example":1490,"default":0},"status":{"type":"string","example":"paid"},"payment_method":{"type":"string","example":"credit_card"},"due_at":{"type":"string","example":"2017-08-10T00:00:00Z"},"created_at":{"type":"string","example":"2017-08-10T16:02:40Z"},"items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Nome - teste"},"amount":{"type":"integer","example":1490,"default":0},"quantity":{"type":"integer","example":1,"default":0},"description":{"type":"string","example":"Premium"}}}},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_2j4vnqJseriZOM0G"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"ce7bd9d7-a959-4f64-8070-896c2d968c9a@avengers.com"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2017-08-10T16:02:28Z"},"updated_at":{"type":"string","example":"2017-08-10T16:02:28Z"},"phones":{"type":"object","properties":{}}}},"subscription":{"type":"object","properties":{"id":{"type":"string","example":"sub_Rg80VjCmxt4N0Oma"},"code":{"type":"string","example":"R66DU1I4PR"},"start_at":{"type":"string","example":"2017-08-10T00:00:00Z"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"postpaid"},"next_billing_at":{"type":"string","example":"2017-09-10T00:00:00Z"},"payment_method":{"type":"string","example":"credit_card"},"currency":{"type":"string","example":"BRL"},"statement_descriptor":{"type":"string","example":"Spotify"},"installments":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-08-10T16:02:30Z"},"updated_at":{"type":"string","example":"2017-08-10T16:02:30Z"}}},"cycle":{"type":"object","properties":{"id":{"type":"string","example":"cycle_zObQAYfOqUnMQMkB"},"start_at":{"type":"string","example":"2017-08-10T00:00:00Z"},"end_at":{"type":"string","example":"2017-09-09T23:59:59Z"},"billing_at":{"type":"string","example":"2017-09-10T00:00:00Z"}}},"charge":{"type":"object","properties":{"id":{"type":"string","example":"ch_Wl2YRDrSOFq1Ax4r"},"code":{"type":"string","example":"R66DU1I4PR-01"},"gateway_id":{"type":"string","example":"798d388b-3e92-4ad1-a0be-893a2391c7fa"},"amount":{"type":"integer","example":1490,"default":0},"paid_amount":{"type":"integer","example":1490,"default":0},"status":{"type":"string","example":"paid"},"currency":{"type":"string","example":"BRL"},"payment_method":{"type":"string","example":"credit_card"},"due_at":{"type":"string","example":"2017-08-10T00:00:00Z"},"paid_at":{"type":"string","example":"2017-08-10T16:02:41Z"},"created_at":{"type":"string","example":"2017-08-10T16:02:40Z"},"updated_at":{"type":"string","example":"2017-08-10T16:02:40Z"},"last_transaction":{"type":"object","properties":{"id":{"type":"string","example":"tran_x7lNYXuPLS1np4n1"},"transaction_type":{"type":"string","example":"credit_card"},"funding_source":{"type":"string","example":"prepaid"},"gateway_id":{"type":"string","example":"a4f98f29-c720-4682-985e-f18234160be1"},"amount":{"type":"integer","example":1490,"default":0},"status":{"type":"string","example":"captured"},"success":{"type":"boolean","example":true,"default":true},"installments":{"type":"integer","example":1,"default":0},"statement_descriptor":{"type":"string","example":"Spotify"},"acquirer_name":{"type":"string","example":"simulator"},"acquirer_affiliation_code":{"type":"string","example":"TesteMaroto"},"acquirer_tid":{"type":"string","example":"21407"},"acquirer_nsu":{"type":"string","example":"743230"},"acquirer_auth_code":{"type":"string","example":"214846"},"acquirer_message":{"type":"string","example":"Simulator|Transação de simulação autorizada com sucesso"},"acquirer_return_code":{"type":"string","example":"0"},"operation_type":{"type":"string","example":"auth_and_capture"},"card":{"type":"object","properties":{"id":{"type":"string","example":"card_brVjYG5uZSrNARPg"},"first_six_digits":{"type":"string","example":"342793"},"last_four_digits":{"type":"string","example":"8229"},"brand":{"type":"string","example":"Amex"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":2018,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-08-10T16:02:28Z"},"updated_at":{"type":"string","example":"2017-08-10T16:02:28Z"},"billing_address":{"type":"object","properties":{"line_1":{"type":"string","example":"10880, Malibu Point, Malibu Central"},"zip_code":{"type":"string","example":"90265"},"city":{"type":"string","example":"Malibu"},"state":{"type":"string","example":"CA"},"country":{"type":"string","example":"US"}}},"type":{"type":"string","example":"credit"}}},"created_at":{"type":"string","example":"2017-08-10T16:02:40Z"},"updated_at":{"type":"string","example":"2017-08-10T16:02:40Z"},"gateway_response":{"type":"object","properties":{"code":{"type":"string","example":"201"}}}}}}},"metadata":{"type":"object","properties":{"code":{"type":"string","example":"1234"},"company":{"type":"string","example":"Avengers"}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"message\": \"Invoice not found.\"\n}"}},"schema":{"type":"object","properties":{"message":{"type":"string","example":"Invoice not found."}}}}}}},"deprecated":false}},"/subscriptions/{subscription_id}/cycles":{"post":{"summary":"Renovar ciclo","description":"Através do identificador da assinatura (`subscription_id`) é possível renovar o ciclo de uma assinatura. A utilização do método irá sempre renovar o ciclo à frente. Para Listar os ciclos de uma assinatura, acesse [Listar Ciclos](https://docs.pagar.me/reference/listar-ciclos-1).","operationId":"renovar-ciclo-1","parameters":[{"name":"subscription_id","in":"path","description":"Código da assinatura.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"cycle_Qal5a0LCpphoDpnR\",\n \"billing_at\": \"2019-04-30T00:00:00Z\",\n \"cycle\": 1,\n \"start_at\": \"2019-04-30T00:00:00Z\",\n \"end_at\": \"2019-07-29T23:59:59Z\",\n \"duration\": 7862399,\n \"created_at\": \"2019-04-30T18:09:32Z\",\n \"updated_at\": \"2019-04-30T18:12:20Z\",\n \"status\": \"billed\"\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"cycle_Qal5a0LCpphoDpnR"},"billing_at":{"type":"string","example":"2019-04-30T00:00:00Z"},"cycle":{"type":"integer","example":1,"default":0},"start_at":{"type":"string","example":"2019-04-30T00:00:00Z"},"end_at":{"type":"string","example":"2019-07-29T23:59:59Z"},"duration":{"type":"integer","example":7862399,"default":0},"created_at":{"type":"string","example":"2019-04-30T18:09:32Z"},"updated_at":{"type":"string","example":"2019-04-30T18:12:20Z"},"status":{"type":"string","example":"billed"}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"get":{"summary":"Listar ciclos","description":"Este recurso permite listar os ciclos associados a uma assinatura. Podem ser utilizados alguns parâmetros como filtro da listagem.","operationId":"listar-ciclos-1","parameters":[{"name":"subscription_id","in":"path","description":"Código da assinatura.","schema":{"type":"string"},"required":true},{"name":"id","in":"query","description":"_Código do ciclo_. Formato: `cycle_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"}},{"name":"billing_at","in":"query","description":"Data de cobrança do ciclo","schema":{"type":"string","format":"date"}},{"name":"cycle","in":"query","description":"Quantidade de ciclos na assinatura","schema":{"type":"string"}},{"name":"start_at","in":"query","description":"Data de início do ciclo","schema":{"type":"string"}},{"name":"end_at","in":"query","description":"Data final do ciclo","schema":{"type":"string"}},{"name":"duration","in":"query","schema":{"type":"string"}},{"name":"created_at","in":"query","description":"Data de criação da assinatura","schema":{"type":"string"}},{"name":"updated_at","in":"query","description":"Data de atualização do ciclo da assinatura.","schema":{"type":"string","format":"date"}},{"name":"status","in":"query","description":"Status dos ciclos. Valores possíveis: **billed** ou **unbilled**","schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"data\": [\n {\n \"id\": \"cycle_Qal5a0LCpphoDpnR\",\n \"billing_at\": \"2019-04-30T00:00:00Z\",\n \"cycle\": 1,\n \"start_at\": \"2019-04-30T00:00:00Z\",\n \"end_at\": \"2019-07-29T23:59:59Z\",\n \"duration\": 7862399,\n \"created_at\": \"2019-04-30T18:09:32Z\",\n \"updated_at\": \"2019-04-30T18:09:33Z\",\n \"status\": \"billed\"\n }\n ],\n \"paging\": {\n \"total\": 1\n }\n}"}},"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"cycle_Qal5a0LCpphoDpnR"},"billing_at":{"type":"string","example":"2019-04-30T00:00:00Z"},"cycle":{"type":"integer","example":1,"default":0},"start_at":{"type":"string","example":"2019-04-30T00:00:00Z"},"end_at":{"type":"string","example":"2019-07-29T23:59:59Z"},"duration":{"type":"integer","example":7862399,"default":0},"created_at":{"type":"string","example":"2019-04-30T18:09:32Z"},"updated_at":{"type":"string","example":"2019-04-30T18:09:33Z"},"status":{"type":"string","example":"billed"}}}},"paging":{"type":"object","properties":{"total":{"type":"integer","example":1,"default":0}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/subscriptions/{subscription_id}/cycles/{cycle_id}":{"get":{"summary":"Obter ciclo","description":"Através do identificador do ciclo (`cycle_id`) é possível recuperar as informação do ciclo de uma assinatura.","operationId":"obter-ciclo-1","parameters":[{"name":"subscription_id","in":"path","description":"Código da assinatura.","schema":{"type":"string"},"required":true},{"name":"cycle_id","in":"path","description":"_Código do ciclo_. Formato: `cycle_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"cycle_Qal5a0LCpphoDpnR\",\n \"billing_at\": \"2019-04-30T00:00:00Z\",\n \"cycle\": 1,\n \"start_at\": \"2019-04-30T00:00:00Z\",\n \"end_at\": \"2019-07-29T23:59:59Z\",\n \"duration\": 7862399,\n \"created_at\": \"2019-04-30T18:09:32Z\",\n \"updated_at\": \"2019-04-30T18:09:33Z\",\n \"status\": \"billed\"\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"cycle_Qal5a0LCpphoDpnR"},"billing_at":{"type":"string","example":"2019-04-30T00:00:00Z"},"cycle":{"type":"integer","example":1,"default":0},"start_at":{"type":"string","example":"2019-04-30T00:00:00Z"},"end_at":{"type":"string","example":"2019-07-29T23:59:59Z"},"duration":{"type":"integer","example":7862399,"default":0},"created_at":{"type":"string","example":"2019-04-30T18:09:32Z"},"updated_at":{"type":"string","example":"2019-04-30T18:09:33Z"},"status":{"type":"string","example":"billed"}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/subscriptions/{subscription_id}/split":{"patch":{"summary":"Editar regras do Split","description":"Com o verbo HTTP PATCH, através do identificador da assinatura (subscription_id) é possível ativar, desativar ou alterar as regras do split na recorrência.\n\nPara realizar a edição tem que ser enviado pelo menos um dos campos, `enabled` ou `rules`, ambos campos são opcionais e independentes.","operationId":"editar-ativação-ou-regras-do-split","parameters":[{"name":"subscription_id","in":"path","description":"Código da Assinatura.
Formato: `sub_XXXXXXXXXXXXXXXX`.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Ativa ou desativa as regras de split na assinatura. Pode ser `true` ou `False`"},"rules":{"type":"array","items":{"properties":{"amount":{"type":"integer","description":"Valor destinado ao recebedor.","format":"int32"},"recipient_id":{"type":"string","description":"Código do recebedor. Formato: rp_XXXXXXXXXXXXXXXX."},"type":{"type":"string","description":"Tipo de divisão. Os valores possíveis são flat ou percentage."},"options":{"type":"object","description":"Informações da responsabilidade do recebedor na transação.","properties":{"charge_processing_fee":{"type":"boolean","description":"Indica se o recebedor vinculado à regra será cobrado pelas taxas da transação"},"charge_remainder_fee":{"type":"boolean","description":"Indica se o recebedor vinculado à regra irá receber o restante dos recebíveis após uma divisão"},"liable":{"type":"boolean","description":"Indica se o recebedor é responsável pela transação em caso de chargeback."}}}},"type":"object"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"sub_WpkrQvNriRs6QKGz\",\n \"code\": \"EP13T6I0KR\",\n \"start_at\": \"2022-01-12T00:00:00Z\",\n \"interval\": \"month\",\n \"interval_count\": 1,\n \"billing_type\": \"postpaid\",\n \"current_cycle\": {\n \"id\": \"cycle_z7NyjWYtLoCWXnM3\",\n \"start_at\": \"2022-01-12T00:00:00Z\",\n \"end_at\": \"2022-01-13T23:59:59Z\",\n \"billing_at\": \"2022-01-14T00:00:00Z\",\n \"status\": \"unbilled\",\n \"cycle\": 1\n },\n \"next_billing_at\": \"2022-02-14T00:00:00Z\",\n \"payment_method\": \"credit_card\",\n \"currency\": \"BRL\",\n \"installments\": 1,\n \"status\": \"active\",\n \"created_at\": \"2022-01-12T15:22:04Z\",\n \"updated_at\": \"2022-01-12T15:59:58Z\",\n \"customer\": {\n \"id\": \"cus_Vg47ZR5qFqS9j0nr\",\n \"name\": \"Tony Stark\",\n \"email\": \"297a5636-3dc1-4cca-b590-c00729b9c322@avengers.com\",\n \"document\": \"78057744049\",\n \"type\": \"individual\",\n \"delinquent\": false,\n \"created_at\": \"2022-01-12T15:22:04Z\",\n \"updated_at\": \"2022-01-12T15:22:04Z\",\n \"phones\": {\n \"home_phone\": {\n \"country_code\": \"55\",\n \"number\": \"22180513\",\n \"area_code\": \"21\"\n }\n }\n },\n \"card\": {\n \"id\": \"card_1jgv2gMiE3S9ROlX\",\n \"first_six_digits\": \"400000\",\n \"last_four_digits\": \"0010\",\n \"brand\": \"Visa\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 2022,\n \"status\": \"active\",\n \"type\": \"credit\",\n \"created_at\": \"2022-01-12T15:22:04Z\",\n \"updated_at\": \"2022-01-12T15:22:04Z\",\n \"billing_address\": {\n \"street\": \"Malibu Point\",\n \"number\": \"10880\",\n \"zip_code\": \"90265\",\n \"neighborhood\": \"Central Malibu\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"line_1\": \"10880, Malibu Point, Central Malibu\"\n }\n },\n \"items\": [\n {\n \"id\": \"si_7ga8GLwEhYf63JMR\",\n \"name\": \"Premium\",\n \"description\": \"Sem anuncios\",\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2022-01-12T15:22:05Z\",\n \"updated_at\": \"2022-01-12T15:22:05Z\",\n \"pricing_scheme\": {\n \"price\": 1490,\n \"scheme_type\": \"unit\"\n }\n },\n {\n \"id\": \"si_8lwNdZKTmfqOBXME\",\n \"name\": \"Silver\",\n \"description\": \"Com anuncios\",\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2022-01-12T15:22:05Z\",\n \"updated_at\": \"2022-01-12T15:22:05Z\",\n \"pricing_scheme\": {\n \"price\": 1490,\n \"scheme_type\": \"unit\"\n }\n }\n ],\n \"split\": {\n \"enabled\": false,\n \"rules\": [\n {\n \"id\": \"sr_WadeEMbhkHoAeEP7\",\n \"type\": \"percentage\",\n \"amount\": 40,\n \"recipient\": {\n \"id\": \"rp_PxYn9ztlLtvY8lGN\",\n \"name\": \"Recipient 1\",\n \"email\": \"tstark@avengers.com\",\n \"document\": \"26224451990\",\n \"description\": \"Recipient 1\",\n \"type\": \"individual\",\n \"payment_mode\": \"bank_transfer\",\n \"status\": \"active\",\n \"created_at\": \"2022-01-12T15:21:50Z\",\n \"updated_at\": \"2022-01-12T15:21:50Z\"\n },\n \"options\": {\n \"liable\": true,\n \"charge_processing_fee\": true,\n \"charge_remainder_fee\": true\n }\n },\n {\n \"id\": \"sr_DAkNVgQQu9UZ6LYz\",\n \"type\": \"percentage\",\n \"amount\": 40,\n \"recipient\": {\n \"id\": \"rp_wMQPAKzI6BFwd5Ol\",\n \"name\": \"Recipient 2\",\n \"email\": \"tstark@avengers.com\",\n \"document\": \"26224451990\",\n \"description\": \"Recipient 2\",\n \"type\": \"individual\",\n \"payment_mode\": \"bank_transfer\",\n \"status\": \"active\",\n \"created_at\": \"2022-01-12T15:59:10Z\",\n \"updated_at\": \"2022-01-12T15:59:10Z\"\n },\n \"options\": {\n \"liable\": true,\n \"charge_processing_fee\": true,\n \"charge_remainder_fee\": false\n }\n },\n {\n \"id\": \"sr_0OJ5y8wuKrfGGzNb\",\n \"type\": \"percentage\",\n \"amount\": 20,\n \"recipient\": {\n \"id\": \"rp_mWAzMySKwfXNz1oD\",\n \"name\": \"Recipient 3\",\n \"email\": \"tstark@avengers.com\",\n \"document\": \"26224451990\",\n \"description\": \"Recipient 2\",\n \"type\": \"individual\",\n \"payment_mode\": \"bank_transfer\",\n \"status\": \"active\",\n \"created_at\": \"2022-01-12T15:59:45Z\",\n \"updated_at\": \"2022-01-12T15:59:45Z\"\n },\n \"options\": {\n \"liable\": true,\n \"charge_processing_fee\": true,\n \"charge_remainder_fee\": false\n }\n }\n ]\n },\n \"metadata\": {\n \"id\": \"teste\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"sub_WpkrQvNriRs6QKGz"},"code":{"type":"string","example":"EP13T6I0KR"},"start_at":{"type":"string","example":"2022-01-12T00:00:00Z"},"interval":{"type":"string","example":"month"},"interval_count":{"type":"integer","example":1,"default":0},"billing_type":{"type":"string","example":"postpaid"},"current_cycle":{"type":"object","properties":{"id":{"type":"string","example":"cycle_z7NyjWYtLoCWXnM3"},"start_at":{"type":"string","example":"2022-01-12T00:00:00Z"},"end_at":{"type":"string","example":"2022-01-13T23:59:59Z"},"billing_at":{"type":"string","example":"2022-01-14T00:00:00Z"},"status":{"type":"string","example":"unbilled"},"cycle":{"type":"integer","example":1,"default":0}}},"next_billing_at":{"type":"string","example":"2022-02-14T00:00:00Z"},"payment_method":{"type":"string","example":"credit_card"},"currency":{"type":"string","example":"BRL"},"installments":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2022-01-12T15:22:04Z"},"updated_at":{"type":"string","example":"2022-01-12T15:59:58Z"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_Vg47ZR5qFqS9j0nr"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"297a5636-3dc1-4cca-b590-c00729b9c322@avengers.com"},"document":{"type":"string","example":"78057744049"},"type":{"type":"string","example":"individual"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2022-01-12T15:22:04Z"},"updated_at":{"type":"string","example":"2022-01-12T15:22:04Z"},"phones":{"type":"object","properties":{"home_phone":{"type":"object","properties":{"country_code":{"type":"string","example":"55"},"number":{"type":"string","example":"22180513"},"area_code":{"type":"string","example":"21"}}}}}}},"card":{"type":"object","properties":{"id":{"type":"string","example":"card_1jgv2gMiE3S9ROlX"},"first_six_digits":{"type":"string","example":"400000"},"last_four_digits":{"type":"string","example":"0010"},"brand":{"type":"string","example":"Visa"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":2022,"default":0},"status":{"type":"string","example":"active"},"type":{"type":"string","example":"credit"},"created_at":{"type":"string","example":"2022-01-12T15:22:04Z"},"updated_at":{"type":"string","example":"2022-01-12T15:22:04Z"},"billing_address":{"type":"object","properties":{"street":{"type":"string","example":"Malibu Point"},"number":{"type":"string","example":"10880"},"zip_code":{"type":"string","example":"90265"},"neighborhood":{"type":"string","example":"Central Malibu"},"city":{"type":"string","example":"Malibu"},"state":{"type":"string","example":"CA"},"country":{"type":"string","example":"US"},"line_1":{"type":"string","example":"10880, Malibu Point, Central Malibu"}}}}},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"si_7ga8GLwEhYf63JMR"},"name":{"type":"string","example":"Premium"},"description":{"type":"string","example":"Sem anuncios"},"quantity":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2022-01-12T15:22:05Z"},"updated_at":{"type":"string","example":"2022-01-12T15:22:05Z"},"pricing_scheme":{"type":"object","properties":{"price":{"type":"integer","example":1490,"default":0},"scheme_type":{"type":"string","example":"unit"}}}}}},"split":{"type":"object","properties":{"enabled":{"type":"boolean","example":false,"default":true},"rules":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"sr_WadeEMbhkHoAeEP7"},"type":{"type":"string","example":"percentage"},"amount":{"type":"integer","example":40,"default":0},"recipient":{"type":"object","properties":{"id":{"type":"string","example":"rp_PxYn9ztlLtvY8lGN"},"name":{"type":"string","example":"Recipient 1"},"email":{"type":"string","example":"tstark@avengers.com"},"document":{"type":"string","example":"26224451990"},"description":{"type":"string","example":"Recipient 1"},"type":{"type":"string","example":"individual"},"payment_mode":{"type":"string","example":"bank_transfer"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2022-01-12T15:21:50Z"},"updated_at":{"type":"string","example":"2022-01-12T15:21:50Z"}}},"options":{"type":"object","properties":{"liable":{"type":"boolean","example":true,"default":true},"charge_processing_fee":{"type":"boolean","example":true,"default":true},"charge_remainder_fee":{"type":"boolean","example":true,"default":true}}}}}}}},"metadata":{"type":"object","properties":{"id":{"type":"string","example":"teste"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/recipients1":{"post":{"summary":"Criar recebedor contrato antigo","description":"Rota para criar um recebedor, definindo os dados do recebedor, transferência e qual a conta bancária que será utilizada para envio dos pagamentos.","operationId":"criar-recebedor-12","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","document","type"],"properties":{"name":{"type":"string","description":"Nome do recebedor. Max:128 caracteres"},"email":{"type":"string","description":"E-mail do recebedor. Max: 64 caracteres"},"description":{"type":"string","description":"Descrição do recebedor. Max:256 caracteres"},"document":{"type":"string","description":"CPF ou CNPJ do recebedor. Max: 16 caracteres"},"type":{"type":"string","description":"Tipo de recebedor. Valores possíveis: **individual** (pessoa física) ou **company** (pessoa jurídica)"},"code":{"type":"string","description":"Referencia externa única por recebedor"},"default_bank_account":{"properties":{"holder_name":{"type":"string","description":"Nome da conta. Max: 30 caracteres"},"bank":{"type":"string","description":"Código do banco. Max 3 caracteres numéricos"},"branch_number":{"type":"string","description":"Número da agência. Max 4 caracteres"},"branch_check_digit":{"type":"string","description":"Digito validador da agência. Max: 1 caracter numérico"},"account_number":{"type":"string","description":"Número da conta. Max: 13 caracteres numéricos"},"account_check_digit":{"type":"string","description":"Digitos validadores da conta. Max 2 caracteres numéricos"},"holder_type":{"type":"string","description":"Tipo do documento. \"individual\" ou \"company\""},"holder_document":{"type":"string","description":"Número do documento do titular da conta. Deve ser igual ao documento do recebedor. Somente números"},"type":{"type":"string","description":"Tipo da conta. Valores Possiveis: \"checking\" ou \"savings\""}},"required":["holder_name","bank","branch_number","account_number","account_check_digit","holder_type","holder_document","type"],"type":"object","description":"Dados da conta bancária do recebedor."},"transfer_settings":{"properties":{"transfer_enabled":{"type":"boolean","description":"Indica se o recebedor receberá seus pagamentos automaticamente."},"transfer_interval":{"type":"string","description":"Indica a frequência das transferências automáticas para a conta do recebedor. Valores possíveis: \"Daily\", \"Weekly\" ou \"Monthly\"."},"transfer_day":{"type":"integer","description":"Indica o dia em que ocorrerá as transferências automáticas.","format":"int32"}},"required":[],"type":"object","description":"Informações de transferência do recebedor"},"automatic_anticipation_settings":{"properties":{"enabled":{"type":"boolean","description":"Indica se o recebedor receberá antecipações automaticamente"},"type":{"type":"string","description":"Indica o tipo de antecipação automática que será configurado para a conta do recebedor. Valores possíveis \"full\" e \"1025\""},"volume_percentage":{"type":"string","description":"Indica a porcentagem do volume passível de ser antecipado para o recebedor."},"delay":{"type":"string","description":"Indica a quantidade de dias que serão desconsiderados na contabilização do valor passível de ser antecipado. A contagem de dias é realizada a partir do dia da antecipação para trás"}},"required":[],"type":"object","description":"Informações de antecipação automática do recebedor"},"metadata":{"type":"string","description":"Objeto chave/valor utilizado para armazenar informações adicionais sobre o recebedor."}}},"examples":{"Request Example":{"value":{"name":"Teste campos","email":"tstark@avengers.com","description":"Recebedor tony stark","document":"26224451990","type":"individual","default_bank_account":{"holder_name":"Tony Stark","holder_type":"individual","holder_document":"26224451990","bank":"341","branch_number":"1234","branch_check_digit":"6","account_number":"12345","account_check_digit":"6","type":"checking","metadata":{"key":"value"}},"transfer_settings":{"transfer_enabled":false,"transfer_interval":"Daily","transfer_day":0},"automatic_anticipation_settings":{"enabled":true,"type":"full","volume_percentage":"50","delay":null},"metadata":{"key":"value"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"rp_P6b2aBqtPsbwG7xw\",\n \"name\": \"Tony Stark\",\n \"email\": \"tstark@avengers.com\",\n \"document\": \"26224451990\",\n \"description\": \"Recebedor tony stark\",\n \"type\": \"individual\",\n \"status\": \"active\",\n \"created_at\": \"2017-08-03T20:29:28Z\",\n \"updated_at\": \"2017-08-03T20:29:28Z\",\n \t \"transfer_settings\": {\n \"transfer_enabled\": false,\n \"transfer_interval\": \"Daily\",\n \"transfer_day\": 0\n },\n \"default_bank_account\": {\n \"id\": \"ba_Ez2lE71FBUPa3XZK\",\n \"holder_name\": \"Tony Stark\",\n \"holder_type\": \"individual\",\n \"holder_document\": \"26224451990\",\n \"bank\": \"341\",\n \"branch_number\": \"1234\",\n \"branch_check_digit\": \"6\",\n \"account_number\": \"12345\",\n \"account_check_digit\": \"6\",\n \"type\": \"checking\",\n \"status\": \"active\",\n \"created_at\": \"2017-08-03T20:29:28Z\",\n \"updated_at\": \"2017-08-03T20:29:28Z\",\n \"metadata\": {\n \"key\": \"value\"\n }\n },\n \"gateway_recipients\": [\n {\n \"gateway\": \"pagarme\",\n \"status\": \"active\",\n \"pgid\": \"re_cj5aaa5i000cdhj6ernz14j1i\",\n \"createdAt\": \"2017-08-03T20:29:28Z\",\n \"updatedAt\": \"2017-08-03T20:29:28Z\"\n }\n ],\n \"automatic_anticipation_settings\": {\n \"enabled\": true,\n \"type\": \"full\",\n \"volume_percentage\": 50,\n \"delay\": 365\n },\n \"metadata\": {\n \"key\": \"value\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"rp_P6b2aBqtPsbwG7xw"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"tstark@avengers.com"},"document":{"type":"string","example":"26224451990"},"description":{"type":"string","example":"Recebedor tony stark"},"type":{"type":"string","example":"individual"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-08-03T20:29:28Z"},"updated_at":{"type":"string","example":"2017-08-03T20:29:28Z"},"transfer_settings":{"type":"object","properties":{"transfer_enabled":{"type":"boolean","example":false,"default":true},"transfer_interval":{"type":"string","example":"Daily"},"transfer_day":{"type":"integer","example":0,"default":0}}},"default_bank_account":{"type":"object","properties":{"id":{"type":"string","example":"ba_Ez2lE71FBUPa3XZK"},"holder_name":{"type":"string","example":"Tony Stark"},"holder_type":{"type":"string","example":"individual"},"holder_document":{"type":"string","example":"26224451990"},"bank":{"type":"string","example":"341"},"branch_number":{"type":"string","example":"1234"},"branch_check_digit":{"type":"string","example":"6"},"account_number":{"type":"string","example":"12345"},"account_check_digit":{"type":"string","example":"6"},"type":{"type":"string","example":"checking"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-08-03T20:29:28Z"},"updated_at":{"type":"string","example":"2017-08-03T20:29:28Z"},"metadata":{"type":"object","properties":{"key":{"type":"string","example":"value"}}}}},"gateway_recipients":{"type":"array","items":{"type":"object","properties":{"gateway":{"type":"string","example":"pagarme"},"status":{"type":"string","example":"active"},"pgid":{"type":"string","example":"re_cj5aaa5i000cdhj6ernz14j1i"},"createdAt":{"type":"string","example":"2017-08-03T20:29:28Z"},"updatedAt":{"type":"string","example":"2017-08-03T20:29:28Z"}}}},"automatic_anticipation_settings":{"type":"object","properties":{"enabled":{"type":"boolean","example":true,"default":true},"type":{"type":"string","example":"full"},"volume_percentage":{"type":"integer","example":50,"default":0},"delay":{"type":"integer","example":365,"default":0}}},"metadata":{"type":"object","properties":{"key":{"type":"string","example":"value"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/recipients":{"post":{"summary":"Criar recebedor","description":"Rota para criar um recebedor, definindo os dados do recebedor, transferência e qual a conta bancária que será utilizada para envio dos pagamentos.","operationId":"criar-recebedor-1","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["register_information","default_bank_account"],"properties":{"code":{"type":"string","description":"Referencia externa única por recebedor"},"register_information":{"type":"object","description":"Dados cadastrais do recebedor. O objeto deve ser preenchido de acordo com o tipo do recebedor, Pessoa Física [PF] ou Pessoa Jurídica [PJ].","required":["email","document","type","company_name","trading_name","annual_revenue","name","birthdate","monthly_income","professional_occupation"],"properties":{"email":{"type":"string","description":"[PF/PJ] E-mail do recebedor."},"document":{"type":"string","description":"[PF/PJ] Número do documento. Recebedores Pessoa Física preencherão o CPF e os recebedores Pessoa Jurídica preencherão o CNPJ."},"type":{"type":"string","description":"[PF/PJ] Para recebedores Pessoa Física, utilizar 'individual' e para recebedores Pessoa Jurídica, utilizar 'corporation'."},"site_url":{"type":"string","description":"[PF/PJ] Site do recebedor. Observação: É necessário incluir o protocolo Http ou Https."},"phone_numbers":{"type":"object","description":"[PJ] Telefone do recebedor.","required":["ddd","number"],"properties":{"ddd":{"type":"string","description":"DDD (Discagem Direta à Distância)"},"number":{"type":"string","description":"Número do telefone"},"type":{"type":"string","description":"Tipo do telefone"}}},"company_name":{"type":"string","description":"[PJ] Nome fantasia do recebedor. Campo exclusivo para recebedores Pessoa Jurídica."},"trading_name":{"type":"string","description":"[PJ] Razão social da empresa. Campo exclusivo para recebedores Pessoa Jurídica."},"annual_revenue":{"type":"integer","description":"[PJ] Receita anual da empresa. Campo exclusivo para recebedores Pessoa Jurídica.","format":"int32"},"corporation_type":{"type":"string","description":"[PJ] Tipo da empresa. Campo exclusivo para recebedores Pessoa Jurídica."},"founding_date":{"type":"string","description":"[PJ] Data de fundação da empresa. Campo exclusivo para recebedores Pessoa Jurídica."},"main_address":{"type":"object","description":"[PJ] Endereço da empresa. Campo exclusivo para recebedores Pessoa Jurídica.","required":["street","complementary","street_number","neighborhood","city","state","zip_code","reference_point"],"properties":{"street":{"type":"string","description":"Rua"},"complementary":{"type":"string","description":"Complemento"},"street_number":{"type":"string","description":"Número"},"neighborhood":{"type":"string","description":"Bairro"},"city":{"type":"string","description":"Cidade"},"state":{"type":"string","description":"Estado"},"zip_code":{"type":"string","description":"CEP. Para endereço brasileiro, deve conter uma numeração de 8 dígitos"},"reference_point":{"type":"string","description":"Ponto de referência do endereço"}}},"managing_partners":{"type":"array","description":"[PJ] Representante legal atrelado a empresa. Campo exclusivo para recebedores Pessoa Jurídica.","items":{"properties":{"name":{"type":"string","description":"Nome do representante legal atrelado a empresa representada pelo recebedor"},"email":{"type":"string","description":"E-mail do representante legal atrelado a empresa representada pelo recebedor"},"document":{"type":"string","description":"Número do CPF do representante legal atrelado a empresa representada pelo recebedor"},"type":{"type":"string","description":"Sempre será 'individual'"},"mother_name":{"type":"string","description":"Nome da mãe do representante legal atrelado a empresa representada pelo recebedor"},"birthdate":{"type":"string","description":"Aniversário do representante legal atrelado a empresa representada pelo recebedor"},"monthly_income":{"type":"string","description":"Renda mensal média ou estimada declarada pelo representante legal atrelado a empresa representada pelo recebedor. Exemplo: de R$1.000,00 até R$2.000,00"},"professional_occupation":{"type":"string","description":"Ocupação profissional do representante legal atrelado a empresa representada pelo recebedor"},"self_declared_legal_representative":{"type":"boolean","description":"Garantia de que aquele cadastro de pessoal física se identifica como representante legal do CNPJ do recebedor ao qual está atrelado"},"address":{"type":"object","required":["street","complementary","street_number","neighborhood","city","state","zip_code","reference_point"],"properties":{"street":{"type":"string","description":"Rua"},"complementary":{"type":"string","description":"Complemento"},"street_number":{"type":"string","description":"Número"},"neighborhood":{"type":"string","description":"Bairro"},"city":{"type":"string","description":"Cidade"},"state":{"type":"string","description":"Estado"},"zip_code":{"type":"string","description":"CEP. Para endereço brasileiro, deve conter uma numeração de 8 dígitos"},"reference_point":{"type":"string","description":"Ponto de referência do endereço"}}},"phone_numbers":{"type":"array","items":{"properties":{"ddd":{"type":"string","description":"DDD (Discagem Direta à Distância)"},"number":{"type":"string","description":"Número do telefone"},"type":{"type":"string","description":"Tipo do telefone"}},"required":["ddd","number"],"type":"object"}}},"required":["name","email","document","birthdate","monthly_income","professional_occupation","self_declared_legal_representative"],"type":"object"}},"name":{"type":"string","description":"[PF] Nome do recebedor. Campo exclusivo para recebedores Pessoa Física."},"mother_name":{"type":"string","description":"[PF] Nome da mãe. Campo exclusivo para recebedores Pessoa Física."},"birthdate":{"type":"string","description":"[PF] Aniversário. Campo exclusivo para recebedores Pessoa Física."},"monthly_income":{"type":"integer","description":"[PF] Renda mensal. Campo exclusivo para recebedores Pessoa Física.","format":"int32"},"professional_occupation":{"type":"string","description":"[PF] Ocupação profissional. Campo exclusivo para recebedores Pessoa Física."},"address":{"type":"object","description":"[PF] Endereço do recebedor.","required":["street","complementary","street_number","neighborhood","city","state","zip_code","reference_point"],"properties":{"street":{"type":"string","description":"Rua"},"complementary":{"type":"string","description":"Complemento"},"street_number":{"type":"string","description":"Número"},"neighborhood":{"type":"string","description":"Bairro"},"city":{"type":"string","description":"Cidade"},"state":{"type":"string","description":"Estado"},"zip_code":{"type":"string","description":"CEP. Para endereço brasileiro, deve conter uma numeração de 8 dígitos"},"reference_point":{"type":"string","description":"Ponto de referência do endereço"}}}}},"default_bank_account":{"type":"object","description":"Dados da conta bancária do recebedor.","required":["holder_name","holder_type","holder_document","bank","branch_number","account_number","account_check_digit","type"],"properties":{"holder_name":{"type":"string","description":"Nome do titular da conta."},"holder_type":{"type":"string","description":"Tipo de titular. Valores possíveis são **individual** (pessoa física) ou **company** (pessoa jurídica)."},"holder_document":{"type":"string","description":"Número do documento do titular da conta. Deve ser igual ao documento do recebedor."},"bank":{"type":"string","description":"Código do banco."},"branch_number":{"type":"string","description":"Número da agência."},"branch_check_digit":{"type":"string","description":"Código verificador da agência."},"account_number":{"type":"string","description":"Número da conta. Máximo 13 caracteres numéricos"},"account_check_digit":{"type":"string","description":"Código verificador da conta."},"type":{"type":"string","description":"Tipo da conta. Valores possíveis são **checking** ou **savings**."},"metadata":{"type":"object","description":"Objeto chave/valor utilizado para armazenar informações adicionais sobre a conta bancária.","properties":{}}}},"transfer_settings":{"type":"object","description":"Informações de transferência do recebedor","properties":{"transfer_enabled":{"type":"boolean","description":"_Indica se o recebedor receberá seus pagamentos automaticamente `."},"transfer_interval":{"type":"string","description":"Indica a frequência das transferências automáticas para a conta do recebedor."},"transfer_day":{"type":"integer","description":"Indica o dia em que ocorrerá as transferências automáticas.","format":"int32"}}},"automatic_anticipation_settings":{"type":"object","description":"Informações de antecipação automática do recebedor","properties":{"enabled":{"type":"boolean","description":"Indica se o recebedor receberá antecipações automaticamente"},"type":{"type":"string","description":"ndica o tipo de antecipação automática que será configurado para a conta do recebedor. Valores possíveis **full** e **1025**."},"volume_percentage":{"type":"string","description":"Indica o volume passível de ser antecipado para o recebedor."},"days":{"type":"array","description":"Indica os dias em que ocorrerá as antecipações automáticas.","items":{"type":"string"}},"delay":{"type":"string","description":"Indica a quantidade de dias que serão desconsiderados na contabilização do valor passível de ser antecipado. A contagem de dias é realizada a partir do dia da antecipação para trás"}}},"metadata":{"type":"string","description":"Objeto chave/valor utilizado para armazenar informações adicionais sobre o recebedor."}}},"examples":{"Request Pessoa Jurídica":{"value":{"code":"1234","register_information":{"company_name":"Recebedor pessoa juridica","trading_name":"Empresa LTDA","email":"empresax@avengers.com","document":"77699131000133","type":"corporation","site_url":"http://www.site.com","annual_revenue":1000000,"corporation_type":"LTDA","founding_date":"2010-10-30","main_address":{"street":"Av. General Justo","complementary":"Bloco A","street_number":"375","neighborhood":"Centro","city":"Rio de Janeiro","state":"RJ","zip_code":"20021130","reference_point":"Ao lado da banca de jornal"},"phone_numbers":[{"ddd":"21","number":"994647568","type":"mobile"}],"managing_partners":[{"name":"Tony Stark","email":"tstark@avengers.com","document":"26224451990","type":"individual","mother_name":"Nome da mae","birthdate":"12/10/1995","monthly_income":120000,"professional_occupation":"Vendedor","self_declared_legal_representative":true,"address":{"street":"Av. General Justo","complementary":"Bloco A","street_number":"375","neighborhood":"Centro","city":"Rio de Janeiro","state":"RJ","zip_code":"20021130","reference_point":"Ao lado da banca de jornal"},"phone_numbers":[{"ddd":"27","number":"999992628","type":"mobile"}]}]},"transfer_settings":{"transfer_enabled":"false","transfer_interval":"Daily","transfer_day":0},"default_bank_account":{"holder_name":"Tony Stark","holder_type":"individual","holder_document":"26224451990","bank":"341","branch_number":"1234","branch_check_digit":"6","account_number":"12345","account_check_digit":"6","type":"checking"},"automatic_anticipation_settings":{"enabled":"true","type":"full","volume_percentage":"50","delay":"null"}}},"Request Pessoa Física":{"value":{"code":"1234","register_information":{"name":"Recebedor Pessoa fisica","email":"tstark@avengers.com","document":"26224451990","type":"individual","site_url":"https://sitedorecebedor.com.br","mother_name":"Nome da mae","birthdate":"12/10/1995","monthly_income":120000,"professional_occupation":"Vendedor","address":{"street":"Av. General Justo","complementary":"Bloco A","street_number":"375","neighborhood":"Centro","city":"Rio de Janeiro","state":"RJ","zip_code":"20021130","reference_point":"Ao lado da banca de jornal"},"phone_numbers":[{"ddd":"21","number":"994647568","type":"mobile"}]},"transfer_settings":{"transfer_enabled":"false","transfer_interval":"Daily","transfer_day":0},"default_bank_account":{"holder_name":"Tony Stark","holder_type":"individual","holder_document":"26224451990","bank":"341","branch_number":"1234","branch_check_digit":"6","account_number":"12345","account_check_digit":"6","type":"checking"},"automatic_anticipation_settings":{"enabled":"true","type":"full","volume_percentage":"50","delay":"null"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"re_clxnqkxk709sc019taqhmj4kf\",\n \"name\": \"Antonio da Silva\",\n \"email\": \"tstark@avengers.com\",\n \"code\": \"21875b51-d4c3-46d3-aeee-d8b3112aab55\",\n \"document\": \"26224451990\",\n \"type\": \"individual\",\n \"payment_mode\": \"bank_transfer\",\n \"status\": \"active\",\n \"created_at\": \"2024-06-20T20:50:31Z\",\n \"updated_at\": \"2024-06-20T20:50:31Z\",\n \"transfer_settings\": {\n \"transfer_enabled\": true,\n \"transfer_interval\": \"Weekly\",\n \"transfer_day\": 1\n },\n \"default_bank_account\": {\n \"id\": \"ba_LlpvMnqcXSO2EVW8\",\n \"holder_name\": \"Tony Stark\",\n \"holder_type\": \"individual\",\n \"holder_document\": \"26224451990\",\n \"bank\": \"341\",\n \"branch_number\": \"1234\",\n \"branch_check_digit\": \"6\",\n \"account_number\": \"12345\",\n \"account_check_digit\": \"6\",\n \"type\": \"checking\",\n \"status\": \"active\",\n \"created_at\": \"2024-06-20T20:50:31Z\",\n \"updated_at\": \"2024-06-20T20:50:31Z\",\n \"metadata\": {\n \"key\": \"value\"\n }\n },\n \"gateway_recipients\": [\n {\n \"gateway\": \"pagarme\",\n \"status\": \"active\",\n \"pgid\": \"re_clxnqkxk709sc019taqhmj4kf\",\n \"createdAt\": \"2024-06-20T20:50:31Z\",\n \"updatedAt\": \"2024-06-20T20:50:31Z\"\n }\n ],\n \"automatic_anticipation_settings\": {\n \"enabled\": false,\n \"type\": \"full\",\n \"volume_percentage\": 0,\n \"delay\": 365\n },\n \"metadata\": {\n \"key\": \"value\"\n },\n \"register_information\": {\n \"email\": \"tstark@avengers.com\",\n \"document\": \"26224451990\",\n \"type\": \"individual\",\n \"site_url\": \"http://www.site.com\",\n \"phone_numbers\": [\n {\n \"ddd\": \"77\",\n \"number\": \"987655432\",\n \"type\": \"mobile\"\n }\n ],\n \"name\": \"Antonio da Silva\",\n \"mother_name\": \"Maria da Silva\",\n \"birthdate\": \"02/10/1990\",\n \"monthly_income\": \"3000\",\n \"professional_occupation\": \"Professor\",\n \"address\": {\n \"street\": \"Rua Alberto Carvalho\",\n \"complementary\": \"Apto. 345\",\n \"street_number\": \"111\",\n \"neighborhood\": \"Gomes Pereira\",\n \"city\": \"Porto Seguro\",\n \"state\": \"BA\",\n \"zip_code\": \"44900000\",\n \"reference_point\": \"Próximo ao Posto Quatro Rodas\"\n }\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"re_clxnqkxk709sc019taqhmj4kf"},"name":{"type":"string","example":"Antonio da Silva"},"email":{"type":"string","example":"tstark@avengers.com"},"code":{"type":"string","example":"21875b51-d4c3-46d3-aeee-d8b3112aab55"},"document":{"type":"string","example":"26224451990"},"type":{"type":"string","example":"individual"},"payment_mode":{"type":"string","example":"bank_transfer"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2024-06-20T20:50:31Z"},"updated_at":{"type":"string","example":"2024-06-20T20:50:31Z"},"transfer_settings":{"type":"object","properties":{"transfer_enabled":{"type":"boolean","example":true,"default":true},"transfer_interval":{"type":"string","example":"Weekly"},"transfer_day":{"type":"integer","example":1,"default":0}}},"default_bank_account":{"type":"object","properties":{"id":{"type":"string","example":"ba_LlpvMnqcXSO2EVW8"},"holder_name":{"type":"string","example":"Tony Stark"},"holder_type":{"type":"string","example":"individual"},"holder_document":{"type":"string","example":"26224451990"},"bank":{"type":"string","example":"341"},"branch_number":{"type":"string","example":"1234"},"branch_check_digit":{"type":"string","example":"6"},"account_number":{"type":"string","example":"12345"},"account_check_digit":{"type":"string","example":"6"},"type":{"type":"string","example":"checking"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2024-06-20T20:50:31Z"},"updated_at":{"type":"string","example":"2024-06-20T20:50:31Z"},"metadata":{"type":"object","properties":{"key":{"type":"string","example":"value"}}}}},"gateway_recipients":{"type":"array","items":{"type":"object","properties":{"gateway":{"type":"string","example":"pagarme"},"status":{"type":"string","example":"active"},"pgid":{"type":"string","example":"re_clxnqkxk709sc019taqhmj4kf"},"createdAt":{"type":"string","example":"2024-06-20T20:50:31Z"},"updatedAt":{"type":"string","example":"2024-06-20T20:50:31Z"}}}},"automatic_anticipation_settings":{"type":"object","properties":{"enabled":{"type":"boolean","example":false,"default":true},"type":{"type":"string","example":"full"},"volume_percentage":{"type":"integer","example":0,"default":0},"delay":{"type":"integer","example":365,"default":0}}},"metadata":{"type":"object","properties":{"key":{"type":"string","example":"value"}}},"register_information":{"type":"object","properties":{"email":{"type":"string","example":"tstark@avengers.com"},"document":{"type":"string","example":"26224451990"},"type":{"type":"string","example":"individual"},"site_url":{"type":"string","example":"http://www.site.com"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"ddd":{"type":"string","example":"77"},"number":{"type":"string","example":"987655432"},"type":{"type":"string","example":"mobile"}}}},"name":{"type":"string","example":"Antonio da Silva"},"mother_name":{"type":"string","example":"Maria da Silva"},"birthdate":{"type":"string","example":"02/10/1990"},"monthly_income":{"type":"string","example":"3000"},"professional_occupation":{"type":"string","example":"Professor"},"address":{"type":"object","properties":{"street":{"type":"string","example":"Rua Alberto Carvalho"},"complementary":{"type":"string","example":"Apto. 345"},"street_number":{"type":"string","example":"111"},"neighborhood":{"type":"string","example":"Gomes Pereira"},"city":{"type":"string","example":"Porto Seguro"},"state":{"type":"string","example":"BA"},"zip_code":{"type":"string","example":"44900000"},"reference_point":{"type":"string","example":"Próximo ao Posto Quatro Rodas"}}}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"get":{"summary":"Listar recebedores","description":"Retorna uma lista de objetos com os dados dos recebedor encontrados.","operationId":"listar-recebedores-1","parameters":[{"name":"page","in":"query","description":"Página atual.","schema":{"type":"integer","format":"int32","default":1}},{"name":"size","in":"query","description":"Quantidade de itens por página.","schema":{"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"data\": [\n {\n \"id\": \"rp_Gxb5NJNiqvf0Y5Xv\",\n \"name\": \"Tony Stark\",\n \"email\": \"tstark@avengers.com\",\n \"document\": \"26224451990\",\n \"description\": \"Recebedor Tony Stark\",\n \"type\": \"individual\",\n \"status\": \"active\",\n \"created_at\": \"2017-10-27T16:12:37Z\",\n \"updated_at\": \"2017-10-27T16:12:37Z\",\n \"transfer_settings\": {\n \"transfer_enabled\": false,\n \"transfer_interval\": \"Daily\",\n \"transfer_day\": 0\n },\n \"default_bank_account\": {\n \"id\": \"ba_KOoYDmEHvIEYD6v3\",\n \"holder_name\": \"Tony Stark\",\n \"holder_type\": \"individual\",\n \"holder_document\": \"26224451990\",\n \"bank\": \"341\",\n \"branch_number\": \"12345\",\n \"branch_check_digit\": \"6\",\n \"account_number\": \"12345\",\n \"account_check_digit\": \"6\",\n \"type\": \"checking\",\n \"status\": \"active\",\n \"created_at\": \"2017-10-27T19:03:21Z\",\n \"updated_at\": \"2017-10-27T19:03:21Z\",\n \"metadata\": {\n \"meta_key\": \"meta_value\"\n }\n },\n \"metadata\": {\n \"key\": \"value\"\n }\n }\n ],\n \"paging\": {\n \"total\": 1\n }\n}"}},"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"rp_Gxb5NJNiqvf0Y5Xv"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"tstark@avengers.com"},"document":{"type":"string","example":"26224451990"},"description":{"type":"string","example":"Recebedor Tony Stark"},"type":{"type":"string","example":"individual"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-10-27T16:12:37Z"},"updated_at":{"type":"string","example":"2017-10-27T16:12:37Z"},"transfer_settings":{"type":"object","properties":{"transfer_enabled":{"type":"boolean","example":false,"default":true},"transfer_interval":{"type":"string","example":"Daily"},"transfer_day":{"type":"integer","example":0,"default":0}}},"default_bank_account":{"type":"object","properties":{"id":{"type":"string","example":"ba_KOoYDmEHvIEYD6v3"},"holder_name":{"type":"string","example":"Tony Stark"},"holder_type":{"type":"string","example":"individual"},"holder_document":{"type":"string","example":"26224451990"},"bank":{"type":"string","example":"341"},"branch_number":{"type":"string","example":"12345"},"branch_check_digit":{"type":"string","example":"6"},"account_number":{"type":"string","example":"12345"},"account_check_digit":{"type":"string","example":"6"},"type":{"type":"string","example":"checking"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-10-27T19:03:21Z"},"updated_at":{"type":"string","example":"2017-10-27T19:03:21Z"},"metadata":{"type":"object","properties":{"meta_key":{"type":"string","example":"meta_value"}}}}},"metadata":{"type":"object","properties":{"key":{"type":"string","example":"value"}}}}}},"paging":{"type":"object","properties":{"total":{"type":"integer","example":1,"default":0}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/recipients/{recipient_id}/kyc_link":{"post":{"summary":"Criar link de de Prova de Vida (KYC)","description":"Rota para gerar o QR Code de acesso ao webapp.","operationId":"criar-link-recebedor","parameters":[{"name":"recipient_id","in":"path","description":"Código do recebedor.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"url\": \"www.pagar.me/kyc/14214214215...\",\n \"base64_qrcode\": \"PD56bWwgdVyc2lvb...pIi8+PC9zdmc+\",\n \"expires_at\": \"2025-05-10T17:17:26Z\"\n}"}},"schema":{"type":"object","properties":{"url":{"type":"string","example":"www.pagar.me/kyc/14214214215..."},"base64_qrcode":{"type":"string","example":"PD56bWwgdVyc2lvb...pIi8+PC9zdmc+"},"expires_at":{"type":"string","example":"2025-05-10T17:17:26Z"}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{\n \"errors\": [\n {\n \"message\": \"Must be passed a parameter to Create QrCode.\"\n }\n ]\n}"}},"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","example":"Must be passed a parameter to Create QrCode."}}}}}}}}},"404":{"description":"404","content":{"application/json":{"examples":{"Result":{"value":"{\n \"errors\": [\n {\n \"message\": \"re_clsnosxwp000a019ts7a262ay doesn´t have any kyc with partially_denied status.\"\n }\n ]\n}"}},"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","example":"re_clsnosxwp000a019ts7a262ay doesn´t have any kyc with partially_denied status."}}}}}}}}}},"deprecated":false,"x-readme":{"code-samples":[{"language":"curl","code":"curl --request POST \\\n --url https://api.stone.com.br/core/v5/recipients/re_clsnosxwp000a019ts7a262ay/kyc_link \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json'"}],"samples-languages":["curl"]}}},"/recipients/{recipient_id}":{"put":{"summary":"Editar recebedor","description":"Rota para editar um recebedor, definindo os dados do recebedor, transferência e qual a conta bancária que será utilizada para envio dos pagamentos. Para recebedores no contrato antigo, é possível alterar apenas os dados do recebedor (veja a opção \"Contrato antigo\" no corpo da requisição).","operationId":"editar-recebedor-1","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"title":"Editar recebedor","type":"object","properties":{"register_information":{"type":"object","description":"Dados cadastrais do recebedor. O objeto deve ser preenchido de acordo com o tipo do recebedor, Pessoa Física [PF] ou Pessoa Jurídica [PJ].","properties":{"email":{"type":"string","description":"[PF/PJ] E-mail do recebedor."},"document":{"type":"string","description":"[PF/PJ] Para recebedores Pessoa Física, utilizar 'individual' e para recebedores Pessoa Jurídica, utilizar 'corporation'."},"site_url":{"type":"string","description":"[PF/PJ] Site do recebedor. Observação: É necessário incluir o protocolo Http ou Https."},"phone_numbers":{"type":"array","description":"[PJ/PJ] Telefone do recebedor.","items":{"properties":{"ddd":{"type":"string","description":"DDD (Discagem Direta à Distância)"},"number":{"type":"string","description":"Número do telefone"},"type":{"type":"string","description":"Tipo do telefone"}},"required":["ddd","number"],"type":"object"}},"main_address":{"type":"object","required":["street","complementary","street_number","neighborhood","city","state","zip_code","reference_point"],"properties":{"street":{"type":"string","description":"Rua"},"complementary":{"type":"string","description":"Complemento"},"street_number":{"type":"string","description":"Número"},"neighborhood":{"type":"string","description":"Bairro"},"city":{"type":"string","description":"Cidade"},"state":{"type":"string","description":"Estado"},"zip_code":{"type":"string","description":"CEP. Para endereço brasileiro, deve conter uma numeração de 8 dígitos"},"reference_point":{"type":"string","description":"Ponto de referência do endereço"}}}}},"metadata":{"type":"string","description":"Objeto chave/valor utilizado para armazenar informações adicionais sobre o recebedor."}}},{"title":"Contrato antigo","type":"object","required":["type"],"properties":{"email":{"type":"string","description":"E-mail do recebedor. Max: 64 caracteres"},"description":{"type":"string","description":"Descrição do recebedor. Max:256 caracteres"},"type":{"type":"string","description":"Tipo de recebedor. Valores possíveis: **individual** (pessoa física) ou **company** (pessoa jurídica)"},"metadata":{"type":"object","description":"Objeto chave/valor utilizado para armazenar informações adicionais sobre o recebedor.","properties":{}}}}]},"examples":{"Request Pessoa Jurídica":{"value":{"register_information":{"type":"corporation","document":"27123482000123","site_url":"http://www.site.com","company_name":"Jorge e Isabel Publicidade e Propaganda Alterado","trading_name":"Jorge e Isabel Publicidade e Propaganda ME Alterado","annual_revenue":"100000000","email":"alterado@teste.com","founding_date":"10/11/2010","cnae":"8599-6/03","managing_partners":[{"document":"26224451990","type":"individual","name":"João da Silva Alterado","birthdate":"10/02/1995 Alterado","email":"alterado@teste.com","monthly_income":"30000","professional_occupation":"Professor Alterado","self_declared_legal_representative":true,"address":{"street":"Av.Santos Lopes Alterada","complementary":"Apto. 104 Alterado","street_number":"189 Alterado","neighborhood":"Centro Alterado","city":"Irecê Alterado","state":"BA Alterado","zip_code":"44900000 Alterado","reference_point":"Em frente ao clube de tiro 1910 Alterado"},"phone_numbers":[{"ddd":"75","number":"98999999","type":"celular"},{"ddd":"75","number":"98777777","type":"celular"}]}],"main_address":{"street":"Av.Santos Lopes Alterado","complementary":"Apto. 104 Alterado","street_number":"189 Alterado","neighborhood":"Centro Alterado","city":"Irecê Alterado","state":"BA Alterado","zip_code":"44900000 Alterado","reference_point":"Em frente ao clube de tiro 1910 Alterado"},"phone_numbers":[{"ddd":"75","number":"97999991","type":"celular"}]},"metadata":{"meta_key":"meta_value"}}},"Request Pessoa Física":{"value":{"register_information":{"email":"change@avengers.com","document":"26224451990","type":"individual","site_url":"http://www.site.com","phone_numbers":[{"ddd":"85","number":"987655433","type":"celular"}],"name":"Antonio da Silva e Santos","mother_name":"Maria da Silva Santos","birthdate":"02/02/1990","monthly_income":"30000","professional_occupation":"Padeiro","address":{"street":"Rua Alberto Pereira","complementary":"Apto. 348","street_number":"115","neighborhood":"Gomes Souza","city":"Campina Grande","state":"PB","zip_code":"44900012","reference_point":"Em frente a UFPB"}}}},"Contrato antigo":{"value":{"email":"tstark@avengers.com","description":"Recebedor Tony Stark","type":"individual","metadata":{"key":"value"}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"rp_P6b2aBqtPsbwG7xw\",\n \"name\": \"Tony Stark\",\n \"email\": \"tstark@pagar.me\",\n \"document\": \"26224451990\",\n \"description\": \"Recebedor tony stark\",\n \"type\": \"individual\",\n \"status\": \"active\",\n \"created_at\": \"2017-08-03T20:29:28Z\",\n \"updated_at\": \"2017-08-03T20:29:28Z\",\n \"transfer_settings\": {\n \"transfer_enabled\": false,\n \"transfer_interval\": \"Daily\",\n \"transfer_day\": 0\n },\n \"default_bank_account\": {\n \"id\": \"ba_Ez2lE71FBUPa3XZK\",\n \"holder_name\": \"Tony Stark\",\n \"holder_type\": \"individual\",\n \"holder_document\": \"26224451990\",\n \"bank\": \"341\",\n \"branch_number\": \"1234\",\n \"branch_check_digit\": \"6\",\n \"account_number\": \"12345\",\n \"account_check_digit\": \"6\",\n \"type\": \"checking\",\n \"status\": \"active\",\n \"created_at\": \"2017-08-03T20:29:28Z\",\n \"updated_at\": \"2017-08-03T20:29:28Z\",\n \"metadata\": {\n \"key\": \"value\"\n }\n },\n \"gateway_recipients\": [\n {\n \"gateway\": \"pagarme\",\n \"status\": \"active\",\n \"pgid\": \"re_cj5aaa5i000cdhj6ernz14j1i\",\n \"createdAt\": \"2017-08-03T20:29:28Z\",\n \"updatedAt\": \"2017-08-03T20:29:28Z\"\n }\n ],\n \"metadata\": {\n \"key\": \"value\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"rp_P6b2aBqtPsbwG7xw"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"tstark@pagar.me"},"document":{"type":"string","example":"26224451990"},"description":{"type":"string","example":"Recebedor tony stark"},"type":{"type":"string","example":"individual"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-08-03T20:29:28Z"},"updated_at":{"type":"string","example":"2017-08-03T20:29:28Z"},"transfer_settings":{"type":"object","properties":{"transfer_enabled":{"type":"boolean","example":false,"default":true},"transfer_interval":{"type":"string","example":"Daily"},"transfer_day":{"type":"integer","example":0,"default":0}}},"default_bank_account":{"type":"object","properties":{"id":{"type":"string","example":"ba_Ez2lE71FBUPa3XZK"},"holder_name":{"type":"string","example":"Tony Stark"},"holder_type":{"type":"string","example":"individual"},"holder_document":{"type":"string","example":"26224451990"},"bank":{"type":"string","example":"341"},"branch_number":{"type":"string","example":"1234"},"branch_check_digit":{"type":"string","example":"6"},"account_number":{"type":"string","example":"12345"},"account_check_digit":{"type":"string","example":"6"},"type":{"type":"string","example":"checking"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-08-03T20:29:28Z"},"updated_at":{"type":"string","example":"2017-08-03T20:29:28Z"},"metadata":{"type":"object","properties":{"key":{"type":"string","example":"value"}}}}},"gateway_recipients":{"type":"array","items":{"type":"object","properties":{"gateway":{"type":"string","example":"pagarme"},"status":{"type":"string","example":"active"},"pgid":{"type":"string","example":"re_cj5aaa5i000cdhj6ernz14j1i"},"createdAt":{"type":"string","example":"2017-08-03T20:29:28Z"},"updatedAt":{"type":"string","example":"2017-08-03T20:29:28Z"}}}},"metadata":{"type":"object","properties":{"key":{"type":"string","example":"value"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false,"parameters":[{"name":"recipient_id","in":"path","description":"Código do recebedor","schema":{"type":"string"},"required":true}]},"get":{"summary":"Obter recebedor","description":"Retorna um objeto com os dados de um recebedor específico.","operationId":"obter-recebedor-1","parameters":[{"name":"recipient_id","in":"path","description":"Código do recebedor.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Contrato antigo":{"value":"{\n \"id\": \"rp_P6b2aBqtPsbwG7xw\",\n \"name\": \"Tony Stark\",\n \"email\": \"tstark@pagar.me\",\n \"document\": \"26224451990\",\n \"description\": \"Recebedor tony stark\",\n \"type\": \"individual\",\n \"status\": \"active\",\n \"created_at\": \"2017-08-03T20:29:28Z\",\n \"updated_at\": \"2017-08-03T20:29:28Z\",\n \"transfer_settings\": {\n \"transfer_enabled\": false,\n \"transfer_interval\": \"Daily\",\n \"transfer_day\": 0\n },\n \"default_bank_account\": {\n \"id\": \"ba_Ez2lE71FBUPa3XZK\",\n \"holder_name\": \"Tony Stark\",\n \"holder_type\": \"individual\",\n \"holder_document\": \"26224451990\",\n \"bank\": \"341\",\n \"branch_number\": \"12345\",\n \"branch_check_digit\": \"6\",\n \"account_number\": \"12345\",\n \"account_check_digit\": \"6\",\n \"type\": \"checking\",\n \"status\": \"active\",\n \"created_at\": \"2017-08-03T20:29:28Z\",\n \"updated_at\": \"2017-08-03T20:29:28Z\",\n \"metadata\": {\n \"key\": \"value\"\n }\n },\n \"gateway_recipients\": [\n {\n \"gateway\": \"pagarme\",\n \"status\": \"active\",\n \"pgid\": \"re_cj5aaa5i000cdhj6ernz14j1i\",\n \"createdAt\": \"2017-08-03T20:29:28Z\",\n \"updatedAt\": \"2017-08-03T20:29:28Z\"\n }\n ],\n \"metadata\": {\n \"key\": \"value\"\n }\n}"},"Contrato novo - PF":{"value":"{\n \"id\": \"re_clt7l11wu03cl019tj3frja7x\",\n \"name\": \"Antonio da Silva\",\n \"email\": \"tstark@avengers.com\",\n \"code\": \"2c0b5b0b-7be5-4a29-b26d-12dd7ed71311\",\n \"document\": \"26224451990\",\n \"type\": \"individual\",\n \"payment_mode\": \"bank_transfer\",\n \"status\": \"active\",\n \"created_at\": \"2024-02-29T18:51:57Z\",\n \"updated_at\": \"2024-02-29T18:51:57Z\",\n \"transfer_settings\": {\n \"transfer_enabled\": true,\n \"transfer_interval\": \"Weekly\",\n \"transfer_day\": 1\n },\n \"default_bank_account\": {\n \"id\": \"ba_dO5X325CBHr3QYe9\",\n \"holder_name\": \"Tony Stark\",\n \"holder_type\": \"individual\",\n \"holder_document\": \"26224451990\",\n \"bank\": \"341\",\n \"branch_number\": \"1234\",\n \"branch_check_digit\": \"6\",\n \"account_number\": \"12345\",\n \"account_check_digit\": \"6\",\n \"type\": \"checking\",\n \"status\": \"active\",\n \"created_at\": \"2024-02-29T18:51:57Z\",\n \"updated_at\": \"2024-02-29T18:51:57Z\",\n \"metadata\": {\n \"key\": \"value\"\n }\n },\n \"gateway_recipients\": [\n {\n \"gateway\": \"pagarme\",\n \"status\": \"active\",\n \"pgid\": \"re_clt7l11wu03cl019tj3frja7x\",\n \"createdAt\": \"2024-02-29T18:51:58Z\",\n \"updatedAt\": \"2024-02-29T18:51:58Z\"\n }\n ],\n \"automatic_anticipation_settings\": {\n \"enabled\": false,\n \"type\": \"full\",\n \"volume_percentage\": 0,\n \"delay\": 365\n },\n \"metadata\": {\n \"key\": \"value\"\n },\n \"register_information\": {\n \"email\": \"tstark@avengers.com\",\n \"document\": \"26224451990\",\n \"type\": \"individual\",\n \"site_url\": \"http://www.site.com\",\n \"phone_numbers\": [\n {\n \"ddd\": \"77\",\n \"number\": \"987655432\",\n \"type\": \"mobile\"\n }\n ],\n \"name\": \"Antonio da Silva\",\n \"mother_name\": \"Maria da Silva\",\n \"birthdate\": \"02/10/1990\",\n \"monthly_income\": \"300000\",\n \"professional_occupation\": \"Professor\",\n \"address\": {\n \"street\": \"Rua Alberto Carvalho\",\n \"complementary\": \"Apto. 345\",\n \"street_number\": \"111\",\n \"neighborhood\": \"Gomes Pereira\",\n \"city\": \"Porto Seguro\",\n \"state\": \"BA\",\n \"zip_code\": \"44900000\",\n \"reference_point\": \"Próximo ao Posto Quatro Rodas\"\n }\n }\n}"},"Contrato novo - PJ":{"value":"{\n \"id\": \"re_clt7md7ej03th019tm0n4c1ct\",\n \"name\": \"Jorge e Isabel Publicidade e Propaganda\",\n \"email\": \"teste@teste.com\",\n \"code\": \"2c0b5b0b-7be5-4a29-b26d-12dd7ed713e0\",\n \"document\": \"27123482000123\",\n \"type\": \"company\",\n \"payment_mode\": \"bank_transfer\",\n \"status\": \"active\",\n \"created_at\": \"2024-02-29T19:29:24Z\",\n \"updated_at\": \"2024-02-29T19:29:24Z\",\n \"transfer_settings\": {\n \"transfer_enabled\": true,\n \"transfer_interval\": \"Weekly\",\n \"transfer_day\": 1\n },\n \"default_bank_account\": {\n \"id\": \"ba_301y9evH6NIgy6rl\",\n \"holder_name\": \"Tony Stark\",\n \"holder_type\": \"individual\",\n \"holder_document\": \"27123482000123\",\n \"bank\": \"341\",\n \"branch_number\": \"1234\",\n \"branch_check_digit\": \"6\",\n \"account_number\": \"12345\",\n \"account_check_digit\": \"6\",\n \"type\": \"checking\",\n \"status\": \"active\",\n \"created_at\": \"2024-02-29T19:29:24Z\",\n \"updated_at\": \"2024-02-29T19:29:24Z\",\n \"metadata\": {\n \"key\": \"value\"\n }\n },\n \"gateway_recipients\": [\n {\n \"gateway\": \"pagarme\",\n \"status\": \"active\",\n \"pgid\": \"re_clt7md7ej03th019tm0n4c1ct\",\n \"createdAt\": \"2024-02-29T19:29:24Z\",\n \"updatedAt\": \"2024-02-29T19:29:24Z\"\n }\n ],\n \"automatic_anticipation_settings\": {\n \"enabled\": false,\n \"type\": \"full\",\n \"volume_percentage\": 0,\n \"delay\": 365\n },\n \"metadata\": {\n \"key\": \"value\"\n },\n \"register_information\": {\n \"email\": \"teste@teste.com\",\n \"document\": \"27123482000123\",\n \"type\": \"corporation\",\n \"site_url\": \"http://www.site.com\",\n \"phone_numbers\": [\n {\n \"ddd\": \"71\",\n \"number\": \"99999999\",\n \"type\": \"mobile\"\n }\n ],\n \"company_name\": \"Jorge e Isabel Publicidade e Propaganda\",\n \"trading_name\": \"Jorge e Isabel Publicidade e Propaganda ME\",\n \"annual_revenue\": \"100000000\",\n \"founding_date\": \"10/10/2010\",\n \"cnae\": \"4651-6/01\",\n \"main_address\": {\n \"street\": \"Av.Santos Lopes\",\n \"complementary\": \"Apto. 104\",\n \"street_number\": \"189\",\n \"neighborhood\": \"Centro\",\n \"city\": \"Irecê\",\n \"state\": \"BA\",\n \"zip_code\": \"44900000\",\n \"reference_point\": \"Em frente ao clube de tiro 1910\"\n },\n \"managing_partners\": [\n {\n \"name\": \"João da Silva\",\n \"email\": \"teste@teste.com\",\n \"document\": \"26224451990\",\n \"type\": \"individual\",\n \"birthdate\": \"10/02/1995\",\n \"monthly_income\": \"300000\",\n \"professional_occupation\": \"Professor\",\n \"self_declared_representative\": true,\n \"address\": {\n \"street\": \"Av.Santos Lopes\",\n \"complementary\": \"Apto. 104\",\n \"street_number\": \"189\",\n \"neighborhood\": \"Centro\",\n \"city\": \"Irecê\",\n \"state\": \"BA\",\n \"zip_code\": \"44900000\",\n \"reference_point\": \"Em frente ao clube de tiro 1910\"\n },\n \"phone_numbers\": [\n {\n \"ddd\": \"71\",\n \"number\": \"99999999\",\n \"type\": \"mobile\"\n },\n {\n \"ddd\": \"71\",\n \"number\": \"97777777\",\n \"type\": \"mobile\"\n }\n ]\n }\n ]\n }\n}"}},"schema":{"oneOf":[{"title":"Contrato antigo","type":"object","properties":{"id":{"type":"string","example":"rp_P6b2aBqtPsbwG7xw"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"tstark@pagar.me"},"document":{"type":"string","example":"26224451990"},"description":{"type":"string","example":"Recebedor tony stark"},"type":{"type":"string","example":"individual"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-08-03T20:29:28Z"},"updated_at":{"type":"string","example":"2017-08-03T20:29:28Z"},"transfer_settings":{"type":"object","properties":{"transfer_enabled":{"type":"boolean","example":false,"default":true},"transfer_interval":{"type":"string","example":"Daily"},"transfer_day":{"type":"integer","example":0,"default":0}}},"default_bank_account":{"type":"object","properties":{"id":{"type":"string","example":"ba_Ez2lE71FBUPa3XZK"},"holder_name":{"type":"string","example":"Tony Stark"},"holder_type":{"type":"string","example":"individual"},"holder_document":{"type":"string","example":"26224451990"},"bank":{"type":"string","example":"341"},"branch_number":{"type":"string","example":"12345"},"branch_check_digit":{"type":"string","example":"6"},"account_number":{"type":"string","example":"12345"},"account_check_digit":{"type":"string","example":"6"},"type":{"type":"string","example":"checking"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-08-03T20:29:28Z"},"updated_at":{"type":"string","example":"2017-08-03T20:29:28Z"},"metadata":{"type":"object","properties":{"key":{"type":"string","example":"value"}}}}},"gateway_recipients":{"type":"array","items":{"type":"object","properties":{"gateway":{"type":"string","example":"pagarme"},"status":{"type":"string","example":"active"},"pgid":{"type":"string","example":"re_cj5aaa5i000cdhj6ernz14j1i"},"createdAt":{"type":"string","example":"2017-08-03T20:29:28Z"},"updatedAt":{"type":"string","example":"2017-08-03T20:29:28Z"}}}},"metadata":{"type":"object","properties":{"key":{"type":"string","example":"value"}}}}},{"title":"Contrato novo - PF","type":"object","properties":{"id":{"type":"string","example":"re_clt7l11wu03cl019tj3frja7x"},"name":{"type":"string","example":"Antonio da Silva"},"email":{"type":"string","example":"tstark@avengers.com"},"code":{"type":"string","example":"2c0b5b0b-7be5-4a29-b26d-12dd7ed71311"},"document":{"type":"string","example":"26224451990"},"type":{"type":"string","example":"individual"},"payment_mode":{"type":"string","example":"bank_transfer"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2024-02-29T18:51:57Z"},"updated_at":{"type":"string","example":"2024-02-29T18:51:57Z"},"transfer_settings":{"type":"object","properties":{"transfer_enabled":{"type":"boolean","example":true,"default":true},"transfer_interval":{"type":"string","example":"Weekly"},"transfer_day":{"type":"integer","example":1,"default":0}}},"default_bank_account":{"type":"object","properties":{"id":{"type":"string","example":"ba_dO5X325CBHr3QYe9"},"holder_name":{"type":"string","example":"Tony Stark"},"holder_type":{"type":"string","example":"individual"},"holder_document":{"type":"string","example":"26224451990"},"bank":{"type":"string","example":"341"},"branch_number":{"type":"string","example":"1234"},"branch_check_digit":{"type":"string","example":"6"},"account_number":{"type":"string","example":"12345"},"account_check_digit":{"type":"string","example":"6"},"type":{"type":"string","example":"checking"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2024-02-29T18:51:57Z"},"updated_at":{"type":"string","example":"2024-02-29T18:51:57Z"},"metadata":{"type":"object","properties":{"key":{"type":"string","example":"value"}}}}},"gateway_recipients":{"type":"array","items":{"type":"object","properties":{"gateway":{"type":"string","example":"pagarme"},"status":{"type":"string","example":"active"},"pgid":{"type":"string","example":"re_clt7l11wu03cl019tj3frja7x"},"createdAt":{"type":"string","example":"2024-02-29T18:51:58Z"},"updatedAt":{"type":"string","example":"2024-02-29T18:51:58Z"}}}},"automatic_anticipation_settings":{"type":"object","properties":{"enabled":{"type":"boolean","example":false,"default":true},"type":{"type":"string","example":"full"},"volume_percentage":{"type":"integer","example":0,"default":0},"delay":{"type":"integer","example":365,"default":0}}},"metadata":{"type":"object","properties":{"key":{"type":"string","example":"value"}}},"register_information":{"type":"object","properties":{"email":{"type":"string","example":"tstark@avengers.com"},"document":{"type":"string","example":"26224451990"},"type":{"type":"string","example":"individual"},"site_url":{"type":"string","example":"http://www.site.com"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"ddd":{"type":"string","example":"77"},"number":{"type":"string","example":"987655432"},"type":{"type":"string","example":"mobile"}}}},"name":{"type":"string","example":"Antonio da Silva"},"mother_name":{"type":"string","example":"Maria da Silva"},"birthdate":{"type":"string","example":"02/10/1990"},"monthly_income":{"type":"string","example":"300000"},"professional_occupation":{"type":"string","example":"Professor"},"address":{"type":"object","properties":{"street":{"type":"string","example":"Rua Alberto Carvalho"},"complementary":{"type":"string","example":"Apto. 345"},"street_number":{"type":"string","example":"111"},"neighborhood":{"type":"string","example":"Gomes Pereira"},"city":{"type":"string","example":"Porto Seguro"},"state":{"type":"string","example":"BA"},"zip_code":{"type":"string","example":"44900000"},"reference_point":{"type":"string","example":"Próximo ao Posto Quatro Rodas"}}}}}}},{"title":"Contrato novo - PJ","type":"object","properties":{"id":{"type":"string","example":"re_clt7md7ej03th019tm0n4c1ct"},"name":{"type":"string","example":"Jorge e Isabel Publicidade e Propaganda"},"email":{"type":"string","example":"teste@teste.com"},"code":{"type":"string","example":"2c0b5b0b-7be5-4a29-b26d-12dd7ed713e0"},"document":{"type":"string","example":"27123482000123"},"type":{"type":"string","example":"company"},"payment_mode":{"type":"string","example":"bank_transfer"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2024-02-29T19:29:24Z"},"updated_at":{"type":"string","example":"2024-02-29T19:29:24Z"},"transfer_settings":{"type":"object","properties":{"transfer_enabled":{"type":"boolean","example":true,"default":true},"transfer_interval":{"type":"string","example":"Weekly"},"transfer_day":{"type":"integer","example":1,"default":0}}},"default_bank_account":{"type":"object","properties":{"id":{"type":"string","example":"ba_301y9evH6NIgy6rl"},"holder_name":{"type":"string","example":"Tony Stark"},"holder_type":{"type":"string","example":"individual"},"holder_document":{"type":"string","example":"27123482000123"},"bank":{"type":"string","example":"341"},"branch_number":{"type":"string","example":"1234"},"branch_check_digit":{"type":"string","example":"6"},"account_number":{"type":"string","example":"12345"},"account_check_digit":{"type":"string","example":"6"},"type":{"type":"string","example":"checking"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2024-02-29T19:29:24Z"},"updated_at":{"type":"string","example":"2024-02-29T19:29:24Z"},"metadata":{"type":"object","properties":{"key":{"type":"string","example":"value"}}}}},"gateway_recipients":{"type":"array","items":{"type":"object","properties":{"gateway":{"type":"string","example":"pagarme"},"status":{"type":"string","example":"active"},"pgid":{"type":"string","example":"re_clt7md7ej03th019tm0n4c1ct"},"createdAt":{"type":"string","example":"2024-02-29T19:29:24Z"},"updatedAt":{"type":"string","example":"2024-02-29T19:29:24Z"}}}},"automatic_anticipation_settings":{"type":"object","properties":{"enabled":{"type":"boolean","example":false,"default":true},"type":{"type":"string","example":"full"},"volume_percentage":{"type":"integer","example":0,"default":0},"delay":{"type":"integer","example":365,"default":0}}},"metadata":{"type":"object","properties":{"key":{"type":"string","example":"value"}}},"register_information":{"type":"object","properties":{"email":{"type":"string","example":"teste@teste.com"},"document":{"type":"string","example":"27123482000123"},"type":{"type":"string","example":"corporation"},"site_url":{"type":"string","example":"http://www.site.com"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"ddd":{"type":"string","example":"71"},"number":{"type":"string","example":"99999999"},"type":{"type":"string","example":"mobile"}}}},"company_name":{"type":"string","example":"Jorge e Isabel Publicidade e Propaganda"},"trading_name":{"type":"string","example":"Jorge e Isabel Publicidade e Propaganda ME"},"annual_revenue":{"type":"string","example":"100000000"},"founding_date":{"type":"string","example":"10/10/2010"},"cnae":{"type":"string","example":"4651-6/01"},"main_address":{"type":"object","properties":{"street":{"type":"string","example":"Av.Santos Lopes"},"complementary":{"type":"string","example":"Apto. 104"},"street_number":{"type":"string","example":"189"},"neighborhood":{"type":"string","example":"Centro"},"city":{"type":"string","example":"Irecê"},"state":{"type":"string","example":"BA"},"zip_code":{"type":"string","example":"44900000"},"reference_point":{"type":"string","example":"Em frente ao clube de tiro 1910"}}},"managing_partners":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"João da Silva"},"email":{"type":"string","example":"teste@teste.com"},"document":{"type":"string","example":"26224451990"},"type":{"type":"string","example":"individual"},"birthdate":{"type":"string","example":"10/02/1995"},"monthly_income":{"type":"string","example":"300000"},"professional_occupation":{"type":"string","example":"Professor"},"self_declared_representative":{"type":"boolean","example":true,"default":true},"address":{"type":"object","properties":{"street":{"type":"string","example":"Av.Santos Lopes"},"complementary":{"type":"string","example":"Apto. 104"},"street_number":{"type":"string","example":"189"},"neighborhood":{"type":"string","example":"Centro"},"city":{"type":"string","example":"Irecê"},"state":{"type":"string","example":"BA"},"zip_code":{"type":"string","example":"44900000"},"reference_point":{"type":"string","example":"Em frente ao clube de tiro 1910"}}},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"ddd":{"type":"string","example":"71"},"number":{"type":"string","example":"99999999"},"type":{"type":"string","example":"mobile"}}}}}}}}}}}]}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/recipients/{recipient_id}/code":{"patch":{"summary":"Editar code de recebedor","description":"","operationId":"atualizar-code-de-recebedor","parameters":[{"name":"recipient_id","in":"path","description":"Identificador do recebedor","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["Code"],"properties":{"Code":{"type":"string","description":"Referencia externa única por recebedor"}}},"examples":{"Request Example":{"value":{"code":"123"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"rp_23452cBK6lP\",\n \"name\": \"Tony Stark\",\n \"email\": \"tstark@avengers.com\",\n \"document\": \"223451990\",\n \"description\": \"Recebedor Tony Stark\",\n \"type\": \"individual\",\n \"status\": \"active\",\n \"created_at\": \"2018-05-23T16:17:39Z\",\n \"updated_at\": \"2018-05-23T16:17:39Z\",\n \"code\": \"123\",\n \"transfer_settings\": {\n \"transfer_enabled\": false,\n \"transfer_interval\": \"Daily\",\n \"transfer_day\": 0\n },\n \"default_bank_account\": {\n \"id\": \"ba_2LYnR234Og\",\n \"holder_name\": \"Tony Stark\",\n \"holder_type\": \"individual\",\n \"holder_document\": \"26224451990\",\n \"bank\": \"341\",\n \"branch_number\": \"12345\",\n \"branch_check_digit\": \"6\",\n \"account_number\": \"12345\",\n \"account_check_digit\": \"6\",\n \"type\": \"checking\",\n \"status\": \"active\",\n \"created_at\": \"2018-05-23T16:17:40Z\",\n \"updated_at\": \"2018-05-23T16:17:40Z\",\n \"metadata\": {\n \"key\": \"value\"\n }\n },\n \"automatic_anticipation_settings\": {\n \"enabled\": true,\n \"type\": \"full\",\n \"volume_percentage\": 50,\n \"delay\": 365,\n \"days\": [\n 1,\n 3,\n 5\n ]\n },\n \"gateway_recipients\": [\n {\n \"gateway\": \"pagarme\",\n \"status\": \"active\",\n \"pgid\": \"re_cjhjb34244o9jw6dyx5aizxn\",\n \"createdAt\": \"2018-05-23T16:17:45Z\",\n \"updatedAt\": \"2018-05-23T16:17:45Z\"\n }\n ],\n \"metadata\": {\n \"key\": \"value\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"rp_23452cBK6lP"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"tstark@avengers.com"},"document":{"type":"string","example":"223451990"},"description":{"type":"string","example":"Recebedor Tony Stark"},"type":{"type":"string","example":"individual"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2018-05-23T16:17:39Z"},"updated_at":{"type":"string","example":"2018-05-23T16:17:39Z"},"code":{"type":"string","example":"123"},"transfer_settings":{"type":"object","properties":{"transfer_enabled":{"type":"boolean","example":false,"default":true},"transfer_interval":{"type":"string","example":"Daily"},"transfer_day":{"type":"integer","example":0,"default":0}}},"default_bank_account":{"type":"object","properties":{"id":{"type":"string","example":"ba_2LYnR234Og"},"holder_name":{"type":"string","example":"Tony Stark"},"holder_type":{"type":"string","example":"individual"},"holder_document":{"type":"string","example":"26224451990"},"bank":{"type":"string","example":"341"},"branch_number":{"type":"string","example":"12345"},"branch_check_digit":{"type":"string","example":"6"},"account_number":{"type":"string","example":"12345"},"account_check_digit":{"type":"string","example":"6"},"type":{"type":"string","example":"checking"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2018-05-23T16:17:40Z"},"updated_at":{"type":"string","example":"2018-05-23T16:17:40Z"},"metadata":{"type":"object","properties":{"key":{"type":"string","example":"value"}}}}},"automatic_anticipation_settings":{"type":"object","properties":{"enabled":{"type":"boolean","example":true,"default":true},"type":{"type":"string","example":"full"},"volume_percentage":{"type":"integer","example":50,"default":0},"delay":{"type":"integer","example":365,"default":0},"days":{"type":"array","items":{"type":"integer","example":1,"default":0}}}},"gateway_recipients":{"type":"array","items":{"type":"object","properties":{"gateway":{"type":"string","example":"pagarme"},"status":{"type":"string","example":"active"},"pgid":{"type":"string","example":"re_cjhjb34244o9jw6dyx5aizxn"},"createdAt":{"type":"string","example":"2018-05-23T16:17:45Z"},"updatedAt":{"type":"string","example":"2018-05-23T16:17:45Z"}}}},"metadata":{"type":"object","properties":{"key":{"type":"string","example":"value"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/recipients/{recipient_id}/default-bank-account":{"patch":{"summary":"Atualizar conta bancária do recebedor","description":"","operationId":"atualizar-conta-bancária-do-recebedor-1","parameters":[{"name":"recipient_id","in":"path","description":"Código do recebedor","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["bank_account"],"properties":{"bank_account":{"type":"object","description":"Dados da conta bancária","required":["holder_name","holder_type","holder_document","bank","branch_number","account_number","account_check_digit","type"],"properties":{"holder_name":{"type":"string","description":"Nome do titular da conta."},"holder_type":{"type":"string","description":"Tipo de titular. Valores possíveis são **individual** (pessoa física) ou **company** (pessoa jurídica)."},"holder_document":{"type":"string","description":"Número do documento do titular da conta. Deve ser igual ao documento do recebedor."},"bank":{"type":"string","description":"Código do banco."},"branch_number":{"type":"string","description":"Número da agência."},"branch_check_digit":{"type":"string","description":"Código verificador da agência."},"account_number":{"type":"string","description":"Número da conta. Máximo 13 caracteres numéricos"},"account_check_digit":{"type":"string","description":"Código verificador da conta."},"type":{"type":"string","description":"Tipo da conta. Valores possíveis são **checking** ou **savings**."},"metadata":{"type":"object","description":"Objeto chave/valor utilizado para armazenar informações adicionais sobre a conta bancária.","properties":{}}}}}},"examples":{"Request Example":{"value":{"bank_account":{"holder_name":"Tony Stark","holder_type":"individual","holder_document":"26224451990","bank":"341","branch_number":"1234","branch_check_digit":"6","account_number":"12345","account_check_digit":"6","type":"checking","metadata":{"meta_key":"meta_value"}}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"rp_Gxb5NJNiqvf0Y5Xv\",\n \"name\": \"Tony Stark\",\n \"email\": \"tstark@avengers.com\",\n \"document\": \"26224451990\",\n \"description\": \"Recebedor Tony Stark\",\n \"type\": \"individual\",\n \"status\": \"active\",\n \"created_at\": \"2017-10-27T16:12:37Z\",\n \"updated_at\": \"2017-10-27T16:12:37Z\",\n \"default_bank_account\": {\n \"id\": \"ba_KOoYDmEHvIEYD6v3\",\n \"holder_name\": \"Tony Stark\",\n \"holder_type\": \"individual\",\n \"holder_document\": \"26224451990\",\n \"bank\": \"341\",\n \"branch_number\": \"1234\",\n \"branch_check_digit\": \"6\",\n \"account_number\": \"12345\",\n \"account_check_digit\": \"6\",\n \"type\": \"checking\",\n \"status\": \"active\",\n \"created_at\": \"2017-10-27T19:03:21Z\",\n \"updated_at\": \"2017-10-27T19:03:21Z\",\n \"metadata\": {\n \"meta_key\": \"meta_value\"\n }\n },\n \"gateway_recipients\": [\n {\n \"gateway\": \"pagarme\",\n \"status\": \"active\",\n \"pgid\": \"re_cj9a3j9ok01275g6emauxwla8\",\n \"createdAt\": \"2017-10-27T16:12:38Z\",\n \"updatedAt\": \"2017-10-27T16:12:38Z\"\n }\n ],\n \"metadata\": {\n \"key\": \"value\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"rp_Gxb5NJNiqvf0Y5Xv"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"tstark@avengers.com"},"document":{"type":"string","example":"26224451990"},"description":{"type":"string","example":"Recebedor Tony Stark"},"type":{"type":"string","example":"individual"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-10-27T16:12:37Z"},"updated_at":{"type":"string","example":"2017-10-27T16:12:37Z"},"default_bank_account":{"type":"object","properties":{"id":{"type":"string","example":"ba_KOoYDmEHvIEYD6v3"},"holder_name":{"type":"string","example":"Tony Stark"},"holder_type":{"type":"string","example":"individual"},"holder_document":{"type":"string","example":"26224451990"},"bank":{"type":"string","example":"341"},"branch_number":{"type":"string","example":"1234"},"branch_check_digit":{"type":"string","example":"6"},"account_number":{"type":"string","example":"12345"},"account_check_digit":{"type":"string","example":"6"},"type":{"type":"string","example":"checking"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-10-27T19:03:21Z"},"updated_at":{"type":"string","example":"2017-10-27T19:03:21Z"},"metadata":{"type":"object","properties":{"meta_key":{"type":"string","example":"meta_value"}}}}},"gateway_recipients":{"type":"array","items":{"type":"object","properties":{"gateway":{"type":"string","example":"pagarme"},"status":{"type":"string","example":"active"},"pgid":{"type":"string","example":"re_cj9a3j9ok01275g6emauxwla8"},"createdAt":{"type":"string","example":"2017-10-27T16:12:38Z"},"updatedAt":{"type":"string","example":"2017-10-27T16:12:38Z"}}}},"metadata":{"type":"object","properties":{"key":{"type":"string","example":"value"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/recipients/{recipient_id}/balance":{"get":{"summary":"Obter saldo","description":"","operationId":"obter-saldo","parameters":[{"name":"recipient_id","in":"path","description":"Identificador do recebedor","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"currency\": \"BRL\",\n \"available_amount\": 0,\n \"waiting_funds_amount\": 0,\n \"transferred_amount\": 0,\n \"recipient\": {\n \"id\": \"rp_pVZR1qZi64F9bR5e\",\n \"name\": \"First recipient\",\n \"email\": \"first_recipient@pagar.me\",\n \"document\": \"12728994706\",\n \"description\": \"Descrição do recebedor 1\",\n \"type\": \"individual\",\n \"status\": \"active\",\n \"created_at\": \"2020-10-08T21:35:26Z\",\n \"updated_at\": \"2020-10-17T18:54:06Z\"\n }\n}"}},"schema":{"type":"object","properties":{"currency":{"type":"string","example":"BRL"},"available_amount":{"type":"integer","example":0,"default":0},"waiting_funds_amount":{"type":"integer","example":0,"default":0},"transferred_amount":{"type":"integer","example":0,"default":0},"recipient":{"type":"object","properties":{"id":{"type":"string","example":"rp_pVZR1qZi64F9bR5e"},"name":{"type":"string","example":"First recipient"},"email":{"type":"string","example":"first_recipient@pagar.me"},"document":{"type":"string","example":"12728994706"},"description":{"type":"string","example":"Descrição do recebedor 1"},"type":{"type":"string","example":"individual"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2020-10-08T21:35:26Z"},"updated_at":{"type":"string","example":"2020-10-17T18:54:06Z"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/recipients/{recipient_id}/withdrawals":{"post":{"summary":"Cria saque","description":"Rota para realizar o saque para uma **conta bancária** de um **recebedor**.","operationId":"cria-saque-1","parameters":[{"name":"recipient_id","in":"path","description":"Código do recebedor","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"amount":{"type":"integer","description":"Valor da cobrança em centavos","format":"int32"}}},"examples":{"Request Example":{"value":{"amount":100}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"with_LJ0OkmVcJCVPj4Yp\",\n \"amount\": 100,\n \"status\": \"failed\",\n \"created_at\": \"2020-01-16T16:36:39Z\",\n \"updated_at\": \"2020-01-16T16:36:39Z\",\n \"bank_account\": {\n \"id\": \"ba_jGXwbQtNASZZrdpE\",\n \"holder_name\": \"Second recipient\",\n \"holder_type\": \"company\",\n \"holder_document\": \"15313587000166\",\n \"bank\": \"341\",\n \"branch_number\": \"12345\",\n \"branch_check_digit\": \"6\",\n \"account_number\": \"12345\",\n \"account_check_digit\": \"6\",\n \"type\": \"checking\",\n \"status\": \"active\",\n \"created_at\": \"2020-01-02T20:23:17Z\",\n \"updated_at\": \"2020-01-02T20:23:17Z\",\n \"metadata\": {\n \"meta_key\": \"meta_value\"\n },\n \"recipient\": {\n \"id\": \"rp_yLnAyVpHbQIqZxwO\",\n \"name\": \"Second recipient\",\n \"email\": \"second_recipient@pagar.me\",\n \"document\": \"15313587000166\",\n \"description\": \"Descrição do recebedor 2\",\n \"type\": \"company\",\n \"status\": \"active\",\n \"created_at\": \"2020-01-02T20:23:17Z\",\n \"updated_at\": \"2020-01-02T20:23:17Z\"\n }\n }\n }"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"with_LJ0OkmVcJCVPj4Yp"},"amount":{"type":"integer","example":100,"default":0},"status":{"type":"string","example":"failed"},"created_at":{"type":"string","example":"2020-01-16T16:36:39Z"},"updated_at":{"type":"string","example":"2020-01-16T16:36:39Z"},"bank_account":{"type":"object","properties":{"id":{"type":"string","example":"ba_jGXwbQtNASZZrdpE"},"holder_name":{"type":"string","example":"Second recipient"},"holder_type":{"type":"string","example":"company"},"holder_document":{"type":"string","example":"15313587000166"},"bank":{"type":"string","example":"341"},"branch_number":{"type":"string","example":"12345"},"branch_check_digit":{"type":"string","example":"6"},"account_number":{"type":"string","example":"12345"},"account_check_digit":{"type":"string","example":"6"},"type":{"type":"string","example":"checking"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2020-01-02T20:23:17Z"},"updated_at":{"type":"string","example":"2020-01-02T20:23:17Z"},"metadata":{"type":"object","properties":{"meta_key":{"type":"string","example":"meta_value"}}},"recipient":{"type":"object","properties":{"id":{"type":"string","example":"rp_yLnAyVpHbQIqZxwO"},"name":{"type":"string","example":"Second recipient"},"email":{"type":"string","example":"second_recipient@pagar.me"},"document":{"type":"string","example":"15313587000166"},"description":{"type":"string","example":"Descrição do recebedor 2"},"type":{"type":"string","example":"company"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2020-01-02T20:23:17Z"},"updated_at":{"type":"string","example":"2020-01-02T20:23:17Z"}}}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"get":{"summary":"Listar saques","description":"Rota para realizar a consulta de saques para um determinado **recebedor**.","operationId":"listar-saques-1","parameters":[{"name":"recipient_id","in":"path","description":"Código do recebedor","schema":{"type":"string"},"required":true},{"name":"status","in":"query","description":"Filtro para o status da transferência","schema":{"type":"string"}},{"name":"created_since","in":"query","description":"Filtro para início do range da data de criação da transferência","schema":{"type":"string","format":"date"}},{"name":"created_until","in":"query","description":"Filtro para o fim do range da data de criação da transferência","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"[\n {\n \"id\": \"with_dADVpgxcmT0v5voP\",\n \"amount\": 100,\n \"status\": \"failed\",\n \"created_at\": \"2020-01-16T17:04:33Z\",\n \"updated_at\": \"2020-01-16T17:04:33Z\",\n \"bank_account\": {\n \"id\": \"ba_jGXwbQtNASZZrdpE\",\n \"holder_name\": \"Second recipient\",\n \"holder_type\": \"company\",\n \"holder_document\": \"15313587000166\",\n \"bank\": \"341\",\n \"branch_number\": \"12345\",\n \"branch_check_digit\": \"6\",\n \"account_number\": \"12345\",\n \"account_check_digit\": \"6\",\n \"type\": \"checking\",\n \"status\": \"active\",\n \"created_at\": \"2020-01-02T20:23:17Z\",\n \"updated_at\": \"2020-01-02T20:23:17Z\",\n \"metadata\": {\n \"meta_key\": \"meta_value\"\n },\n \"recipient\": {\n \"id\": \"rp_yLnAyVpHbQIqZxwO\",\n \"name\": \"Second recipient\",\n \"email\": \"second_recipient@pagar.me\",\n \"document\": \"15313587000166\",\n \"description\": \"Descrição do recebedor 2\",\n \"type\": \"company\",\n \"status\": \"active\",\n \"created_at\": \"2020-01-02T20:23:17Z\",\n \"updated_at\": \"2020-01-02T20:23:17Z\"\n }\n }\n },\n {\n \"id\": \"with_rax8WlIjeHXxwe6z\",\n \"amount\": 100,\n \"status\": \"failed\",\n \"created_at\": \"2020-01-16T17:04:23Z\",\n \"updated_at\": \"2020-01-16T17:04:23Z\",\n \"bank_account\": {\n \"id\": \"ba_jGXwbQtNASZZrdpE\",\n \"holder_name\": \"Second recipient\",\n \"holder_type\": \"company\",\n \"holder_document\": \"15313587000166\",\n \"bank\": \"341\",\n \"branch_number\": \"12345\",\n \"branch_check_digit\": \"6\",\n \"account_number\": \"12345\",\n \"account_check_digit\": \"6\",\n \"type\": \"checking\",\n \"status\": \"active\",\n \"created_at\": \"2020-01-02T20:23:17Z\",\n \"updated_at\": \"2020-01-02T20:23:17Z\",\n \"metadata\": {\n \"meta_key\": \"meta_value\"\n },\n \"recipient\": {\n \"id\": \"rp_yLnAyVpHbQIqZxwO\",\n \"name\": \"Second recipient\",\n \"email\": \"second_recipient@pagar.me\",\n \"document\": \"15313587000166\",\n \"description\": \"Descrição do recebedor 2\",\n \"type\": \"company\",\n \"status\": \"active\",\n \"created_at\": \"2020-01-02T20:23:17Z\",\n \"updated_at\": \"2020-01-02T20:23:17Z\"\n }\n }\n }\n]"}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/recipients/{recipient_id}/withdrawals/{withdrawals_id}":{"get":{"summary":"Obter saque","description":"Rota para realizar a consulta de um saque específico.","operationId":"obter-saque-1","parameters":[{"name":"recipient_id","in":"path","description":"Código do recebedor","schema":{"type":"string"},"required":true},{"name":"withdrawals_id","in":"path","description":"Código da transferência","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"transf_1A68BR3izKHz8Zqr\",\n \"amount\": 100,\n \"status\": \"pending\",\n \"created_at\": \"2017-10-27T16:12:56Z\",\n \"updated_at\": \"2017-10-27T16:12:57Z\",\n \"bank_account\": {\n \"id\": \"ba_A2Np1QJSyTRXp5mE\",\n \"holder_name\": \"Tony Stark\",\n \"holder_type\": \"individual\",\n \"holder_document\": \"26224451990\",\n \"bank\": \"341\",\n \"branch_number\": \"12345\",\n \"branch_check_digit\": \"6\",\n \"account_number\": \"12345\",\n \"account_check_digit\": \"6\",\n \"type\": \"checking\",\n \"status\": \"active\",\n \"created_at\": \"2017-10-27T16:12:37Z\",\n \"updated_at\": \"2017-10-27T16:12:37Z\",\n \"metadata\": {\n \"key\": \"value\"\n },\n \"recipient\": {\n \"id\": \"rp_Acb5NJNiqvf0Y5Xv\",\n \"name\": \"Tony Stark\",\n \"email\": \"tstark@avengers.com\",\n \"document\": \"26224451990\",\n \"description\": \"Recebedor Tony Stark\",\n \"type\": \"individual\",\n \"status\": \"active\",\n \"created_at\": \"2017-10-27T16:12:37Z\",\n \"updated_at\": \"2017-10-27T16:12:37Z\"\n }\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"transf_1A68BR3izKHz8Zqr"},"amount":{"type":"integer","example":100,"default":0},"status":{"type":"string","example":"pending"},"created_at":{"type":"string","example":"2017-10-27T16:12:56Z"},"updated_at":{"type":"string","example":"2017-10-27T16:12:57Z"},"bank_account":{"type":"object","properties":{"id":{"type":"string","example":"ba_A2Np1QJSyTRXp5mE"},"holder_name":{"type":"string","example":"Tony Stark"},"holder_type":{"type":"string","example":"individual"},"holder_document":{"type":"string","example":"26224451990"},"bank":{"type":"string","example":"341"},"branch_number":{"type":"string","example":"12345"},"branch_check_digit":{"type":"string","example":"6"},"account_number":{"type":"string","example":"12345"},"account_check_digit":{"type":"string","example":"6"},"type":{"type":"string","example":"checking"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-10-27T16:12:37Z"},"updated_at":{"type":"string","example":"2017-10-27T16:12:37Z"},"metadata":{"type":"object","properties":{"key":{"type":"string","example":"value"}}},"recipient":{"type":"object","properties":{"id":{"type":"string","example":"rp_Acb5NJNiqvf0Y5Xv"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"tstark@avengers.com"},"document":{"type":"string","example":"26224451990"},"description":{"type":"string","example":"Recebedor Tony Stark"},"type":{"type":"string","example":"individual"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-10-27T16:12:37Z"},"updated_at":{"type":"string","example":"2017-10-27T16:12:37Z"}}}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/recipients/{recipient_id}/transfer-settings":{"patch":{"summary":"Atualizar configurações de transferência","description":"","operationId":"atualizar-informações-de-transferência-1","parameters":[{"name":"recipient_id","in":"path","description":"Identificador do recebedor","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["transfer_enabled","transfer_interval","transfer_day"],"properties":{"transfer_enabled":{"type":"boolean","description":"Variável que indica se o recebedor irá receber os transferências automaticamente."},"transfer_interval":{"type":"string","description":"Frequência na qual o recebedor irá receber transferências. Valores possíveis: daily, weekly, monthly"},"transfer_day":{"type":"integer","description":"Dia no qual o recebedor vai receber a transferência. Depende do transfer_interval. Se for daily, é necessário informar 0. Se for weekly pode ser de 1 (segunda) a 5 (sexta). Se for monthly, pode ser de 1 a 31.","format":"int32"}}},"examples":{"Request Example":{"value":{"transfer_enabled":false,"transfer_interval":"Daily","transfer_day":0}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"rp_23452cBK6lP\",\n \"name\": \"Tony Stark\",\n \"email\": \"tstark@avengers.com\",\n \"document\": \"223451990\",\n \"description\": \"Recebedor Tony Stark\",\n \"type\": \"individual\",\n \"status\": \"active\",\n \"created_at\": \"2018-05-23T16:17:39Z\",\n \"updated_at\": \"2018-05-23T16:17:39Z\",\n \"transfer_settings\": {\n \"transfer_enabled\": false,\n \"transfer_interval\": \"Daily\",\n \"transfer_day\": 0\n },\n \"default_bank_account\": {\n \"id\": \"ba_2LYnR234Og\",\n \"holder_name\": \"Tony Stark\",\n \"holder_type\": \"individual\",\n \"holder_document\": \"26224451990\",\n \"bank\": \"341\",\n \"branch_number\": \"12345\",\n \"branch_check_digit\": \"6\",\n \"account_number\": \"12345\",\n \"account_check_digit\": \"6\",\n \"type\": \"checking\",\n \"status\": \"active\",\n \"created_at\": \"2018-05-23T16:17:40Z\",\n \"updated_at\": \"2018-05-23T16:17:40Z\",\n \"metadata\": {\n \"key\": \"value\"\n }\n },\n \"gateway_recipients\": [\n {\n \"gateway\": \"pagarme\",\n \"status\": \"active\",\n \"pgid\": \"re_cjhjb34244o9jw6dyx5aizxn\",\n \"createdAt\": \"2018-05-23T16:17:45Z\",\n \"updatedAt\": \"2018-05-23T16:17:45Z\"\n }\n ],\n \"metadata\": {\n \"key\": \"value\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"rp_23452cBK6lP"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"tstark@avengers.com"},"document":{"type":"string","example":"223451990"},"description":{"type":"string","example":"Recebedor Tony Stark"},"type":{"type":"string","example":"individual"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2018-05-23T16:17:39Z"},"updated_at":{"type":"string","example":"2018-05-23T16:17:39Z"},"transfer_settings":{"type":"object","properties":{"transfer_enabled":{"type":"boolean","example":false,"default":true},"transfer_interval":{"type":"string","example":"Daily"},"transfer_day":{"type":"integer","example":0,"default":0}}},"default_bank_account":{"type":"object","properties":{"id":{"type":"string","example":"ba_2LYnR234Og"},"holder_name":{"type":"string","example":"Tony Stark"},"holder_type":{"type":"string","example":"individual"},"holder_document":{"type":"string","example":"26224451990"},"bank":{"type":"string","example":"341"},"branch_number":{"type":"string","example":"12345"},"branch_check_digit":{"type":"string","example":"6"},"account_number":{"type":"string","example":"12345"},"account_check_digit":{"type":"string","example":"6"},"type":{"type":"string","example":"checking"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2018-05-23T16:17:40Z"},"updated_at":{"type":"string","example":"2018-05-23T16:17:40Z"},"metadata":{"type":"object","properties":{"key":{"type":"string","example":"value"}}}}},"gateway_recipients":{"type":"array","items":{"type":"object","properties":{"gateway":{"type":"string","example":"pagarme"},"status":{"type":"string","example":"active"},"pgid":{"type":"string","example":"re_cjhjb34244o9jw6dyx5aizxn"},"createdAt":{"type":"string","example":"2018-05-23T16:17:45Z"},"updatedAt":{"type":"string","example":"2018-05-23T16:17:45Z"}}}},"metadata":{"type":"object","properties":{"key":{"type":"string","example":"value"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/recipients/{recipient_id}/automatic-anticipation-settings":{"patch":{"summary":"Atualizar configurações de antecipação automática","description":"","operationId":"atualizar-informações-de-antecipação-automática-1","parameters":[{"name":"recipient_id","in":"path","description":"Identificador do recebedor","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Variável que indica se o recebedor irá possuir antecipação automaticamentica.","default":false},"type":{"type":"string","description":"Configuração de como devemos criar as antecipações automáticas do recebedor. Valores possíveis full e 1025. Se informado full será criada antecipações seguindo a regra de volume máximo antecipável. Se informado 1025 será criada antecipações de vendas inteiras, modelos D+X e 10/25.","default":"full"},"volume_percentage":{"type":"string","description":"Porcentagem do valor passível de antecipação para este recebedor. Valores entre 0 e 100."},"days":{"type":"array","description":"Lista de dias em que serão criar as antecipações automáticas. Valores possíveis de 1 a 31, necessário informar entre chaves\"[ ]\"","items":{"type":"string"}},"delay":{"type":"string","description":"Quantidade de dias, contados a partir do dia da antecipação para trás, que serão desconsiderados na criação desta antecipação"}}},"examples":{"Request Example":{"value":{"enabled":true,"type":"full","volume_percentage":"50","days":[1,3,5],"delay":null}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"rp_23452cBK6lP\",\n \"name\": \"Tony Stark\",\n \"email\": \"tstark@avengers.com\",\n \"document\": \"223451990\",\n \"description\": \"Recebedor Tony Stark\",\n \"type\": \"individual\",\n \"status\": \"active\",\n \"created_at\": \"2018-05-23T16:17:39Z\",\n \"updated_at\": \"2018-05-23T16:17:39Z\",\n \"transfer_settings\": {\n \"transfer_enabled\": false,\n \"transfer_interval\": \"Daily\",\n \"transfer_day\": 0\n },\n \"default_bank_account\": {\n \"id\": \"ba_2LYnR234Og\",\n \"holder_name\": \"Tony Stark\",\n \"holder_type\": \"individual\",\n \"holder_document\": \"26224451990\",\n \"bank\": \"341\",\n \"branch_number\": \"12345\",\n \"branch_check_digit\": \"6\",\n \"account_number\": \"12345\",\n \"account_check_digit\": \"6\",\n \"type\": \"checking\",\n \"status\": \"active\",\n \"created_at\": \"2018-05-23T16:17:40Z\",\n \"updated_at\": \"2018-05-23T16:17:40Z\",\n \"metadata\": {\n \"key\": \"value\"\n }\n },\n \"automatic_anticipation_settings\": {\n \"enabled\": true,\n \"type\": \"full\",\n \"volume_percentage\": 50,\n \"delay\": 365,\n \"days\": [\n 1,\n 3,\n 5\n ]\n },\n \"gateway_recipients\": [\n {\n \"gateway\": \"pagarme\",\n \"status\": \"active\",\n \"pgid\": \"re_cjhjb34244o9jw6dyx5aizxn\",\n \"createdAt\": \"2018-05-23T16:17:45Z\",\n \"updatedAt\": \"2018-05-23T16:17:45Z\"\n }\n ],\n \"metadata\": {\n \"key\": \"value\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"rp_23452cBK6lP"},"name":{"type":"string","example":"Tony Stark"},"email":{"type":"string","example":"tstark@avengers.com"},"document":{"type":"string","example":"223451990"},"description":{"type":"string","example":"Recebedor Tony Stark"},"type":{"type":"string","example":"individual"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2018-05-23T16:17:39Z"},"updated_at":{"type":"string","example":"2018-05-23T16:17:39Z"},"transfer_settings":{"type":"object","properties":{"transfer_enabled":{"type":"boolean","example":false,"default":true},"transfer_interval":{"type":"string","example":"Daily"},"transfer_day":{"type":"integer","example":0,"default":0}}},"default_bank_account":{"type":"object","properties":{"id":{"type":"string","example":"ba_2LYnR234Og"},"holder_name":{"type":"string","example":"Tony Stark"},"holder_type":{"type":"string","example":"individual"},"holder_document":{"type":"string","example":"26224451990"},"bank":{"type":"string","example":"341"},"branch_number":{"type":"string","example":"12345"},"branch_check_digit":{"type":"string","example":"6"},"account_number":{"type":"string","example":"12345"},"account_check_digit":{"type":"string","example":"6"},"type":{"type":"string","example":"checking"},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2018-05-23T16:17:40Z"},"updated_at":{"type":"string","example":"2018-05-23T16:17:40Z"},"metadata":{"type":"object","properties":{"key":{"type":"string","example":"value"}}}}},"automatic_anticipation_settings":{"type":"object","properties":{"enabled":{"type":"boolean","example":true,"default":true},"type":{"type":"string","example":"full"},"volume_percentage":{"type":"integer","example":50,"default":0},"delay":{"type":"integer","example":365,"default":0},"days":{"type":"array","items":{"type":"integer","example":1,"default":0}}}},"gateway_recipients":{"type":"array","items":{"type":"object","properties":{"gateway":{"type":"string","example":"pagarme"},"status":{"type":"string","example":"active"},"pgid":{"type":"string","example":"re_cjhjb34244o9jw6dyx5aizxn"},"createdAt":{"type":"string","example":"2018-05-23T16:17:45Z"},"updatedAt":{"type":"string","example":"2018-05-23T16:17:45Z"}}}},"metadata":{"type":"object","properties":{"key":{"type":"string","example":"value"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/payables":{"get":{"summary":"Obter recebíveis","description":"Retorna os recebíveis da sua loja.","operationId":"retornando-recebíveis","parameters":[{"name":"created_since","in":"query","description":"Filtro pela data de criação do recebível como data de partida. Quando não informado, o padrão é a data atual menos 6 meses","schema":{"type":"string","format":"date","default":""}},{"name":"created_until","in":"query","description":"Filtro pela data de criação do recebível como data limite","schema":{"type":"string","format":"date"}},{"name":"status","in":"query","description":"Filtro pelo status do recebível, `paid` ou `waiting_funds`","schema":{"type":"string"}},{"name":"payment_date_since","in":"query","description":"Filtro pela data de pagamento do recebível, como data de partida","schema":{"type":"string","format":"date"}},{"name":"payment_date_until","in":"query","description":"Filtro pela data de pagamento do recebível, como data limite","schema":{"type":"string","format":"date"}},{"name":"type","in":"query","description":"Filtro pelo type do recebível. Pode ser `chargeback`, `refund`, `chargeback_refund` ou `credit`","schema":{"type":"string"}},{"name":"updated_since","in":"query","description":"Filtro pela data de atualização do recebível, como data de partida","schema":{"type":"string","format":"date"}},{"name":"updated_until","in":"query","description":"Filtro pela data de atualização do recebível, como data limite","schema":{"type":"string","format":"date"}},{"name":"charge_id","in":"query","description":"Filtro pelo código da cobrança","schema":{"type":"string"}},{"name":"recipient_id","in":"query","description":"Filtro pelo código do recebedor","schema":{"type":"string"}},{"name":"split_id","in":"query","description":"Filtro pelo identificador da regra de split","schema":{"type":"string"}},{"name":"id","in":"query","description":"Filtro pelo identificador do recebível","schema":{"type":"string"}},{"name":"size","in":"query","description":"Filtro pela quantidade de objetos retornados. Deve ser menor ou igual a 1000","schema":{"type":"integer","format":"int32"}},{"name":"page","in":"query","description":"Filtro pela página de retorno. Utilize o parâmetro `forward_cursor` para paginação","deprecated":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"forward_cursor","schema":{"type":"string"},"required":false,"description":"Cursor para retorno da próxima página, seu valor é retornado no corpo da resposta em `paging.forward_cursor`"}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Cobranças pós 01/07/23":{"value":"{\n \"data\": [\n {\n \"id\": 4304241393,\n \"status\": \"waiting_funds\",\n \"amount\": 3090,\n \"fee\": 155,\n \"anticipation_fee\": 0,\n \"fraud_coverage_fee\": 0,\n \"installment\": 1,\n \"gateway_id\": 23879573,\n \"charge_id\": \"ch_xj9w8g8CEdhOX0BM\",\n \"recipient_id\": \"re_cjlnpqrq0006vn56e1nig0tcv\",\n \"payment_date\": \"2023-08-03T03:00:00Z\",\n \"type\": \"credit\",\n \"payment_method\": \"credit_card\",\n \"accrual_at\": \"2023-07-03T13:06:21Z\",\n \"created_at\": \"2023-07-03T13:06:22Z\"\n },\n {\n \"id\": 4304239592,\n \"status\": \"waiting_funds\",\n \"amount\": 3798,\n \"fee\": 190,\n \"anticipation_fee\": 0,\n \"fraud_coverage_fee\": 0,\n \"installment\": 2,\n \"gateway_id\": 23876873,\n \"charge_id\": \"ch_mz7LoQhYpidoJO5B\",\n \"recipient_id\": \"re_cjlnpqrq0006vn56e1nig0tcv\",\n \"payment_date\": \"2023-09-04T03:00:00Z\",\n \"type\": \"credit\",\n \"payment_method\": \"credit_card\",\n \"accrual_at\": \"2023-07-03T05:34:28Z\",\n \"created_at\": \"2023-07-03T05:34:35Z\"\n },\n {\n \"id\": 4304239591,\n \"status\": \"waiting_funds\",\n \"amount\": 3798,\n \"fee\": 190,\n \"anticipation_fee\": 0,\n \"fraud_coverage_fee\": 0,\n \"installment\": 3,\n \"gateway_id\": 23876873,\n \"charge_id\": \"ch_mz7LoQhYpidoJO5B\",\n \"recipient_id\": \"re_cjlnpqrq0006vn56e1nig0tcv\",\n \"payment_date\": \"2023-10-03T03:00:00Z\",\n \"type\": \"credit\",\n \"payment_method\": \"credit_card\",\n \"accrual_at\": \"2023-07-03T05:34:28Z\",\n \"created_at\": \"2023-07-03T05:34:35Z\"\n },\n {\n \"id\": 4304239590,\n \"status\": \"waiting_funds\",\n \"amount\": 3798,\n \"fee\": 190,\n \"anticipation_fee\": 0,\n \"fraud_coverage_fee\": 0,\n \"installment\": 4,\n \"gateway_id\": 23876873,\n \"charge_id\": \"ch_mz7LoQhYpidoJO5B\",\n \"recipient_id\": \"re_cjlnpqrq0006vn56e1nig0tcv\",\n \"payment_date\": \"2023-11-01T03:00:00Z\",\n \"type\": \"credit\",\n \"payment_method\": \"credit_card\",\n \"accrual_at\": \"2023-07-03T05:34:28Z\",\n \"created_at\": \"2023-07-03T05:34:35Z\"\n },\n {\n \"id\": 4304239589,\n \"status\": \"waiting_funds\",\n \"amount\": 3798,\n \"fee\": 190,\n \"anticipation_fee\": 0,\n \"fraud_coverage_fee\": 0,\n \"installment\": 5,\n \"gateway_id\": 23876873,\n \"charge_id\": \"ch_mz7LoQhYpidoJO5B\",\n \"recipient_id\": \"re_cjlnpqrq0006vn56e1nig0tcv\",\n \"payment_date\": \"2023-12-01T03:00:00Z\",\n \"type\": \"credit\",\n \"payment_method\": \"credit_card\",\n \"accrual_at\": \"2023-07-03T05:34:28Z\",\n \"created_at\": \"2023-07-03T05:34:35Z\"\n }\n ],\n \"paging\": {}\n}"},"Cobranças pré 01/07/23":{"value":"{\n \"data\": [\n {\n \"id\": 4304198148,\n \"status\": \"waiting_funds\",\n \"amount\": 927,\n \"fee\": 0,\n \"anticipation_fee\": 0,\n \"fraud_coverage_fee\": 0,\n \"installment\": 1,\n \"gateway_id\": 23833759,\n \"split_id\": \"sr_cljh854vb03tf019thoelps6p\",\n \"recipient_id\": \"re_clfj3jwyj051k019tyakiduuc\",\n \"payment_date\": \"2023-08-01T03:00:00Z\",\n \"type\": \"credit\",\n \"payment_method\": \"credit_card\",\n \"accrual_at\": \"2023-06-29T14:11:52Z\",\n \"created_at\": \"2023-06-29T14:11:56Z\"\n },\n {\n \"id\": 4304198147,\n \"status\": \"waiting_funds\",\n \"amount\": 2163,\n \"fee\": 155,\n \"anticipation_fee\": 0,\n \"fraud_coverage_fee\": 0,\n \"installment\": 1,\n \"gateway_id\": 23833759,\n \"split_id\": \"sr_cljh854vb03te019tkteg20h9\",\n \"recipient_id\": \"rp_9zD2AbZURUkA83bR\",\n \"payment_date\": \"2023-08-01T03:00:00Z\",\n \"type\": \"credit\",\n \"payment_method\": \"credit_card\",\n \"accrual_at\": \"2023-06-29T14:11:52Z\",\n \"created_at\": \"2023-06-29T14:11:56Z\"\n },\n {\n \"id\": 4304196046,\n \"status\": \"waiting_funds\",\n \"amount\": 3798,\n \"fee\": 190,\n \"anticipation_fee\": 0,\n \"fraud_coverage_fee\": 0,\n \"installment\": 2,\n \"gateway_id\": 23828771,\n \"recipient_id\": \"re_cjlnpqrq0006vn56e1nig0tcv\",\n \"payment_date\": \"2023-08-29T03:00:00Z\",\n \"type\": \"credit\",\n \"payment_method\": \"credit_card\",\n \"accrual_at\": \"2023-06-29T04:04:33Z\",\n \"created_at\": \"2023-06-29T04:04:37Z\"\n },\n {\n \"id\": 4304196045,\n \"status\": \"waiting_funds\",\n \"amount\": 3798,\n \"fee\": 190,\n \"anticipation_fee\": 0,\n \"fraud_coverage_fee\": 0,\n \"installment\": 3,\n \"gateway_id\": 23828771,\n \"recipient_id\": \"re_cjlnpqrq0006vn56e1nig0tcv\",\n \"payment_date\": \"2023-09-28T03:00:00Z\",\n \"type\": \"credit\",\n \"payment_method\": \"credit_card\",\n \"accrual_at\": \"2023-06-29T04:04:33Z\",\n \"created_at\": \"2023-06-29T04:04:37Z\"\n },\n {\n \"id\": 4304196044,\n \"status\": \"waiting_funds\",\n \"amount\": 3798,\n \"fee\": 190,\n \"anticipation_fee\": 0,\n \"fraud_coverage_fee\": 0,\n \"installment\": 4,\n \"gateway_id\": 23828771,\n \"recipient_id\": \"re_cjlnpqrq0006vn56e1nig0tcv\",\n \"payment_date\": \"2023-10-30T03:00:00Z\",\n \"type\": \"credit\",\n \"payment_method\": \"credit_card\",\n \"accrual_at\": \"2023-06-29T04:04:33Z\",\n \"created_at\": \"2023-06-29T04:04:37Z\"\n }\n ],\n \"paging\": {}\n}"}},"schema":{"oneOf":[{"title":"Cobranças pós 01/07/23","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":4304241393,"default":0},"status":{"type":"string","example":"waiting_funds"},"amount":{"type":"integer","example":3090,"default":0},"fee":{"type":"integer","example":155,"default":0},"anticipation_fee":{"type":"integer","example":0,"default":0},"installment":{"type":"integer","example":1,"default":0},"charge_id":{"type":"string","example":"ch_xj9w8g8CEdhOX0BM"},"recipient_id":{"type":"string","example":"re_cjlnpqrq0006vn56e1nig0tcv"},"payment_date":{"type":"string","example":"2023-08-03T03:00:00Z"},"type":{"type":"string","example":"credit"},"payment_method":{"type":"string","example":"credit_card"},"accrual_at":{"type":"string","example":"2023-07-03T13:06:21Z"},"created_at":{"type":"string","example":"2023-07-03T13:06:22Z"}}}},"paging":{"type":"object","properties":{}}}},{"title":"Cobranças pré 01/07/23","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":4304198148,"default":0},"status":{"type":"string","example":"waiting_funds"},"amount":{"type":"integer","example":927,"default":0},"fee":{"type":"integer","example":0,"default":0},"anticipation_fee":{"type":"integer","example":0,"default":0},"fraud_coverage_fee":{"type":"integer","example":0,"default":0},"installment":{"type":"integer","example":1,"default":0},"gateway_id":{"type":"integer","example":23833759,"default":0},"split_id":{"type":"string","example":"sr_cljh854vb03tf019thoelps6p"},"recipient_id":{"type":"string","example":"re_clfj3jwyj051k019tyakiduuc"},"payment_date":{"type":"string","example":"2023-08-01T03:00:00Z"},"type":{"type":"string","example":"credit"},"payment_method":{"type":"string","example":"credit_card"},"accrual_at":{"type":"string","example":"2023-06-29T14:11:52Z"},"created_at":{"type":"string","example":"2023-06-29T14:11:56Z"}}}},"paging":{"type":"object","properties":{}}}}]}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/payables/{payable_id}":{"get":{"summary":"Obter um recebível","description":"Retorna um recebível específico da sua loja.","operationId":"obter-recebíveis-copy","parameters":[{"name":"payable_id","in":"path","description":"Filtro pelo identificador do recebível","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": 4304198148,\n \"status\": \"waiting_funds\",\n \"amount\": 927,\n \"fee\": 0,\n \"anticipation_fee\": 0,\n \"fraud_coverage_fee\": 0,\n \"installment\": 1,\n \"gateway_id\": 23833759,\n \"split_id\": \"sr_cljh854vb03tf019thoelps6p\",\n \"recipient_id\": \"re_clfj3jwyj051k019tyakiduuc\",\n \"payment_date\": \"2023-08-01T03:00:00Z\",\n \"type\": \"credit\",\n \"payment_method\": \"credit_card\",\n \"accrual_at\": \"2023-06-29T14:11:52Z\",\n \"created_at\": \"2023-06-29T14:11:56Z\"\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":4304198148,"default":0},"status":{"type":"string","example":"waiting_funds"},"amount":{"type":"integer","example":927,"default":0},"fee":{"type":"integer","example":0,"default":0},"anticipation_fee":{"type":"integer","example":0,"default":0},"fraud_coverage_fee":{"type":"integer","example":0,"default":0},"installment":{"type":"integer","example":1,"default":0},"gateway_id":{"type":"integer","example":23833759,"default":0},"split_id":{"type":"string","example":"sr_cljh854vb03tf019thoelps6p"},"recipient_id":{"type":"string","example":"re_clfj3jwyj051k019tyakiduuc"},"payment_date":{"type":"string","example":"2023-08-01T03:00:00Z"},"type":{"type":"string","example":"credit"},"payment_method":{"type":"string","example":"credit_card"},"accrual_at":{"type":"string","example":"2023-06-29T14:11:52Z"},"created_at":{"type":"string","example":"2023-06-29T14:11:56Z"}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/balance/operations":{"get":{"summary":"Obter histórico das operações","description":"Com esta rota é possível verificar os movimentos ocorridos no saldo da sua conta.","operationId":"obter-histórico-das-operações","parameters":[{"name":"created_since","in":"query","description":"Filtro pela data de criação da operação de saldo, como data de partida","schema":{"type":"string"}},{"name":"created_until","in":"query","description":"Filtro pela data de criação da operação de saldo, como data limite","schema":{"type":"string"}},{"name":"status","in":"query","description":"Estado do saldo da conta. Valores possíveis: `waiting_funds`, `available` e `transferred`, sendo o default `available`","schema":{"type":"string"}},{"name":"recipient_id","in":"query","description":"ID de recebedor desejado","schema":{"type":"string"}},{"name":"size","in":"query","description":"Filtro pela quantidade de objetos retornados. Deve ser menor ou igual a 1000","schema":{"type":"integer","format":"int32"}},{"name":"page","in":"query","description":"Filtro pela página de retorno","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"data\": [\n {\n \"id\": 2155314409,\n \"status\": \"available\",\n \"balance_amount\": 0,\n \"type\": \"payable\",\n \"amount\": -8990,\n \"fee\": 0,\n \"created_at\": \"2023-06-27T20:59:20Z\",\n \"movement_object\": {\n \"fee\": 0,\n \"anticipation_fee\": 0,\n \"fraud_coverage_fee\": 0,\n \"recipient_id\": \"re_cjlnpqrq0006vn56e1nig0tcv\",\n \"originator_model\": \"refund\",\n \"originator_model_id\": \"rf_cljertfyx1z1301m52an4poij\",\n \"payment_date \": \"2023-06-27T03:00:00Z\",\n \"payment_method\": \"pix\",\n \"object\": \"payable\",\n \"id\": \"4304143066\",\n \"status\": \"paid\",\n \"amount\": -8990,\n \"created_at\": \"2023-06-27T20:59:20Z\",\n \"type\": \"refund\",\n \"gateway_id\": \"23795495\"\n }\n },\n {\n \"id\": 2155314405,\n \"status\": \"available\",\n \"balance_amount\": 0,\n \"type\": \"payable\",\n \"amount\": 8990,\n \"fee\": 107,\n \"created_at\": \"2023-06-27T20:57:26Z\",\n \"movement_object\": {\n \"fee\": 107,\n \"anticipation_fee\": 0,\n \"fraud_coverage_fee\": 0,\n \"recipient_id\": \"re_cjlnpqrq0006vn56e1nig0tcv\",\n \"payment_date \": \"2023-06-27T03:00:00Z\",\n \"payment_method\": \"pix\",\n \"object\": \"payable\",\n \"id\": \"4304143062\",\n \"status\": \"paid\",\n \"amount\": 8990,\n \"created_at\": \"2023-06-27T20:57:26Z\",\n \"type\": \"credit\",\n \"gateway_id\": \"23795495\"\n }\n },\n {\n \"id\": 2155309256,\n \"status\": \"available\",\n \"balance_amount\": 0,\n \"type\": \"payable\",\n \"amount\": -8990,\n \"fee\": 0,\n \"created_at\": \"2023-06-27T19:59:47Z\",\n \"movement_object\": {\n \"fee\": 0,\n \"anticipation_fee\": 0,\n \"fraud_coverage_fee\": 0,\n \"recipient_id\": \"re_cjlnpqrq0006vn56e1nig0tcv\",\n \"originator_model\": \"refund\",\n \"originator_model_id\": \"rf_cljepoveh085601m54lfrq07q\",\n \"payment_date \": \"2023-06-27T03:00:00Z\",\n \"payment_method\": \"pix\",\n \"object\": \"payable\",\n \"id\": \"4304137920\",\n \"status\": \"paid\",\n \"amount\": -8990,\n \"created_at\": \"2023-06-27T19:59:47Z\",\n \"type\": \"refund\",\n \"gateway_id\": \"23793734\"\n }\n },\n {\n \"id\": 2155309241,\n \"status\": \"available\",\n \"balance_amount\": 0,\n \"type\": \"payable\",\n \"amount\": 8990,\n \"fee\": 107,\n \"created_at\": \"2023-06-27T19:59:13Z\",\n \"movement_object\": {\n \"fee\": 107,\n \"anticipation_fee\": 0,\n \"fraud_coverage_fee\": 0,\n \"recipient_id\": \"re_cjlnpqrq0006vn56e1nig0tcv\",\n \"payment_date \": \"2023-06-27T03:00:00Z\",\n \"payment_method\": \"pix\",\n \"object\": \"payable\",\n \"id\": \"4304137905\",\n \"status\": \"paid\",\n \"amount\": 8990,\n \"created_at\": \"2023-06-27T19:59:13Z\",\n \"type\": \"credit\",\n \"gateway_id\": \"23793734\"\n }\n },\n {\n \"id\": 2155309084,\n \"status\": \"available\",\n \"balance_amount\": 0,\n \"type\": \"payable\",\n \"amount\": -8990,\n \"fee\": 0,\n \"created_at\": \"2023-06-27T19:54:12Z\",\n \"movement_object\": {\n \"fee\": 0,\n \"anticipation_fee\": 0,\n \"fraud_coverage_fee\": 0,\n \"recipient_id\": \"re_cjlnpqrq0006vn56e1nig0tcv\",\n \"originator_model\": \"refund\",\n \"originator_model_id\": \"rf_cljephore028a01m556g5fcl3\",\n \"payment_date \": \"2023-06-27T03:00:00Z\",\n \"payment_method\": \"pix\",\n \"object\": \"payable\",\n \"id\": \"4304137806\",\n \"status\": \"paid\",\n \"amount\": -8990,\n \"created_at\": \"2023-06-27T19:54:12Z\",\n \"type\": \"refund\",\n \"gateway_id\": \"23793595\"\n }\n }\n ],\n \"paging\": {}\n}"}},"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","example":2155314409,"default":0},"status":{"type":"string","example":"available"},"balance_amount":{"type":"integer","example":0,"default":0},"type":{"type":"string","example":"payable"},"amount":{"type":"integer","example":-8990,"default":0},"fee":{"type":"integer","example":0,"default":0},"created_at":{"type":"string","example":"2023-06-27T20:59:20Z"},"movement_object":{"type":"object","properties":{"fee":{"type":"integer","example":0,"default":0},"anticipation_fee":{"type":"integer","example":0,"default":0},"fraud_coverage_fee":{"type":"integer","example":0,"default":0},"recipient_id":{"type":"string","example":"re_cjlnpqrq0006vn56e1nig0tcv"},"originator_model":{"type":"string","example":"refund"},"originator_model_id":{"type":"string","example":"rf_cljertfyx1z1301m52an4poij"},"payment_date ":{"type":"string","example":"2023-06-27T03:00:00Z"},"payment_method":{"type":"string","example":"pix"},"object":{"type":"string","example":"payable"},"id":{"type":"string","example":"4304143066"},"status":{"type":"string","example":"paid"},"amount":{"type":"integer","example":-8990,"default":0},"created_at":{"type":"string","example":"2023-06-27T20:59:20Z"},"type":{"type":"string","example":"refund"},"gateway_id":{"type":"string","example":"23795495"}}}}}},"paging":{"type":"object","properties":{}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/balance/operations/{balance_operation_id}":{"get":{"summary":"Obter histórico específico de uma operação","description":"Retorna uma operação específica ocorrida no saldo da sua conta.","operationId":"obter-histórico-específico-de-uma-operação","parameters":[{"name":"balance_operation_id","in":"path","description":"ID da operação desejada","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": 2155314409,\n \"status\": \"available\",\n \"balance_amount\": 0,\n \"type\": \"payable\",\n \"amount\": -8990,\n \"fee\": 0,\n \"created_at\": \"2023-06-27T20:59:20Z\",\n \"movement_object\": {\n \"fee\": 0,\n \"anticipation_fee\": 0,\n \"fraud_coverage_fee\": 0,\n \"recipient_id\": \"re_cjlnpqrq0006vn56e1nig0tcv\",\n \"originator_model\": \"refund\",\n \"originator_model_id\": \"rf_cljertfyx1z1301m52an4poij\",\n \"payment_date \": \"2023-06-27T03:00:00Z\",\n \"payment_method\": \"pix\",\n \"object\": \"payable\",\n \"id\": \"4304143066\",\n \"status\": \"paid\",\n \"amount\": -8990,\n \"created_at\": \"2023-06-27T20:59:20Z\",\n \"type\": \"refund\",\n \"gateway_id\": \"23795495\"\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"integer","example":2155314409,"default":0},"status":{"type":"string","example":"available"},"balance_amount":{"type":"integer","example":0,"default":0},"type":{"type":"string","example":"payable"},"amount":{"type":"integer","example":-8990,"default":0},"fee":{"type":"integer","example":0,"default":0},"created_at":{"type":"string","example":"2023-06-27T20:59:20Z"},"movement_object":{"type":"object","properties":{"fee":{"type":"integer","example":0,"default":0},"anticipation_fee":{"type":"integer","example":0,"default":0},"fraud_coverage_fee":{"type":"integer","example":0,"default":0},"recipient_id":{"type":"string","example":"re_cjlnpqrq0006vn56e1nig0tcv"},"originator_model":{"type":"string","example":"refund"},"originator_model_id":{"type":"string","example":"rf_cljertfyx1z1301m52an4poij"},"payment_date ":{"type":"string","example":"2023-06-27T03:00:00Z"},"payment_method":{"type":"string","example":"pix"},"object":{"type":"string","example":"payable"},"id":{"type":"string","example":"4304143066"},"status":{"type":"string","example":"paid"},"amount":{"type":"integer","example":-8990,"default":0},"created_at":{"type":"string","example":"2023-06-27T20:59:20Z"},"type":{"type":"string","example":"refund"},"gateway_id":{"type":"string","example":"23795495"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/recipients/{recipient_id}/receivable-units":{"get":{"summary":"Retornando URs de um Recebedor","description":"","operationId":"retornando-urs-de-um-recebedor-v5","parameters":[{"name":"recipient_id","in":"path","description":"Código do recebedor","schema":{"type":"string"},"required":true},{"name":"start_date","in":"query","description":"Dia inicial da consulta de agenda. Deve ser informado em timestamp","required":true,"schema":{"type":"string","format":"date-time"}},{"name":"end_date","in":"query","description":"Dia final da consulta de agenda. Dia inicial da consulta de agenda. Deve ser informado em timestamp","required":true,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"[\n {\n \"payment_method\": \"credit_card\",\n \"card_brand\": \"amex\",\n \"amount\": 16661,\n \"chargeback_amount\": -253,\n \"chargeback_refund_amount\": 952,\n \"credit_amount\": 16569,\n \"fee_amount\": -33,\n \"liquidation_amount\": -376,\n \"refund_amount\": -382,\n \"payment_date\": \"2023-09-22\"\n }\n ]"}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/hooks/{hook_id}/retry":{"post":{"summary":"Enviar webhook","description":"","operationId":"enviar-webhook","parameters":[{"name":"hook_id","in":"path","description":"Código do webhook.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/hooks/{hook_id}":{"get":{"summary":"Obter webhook","description":"","operationId":"obter-webhook","parameters":[{"name":"hook_id","in":"path","description":"Código do webhook.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"hook_98kmOL1sMfnZqoPL\",\n \"url\": \"https://70cfee17.ngrok.io/notifications/payment\",\n \"account\": {\n \"id\": \"acc_jZkdN857et650oNv\",\n \"name\": \"Lojinha\"\n },\n \"event\": \"order.paid\",\n \"status\": \"failed\",\n \"attempts\": \"3/3\",\n \"last_attempt\": \"2017-03-24T21:32:07Z\",\n \"created_at\": \"2017-03-24T21:21:59Z\",\n \"response_status\": 404,\n \"response_raw\": \"Tunnel 70cfee17.ngrok.io not found\",\n \"data\": {\n \"id\": \"or_e36l73IwgF7MlJwx\",\n \"code\": \"ER30H4MU4N\",\n \"amount\": 199,\n \"currency\": \"BRL\",\n \"closed\": true,\n \"items\": [\n {\n \"id\": \"oi_NqW9Rb2LTbsqRa3n\",\n \"description\": \"FLIP Payment\",\n \"amount\": 199,\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-03-24T21:21:58Z\",\n \"updated_at\": \"2017-03-24T21:21:58Z\"\n }\n ],\n \"customer\": {\n \"id\": \"cus_le6ZqXjiBSEOWdoA\",\n \"name\": \"Matheus Moreira\",\n \"email\": \"mmoreira@pagar.me\",\n \"delinquent\": false,\n \"created_at\": \"2016-11-25T23:45:04Z\",\n \"updated_at\": \"2016-12-26T21:34:45Z\"\n },\n \"status\": \"paid\",\n \"created_at\": \"2017-03-24T21:21:58Z\",\n \"updated_at\": \"2017-03-24T21:21:59Z\",\n \"closed_at\": \"2017-03-24T21:21:59Z\",\n \"charge\": {\n \"id\": \"ch_56YNm9akt4i6mKQ8\",\n \"code\": \"ER30H4MU4N\",\n \"gateway_id\": \"b21c20f8-21e1-4f56-ac1c-34425c9e9dc9\",\n \"amount\": 199,\n \"status\": \"paid\",\n \"currency\": \"BRL\",\n \"payment_method\": \"credit_card\",\n \"funding_source\": \"prepaid\",\n \"due_at\": \"2017-03-24T00:00:00Z\",\n \"paid_at\": \"2017-03-24T21:21:59Z\",\n \"created_at\": \"2017-03-24T21:21:58Z\",\n \"updated_at\": \"2017-03-24T21:21:58Z\",\n \"customer\": {\n \"id\": \"cus_le6ZqXjiBSEOWdoA\",\n \"name\": \"Matheus Moreira\",\n \"email\": \"mmoreira@pagar.me\",\n \"delinquent\": false,\n \"created_at\": \"2016-11-25T23:45:04Z\",\n \"updated_at\": \"2016-12-26T21:34:45Z\"\n },\n \"last_transaction\": {\n \"id\": \"tran_MpnYkMXhOBTb7Ze8\",\n \"transaction_type\": \"credit_card\",\n \"gateway_id\": \"9ac7ee2c-02a1-4b19-9f7e-168739a0427b\",\n \"amount\": 199,\n \"status\": \"captured\",\n \"success\": true,\n \"installments\": 1,\n \"acquirer_name\": \"simulator\",\n \"acquirer_affiliation_code\": \"1235\",\n \"acquirer_tid\": \"266699\",\n \"acquirer_nsu\": \"848780\",\n \"acquirer_auth_code\": \"1234\",\n \"acquirer_message\": \"Simulator|Transação de simulação autorizada com sucesso\",\n \"acquirer_return_code\": \"0\",\n \"operation_type\": \"auth_and_capture\",\n \"credit_card\": {\n \"id\": \"card_yB3ma9rS8HW7mnA9\",\n \"first_six_digits\": \"342793\",\n \"last_four_digits\": \"8229\",\n \"brand\": \"Amex\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 2018,\n \"status\": \"active\",\n \"created_at\": \"2016-11-29T21:14:07Z\",\n \"updated_at\": \"2016-11-29T21:14:07Z\",\n \"billing_address\": {\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"line_1\": \"10880, Malibu Point, Malibu Central\"\n }\n },\n \"created_at\": \"2017-03-24T21:21:58Z\",\n \"updated_at\": \"2017-03-24T21:21:58Z\"\n }\n },\n \"charges\": [\n {\n \"id\": \"ch_56YNm9akt4i6mKQ8\",\n \"code\": \"ER30H4MU4N\",\n \"gateway_id\": \"b21c20f8-21e1-4f56-ac1c-34425c9e9dc9\",\n \"amount\": 199,\n \"status\": \"paid\",\n \"currency\": \"BRL\",\n \"payment_method\": \"credit_card\",\n \"due_at\": \"2017-03-24T00:00:00Z\",\n \"paid_at\": \"2017-03-24T21:21:59Z\",\n \"created_at\": \"2017-03-24T21:21:58Z\",\n \"updated_at\": \"2017-03-24T21:21:58Z\",\n \"customer\": {\n \"id\": \"cus_le6ZqXjiBSEOWdoA\",\n \"name\": \"Matheus Moreira\",\n \"email\": \"mmoreira@pagar.me\",\n \"delinquent\": false,\n \"created_at\": \"2016-11-25T23:45:04Z\",\n \"updated_at\": \"2016-12-26T21:34:45Z\"\n },\n \"last_transaction\": {\n \"id\": \"tran_MpnYkMXhOBTb7Ze8\",\n \"transaction_type\": \"credit_card\",\n \"gateway_id\": \"9ac7ee2c-02a1-4b19-9f7e-168739a0427b\",\n \"amount\": 199,\n \"status\": \"captured\",\n \"success\": true,\n \"installments\": 1,\n \"acquirer_name\": \"simulator\",\n \"acquirer_affiliation_code\": \"12345\",\n \"acquirer_tid\": \"266699\",\n \"acquirer_nsu\": \"848780\",\n \"acquirer_auth_code\": \"12345\",\n \"acquirer_message\": \"Simulator|Transação de simulação autorizada com sucesso\",\n \"acquirer_return_code\": \"0\",\n \"operation_type\": \"auth_and_capture\",\n \"credit_card\": {\n \"id\": \"card_yB3ma9rS8HW7mnA9\",\n \"last_four_digits\": \"8229\",\n \"brand\": \"Amex\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 2018,\n \"status\": \"active\",\n \"created_at\": \"2016-11-29T21:14:07Z\",\n \"updated_at\": \"2016-11-29T21:14:07Z\",\n \"billing_address\": {\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"line_1\": \"10880, Malibu Point, Malibu Central\"\n }\n },\n \"created_at\": \"2017-03-24T21:21:58Z\",\n \"updated_at\": \"2017-03-24T21:21:58Z\"\n }\n }\n ]\n }\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"hook_98kmOL1sMfnZqoPL"},"url":{"type":"string","example":"https://70cfee17.ngrok.io/notifications/payment"},"account":{"type":"object","properties":{"id":{"type":"string","example":"acc_jZkdN857et650oNv"},"name":{"type":"string","example":"Lojinha"}}},"event":{"type":"string","example":"order.paid"},"status":{"type":"string","example":"failed"},"attempts":{"type":"string","example":"3/3"},"last_attempt":{"type":"string","example":"2017-03-24T21:32:07Z"},"created_at":{"type":"string","example":"2017-03-24T21:21:59Z"},"response_status":{"type":"integer","example":404,"default":0},"response_raw":{"type":"string","example":"Tunnel 70cfee17.ngrok.io not found"},"data":{"type":"object","properties":{"id":{"type":"string","example":"or_e36l73IwgF7MlJwx"},"code":{"type":"string","example":"ER30H4MU4N"},"amount":{"type":"integer","example":199,"default":0},"currency":{"type":"string","example":"BRL"},"closed":{"type":"boolean","example":true,"default":true},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"oi_NqW9Rb2LTbsqRa3n"},"description":{"type":"string","example":"FLIP Payment"},"amount":{"type":"integer","example":199,"default":0},"quantity":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-03-24T21:21:58Z"},"updated_at":{"type":"string","example":"2017-03-24T21:21:58Z"}}}},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_le6ZqXjiBSEOWdoA"},"name":{"type":"string","example":"Matheus Moreira"},"email":{"type":"string","example":"mmoreira@pagar.me"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2016-11-25T23:45:04Z"},"updated_at":{"type":"string","example":"2016-12-26T21:34:45Z"}}},"status":{"type":"string","example":"paid"},"created_at":{"type":"string","example":"2017-03-24T21:21:58Z"},"updated_at":{"type":"string","example":"2017-03-24T21:21:59Z"},"closed_at":{"type":"string","example":"2017-03-24T21:21:59Z"},"charge":{"type":"object","properties":{"id":{"type":"string","example":"ch_56YNm9akt4i6mKQ8"},"code":{"type":"string","example":"ER30H4MU4N"},"gateway_id":{"type":"string","example":"b21c20f8-21e1-4f56-ac1c-34425c9e9dc9"},"amount":{"type":"integer","example":199,"default":0},"status":{"type":"string","example":"paid"},"currency":{"type":"string","example":"BRL"},"payment_method":{"type":"string","example":"credit_card"},"funding_source":{"type":"string","example":"prepaid"},"due_at":{"type":"string","example":"2017-03-24T00:00:00Z"},"paid_at":{"type":"string","example":"2017-03-24T21:21:59Z"},"created_at":{"type":"string","example":"2017-03-24T21:21:58Z"},"updated_at":{"type":"string","example":"2017-03-24T21:21:58Z"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_le6ZqXjiBSEOWdoA"},"name":{"type":"string","example":"Matheus Moreira"},"email":{"type":"string","example":"mmoreira@pagar.me"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2016-11-25T23:45:04Z"},"updated_at":{"type":"string","example":"2016-12-26T21:34:45Z"}}},"last_transaction":{"type":"object","properties":{"id":{"type":"string","example":"tran_MpnYkMXhOBTb7Ze8"},"transaction_type":{"type":"string","example":"credit_card"},"gateway_id":{"type":"string","example":"9ac7ee2c-02a1-4b19-9f7e-168739a0427b"},"amount":{"type":"integer","example":199,"default":0},"status":{"type":"string","example":"captured"},"success":{"type":"boolean","example":true,"default":true},"installments":{"type":"integer","example":1,"default":0},"acquirer_name":{"type":"string","example":"simulator"},"acquirer_affiliation_code":{"type":"string","example":"1235"},"acquirer_tid":{"type":"string","example":"266699"},"acquirer_nsu":{"type":"string","example":"848780"},"acquirer_auth_code":{"type":"string","example":"1234"},"acquirer_message":{"type":"string","example":"Simulator|Transação de simulação autorizada com sucesso"},"acquirer_return_code":{"type":"string","example":"0"},"operation_type":{"type":"string","example":"auth_and_capture"},"credit_card":{"type":"object","properties":{"id":{"type":"string","example":"card_yB3ma9rS8HW7mnA9"},"first_six_digits":{"type":"string","example":"342793"},"last_four_digits":{"type":"string","example":"8229"},"brand":{"type":"string","example":"Amex"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":2018,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2016-11-29T21:14:07Z"},"updated_at":{"type":"string","example":"2016-11-29T21:14:07Z"},"billing_address":{"type":"object","properties":{"zip_code":{"type":"string","example":"90265"},"city":{"type":"string","example":"Malibu"},"state":{"type":"string","example":"CA"},"country":{"type":"string","example":"US"},"line_1":{"type":"string","example":"10880, Malibu Point, Malibu Central"}}}}},"created_at":{"type":"string","example":"2017-03-24T21:21:58Z"},"updated_at":{"type":"string","example":"2017-03-24T21:21:58Z"}}}}},"charges":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"ch_56YNm9akt4i6mKQ8"},"code":{"type":"string","example":"ER30H4MU4N"},"gateway_id":{"type":"string","example":"b21c20f8-21e1-4f56-ac1c-34425c9e9dc9"},"amount":{"type":"integer","example":199,"default":0},"status":{"type":"string","example":"paid"},"currency":{"type":"string","example":"BRL"},"payment_method":{"type":"string","example":"credit_card"},"due_at":{"type":"string","example":"2017-03-24T00:00:00Z"},"paid_at":{"type":"string","example":"2017-03-24T21:21:59Z"},"created_at":{"type":"string","example":"2017-03-24T21:21:58Z"},"updated_at":{"type":"string","example":"2017-03-24T21:21:58Z"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_le6ZqXjiBSEOWdoA"},"name":{"type":"string","example":"Matheus Moreira"},"email":{"type":"string","example":"mmoreira@pagar.me"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2016-11-25T23:45:04Z"},"updated_at":{"type":"string","example":"2016-12-26T21:34:45Z"}}},"last_transaction":{"type":"object","properties":{"id":{"type":"string","example":"tran_MpnYkMXhOBTb7Ze8"},"transaction_type":{"type":"string","example":"credit_card"},"gateway_id":{"type":"string","example":"9ac7ee2c-02a1-4b19-9f7e-168739a0427b"},"amount":{"type":"integer","example":199,"default":0},"status":{"type":"string","example":"captured"},"success":{"type":"boolean","example":true,"default":true},"installments":{"type":"integer","example":1,"default":0},"acquirer_name":{"type":"string","example":"simulator"},"acquirer_affiliation_code":{"type":"string","example":"12345"},"acquirer_tid":{"type":"string","example":"266699"},"acquirer_nsu":{"type":"string","example":"848780"},"acquirer_auth_code":{"type":"string","example":"12345"},"acquirer_message":{"type":"string","example":"Simulator|Transação de simulação autorizada com sucesso"},"acquirer_return_code":{"type":"string","example":"0"},"operation_type":{"type":"string","example":"auth_and_capture"},"credit_card":{"type":"object","properties":{"id":{"type":"string","example":"card_yB3ma9rS8HW7mnA9"},"last_four_digits":{"type":"string","example":"8229"},"brand":{"type":"string","example":"Amex"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":2018,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2016-11-29T21:14:07Z"},"updated_at":{"type":"string","example":"2016-11-29T21:14:07Z"},"billing_address":{"type":"object","properties":{"zip_code":{"type":"string","example":"90265"},"city":{"type":"string","example":"Malibu"},"state":{"type":"string","example":"CA"},"country":{"type":"string","example":"US"},"line_1":{"type":"string","example":"10880, Malibu Point, Malibu Central"}}}}},"created_at":{"type":"string","example":"2017-03-24T21:21:58Z"},"updated_at":{"type":"string","example":"2017-03-24T21:21:58Z"}}}}}}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/hooks":{"get":{"summary":"Listar webhooks","description":"","operationId":"listar-webhooks","parameters":[{"name":"status","in":"query","description":"Status do webhook ('pending', 'sent' or 'failed')","schema":{"type":"string"}},{"name":"webhook_event","in":"query","description":"Nome do evento do webhook","schema":{"type":"string"}},{"name":"created_since","in":"query","description":"Data de início do período de criação a ser listado.","schema":{"type":"string","format":"date"}},{"name":"created_until","in":"query","description":"Data final do período de criação a ser listado.","schema":{"type":"string","format":"date"}},{"name":"page","in":"query","description":"Número da página.","schema":{"type":"integer","format":"int32","default":1}},{"name":"size","in":"query","description":"Quantidade de itens por página.","schema":{"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"data\": [\n {\n \"id\": \"hook_98kmOL1sMfnZqoPL\",\n \"url\": \"https://70cfee17.ngrok.io/notifications/payment\",\n \"account\": {\n \"id\": \"acc_jZkdN857et650oNv\",\n \"name\": \"Lojinha\"\n },\n \"event\": \"order.paid\",\n \"status\": \"failed\",\n \"attempts\": \"3/3\",\n \"last_attempt\": \"2017-03-24T21:32:07Z\",\n \"created_at\": \"2017-03-24T21:21:59Z\",\n \"response_status\": 404,\n \"response_raw\": \"Tunnel 70cfee17.ngrok.io not found\",\n \"data\": {\n \"id\": \"or_e36l73IwgF7MlJwx\",\n \"code\": \"ER30H4MU4N\",\n \"amount\": 199,\n \"currency\": \"BRL\",\n \"closed\": true,\n \"items\": [\n {\n \"id\": \"oi_NqW9Rb2LTbsqRa3n\",\n \"description\": \"FLIP Payment\",\n \"amount\": 199,\n \"quantity\": 1,\n \"status\": \"active\",\n \"created_at\": \"2017-03-24T21:21:58Z\",\n \"updated_at\": \"2017-03-24T21:21:58Z\"\n }\n ],\n \"customer\": {\n \"id\": \"cus_le6ZqXjiBSEOWdoA\",\n \"name\": \"Matheus Moreira\",\n \"email\": \"mmoreira@pagar.me\",\n \"delinquent\": false,\n \"created_at\": \"2016-11-25T23:45:04Z\",\n \"updated_at\": \"2016-12-26T21:34:45Z\"\n },\n \"status\": \"paid\",\n \"created_at\": \"2017-03-24T21:21:58Z\",\n \"updated_at\": \"2017-03-24T21:21:59Z\",\n \"closed_at\": \"2017-03-24T21:21:59Z\",\n \"charge\": {\n \"id\": \"ch_56YNm9akt4i6mKQ8\",\n \"code\": \"ER30H4MU4N\",\n \"gateway_id\": \"b21c20f8-21e1-4f56-ac1c-34425c9e9dc9\",\n \"amount\": 199,\n \"status\": \"paid\",\n \"currency\": \"BRL\",\n \"payment_method\": \"credit_card\",\n \"due_at\": \"2017-03-24T00:00:00Z\",\n \"paid_at\": \"2017-03-24T21:21:59Z\",\n \"created_at\": \"2017-03-24T21:21:58Z\",\n \"updated_at\": \"2017-03-24T21:21:58Z\",\n \"customer\": {\n \"id\": \"cus_le6ZqXjiBSEOWdoA\",\n \"name\": \"Matheus Moreira\",\n \"email\": \"mmoreira@pagar.me\",\n \"delinquent\": false,\n \"created_at\": \"2016-11-25T23:45:04Z\",\n \"updated_at\": \"2016-12-26T21:34:45Z\"\n },\n \"last_transaction\": {\n \"id\": \"tran_MpnYkMXhOBTb7Ze8\",\n \"transaction_type\": \"credit_card\",\n \"funding_source\": \"prepaid\",\n \"gateway_id\": \"9ac7ee2c-02a1-4b19-9f7e-168739a0427b\",\n \"amount\": 199,\n \"status\": \"captured\",\n \"success\": true,\n \"installments\": 1,\n \"acquirer_name\": \"simulator\",\n \"acquirer_affiliation_code\": \"125\",\n \"acquirer_tid\": \"266699\",\n \"acquirer_nsu\": \"848780\",\n \"acquirer_auth_code\": \"125\",\n \"acquirer_message\": \"Simulator|Transação de simulação autorizada com sucesso\",\n \"acquirer_return_code\": \"0\",\n \"operation_type\": \"auth_and_capture\",\n \"credit_card\": {\n \"id\": \"card_yB3ma9rS8HW7mnA9\",\n \"last_four_digits\": \"8229\",\n \"brand\": \"Amex\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 2018,\n \"status\": \"active\",\n \"created_at\": \"2016-11-29T21:14:07Z\",\n \"updated_at\": \"2016-11-29T21:14:07Z\",\n \"billing_address\": {\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"line_1\": \"10880, Malibu Point, Malibu Central\"\n }\n },\n \"created_at\": \"2017-03-24T21:21:58Z\",\n \"updated_at\": \"2017-03-24T21:21:58Z\"\n }\n },\n \"charges\": [\n {\n \"id\": \"ch_56YNm9akt4i6mKQ8\",\n \"code\": \"ER30H4MU4N\",\n \"gateway_id\": \"b21c20f8-21e1-4f56-ac1c-34425c9e9dc9\",\n \"amount\": 199,\n \"status\": \"paid\",\n \"currency\": \"BRL\",\n \"payment_method\": \"credit_card\",\n \"funding_source\": \"prepaid\",\n \"due_at\": \"2017-03-24T00:00:00Z\",\n \"paid_at\": \"2017-03-24T21:21:59Z\",\n \"created_at\": \"2017-03-24T21:21:58Z\",\n \"updated_at\": \"2017-03-24T21:21:58Z\",\n \"customer\": {\n \"id\": \"cus_le6ZqXjiBSEOWdoA\",\n \"name\": \"Matheus Moreira\",\n \"email\": \"mmoreira@pagar.me\",\n \"delinquent\": false,\n \"created_at\": \"2016-11-25T23:45:04Z\",\n \"updated_at\": \"2016-12-26T21:34:45Z\"\n },\n \"last_transaction\": {\n \"id\": \"tran_MpnYkMXhOBTb7Ze8\",\n \"transaction_type\": \"credit_card\",\n \"gateway_id\": \"9ac7ee2c-02a1-4b19-9f7e-168739a0427b\",\n \"amount\": 199,\n \"status\": \"captured\",\n \"success\": true,\n \"installments\": 1,\n \"acquirer_name\": \"simulator\",\n \"acquirer_affiliation_code\": \"1236\",\n \"acquirer_tid\": \"266699\",\n \"acquirer_nsu\": \"848780\",\n \"acquirer_auth_code\": \"12234\",\n \"acquirer_message\": \"Simulator|Transação de simulação autorizada com sucesso\",\n \"acquirer_return_code\": \"0\",\n \"operation_type\": \"auth_and_capture\",\n \"credit_card\": {\n \"id\": \"card_yB3ma9rS8HW7mnA9\",\n \"first_six_digits\": \"342793\",\n \"last_four_digits\": \"8229\",\n \"brand\": \"Amex\",\n \"holder_name\": \"Tony Stark\",\n \"exp_month\": 1,\n \"exp_year\": 2018,\n \"status\": \"active\",\n \"created_at\": \"2016-11-29T21:14:07Z\",\n \"updated_at\": \"2016-11-29T21:14:07Z\",\n \"billing_address\": {\n \"zip_code\": \"90265\",\n \"city\": \"Malibu\",\n \"state\": \"CA\",\n \"country\": \"US\",\n \"line_1\": \"10880, Malibu Point, Malibu Central\"\n }\n },\n \"created_at\": \"2017-03-24T21:21:58Z\",\n \"updated_at\": \"2017-03-24T21:21:58Z\"\n }\n }\n ]\n }\n }\n ],\n \"paging\": {\n \"total\": 34,\n \"next\": \"https://api.stone.com.br/core/v5/hooks?since=2017-03-05&page=2&size=1\"\n }\n}"}},"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"hook_98kmOL1sMfnZqoPL"},"url":{"type":"string","example":"https://70cfee17.ngrok.io/notifications/payment"},"account":{"type":"object","properties":{"id":{"type":"string","example":"acc_jZkdN857et650oNv"},"name":{"type":"string","example":"Lojinha"}}},"event":{"type":"string","example":"order.paid"},"status":{"type":"string","example":"failed"},"attempts":{"type":"string","example":"3/3"},"last_attempt":{"type":"string","example":"2017-03-24T21:32:07Z"},"created_at":{"type":"string","example":"2017-03-24T21:21:59Z"},"response_status":{"type":"integer","example":404,"default":0},"response_raw":{"type":"string","example":"Tunnel 70cfee17.ngrok.io not found"},"data":{"type":"object","properties":{"id":{"type":"string","example":"or_e36l73IwgF7MlJwx"},"code":{"type":"string","example":"ER30H4MU4N"},"amount":{"type":"integer","example":199,"default":0},"currency":{"type":"string","example":"BRL"},"closed":{"type":"boolean","example":true,"default":true},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"oi_NqW9Rb2LTbsqRa3n"},"description":{"type":"string","example":"FLIP Payment"},"amount":{"type":"integer","example":199,"default":0},"quantity":{"type":"integer","example":1,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2017-03-24T21:21:58Z"},"updated_at":{"type":"string","example":"2017-03-24T21:21:58Z"}}}},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_le6ZqXjiBSEOWdoA"},"name":{"type":"string","example":"Matheus Moreira"},"email":{"type":"string","example":"mmoreira@pagar.me"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2016-11-25T23:45:04Z"},"updated_at":{"type":"string","example":"2016-12-26T21:34:45Z"}}},"status":{"type":"string","example":"paid"},"created_at":{"type":"string","example":"2017-03-24T21:21:58Z"},"updated_at":{"type":"string","example":"2017-03-24T21:21:59Z"},"closed_at":{"type":"string","example":"2017-03-24T21:21:59Z"},"charge":{"type":"object","properties":{"id":{"type":"string","example":"ch_56YNm9akt4i6mKQ8"},"code":{"type":"string","example":"ER30H4MU4N"},"gateway_id":{"type":"string","example":"b21c20f8-21e1-4f56-ac1c-34425c9e9dc9"},"amount":{"type":"integer","example":199,"default":0},"status":{"type":"string","example":"paid"},"currency":{"type":"string","example":"BRL"},"payment_method":{"type":"string","example":"credit_card"},"due_at":{"type":"string","example":"2017-03-24T00:00:00Z"},"paid_at":{"type":"string","example":"2017-03-24T21:21:59Z"},"created_at":{"type":"string","example":"2017-03-24T21:21:58Z"},"updated_at":{"type":"string","example":"2017-03-24T21:21:58Z"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_le6ZqXjiBSEOWdoA"},"name":{"type":"string","example":"Matheus Moreira"},"email":{"type":"string","example":"mmoreira@pagar.me"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2016-11-25T23:45:04Z"},"updated_at":{"type":"string","example":"2016-12-26T21:34:45Z"}}},"last_transaction":{"type":"object","properties":{"id":{"type":"string","example":"tran_MpnYkMXhOBTb7Ze8"},"transaction_type":{"type":"string","example":"credit_card"},"funding_source":{"type":"string","example":"prepaid"},"gateway_id":{"type":"string","example":"9ac7ee2c-02a1-4b19-9f7e-168739a0427b"},"amount":{"type":"integer","example":199,"default":0},"status":{"type":"string","example":"captured"},"success":{"type":"boolean","example":true,"default":true},"installments":{"type":"integer","example":1,"default":0},"acquirer_name":{"type":"string","example":"simulator"},"acquirer_affiliation_code":{"type":"string","example":"125"},"acquirer_tid":{"type":"string","example":"266699"},"acquirer_nsu":{"type":"string","example":"848780"},"acquirer_auth_code":{"type":"string","example":"125"},"acquirer_message":{"type":"string","example":"Simulator|Transação de simulação autorizada com sucesso"},"acquirer_return_code":{"type":"string","example":"0"},"operation_type":{"type":"string","example":"auth_and_capture"},"credit_card":{"type":"object","properties":{"id":{"type":"string","example":"card_yB3ma9rS8HW7mnA9"},"last_four_digits":{"type":"string","example":"8229"},"brand":{"type":"string","example":"Amex"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":2018,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2016-11-29T21:14:07Z"},"updated_at":{"type":"string","example":"2016-11-29T21:14:07Z"},"billing_address":{"type":"object","properties":{"zip_code":{"type":"string","example":"90265"},"city":{"type":"string","example":"Malibu"},"state":{"type":"string","example":"CA"},"country":{"type":"string","example":"US"},"line_1":{"type":"string","example":"10880, Malibu Point, Malibu Central"}}}}},"created_at":{"type":"string","example":"2017-03-24T21:21:58Z"},"updated_at":{"type":"string","example":"2017-03-24T21:21:58Z"}}}}},"charges":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"ch_56YNm9akt4i6mKQ8"},"code":{"type":"string","example":"ER30H4MU4N"},"gateway_id":{"type":"string","example":"b21c20f8-21e1-4f56-ac1c-34425c9e9dc9"},"amount":{"type":"integer","example":199,"default":0},"status":{"type":"string","example":"paid"},"currency":{"type":"string","example":"BRL"},"payment_method":{"type":"string","example":"credit_card"},"funding_source":{"type":"string","example":"prepaid"},"due_at":{"type":"string","example":"2017-03-24T00:00:00Z"},"paid_at":{"type":"string","example":"2017-03-24T21:21:59Z"},"created_at":{"type":"string","example":"2017-03-24T21:21:58Z"},"updated_at":{"type":"string","example":"2017-03-24T21:21:58Z"},"customer":{"type":"object","properties":{"id":{"type":"string","example":"cus_le6ZqXjiBSEOWdoA"},"name":{"type":"string","example":"Matheus Moreira"},"email":{"type":"string","example":"mmoreira@pagar.me"},"delinquent":{"type":"boolean","example":false,"default":true},"created_at":{"type":"string","example":"2016-11-25T23:45:04Z"},"updated_at":{"type":"string","example":"2016-12-26T21:34:45Z"}}},"last_transaction":{"type":"object","properties":{"id":{"type":"string","example":"tran_MpnYkMXhOBTb7Ze8"},"transaction_type":{"type":"string","example":"credit_card"},"gateway_id":{"type":"string","example":"9ac7ee2c-02a1-4b19-9f7e-168739a0427b"},"amount":{"type":"integer","example":199,"default":0},"status":{"type":"string","example":"captured"},"success":{"type":"boolean","example":true,"default":true},"installments":{"type":"integer","example":1,"default":0},"acquirer_name":{"type":"string","example":"simulator"},"acquirer_affiliation_code":{"type":"string","example":"1236"},"acquirer_tid":{"type":"string","example":"266699"},"acquirer_nsu":{"type":"string","example":"848780"},"acquirer_auth_code":{"type":"string","example":"12234"},"acquirer_message":{"type":"string","example":"Simulator|Transação de simulação autorizada com sucesso"},"acquirer_return_code":{"type":"string","example":"0"},"operation_type":{"type":"string","example":"auth_and_capture"},"credit_card":{"type":"object","properties":{"id":{"type":"string","example":"card_yB3ma9rS8HW7mnA9"},"first_six_digits":{"type":"string","example":"342793"},"last_four_digits":{"type":"string","example":"8229"},"brand":{"type":"string","example":"Amex"},"holder_name":{"type":"string","example":"Tony Stark"},"exp_month":{"type":"integer","example":1,"default":0},"exp_year":{"type":"integer","example":2018,"default":0},"status":{"type":"string","example":"active"},"created_at":{"type":"string","example":"2016-11-29T21:14:07Z"},"updated_at":{"type":"string","example":"2016-11-29T21:14:07Z"},"billing_address":{"type":"object","properties":{"zip_code":{"type":"string","example":"90265"},"city":{"type":"string","example":"Malibu"},"state":{"type":"string","example":"CA"},"country":{"type":"string","example":"US"},"line_1":{"type":"string","example":"10880, Malibu Point, Malibu Central"}}}}},"created_at":{"type":"string","example":"2017-03-24T21:21:58Z"},"updated_at":{"type":"string","example":"2017-03-24T21:21:58Z"}}}}}}}}}}},"paging":{"type":"object","properties":{"total":{"type":"integer","example":34,"default":0},"next":{"type":"string","example":"https://api.stone.com.br/core/v5/hooks?since=2017-03-05&page=2&size=1"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/odersMF":{"post":{"summary":"Criação de pedido MF","description":"","operationId":"criação-de-pedido-mf","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"amount":{"type":"string","enum":[""]}}},"examples":{"Request Example":{"value":{"items":[{"amount":1000,"description":"Chaveiro do Tesseract","quantity":1,"code":"123"}],"closed":"false","poi_payment_settings":{"visible":true,"display_name":"Teste NF","print_order_receipt":true,"devices_serial_number":["6M489133"],"payment_setup":{"type":"credit","installments":1,"installment_type":"merchant"}},"customer":{"name":"Tony Stark","email":"testes@gmail.com","Document":"13621248773","type":"individual","phones":{"home_phone":{"country_code":"55","area_code":"21","number":"000000000"},"mobile_phone":{"country_code":"55","area_code":"21","number":"000000000"}}}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/recipients/{recipient_id}/bulk_anticipations":{"post":{"summary":"Criando uma antecipação","description":"","operationId":"criando-uma-antecipação","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["payment_date","timeframe","requested_amount"],"properties":{"payment_date":{"type":"string","description":"Data de pagamento da antecipação. Data no formato ISO 8601"},"timeframe":{"type":"string","description":"Define o período de onde os recebíveis serão escolhidos. start define recebíveis próximos, perto de serem pagos, e end define recebíveis longes, no final de todos recebíveis que você possui para receber. String `start` ou `end`"},"requested_amount":{"type":"integer","description":"Valor líquido, em centavos, que você deseja receber de antecipação","format":"int32"},"automatic_transfer":{"type":"boolean","description":"Define se o valor da antecipação será transferido automaticamente para a conta bancária do recebedor","default":false}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"ba_123456789\",\n \"status\": \"approved\",\n \"amount\": 100000,\n \"fee\": 5000,\n \"fraud_coverage_fee\": 0,\n \"anticipation_fee\": 3000,\n \"automatic_transfer\": false,\n \"type\": \"spot\",\n \"timeframe\": \"start\",\n \"payment_date\": \"2025-08-20T00:00:00.000Z\",\n \"created_at\": \"2025-08-19T14:23:00.000Z\",\n \"updated_at\": \"2025-08-20T10:15:00.000Z\",\n \"anticipation_tax\": null\n }"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"ba_123456789"},"status":{"type":"string","example":"approved"},"amount":{"type":"integer","example":100000,"default":0},"fee":{"type":"integer","example":5000,"default":0},"fraud_coverage_fee":{"type":"integer","example":0,"default":0},"anticipation_fee":{"type":"integer","example":3000,"default":0},"automatic_transfer":{"type":"boolean","example":false,"default":true},"type":{"type":"string","example":"spot"},"timeframe":{"type":"string","example":"start"},"payment_date":{"type":"string","example":"2025-08-20T00:00:00.000Z"},"created_at":{"type":"string","example":"2025-08-19T14:23:00.000Z"},"updated_at":{"type":"string","example":"2025-08-20T10:15:00.000Z"},"anticipation_tax":{}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{ \"errors\": [{ \"type\": \"invalid_parameter_error\", \"parameter_name\": \"payment_date\", \"message\": \"A data de pagamento deve ser um dia útil.\" }] }"}},"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"invalid_parameter_error"},"parameter_name":{"type":"string","example":"payment_date"},"message":{"type":"string","example":"A data de pagamento deve ser um dia útil."}}}}}}}}}},"deprecated":false,"parameters":[{"name":"recipient_id","in":"path","description":"Código do recebedor","schema":{"type":"string"},"required":true}]},"get":{"summary":"Retornando antecipações","description":"Retorna uma lista contendo objetos de antecipações.","operationId":"retornando-antecipações","parameters":[{"name":"recipient_id","in":"path","schema":{"type":"string"},"required":true},{"name":"count","in":"query","description":"Retorna n resultados, com um máximo de 1000","schema":{"type":"string"}},{"name":"page","in":"query","description":"Útil para implementação de uma paginação de resultados","schema":{"type":"string"}},{"name":"amount","in":"query","description":"Filtro de amount","schema":{"type":"string"}},{"name":"fee","in":"query","description":"Filtro de fee","schema":{"type":"string"}},{"name":"anticipation_fee","in":"query","description":"Filtro de anticipation fee","schema":{"type":"string"}},{"name":"id","in":"query","description":"ID da antecipação procurada","schema":{"type":"string"}},{"name":"payment_date","in":"query","description":"Data de pagamento procurada","schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"[\n {\n \"id\": \"ba_123456789\",\n \"status\": \"approved\",\n \"amount\": 100000,\n \"fee\": 5000,\n \"fraud_coverage_fee\": 0,\n \"anticipation_fee\": 3000,\n \"automatic_transfer\": false,\n \"type\": \"spot\",\n \"timeframe\": \"start\",\n \"payment_date\": \"2025-08-20T00:00:00.000Z\",\n \"created_at\": \"2025-08-19T14:23:00.000Z\",\n \"updated_at\": \"2025-08-20T10:15:00.000Z\",\n \"anticipation_tax\": null\n },\n {\n \"id\": \"ba_987654321\",\n \"status\": \"canceled\",\n \"amount\": 50000,\n \"fee\": 2500,\n \"fraud_coverage_fee\": 0,\n \"anticipation_fee\": 1500,\n \"automatic_transfer\": true,\n \"type\": \"spot\",\n \"timeframe\": \"end\",\n \"payment_date\": \"2025-08-18T00:00:00.000Z\",\n \"created_at\": \"2025-08-17T09:00:00.000Z\",\n \"updated_at\": \"2025-08-18T10:00:00.000Z\",\n \"anticipation_tax\": 0.015\n }\n]"}},"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"ba_123456789"},"status":{"type":"string","example":"approved"},"amount":{"type":"integer","example":100000,"default":0},"fee":{"type":"integer","example":5000,"default":0},"fraud_coverage_fee":{"type":"integer","example":0,"default":0},"anticipation_fee":{"type":"integer","example":3000,"default":0},"automatic_transfer":{"type":"boolean","example":false,"default":true},"type":{"type":"string","example":"spot"},"timeframe":{"type":"string","example":"start"},"payment_date":{"type":"string","example":"2025-08-20T00:00:00.000Z"},"created_at":{"type":"string","example":"2025-08-19T14:23:00.000Z"},"updated_at":{"type":"string","example":"2025-08-20T10:15:00.000Z"},"anticipation_tax":{}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{ \"errors\": [{ \"type\": \"invalid_parameter_error\", \"parameter_name\": \"page\", \"message\": \"Página inválida.\" }] }"}},"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"invalid_parameter_error"},"parameter_name":{"type":"string","example":"page"},"message":{"type":"string","example":"Página inválida."}}}}}}}}}},"deprecated":false}},"/recipients/{recipient_id}/bulk_anticipations/simulate":{"get":{"summary":"Simulando uma Antecipação Spot","description":"Obtem previsões precisas sobre o valor a ser recebido, os custos envolvidos na operação, e a data de pagamento. Para iniciar a simulação da antecipação, é necessário utilizar a rota:","operationId":"simulando-uma-antecipação-spot","parameters":[{"name":"recipient_id","in":"path","description":"ID do recebedor para o qual deseja simular a antecipação.","schema":{"type":"string"},"required":true},{"name":"timeframe","in":"query","description":"Define o período de onde os recebíveis serão escolhidos para simulação — ou seja, do inicio ou do fim da sua agenda de recebíveis.","required":true,"schema":{"type":"string"}},{"name":"requested_amount","in":"query","description":"Valor líquido, em centavos, que você deseja receber na antecipação, o valor deve estar entre o limite antecipável do recebedor. Caso queira consultar os limites antecipáveis utilize a rota /limits.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"payment_date","in":"query","description":"Data que você deseja receber a antecipação em sua conta Pagar.me. O parâmetro payment_date pode ser para qualquer dia no futuro e do dia atual até as 11h, caso já tenha passado desse horário, por favor adicione um payment_date para o próximo dia útil. Data em string no formato ISO 8601","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"amount\": 1000000, \n \"fee\": 20000, \n \"fraudCoverageFee\": 0, \n \"anticipationAmount\": 900000, \n \"anticipationFee\": 80000, \n \"timeframe\": \"start\", \n \"paymentDate\": \"2025-08-10T00:00:00.000Z\", \n \"startIntervalDate\": \"2025-08-05T00:00:00.000Z\",\n \"endIntervalDate\": \"2024-12-18T00:00:00.000Z\" \n}"}},"schema":{"type":"object","properties":{"amount":{"type":"integer","example":1000000,"default":0},"fee":{"type":"integer","example":20000,"default":0},"fraudCoverageFee":{"type":"integer","example":0,"default":0},"anticipationAmount":{"type":"integer","example":900000,"default":0},"anticipationFee":{"type":"integer","example":80000,"default":0},"timeframe":{"type":"string","example":"start"},"paymentDate":{"type":"string","example":"2025-08-10T00:00:00.000Z"},"startIntervalDate":{"type":"string","example":"2025-08-05T00:00:00.000Z"},"endIntervalDate":{"type":"string","example":"2024-12-18T00:00:00.000Z"}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{ \"errors\": [{ \"type\": \"invalid_parameter_error\", \"parameter_name\": \"payment_date\", \"message\": \"A data de pagamento deve ser um dia útil.\" }] }"}},"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"invalid_parameter_error"},"parameter_name":{"type":"string","example":"payment_date"},"message":{"type":"string","example":"A data de pagamento deve ser um dia útil."}}}}}}}}}},"deprecated":false}},"/recipients/{recipient_id}/bulk_anticipations/limits":{"get":{"summary":"Obtendo os limites de antecipação","description":"Retorna os limites máximos e mínimos de antecipação que um recebedor pode fazer.","operationId":"obtendo-os-limites-de-antecipação","parameters":[{"name":"recipient_id","in":"path","description":"Identificador do recebedor","schema":{"type":"string"},"required":true},{"name":"payment_date","in":"query","description":"Data de pagamento desejada para a antecipação, ou seja, data em que você deseja que o dinheiro esteja em sua conta Pagar.me disponível para saque","required":true,"schema":{"type":"string"}},{"name":"timeframe","in":"query","description":"Define o período de onde os recebíveis serão escolhidos. start define recebíveis próximos, perto de serem pagos, e end define recebíveis longes, no final de todos recebíveis que você possui para receber","schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"maximum\": {\n \"amount\": 0,\n \"anticipation_fee\": 0,\n \"fee\": 0,\n \"fraud_coverage_fee\": 0\n },\n \"minimum\": {\n \"amount\": 0,\n \"anticipation_fee\": 0,\n \"fee\": 0,\n \"fraud_coverage_fee\": 0\n }\n}"}},"schema":{"type":"object","properties":{"maximum":{"type":"object","properties":{"amount":{"type":"integer","example":0,"default":0},"anticipation_fee":{"type":"integer","example":0,"default":0},"fee":{"type":"integer","example":0,"default":0},"fraud_coverage_fee":{"type":"integer","example":0,"default":0}}},"minimum":{"type":"object","properties":{"amount":{"type":"integer","example":0,"default":0},"anticipation_fee":{"type":"integer","example":0,"default":0},"fee":{"type":"integer","example":0,"default":0},"fraud_coverage_fee":{"type":"integer","example":0,"default":0}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{ \"errors\": [{ \"type\": \"not_found_error\", \"message\": \"Recipient não encontrado.\" }] }"}},"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"not_found_error"},"message":{"type":"string","example":"Recipient não encontrado."}}}}}}}}}},"deprecated":false}},"/recipients/{recipient_id}/bulk_anticipations/{bulk_anticipation_id}/cancel":{"post":{"summary":"Cancelando uma antecipação pending","description":"Cancela uma antecipação com status pending. Enquanto a antecipação foi criada e o Pagar.me ainda não a confirmou, você pode cancelar a antecipação a qualquer momento.","operationId":"cancelando-uma-antecipação-pending","parameters":[{"name":"recipient_id","in":"path","description":"ID de recebedor desejado","schema":{"type":"string"},"required":true},{"name":"bulk_anticipation_id","in":"path","description":"ID da antecipação desejada","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"ba_123456789\",\n \"status\": \"canceled\",\n \"amount\": 100000,\n \"fee\": 5000,\n \"fraud_coverage_fee\": 0,\n \"anticipation_fee\": 3000,\n \"automatic_transfer\": false,\n \"type\": \"spot\",\n \"timeframe\": \"start\",\n \"payment_date\": \"2025-08-20T00:00:00.000Z\",\n \"created_at\": \"2025-08-19T14:23:00.000Z\",\n \"updated_at\": \"2025-08-20T10:15:00.000Z\",\n \"anticipation_tax\": 0.018\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"ba_123456789"},"status":{"type":"string","example":"canceled"},"amount":{"type":"integer","example":100000,"default":0},"fee":{"type":"integer","example":5000,"default":0},"fraud_coverage_fee":{"type":"integer","example":0,"default":0},"anticipation_fee":{"type":"integer","example":3000,"default":0},"automatic_transfer":{"type":"boolean","example":false,"default":true},"type":{"type":"string","example":"spot"},"timeframe":{"type":"string","example":"start"},"payment_date":{"type":"string","example":"2025-08-20T00:00:00.000Z"},"created_at":{"type":"string","example":"2025-08-19T14:23:00.000Z"},"updated_at":{"type":"string","example":"2025-08-20T10:15:00.000Z"},"anticipation_tax":{"type":"number","example":0.018,"default":0}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{ \"errors\": [{ \"type\": \"invalid_parameter_error\", \"parameter_name\": \"id\", \"message\": \"ID inválido.\" }] }"}},"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","example":"invalid_parameter_error"},"parameter_name":{"type":"string","example":"id"},"message":{"type":"string","example":"ID inválido."}}}}}}}}}},"deprecated":false}},"/settlements":{"get":{"summary":"Retornando pagamentos","description":"Retorna um Array contendo objetos de pagamentos (settlements) de um recebedor ordenados a partir da data de criação colocando os mais recentes no topo.","operationId":"retornando-pagamentos","parameters":[{"name":"payment_date_start","in":"query","description":"Início da data de pagamento. Data no formato YYYY-MM-DD","required":true,"schema":{"type":"string"}},{"name":"payment_date_end","in":"query","description":"Fim da data de pagamento. Data no formato YYYY-MM-DD","required":true,"schema":{"type":"string"}},{"name":"liquidation_arrangement_id","in":"query","description":"ID da LiquidationArrangement","schema":{"type":"string"}},{"name":"page","in":"query","description":"Número da página","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"Limite de itens por página. Valor máximo = 2000","schema":{"type":"integer","format":"int32"}},{"name":"get_ispb","in":"query","description":"Se retorna ou não os dados de ISPB das Settlements","schema":{"type":"boolean"}},{"name":"liquidation_arrangement_id","in":"query","description":"ID da LiquidationArrangement para filtrar","schema":{"type":"string"}},{"name":"settlement_id","in":"query","description":"ID da Settlement para usar como base. O ID da LiquidationArrangement desta Settlement será utilizado como filtro. Sobrescreve o parâmetro liquidation_arrangement_id","schema":{"type":"string"}},{"name":"external_engine_payment_id","in":"query","description":"ID do motor de liquidação utilizado internamente","schema":{"type":"string"}},{"name":"order","in":"query","description":"Ordernar pela criação da Settlement crescente ou decrescente. String asc ou desc","schema":{"type":"string","default":"desc"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/recipients/{recipient_id}/settlements":{"get":{"summary":"Retornando pagamentos por recebedor","description":"Retorna um Array contendo objetos de pagamentos (settlements) de um recebedor ordenados a partir da data de criação colocando os mais recentes no topo.","operationId":"retornando-pagamentos-por-recebedor","parameters":[{"name":"recipient_id","in":"path","description":"ID do recebedor","schema":{"type":"string"},"required":true},{"name":"payment_date_start","in":"query","description":"Início da data de pagamento (inclusivo). Data no formato YYYY-MM-DD","required":true,"schema":{"type":"string"}},{"name":"payment_date_end","in":"query","description":"Fim da data de pagamento (inclusivo). Data no formato YYYY-MM-DD","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/settlements/{settlement_id}":{"get":{"summary":"Retornando um pagamento","description":"","operationId":"retornando-um-pagamento","parameters":[{"name":"settlement_id","in":"path","description":"ID do pagamento","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/transfers":{"post":{"summary":"Criando uma transferência","description":"Realiza uma transferência para uma conta bancária previamente criada.","operationId":"criando-uma-transferência","parameters":[{"name":"Idempotency-Key","in":"header","description":"Valor único que identifica a transação para permitir uma nova tentativa de requisição com a segurança de que a mesma operação não será executada duas vezes acidentalmente.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["amount"],"properties":{"amount":{"type":"integer","description":"Valor, em centavos, a ser transferido para uma determinada conta bancária (valor precisa estar entre 1 e 2147483647)","format":"int32"},"recipient_id":{"type":"string","description":"Indica que o valor da transferência sairá da conta do recebedor identificado por este parâmetro. OBS: Caso o recipient_id seja passado, não é necessário passar bank_account_id"},"metadata":{"type":"string","description":"Você pode passar dados adicionais na criação da transferência para facilitar uma futura análise de dados por seus sistemas.","format":"json"}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"object\": \"transfer\",\n \"id\": 65485,\n \"amount\": 100,\n \"type\": \"ted\",\n \"status\": \"pending_transfer\",\n \"source_type\": \"recipient\",\n \"source_id\": \"re_cix7pxz6f02ppcv6dn4ckcrcc\",\n \"target_type\": \"bank_account\",\n \"target_id\": \"17346045\",\n \"fee\": 367,\n \"funding_date\": null,\n \"funding_estimated_date\": \"2017-02-18T02:00:00.000Z\",\n \"transaction_id\": null,\n \"date_created\": \"2017-02-17T16:24:20.933Z\",\n \"bank_account\": {\n \"object\": \"bank_account\",\n \"id\": 17346045,\n \"bank_code\": \"000\",\n \"agencia\": \"00000\",\n \"agencia_dv\": \"2\",\n \"conta\": \"00000\",\n \"conta_dv\": \"00\",\n \"type\": \"conta_corrente\",\n \"document_type\": \"cpf\",\n \"document_number\": \"03602396681\",\n \"legal_name\": \"nome2\",\n \"charge_transfer_fees\": true,\n \"date_created\": \"2016-12-27T22:08:10.536Z\"\n },\n \"metadata\": {\n \"idProduto\": \"13933139\"\n }\n}"}},"schema":{"type":"object","properties":{"object":{"type":"string","example":"transfer"},"id":{"type":"integer","example":65485,"default":0},"amount":{"type":"integer","example":100,"default":0},"type":{"type":"string","example":"ted"},"status":{"type":"string","example":"pending_transfer"},"source_type":{"type":"string","example":"recipient"},"source_id":{"type":"string","example":"re_cix7pxz6f02ppcv6dn4ckcrcc"},"target_type":{"type":"string","example":"bank_account"},"target_id":{"type":"string","example":"17346045"},"fee":{"type":"integer","example":367,"default":0},"funding_date":{},"funding_estimated_date":{"type":"string","example":"2017-02-18T02:00:00.000Z"},"transaction_id":{},"date_created":{"type":"string","example":"2017-02-17T16:24:20.933Z"},"bank_account":{"type":"object","properties":{"object":{"type":"string","example":"bank_account"},"id":{"type":"integer","example":17346045,"default":0},"bank_code":{"type":"string","example":"000"},"agencia":{"type":"string","example":"00000"},"agencia_dv":{"type":"string","example":"2"},"conta":{"type":"string","example":"00000"},"conta_dv":{"type":"string","example":"00"},"type":{"type":"string","example":"conta_corrente"},"document_type":{"type":"string","example":"cpf"},"document_number":{"type":"string","example":"03602396681"},"legal_name":{"type":"string","example":"nome2"},"charge_transfer_fees":{"type":"boolean","example":true,"default":true},"date_created":{"type":"string","example":"2016-12-27T22:08:10.536Z"}}},"metadata":{"type":"object","properties":{"idProduto":{"type":"string","example":"13933139"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"get":{"summary":"Retornando transferências","description":"Retorna os dados de todas as transferências previamente realizadas.","operationId":"retornando-transferências","parameters":[{"name":"count","in":"query","description":"Retorna n resultados, com um máximo de 1000","schema":{"type":"string","default":"10"}},{"name":"cursor","in":"query","description":"Útil para implementação de uma paginação de resultados, permitindo a troca de páginas utilizando `x-cursor-nextpage` ou `x-cursor-previouspage`.","schema":{"type":"string"}},{"name":"x-cursor-nextpage","in":"query","description":"Retornado nos headers da resposta contém o Token que permite acesso a próxima página.","schema":{"type":"string"}},{"name":"x-cursor-previouspage","in":"query","description":"Retornado nos headers da resposta contém o Token que permite acesso a página anterior.","schema":{"type":"string"}},{"name":"bank_account_id","in":"query","description":"Filtro de bank account id","schema":{"type":"string"}},{"name":"amount","in":"query","description":"Filtro de amount","schema":{"type":"string"}},{"name":"recipient_id","in":"query","description":"Filtro de recipient id","schema":{"type":"string"}},{"name":"id","in":"query","description":"ID da transferência procurada","schema":{"type":"string"}},{"name":"date_created","in":"query","description":"Filtro de data da criação da transferência","schema":{"type":"string","format":"date"}},{"name":"created_at","in":"query","description":"Mesmo que date_created","schema":{"type":"string","format":"date"}},{"name":"status","in":"query","description":"Filtro para um dos status: pending_transfer, transferred, failed, processing, canceled","schema":{"type":"string"}},{"name":"date_updated","in":"query","description":"Filtro para data de último update","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"[\n {\n \"object\": \"transfer\",\n \"id\": 65485,\n \"amount\": 100,\n \"type\": \"ted\",\n \"status\": \"pending_transfer\",\n \"source_type\": \"recipient\",\n \"source_id\": \"re_cix7pxz6f02ppcv6dn4ckcrcc\",\n \"target_type\": \"bank_account\",\n \"target_id\": \"17346045\",\n \"fee\": 367,\n \"funding_date\": null,\n \"funding_estimated_date\": \"2017-02-18T02:00:00.000Z\",\n \"transaction_id\": null,\n \"date_created\": \"2017-02-17T16:24:20.933Z\",\n \"bank_response\": null,\n \"bank_account\": {\n \"object\": \"bank_account\",\n \"id\": 17346045,\n \"bank_code\": \"000\",\n \"agencia\": \"00000\",\n \"agencia_dv\": \"2\",\n \"conta\": \"00000\",\n \"conta_dv\": \"00\",\n \"type\": \"conta_corrente\",\n \"document_type\": \"cpf\",\n \"document_number\": \"03602396681\",\n \"legal_name\": \"nome2\",\n \"charge_transfer_fees\": true,\n \"date_created\": \"2016-12-27T22:08:10.536Z\"\n },\n \"metadata\": {\n \"idProduto\": \"13933139\"\n }\n },\n {\n \"object\": \"transfer\",\n \"id\": 65482,\n \"amount\": 1000,\n \"type\": \"ted\",\n \"status\": \"pending_transfer\",\n \"source_type\": \"recipient\",\n \"source_id\": \"re_ciu4jif1j007td56dsm17yew9\",\n \"target_type\": \"bank_account\",\n \"target_id\": \"17298390\",\n \"fee\": 367,\n \"funding_date\": null,\n \"funding_estimated_date\": \"2017-02-18T02:00:00.000Z\",\n \"transaction_id\": null,\n \"date_created\": \"2017-02-17T16:16:03.044Z\",\n \"bank_response\": null,\n \"bank_account\": {\n \"object\": \"bank_account\",\n \"id\": 17298390,\n \"bank_code\": \"000\",\n \"agencia\": \"0000\",\n \"agencia_dv\": null,\n \"conta\": \"00000\",\n \"conta_dv\": \"0\",\n \"type\": \"conta_corrente\",\n \"document_type\": \"cnpj\",\n \"document_number\": \"00000000000000\",\n \"legal_name\": \"CONTA BANCARIA DE TESTES\",\n \"charge_transfer_fees\": true,\n \"date_created\": \"2016-10-10T20:57:40.506Z\"\n },\n \"metadata\": {\n \"idProduto\": \"13933140\"\n }\n },\n {\n \"object\": \"transfer\",\n \"id\": 65481,\n \"amount\": 1000,\n \"type\": \"ted\",\n \"status\": \"pending_transfer\",\n \"source_type\": \"recipient\",\n \"source_id\": \"re_ciu4jif1j007td56dsm17yew9\",\n \"target_type\": \"bank_account\",\n \"target_id\": \"17298390\",\n \"fee\": 367,\n \"funding_date\": null,\n \"funding_estimated_date\": \"2017-02-18T02:00:00.000Z\",\n \"transaction_id\": null,\n \"date_created\": \"2017-02-17T16:15:54.089Z\",\n \"bank_response\": null,\n \"bank_account\": {\n \"object\": \"bank_account\",\n \"id\": 17298390,\n \"bank_code\": \"000\",\n \"agencia\": \"0000\",\n \"agencia_dv\": null,\n \"conta\": \"00000\",\n \"conta_dv\": \"0\",\n \"type\": \"conta_corrente\",\n \"document_type\": \"cnpj\",\n \"document_number\": \"00000000000000\",\n \"legal_name\": \"CONTA BANCARIA DE TESTES\",\n \"charge_transfer_fees\": true,\n \"date_created\": \"2016-10-10T20:57:40.506Z\"\n },\n \"metadata\": {\n \"idProduto\": \"13933141\"\n }\n }\n]"}},"schema":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"transfer"},"id":{"type":"integer","example":65485,"default":0},"amount":{"type":"integer","example":100,"default":0},"type":{"type":"string","example":"ted"},"status":{"type":"string","example":"pending_transfer"},"source_type":{"type":"string","example":"recipient"},"source_id":{"type":"string","example":"re_cix7pxz6f02ppcv6dn4ckcrcc"},"target_type":{"type":"string","example":"bank_account"},"target_id":{"type":"string","example":"17346045"},"fee":{"type":"integer","example":367,"default":0},"funding_date":{},"funding_estimated_date":{"type":"string","example":"2017-02-18T02:00:00.000Z"},"transaction_id":{},"date_created":{"type":"string","example":"2017-02-17T16:24:20.933Z"},"bank_response":{},"bank_account":{"type":"object","properties":{"object":{"type":"string","example":"bank_account"},"id":{"type":"integer","example":17346045,"default":0},"bank_code":{"type":"string","example":"000"},"agencia":{"type":"string","example":"00000"},"agencia_dv":{"type":"string","example":"2"},"conta":{"type":"string","example":"00000"},"conta_dv":{"type":"string","example":"00"},"type":{"type":"string","example":"conta_corrente"},"document_type":{"type":"string","example":"cpf"},"document_number":{"type":"string","example":"03602396681"},"legal_name":{"type":"string","example":"nome2"},"charge_transfer_fees":{"type":"boolean","example":true,"default":true},"date_created":{"type":"string","example":"2016-12-27T22:08:10.536Z"}}},"metadata":{"type":"object","properties":{"idProduto":{"type":"string","example":"13933139"}}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/transfers/{transfer_id}":{"get":{"summary":"Retornando uma transferência","description":"Retorna os dados de uma transferência em específico de sua conta.","operationId":"retornando-uma-transferência","parameters":[{"name":"transfer_id","in":"path","description":"ID da transferência desejada","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"object\": \"transfer\",\n \"id\": 65485,\n \"amount\": 100,\n \"type\": \"ted\",\n \"status\": \"pending_transfer\",\n \"source_type\": \"recipient\",\n \"source_id\": \"re_cix7pxz6f02ppcv6dn4ckcrcc\",\n \"target_type\": \"bank_account\",\n \"target_id\": \"17346045\",\n \"fee\": 367,\n \"funding_date\": null,\n \"funding_estimated_date\": \"2017-02-18T02:00:00.000Z\",\n \"transaction_id\": null,\n \"date_created\": \"2017-02-17T16:24:20.933Z\",\n \"bank_response\": null,\n \"bank_account\": {\n \"object\": \"bank_account\",\n \"id\": 17346045,\n \"bank_code\": \"000\",\n \"agencia\": \"00000\",\n \"agencia_dv\": \"2\",\n \"conta\": \"00000\",\n \"conta_dv\": \"00\",\n \"type\": \"conta_corrente\",\n \"document_type\": \"cpf\",\n \"document_number\": \"03602396681\",\n \"legal_name\": \"nome2\",\n \"charge_transfer_fees\": true,\n \"date_created\": \"2016-12-27T22:08:10.536Z\"\n },\n \"metadata\": {\n \"idProduto\": \"13933139\"\n }\n}"}},"schema":{"type":"object","properties":{"object":{"type":"string","example":"transfer"},"id":{"type":"integer","example":65485,"default":0},"amount":{"type":"integer","example":100,"default":0},"type":{"type":"string","example":"ted"},"status":{"type":"string","example":"pending_transfer"},"source_type":{"type":"string","example":"recipient"},"source_id":{"type":"string","example":"re_cix7pxz6f02ppcv6dn4ckcrcc"},"target_type":{"type":"string","example":"bank_account"},"target_id":{"type":"string","example":"17346045"},"fee":{"type":"integer","example":367,"default":0},"funding_date":{},"funding_estimated_date":{"type":"string","example":"2017-02-18T02:00:00.000Z"},"transaction_id":{},"date_created":{"type":"string","example":"2017-02-17T16:24:20.933Z"},"bank_response":{},"bank_account":{"type":"object","properties":{"object":{"type":"string","example":"bank_account"},"id":{"type":"integer","example":17346045,"default":0},"bank_code":{"type":"string","example":"000"},"agencia":{"type":"string","example":"00000"},"agencia_dv":{"type":"string","example":"2"},"conta":{"type":"string","example":"00000"},"conta_dv":{"type":"string","example":"00"},"type":{"type":"string","example":"conta_corrente"},"document_type":{"type":"string","example":"cpf"},"document_number":{"type":"string","example":"03602396681"},"legal_name":{"type":"string","example":"nome2"},"charge_transfer_fees":{"type":"boolean","example":true,"default":true},"date_created":{"type":"string","example":"2016-12-27T22:08:10.536Z"}}},"metadata":{"type":"object","properties":{"idProduto":{"type":"string","example":"13933139"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/transfers/{transfer_id}/cancel":{"post":{"summary":"Cancelando uma transferência","description":"Cancela uma transferência previamente realizada. Só é possível cancelar transferências com status **pending_transfer**.","operationId":"cancelando-uma-transferência","parameters":[{"name":"transfer_id","in":"path","description":"ID da transferência a ser cancelada","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"object\": \"transfer\",\n \"id\": 65485,\n \"amount\": 100,\n \"type\": \"ted\",\n \"status\": \"canceled\",\n \"source_type\": \"recipient\",\n \"source_id\": \"re_cix7pxz6f02ppcv6dn4ckcrcc\",\n \"target_type\": \"bank_account\",\n \"target_id\": \"17346045\",\n \"fee\": 367,\n \"funding_date\": null,\n \"funding_estimated_date\": \"2017-02-18T02:00:00.000Z\",\n \"transaction_id\": null,\n \"date_created\": \"2017-02-17T16:24:20.933Z\",\n \"bank_response\": null,\n \"bank_account\": {\n \"object\": \"bank_account\",\n \"id\": 17346045,\n \"bank_code\": \"000\",\n \"agencia\": \"00000\",\n \"agencia_dv\": \"2\",\n \"conta\": \"00000\",\n \"conta_dv\": \"00\",\n \"type\": \"conta_corrente\",\n \"document_type\": \"cpf\",\n \"document_number\": \"03602396681\",\n \"legal_name\": \"nome2\",\n \"charge_transfer_fees\": true,\n \"date_created\": \"2016-12-27T22:08:10.536Z\"\n },\n \"metadata\": {\n \"idProduto\": \"13933139\"\n }\n}"}},"schema":{"type":"object","properties":{"object":{"type":"string","example":"transfer"},"id":{"type":"integer","example":65485,"default":0},"amount":{"type":"integer","example":100,"default":0},"type":{"type":"string","example":"ted"},"status":{"type":"string","example":"canceled"},"source_type":{"type":"string","example":"recipient"},"source_id":{"type":"string","example":"re_cix7pxz6f02ppcv6dn4ckcrcc"},"target_type":{"type":"string","example":"bank_account"},"target_id":{"type":"string","example":"17346045"},"fee":{"type":"integer","example":367,"default":0},"funding_date":{},"funding_estimated_date":{"type":"string","example":"2017-02-18T02:00:00.000Z"},"transaction_id":{},"date_created":{"type":"string","example":"2017-02-17T16:24:20.933Z"},"bank_response":{},"bank_account":{"type":"object","properties":{"object":{"type":"string","example":"bank_account"},"id":{"type":"integer","example":17346045,"default":0},"bank_code":{"type":"string","example":"000"},"agencia":{"type":"string","example":"00000"},"agencia_dv":{"type":"string","example":"2"},"conta":{"type":"string","example":"00000"},"conta_dv":{"type":"string","example":"00"},"type":{"type":"string","example":"conta_corrente"},"document_type":{"type":"string","example":"cpf"},"document_number":{"type":"string","example":"03602396681"},"legal_name":{"type":"string","example":"nome2"},"charge_transfer_fees":{"type":"boolean","example":true,"default":true},"date_created":{"type":"string","example":"2016-12-27T22:08:10.536Z"}}},"metadata":{"type":"object","properties":{"idProduto":{"type":"string","example":"13933139"}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/transfers/{transfer_id}/receipt":{"post":{"summary":"Retornando o comprovante de uma transferência","description":"Retorna o comprovante de uma transferência realizada com sucesso. Só é possível retornar comprovantes de transferências com status **transferred**.","operationId":"retornando-o-comprovante-de-uma-transferência","parameters":[{"name":"transfer_id","in":"path","description":"ID da transferência que se deseja buscar o comprovante","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":""}}}}},"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} ```