swagger: '2.0' schemes: - https consumes: - application/json produces: - application/json host: api-homologacao.getnet.com.br info: title: Referência da API | Plataforma Digital version: 1.0.10 description: | # API ## Introdução O objetivo deste documento é descrever a interface das APIs de integração da Plataforma Digital da Getnet com o E-commerce. tags: - name: Autenticação x-displayName: Autenticação description: | As API’s listadas nessa documentação utilizam autenticação OAuth2, isso significa que em todas as requisições é necessário informar um token de acesso que será obtido através da autenticação com o seu **Client ID** e **Client Secret**. - name: Tokenização PCI x-displayName: Tokenização PCI description: | Para efetuar transações de forma segura o número do cartão deve ser tokenizado previamente em todas as requisições antes de ser trafegado em conjunto com os demais dados, como nome do portador, data de validade e cvv. - name: Tokenização Bandeira x-displayName: Tokenização Bandeira description: | A tokenização de bandeira é um serviço que prevê a substituição do PAN (número de conta principal) por um token, provisionado diretamente com as bandeiras de cartão. O diferencial presente na tokenização de bandeira está atrelado ao modelo de token gerado, o qual é interoperável e pode ser transacionado nos adquirentes que estão aderentes ao seu processamento, visto que o número desse token segue a mesma configuração de um PAN contendo 16 dígitos, BIN e digito verificador. Dessa forma, a leitura dos dados permanece com a mesma configuração e segurança.Além disso, em toda transação com um token de bandeira é necessário a geração de um criptograma, que adiciona maior segurança as transações de e-commerce e verifica se o token enviado realmente é válido e pode ser transacionado. ***Bandeiras Disponíveis para Tokenização na Getnet:*** * VISA * MASTERCARD ***OBS:*** Os tokens e criptogramas precisam ser gerados no mesmo provedor de tokens para que possam ser transacionados. O número do token deve ser preenchido no campo: **number_token**, no nó "card", disponível nas chamadas de pagamento com cartão, junto com a sua respectiva data de validade. Para ocorrer a leitura das informações geradas no processo de solicitação de tokens no momento do pagamento é necessário preencher algumas informações adicionais, disponíveis no nó "tokenization" em qualquer chamada de pagamentos com cartão (autorização), as quais são: * **type**: bandeira a qual se destina o token: * UCAF (Mastercard); * TAVV (Visa) * **cryptogram**: Valor de criptograma gerado em "Geração de criptograma do cartão". * **eci**: preenchido com: * 07 (Visa); * 06 (Mastercard). ***OBS:*** No caso da Mastercard, caso seja uma transação recorrente é necessário sinalizar o ECI como 07 realizando as devidas marcações de COF presente em pagamentos com cartão (autorização). * **requestor_id**: caso utilize o serviço de tokenização Getnet, não é necessário preencher essa informação. ***NOTA:*** O serviço de tokenização Getnet precisa ser contrato antes do uso e está sujeito a cobranças pela utilização. - name: Cofre x-displayName: Cofre description: | Este produto oferece aos clientes a possibilidade de guardar as informações dos cartões de seus compradores para utilização em futuras compras. Tudo isso garantido pelas melhores práticas de segurança, conforme orientações da certificação PCI. Com esta solução é possível armazenar os dados dos cartões (número do cartão, nome do portador e data de vencimento) para pagamentos com modalidade recorrente, por exemplo, assinaturas que possam ser oferecidas para os seus clientes, garantindo desta forma que os pagamentos das parcelas desta assinatura sejam realizados sem a necessidade do cartão presente, mas com as garantias exigidas pelos Emissores e Bandeiras de cartões. Neste produto estão disponíveis os métodos: * Armazena os dados de cartão do consumidor no cofre (novo cartão), * Listagem de cartões salvos, * Recuperação dos dados de um cartão salvo. * Remoção de um cartão salvo. ***É importante salientar que a solução de Cofre da Getnet é um produto disponível na Plataforma Digital, ou seja, pode ser utilizado somente mediante a contratação de um pacote que possua este produto.*** - name: Pagamento x-displayName: Pagamento description: | Para efetuar transações relacionadas a pagamento utilize os endpoints descritos abaixo mediante autenticação. - name: Pagamento Combinado x-displayName: Pagamento Combinado description: | Para efetuar transações relacionadas a pagamento combinado utilize os endpoints descritos abaixo mediante autenticação. - name: QRCode x-displayName: QRCode description: | Para efetuar transações relacionadas a pagamento com QRCode utilize os endpoints descritos abaixo mediante autenticação OAuth2. - name: PIX x-displayName: PIX description: | Para efetuar transações relacionadas a pagamento com PIX utilize o(s) endpoint(s) descrito(s) abaixo mediante autenticação OAuth2. - name: Autenticação 3DS x-displayName: Autenticação 3DS description: | Para efetuar transações relacionadas a autenticação 3DS utilize os endpoints descritos abaixo mediante autenticação OAuth2. - name: Pagamento Autenticado 3DS x-displayName: Pagamento Autenticado 3DS description: | Para efetuar transações relacionadas a pagamento autenticado utilize os endpoints descritos abaixo mediante autenticação OAuth2. - name: GetPay x-displayName: GetPay description: | A API Getpay permite ao lojista, criar, editar e consultar transações por link de pagamento. Ao clicar em GetPay o comprador é levado para o ambiente Getnet com identificação do comprador, endereço de entrega e checkout Getnet para finalização da compra. Para contratação procure seu gerente ou entre em contato através do **4020 4009**. ***Para pagamentos em homologação, é necessário informar o TokenSMS = 123456 , quando solicitado, na etapa de verificação dos dados do cliente.*** Abaixo os endpoints para criação e gestão dos GetPays: - name: Cancelamento x-displayName: Cancelamento description: | Para possibilitar a solicitação de cancelamento de pagamentos com cartões de crédito utilize os endpoints abaixo mediante autenticação. - name: Recorrência x-displayName: Recorrência description: | A Recorrência Getnet permite a gestão das cobranças de forma fácil e rápida. É necessária apenas cadastrar o cliente, o plano de periodicidade e uma assinatura para vincular o cliente ao plano. Para ter o serviço de recorrência você deve contratar o pacote Recorrência ou o pacote Modular com recorrência e cofre. Veja abaixo os endpoints responsáveis para gestão de cobranças de recorrência: - name: Clientes x-displayName: Clientes description: | Para que a recorrência funcione é necessário cadastrar um cliente. O cliente é o consumidor do produto/serviço oferecido na assinatura. - name: Planos x-displayName: Planos description: | Para que a recorrência funcione é necessário cadastrar um plano. O plano é o que definirá a forma de como os pagamentos recorrentes serão aplicados. No plano são definidas as informações do valor da parcela, a periodicidade e a quantidade de parcelas. A quantidade de parcelas pode ser vitalícia ou finita, sendo vitalícia um tempo indefinido para o encerramento das parcelas e finita um tempo determinado para o encerramento das parcelas. A periodicidade pode ser: * Anual, cobra 1 vez ao ano; * Mensal, cobra 1 vez por mês; * Bimensal, cobra 1 vez a cada 2 meses; * Trimestral, cobra 1 vez a cada 3 meses; * Semestral, cobra 1 vez a cada 6 meses; * Especifico, ciclo específico de cobrança em dias. - name: Assinaturas x-displayName: Assinaturas description: | Para que a recorrência funcione é necessário vincular o cliente e o plano através da assinatura. Assinatura é o que irá ser respeitado em toda cobrança recorrente a partir do que foi descrito e parametrizado em sua criação. - name: Consulta BIN x-displayName: Consulta BIN description: | Execute a verificação dos BINs dos cartões, validando os dados para evitar fraudes. O BIN de um cartão corresponde dos 4 primeiros até o nono digito. paths: /auth/oauth/v2/token: post: summary: Geração do token de acesso description: Endpoint responsável pela geração do token de acesso utilizado nas demais requisições, para isso utilizamos [HTTP Basic Authentication](https://www.w3.org/Protocols/HTTP/1.0/draft-ietf-http-spec.html#BasicAA) tags: - Autenticação consumes: - application/x-www-form-urlencoded produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/x-www-form-urlencoded default: application/x-www-form-urlencoded description: | Tipo do conteúdo padrão application/x-www-form-urlencoded. - in: header name: Authorization required: true type: string description: | Authorization: Basic AuthString Onde **AuthString** é a concatenação do seu **Client ID**, seguido de ":" (dois pontos) mais o seu **Client Secret**, convertidos para base64. **Exemplo**: Para o Client ID igual a "client-01" e Client Secret igual a "secret-key-02", teremos o texto client-01:secret-key-02 após a concatenação, convertendo para base64 teremos o resultado "Y2xpZW50LTAxOnNlY3JldC1rZXktMDI=". Neste caso o Authorization no header da requisição será: Authorization: Basic Y2xpZW50LTAxOnNlY3JldC1rZXktMDI= - in: formData required: true type: string name: scope description: Usar o valor fixo "oob" default: oob - in: formData required: true type: string name: grant_type description: Usar O valor fixo "client_credentials" default: client_credentials responses: '200': description: Retorna o token de acesso. schema: type: object properties: access_token: type: string description: Token de acesso a API para envio em todas as requisições example: ca22a2ge-1914-4b0c-a0fb-d3ce0fde7346 format: uuidv4 minLength: 36 maxLength: 36 token_type: type: string description: Tipo do token, deve ser enviado no header junto do token (https://tools.ietf.org/html/rfc6750) example: Bearer expires_in: type: number description: Tempo de expiração do token em segundos example: 3600 scope: type: string description: Escopo do token example: oob '400': description: Requisição inválida. schema: $ref: '#/definitions/error_authentication' '401': description: Não autorizado. schema: $ref: '#/definitions/error_authentication' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/auth/oauth/v2/token \ -H 'authorization: Basic Y2xpZW50LTAxOnNlY3JldC1rZXktMDI=' \ -H 'content-type: application/x-www-form-urlencoded' \ -d 'scope=oob&grant_type=client_credentials' /v1/tokens/card: post: summary: Geração do token do cartão description: | Para efetuar transações de forma segura os dados do cartão, exceto CVV, devem ser *tokenizados*, esse processo é feito pelo endpoint descrito abaixo mediante autenticação. tags: - Tokenização PCI consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Tipo do conteúdo. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. - in: header name: seller_id required: false type: string description: | Código de identificação do e-commerce. ***Obrigatório quando o cliente for tratado como Plataforma.*** format: uuidv4 minLength: 36 maxLength: 36 - in: body name: token_card description: Dados do cartão e do comprador schema: type: object required: - card_number properties: card_number: type: string description: Número do cartão minLength: 13 maxLength: 19 example: '5155901222280001' customer_id: type: string description: Identificador do comprador. Informação definida pela aplicação que consome a api da Plataforma Digital. example: customer_21081826 maxLength: 100 responses: '201': description: Retorna o token do cartão. schema: type: object properties: number_token: type: string description: | Token do cartão que será utilizado nas transações. Caso a resposta HTTP contenha o header "Content-Encoding:gzip" ( RFC 2616 tópico 14.11 Content-Encoding ) a resposta deve passar por um processo de descompactação, dependendo da tecnologia utilizada para integração será necessário a utilização de uma biblioteca de terceiros. example: 'dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c' minLength: 128 maxLength: 128 '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/tokens/card \ -H 'authorization: Bearer ca22a2ge-1914-4b0c-a0fb-d3ce0fde7346' \ -H 'content-type: application/json; charset=utf-8' \ -d '{ "card_number": "5155901222280001" }' /v1/tokenization/token: post: summary: Geração do token do cartão description: | Para efetuar transações de forma segura os dados do cartão, exceto CVV, devem ser **tokenizados**, esse processo é feito pelo endpoint descrito abaixo mediante autenticação. tags: - Tokenização Bandeira consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Tipo do conteúdo. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. - in: body name: token_card description: Dados do cartão e do comprador schema: type: object required: - customer_id (cpf ou identificador unico) - card_pan - card_pan_source - card_brand - expiration_year - expiration_month - email properties: customer_id: type: string description: | Identificador do comprador. Informação definida pela aplicação que consome a api da Plataforma Digital. Obs. Usar em conjunto com o Número do cartão. example: customer_45678900, 123.456.789-00 ou 12345678900 card_pan: type: string description: Número do cartão minLength: 13 maxLength: 19 example: '4622943120000493' card_pan_source: type: string description: | Source do Cartão. Valores possiveis. * ON_FILE (O solicitante do token já possui os dados PAN em seus registros) * MANUALLY_ENTERED (Os dados do PAN foram digitados pelo titular do cartão) * VIA_APPLICATION (Os dados PAN (ou referência) foram fornecidos por um Aplicativo Emissor) example: ON_FILE, MANUALLY_ENTERED ou VIA_APPLICATION card_brand: type: string description: Identificador da Bandeira. Valores possiveis VISA e MASTERCARD. example: VISA, MASTERCARD expiration_year: type: string description: Ano de expiração. format: string example: '2023' expiration_month: type: string description: Mês de expiração. format: string example: '07' security_code: type: string description: cvv. format: string example: 1234 email: type: string description: Email do comprador. format: email example: tokenizacao_bandeiras@getnet.com.br responses: '200': description: Retorna o token do cartão. schema: type: object properties: network_token_id: type: string description: Token do cartão que será utilizado na geração de criptograma. example: 1b110aaa71934ae492bff48baab9af81 status: type: string description: Status do Token. example: ACTIVE '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/tokenization/token \ -H 'authorization: Bearer ca22a2ge-1914-4b0c-a0fb-d3ce0fde7346' \ -H 'content-type: application/json; charset=utf-8' \ -d '{ customer_id: 'customer_45678900' email: test@merchant.com card_brand: 'Mastercard' card_pan_source: ON_FILE card_pan: '5204731600014784' security_code: '226' expiration_month: '12' expiration_year: '2023' }' /v1/tokenization/crypt: post: summary: Geração de criptograma do cartão description: Para efetuar transações de forma segura os dados do cartão, o network_token_id devem ser *criptografados*, esse processo é feito pelo endpoint descrito abaixo mediante autenticação. tags: - Tokenização Bandeira consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Tipo do conteúdo. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. - in: body name: token_card_crypt description: Dados do cartão e do comprador schema: type: object required: - network_token_id - transaction_type - cryptogram_type - amount - customer_id - email - card_brand properties: network_token_id: type: string description: Token obtido no endpoint anterior. example: 1b110aaa71934ae492bff48baab9af81 transaction_type: type: string description: Tipo de Criptograma. Valores possiveis. CIT (Transação Iniciada pelo Cliente) ou MIT (Transação Iniciada pelo Comerciante - pagamento recorrente). example: CIT ou MIT cryptogram_type: type: string description: Indentificador da Bandeira. Valores possiveis. VISA_TAVV(valor de verificação de autenticação do token VISA) ou MC_DSRP_LONG (controle remoto seguro digital Mastercard) example: VISA_TAVV ou MC_DSRP_LONG amount: type: number description: Valor monetario da transação em centavos. example: 100 customer_id: type: string description: Identificador do comprador. Informação definida pela aplicação que consome a api da Plataforma Digital. Obs. Usar em conjunto com o Número do cartão. example: customer_45678900, 123.456.789-00 ou 12345678900 email: type: string description: Email do comprador. format: email example: tokenizacao_bandeira@getnet.com.br card_brand: type: string description: Identificador da Bandeira. Valores possiveis VISA e MASTERCARD. example: VISA, MASTERCARD responses: '200': description: Retorna o criptograma do cartão. schema: type: object properties: cryptogram: type: string description: Criptograma do cartão que será utilizado nas transações. example: MF5GJksAAJU1ASH4Eo7gAAADFAM= token_pan_card: type: string description: Novo pan tokenizado. example: '5204731618934544' token_expiration_month: type: string description: Novo mês de expiração do pan tokenizado. example: '11' token_expiration_year: type: string description: Novo ano de expiração do pan tokenizado. example: '2026' token_status: type: string description: Criptograma do cartão que será utilizado nas transações. example: ACTIVE '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/tokenization/crypt \ -H 'authorization: Bearer ca22a2ge-1914-4b0c-a0fb-d3ce0fde7346' \ -H 'content-type: application/json; charset=utf-8' \ -d '{ cryptogram: "MF5GJksAAJU1ASH4Eo7gAAADFAM=", token_pan_card: "5204731618934544", token_expiration_month: "11", token_expiration_year: "2026", token_status: "ACTIVE" }' /v1/cards/verification: post: summary: Verificação de cartão description: O objetivo da transação de verificação de cartão de crédito é verificar se o cartão de crédito informado pelo portador é um cartão válido. Entende-se como um cartão crédito válido um cartão que não está cancelado, bloqueado ou com restrições. Para verificar funcionalidade, clique aqui. tags: - Pagamento consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Tipo do conteúdo. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. - in: header name: seller_id required: false type: string description: | Authorization: Código de identificação do e-commerce. Obrigatório quando o cliente for tratado como Plataforma. format: uuidv4 minLength: 36 maxLength: 36 - in: body name: verification_card_body required: true description: Requisição contendo os dados de cartão para verificação. schema: $ref: '#/definitions/verification_card_body' responses: '200': description: Verificação de cartão executada com sucesso. schema: type: object properties: status: type: string description: Status da verificação do cartão, onde VERIFIED é o indicativo de que o cartão foi validado com sucesso. enum: - VERIFIED - NOT VERIFIED - DENIED - ERROR example: VERIFIED minLength: 5 maxLength: 20 verification_id: type: string format: uuidv4 description: Identificação do pedido de verificação na plataforma digital. example: ae267804-503c-4163-b1b1-f5da5120b74e minLength: 36 maxLength: 36 authorization_code: type: string description: Número de autorização gerado pelo sistema de verificação de cartão. example: '6964722471672911' minLength: 1 maxLength: 18 transaction_id: type: string description: Código de transação da verificação. example: '6964722471672911' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/cards/verification \ -H 'authorization: Bearer 4d98da5d-767b-4db6-b581-b664e829bd41' \ -H 'content-type: application/json; charset=utf-8 ' \ -d ' { "number_token": "3fdb3ac9a6def80bf64cd241b9035e77ed8757032d356718864d03465a1130e20d8a897005e144dd6c1a5b4e63fcc99d3755f9e18a7cd852ad82778c65008988", "brand":"mastercard", "cardholder_name": "JOAO DA SILVA", "expiration_month" : "10", "expiration_year" : "28", "security_code" : "123" }' /v1/cards: post: summary: Armazena os dados de cartão do consumidor no cofre description: Cria um recurso cards dentro da plataforma digital Getnet a partir dos dados de cartão do consumidor, para uso em pagamentos futuros. tags: - Cofre consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Tipo do conteúdo. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. - in: header name: seller_id required: false type: string description: | Authorization: Código de identificação do e-commerce. format: uuidv4 minLength: 36 maxLength: 36 - in: body name: vault_card_body required: true description: Requisição contendo os dados de cartão para salvamento no cofre. schema: $ref: '#/definitions/vault_card' responses: '201': description: Identificador do cartão criado com sucesso. Cartão salvo no cofre. schema: type: object properties: card_id: type: string description: Identificador do cartão salvo no cofre, pode ser utilizado para recuperar um number_token valido para futuras compras, como também pode ser utilizado para remover cartões salvos. example: e8ad2ae4-9e3e-4532-998f-1a5a11e56e58 format: uuidv4 minLength: 36 maxLength: 36 number_token: type: string description: Token do cartão que será utilizado nas transações. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Produto cofre não habilitado. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/cards \ -H 'authorization: Bearer ca22a2ge-1914-4b0c-a0fb-d3ce0fde7346' \ -H 'content-type: application/json; charset=utf-8' \ -d '{ "number_token": "dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c", "cardholder_name": "JOAO DA SILVA", "expiration_month": "12", "expiration_year": "28", "customer_id": "customer_21081826", "cardholder_identification": "12345678912" }' get: summary: Lista de cartões salvos no cofre description: Retorna uma lista de cartões salvos com base nos dados de identificação do comprador - customer_id. tags: - Cofre produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - in: header name: seller_id required: false type: string description: | Authorization: Código de identificação do e-commerce. Obrigatório quando o cliente for tratado como Plataforma. format: uuidv4 minLength: 36 maxLength: 36 - required: true description: Identificador do comprador. Informação definida pela aplicação que consome a api da Plataforma Digital. type: string name: customer_id maxLength: 100 in: query - required: false description: Filtro de status dos cartões retornados. Caso não seja informado nenhum filtro, serão retornados os cartões ativos e renovados. enum: - all - active - renewed type: string name: status maxLength: 25 in: query responses: '200': description: Lista de cartões salvos. schema: type: object properties: cards: type: array items: $ref: '#/definitions/vault_card_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Produto cofre não habilitado. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/cards?customer_id=customer_21081826 \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' /v1/cards/{card_id}: get: summary: Recupera um cartão salvo no cofre description: Obtém os dados do cartão salvo no cofre, a partir do card_id gerado no momento do armazenamento do cartão. tags: - Cofre produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - in: header name: seller_id required: false type: string description: | Authorization: Código de identificação do e-commerce. Obrigatório quando o cliente for tratado como Plataforma. format: uuidv4 minLength: 36 maxLength: 36 - required: true description: Identificador único do cartão na plataforma digital Getnet. type: string name: card_id maxLength: 36 in: path responses: '200': description: Dados do cartão. schema: $ref: '#/definitions/vault_card_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Produto cofre não habilitado. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/cards/14a2ce5d-ebc3-49dc-a516-cb5239b02285 \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' delete: summary: Remove um cartão salvo no cofre description: Remove um cartão salvo na plataforma digital Getnet, a partir do card_id. tags: - Cofre produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - in: header name: seller_id required: false type: string description: | Authorization: Código de identificação do e-commerce. Obrigatório quando o cliente for tratado como Plataforma. format: uuidv4 minLength: 36 maxLength: 36 - required: true description: Identificador único do cartão na plataforma digital Getnet. type: string name: card_id maxLength: 36 in: path responses: '204': description: Cartão removido com sucesso. '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Produto cofre não habilitado. schema: $ref: '#/definitions/error' '404': description: Recurso não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X DELETE \ https://api-homologacao.getnet.com.br/v1/cards/14a2ce5d-ebc3-49dc-a516-cb5239b02285 \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' /v1/payments/credit: post: summary: Pagamento com cartão de crédito description: | Nesse endpoint serão recebidos dados para pagamento com cartão de crédito. Para o os campos delayed e pre_authorization, somente um deles podem estar com valor true, indicando assim somente um serviço de crédito a ser processado. tags: - Pagamento consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Tipo do conteúdo. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. - in: body name: credit_body required: true description: Requisição contendo os dados para pagamento com cartão de crédito e análise de fraude. schema: $ref: '#/definitions/payment_credit' responses: '200': description: Pagamento efetuado com sucesso. Transação aprovada. schema: $ref: '#/definitions/payment_credit_response' '202': description: Solicitação de pagamento de crédito com confirmação tardia ou pré autorização recebida, aceita e armazenada esperando confirmação. schema: $ref: '#/definitions/payment_credit_pre_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error_credit' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error_credit' '402': description: Requisição é válida mas pagamento negado. Pode ser negado por vários motivos / regras de negócios. schema: $ref: '#/definitions/error_credit' '404': description: Não encontrado. schema: $ref: '#/definitions/error_credit' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error_credit' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/credit \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -d '{ "seller_id": "6eb2412c-165a-41cd-b1d9-76c575d70a28", "amount": 100, "currency": "BRL", "order": { "order_id": "6d2e4380-d8a3-4ccb-9138-c289182818a3", "sales_tax": 0, "product_type": "service" }, "customer": { "customer_id": "customer_21081826", "first_name": "João", "name": "João da Silva", "email": "customer@email.com.br", "document_type": "CPF", "phone_number": "5551999887766", "billing_address": { "street": "Av. Brasil", "number": "1000", "complement": "Sala 1", "district": "São Geraldo", "city": "Porto Alegre", "state": "RS", "country": "Brasil", "postal_code": "90230060" } }, "credit": { "delayed": false, "save_card_data": false, "transaction_type": "FULL", "number_installments": 1, "soft_descriptor": "LOJA*TESTE*COMPRA-123", "dynamic_mcc": 1799, "card": { "number_token": "dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c", "bin": "123412", "security_code": "123", "expiration_month": "12", "expiration_year": "28", "cardholder_name": "JOAO DA SILVA" } } }' /v1/payments/credit/{payment_id}/confirm: post: summary: Confirmação tardia de pagamento ou confirmação de pré autorização com cartão de crédito description: Quando uma transação de crédito é feita com a opção delayed = true ou pre_authorization = true, confirmação tardia ou pré autorização, respectivamente, ela pode ser posteriormente confirmada, este endpoint é responsável pela confirmação. tags: - Pagamento consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Tipo do conteúdo. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. - in: path name: payment_id description: Identificador do pagamento previamente recebido e aceito. type: string minLength: 36 maxLength: 36 format: uuidv4 required: true - in: body name: body description: Requisição contendo os dados para uma solicitação de confirmação de crédito tardio ou pré autorizado. schema: $ref: '#/definitions/credit_confirm' required: false responses: '200': description: Pagamento confirmado com sucesso. schema: $ref: '#/definitions/credit_delayed_confirm' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '402': description: Requisição é válida mas pagamento negado. Pode ser negado por vários motivos / regras de negócios. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/credit/06f256c8-1bbf-42bf-93b4-ce2041bfb87e/confirm \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json; charset=utf-8' \ /v1/payments/credit/{payment_id}/adjustment: post: summary: Ajustar valor de uma transação de pré autorização description: Executa um ajuste (Incremento/Decremento) no valor previamente reservado no saldo do Portador por uma Transação de Pré-Autorização. O valor da Transação de Ajuste de Pré-Autorização pode ser maior ou menor que o valor original. Na chamada do processo de ajuste sempre deve ser enviado o valor final desejado no campo de amount. tags: - Pagamento consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Tipo do conteúdo. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. - in: path name: payment_id description: Identificador do pagamento previamente recebido e aceito. type: string minLength: 36 maxLength: 36 format: uuidv4 required: true - in: body name: body description: Requisição contendo os dados para uma solicitação de ajuste de valor de uma Pré-Autorização. schema: $ref: '#/definitions/credit_preauthorized_adjustment' required: true responses: '200': description: Ajuste realizado com sucesso. schema: $ref: '#/definitions/credit_preauthorized_adjustment_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '402': description: Requisição é válida mas o ajuste foi negado. Pode ser negado por vários motivos / regras de negócios. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/credit/06f256c8-1bbf-42bf-93b4-ce2041bfb87e/adjustment \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json; charset=utf-8' \ -d '{ "amount": 19990, "currency": "BRL", "dynamic_mcc": 6666, "soft_descriptor": "LOJA*TESTE*COMPRA-123" }' /v1/payments/credit/{payment_id}/cancel: post: summary: Cancelar pagamento no cartão de crédito description: | Cancelar transação de crédito completa ou cancelar/desfazer transação de crédito tardio ou transação de pré autorização. Caso a transação já esteja confirmada, o cancelamento é permitido apenas no mesmo dia (D0) em que esta transação foi realizada. No entanto se a transação encontra-se autorizada (AUTHORIZED) o desfazimento pode ser realizado em até 7 dias para crédito tardio ou em até 30 dias para pré autorização. * Estorna ou desfaz transações feitas no mesmo dia (D0). tags: - Pagamento consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Tipo do conteúdo. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. - in: path name: payment_id description: Identificador do pagamento previamente recebido e aceito. type: string minLength: 36 maxLength: 36 format: uuidv4 required: true responses: '200': description: Pagamento cancelado com sucesso. schema: $ref: '#/definitions/credit_delayed_cancel' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '402': description: Requisição é válida mas pagamento negado. Pode ser negado por vários motivos / regras de negócios. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/credit/06f256c8-1bbf-42bf-93b4-ce2041bfb87e/cancel \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json; charset=utf-8' \ /v1/payments/debit: post: summary: Pagamento com cartão de débito description: | Nesse endpoint serão recebidos dados para pagamento com cartão de débito. ### Fluxo Transação de Débito Não Autenticado Débito não autenticado é aquele que não possui desafio, para habilita-lo você precisa entrar em contato com a central de atendimento através do número: 4020 4009. Lembrando que para a transação acontecer além de estar habilitado na Getnet o emissor precisa permitir essa modalidade. A seguir os endpoints necessários: tags: - Pagamento consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Tipo do conteúdo. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. - in: body name: debit_body required: true description: Requisição contendo os dados para pagamento com cartão de débito e análise de fraude. schema: $ref: '#/definitions/payment_debit' responses: '200': description: Pagamento realizado com sucesso. Transação aprovada. schema: $ref: '#/definitions/payment_debit_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error_debit' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error_debit' '402': description: Requisição é válida mas pagamento negado. Pode ser negado por vários motivos / regras de negócios. schema: $ref: '#/definitions/error_debit' '404': description: Não encontrado. schema: $ref: '#/definitions/error_debit' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error_debit' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/debit \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -d '{ "seller_id": "6eb2412c-165a-41cd-b1d9-76c575d70a28", "amount": 100, "currency": "BRL", "order": { "order_id": "6d2e4380-d8a3-4ccb-9138-c289182818a3", "sales_tax": 0, "product_type": "service" }, "customer": { "customer_id": "customer_21081826", "first_name": "João", "name": "João Silva", "document_type": "CPF", "document_number": "12345678912", "phone_number": "5551999887766", "billing_address": { "street": "Av. Brasil", "complement": "Sala 1", "number": "1000", "district": "São Geraldo", "city": "Porto Alegre", "state": "RS", "country": "Brasil", "postal_code": "90230060" } }, "device": { "ip_address": "127.0.0.1", "device_id": "hash-device-id" }, "shippings": [{ "first_name": "João", "name": "João da Silva", "email": "customer@email.com.br", "phone_number": "5551999887766", "shipping_amount": 3000, "address": { "street": "Av. Brasil", "complement": "Sala 1", "number": "1000", "district": "São Geraldo", "city": "Porto Alegre", "state": "RS", "country": "Brasil", "postal_code": "90230060" } }], "debit": { "cardholder_mobile": "5551999887766", "soft_descriptor": "LOJA*TESTE*COMPRA-123", "dynamic_mcc": 1799, "card": { "number_token": "dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c", "security_code": "123", "expiration_month": "12", "expiration_year": "28", "cardholder_name": "JOAO DA SILVA" } } }' /v1/payments/debit/{payment_id}/cancel: post: summary: Cancelar pagamento no cartão de debito description: | Cancelar uma transação de debito completo. * Estorna ou desfaz transações feitas no mesmo dia (D0). tags: - Pagamento consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Tipo do conteúdo. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. - in: path name: payment_id description: Identificador do pagamento previamente recebido e aceito. type: string minLength: 36 maxLength: 36 format: uuidv4 required: true responses: '200': description: Pagamento cancelado com sucesso. schema: $ref: '#/definitions/debit_cancel' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '402': description: Requisição é válida mas cancelamento negado. Pode ser negado por vários motivos / regras de negócios. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/debit/06f256c8-1bbf-42bf-93b4-ce2041bfb87e/cancel \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json; charset=utf-8' \ /v1/payments/boleto: post: summary: Registro para pagamento com boleto description: | Neste endpoint serão recebidos os dados do novo boleto, que será registrado no Banco Santander.

#### Impressão da segunda via de um boleto No registro de um pagamento com boleto é retornado o campo payment_id na resposta da requisição de registro. O payment_id será utilizado para a requisição de download da segunda via do boleto nas requisições Download pdf do boleto ou Download html do boleto

__Observação:__ Na notificação de boleto também pode ser recuperado o campo payment_id. Mais informações sobre notificações estão disponíveis no Notificações 1.1 tags: - Pagamento consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Tipo do conteúdo. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. - in: body name: boleto_body required: true description: Requisição contendo os dados para pagamento com boleto. schema: $ref: '#/definitions/payment_boleto' responses: '201': description: Boleto emitido com sucesso. schema: $ref: '#/definitions/payment_boleto_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '402': description: Requisição é válida mas pagamento negado. Pode ser negado por vários motivos / regras de negócios. schema: $ref: '#/definitions/error_boleto_402' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/boleto \ -H 'authorization: Bearer 151f3061-d162-41c0-a3e7-474c49e60f57' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json; charset=utf-8' \ -d '{ "seller_id": "6eb2412c-165a-41cd-b1d9-76c575d70a28", "amount": 100, "currency": "BRL", "order": { "order_id": "6d2e4380-d8a3-4ccb-9138-c289182818a3", "sales_tax": 0, "product_type": "service" }, "boleto": { "our_number": "000001946598", "document_number": "170500000019763", "instructions": "Pagar até o vencimento", "provider": "santander", "expiration_date": "10/05/2018" }, "customer": { "first_name": "João", "name": "João da Silva", "document_type": "CPF", "document_number": "12345678912", "billing_address": { "street": "Av. Brasil", "number": "1000", "complement": "Sala 1", "district": "São Geraldo", "city": "Porto Alegre", "state": "RS", "country": "Brasil", "postal_code": "90230060" } } }' /v2/payments/boleto: post: summary: Registro para pagamento com boleto v2 description: | Neste endpoint serão recebidos os dados de boleto com a possibilidade de pagamento via pix, que será registrado no Banco Santander.

#### Impressão da segunda via de um boleto No registro de um pagamento com boleto é retornado o campo payment_id na resposta da requisição de registro. O payment_id será utilizado para a requisição de download da segunda via do boleto nas requisições Download pdf do boleto ou Download html do boleto

#### PIX Na impressão do boleto será disponibilizado o QRCode, para pagamento via pix. __Observação:__ Na notificação de boleto também pode ser recuperado o campo payment_id. Mais informações sobre notificações estão disponíveis no Notificações 1.0 tags: - Pagamento consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Tipo do conteúdo. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. - in: body name: payment_boleto_v2 required: true description: Requisição contendo os dados para pagamento com boleto. schema: $ref: '#/definitions/payment_boleto_v2' responses: '201': description: Boleto emitido com sucesso. schema: $ref: '#/definitions/payment_boleto_response_v2' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '402': description: Requisição é válida mas pagamento negado. Pode ser negado por vários motivos / regras de negócios. schema: $ref: '#/definitions/error_boleto_402' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/boleto \ -H 'authorization: Bearer 151f3061-d162-41c0-a3e7-474c49e60f57' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json; charset=utf-8' \ -d '{ "idempotency_key": "7eb2412c-165a-41cd-b1d9-76c575d70a27", "request_id": "9eb2412c-165a-41cd-b1d9-76c575d70a29", "data": { "seller_id": "6eb2412c-165a-41cd-b1d9-76c575d70a28", "amount": 100, "currency": "BRL", "order": { "order_id": "6d2e4380-d8a3-4ccb-9138-c289182818a3", "sales_tax": 0, "product_type": "service" }, "boleto": { "our_number": "000001946598", "document_number": "170500000019763", "instructions": "Pagar até o vencimento", "provider": "santander", "expiration_date": "10/05/2018" }, "customer": { "first_name": "João", "name": "João da Silva", "document_type": "CPF", "document_number": "12345678912", "billing_address": { "street": "Av. Brasil", "number": "1000", "complement": "Sala 1", "district": "São Geraldo", "city": "Porto Alegre", "state": "RS", "country": "Brasil", "postal_code": "90230060" } } } }' /v1/payments/boleto/{payment_id}/pdf: get: summary: Download pdf do boleto description: Nesse endpoint o usuário consegue realizar o download PDF do boleto para o ID informado no path. tags: - Pagamento produces: - application/json parameters: - in: path name: payment_id description: | Hash identificador do boleto.
Exemplo: 67e1eba5a4bae6a5011fc30b type: string minLength: 36 maxLength: 36 required: true - in: query name: ack description: |

Parâmetro de segurança.

Exemplo: ack=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2N2UxZWJhNWE0YmFlNmE1MDExZmMzMGIiLCJpYXQiOjE3NDI4NTkxNzMsImF1ZGllbmNlIjoiWW05c1pYUnZMV1J2ZDI1c2IyRmtMWE5sY25acFkyVT0iLCJleHAiOjE3NDg3MzYwMDB9.HXX3kOf95MiXUG9fJUE4d8QsDlr3acTGsCpfvd2RFX6HYPHiywnlFq-mXCKCYPkdY3mUJVwW7ct7WXStKkDZG2ZqfC7d9CnMQs5b5Tjw4sg2vbeZrMkbd69ih6pt6f0hpmecPA_Jbonl995suzW67zQNy-oJ-4ULDlNLuu4FdmRRX31uLho3Gtu3PoQhC3p876m5oFJ1MTxdZwcIqiGQIXWv96elhx-LpIfT4yzisSkZGgRe-EVdh-q31hRrAH3HqsS6_BdXX0XSoFBhEbCtkjOlST0Rknm_kMyk1QCvrh5vCh9EAJQ5DTeglcyE8NgDG5CLzRcJcM6B1KpKOH0oHw

Observação: Na notificação de boleto também pode ser recuperado o campo ack. Mais informações sobre notificações estão disponíveis no Notificações 1.1

type: string maxLength: 600 required: true responses: '200': description: Em caso de sucesso, será retornado o boleto em arquivo PDF. '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ 'https://api-homologacao.getnet.com.br/v1/payments/boleto/599ca35059028b001023b323/pdf' /v1/payments/boleto/{payment_id}/html: get: summary: Download html do boleto description: Nesse endpoint o usuário consegue realizar o download html do boleto para o ID informado no path. tags: - Pagamento produces: - application/json parameters: - in: path name: payment_id description: | Hash identificador do boleto.
Exemplo: 67e1eba5a4bae6a5011fc30b type: string minLength: 36 maxLength: 36 required: true - in: query name: ack description: |

Parâmetro de segurança.

Observação: Na notificação de boleto também pode ser recuperado o campo ack. Mais informações sobre notificações estão disponíveis no Notificações 1.1

type: string maxLength: 600 required: true responses: '200': description: Em caso de sucesso, será retornado o boleto em arquivo html. '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ 'https://api-homologacao.getnet.com.br/v1/payments/boleto/599ca35059028b001023b323/html' /v1/payments/combined: post: summary: Pagamento combinado description: Nesse endpoint serão recebidos dados para pagamento combinado tags: - Pagamento Combinado consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Tipo do conteúdo application/json. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. - in: header required: false description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 - in: body name: body required: true description: Requisição contendo os dados para pagamento combinado schema: $ref: '#/definitions/payment_combined' responses: '201': description: Solicitação de autorização de pagamento(s) recebida com sucesso. schema: $ref: '#/definitions/payment_combined_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '402': description: Requisição é válida, porém pagamento(s) negado(s). Pode(m) ser negado(s) por vários motivos/regras de negócios. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' '504': description: Timeout. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/combined \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -d '{ "seller_id": "6eb2412c-165a-41cd-b1d9-76c575d70a28", "amount": 20000, "currency": "BRL", "order": { "order_id": "6d2e4380-d8a3-4ccb-9138-c289182818a3", "product_type": "service" }, "customer": { "customer_id": "customer_21081826", "first_name": "João", "name": "João Silva", "email": "customer@email.com.br", "document_type": "CPF", "document_number": "12345678912", "phone_number": "5551999887766", "billing_address": { "street": "Av. Brasil", "number": "1000", "complement": "Sala 1", "district": "São Geraldo", "city": "Porto Alegre", "state": "RS", "country": "Brasil", "postal_code": "90230060" } }, "device": { "ip_address": "127.0.0.1", "device_id": "hash-device-id" }, "shippings": [ { "first_name": "João", "name": "João da Silva", "email": "customer@email.com.br", "phone_number": "5551999887766", "shipping_amount": 1000, "address": { "street": "Av. Brasil", "complement": "Sala 1", "number": "1000", "district": "São Geraldo", "city": "Porto Alegre", "state": "RS", "country": "Brasil", "postal_code": "90230060" } } ], "payments": [ { "type": "CREDIT", "amount": 15000, "currency": "BRL", "save_card_data": false, "transaction_type": "FULL", "number_installments": 1, "soft_descriptor": "LOJA*TESTE*COMPRA-123", "payment_tag": "pay-1", "card": { "number_token": "3ac4934350d11409cb17433ce324e83e41d980afeeb0379c24e1895fec1bec0d72c0d1434241f9c73fff79367b373755dede2a98d09975ea9af93fdfd4581b78", "cardholder_name": "JOAO DA SILVA", "security_code": "123", "brand": "Mastercard", "expiration_month": "12", "expiration_year": "28" } }, { "type": "CREDIT", "amount": 5000, "currency": "BRL", "save_card_data": false, "transaction_type": "FULL", "number_installments": 1, "soft_descriptor": "LOJA*TESTE*COMPRA-123", "payment_tag": "pay-2", "card": { "number_token": "004ff49682bae4596b72ac14f5739f7e25231db823b75c1c2eadc9ecd494890164b79c8edb410471b3cae2a439ad192cc74b27ee7547b6089b2c3f8d66b8ab6a", "cardholder_name": "JOAO DA SILVA", "security_code": "123", "brand": "Visa", "expiration_month": "12", "expiration_year": "28" } } ] }' /v1/payments/combined/confirm: post: summary: Confirmação tardia de pagamento combinado description: Quando os pagamentos que compõem a transação de pagamento combinado são feitos com a opção delayed = true, confirmação tardia, ela deve ser posteriormente confirmada, este endpoint é responsável por esta confirmação. **É obrigatório o envio do mesmo número de pagamentos enviados na requisição de autorização**. tags: - Pagamento Combinado consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Tipo do conteúdo application/json. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. - in: header required: false description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 - in: body required: true name: body description: Requisição contendo os dados para uma confirmação de pagamento combinado. schema: $ref: '#/definitions/combined_confirm' responses: '200': description: Pagamento combinado confirmado com sucesso. schema: $ref: '#/definitions/combined_confirm_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '402': description: Requisição é válida mas um ou mais pagamento(s) negado(s). Pode ser negado por vários motivos/regras de negócios. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' '504': description: Timeout. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/combined/confirm \ -H 'content-type: application/json' \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -d '{ "payments": [ { "payment_tag": "pay-1", "payment_id": "06f256c8-1bbf-42bf-93b4-ce2041bfb87e" } ] }' /v1/payments/combined/cancel: post: summary: Cancelar pagamento combinado (somente para transações de crédito) description: Cancelar uma transação de pagamento combinado. **É obrigatório o envio do mesmo número de pagamentos enviados na requisição de autorização/confirmação** * Estorna transações confirmadas no mesmo dia (D0). * Desfaz transções autorizadas em até 7 dias. tags: - Pagamento Combinado consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Tipo do conteúdo application/json. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. - in: header required: false description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 - in: body required: true name: body description: Requisição contendo os dados para um cancelamento de pagamento combinado. schema: $ref: '#/definitions/combined_cancel' responses: '200': description: Pagamento combinado cancelado com sucesso. schema: $ref: '#/definitions/combined_cancel_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '402': description: Requisição é válida mas cancelamento negado. Pode ser negado por vários motivos / regras de negócios. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' '504': description: Timeout. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/combined/cancel \ -H 'content-type: application/json' \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -d '{ "payments": [ { "payment_tag": "pay-1", "payment_id": "06f256c8-1bbf-42bf-93b4-ce2041bfb87e" } ] }' /v1/payments/combined/cancel/request: post: summary: Solicita um cancelamento para pagamento combinado (somente para transações com cartão) description: | * Solicita o cancelamento de um pagamento combinado, confirmado, realizado há mais de 1 dia (D+n). tags: - Pagamento Combinado consumes: - application/json produces: - application/json parameters: - required: true description: Tipo do conteúdo. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: false description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true in: body name: body description: Requisição contendo os dados para uma solicitação de cancelamento para pagamento combinado. schema: $ref: '#/definitions/payment_combined_cancel' responses: '202': description: Solicitação(ões) de cancelamento aceita(s) e em processamento schema: $ref: '#/definitions/combine_cancel_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' '504': description: Time out. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/combined/cancel/request \ -H 'authorization: Bearer 151f3061-d162-41c0-a3e7-474c49e60f57' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json; charset=utf-8' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' \ -d '{ "payments": [ { "payment_id": "06f256c8-1bbf-42bf-93b4-ce2041bfb87e", "cancel_amount": 1000, "cancel_custom_key": "cancel-pay-1", "payment_tag": "pay-1" } ] } /v1/3ds/tokens: post: summary: Geração do token de acesso 3DS description: | Endpoint responsável pela geração do token de acesso para abertura de uma sessão de autenticação 3DS junto à GetNet. tags: - Autenticação 3DS consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Tipo do conteúdo. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. - in: header name: seller_id required: false type: string description: | Authorization: Código de identificação do e-commerce.
Obrigatório quando o cliente for tratado como Plataforma. format: uuidv4 minLength: 36 maxLength: 36 - in: body name: 3ds_token required: true description: | Dados que identificam a sessão e a compra que está sendo efetuada (Order). schema: $ref: '#/definitions/3ds_token' responses: '201': description: | Retorna o token de acesso para sessão de autenticação 3DS junto à GetNet schema: type: object properties: access_token: type: string description: Token de acesso para sessão de autenticação 3DS. example: | eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIzZjczZGQ3MS03NjkyLTQyYTItYjU2Ni1jYmUzMzJkYzU3OTQiLCJpYXQiOjE1NzY2NzI3NDUsImlzcyI6IjVkNzVhYzYxNmZlM2QxMmYxODhmZmQ3YyIsIk9yZ1VuaXRJZCI6IjVkNzRlZDczZTA5MTlmMTk1ODNjMzE5MyIsIlBheWxvYWQiOiJ7XCJvcmRlck51bWJlclwiOlwic3RyaW5nXCIsXCJwYXltZW50SWRcIjpcImRhMGU4ZDkwLTQ0OGMtNGJhMC1iZGUyLTQxN2Q2YTdmZjliOVwiLFwibWVyY2hhbnRJZFwiOlwiMDU0Mzk5MlwiLFwibWVyY2hhbnROYW1lXCI6XCJFQyBUZXN0ZSBIVUIg4oCTIFBBRFJBT1wiLFwiY3VycmVuY3lcIjpcImJybFwiLFwidG90YWxBbW91bnRcIjpcIjEwMDBcIixcImpzVmVyc2lvblwiOlwic3RyaW5nXCIsXCJjbGllbnRDb2RlXCI6XCJzdHJpbmctM2Y3M2RkNzEtNzY5Mi00MmEyLWI1NjYtY2JlMzMyZGM1Nzk0XCIsXCJvdmVycmlkZVBheW1lbnRNZXRob2RcIjpcIjAyXCIsXCJpdGVtc1wiOlt7XCJ0b3RhbEFtb3VudFwiOlwiOTAwXCIsXCJ1bml0UHJpY2VcIjpcIjg5OVwiLFwicXVhbnRpdHlcIjowLFwic2t1XCI6XCJzdHJpbmdcIixcImRlc2NyaXB0aW9uXCI6XCJzdHJpbmdcIixcIm5hbWVcIjpcInN0cmluZ1wifSx7XCJ0b3RhbEFtb3VudFwiOlwiOTAwXCIsXCJ1bml0UHJpY2VcIjpcIjgwMFwiLFwicXVhbnRpdHlcIjowLFwic2t1XCI6XCJzdHJpbmdcIixcImRlc2NyaXB0aW9uXCI6XCJzdHJpbmdcIixcIm5hbWVcIjpcInN0cmluZ1wifV19IiwiT2JqZWN0aWZ5UGF5bG9hZCI6ZmFsc2UsIlJlZmVyZW5jZUlkIjoiM2Y3M2RkNzEtNzY5Mi00MmEyLWI1NjYtY2JlMzMyZGM1Nzk0IiwiZXhwIjoxNTc2NjcyODY1fQ.jrPvIjtvSY6HukI-PjBE0ACWo68whA2FhCCfKeEfB4g maxLength: 2000 token_type: type: string description: Tipo do token. example: bearer minLength: 6 maxLength: 6 expiration_date: type: string description: Data de expiração do token. minLength: 23 maxLength: 23 format: YYYY-MM-DDTHH:mm:ss.SSS example: '2019-09-05T18:54:53.153' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Acesso negado. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' '503': description: Erro servidor ou serviço indisponivel. schema: $ref: '#/definitions/error' '504': description: Erro gateway timeout. schema: $ref: '#/definitions/error' /v1/3ds/authentications: post: summary: Solicita a autenticação 3DS description: | Endpoint responsável pela solicitação de autenticação 3DS junto à GetNet. tags: - Autenticação 3DS consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Tipo do conteúdo. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. - in: header name: seller_id required: false type: string description: | Authorization: Código de identificação do e-commerce.
Obrigatório quando o cliente for tratado como Plataforma. format: uuidv4 minLength: 36 maxLength: 36 - in: body name: 3ds_authentication required: true description: | Dados que identificam a compra que está sendo efetuada (Order), detalhes sobre autenticação, histórico do cliente, dados do cartão. schema: $ref: '#/definitions/3ds_authentication' responses: '201': description: Retorna da autenticação 3DS junto à GetNet. schema: type: object properties: card: $ref: '#/definitions/3ds_authentications_resp_card_ref' id: type: string maxLength: 26 description: | Um número de identificação exclusivo atribuído pela CyberSource para identificar a solicitação enviada. example: 5.785063465166933e+21 submit_time_utc: type: string description: | Hora da solicitação em UTC. maxLength: 20 example: '2019-12-18T17:46:02.000Z' format: YYYY-MM-DDThh:mm:ssZ status: type: string description: | Status da solicitação de autenticação 3DS. example: AUTHENTICATION_SUCCESSFUL maxLength: 25 enum: - AUTHENTICATION_SUCCESSFUL - PENDING_AUTHENTICATION - AUTHENTICATION_FAILED client_reference_information: $ref: '#/definitions/3ds_authentications_resp_client_reference_information_ref' consumer_authentication_information: $ref: '#/definitions/3ds_authentications_resp_consumer_authentication_information_ref' error_information: $ref: '#/definitions/3ds_authentications_resp_error_information_ref' reference_id: type: string description: | Número de referência gerado pelo 3DS Getnet maxLength: 36 example: a1c1aaf5-28fe-44c8-8b06-26103afb101e org_unit_id: type: string description: | Id Getnet usado para consumir o serviço 3DS. example: 5d74ed73e0919f19583c3193 send_ds_date: type: integer description: | Data de envio do serviço 3DS em formato longo que representa currentTimeMillis. example: 1578506345431 rec_ds_date: type: integer description: | Data de recebimento do serviço 3DS em formato longo que representa currentTimeMillis. example: 1578506348886 '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Acesso negado. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' '503': description: Erro servidor ou serviço indisponivel. schema: $ref: '#/definitions/error' '504': description: Erro gateway timeout. schema: $ref: '#/definitions/error' /v1/3ds/authentications/results: post: summary: Solicita resultado da autenticação 3DS description: | Endpoint responsável pela solicitação do resultado da autenticação 3DS junto à GetNet. tags: - Autenticação 3DS consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Tipo do conteúdo. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. - in: header name: seller_id required: false type: string description: | Authorization: Código de identificação do e-commerce. Obrigatório quando o cliente for tratado como Plataforma. format: uuidv4 minLength: 36 maxLength: 36 - in: body name: body schema: $ref: '#/definitions/3ds_results_ref' responses: '201': description: Retorna resultado da autenticação 3DS junto à GetNet. schema: type: object properties: card: $ref: '#/definitions/3ds_authentications_resp_card_ref' id: type: string description: Um número de identificação exclusivo atribuído pela CyberSource para identificar a solicitação enviada. example: 5.785063465166933e+21 submit_time_utc: type: string description: Hora da solicitação em UTC. example: '2019-12-18T17:46:02.000Z' status: type: string description: | Status da solicitação de autenticação 3DS. example: AUTHENTICATION_SUCCESSFUL maxLength: 25 enum: - AUTHENTICATION_SUCCESSFUL - PENDING_AUTHENTICATION - AUTHENTICATION_FAILED client_reference_information: $ref: '#/definitions/3ds_authentications_resp_client_reference_information_ref' consumer_authentication_information: $ref: '#/definitions/3ds_authentication_results_resp_consumer_authentication_information_ref' send_ds_date: type: string description: 'Data de envio do serviço 3DS em formato longo que representa currentTimeMillis. ' example: 1578506345431 rec_ds_date: type: string description: Data de recebimento do serviço 3DS em formato longo que representa currentTimeMillis. example: 1578506348886 '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Acesso negado. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' '503': description: Erro servidor ou serviço indisponivel. schema: $ref: '#/definitions/error' '504': description: Erro gateway timeout. schema: $ref: '#/definitions/error' /v1/payments/authenticated: post: summary: Pagamento autenticado 3DS com cartão de crédito ou débito. description: | Nesse endpoint serão recebidos dados para pagamento autenticado 3DS com cartão de crédito ou débito. tags: - Pagamento Autenticado 3DS consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Tipo do conteúdo. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. - in: header name: seller_id required: false type: string description: | Authorization: Código de identificação do e-commerce. Obrigatório quando o cliente for tratado como Plataforma. format: uuidv4 minLength: 36 maxLength: 36 - in: body name: body schema: $ref: '#/definitions/3ds_payments_authenticated_ref' responses: '200': description: Pagamento efetuado com sucesso. Transação aprovada. schema: $ref: '#/definitions/3ds_payments_authenticated_res_ref' '202': description: | Solicitação de pagamento de crédito com confirmação tardia ou pré autorização recebida, aceita e armazenada esperando confirmação. schema: $ref: '#/definitions/3ds_payments_authenticated_pre_res_ref' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Acesso negado. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' '503': description: Erro servidor ou serviço indisponivel. schema: $ref: '#/definitions/error' '504': description: Erro gateway timeout. schema: $ref: '#/definitions/error' /v1/payments/authenticated/{payment_id}/confirm: post: summary: | Confirmação tardia de pagamento ou confirmação de pré autorização com cartão de crédito com autenticação 3DS. description: | Quando uma transação de crédito com autenticação 3DS é feita com a opção de confirmação tardia ou pré autorização,ela pode ser posteriormente confirmada, este endpoint é responsável pela confirmação. tags: - Pagamento Autenticado 3DS consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Tipo do conteúdo. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. - in: header name: seller_id required: false type: string description: | Authorization: Código de identificação do e-commerce. Obrigatório quando o cliente for tratado como Plataforma. format: uuidv4 minLength: 36 maxLength: 36 - in: path name: payment_id description: Identificador do pagamento previamente recebido e aceito. type: string minLength: 36 maxLength: 36 format: uuidv4 required: true - in: body name: body schema: $ref: '#/definitions/3ds_payments_authenticated_confirm_ref' responses: '200': description: Pagamento confirmado com sucesso. schema: $ref: '#/definitions/3ds_payments_authenticated_confirm_res_ref' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Acesso negado. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' '503': description: Erro servidor ou serviço indisponivel. schema: $ref: '#/definitions/error' '504': description: Erro gateway timeout. schema: $ref: '#/definitions/error' /v1/payments/authenticated/{payment_id}/adjustment: post: summary: Ajustar valor de uma transação de pré autorização com autenticação 3DS. description: | Executa um ajuste (incremento/decremento) no valor previamente reservado no saldo do portador por uma transação de pré autorização. O valor da transação de ajuste de pré autorização pode ser maior ou menor que o valor original. Na chamada do processo de ajuste sempre deve ser enviado o valor final desejado no campo de amount. tags: - Pagamento Autenticado 3DS consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Tipo do conteúdo. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. - in: header name: seller_id required: false type: string description: | Authorization: Código de identificação do e-commerce. Obrigatório quando o cliente for tratado como Plataforma. format: uuidv4 minLength: 36 maxLength: 36 - in: path name: payment_id description: Identificador do pagamento previamente recebido e aceito. type: string minLength: 36 maxLength: 36 format: uuidv4 required: true - in: body name: body schema: $ref: '#/definitions/3ds_payments_authenticated_adjustment_ref' responses: '200': description: Ajuste realizado com sucesso. schema: $ref: '#/definitions/3ds_payments_authenticated_adjustment_res_ref' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Acesso negado. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' '503': description: Erro servidor ou serviço indisponivel. schema: $ref: '#/definitions/error' '504': description: Erro gateway timeout. schema: $ref: '#/definitions/error' /v1/payments/authenticated/{payment_id}/cancel: post: summary: Cancelar pagamento no cartão de crédito com autenticação 3DS. description: | Cancelar uma transação com autenticação 3DS de crédito completa ou transação com autenticação 3DS de crédito tardia ou transaçãocom autenticação 3DS de crédito pré autorizada. * Estorna ou desfaz transações feitas no mesmo dia (D0). tags: - Pagamento Autenticado 3DS consumes: - application/json produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Tipo do conteúdo. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. - in: header name: seller_id required: false type: string description: | Authorization: Código de identificação do e-commerce. Obrigatório quando o cliente for tratado como Plataforma. format: uuidv4 minLength: 36 maxLength: 36 - in: path name: payment_id description: Identificador do pagamento previamente recebido e aceito. type: string minLength: 36 maxLength: 36 format: uuidv4 required: true - in: body name: body schema: $ref: '#/definitions/3ds_payments_authenticated_cancel_ref' responses: '200': description: Pagamento cancelado com sucesso. schema: $ref: '#/definitions/3ds_payments_authenticated_cancel_res_ref' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Acesso negado. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' '503': description: Erro servidor ou serviço indisponivel. schema: $ref: '#/definitions/error' '504': description: Erro gateway timeout. schema: $ref: '#/definitions/error' /v1/payment-links: post: summary: Criação do GetPay. description: Endpoint responsável pela criação de Links de Pagamento. tags: - GetPay consumes: - application/json produces: - application/json parameters: - required: true description: Tipo do conteúdo. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: false description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true in: body name: body description: Requisição contendo os dados para o GetPay. schema: $ref: '#/definitions/payment_link_request' responses: '201': description: Created schema: $ref: '#/definitions/payment_link_request_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error401getpay' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' get: summary: Consulta GetPay por filtro description: Nesse endpoint é possível buscar dados e informações de todos os Links de pagamentos que foram criados pelo estabelecimento. Esse endpoint deve ser utilizada com o objetivo de analisar os links que foram gerados de maneira geral, para mais detalhes sobre cada link deve-se utilizar outro endpoint. Pode ser utilizado inúmeros filtros para ajudar na analise e relatórios. tags: - GetPay produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: false description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - name: label description: Filtra por label de identificação do link de pagamento type: string in: query - name: expiration_since description: Data e hora de expiração no formato ISO. Filtro "a partir de". type: string in: query - name: credit description: Filtro por tipo de pagamento crédito habilitado. type: string in: query - name: debit description: Filtro por tipo de pagamento débito habilitado. type: string in: query - name: created_since description: Data e hora de criação no formato ISO. Filtro "a partir de". type: string in: query - name: created_until description: Data e hora de criação no formato ISO. Filtro "antes de". type: string in: query - name: status description: Filtro por status do GetPay. type: string enum: - SUSPENDED - ACTIVE - EXPIRED in: query - name: limit description: Limite de resultados por busca. type: string minimum: 1 maximum: 20 default: 10 in: query - name: page description: Pagina dos resultados. type: integer in: query - name: expiration_until description: Data e hora de expiração no formato ISO. Filtro "antes de". type: string in: query responses: '200': description: OK schema: $ref: '#/definitions/payment_link_filter_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '404': description: Not Found schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' /v1/payment-links/{link_id}: patch: summary: Altera dados do GetPay. description: Atualiza as propriedades do GetPay. tags: - GetPay consumes: - application/json produces: - application/json parameters: - required: false description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Tipo do conteúdo. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true in: body name: body description: Conjunto de dados do GetPay a ser atualizado. schema: $ref: '#/definitions/payment_link_alteration' - required: true type: string description: ID GetPay que originou a ordem de pagamento. name: link_id in: path responses: '200': description: OK schema: $ref: '#/definitions/payment_link_alteration_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' get: summary: Consulta dados do GetPay description: Um link de pagamento pode ter inúmeras ordens de venda, esse endpoint tem como objetivo principal demonstrar de maneira geral informações cadastrais sobre esse link e quantas ordens de venda o mesmo teve. tags: - GetPay produces: - application/json parameters: - required: false description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true type: string description: ID GetPay que originou a ordem de pagamento. name: link_id in: path responses: '200': description: OK schema: $ref: '#/definitions/payment_link_consult_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' /v1/payment-links/{link_id}/payment-orders/{payment_order_id}: get: summary: Consulta pagamento relacionado ao GetPay. description: Esse endpoint possibilita obter todas as informações das tentativas de pagamentos, retornando dados da autorização processada pela Getnet. Essa API é essencial para avaliar o motivo da transação ter sido negada, a data e hora em que foi processada e etc.. Todas essas informações retornam independentemente se a transação foi negada ou aprovada. tags: - GetPay produces: - application/json parameters: - required: false description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true description: ID GetPay que originou a ordem de pagamento. type: string name: link_id in: path - required: true description: ID da ordem de pagamento. type: string name: payment_order_id in: path responses: '200': description: OK- O Bloco transaction dentro de payments pode variar de acordo com o cada tipo de pagamento sendo(DEBITO, DEBITO NÃO AUTENTICADO, CREDITO, CREDITO NÃO AUTENTICADO, PIX, QRCODE) schema: $ref: '#/definitions/payment_link_payment_consult_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' /v1/payment-links/{link_id}/payment-orders: get: summary: Consulta pagamento vinculado ao GetPay description: Um link de pagamento pode ter inúmeras ordens de venda, e uma ordem de venda pode ter inúmeras tentativas de pagamento. Uma ordem de venda só é considerada successfull quando uma tentativa de pagamento é aprovada com sucesso. Esse endpoint possibilita obter informações das ordens de vendas de um link especifico, retornando dados que foram enviados no momento da transação (dados do portador). tags: - GetPay produces: - application/json parameters: - required: false description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - type: string in: query name: customer_email description: Filtro de pesquisa pelo email do cliente. - type: string in: query name: payment_id description: ID do pagamento vinculado a ordem de pagamento. - type: string in: query name: created_since description: Data e hora de criação no formato ISO. Filtro "a partir de". - type: string in: query name: created_until description: Data e hora de criação no formato ISO. Filtro "antes de". - type: string description: ID GetPay que originou a ordem de pagamento. name: link_id in: path required: true responses: '200': description: OK schema: $ref: '#/definitions/payment_link_linked_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' /v1/payment-links/enabled-products: get: summary: Consulta produtos habilitados para uso do Getpay description: Consulta produtos habilitados para uso do Getpay tags: - GetPay produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: false description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header responses: '200': description: OK schema: $ref: '#/definitions/payment_link_filter_response_enabled_products' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '404': description: Not Found schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' /v1/payments/qrcode: post: summary: Geração de QRCode para pagamento description: Nesse endpoint serão recebidos dados para pagamento com QRCode.

O QRCode tem um limite de expiração, que é de 1 minuto e 50 segundos, após esse período deve ser gerado um novo QRCode e o anterior deve ser desconsiderado.
Esse serviço está disponível para apenas as bandeiras VISA e MASTER. tags: - QRCode consumes: - application/json produces: - application/json parameters: - required: false description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Tipo do conteúdo. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. - in: body name: credit_body required: true description: Requisição contendo os dados para pagamento com cartão de crédito e análise de fraude. schema: $ref: '#/definitions/payment_qrcode_request' responses: '200': description: QRCode gerado com sucesso. Transação aprovada. schema: $ref: '#/definitions/payment_qrcode_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/qrcode \ -H 'authorization: Bearer 41460520-13ed-479a-93e7-a501c89212f9' \ -H 'content-type: application/json' \ -d '{ "amount": 199, "currency": "BRL", "order": { "order_id": "HTI-1608309698", "sales_tax": 100, "product_type": "service" }, "customer": { "customer_id": "bf8292ec-8c76-416b-a435-f9fce0b90f22", "first_name": "Winston", "last_name": "Smith", "name": "Winston Smith", "email": "aceitei@getnet.com.br", "document_type": "RG", "document_number": "GI6660001984", "phone_number": "66999991984", "billing_address": { "street": "Av. Ministério da Pujança", "number": "1984", "complement": "Mansão Victory", "district": "Minipuja", "city": "Novafala", "state": "OC", "country": "BR", "postal_code": "19840000" } }, "device": { "ip_address": "127.0.0.1", "device_id": "ldskfq7laskdfjljLKJOIULKSLSFFAS" }, "shippings": [ { "first_name": "Winston", "name": "Winston Smith", "email": "aceitei@getnet.com.br", "phone_number": "66999991984", "shipping_amount": 99, "address": { "street": "Av. Ministério da Pujança", "number": "1984", "complement": "Mansão Victory", "district": "Minipuja", "city": "Novafala", "state": "OC", "country": "BR", "postal_code": "19840000" } } ], "payments": [ { "type": "CREDIT", -- OU DEBIT "delayed": false, "authenticated": false, "pre_authorization": false, "save_card_data": false, "transaction_type": "FULL", "number_installments": 1, "soft_descriptor": "GI*PEDIDO*1984", "dynamic_mcc": 1234 } ] }' /v1/payments/qrcode/{payment_id}: get: summary: Consulta status do pagamento description: | Retorna os dados do pagamento com QRCode.

A consulta deve durar no máximo 1 minuto e 50 segundos, pois é o tempo de validade de um QRCode.
Caso a transação ainda esteja com o status PENDING após este tempo, ela não mudara mais de status. tags: - QRCode produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: false description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - in: path name: payment_id description: Identificador do pagamento. type: string minLength: 36 maxLength: 36 format: uuidv4 required: true responses: '200': description: Status e dados da transação de pagamento. schema: $ref: '#/definitions/qrcode_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' /v1/payments/qrcode/pix: post: summary: Geração de QR Code para pagamento PIX description: Nesse endpoint serão recebidos dados para pagamento PIX com QR Code.

O QR Code PIX tem um limite de expiração, default que é de 3 minutos, após esse período deve ser gerado um novo QR Code e o anterior deve ser desconsiderado.
Após a geração do QR Code o retorno do pagamento ao Estabelecimento Comercial se dará através de uma Notificação via HTTP. Para mais detalhes por favor consulte por "Notificações PIX" nas seções de Notificações 1.0 e Notificações 1.1 desse documento. tags: - PIX consumes: - application/json produces: - application/json parameters: - required: false description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - in: header name: Content-type required: true type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 description: | Tipo do conteúdo. - in: header name: Authorization required: true type: string description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. - in: header name: x-qrcode-expiration-time required: false type: number description: É possível personalizar o tempo de expiração do QR Code inserindo o tempo desejado em segundos, caso não seja informado a operação irá com o valor default de 180s. O valor máximo para o tempo de expiração é 1800s default: 180 maximum: 1800 - in: body name: pix_body required: true description: Requisição contendo os dados para pagamento com PIX. schema: $ref: '#/definitions/payment_qrcode_pix_request' responses: '200': description: QR Code gerado com sucesso e aguardando o pagamento. schema: $ref: '#/definitions/payment_qrcode_pix_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl --location --request POST 'https://api-homologacao.getnet.com.br/v1/payments/qrcode/pix' \ --header 'Content-type: application/json; charset=utf-8' \ --header 'Authorization: Bearer 41460520-13ed-479a-93e7-a501c89212f9' \ --data-raw '{ "amount": 100, "currency": "BRL", "order_id": "DEV-1608748980", "customer_id": "string" }' /v1/payments/cancel/request: post: summary: Solicita um cancelamento description: | * Solicita o cancelamento de transações que foram realizadas há mais de 1 dia (D+n). tags: - Cancelamento consumes: - application/json produces: - application/json parameters: - required: true description: Tipo do conteúdo. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: false description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true in: body name: body description: Requisição contendo os dados para uma solicitação de cancelamento. schema: $ref: '#/definitions/cancel_request' responses: '202': description: Solicitação de cancelamento aceita schema: $ref: '#/definitions/cancel_request_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '409': description: Conflito. Chave do cliente duplicada (cancel_custom_key). schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/payments/cancel/request \ -H 'authorization: Bearer 151f3061-d162-41c0-a3e7-474c49e60f57' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json; charset=utf-8' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' \ -d '{ "payment_id": "06f256c8-1bbf-42bf-93b4-ce2041bfb87e", "cancel_amount": 19990, "cancel_custom_key": "4ec33ee18f9e45bfb73c5c30667f9006" } get: summary: Retorna uma solicitação de cancelamento pela chave do cliente description: Retorna os dados da solicitação de cancelamento pela chave gerada pelo cliente. tags: - Cancelamento produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: false description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Chave gerada pelo cliente para a solicitação de cancelamento. type: string name: cancel_custom_key maxLength: 32 in: query responses: '200': description: Retorna os dados da solicitação de cancelamento. schema: $ref: '#/definitions/cancel_query_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/payments/cancel/request?cancel_custom_key=4ec33ee18f9e45bfb73c5c30667f9006 \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' /v1/payments/cancel/request/{cancel_request_id}: get: summary: Retorna uma solicitação de cancelamento pelo identificador description: Retorna os dados da solicitação de cancelamento pelo identificador. tags: - Cancelamento produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: false description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Identificador da solicitação de cancelamento. type: string name: cancel_request_id minLength: 18 maxLength: 18 in: path responses: '200': description: Retorna os dados da solicitação de cancelamento. schema: $ref: '#/definitions/cancel_query_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/payments/cancel/request/20171117084237501 \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' /v1/customers: post: summary: Cadastra um novo cliente description: Neste endpoint você pode cadastrar os dados de um novo cliente para recorrência. tags: - Clientes consumes: - application/json produces: - application/json parameters: - required: true description: Tipo do conteúdo. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: false description: Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. type: string name: username in: header - required: true in: body name: body description: Requisição contendo os dados para cadastro de um novo cliente. schema: $ref: '#/definitions/customer_info' responses: '200': description: Cadastro do cliente realizado com sucesso schema: $ref: '#/definitions/customer_info_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/customers \ -H 'authorization: Bearer 151f3061-d162-41c0-a3e7-474c49e60f57' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json; charset=utf-8' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' \ -d '{ "seller_id": "6eb2412c-165a-41cd-b1d9-76c575d70a28", "customer_id": "customer_21081826", "first_name": "João", "last_name": "da Silva", "document_type": "CPF", "document_number": "12345678912", "birth_date": "1976-02-21", "phone_number": "5551999887766", "celphone_number": "5551999887766", "email": "customer@email.com.br", "observation": "O cliente tem interesse no plano x.", "address": { "street": "Av. Brasil", "number": "1000", "complement": "Sala 1", "district": "São Geraldo", "city": "Porto Alegre", "state": "RS", "country": "Brasil", "postal_code": "90230060" } } get: summary: Lista dos clientes description: Neste endpoint você pode listar todos os clientes previamente cadastrados com base nos filtros escolhidos. tags: - Clientes produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Número da página em que inicia a paginação. minimum: 1 type: number name: page in: query - required: true description: Limite de resultados por página. minimum: 0 maximum: 9999 type: number name: limit in: query - required: false description: Identificador do comprador. type: string name: customer_id maxLength: 100 in: query - required: false description: Número do documento do comprador. minLength: 11 maxLength: 15 type: string name: document_number in: query - required: false description: Primeiro nome do comprador. maxLength: 40 type: string name: first_name in: query - required: false description: Último nome do comprador. maxLength: 80 type: string name: last_name in: query - required: false description: Campo para realizar a ordenação. default: last_name type: string name: sort in: query - required: false description: Tipo de ordenação. Ascendente ou Descendente. enum: - asc - desc type: string name: sort_type in: query responses: '200': description: Lista de clientes cadastrados. schema: $ref: '#/definitions/customer_filter_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/customers?page=1&limit=10 \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' /v1/customers/{customer_id}: get: summary: Retorna um cliente description: Neste endpoint você pode buscar os dados de um cliente específico, previamente cadastrado. tags: - Clientes produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Identificador do comprador. type: string name: customer_id maxLength: 100 in: path responses: '200': description: Retorna os dados do cliente. schema: $ref: '#/definitions/customer_info' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/customers/123456 \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' /v1/plans: post: summary: Cadastra um novo plano description: Neste endpoint você pode criar um plano de recorrência. consumes: - application/json produces: - application/json tags: - Planos parameters: - required: true description: Tipo do conteúdo. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: false description: Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. type: string name: username in: header - required: true in: body name: body description: Requisição contendo os dados para cadastro de um novo plano. schema: $ref: '#/definitions/plan' responses: '200': description: Cadastro de plano realizado com sucesso schema: $ref: '#/definitions/plan_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Produto recorrência não habilitado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/plans \ -H 'authorization: Bearer 151f3061-d162-41c0-a3e7-474c49e60f57' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json; charset=utf-8' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' \ -d '{ "seller_id": "6eb2412c-165a-41cd-b1d9-76c575d70a28", "name": "Plano flex", "description": "Plano flex", "amount": 19990, "currency": "BRL", "payment_types": [ "credit_card" ], "sales_tax": 0, "product_type": "service", "period": { "type": "monthly", "billing_cycle": 30, "specific_cycle_in_days": 0 } } get: summary: Lista de planos description: 'Neste endpoint você pode listar os planos previamente cadastrados com base nos filtros escolhidos. ' tags: - Planos produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Número da página em que inicia a paginação. minimum: 1 type: number name: page in: query - required: true description: Limite de resultados por página. minimum: 0 maximum: 9999 type: number name: limit in: query - required: false description: Identificador do plano. type: string name: plan_id minLength: 36 maxLength: 36 format: uuidv4 in: query - required: false description: Status do plano. default: active enum: - active - inactive type: string name: status in: query - required: false description: Nome do plano. minLength: 3 type: string name: name in: query - required: false description: Campo para realizar a ordenação. default: name type: string name: sort in: query - required: false description: Tipo de ordenação. Ascendente ou Descendente. enum: - asc - desc type: string name: sort_type in: query - name: expand in: query type: array items: type: string required: false description: | Exibe informações adicionais dos Planos como por exemplo as alterações de data e valor previstas para os mesmos. A exibição de algumas informações poderá depender da habilitação de um produto específico na Getnet. * `floating_data` - Inclui no resultado o bloco de informações de todas as alterações de data e valor. responses: '200': description: Lista de planos cadastrados. schema: $ref: '#/definitions/plan_filter_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Produto recorrência não habilitado. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/plans?page=1&limit=10 \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' /v1/plans/{plan_id}: get: summary: Retorna um plano description: Neste endpoint você pode buscar os dados de um plano específico, previamente cadastrado. tags: - Planos produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Identificador do plano. type: string name: plan_id minLength: 36 maxLength: 36 format: uuidv4 in: path - name: expand in: query type: array items: type: string required: false description: | Exibe informações adicionais do Plano como por exemplo as alterações de data e valor previstas para o mesmo. A exibição de algumas informações poderá depender da habilitação de um produto específico na Getnet. * `floating_data` - Inclui no resultado o bloco de informações de todas as alterações de data e valor. responses: '200': description: Retorna os dados do plano. schema: $ref: '#/definitions/plan_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Produto recorrência não habilitado. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/plans/51995e24-b1ae-4826-8e15-2a568a87abdd \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' patch: summary: Atualiza um plano description: | Neste endpoint você pode atualizar as definições de um plano previamente cadastrado. Lembrando que os Planos que possuírem assinaturas ativas associadas permitem somente alterações de informações de Nome e Descrição. tags: - Planos consumes: - application/json produces: - application/json parameters: - required: true description: Tipo do conteúdo. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: false description: Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. type: string name: username in: header - required: true description: Identificador do plano. type: string name: plan_id minLength: 36 maxLength: 36 format: uuidv4 in: path - required: true description: Conjunto de dados do plano a ser atualizado. in: body name: body schema: $ref: '#/definitions/plan_update' responses: '200': description: Retorna o plano atualizado. schema: $ref: '#/definitions/plan_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Produto recorrência não habilitado. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X PATCH \ https://api-homologacao.getnet.com.br/v1/plans/51995e24-b1ae-4826-8e15-2a568a87abdd \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'content-type: application/json; charset=utf-8' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' \ -d '{ "name": "Plano flex atualizado", "description": "Plano flex atualizado", } /v1/plans/{plan_id}/status/{status}: patch: summary: Atualiza o status do plano description: Neste endpoint você pode ativar/desativar o status do plano da recorrência. tags: - Planos produces: - application/json parameters: - required: true description: Tipo do conteúdo. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: false description: Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. type: string name: username in: header - required: true description: Identificador do plano. type: string name: plan_id minLength: 36 maxLength: 36 format: uuidv4 in: path - required: true description: Status do plano. enum: - active - inactive type: string name: status in: path responses: '200': description: Retorna os dados do plano. schema: $ref: '#/definitions/plan_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Produto recorrência não habilitado. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X PATCH \ https://api-homologacao.getnet.com.br/v1/plans/51995e24-b1ae-4826-8e15-2a568a87abdd/status/active \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'content-type: application/json; charset=utf-8' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' /v1/plans/subscriptions/migration: post: summary: Altera o Plano de uma lista de Assinaturas. description: Neste endpoint você pode solicitar a alteração do Plano de uma lista de Assinaturas, ou ainda, solicitar a alteração do Plano de todas as Assinaturas de um Plano origem para um Plano destino. consumes: - application/json produces: - application/json tags: - Planos parameters: - required: true description: Tipo do conteúdo. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: false description: Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. type: string name: username in: header - in: body required: true name: body description: Aqui serão informados os identificadores dos Planos de origem e Plano destino, ou seja, as Assinaturas do Plano origem (campo from) serão alteradas (migradas) para o Plano destino (campo to). Também poderá ser informada como opcional uma lista de identificadores de Assinaturas para a necessidade de se alterar o Plano de somente Assinaturas específicas. Caso essa lista de Assinaturas não seja informada então o serviço irá migrar todas as Assinaturas do Plano origem (campo from) para Plano destino (campo to). schema: $ref: '#/definitions/subscription_plan_migration' responses: '202': description: Solicitação aceita para processamento, ou seja, o processo de migração de Assinaturas de um Plano origem para um Plano destino será feito de forma assíncrona. É possível verificar o progresso de migração das Assinaturas por meio do serviço GET /v1/subscriptions informando o identificador do plano destino. schema: $ref: '#/definitions/subscription_plan_migration' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Produto recorrência não habilitado. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' '503': description: Serviço indisponível. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/plans/subscriptions/migration \ -H 'authorization: Bearer 151f3061-d162-41c0-a3e7-474c49e60f57' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json; charset=utf-8' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' -H 'username: Usuario' \ -d '{ \"from\": \"9aca75f2-bb03-42d7-aa09-7e46409ded26\", \"to\": \"a0ca3090-a4f6-4e1f-a91d-a535454dd72b\", \"subscriptions\": [ \"a0ca3090-a4f6-4e1f-a91d-a535454dd72b\", \"4fd5d55f-de02-4d0b-ab6a-33ea4d92511a\" ] }' /v1/subscriptions: post: summary: Cadastra uma nova assinatura description: Neste endpoint você pode criar uma nova assinatura de recorrência. tags: - Assinaturas consumes: - application/json produces: - application/json parameters: - required: true description: Tipo do conteúdo. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: false description: Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. type: string name: username in: header - required: false description: Requisição contendo os dados para cadastro de uma nova assinatura. in: body name: body schema: $ref: '#/definitions/subscription' responses: '201': description: Assinatura criada com sucesso. schema: $ref: '#/definitions/subscription_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Produto recorrência não habilitado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/subscriptions \ -H 'authorization: Bearer 151f3061-d162-41c0-a3e7-474c49e60f57' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json; charset=utf-8' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' \ -d '{ "seller_id": "6eb2412c-165a-41cd-b1d9-76c575d70a28", "customer_id": "customer_21081826", "plan_id": "51995e24-b1ae-4826-8e15-2a568a87abdd", "order_id": "6d2e4380-d8a3-4ccb-9138-c289182818a3", "subscription": { "payment_type": { "credit": { "transaction_type": "FULL", "number_installments": 1, "soft_descriptor": "LOJA*TESTE*COMPRA-123", "billing_address": { "street": "Av. Brasil", "number": "1000", "complement": "Sala 1", "district": "São Geraldo", "city": "Porto Alegre", "state": "RS", "country": "Brasil", "postal_code": "90230060" }, "card": { "number_token": "dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c", "cardholder_name": "JOAO DA SILVA", "security_code": "123", "brand": "Mastercard", "expiration_month": "12", "expiration_year": "28", "bin": "123412", "card_id": "17b5ce46-db3f-4e03-90d0-42aa3131c41e" } } }, "shippings": [ { "first_name": "João", "last_name": "da Silva", "email": "customer@email.com.br", "phone_number": "5551999887766", "shipping_amount": 3000, "address": { "street": "Av. Brasil", "number": "1000", "complement": "Sala 1", "district": "São Geraldo", "city": "Porto Alegre", "state": "RS", "country": "Brasil", "postal_code": "90230060" } } ] }, "device": { "ip_address": "127.0.0.1", "device_id": "hash-device-id" } } get: summary: Lista de assinaturas description: 'Neste endpoint você pode listar as assinaturas previamente cadastrados com base nos filtros escolhidos. ' tags: - Assinaturas produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Número da página em que inicia a paginação. minimum: 1 type: number name: page in: query - required: true description: Limite de resultados por página. minimum: 0 maximum: 9999 type: number name: limit in: query - required: false description: Identificador do comprador. type: string name: customer_id maxLength: 100 in: query - required: false description: Identificador do plano de recorrência. type: string name: plan_id minLength: 36 maxLength: 36 format: uuidv4 in: query - required: false description: Identificador da assinatura de recorrência. type: string name: subscription_id minLength: 36 maxLength: 36 format: uuidv4 in: query - required: false description: Data inicial do próximo agendamento. type: string name: next_scheduled_date[start] in: query - required: false description: Data final do próximo agendamento. type: string name: next_scheduled_date[end] in: query - required: false description: Data inicial de criação da assinatura. type: string name: create_date[start] in: query - required: false description: Data final de criação da assinatura. type: string name: create_date[end] in: query - required: false description: Data inicial da assinatura. type: string name: end_date[start] in: query - required: false description: Data final da assinatura. type: string name: end_date[end] in: query - required: false description: Campo para realizar a ordenação. default: create_date enum: - order_id - create_date - end_date type: string name: sort in: query - required: false description: Tipo de ordenação. Ascendente ou Descendente. default: asc enum: - asc - desc type: string name: sort_type in: query - required: false description: Status da assinatura. enum: - processing - canceled - success - delayed - expired type: string name: status in: query - name: expand in: query type: array items: type: string required: false description: | Exibe informações adicionais da assinatura como por exemplo as alterações de data e valor previstas para a mesma. A exibição de algumas informações poderá depender da habilitação de um produto específico na Getnet. * `floating_data` - Inclui no resultado o bloco de informações de todas as alterações de data e valor. responses: '200': description: Lista retornada com sucesso. schema: $ref: '#/definitions/subscription_filter_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Produto recorrência não habilitado. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/subscriptions?page=1&limit=10 \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' /v1/subscriptions/{subscription_id}: get: summary: Assinatura de recorrência description: Neste endpoint você pode buscar os dados de uma assinatura específica, previamente cadastrado. tags: - Assinaturas produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Identificador da assinatura de recorrência. type: string name: subscription_id minLength: 36 maxLength: 36 format: uuidv4 in: path - name: expand in: query type: array items: type: string required: false description: | Exibe informações adicionais da assinatura como por exemplo as alterações de data e valor previstas para a mesma. A exibição de algumas informações poderá depender da habilitação de um produto específico na Getnet. * `floating_data` - Inclui no resultado o bloco de informações de todas as alterações de data e valor. responses: '200': description: Assinatura retornada com sucesso. schema: $ref: '#/definitions/subscription_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Produto recorrência não habilitado. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/subscriptions/5d740ea0-b7d1-42f5-ad64-5a5521e12er9 \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' /v1/subscriptions/{subscription_id}/cancel: post: summary: Cancela uma assinatura de recorrência description: | Neste endpoint você pode cancelar uma assinatura previamente cadastrada. Lembrando que o cancelamento da assinatura também efetua o cancelamento da próxima cobrança agendada. tags: - Assinaturas consumes: - application/json produces: - application/json parameters: - required: true description: Tipo do conteúdo. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: false description: Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. type: string name: username in: header - required: true description: Identificador da assinatura de recorrência. type: string name: subscription_id minLength: 36 maxLength: 36 format: uuidv4 in: path - required: false description: Conjundo de dados adicionais para cancelamento. in: body name: body schema: $ref: '#/definitions/subscription_cancel' responses: '200': description: Assinatura cancelada com sucesso. schema: $ref: '#/definitions/subscription_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Produto recorrência não habilitado. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/subscriptions/5d740ea0-b7d1-42f5-ad64-5a5521e12er9/cancel \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'content-type: application/json; charset=utf-8' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' \ -d '{ "seller_id": "6eb2412c-165a-41cd-b1d9-76c575d70a28", "status_details": "Cliente não tem mais interesse no serviço/produto" } /v1/subscriptions/{subscription_id}/charges/projection: get: summary: Demonstra a projeção de cobranças description: | Neste endpoint é possível demonstrar a projeção de cobranças programadas para a assinatura de recorrência. Lembrando que as projeções e as cobranças que forem cadastradas com datas maiores que 28, dependendo do mês, podem respeitar o último dia do mês. __Por exemplo:__ Dia de pagamento: 31 Projeção: * 31/10/2019 * 30/11/2019 * 31/12/2019 tags: - Assinaturas produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Identificador da assinatura de recorrência. type: string name: subscription_id minLength: 36 maxLength: 36 format: uuidv4 in: path - name: expand in: query type: array items: type: string required: false description: | Exibe informações adicionais da assinatura como por exemplo as alterações de data e valor previstas para a mesma. A exibição de algumas informações poderá depender da habilitação de um produto específico na Getnet. * `installment` - Inclui no resultado a informação de número da parcela * `floating_data` - Inclui no resultado o bloco de informações de todas as alterações de data e valor. responses: '200': description: Projeção retornada com sucesso. schema: $ref: '#/definitions/subscription_projection_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Produto recorrência não habilitado. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/subscriptions/5d740ea0-b7d1-42f5-ad64-5a5521e12er9/charges/projection?limit=1 \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' /v1/subscriptions/{subscription_id}/confirmPayment: post: summary: Confirma o pagamento da assinatura description: Neste endpoint você pode confirmar o pagamento de uma assinatura feito de forma manual. tags: - Assinaturas consumes: - application/json produces: - application/json parameters: - required: true description: Tipo do conteúdo. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: false description: Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. type: string name: username in: header - required: true description: Identificador da assinatura de recorrência. type: string name: subscription_id minLength: 36 maxLength: 36 format: uuidv4 in: path - required: false description: Conjunto de informações para confirmação de pagamento de assinatura. in: body name: body schema: $ref: '#/definitions/subscription_confirm' responses: '200': description: Pagamento confirmado com sucesso. schema: $ref: '#/definitions/subscription_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Produto recorrência não habilitado. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/subscriptions/5d740ea0-b7d1-42f5-ad64-5a5521e12er9/confirmPayment \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'content-type: application/json; charset=utf-8' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' \ -d '{ "seller_id": "6eb2412c-165a-41cd-b1d9-76c575d70a28", "status_details": "Pagamento de assinatura confirmado", "charge_id": "52bc81b2-f079-4f7b-b63a-f653ff29d794" } /v1/subscriptions/{subscription_id}/paymentDate: patch: summary: Atualiza data da cobrança description: | Neste endpoint você pode atualizar a data da cobrança de uma assinatura previamente cadastrada Lembrando que ao alterar a data de cobrança, todas as próximas parcelas serão atualizadas com a nova data. tags: - Assinaturas consumes: - application/json produces: - application/json parameters: - required: true description: Tipo do conteúdo. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: false description: Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. type: string name: username in: header - required: true description: Identificador da assinatura de recorrência. type: string name: subscription_id minLength: 36 maxLength: 36 format: uuidv4 in: path - required: false description: Conjunto de dados para atualização de data de pagamento. in: body name: body schema: $ref: '#/definitions/subscription_payment_date' responses: '200': description: Data atualizada com sucesso. schema: $ref: '#/definitions/subscription_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Produto recorrência não habilitado. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X PATCH \ https://api-homologacao.getnet.com.br/v1/subscriptions/5d740ea0-b7d1-42f5-ad64-5a5521e12er9/paymentDate \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'content-type: application/json; charset=utf-8' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' \ -d '{ "day": 25 } /v1/subscriptions/{subscription_id}/paymentType/credit/card: patch: summary: Atualiza os dados de pagamento description: Neste endpoint você pode atualizar os dados de pagamento de uma assinatura previamente cadastrada tags: - Assinaturas consumes: - application/json produces: - application/json parameters: - required: true description: Tipo do conteúdo. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: false description: Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. type: string name: username in: header - required: true description: Identificador da assinatura de recorrência. type: string name: subscription_id minLength: 36 maxLength: 36 format: uuidv4 in: path - required: true description: Conjunto de dados para troca de tipo de pagamento. in: body name: body schema: $ref: '#/definitions/subscription_update_payment_type' responses: '200': description: Dados de pagamento atualizados com sucesso. schema: $ref: '#/definitions/subscription_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Produto recorrência não habilitado. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X PATCH \ https://api-homologacao.getnet.com.br/v1/subscriptions/5d740ea0-b7d1-42f5-ad64-5a5521e12er9/paymentType/credit/card \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'content-type: application/json; charset=utf-8' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' \ -d '{ "number_token": "dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c", "cardholder_name": "JOAO DA SILVA", "brand": "Mastercard", "expiration_month": "12", "expiration_year": "28", "bin": "123412", "card_id": "17b5ce46-db3f-4e03-90d0-42aa3131c41e" } /v1/subscriptions/{subscription_id}/floating: post: summary: Cadastra uma alteração de data ou valor para a assinatura description: | Neste endpoint você pode criar uma nova alteração de data e/ou valor para uma ou mais cobranças que estão agendadas da assinatura. Para utilizar esse endpoint é necessário o estabelecimento estar habilitado para esse produto específico. Para mais detalhes olhar as Regras de alteração de data. tags: - Assinaturas consumes: - application/json produces: - application/json parameters: - required: true description: Tipo do conteúdo. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Identificador da assinatura de recorrência. type: string name: subscription_id minLength: 36 maxLength: 36 format: uuidv4 in: path - required: false description: Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. type: string name: username in: header - required: false description: Requisição contendo os dados para cadastro das alterações de data e/ou valor para determinadas cobranças. in: body name: body schema: $ref: '#/definitions/subscription_floating_data_array_creation' responses: '201': description: Assinatura alterada com sucesso. schema: $ref: '#/definitions/subscription_floating_data_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Produto recorrência não habilitado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/subscriptions/9aca75f2-bb03-42d7-aa09-7e46409ded26/floating \ -H 'authorization: Bearer 151f3061-d162-41c0-a3e7-474c49e60f57' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json; charset=utf-8' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' -H 'username: Usuario' \ -d '{ \"subscription_id\": \"9aca75f2-bb03-42d7-aa09-7e46409ded26\", \"floating_data\": [ { \"installment\": 2, \"new_scheduled_date\": \"2020-07-16\", \"new_amount": 123, \"original_scheduled_date": \"2020-07-09\", \"original_amount": 10000 }, { \"installment\": 4, \"new_scheduled_date\": \"2020-09-05\", \"new_amount\": 321, \"original_scheduled_date\": \"2020-09-09\", \"original_amount\": 10000 } ] }' get: summary: Lista todas as alterações de data e/ou valor de uma assinatura de recorrência description: | Neste endpoint você pode buscar os dados de todas as alterações de data e/ou valor nas cobranças de uma assinatura específica. Para utilizar esse endpoint é necessário o estabelecimento estar habilitado para esse produto específico. Para mais detalhes olhar as Regras de alteração de data. tags: - Assinaturas produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Identificador da assinatura de recorrência. type: string name: subscription_id minLength: 36 maxLength: 36 format: uuidv4 in: path responses: '200': description: Alterações de data e/ou valor das cobranças da Assinatura retornadas com sucesso. schema: $ref: '#/definitions/subscription_floating_data_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Produto recorrência não habilitado. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/subscriptions/5d740ea0-b7d1-42f5-ad64-5a5521e12er9/floating \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' delete: summary: Remove todas as alterações de data e valor de uma assinatura. description: Neste endpoint você pode remover todas as alterações de data e valor nas cobranças de uma assinatura específica. A assinatura ficará com os valores e datas originais conforme o plano associado. Para utilizar esse endpoint é necessário o estabelecimento estar habilitado para esse produto específico. tags: - Assinaturas produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Identificador da assinatura de recorrência. type: string name: subscription_id minLength: 36 maxLength: 36 format: uuidv4 in: path - required: false description: Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. type: string name: username in: header responses: '200': description: Alterações de data e valor foram removidos parcialmente. schema: $ref: '#/definitions/subscription_floating_data_remove_response' '204': description: Alterações de data e valor foram removidos com sucesso. '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Produto cofre não habilitado. schema: $ref: '#/definitions/error' '404': description: Recurso não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X DELETE \ https://api-homologacao.getnet.com.br/v1/subscriptions/5d740ea0-b7d1-42f5-ad64-5a5521e12er9/floating \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'seller_id: 7ea44e22-2af3-40a1-a10e-9bb6ebdb9892' -H 'username: Usuario' patch: summary: Adiciona novas alterações de data e/ou valor para cobranças de uma assinatura. description: | Neste endpoint você pode adicionar novas alterações de data e/ou valor para cobranças de uma assinatura específica. Este endpoint pode ser utilizado para assinaturas que já possuem alterações de data e valor cadastradas. Para utilizar esse endpoint é necessário o estabelecimento estar habilitado para esse produto específico. Para mais detalhes olhar as Regras de alteração de data. tags: - Assinaturas consumes: - application/json produces: - application/json parameters: - required: true description: Tipo do conteúdo. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Identificador da assinatura de recorrência. type: string name: subscription_id minLength: 36 maxLength: 36 format: uuidv4 in: path - required: false description: Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. type: string name: username in: header - required: false description: Requisição contendo os dados para adição das alterações de data e/ou valor para determinadas cobranças. in: body name: body schema: $ref: '#/definitions/subscription_floating_data_array_creation' responses: '200': description: Alterações de data e valor inseridas com sucesso. schema: $ref: '#/definitions/subscription_floating_data_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Produto recorrência não habilitado. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '422': description: Requisição inválida. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X PATCH \ https://api-homologacao.getnet.com.br/v1/subscriptions/5d740ea0-b7d1-42f5-ad64-5a5521e12er9/floating \ -H "content-type: application/json; charset=utf-8" \ -H "authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc" \ -H "seller_id: 7ea44e22-2af3-40a1-a10e-9bb6ebdb9892" -H "username: Usuario" \ -d "[ { \"installment\": 6, \"new_amount\": 7888, \"new_scheduled_date\": \"2020-08-26\" } ]" /v1/subscriptions/{subscription_id}/floating/installment/{installment}: delete: summary: Remove a alteração de data e valor para uma cobrança específica de uma assinatura. description: Neste endpoint você pode remover todas as alterações de data e valor para uma cobrança específica de uma assinatura. A cobrança ficará com os valores e datas originais conforme o plano associado. Para utilizar esse endpoint é necessário o estabelecimento estar habilitado para esse produto específico. tags: - Assinaturas produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Identificador da assinatura de recorrência. type: string name: subscription_id minLength: 36 maxLength: 36 format: uuidv4 in: path - required: true description: Número da parcela que será aplicada a alteração. type: integer format: int32 name: installment minimum: 1 in: path - required: false description: Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. type: string name: username in: header responses: '200': description: Alterações de data e valor foram removidos parcialmente. schema: $ref: '#/definitions/subscription_floating_data_remove_response' '204': description: Alterações de data e valor foram removidos com sucesso. '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Produto cofre não habilitado. schema: $ref: '#/definitions/error' '404': description: Recurso não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X DELETE \ https://api-homologacao.getnet.com.br/v1/subscriptions/5d740ea0-b7d1-42f5-ad64-5a5521e12er9/floating\installment\3 \ -H "content-type: application/json; charset=utf-8" \ -H "authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc" \ -H "seller_id: 7ea44e22-2af3-40a1-a10e-9bb6ebdb9892" -H "username: Usuario" \ put: summary: Atualiza a data e valor para uma cobrança específica de uma assinatura. description: | Neste endpoint você pode atualizar a data e valor para uma cobrança específica de uma assinatura. Este endpoint pode ser utilizado para uma cobrança específica que já possui alteração data e valor cadastrado. Para utilizar esse endpoint é necessário o estabelecimento estar habilitado para esse produto específico. Para mais detalhes olhar as Regras de alteração de data. tags: - Assinaturas consumes: - application/json produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Identificador da assinatura de recorrência. type: string name: subscription_id minLength: 36 maxLength: 36 format: uuidv4 in: path - required: true description: Número da parcela que será aplicada a alteração. type: integer format: int32 name: installment minimum: 1 in: path - required: false description: Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. type: string name: username in: header - required: false description: Dados para atualização de data e/ou valor de uma determinada cobrança. in: body name: body schema: $ref: '#/definitions/subscription_floating_data_update' responses: '200': description: Alterações de data e valor inseridas com sucesso. schema: $ref: '#/definitions/subscription_floating_data_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Produto recorrência não habilitado. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '422': description: Requisição inválida. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X PUT \ https://api-homologacao.getnet.com.br/v1/subscriptions/5d740ea0-b7d1-42f5-ad64-5a5521e12er9/floating/installment/3 \ -H "content-type: application/json; charset=utf-8" \ -H "authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc" \ -H "seller_id: 7ea44e22-2af3-40a1-a10e-9bb6ebdb9892" -H "username: Usuario" \ -d "{\"new_amount\": 3219, \"new_scheduled_date\": \"2020-10-17\"}" /v1/subscriptions/{subscription_id}/plans/migration: post: summary: Alteração do Plano de uma Assinatura. description: Nesse endpoint você pode solicitar a alteração do Plano de uma Assinatura específica. consumes: - application/json produces: - application/json tags: - Assinaturas parameters: - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true type: string name: subscription_id in: path - required: false description: Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. type: string name: username in: header - required: false in: body name: body schema: $ref: '#/definitions/plan_migration_request' responses: '200': description: Assinatura migrada com sucesso. schema: $ref: '#/definitions/subscription_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/v1/subscriptions/9aca75f2-bb03-42d7-aa09-7e46409ded26/plans/migration \ -H 'authorization: Bearer 151f3061-d162-41c0-a3e7-474c49e60f57' \ -H 'cache-control: no-cache' \ -H 'content-type: application/json; charset=utf-8' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' -H 'username: Usuario' \ -d '{ \"from\": \"9aca75f2-bb03-42d7-aa09-7e46409ded26\", \"to\": \"a0ca3090-a4f6-4e1f-a91d-a535454dd72b\" }' /v1/cards/binlookup/{bin}: get: tags: - Consulta BIN summary: Retorna as informações de um Bin. description: Este endpoint retorna as informações de um BIN como por exemplo o nome da bandeira, código da bandeira, país emissor e etc." operationId: consultaBinUsingGET produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true name: bin in: path description: bin type: string responses: '200': description: Retorna a lista dos BINs encontrados. schema: $ref: '#/definitions/consulta_bin_response' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' deprecated: false /v1/charges: get: summary: Lista de cobranças description: Neste endpoint você pode listar as cobranças cadastradas com base nos filtros escolhidos tags: - Assinaturas produces: - application/json parameters: - required: true description: | Authorization: Bearer *AuthString*
Onde *AuthString* é token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Número da página em que inicia a paginação. minimum: 1 type: number name: page in: query - required: true description: Limite de resultados por página. minimum: 0 maximum: 9999 type: number name: limit in: query - required: false description: Identificador da cobrança. type: string name: charge_id minLength: 36 maxLength: 36 format: uuidv4 in: query - required: false description: Código de identificação do e-commerce. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: query - required: false description: Identificador da assinatura de recorrência. type: string name: subscription_id minLength: 36 maxLength: 36 format: uuidv4 in: query - required: false description: Status da cobrança. enum: - paid - denied - processing - scheduled - canceled type: string name: status in: query - required: false description: Data de início. type: string name: start_date in: query - required: false description: Data final. type: string name: end_date in: query - required: false description: Data de agendamento. type: string name: scheduled_date in: query - required: false description: Número de retentativas. minimum: 0 type: number name: retries in: query - required: false description: Campo para realizar a ordenação. default: create_date enum: - create_date - installment - scheduled_date type: string name: sort in: query - required: false description: Tipo de ordenação. Ascendente ou Descendente. enum: - asc - desc type: string name: sort_type in: query responses: '200': description: Retorna a lista de cobranças. schema: $ref: '#/definitions/charge_filter_response' '400': description: Requisição inválida. schema: $ref: '#/definitions/error' '401': description: Autenticação inválida. schema: $ref: '#/definitions/error' '403': description: Produto recorrência não habilitado. schema: $ref: '#/definitions/error' '404': description: Não encontrado. schema: $ref: '#/definitions/error' '500': description: Erro interno do servidor ou serviço. schema: $ref: '#/definitions/error' x-code-samples: - lang: cURL source: | curl -X GET \ https://api-homologacao.getnet.com.br/v1/charges?page=1&limit=10 \ -H 'authorization: Bearer 72402c54-6bd3-4895-a6b4-adfded0c11dc' \ -H 'seller_id: 6eb2412c-165a-41cd-b1d9-76c575d70a28' definitions: payment_credit: type: object description: Conjunto de dados referentes a transação de pagamento required: - amount - credit - order - customer properties: seller_id: type: string description: Código de identificação do e-commerce. minLength: 36 maxLength: 36 format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 amount: type: integer description: Valor da compra em centavos. example: 100 currency: type: string description: Identificação da moeda (Consultar código em "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 order: $ref: '#/definitions/order' customer: $ref: '#/definitions/customer_credit' device: $ref: '#/definitions/device_credit' shippings: type: array items: $ref: '#/definitions/shipping_credit' sub_merchant: $ref: '#/definitions/sub_merchant' credit: $ref: '#/definitions/credit' wallet: $ref: '#/definitions/wallet' payment_debit: type: object description: Conjunto de dados referentes a transação de pagamento required: - seller_id - amount - debit - order - customer properties: seller_id: type: string description: Código de identificação do e-commerce. minLength: 36 maxLength: 36 format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 amount: type: integer description: Valor da compra em centavos. example: 100 currency: type: string description: Identificação da moeda (Consultar código em "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 order: $ref: '#/definitions/order' customer: $ref: '#/definitions/customer_debit' device: $ref: '#/definitions/device_debit' shippings: type: array items: $ref: '#/definitions/shipping_debit' sub_merchant: $ref: '#/definitions/sub_merchant' debit: $ref: '#/definitions/debit' wallet: $ref: '#/definitions/wallet' payment_boleto: type: object description: Conjunto de dados referentes a transação de boleto. required: - seller_id - amount - order - boleto - customer properties: seller_id: type: string description: Código de identificação do e-commerce. minLength: 36 maxLength: 36 format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 amount: type: integer description: Valor da compra em centavos. example: 100 currency: type: string description: Identificação da moeda (Consultar código em "https://www.currency-iso.org/en/home/tables/table-a1.html"). minLength: 3 maxLength: 3 example: BRL order: $ref: '#/definitions/order' boleto: $ref: '#/definitions/boleto' customer: $ref: '#/definitions/customer_boleto' payment_boleto_v2: type: object description: Conjunto de dados referentes a transação de boleto. required: - seller_id - amount - order - boleto - customer - idempotency_key - request_id properties: idempotency_key: type: string description: Chave de idempotência, utilizada para controle de requisições, deve ser única por requisição, pois caso se repita, sempre será retornado os mesmos dados. minLength: 1 maxLength: 64 example: 1eb2412c-165a-41cd-b1d9-76c575d70a21 request_id: type: string description: ID de identifcação da requisição. minLength: 36 maxLength: 36 format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 data: type: object description: Dados do pagamento. properties: amount: type: integer description: Valor da compra em centavos. example: 100 currency: type: string description: Identificação da moeda (Consultar código em "https://www.currency-iso.org/en/home/tables/table-a1.html"). minLength: 3 maxLength: 3 example: BRL payment: $ref: '#/definitions/payment' order: $ref: '#/definitions/order' boleto: $ref: '#/definitions/boleto' customer: $ref: '#/definitions/customer_boleto' additional_data: type: object description: Dados adicionais do pagamento. properties: split: $ref: '#/definitions/split_data' split_data: type: object description: Dados para realização de split de pagamento. properties: subseller_list_payment: type: array description: Lista de Lojas e seus devidos valores para pagamento. items: properties: subseller_id: type: string description: ID do subseller cadastrado na plataforma de marketplace (MGM). minLength: 0 maxLength: 25 document_type: type: string description: Tipo de documento do Subcomércio. enum: - CPF - CNPJ example: CNPJ minLength: 3 maxLength: 4 document_number: type: string description: Número do documento do Subcomércio sem pontuação. (sem máscara) minLength: 11 maxLength: 15 example: '12345678912' subseller_sale_amount: type: integer description: Parte do Valor da loja em relação ao Pedido (em centavos). example: 10520 items: type: array description: Lista de items do Subcomércio. required: - id - description - amount properties: id: type: string description: Identificador do Item/Produto. minLength: 1 maxLength: 25 example: 6bbaee93-d6d8-4d93-a0e8-d1558ccdf08b description: type: string description: Descrição do Item/Produto. amount: type: integer description: Valor do Item/Produto (em centavos). example: 1099 transaction_rate_percent: type: number description: 'Taxa a ser cobrada no item em porcentagem se não enviar a taxa será definida a mesma do cadastro.
Se tax_percent for informado não se deve enviar o tax_amount.
Obs: Caso tax_percent e tax_amount forem enviado para um mesmo item os valores serão somados.' example: 1.2 transaction_rate_amount: type: integer description: 'Taxa a ser cobrada no item em valor (em centavos) se não enviar a taxa será definida a mesma do cadastro.
Se tax_amount for informado não se deve enviar o tax_percent.
Obs: Caso tax_percent e tax_amount forem enviado para um mesmo item os valores serão somados.' example: 235 order: type: object description: Conjunto de dados para identificação da compra required: - order_id properties: order_id: type: string description: Código de identificação da compra utilizado pelo e-commerce maxLength: 36 example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 sales_tax: type: number description: Valor de impostos example: 0 product_type: type: string description: Identificador do tipo de produto vendido dentre as opções enum: - cash_carry - digital_content - digital_goods - digital_physical - gift_card - physical_goods - renew_subs - shareware - service example: service payment: type: object description: Metódo de pagamento. properties: payment_method: type: string description: Metódo de pagamento. example: BOLETO enum: - BOLETO billing_address: type: object description: Conjunto de dados referentes ao endereço de cobrança properties: street: type: string description: Logradouro.
Campo obrigatório para o Antifraude maxLength: 60 example: Av. Brasil number: type: string description: Número do logradouro.
Campo obrigatório para o Antifraude maxLength: 10 example: '1000' complement: type: string description: Complemento do logradouro.
Campo obrigatório para o Antifraude maxLength: 60 example: Sala 1 district: type: string description: Bairro. maxLength: 40 example: São Geraldo city: type: string description: Cidade.
Campo obrigatório para o Antifraude maxLength: 40 example: Porto Alegre state: type: string description: Estado (UF).
Campo obrigatório para o Antifraude maxLength: 20 example: RS country: type: string description: País.
Campo obrigatório para o Antifraude maxLength: 20 example: Brasil postal_code: type: string description: Código Postal, CEP no Brasil ou ZIP nos Estados Unidos. (sem máscara)
Campo obrigatório para o Antifraude maxLength: 8 example: '90230060' address_credit: type: object description: Conjunto de dados referentes ao endereço do comprador properties: street: type: string description: Logradouro.
Campo obrigatório para o Antifraude maxLength: 60 example: Av. Brasil number: type: string description: Número do logradouro.
Campo obrigatório para o Antifraude maxLength: 10 example: '1000' complement: type: string description: Complemento do logradouro.
Campo obrigatório para o Antifraude maxLength: 60 example: Sala 1 district: type: string description: Bairro. maxLength: 40 example: São Geraldo city: type: string description: Cidade.
Campo obrigatório para o Antifraude maxLength: 40 example: Porto Alegre state: type: string description: Estado (UF).
Campo obrigatório para o Antifraude maxLength: 20 example: RS country: type: string description: País.
Campo obrigatório para o Antifraude maxLength: 20 example: Brasil postal_code: type: string description: Código Postal, CEP no Brasil ou ZIP nos Estados Unidos. (sem máscara)
Campo obrigatório para o Antifraude maxLength: 8 example: '90230060' address_debit: type: object description: Conjunto de dados referentes ao endereço do comprador properties: street: type: string description: Logradouro.
Campo obrigatório para o Antifraude maxLength: 60 example: Av. Brasil number: type: string description: Número do logradouro.
Campo obrigatório para o Antifraude maxLength: 10 example: '1000' complement: type: string description: Complemento do logradouro.
Campo obrigatório para o Antifraude maxLength: 60 example: Sala 1 district: type: string description: Bairro. maxLength: 40 example: São Geraldo city: type: string description: Cidade.
Campo obrigatório para o Antifraude maxLength: 40 example: Porto Alegre state: type: string description: Estado (UF).
Campo obrigatório para o Antifraude maxLength: 20 example: RS country: type: string description: País.
Campo obrigatório para o Antifraude maxLength: 20 example: Brasil postal_code: type: string description: Código Postal, CEP no Brasil ou ZIP nos Estados Unidos. (sem máscara)
Campo obrigatório para o Antifraude maxLength: 8 example: '90230060' address: type: object description: Conjunto de dados referentes ao endereço do comprador properties: street: type: string description: Logradouro. maxLength: 60 example: Av. Brasil number: type: string description: Número do logradouro. maxLength: 10 example: '1000' complement: type: string description: Complemento do logradouro. maxLength: 60 example: Sala 1 district: type: string description: Bairro. maxLength: 40 example: São Geraldo city: type: string description: Cidade. maxLength: 40 example: Porto Alegre state: type: string description: Estado (UF). maxLength: 20 example: RS country: type: string description: País. maxLength: 20 example: Brasil postal_code: type: string description: Código Postal, CEP no Brasil ou ZIP nos Estados Unidos. (sem máscara) maxLength: 8 example: '90230060' address_boleto: type: object description: Conjunto de dados referentes ao endereço do comprador required: - street - number - district - city - state - postal_code properties: street: type: string description: Logradouro. maxLength: 20 example: Av. Brasil number: type: string description: Número do logradouro. maxLength: 6 example: '1000' complement: type: string description: Complemento do logradouro. maxLength: 12 example: Sala 1 district: type: string description: Bairro. maxLength: 30 example: São Geraldo city: type: string description: Cidade. maxLength: 20 example: Porto Alegre state: type: string description: Estado (UF). maxLength: 2 example: RS postal_code: type: string description: Código Postal, CEP no Brasil ou ZIP nos Estados Unidos. (sem máscara) minLength: 8 maxLength: 8 example: '90230060' customer_credit: type: object description: Conjunto de dados referentes ao comprador. required: - customer_id - billing_address properties: customer_id: type: string description: Identificador do comprador. example: customer_21081826 maxLength: 100 first_name: type: string description: Primeiro nome do comprador.
Campo obrigatório para o Antifraude maxLength: 40 example: João last_name: type: string description: Último nome do comprador.
Campo obrigatório para o Antifraude maxLength: 80 example: da Silva name: type: string description: Nome completo do comprador. Obrigatório para boleto. maxLength: 100 example: João da Silva email: type: string description: Email do comprador.
Campo obrigatório para o Antifraude format: email example: customer@email.com.br document_type: type: string description: Tipo do documento de identificação do comprador. Obrigatório para boleto.
Campo obrigatório para o Antifraude maxLength: 26 example: CPF document_number: type: string description: Número do documento do comprador sem pontuação. (sem máscara)
Campo obrigatório para o Antifraude minLength: 11 maxLength: 15 example: '12345678912' phone_number: type: string description: Telefone do comprador. (sem máscara)
Campo obrigatório para o Antifraude maxLength: 15 example: '5551999887766' billing_address: $ref: '#/definitions/billing_address' customer_debit: type: object description: Conjunto de dados referentes ao comprador. required: - customer_id - billing_address properties: customer_id: type: string description: Identificador do comprador. example: customer_21081826 maxLength: 100 first_name: type: string description: Primeiro nome do comprador.
Campo obrigatório para o Antifraude maxLength: 40 example: João last_name: type: string description: Último nome do comprador.
Campo obrigatório para o Antifraude maxLength: 80 example: da Silva name: type: string description: Nome completo do comprador. Obrigatório para boleto. maxLength: 100 example: João da Silva email: type: string description: Email do comprador.
Campo obrigatório para o Antifraude format: email example: customer@email.com.br document_type: type: string description: Tipo do documento de identificação do comprador. Obrigatório para boleto.
Campo obrigatório para o Antifraude maxLength: 26 example: CPF document_number: type: string description: Número do documento do comprador sem pontuação. (sem máscara)
Campo obrigatório para o Antifraude minLength: 11 maxLength: 15 example: '12345678912' phone_number: type: string description: Telefone do comprador. (sem máscara)
Campo obrigatório para o Antifraude maxLength: 15 example: '5551999887766' billing_address: $ref: '#/definitions/address_debit' customer_boleto: type: object description: Conjunto de dados referentes ao comprador. required: - name - document_type - document_number - billing_address properties: first_name: type: string description: Primeiro nome do comprador. maxLength: 40 example: João name: type: string description: Nome completo do comprador. Obrigatório para boleto. maxLength: 40 example: João da Silva document_type: type: string description: Tipo do documento de identificação do comprador. Obrigatório para boleto. enum: - CPF - CNPJ example: CPF document_number: type: string description: Número do documento do comprador sem pontuação. (sem máscara) minLength: 11 maxLength: 15 example: '12345678912' billing_address: $ref: '#/definitions/address_boleto' device: type: object description: Conjunto de dados referentes ao dispositivo utilizado pelo comprador. properties: ip_address: type: string description: Endereço IP (IPv4) do dispositivo do comprador. Este atributo deve ser capturado pela sua aplicação, a partir do dispositivo do comprador (mobile; browser; etc.) e enviado no payload, afim de enriquecer nossas análises preventivas. format: IPv4 example: 127.0.0.1 device_id: type: string description: Hash de identificação (Device Fingerprint) do dispositivo. Mais informações no tópico Antifraude. example: hash-device-id device_credit: type: object description: Conjunto de dados referentes ao dispositivo utilizado pelo comprador. properties: ip_address: type: string description: Endereço IP (IPv4) do dispositivo do comprador. Este atributo deve ser capturado pela sua aplicação, a partir do dispositivo do comprador (mobile; browser; etc.) e enviado no payload, afim de enriquecer nossas análises preventivas.
Campo obrigatório para o Antifraude format: IPv4 example: 127.0.0.1 device_id: type: string description: Hash de identificação (Device Fingerprint) do dispositivo. Mais informações no tópico Antifraude.
Campo obrigatório para o Antifraude example: hash-device-id device_debit: type: object description: Conjunto de dados referentes ao dispositivo utilizado pelo comprador. properties: ip_address: type: string description: Endereço IP (IPv4) do dispositivo do comprador. Este atributo deve ser capturado pela sua aplicação, a partir do dispositivo do comprador (mobile; browser; etc.) e enviado no payload, afim de enriquecer nossas análises preventivas.
Campo obrigatório para o Antifraude format: IPv4 example: 127.0.0.1 device_id: type: string description: Hash de identificação (Device Fingerprint) do dispositivo. Mais informações no tópico Antifraude.
Campo obrigatório para o Antifraude example: hash-device-id shipping_debit: type: object description: Conjunto de dados referentes ao endereço de entrega. properties: first_name: type: string description: Primeiro nome do comprador. maxLength: 40 example: João name: type: string description: Nome completo do comprador. maxLength: 100 example: João da Silva email: type: string description: Email do comprador. format: email example: customer@email.com.br phone_number: type: string description: Telefone do comprador. (sem máscara)
Campo obrigatório para o Antifraude maxLength: 15 example: '5551999887766' shipping_amount: type: number description: Valor do frete em centavos. example: 3000 address: $ref: '#/definitions/address_debit' shipping_credit: type: object description: Conjunto de dados referentes ao endereço de entrega. properties: first_name: type: string description: Primeiro nome do comprador. maxLength: 40 example: João name: type: string description: Nome completo do comprador. maxLength: 100 example: João da Silva email: type: string description: Email do comprador. format: email example: customer@email.com.br phone_number: type: string description: Telefone do comprador. (sem máscara)
Campo obrigatório para o Antifraude maxLength: 15 example: '5551999887766' shipping_amount: type: number description: Valor do frete em centavos. example: 3000 address: $ref: '#/definitions/address_credit' sub_merchant: type: object description: Para que a Getnet possa cumprir com as regras das Bandeiras e Arranjos, as Leis Federais e determinações do BACEN (Banco Central do Brasil) para identificação das entidades finais (subcomércios) que fazem as transações financeiras, os Facilitadores de Pagamento devem enviar os dados de identificação de seus clientes a cada transação enviada à Getnet. required: - identification_code - business_name - document_type - document_number - address - city - state - postal_code properties: identification_code: type: string description: ID do Sub comércio. example: '9058344' maxLength: 15 business_name: type: string description: Nome do recebedor ou Razão Social do Subcomércio. (Deve corresponder ao cadastro existente no site gov.br) example: 'Loja de roupas LTDA' maxLength: 80 document_type: type: string description: Tipo de documento do Subcomércio. enum: - CPF - CNPJ example: CNPJ minLength: 3 maxLength: 4 document_number: type: string description: CNPJ ou CPF do Subcomércio. example: '20551625000159' minLength: 11 maxLength: 14 foreign_type: type: string description: |

Há 3 tipos para os submerchants, sendo eles descritos como:

F - Full Foreign:
Todos os submerchants são internacionais.
P - Partial Foreign:
Carrinho misto com submerchants internacionais e nacionais.
D - Full Domestic:
Todos os submerchants são nacionais.

enum: - F - P - D example: D minLength: 1 maxLength: 1 address: type: string description: Logradouro do Subcomércio. (Não permitido o uso de vírgula) example: Torre Negra 44 maxLength: 40 city: type: string description: Cidade do Subcomércio. example: Cidade maxLength: 13 state: type: string description: Estado do Subcomércio. example: RS minLength: 2 maxLength: 2 postal_code: type: string description: Código Postal (CEP) do Subcomércio. example: '90520000' minLength: 8 maxLength: 8 credit: type: object description: Conjunto de dados referentes a transação de crédito. required: - delayed - save_card_data - transaction_type - number_installments - card properties: delayed: type: boolean description: Identifica se o crédito será feito com confirmação tardia. example: false pre_authorization: type: boolean description: Indicativo se a transação é uma pré autorização de crédito. example: false save_card_data: type: boolean description: Identifica se o cartão deve ser salvo para futuras compras. example: false transaction_type: type: string description: | Tipo de transação. Pagamento completo à vista, parcelado sem juros, parcelado com juros. enum: - FULL - INSTALL_NO_INTEREST - INSTALL_WITH_INTEREST example: FULL gateway_id: type: string description: | Merchant Payment Gateway ID. example: '00000999998' number_installments: type: number description: Número de parcelas para uma transação de crédito parcelado. example: 1 soft_descriptor: $ref: '#/definitions/soft_descriptor_global_sub_merchant' dynamic_mcc: $ref: '#/definitions/dynamic_mcc_sub_merchant' card: $ref: '#/definitions/card_credit' tokenization: $ref: '#/definitions/tokenization' credentials_on_file_type: type: string description: |

Tipo do COF (Credential On File).

ONE_CLICK: Usado quando é realizado a primeira transação (parcela) de um pagamento normal.
ONE_CLICK_PAYMENT: Usado quando é realizado transações para as demais parcelas restantes de um pagamento normal. Obs: Necessário informar o transaction_id da primeira transação realizada.
RECURRING: Usado quando é realizado a primeira transação (parcela) de um pagamento recorrente.
RECURRING_PAYMENT: Usado quando é realizado transações para as demais parcelas restantes de um pagamento recorrente. Obs: Necessário informar o transaction_id da primeira transação realizada.

Campos para o cumprimento de regras de carteiras digitais do arranjo SDWO - (Staged Digital Wallet Operator). O Modelo se trata de carteiras digitais (Wallets) que credenciam estabelecimentos para aceite de seu meio de pagamento, similar ao modelo de Facilitadores de Pagamento. Quanto a liquidação, os valores provenientes de pagamentos através das Wallets são enviados para o EC Wallet e, em segundo momento, ela realiza o repasse aos seus subcomercios finais. Hoje o modelo está estruturado para Visa, Mastercard e Elo. As transações de uma Carteira Digital Escalonada (SDWO) possuem basicamente dois modelos:

Cash-In: transação bandeirada não vinculada a uma compra:
Abastecimento de Fundos na Carteira utilizando Cartão. Ex.: recarga de saldo na carteira através de cartão
Transferência para saldo de outra pessoa utilizando cartão

Compra (também conhecida como back-to-back):
Pagamento de QR Code impresso / proprietário da carteira utilizando cartão. Ex.: QR Code da carteira digital impresso no balcão e pago através de cartão
Pagamento online através de área logada da carteira utilizando cartão

Para transações de Cash-in é necessário, além do preenchimento das tags do subgrupo de wallet, também o envio dos campos de dynamic_mcc e soft_descriptor presentes nos subgrupos de payment presente na aba "pagamentos" desta documentação. Para transações de Back-to-Back, além do preenchimento das tags do subgrupo de wallet, dynamic_mcc, com o número que melhor descreve a atividade do subcomercio que realizou a transação e soft_descriptor, também é necessário o preenchimento do subgrupo sub_merchant, informando os respectivos dados dos subcomercio que realizou a transação.

Para cada tipo de caso de uso faz-se necessário o preenchimento de alguns dados disponíveis na relação abaixo, nos quais é possível ser conferido suas respectivas regras e obrigatoriedades.

properties: type: type: string description: Tipo de Carteira (Wallet Type):

01: MasterPass Wallet
02: Visa Checkout
10: Generic Tokenized Wallet
55: Local Brazil Wallet (SDWO)

maxLength: 2 enum: - '01' - '02' - '10' - '55' example: '55' id: type: string description: Identificação da Carteira (Wallet Identification).

- MasterPass:
101 = Wallet Remote
102 = Wallet Remote NFC Payment
- Generic Tokenized Wallet
000 = Unspecified
101 = Wallet Remote
102 = Wallet Remote NFC Payment
103 = Apple Pay
216 = Android Pay
217 = Samsung Pay
327 = MDES for merchants (M4M)
example: '000' maxLength: 5 enum: - '000' - '101' - '102' - '103' - '216' - '217' - '327' merchant_id: type: string description: Número de identificação da Carteira Digital registrado juntos as bandeira.
Visa = MVV (Merchant Value Verification) com 6 posições
Mastercard = WID (Wallet ID) com 3 posições
Elo = WID (Wallet ID) com 11 posições
example: '327' maxLength: 12 fund_transfer: type: object description: Dados para transações do arranjo SDWO (Staged Digital Wallet Operator) properties: pay_action: type: string description: Tipo de Financimamento.

FT Funding Transfer – Que deve ser marcado em transações de Cash-in SDWO para todas as bandeiras.

FP Funding and Purchase – Que deve ser marcado em transações de Back-to-Back SDWO para todas as bandeiras.

BP Billpay – Marcação de pagamento de conta no programa Visa CBPS. enum: - FT - FP - BP example: FT maxLength: 2 receiver: type: object description: Dados Receiver Account properties: account_number: type: string description: Receiver Account Number que pode ser preenchido com um dos valores a seguir "#NA" ou "9999999999999995". Necessário o preenchimento apenas para a bandeira Mastercard, para transações de SDWO de Cash-in, para as demais bandeiras o preenchimento é opcional. example: '9999999999999995' maxLength: 20 account_type: type: string description: Account Type que deve ser preenchido com 00.

- 00 - Outros (Default, atualmente o único valor permitido)
- 01 — RTN + Conta Bancária
- 02 — IBAN
- 03 — Conta de Cartão (para getnet atualmente apenas o tipo disponível)
- 04 — E-mail
- 05 — Número de Telefone
- 06 — Número da conta bancária (BAN) + Código de
Identificação do Banco (BIC)
- 07 — ID da Carteira
- 08 — ID da Rede Social
Necessário o preenchimento apenas para a bandeira Mastercard para transações de SDWO de Cash-in, para as demais bandeiras o preenchimento é opcional enum: - '00' - '01' - '02' - '03' - '04' - '05' - '06' - '07' - '08' example: '00' maxLength: 2 first_name: type: string description: | Receiver First Name que deve ser preenchido com o primeiro nome do destinatário da transferência. Ex Jane. Necessário o preenchimento apenas para a bandeira Mastercard para transações de SDWO de Cash-in, para as demais bandeiras o preenchimento é opcional example: Jane maxLength: 35 middle_name: type: string description: 'Receiver Middle Name que deve ser preenchido com a abreviação do nome do meio do destinatário da transferência. Ex: T. O preenchimento é opcional para todas as bandeiras. minLength: 1 maxLength: 1' example: T last_name: type: string description: 'Receiver Last Name que deve ser preenchido com último nome (sobrenome) do destinatário da transferência. Ex: Smith. Necessário o preenchimento apenas para a bandeira Mastercard para transações de SDWO de Cash-in, para as demais bandeiras o preenchimento é opcional' example: Smith maxLength: 35 addr_street: type: string description: 'Receiver Addr Street que deve ser preenchido com o endereço do destinatário da transferência (rua e número). Ex: 1 Main ST. O preenchimento é opcional para todas as bandeiras.' example: 1 Main ST maxLength: 50 addr_city: type: string description: 'Receiver Addr City que deve ser preenchido com a cidade do destinatário da transferência. Ex: SAO PAULO. O preenchimento é opcional para todas as bandeiras.' example: SAO PAULO maxLength: 25 addr_state: type: string description: 'Receiver Addr State que deve ser preenchido com o estado do destinatário da transferência. Ex: SP. O preenchimento é opcional para todas as bandeiras.' example: SP maxLength: 3 addr_country: type: string description: Receiver Addr Country que deve ser preenchido com o país do destinatário da transferência. Seguindo o padrão ISO 3166-1 alfa 3. Necessário o preenchimento apenas para a bandeira Mastercard para transações de SDWO de Cash-in, para as demais bandeiras o preenchimento é opcional example: BRA maxLength: 3 addr_postal_code: type: string description: 'Receiver Addr Postal Code que deve ser preenchido com o código postal (CEP) do destinatário da transferência. Ex: 01408000. O preenchimento é opcional para todas as bandeiras.' example: '1408000' maxLength: 10 nationality: type: string description: Receiver Nationality que deve ser preenchido com a nacionalidade do destinatário da transferência. Seguindo o padrão ISO 3166-1 alfa 3, Ex: BRA. O preenchimento é opcional para todas as bandeiras. example: BRA maxLength: 3 phone: type: string description: 'Receiver Phone que deve ser preenchido com o número de telefone do destinatário da transferência, incluindo o código do país. Ex: 5511977778888. O preenchimento é opcional para todas as bandeiras.' example: '5511977778888' maxLength: 20 date_of_birth: type: string description: | Receiver Date Of Birth que deve ser preenchido com a data de nascimento do destinatário da transferência com o formato YYYYMMDD. Ex 19901230. O preenchimento é opcional para todas as bandeiras. example: '19901230' maxLength: 8 id_type: type: string description: Receiver Id Type que deve ser preenchido com o tipo do documento utilizado pelo destinatário da transferência (CPF ou CNPJ). Nesse caso preenchido com 03. Necessário o preenchimento para as bandeiras Mastercard, Visa e ELO para transações de SDWO de Cash-in, para as demais bandeiras o preenchimento é opcional.
- 00 = Passaporte
- 01 = Carteira de Identificação Nacional
- 02 = Carteira de Motorista
- 03 = Emitida pelo Governo
- 04 = Outros
enum: - '00' - '01' - '02' - '03' - '04' example: '03' maxLength: 2 id_num: type: string description: Receiver Id Number que deve ser preenchido com o número do CPF ou CNPJ do destinatário da transferência. Ex 12345678900000. Necessário o preenchimento para as bandeiras Mastercard, Visa e ELO para transações de SDWO de Cash-in, para as demais bandeiras o preenchimento é opcional. example: '12345678900000' maxLength: 25 sender: type: object description: Dados Sender Account properties: account_number: type: string description: 'Sender Account Number que pode ser preenchido com um dos valores a seguir "#NA" ou "9999999999999995". Necessário o preenchimento apenas para a bandeira Mastercard, para transações de SDWO de Cash-in, para as demais bandeiras o preenchimento é opcional.' example: '9999999999999995' maxLength: 20 account_type: type: string description: 'Account Type que deve ser preenchido com 00.

- 00 - Outros (Default, atualmente o único valor permitido)
- 01 — RTN + Conta Bancária
- 02 — IBAN
- 03 — Conta de Cartão (para getnet atualmente apenas o tipo disponível)
- 04 — E-mail
- 05 — Número de Telefone
- 06 — Número da conta bancária (BAN) + Código de
Identificação do Banco (BIC)
- 07 — ID da Carteira
- 08 — ID da Rede Social
Necessário o preenchimento apenas para a bandeira Mastercard para transações de SDWO de Cash-in, para as demais bandeiras o preenchimento é opcional' enum: - '00' - '01' - '02' - '03' - '04' - '05' - '06' - '07' - '08' example: '00' maxLength: 2 first_name: type: string description: | Sender First Name que deve ser preenchido com o primeiro nome do remetente da transferência. Ex Jane. Necessário o preenchimento apenas para a bandeira Mastercard para transações de SDWO de Cash-in, para as demais bandeiras o preenchimento é opcional example: Jane maxLength: 35 middle_name: type: string description: 'Sender Middle Name que deve ser preenchido com a abreviação do nome do meio do remetente da transferência. Ex: T. O preenchimento é opcional para todas as bandeiras. minLength: 1 maxLength: 1' example: T last_name: type: string description: 'Sender Last Name que deve ser preenchido com último nome (sobrenome) do remetente da transferência. Ex: Smith. Necessário o preenchimento apenas para a bandeira Mastercard para transações de SDWO de Cash-in, para as demais bandeiras o preenchimento é opcional' example: Smith maxLength: 35 addr_street: type: string description: 'Sender Addr Street que deve ser preenchido com o endereço do remetente da transferência (rua e número). Ex: 1 Main ST. O preenchimento é opcional para todas as bandeiras.' example: 1 Main ST maxLength: 50 addr_city: type: string description: 'Sender Addr City que deve ser preenchido com a cidade do remetente da transferência. Ex: SAO PAULO. O preenchimento é opcional para todas as bandeiras.' example: SAO PAULO maxLength: 25 addr_state: type: string description: 'Sender Addr State que deve ser preenchido com o estado do remetente da transferência. Ex: SP. O preenchimento é opcional para todas as bandeiras.' example: SP maxLength: 3 addr_country: type: string description: 'Sender Addr Country que deve ser preenchido com o país do remetente da transferência. Seguindo o padrão ISO 3166-1 alfa 3. Necessário o preenchimento apenas para a bandeira Mastercard para transações de SDWO de Cash-in, para as demais bandeiras o preenchimento é opcional' example: BRA maxLength: 3 addr_postal_code: type: string description: 'Sender Addr Postal Code que deve ser preenchido com o código postal (CEP) do remetente da transferência. Ex: 01408000. O preenchimento é opcional para todas as bandeiras.' example: '1408000' maxLength: 10 nationality: type: string description: 'Sender Nationality que deve ser preenchido com a nacionalidade do remetente da transferência. Seguindo o padrão ISO 3166-1 alfa 3, Ex: BRA. O preenchimento é opcional para todas as bandeiras.' example: BRA maxLength: 3 phone: type: string description: 'Sender Phone que deve ser preenchido com o número de telefone do remetente da transferência, incluindo o código do país. Ex: 5511977778888. O preenchimento é opcional para todas as bandeiras.' example: '5511977778888' maxLength: 20 date_of_birth: type: string description: | Sender Date Of Birth que deve ser preenchido com a data de nascimento do remetente da transferência com o formato YYYYMMDD. Ex 19901230. O preenchimento é opcional para todas as bandeiras. example: '19901230' maxLength: 8 id_type: type: string description: 'Sender Id Type que deve ser preenchido com o tipo do documento utilizado pelo remetente da transferência (CPF ou CNPJ). Nesse caso preenchido com 03. Necessário o preenchimento para as bandeiras Mastercard, Visa e ELO para transações de SDWO de Cash-in, para as demais bandeiras o preenchimento é opcional.
- 00 = Passaporte
- 01 = Carteira de Identificação Nacional
- 02 = Carteira de Motorista
- 03 = Emitida pelo Governo
- 04 = Outros
' enum: - '00' - '01' - '02' - '03' - '04' example: '03' maxLength: 2 id_num: type: string description: 'Sender Id Number que deve ser preenchido com o número do CPF ou CNPJ do remetente da transferência. Ex 12345678900000. Necessário o preenchimento para as bandeiras Mastercard, Visa e ELO para transações de SDWO de Cash-in, para as demais bandeiras o preenchimento é opcional.' example: '12345678900000' maxLength: 25 debit: type: object description: Conjunto de dados referentes a transação de débito. required: - authenticated properties: cardholder_mobile: type: string description: Telefone do portador do cartão. Obrigatório para Visa. example: '5551999887766' soft_descriptor: $ref: '#/definitions/soft_descriptor_global_sub_merchant' dynamic_mcc: $ref: '#/definitions/dynamic_mcc_sub_merchant' authenticated: type: boolean enum: - false description: Indicativo se transação deve ter o processo de autenticação no emissor. example: false default: false card: $ref: '#/definitions/card_debit' tokenization: $ref: '#/definitions/tokenization' credentials_on_file_type: type: string description: |

Tipo do COF (Credential On File).

ONE_CLICK: Usado quando é realizado a primeira transação (parcela) de um pagamento normal.
ONE_CLICK_PAYMENT: Usado quando é realizado transações para as demais parcelas restantes de um pagamento normal. Obs: Necessário informar o transaction_id da primeira transação realizada.
RECURRING: Usado quando é realizado a primeira transação (parcela) de um pagamento recorrente.
RECURRING_PAYMENT: Usado quando é realizado transações para as demais parcelas restantes de um pagamento recorrente. Obs: Necessário informar o transaction_id da primeira transação realizada.

enum: - ONE_CLICK - ONE_CLICK_PAYMENT - RECURRING - RECURRING_PAYMENT example: ONE_CLICK_PAYMENT transaction_id: type: string description: Código de uma transação feita no passado com o mesmo cartão e que foi efetivada com sucesso, que será usada pelo COF (Credential On File). example: '1002217281190421' gateway_id: type: string description: ID do Merchant Payment Gateway (MPG). minLength: 11 maxLength: 11 example: '00000999998' vault_card: type: object description: Conjunto de dados do cartão. required: - number_token - expiration_month - expiration_year - customer_id properties: number_token: type: string description: Número do cartão tokenizado. Gerado por meio do endpoint /v1/tokens/card. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 brand: type: string description: Bandeira do cartão. Preenchido automaticamente pela API caso não seja informado. maxLength: 50 enum: - Mastercard - Visa - Amex - Elo - Hipercard example: Mastercard cardholder_name: type: string description: 'Nome do comprador impresso no cartão. ' maxLength: 26 example: JOAO DA SILVA expiration_month: type: string description: Mês de expiração do cartão com dois dígitos. minLength: 2 maxLength: 2 example: '12' expiration_year: type: string description: Ano de expiração do cartão com dois dígitos. minLength: 2 maxLength: 2 example: '28' customer_id: type: string description: | Identificador do comprador. Informação definida pela aplicação que consome a api da Plataforma Digital. É permitido neste campo somente dados alfanuméricos. Os seguintes caracteres especiais não devem ser utilizados: % $ , . / & ( ) + = = < > - * example: customer_21081826 maxLength: 100 cardholder_identification: type: string description: Identificação do comprador, como CPF ou RG. (sem máscara) example: '12345678912' verify_card: type: boolean description: Realiza uma transação que Verifica se o cartão informado, não está cancelado, bloqueado ou com restrições. default: false example: false security_code: type: string description: Código de segurança. CVV ou CVC. minLength: 3 maxLength: 4 example: '123' vault_card_response: type: object description: Conjunto de dados do cartão salvo. properties: card_id: type: string description: Identificador do cartão salvo no cofre. format: uuidv4 example: e8ad2ae4-9e3e-4532-998f-1a5a11e56e58 minLength: 36 maxLength: 36 last_four_digits: type: string description: Últimos quatro dígitos do cartão. example: '1212' minLength: 4 maxLength: 4 bin: type: string description: Seis primeiros dígitos do cartão. example: '121212' minLength: 6 maxLength: 6 expiration_month: type: string description: 'Mês de expiração do cartão com dois dígitos. ' example: '12' minLength: 2 maxLength: 2 expiration_year: type: string description: Ano de expiração do cartão com dois dígitos. example: '28' minLength: 2 maxLength: 2 brand: type: string description: Bandeira. (Utilizado também no antifraude). example: Mastercard enum: - Mastercard - Visa - Amex - Elo - Hipercard maxLength: 50 cardholder_name: type: string description: Nome do comprador impresso no cartão. example: JOAO DA SILVA maxLength: 26 customer_id: type: string description: | Identificador do comprador. Pode ser qualquer informação que identifique o seu consumidor, como documento de identificação, email ou até mesmo um id interno do seu sistema. example: customer_21081826 maxLength: 100 number_token: type: string description: Número do cartão tokenizado. Gerado por meio do endpoint /v1/tokens/card. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 used_at: type: string description: Data da última utilização. example: '2017-04-19T16:30:30Z' format: YYYY-MM-DDTHH:MM:SSZ minLength: 24 maxLength: 24 created_at: type: string description: Data de criação. example: '2017-04-19T16:30:30Z' format: YYYY-MM-DDTHH:MM:SSZ minLength: 24 maxLength: 24 updated_at: type: string description: Data de atualização. example: '2017-04-19T16:30:30Z' format: YYYY-MM-DDTHH:MM:SSZ minLength: 24 maxLength: 24 status: type: string description: Status do cartão no cofre. enum: - active - blocked - canceled - renewed example: active maxLength: 20 transaction_id: type: string description: Código de uma transação do cartão. example: '1002217281190421' verification_card_body: type: object description: Conjunto de dados do cartão a ser verificado. required: - number_token - expiration_month - expiration_year properties: number_token: type: string description: Número do cartão tokenizado. Gerado previamente por meio do endpoint /v1/tokens/card. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 brand: type: string description: Bandeira do cartão. Preenchido automaticamente pela API caso não seja informado. maxLength: 50 example: Mastercard enum: - Mastercard - Visa - Amex - Elo - Hipercard cardholder_name: type: string description: Nome do comprador impresso no cartão. maxLength: 26 example: JOAO DA SILVA expiration_month: type: string description: Mês de expiração do cartão com dois dígitos. minLength: 2 maxLength: 2 example: '12' expiration_year: type: string description: Ano de expiração do cartão com dois dígitos. minLength: 2 maxLength: 2 example: '28' security_code: type: string description: Código de segurança. CVV ou CVC. minLength: 3 maxLength: 4 example: '123' gateway_id: type: string description: | Merchant Payment Gateway ID. example: '00000999998' card_debit: type: object description: Conjunto de dados do cartão. required: - number_token - expiration_month - expiration_year - security_code properties: number_token: type: string description: Número do cartão tokenizado. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 cardholder_name: type: string description: Nome do comprador impresso no cartão.
Campo obrigatório para o Antifraude maxLength: 26 example: JOAO DA SILVA security_code: type: string description: Código de segurança. CVV ou CVC.
Campo obrigatório para o Antifraude minLength: 3 maxLength: 4 example: '123' brand: type: string description: Bandeira do cartão. Preenchido automaticamente pela API caso não seja informado.
Campo obrigatório para o Antifraude maxLength: 50 example: Mastercard enum: - Mastercard - Visa - Amex - Elo - Hipercard expiration_month: type: string description: Mês de expiração do cartão com dois dígitos. minLength: 2 maxLength: 2 example: '12' expiration_year: type: string description: Ano de expiração do cartão com dois dígitos. minLength: 2 maxLength: 2 example: '28' card_credit: type: object description: Conjunto de dados do cartão. required: - number_token - expiration_month - expiration_year properties: number_token: type: string description: Número do cartão tokenizado. Esse campo pode receber dois tipos de conteúdo 1 - Esse campo pode receber uma token gerado pelo serviço de [Tokenização da Getnet] (https://developers.getnet.com.br/api#tag/Tokenizacao%2Fpaths%2F~1v1~1tokens~1card%2Fpost) 2 - Esse campo também pode receber um token de cartão gerado através de um TSP (Token Service Provider). example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 cardholder_name: type: string description: Nome do comprador impresso no cartão.
Campo obrigatório para o Antifraude e se o number_token for gerado através de um TSP (Token Service Provider) maxLength: 26 example: JOAO DA SILVA security_code: type: string description: Código de segurança. CVV ou CVC.
Campo obrigatório para o Antifraude minLength: 3 maxLength: 4 example: '123' brand: type: string description: Bandeira do cartão. Preenchido automaticamente pela API caso não seja informado.
Campo obrigatório para o Antifraude maxLength: 50 example: Mastercard enum: - Mastercard - Visa - Amex - Elo - Hipercard expiration_month: type: string description: Mês de expiração do cartão com dois dígitos. minLength: 2 maxLength: 2 example: '12' expiration_year: type: string description: Ano de expiração do cartão com dois dígitos. minLength: 2 maxLength: 2 example: '28' subscription_card: type: object description: Conjunto de dados do cartão. properties: number_token: type: string description: Número do cartão tokenizado. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 cardholder_name: type: string description: Nome do comprador impresso no cartão. Obrigatório caso os dados de cartão não foram armazenados permanentemente com o token. maxLength: 26 example: JOAO DA SILVA security_code: type: string description: Código de segurança. CVV ou CVC. minLength: 3 maxLength: 4 example: '123' brand: type: string description: Bandeira. (Utilizado também no antifraude). Obrigatório caso os dados de cartão não foram armazenados permanentemente com o token. maxLength: 50 example: Mastercard enum: - Mastercard - Visa - Amex - Elo - Hipercard expiration_month: type: string description: Mês de expiração do cartão com dois dígitos. Obrigatório caso os dados de cartão não foram armazenados permanentemente com o token. minLength: 2 maxLength: 2 example: '12' expiration_year: type: string description: Ano de expiração do cartão com dois dígitos. Obrigatório caso os dados de cartão não foram armazenados permanentemente com o token. minLength: 2 maxLength: 2 example: '28' bin: type: string description: Seis primeiros números do cartão. minLength: 6 maxLength: 9 example: '123412' payment_credit_response: type: object description: Conjunto de dados da resposta do pagamento de crédito. properties: payment_id: type: string description: Código de identificação do pagamento. format: uuidv4 example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 seller_id: type: string description: Código de identificação do e-commerce. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 amount: type: integer description: Valor da compra em centavos. example: 100 currency: type: string description: Identificação da moeda (Consultar código em "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 order_id: type: string description: Código de identificação da compra utilizado pelo e-commerce example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 maxLength: 36 status: type: string description: Status da transação. Para mais informações sobre os status de retorno, veja em Notificações 1.0 ou Notificações 1.1 example: APPROVED enum: - CANCELED - APPROVED - DENIED - AUTHORIZED - CONFIRMED maxLength: 20 received_at: type: string description: Data e hora do registro de pagamento. format: YYYY-MM-DDTHH:mm:ss.SSSZ example: '2017-03-19T16:30:30.764Z' maxLength: 24 credit: $ref: '#/definitions/payment_credit_detail' payment_credit_pre_response: type: object description: Conjunto de dados da resposta do pagamento de crédito. properties: payment_id: type: string description: Código de identificação do pagamento. format: uuidv4 example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 seller_id: type: string description: Código de identificação do e-commerce. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 amount: type: integer description: Valor da compra em centavos. example: 100 currency: type: string description: Identificação da moeda (Consultar código em "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 order_id: type: string description: Código de identificação da compra utilizado pelo e-commerce example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 maxLength: 36 status: type: string description: Status da transação. Para mais informações sobre os status de retorno, veja em Notificações 1.0 ou Notificações 1.1 example: AUTHORIZED enum: - CANCELED - APPROVED - DENIED - AUTHORIZED - CONFIRMED maxLength: 20 received_at: type: string description: Data e hora do registro de pagamento. format: YYYY-MM-DDTHH:mm:ss.SSSZ example: '2017-03-19T16:30:30.764Z' maxLength: 24 credit: $ref: '#/definitions/payment_credit_detail' payment_credit_detail: type: object description: Conjunto de dados referentes a transação. properties: delayed: type: boolean description: Identifica se o crédito será feito com confirmação tardia. example: false authorization_code: type: string description: Código interno da transação. example: '504115596011102460' maxLength: 20 authorized_at: type: number description: Data/hora da autorização de crédito. format: YYYY-MM-DDTHH:MM:SSZ example: '2017-03-19T16:30:30Z' maxLength: 24 reason_code: type: string description: Código de retorno. example: '00' minLength: 1 maxLength: 5 reason_message: type: string description: Mensagem de retorno. example: transaction approved maxLength: 250 acquirer: type: string description: Nome do adquirente. example: GETNET maxLength: 30 soft_descriptor: type: string description: Descrição para a fatura do cartão. example: Descrição para fatura maxLength: 22 brand: type: string description: Bandeira resposável pelo o processamento da transação. example: Mastercard maxLength: 50 enum: - Mastercard - Visa - Amex - Elo - Hipercard terminal_nsu: type: string description: Código de Autorização gerado pelo Emissor quando a transação é realizada com sucesso. example: '006090' acquirer_transaction_id: type: string description: Código de transação do adquirente. example: '10000024' maxLength: 20 transaction_id: type: string description: Código de transação. example: '1002217281190421' first_installment_amount: type: string description: Valor da primeira parcela. example: '123' other_installment_amount: type: string description: Outro valor da parcela. example: '123' total_installment_amount: type: string description: Valor total da parcela. example: '123' credit_delayed_confirm: type: object description: Conjunto de dados da resposta da confirmação de pagamento de crédito tardio. properties: payment_id: type: string description: Código de identificação do pagamento. minLength: 36 maxLength: 36 format: uuidv4 example: 331b0b07-6e37-4bd9-a37b-99156cb34104 seller_id: type: string description: Código de identificação do e-commerce. minLength: 36 maxLength: 36 format: uuidv4 example: 8f840ea0-b7d1-42f5-ad78-5a5521e3125f amount: type: integer description: Valor da compra em centavos. example: 200000 currency: type: string description: Identificação da moeda (Consultar código em "https://www.currency-iso.org/en/home/tables/table-a1.html"). minLength: 3 maxLength: 3 example: BRL order_id: type: string description: Código de identificação da compra utilizado pelo e-commerce example: order-3 maxLength: 36 status: type: string description: Status da transação. Para mais informações sobre os status de retorno, veja em Notificações 1.0 ou Notificações 1.1 example: CONFIRMED enum: - CONFIRMED - ERROR maxLength: 20 credit_confirm: $ref: '#/definitions/payment_credit_confirm_details' payment_credit_confirm_details: type: object description: Conjunto de informações adicionais do serviço de confirmação. properties: confirm_date: type: string description: Data/hora do recebimento da transação. format: YYYY-MM-DDTHH:mm:ss.SSSZ example: '2018-07-18T20:00:53.764Z' maxLength: 24 message: type: string description: Aviso de recebimento e finalização pendente a comfirmação. maxLength: 250 example: Postponed 331b0b07-6e37-4bd9-a37b-99156cb34104 confirmed credit_delayed_cancel: type: object description: Conjunto de dados da resposta do cancelamento de pagamento de crédito completo ou com confirmação tardia. properties: payment_id: type: string description: Código de identificação do pagamento. minLength: 36 maxLength: 36 format: uuidv4 example: f3b54da1-0753-4dcf-ac92-48721d2ff553 seller_id: type: string description: Código de identificação do e-commerce. minLength: 36 maxLength: 36 format: uuidv4 example: 8f840ea0-b7d1-42f5-ad78-5a5521e3125f amount: type: integer description: Valor da compra em centavos. example: 500000 currency: type: string description: Identificação da moeda (Consultar código em "https://www.currency-iso.org/en/home/tables/table-a1.html"). minLength: 3 maxLength: 3 example: BRL order_id: type: string description: Código de identificação da compra utilizado pelo e-commerce example: pre-auth-order-204 maxLength: 36 status: type: string description: Status da transação. Para mais informações sobre os status de retorno, veja em Notificações 1.0 ou Notificações 1.1 example: CANCELED enum: - CANCELED - ERROR - DENIED maxLength: 20 credit_cancel: $ref: '#/definitions/payment_credit_cancel_details' debit_cancel: type: object description: Conjunto de dados da resposta do cancelamento de pagamento de débito completo. properties: payment_id: type: string description: Código de identificação do pagamento. minLength: 36 maxLength: 36 format: uuidv4 example: f3b54da1-0753-4dcf-ac92-48721d2ff553 seller_id: type: string description: Código de identificação do e-commerce. minLength: 36 maxLength: 36 format: uuidv4 example: 8f840ea0-b7d1-42f5-ad78-5a5521e3125f amount: type: integer description: Valor da compra em centavos. example: 500000 currency: type: string description: Identificação da moeda (Consultar código em "https://www.currency-iso.org/en/home/tables/table-a1.html"). minLength: 3 maxLength: 3 example: BRL order_id: type: string description: Código de identificação da compra utilizado pelo e-commerce example: order-204 maxLength: 36 status: type: string description: Status da transação. Para mais informações sobre os status de retorno, veja em Notificações 1.0 ou Notificações 1.1 example: CANCELED enum: - CANCELED - ERROR - DENIED maxLength: 20 debit_cancel: $ref: '#/definitions/payment_debit_cancel_details' payment_debit_cancel_details: type: object description: Conjunto de informações adicionais do serviço de cancelamento. properties: canceled_at: type: string description: Data/hora do recebimento da transação. format: YYYY-MM-DDTHH:mm:ss.SSSZ example: '2018-07-22T18:47:32.270Z' maxLength: 24 message: type: string description: Aviso de recebimento e finalização pendente a comfirmação. example: Debit transaction cancelled successfully maxLength: 250 payment_credit_cancel_details: type: object description: Conjunto de informações adicionais do serviço de cancelamento. properties: canceled_at: type: string description: Data/hora do recebimento da transação. format: YYYY-MM-DDTHH:mm:ss.SSSZ example: '2018-07-22T18:47:32.270Z' maxLength: 24 message: type: string description: Aviso de recebimento e finalização pendente a comfirmação. example: Credit transaction cancelled successfully maxLength: 250 payment_debit_response: type: object description: Conjunto de dados da resposta do pagamento de débito. properties: payment_id: type: string description: Código de identificação do pagamento. format: uuidv4 example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 seller_id: type: string description: Código de identificação do e-commerce. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 amount: type: integer description: Valor da compra em centavos. example: 100 currency: type: string description: Identificação da moeda (Consultar código em "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 order_id: type: string description: Código de identificação da compra utilizado pelo e-commerce example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 maxLength: 36 status: type: string description: Status da transação. Para mais informações sobre os status de retorno, veja em Notificações 1.0 ou Notificações 1.1 example: APPROVED enum: - CANCELED - APPROVED - DENIED - AUTHORIZED - CONFIRMED maxLength: 20 received_at: type: string description: Data e hora do registro de pagamento. format: YYYY-MM-DDTHH:mm:ss.SSSZ example: '2017-03-19T16:30:30.764Z' maxLength: 24 debit: $ref: '#/definitions/payment_debit_detail' payment_debit_detail: type: object description: Conjunto de dados referentes a transação. properties: authorization_code: type: string description: Código interno da transação. example: '504115596011102460' maxLength: 20 authorized_timestamp: type: number description: Data/hora da autorização de crédito. format: YYYY-MM-DDTHH:MM:SSZ example: '2017-03-19T16:30:30Z' maxLength: 24 reason_code: type: string description: Código de retorno. example: '00' minLength: 1 maxLength: 5 reason_message: type: string description: Mensagem de retorno. example: transaction approved maxLength: 250 acquirer: type: string description: Nome do adquirente. example: GETNET maxLength: 30 soft_descriptor: type: string description: Descrição para a fatura do cartão. example: Descrição para fatura maxLength: 22 brand: type: string description: Bandeira responsável pelo o processamento da transação. example: Maestro maxLength: 50 enum: - Maestro - Visa-Electron - Elo-Debit terminal_nsu: type: string description: Código de Autorização gerado pelo Emissor quando a transação é realizada com sucesso. example: '006090' acquirer_transaction_id: type: string description: Código de transação do adquirente. example: '10000024' maxLength: 20 transaction_id: type: string description: Código de transação. example: '1002217281190421' boleto: type: object properties: document_number: type: string description: Seu Número. Número controlado pelo cliente, geralmente é gerenciado pelo sistema que está gerando o boleto. (sem máscara) minLength: 15 maxLength: 15 example: '170500000019763' expiration_date: type: string description: Data do vencimento do boleto. Caso não seja informado, será considerado o número de dias padrão pré-cadastrado para o vencimento. format: dd/mm/yyyy example: 16/11/2017 instructions: type: string description: Instruções a serem impressas no boleto. A quebra da linha pode ser realizada de duas formas. 1) Quebra de linha automática: será feita uma quebra de linha em até 100 caracteres sem que as palavras sejam truncadas; 2) Quebra de linha manual: quebra de linha utilizando o carácter de escape "\n". Exemplo: "Este é um teste de quebra de linha.\nA segunda linha será impressa agora.\nE por fim, a terceira linha."; maxLength: 1000 example: Não receber após o vencimento provider: type: string description: Banco provedor. enum: - santander maxLength: 40 default: santander example: santander payment_boleto_response: type: object description: Conjunto de dados da responda da emissão do boleto. properties: payment_id: type: string description: Código de identificação do pagamento. example: bb0ec674-01e6-451e-9b98-da6259d2ea52 minLength: 36 maxLength: 36 seller_id: type: string description: Código de identificação do e-commerce. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 amount: type: string description: Valor da compra em centavos . example: '100' currency: type: string description: Identificação da moeda (Consultar código em "https://www.currency-iso.org/en/home/tables/table-a1.html"). minLength: 3 maxLength: 3 example: BRL order_id: type: string description: Código de identificação da compra utilizado pelo e-commerce example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 maxLength: 36 status: type: string description: Status da transação. Para mais informações sobre os status de retorno, veja em Notificações 1.0 ou Notificações 1.1 example: PENDING enum: - PENDING maxLength: 20 boleto: $ref: '#/definitions/payment_boleto_detail' payment_boleto_response_v2: type: object description: Conjunto de dados da resposta da emissão do boleto. properties: payment_id: type: string description: Código de identificação do pagamento. example: bb0ec674-01e6-451e-9b98-da6259d2ea52 minLength: 36 maxLength: 36 status: type: string description: Status da transação. Para mais informações sobre os status de retorno, veja em Notificações 1.0 ou Notificações 1.1 example: EM ABERTO enum: - EM ABERTO maxLength: 20 seller_id: description: Código de identificação do e-commerce. type: string format: uuidv4 minLength: 24 maxLength: 24 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 amount: type: string description: Valor da compra em centavos. example: '100' currency: type: string description: Identificação da moeda (Consultar código em "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 order_id: description: Código de identificação da compra utilizado pelo e-commerce. type: string maxLength: 36 example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 boleto: $ref: '#/definitions/payment_boleto_detail_pix' payment_boleto_detail: type: object description: Corpo com os dados do boleto. properties: boleto_id: type: string description: Identificação do boleto. format: uuidv4 example: e587cefe-8832-4fc0-acff-acc83dd66e9e minLength: 36 maxLength: 36 bank: type: string description: Número do banco EC. (sem máscara) example: '0033' minLength: 3 maxLength: 4 status_code: type: string description: Código do status do pagamento. example: '1' minLength: 1 maxLength: 1 status_label: type: string description: Status do pagamento em texto example: EM ABERTO maxLength: 20 typeful_line: type: string description: Linha digitável do boleto. example: '03399.58910 93000.000013 94659.801016 8 71670000030015' minLength: 54 maxLength: 54 bar_code: type: string description: Código de barras do boleto. (sem máscara) example: '03397999200000002309235515900000026629840101' minLength: 44 maxLength: 44 issue_date: type: string description: Data de geração do boleto. example: '17/05/2017' minLength: 10 maxLength: 10 expiration_date: type: string description: Data de vencimento do boleto. example: '22/05/2017' minLength: 10 maxLength: 10 our_number: type: string description: Nosso número. (sem máscara) example: '0000001946598' minLength: 12 maxLength: 13 document_number: type: string description: Número do documento controlado pelo cliente. (sem máscara) example: '170500000019763' minLength: 15 maxLength: 15 _links: type: array items: type: object example: - href: /v1/payments/boleto/593948e8589f66000ed575e0/pdf?ack=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2N2UxZWJhNWE0YmFlNmE1MDExZmMzMGIiLCJpYXQiOjE3NDI4NTkxNzMsImF1ZGllbmNlIjoiWW05c1pYUnZMV1J2ZDI1c2IyRmtMWE5sY25acFkyVT0iLCJleHAiOjE3NDg3MzYwMDB9.HXX3kOf95MiXUG9fJUE4d8QsDlr3acTGsCpfvd2RFX6HYPHiywnlFq-mXCKCYPkdY3mUJVwW7ct7WXStKkDZG2ZqfC7d9CnMQs5b5Tjw4sg2vbeZrMkbd69ih6pt6f0hpmecPA_Jbonl995suzW67zQNy-oJ-4ULDlNLuu4FdmRRX31uLho3Gtu3PoQhC3p876m5oFJ1MTxdZwcIqiGQIXWv96elhx-LpIfT4yzisSkZGgRe-EVdh-q31hRrAH3HqsS6_BdXX0XSoFBhEbCtkjOlST0Rknm_kMyk1QCvrh5vCh9EAJQ5DTeglcyE8NgDG5CLzRcJcM6B1KpKOH0oHw rel: boleto_pdf type: GET - href: /v1/payments/boleto/593948e8589f66000ed575e0/html?ack=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2N2UxZWJhNWE0YmFlNmE1MDExZmMzMGIiLCJpYXQiOjE3NDI4NTkxNzMsImF1ZGllbmNlIjoiWW05c1pYUnZMV1J2ZDI1c2IyRmtMWE5sY25acFkyVT0iLCJleHAiOjE3NDg3MzYwMDB9.HXX3kOf95MiXUG9fJUE4d8QsDlr3acTGsCpfvd2RFX6HYPHiywnlFq-mXCKCYPkdY3mUJVwW7ct7WXStKkDZG2ZqfC7d9CnMQs5b5Tjw4sg2vbeZrMkbd69ih6pt6f0hpmecPA_Jbonl995suzW67zQNy-oJ-4ULDlNLuu4FdmRRX31uLho3Gtu3PoQhC3p876m5oFJ1MTxdZwcIqiGQIXWv96elhx-LpIfT4yzisSkZGgRe-EVdh-q31hRrAH3HqsS6_BdXX0XSoFBhEbCtkjOlST0Rknm_kMyk1QCvrh5vCh9EAJQ5DTeglcyE8NgDG5CLzRcJcM6B1KpKOH0oHw rel: boleto_html type: GET payment_boleto_detail_pix: type: object description: Corpo com os dados do boleto. properties: boleto_id: type: string description: Identificação do boleto. format: uuidv4 example: e587cefe-8832-4fc0-acff-acc83dd66e9e minLength: 36 maxLength: 36 bank: type: string description: Número do banco EC. (sem máscara) example: '0033' minLength: 3 maxLength: 4 status_code: type: string description: Código do status do pagamento. example: '1' minLength: 1 maxLength: 1 status_label: type: string description: Status do pagamento em texto example: EM ABERTO maxLength: 20 typeful_line: type: string description: Linha digitável do boleto. example: '03399.58910 93000.000013 94659.801016 8 71670000030015' minLength: 54 maxLength: 54 bar_code: type: string description: Código de barras do boleto. (sem máscara) example: '03397999200000002309235515900000026629840101' minLength: 44 maxLength: 44 issue_date: type: string description: Data de geração do boleto. example: '17/05/2017' minLength: 10 maxLength: 10 expiration_date: type: string description: Data de vencimento do boleto. example: '22/05/2017' minLength: 10 maxLength: 10 our_number: type: string description: Nosso número. (sem máscara) example: '0000001946598' minLength: 12 maxLength: 13 document_number: type: string description: Número do documento controlado pelo cliente. (sem máscara) example: '170500000019763' minLength: 15 maxLength: 15 pix: type: object description: Dados de pagamento via Pix. properties: cod_qrcode: type: string format: Base64 description: Código Base64 para geração da imagem do QRCode. example: '00020101021226900014br.gov.bcb.pix2568pix.santander.com.br/qr/v2/cobv/5d877814-6974-42b9-aed8-4bab01ddb1eb52040000530398654042.305802BR5925ESTABELECIMENTO E SERVICO6009SAO PAULO12345678***63047FF0' cod_url_qrcode: type: string format: url description: URL de visualização do QRCode. example: 'pix.santander.com.br/qr/v2/cobv/a796c937-80ee-483c-a8d5-72f95759fd99' _links: type: array items: type: object example: - href: /v1/payments/boleto/593948e8589f66000ed575e0/pdf?ack=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2N2UxZWJhNWE0YmFlNmE1MDExZmMzMGIiLCJpYXQiOjE3NDI4NTkxNzMsImF1ZGllbmNlIjoiWW05c1pYUnZMV1J2ZDI1c2IyRmtMWE5sY25acFkyVT0iLCJleHAiOjE3NDg3MzYwMDB9.HXX3kOf95MiXUG9fJUE4d8QsDlr3acTGsCpfvd2RFX6HYPHiywnlFq-mXCKCYPkdY3mUJVwW7ct7WXStKkDZG2ZqfC7d9CnMQs5b5Tjw4sg2vbeZrMkbd69ih6pt6f0hpmecPA_Jbonl995suzW67zQNy-oJ-4ULDlNLuu4FdmRRX31uLho3Gtu3PoQhC3p876m5oFJ1MTxdZwcIqiGQIXWv96elhx-LpIfT4yzisSkZGgRe-EVdh-q31hRrAH3HqsS6_BdXX0XSoFBhEbCtkjOlST0Rknm_kMyk1QCvrh5vCh9EAJQ5DTeglcyE8NgDG5CLzRcJcM6B1KpKOH0oHw rel: boleto_pdf type: GET - href: /v1/payments/boleto/593948e8589f66000ed575e0/html?ack=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2N2UxZWJhNWE0YmFlNmE1MDExZmMzMGIiLCJpYXQiOjE3NDI4NTkxNzMsImF1ZGllbmNlIjoiWW05c1pYUnZMV1J2ZDI1c2IyRmtMWE5sY25acFkyVT0iLCJleHAiOjE3NDg3MzYwMDB9.HXX3kOf95MiXUG9fJUE4d8QsDlr3acTGsCpfvd2RFX6HYPHiywnlFq-mXCKCYPkdY3mUJVwW7ct7WXStKkDZG2ZqfC7d9CnMQs5b5Tjw4sg2vbeZrMkbd69ih6pt6f0hpmecPA_Jbonl995suzW67zQNy-oJ-4ULDlNLuu4FdmRRX31uLho3Gtu3PoQhC3p876m5oFJ1MTxdZwcIqiGQIXWv96elhx-LpIfT4yzisSkZGgRe-EVdh-q31hRrAH3HqsS6_BdXX0XSoFBhEbCtkjOlST0Rknm_kMyk1QCvrh5vCh9EAJQ5DTeglcyE8NgDG5CLzRcJcM6B1KpKOH0oHw rel: boleto_html type: GET customer_info: type: object description: Conjunto de dados do comprador. required: - seller_id - first_name - last_name - document_type - document_number properties: seller_id: description: Código de identificação do e-commerce. type: string format: uuidv4 minLength: 36 maxLength: 36 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 customer_id: description: Identificador do comprador. Caso não seja informado, o sistema irá gerar um identificador no formato uuidv4 de 36 posições. type: string example: customer_21081826 maxLength: 100 first_name: description: Primeiro nome do comprador. type: string maxLength: 40 example: João last_name: description: Último nome do comprador. type: string maxLength: 80 example: da Silva document_type: description: Tipo de documento do comprador. type: string enum: - CPF - CNPJ example: CPF document_number: description: Número do documento do comprador. (sem máscara) type: string minLength: 11 maxLength: 15 example: '12345678912' birth_date: description: Data de nascimento do comprador. type: string format: YYYY-MM-DD example: '1976-02-21' minLength: 10 maxLength: 10 phone_number: description: Número do telefone do comprador. (sem máscara) type: string maxLength: 15 example: '5551999887766' celphone_number: description: Número do telefone celular do comprador. (sem máscara) type: string example: '5551999887766' maxLength: 15 email: description: Email do comprador. type: string format: email example: customer@email.com.br observation: description: Observações. type: string example: O cliente tem interesse no plano x. address: $ref: '#/definitions/address' customer_info_response: description: Conjunto de dados do comprador. properties: seller_id: description: Código de identificação do e-commerce. type: string format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 customer_id: description: Identificador do comprador. type: string example: customer_21081826 maxLength: 100 first_name: description: Primeiro nome do comprador. type: string example: João maxLength: 40 last_name: description: Último nome do comprador. type: string example: da Silva maxLength: 80 document_type: description: Tipo de documento do comprador. type: string enum: - CPF - CNPJ example: CPF document_number: description: Número do documento do comprador. (sem máscara) type: string minLength: 11 maxLength: 15 example: '12345678912' birth_date: description: Data de nascimento do comprador. type: string format: YYYY-MM-DD example: '1976-02-21' minLength: 10 maxLength: 10 phone_number: description: Número do telefone do comprador. (sem máscara) type: string maxLength: 15 example: '5551999887766' celphone_number: description: Número do telefone celular do comprador. (sem máscara) type: string example: '5551999887766' maxLength: 15 email: description: Email do comprador. type: string format: email example: customer@email.com.br observation: description: Observações. type: string example: O cliente tem interesse no plano x. status: description: Status do cadastro do comprador. type: string example: success maxLength: 20 address: $ref: '#/definitions/address' customer_filter_response: type: object required: - page - limit - total properties: customers: description: Lista de clientes type: array items: $ref: '#/definitions/customer_filter_info_response' page: description: Página corrente. type: number example: 1 limit: description: Número de registros por página. type: number example: 10 total: description: Total de clientes cadastrados. type: number example: 1 customer_filter_info_response: type: object properties: customer_id: description: Identificador do comprador. type: string example: customer_21081826 maxLength: 100 first_name: description: Primeiro nome do comprador. type: string example: João maxLength: 40 last_name: description: Último nome do comprador. type: string example: da Silva maxLength: 80 document_type: description: Tipo de documento do comprador. type: string enum: - CPF - CNPJ example: CPF document_number: description: Número do documento do comprador. (sem máscara) type: string example: '12345678912' minLength: 11 maxLength: 15 phone_number: description: Número do telefone do comprador. (sem máscara) type: string example: '5551999887766' maxLength: 15 celphone_number: description: Número do telefone celular do comprador. (sem máscara) type: string example: '5551999887766' maxLength: 15 email: description: Email do comprador. type: string format: email example: customer@email.com.br plan: type: object required: - seller_id - name - amount - currency - payment_types - period properties: seller_id: description: Código de identificação do e-commerce. type: string minLength: 36 maxLength: 36 format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 name: description: Nome do plano. type: string example: Plano flex description: description: Descrição do plano. type: string example: Plano flex amount: description: Valor do plano. type: integer example: 19990 currency: description: Identificação da moeda (Consultar código em "https://en.wikipedia.org/wiki/ISO_4217"). type: string minLength: 3 maxLength: 3 example: BRL payment_types: description: Tipos de pagamentos aceitos. type: array enum: - - credit_card items: type: string example: - credit_card sales_tax: description: Valor de impostos. type: integer default: 0 product_type: description: Identificador do tipo de produto vendido dentre as opções. type: string enum: - cash_carry - digital_content - digital_goods - gift_card - physical_goods - renew_subs - shareware - service example: service period: $ref: '#/definitions/period' floating_data: type: array description: Lista preconfigurada de parcelas que terão um valor diferenciado quando a Assinatura for criada. Essa funcionalidade poderá ser utilizada para criar parcelas de degustação com valor zero, um valor de entrada ou parcelas com desconto. A utilização dessa funcionalidade e seu objetivo esperado irá depender da habilitação de um produto específico na Getnet. items: $ref: '#/definitions/plan_floating_data_with_details' period: type: object description: Período do plano. required: - type - billing_cycle properties: type: description: Tipo de periodicidade. type: string enum: - yearly - monthly - bimonthly - quarterly - semesterly - specific example: monthly maxLength: 15 billing_cycle: description: Duração do plano com base no tipo de periodicidade. Por exemplo, para um plano de 12 meses, onde a cobrança será realizada mensalmente (type = monthly) o valor a ser atribuído é 12. type: integer minimum: 0 maximum: 9999 example: 12 specific_cycle_in_days: description: Ciclo específico de cobrança em dias. Quando o tipo de periodicidade for específico (type = specific) deve ser atribuído o número de dias em que o ciclo de cobrança será realizado. Por exemplo, se a duração do plano for 12 (billing_cycle = 12) e o ciclo específico for 10 (specific_cycle_in_days = 10), significa que a cobrança ocorrerá de 10 em 10 dias num todal de 12 cobranças. type: number minimum: 1 maximum: 30 plan_response: type: object properties: seller_id: description: Código de identificação do e-commerce. type: string format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 plan_id: description: Identificador do plano. type: string format: uuidv4 example: 51995e24-b1ae-4826-8e15-2a568a87abdd minLength: 36 maxLength: 36 name: description: Nome do plano. type: string example: Plano flex description: description: Descrição do plano. type: string example: Plano flex amount: description: Valor do plano. type: integer example: 19990 currency: description: Identificação da moeda (Consultar código em "https://www.currency-iso.org/en/home/tables/table-a1.html"). type: string example: BRL minLength: 3 maxLength: 3 payment_types: description: Tipos de pagamentos aceitos. type: string enum: - credit_card items: type: string example: - credit_card sales_tax: description: Valor de impostos. type: integer default: 0 product_type: description: Identificador do tipo de produto vendido dentre as opções. type: string enum: - cash_carry - digital_content - digital_goods - gift_card - physical_goods - renew_subs - shareware - service example: service create_date: description: Data de criação do plano. type: string format: YYYY-MM-DDTHH:MM:SSZ example: '2017-04-19T16:30:30Z' maxLength: 24 status: description: Status do plano. type: string enum: - active - inactive example: active maxLength: 20 period: $ref: '#/definitions/period' floating_data: type: array description: Lista preconfigurada de parcelas que terão um valor diferenciado quando a Assinatura for criada. Essa funcionalidade poderá ser utilizada para criar parcelas de degustação com valor zero, um valor de entrada ou parcelas com desconto. A utilização dessa funcionalidade e seu objetivo esperado irá depender da habilitação de um produto específico na Getnet. items: $ref: '#/definitions/plan_floating_data_with_details' plan_filter_response: type: object required: - page - limit - total properties: plans: description: Lista de planos cadastrados. type: array items: $ref: '#/definitions/plan_filter' page: description: Página corrente. type: number example: 1 limit: description: Número de registros por página. type: number example: 10 total: description: Total de planos cadastrados. type: number example: 1 plan_filter: type: object properties: plan_id: description: Identificador do plano. type: string format: uuidv4 example: 51995e24-b1ae-4826-8e15-2a568a87abdd minLength: 36 maxLength: 36 name: description: Nome do plano. type: string example: Plano flex status: description: Status do plano. type: string enum: - active - inactive example: active maxLength: 20 amount: description: Valor do plano. type: integer example: 19990 currency: description: Identificação da moeda (Consultar código em "https://www.currency-iso.org/en/home/tables/table-a1.html"). type: string example: BRL minLength: 3 maxLength: 3 payment_types: description: Tipos de pagamentos aceitos. type: array enum: - - credit_card items: type: string example: - credit_card create_date: description: Data de criação do plano. type: string format: YYYY-MM-DDTHH:MM:SSZ example: '2017-04-19T16:30:30Z' minLength: 24 period: $ref: '#/definitions/period' floating_data: type: array description: Lista preconfigurada de parcelas que terão um valor diferenciado quando a Assinatura for criada. Essa funcionalidade poderá ser utilizada para criar parcelas de degustação com valor zero, um valor de entrada ou parcelas com desconto. A utilização dessa funcionalidade e seu objetivo esperado irá depender da habilitação de um produto específico na Getnet. items: $ref: '#/definitions/plan_floating_data_with_details' plan_update: type: object required: - name - description properties: name: description: Nome do plano. type: string example: Plano flex atualizado description: description: Descrição do plano. type: string example: Plano flex atualizado floating_data: type: array description: Lista preconfigurada de parcelas que terão um valor diferenciado quando a Assinatura for criada. Essa funcionalidade poderá ser utilizada para criar parcelas de degustação com valor zero, um valor de entrada ou parcelas com desconto. A utilização dessa funcionalidade e seu objetivo esperado irá depender da habilitação de um produto específico na Getnet. items: $ref: '#/definitions/plan_floating_data_with_details' plan_floating_data_with_details: type: object required: - installment properties: installment: type: integer format: int32 example: 2 description: Número da parcela que a alteração será aplicada. minimum: 1 amount: type: integer example: 19990 description: Novo valor da cobrança para uma determinada parcela do plano. Quando uma Assinatura for criada com esse Plano terá esse característica, por exemplo para a parcela 2 aplicar o valor de R$ 10,00. Esse valor pode ser zero, maior ou menor do que o valor original do Plano. minimum: 0 plan_migration_request: type: object required: - from - to properties: from: type: string format: uuid description: Identificador do plano origem, ou seja, o plan_id original da Assinatura. to: type: string format: uuid description: Identificador do plano destino, ou seja, o plan_id ao qual se deseja migrar a Assinatura. subscription: type: object required: - seller_id - customer_id - plan_id properties: seller_id: description: Código de identificação do e-commerce. type: string minLength: 24 maxLength: 24 format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 customer_id: description: Identificador do comprador. type: string example: customer_21081826 maxLength: 100 plan_id: description: Identificador do plano de recorrência. type: string minLength: 36 maxLength: 36 format: uuidv4 example: 51995e24-b1ae-4826-8e15-2a568a87abdd order_id: description: Código de identificação da compra utilizado pelo e-commerce. type: string maxLength: 36 example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 subscription: $ref: '#/definitions/subscription_payment_type_shippings' device: $ref: '#/definitions/device' installment_start_date: description: Data de início de cobrança da Assinatura. Até essa data a Assinatura ficará Programada, ou seja, com status created. A utilização desse campo e seu objetivo esperado irá depender da habilitação de um produto específico na Getnet. type: string format: YYYY-MM-DD example: '2020-09-14' maxLength: 10 subscription_payment_type_shippings: description: Informações da assinatura. type: object properties: payment_type: $ref: '#/definitions/subscription_payment_type_credit' shippings: description: Conjunto de endereços de entrega. type: array items: $ref: '#/definitions/subscription_shippings' subscription_payment_type_credit: description: Informações do tipo de pagamento da assinatura. type: object required: - credit properties: credit: $ref: '#/definitions/subscription_credit' subscription_shippings: type: object properties: first_name: description: Primeiro nome do comprador. type: string maxLength: 40 example: João last_name: description: Último nome do comprador. type: string maxLength: 80 example: da Silva email: description: E-mail do comprador. type: string format: email example: customer@email.com.br phone_number: description: Telefone do comprador. type: string maxLength: 15 example: '5551999887766' shipping_amount: description: Valor da entrega. type: integer example: 3000 address: $ref: '#/definitions/address' subscription_credit: description: Conjunto de dados referentes a transação de crédito. type: object required: - transaction_type - number_installments - card properties: transaction_type: description: Tipo de transação. Pagamento completo à vista. type: string enum: - FULL example: FULL number_installments: description: Número de parcelas para uma transação de crédito parcelado. Para o transaction_type=FULL o valor que deverá ser enviado será sempre 1. type: integer example: 1 soft_descriptor: $ref: '#/definitions/soft_descriptor_global' billing_address: $ref: '#/definitions/address' card: $ref: '#/definitions/subscription_card' subscription_response: type: object properties: seller_id: description: Código de identificação do e-commerce. type: string format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 order_id: description: Código de identificação da compra utilizado pelo e-commerce type: string example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 maxLength: 36 create_date: description: Data de criação da assinatura de recorrência. type: string format: YYYY-MM-DDTHH:MM:SSZ example: '2017-04-19T16:30:30Z' maxLength: 24 end_date: description: Data final da assnatura de recorrência. type: string format: YYYY-MM-DDTHH:MM:SSZ example: '2018-04-19T16:30:30Z' maxLength: 24 payment_date: description: Data de pagamento da assinatura de recorrência. type: integer format: YYYY-MM-DDTHH:MM:SSZ example: '2017-04-19T16:30:30Z' maxLength: 24 next_scheduled_date: description: Próxima data de agendamento da assinatura de recorrência. type: string format: YYYY-MM-DDTHH:MM:SSZ example: '2017-05-19T16:30:30Z' maxLength: 24 subscription: $ref: '#/definitions/subscription_payment_type_shippings_response' customer: $ref: '#/definitions/subscription_customer_response' plan: $ref: '#/definitions/subscription_plan_response' device: $ref: '#/definitions/device' status: description: Status da assinatura de recorrência. type: string enum: - processing - canceled - success - delayed - failed - expired example: success maxLength: 20 status_details: description: Detalhes do status da assinatura de recorrência. type: string example: Assinatura Plano flex criada com sucesso maxLength: 500 payment: description: Informações de pagamento da assinatura type: object properties: error: $ref: '#/definitions/error_payment_subscription' installment_start_date: description: Data de início de cobrança da Assinatura. Até essa data a Assinatura ficará Programada, ou seja, com status created. A utilização desse campo e seu objetivo esperado irá depender da habilitação de um produto específico na Getnet. type: string format: YYYY-MM-DD example: '2020-09-14' maxLength: 10 subscription_payment_type_shippings_response: description: Informações da assinatura. type: object properties: subscription_id: description: Identificador da assinatura de recorrência. type: string format: uuidv4 example: 5d740ea0-b7d1-42f5-ad64-5a5521e12er9 minLength: 36 maxLength: 36 payment_type: $ref: '#/definitions/subscription_payment_type_credit_response' shippings: description: Conjunto de endereços de entrega. type: array items: $ref: '#/definitions/subscription_shippings' subscription_payment_type_credit_response: description: Informações do tipo de pagamento da assinatura. type: object properties: credit: $ref: '#/definitions/subscription_credit_response' subscription_credit_response: description: Conjunto de dados referentes a transação de crédito. type: object properties: transaction_type: description: Tipo de transação. Pagamento completo à vista. type: string enum: - FULL example: FULL number_installments: description: Número de parcelas para uma transação de crédito parcelado. type: integer example: 1 billing_address: $ref: '#/definitions/address' card: $ref: '#/definitions/subscription_card_response' subscription_card_response: type: object description: Conjunto de dados do cartão. properties: cardholder_name: type: string description: Nome do comprador impresso no cartão. Obrigatório caso os dados de cartão não foram armazenados permanentemente com o token. example: JOAO DA SILVA maxLength: 26 brand: type: string description: Bandeira. (Utilizado também no antifraude). Obrigatório caso os dados de cartão não foram armazenados permanentemente com o token. example: Mastercard enum: - Mastercard - Visa - Amex - Elo - Hipercard maxLength: 50 expiration_month: type: string description: Mês de expiração do cartão com dois dígitos. Obrigatório caso os dados de cartão não foram armazenados permanentemente com o token. example: '12' minLength: 2 maxLength: 2 expiration_year: type: string description: Ano de expiração do cartão com dois dígitos. Obrigatório caso os dados de cartão não foram armazenados permanentemente com o token. example: '28' minLength: 2 maxLength: 2 bin: type: string description: Seis primeiros números do cartão. example: '123412' minLength: 6 maxLength: 9 subscription_customer_response: type: object description: Conjunto de dados do comprador. properties: customer_id: description: Identificador do comprador. type: string example: customer_21081826 maxLength: 100 first_name: description: Primeiro nome do comprador. type: string example: João maxLength: 40 last_name: description: Último nome do comprador. type: string example: da Silva maxLength: 80 document_type: description: Tipo de documento do comprador. type: string enum: - CPF - CNPJ example: CPF document_number: description: Número do documento do comprador. (sem máscara) type: string minLength: 11 maxLength: 15 example: '12345678912' birth_date: description: Data de nascimento do comprador. type: string format: YYYY-MM-DD example: '1976-02-21' minLength: 10 maxLength: 10 phone_number: description: Número do telefone do comprador. (sem máscara) type: string maxLength: 15 example: '5551999887766' celphone_number: description: Número do telefone celular do comprador. (sem máscara) type: string example: '5551999887766' maxLength: 15 email: description: Email do comprador. type: string format: email example: customer@email.com.br observation: description: Observações. type: string example: O cliente tem interesse no plano x. address: $ref: '#/definitions/address' subscription_plan_response: description: Informações sobre o plano. type: object properties: plan_id: description: Identificador do plano. type: string format: uuidv4v4 example: 51995e24-b1ae-4826-8e15-2a568a87abdd minLength: 36 maxLength: 36 name: description: Nome do plano. type: string example: Plano flex description: description: Descrição do plano. type: string example: Plano flex amount: description: Valor do plano. type: integer example: 19990 currency: description: Identificação da moeda (Consultar código em "https://www.currency-iso.org/en/home/tables/table-a1.html"). type: string example: BRL minLength: 3 maxLength: 3 payment_types: description: Tipos de pagamentos aceitos. type: string enum: - credit_card items: type: string example: - credit_card sales_tax: description: Valor de impostos. type: integer default: 0 product_type: description: Identificador do tipo de produto vendido dentre as opções. type: string enum: - cash_carry - digital_content - digital_goods - gift_card - physical_goods - renew_subs - shareware - service example: service status: description: Status do plano. type: string enum: - active - inactive example: active maxLength: 20 period: $ref: '#/definitions/period' subscription_filter_response: type: object properties: subscriptions: description: Conjunto de assinaturas de recorrência. type: array items: $ref: '#/definitions/subscription_response' page: description: Página corrente. type: number example: 1 limit: description: Número de registros por página. type: number example: 10 total: description: Total de planos cadastrados. type: number example: 1 subscription_cancel: type: object required: - seller_id - status_details properties: seller_id: description: Código de identificação do e-commerce. type: string minLength: 36 maxLength: 36 format: uuidv4v4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 status_details: description: Detalhes do status da assinatura de recorrência. type: string maxLength: 500 example: Cliente não tem mais interesse no serviço/produto subscription_projection_response: type: object required: - amount properties: amount: description: Valor total da projeção. type: number example: 199900 projection: description: Conjunto de projeções de cobrança. type: array items: properties: date: description: Data da projeção de cobrança. type: string format: YYYY-MM-DD example: '2017-05-19' minLength: 10 maxLength: 10 amount: description: Valor da projeção de cobrança. type: number example: 100000 installment: description: Número da parcela. type: number example: 2 floating_data: $ref: '#/definitions/subscription_floating_data_projection' subscription_confirm: type: object required: - seller_id - status_details - charge_id properties: seller_id: description: Código de identificação do e-commerce. type: string format: uuidv4v4 minLength: 36 maxLength: 36 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 status_details: description: Detalhes do status da assinatura de recorrência. type: string maxLength: 500 example: Pagamento de assinatura confirmado charge_id: description: Identificador da cobrança. type: string minLength: 36 maxLength: 36 format: uuidv4v4 example: 52bc81b2-f079-4f7b-b63a-f653ff29d794 subscription_payment_date: type: object required: - day properties: day: description: Dia de pagamento da nova cobrança. type: integer minimum: 1 maximum: 31 example: 25 subscription_update_payment_type: type: object description: Conjunto de dados do cartão. properties: number_token: type: string description: Número do cartão tokenizado. example: dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c minLength: 128 maxLength: 128 cardholder_name: type: string description: Nome do comprador impresso no cartão. Obrigatório caso os dados de cartão não foram armazenados permanentemente com o token. maxLength: 26 example: JOAO DA SILVA brand: type: string description: Bandeira. (Utilizado também no antifraude). Obrigatório caso os dados de cartão não foram armazenados permanentemente com o token. example: Mastercard enum: - Mastercard - Visa - Amex - Elo - Hipercard maxLength: 50 expiration_month: type: string description: Mês de expiração do cartão com dois dígitos. Obrigatório caso os dados de cartão não foram armazenados permanentemente com o token. minLength: 2 maxLength: 2 example: '12' expiration_year: type: string description: Ano de expiração do cartão com dois dígitos. Obrigatório caso os dados de cartão não foram armazenados permanentemente com o token. minLength: 2 maxLength: 2 example: '28' bin: type: string description: Seis primeiros números do cartão. minLength: 6 maxLength: 9 example: '123412' subscription_floating_data_response: type: object required: - subscription_id properties: subscription_id: type: string format: uuid description: Identificador da assinatura de recorrência. minLength: 36 maxLength: 36 example: 9aca75f2-bb03-42d7-aa09-7e46409ded26 floating_data: type: array description: Lista de cobranças com a alterações de data e/ou valor items: $ref: '#/definitions/subscription_floating_data' subscription_floating_data_array_creation: type: array description: Lista de cobranças com a alterações de data e/ou valor items: $ref: '#/definitions/subscription_floating_data_creation' subscription_floating_data_update: type: object properties: new_amount: type: integer example: 19990 description: Novo valor da cobrança. minimum: 0 new_scheduled_date: type: string format: YYYY-MM-DD description: Nova data de cobrança example: '2020-06-10' maxLength: 12 subscription_floating_data_remove_response: type: object required: - subscription_id properties: subscription_id: type: string format: uuid description: Identificador da assinatura de recorrência. minLength: 36 maxLength: 36 example: 9aca75f2-bb03-42d7-aa09-7e46409ded26 floating_data: type: array description: Lista de cobranças com a alterações de data e/ou valor items: $ref: '#/definitions/subscription_floating_data_with_details' subscription_floating_data_creation: type: object required: - installment properties: installment: type: integer format: int32 example: 2 description: Número da parcela que a alteração será aplicada. minimum: 1 new_amount: type: integer example: 19990 description: Novo valor da cobrança. minimum: 0 new_scheduled_date: type: string format: YYYY-MM-DD description: Nova data de cobrança example: '2020-06-10' maxLength: 12 subscription_floating_data: type: object required: - installment properties: installment: type: integer format: int32 example: 2 description: Número da parcela que a alteração será aplicada. minimum: 1 new_amount: type: integer example: 19990 description: Novo valor da cobrança. minimum: 0 new_scheduled_date: type: string format: YYYY-MM-DD description: Nova data de cobrança example: '2020-06-10' maxLength: 12 original_scheduled_date: type: string format: YYYY-MM-DD description: Data do agendamento original da cobrança, antes de ser alterada, de acordo com o plano associado à assinatura. example: '2020-06-10' maxLength: 12 original_amount: type: integer example: 19990 description: Valor original da cobrança, antes de ser alterada, de acordo com o plano associado a assinatura. minimum: 0 subscription_floating_data_with_details: type: object required: - installment properties: installment: type: integer format: int32 example: 2 description: Número da parcela que a alteração será aplicada. minimum: 1 new_amount: type: integer example: 19990 description: Novo valor da cobrança. minimum: 0 new_scheduled_date: type: string format: YYYY-MM-DD description: Nova data de cobrança example: '2020-06-10' maxLength: 12 original_scheduled_date: type: string format: YYYY-MM-DD description: Data do agendamento original da cobrança, antes de ser alterada, de acordo com o plano associado à assinatura. example: '2020-06-10' maxLength: 12 original_amount: type: integer example: 19990 description: Valor original da cobrança, antes de ser alterada, de acordo com o plano associado a assinatura. minimum: 0 details: type: string description: Motivo pela qual não foi possível remover da cobrança a alteração de data e/ou valor. subscription_floating_data_projection: type: object description: Esse campo será apresentado caso seja informado o parâmetro expand=floating_data e também dependerá da contratação do produto Recorrência Flexível. properties: new_date: type: string format: YYYY-MM-DD description: Nova data alterada da cobrança. example: '2020-06-10' maxLength: 12 new_amount: type: integer example: 19990 description: Novo valor alterado da cobrança. minimum: 0 subscription_plan_migration: type: object required: - from - to properties: from: type: string format: uuid description: Identificador do Plano de origem. Todas as Assinaturas com esse Plano serão migradas para o Plano destino (campo to) to: type: string format: uuid description: Identificador do Plano ao qual as Assinaturas serão destinadas. subscriptions: $ref: '#/definitions/subscription_ids_array' subscription_ids_array: type: array description: Lista de identificadores de Assinaturas que serão migradas para o Plano destino (campo to). Caso essa lista não for informada então o serviço migrará todas as Assinaturas do Plano origem (campo from) para o Plano destino (campo to). items: type: string format: uuid charge_filter_response: type: object required: - page - limit - total properties: charges: type: array items: $ref: '#/definitions/charge_filter' page: description: Página corrente. type: number example: 1 limit: description: Número de registros por página. type: number example: 10 total: description: Total de cobranças cadastradas. type: number example: 1 charge_filter: description: Informações das cobranças. type: object properties: seller_id: description: Código de identificação do e-commerce. type: string format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 charge_id: description: Identificador da cobrança. type: string format: uuidv4 example: 52bc81b2-f079-4f7b-b63a-f653ff29d794 minLength: 36 maxLength: 36 subscription_id: description: Identificador da assinatura. type: string format: uuidv4 example: 5d740ea0-b7d1-42f5-ad64-5a5521e12er9 minLength: 36 maxLength: 36 customer_id: description: Identificador do comprador. type: string example: customer_21081826 maxLength: 100 plan_id: description: Identificador do plano. type: string format: uuidv4 example: 51995e24-b1ae-4826-8e15-2a568a87abdd minLength: 36 maxLength: 36 payment_id: description: Código de identificação do pagamento da transação original. type: string format: uuidv4 example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 amount: description: Valor da cobrança. type: integer example: 19990 status: description: Status da cobrança. enum: - paid - denied - processing - scheduled - canceled type: string example: paid maxLength: 20 scheduled_date: description: Data de agendamento da cobrança. type: string format: YYYY-MM-DDTHH:MM:SSZ example: '2017-04-19T16:30:30Z' create_date: description: Data de criação da cobrança. type: string format: YYYY-MM-DDTHH:MM:SSZ example: '2017-03-19T16:30:30Z' retry_number: description: Número de retentativas. type: integer example: 1 payment_date: description: Data de pagamento da assinatura de recorrência. type: integer format: YYYY-MM-DDTHH:MM:SSZ example: '2017-04-19T16:30:30Z' maxLength: 24 payment_type: description: Tipo de pagamento. type: string example: credit_card terminal_nsu: type: string description: Código de Autorização gerado pelo Emissor quando a transação é realizada com sucesso. example: '006090' authorization_code: type: string description: Número de autorização gerado pelo sistema de verificação de cartão. example: '6964722471672911' minLength: 1 maxLength: 18 acquirer_transaction_id: type: string description: Código do adquirente da transação original. example: '113880914' payment_link_request: type: object description: Requisição contendo os dados para o GetPay. required: - label - order - payment properties: label: type: string description: Tag de identificação do GetPay. example: carrinho1 minLength: 6 maxLength: 36 expiration: type: string description: Data de expiração do GetPay. format: date-time example: '2028-12-30T13:18:27.232Z' max_orders: type: integer description: Número máximo de vendas que o GetPay permitirá. minimum: 1 example: 1 order: $ref: '#/definitions/payment_link_order' payment: $ref: '#/definitions/payment_link_payment' payment_link_order: type: object description: Informações sobre o pedido. required: - product_type - title - description - amount properties: product_type: type: string description: Tipo de produto vinculado a compra. enum: - cash_carry - digital_content - digital_goods - digital_physical - gift_card - physical_goods - renew_subs - shareware - service title: type: string description: Titulo do pedido. maxLength: 128 description: type: string description: Descrição do pedido. maxLength: 1024 order_prefix: type: string description: Prefixo de ID de pedido. maxLength: 16 shipping_amount: type: integer description: Valor em centávos do frete. amount: type: number description: Valor em centávos do carrinho(Deve ser um numero positivo). example: 1 payment_link_payment: type: object description: Configuração dos tipos de pagamento disponibilizados no GetPay. required: - credit - debit properties: credit: $ref: '#/definitions/payment_link_credit' debit: $ref: '#/definitions/payment_link_debit' wallet: $ref: '#/definitions/payment_link_qrcode' pix: $ref: '#/definitions/payment_link_pix' payment_link_credit: type: object description: Configurações do tipo de pagamento de crédito. required: - enable properties: enable: type: boolean description: Habilita o tipo de pagamento no checkout do GetPay. max_installments: type: integer description: Número máximo de parcelas. minimum: 1 maximum: 12 example: 1 not_authenticated: type: boolean description: Habilita a opção de pagamento sem autenticação para o meio de pagamento. default: false authenticated: type: boolean description: Habilita a opção de pagamento com autenticação para o meio de pagamento. default: true payment_link_debit: type: object description: Configurações do tipo de pagamento de débito. required: - enable properties: enable: type: boolean description: Habilita o tipo de pagamento no checkout do GetPay. caixa_virtual_card: type: boolean description: Habilita a opção de cartão virtual Caixa no checkout do GetPay. default: false not_authenticated: type: boolean description: Habilita a opção de pagamento sem autenticação para o meio de pagamento. default: false authenticated: type: boolean description: Habilita a opção de pagamento com autenticação para o meio de pagamento. default: true payment_link_qrcode: type: object description: Configurações do meio de pagamento de QRCode. required: - enable properties: enable: type: boolean description: Habilita o meio de pagamento QRCode no checkout do GetPay.
(payment.wallet.enabled pode ser enviado = true se payment.credit.enabled ou payment.debit.enabled = true) payment_link_pix: type: object description: Configurações do tipo de pagamento QR Code PIX. required: - enable properties: enable: type: boolean description: Habilita o tipo de pagamento QR Code PIX no Checkout para o GetPay. payment_link_request_response: type: object properties: amount: type: integer description: Valor em centávos do carrinho. minimum: 0 label: type: string description: Tag de identificação do GetPay. link_id: type: string description: ID do link de pagamento. format: uuid created_at: type: string description: Data de criacao do GetPay. format: date-time updated_at: type: string description: Data da ultima atualização do GetPay. format: date-time max_orders: type: string description: Número máximo de vendas que o GetPay permitirá. status: type: string description: Status do GetPay. enum: - ACTIVE - SUSPENDED - EXPIRED url: type: string description: Url do GetPay. format: uri expiration: type: string description: Data de expiração do GetPay. format: date-time payment_link_filter_response: type: object properties: page_number: type: integer description: Número da pagina atual. minimum: 0 total_pages: type: integer description: Número total de paginas. minimum: 0 result: type: array description: Lista de resultados da busca. items: $ref: '#/definitions/payment_link_result' total: type: integer description: Número total de resultados. minimum: 0 per_page: type: integer description: Número de resultados por página. minimum: 0 payment_link_filter_response_enabled_products: type: object properties: debit: type: array description: Número da pagina atual. items: $ref: '#/definitions/payment_link_result_enabled_products' credit: type: array description: Número da pagina atual. items: $ref: '#/definitions/payment_link_result_enabled_products' pix: type: array description: Número da pagina atual. items: $ref: '#/definitions/payment_link_result_enabled_products_pix' qr-code: type: array description: Número da pagina atual. items: $ref: '#/definitions/payment_link_result_enabled_products_qrcode' payment_link_result_enabled_products: type: object description: Item da lista de resultados. properties: enabled: type: boolean format: boolean authenticated: type: boolean format: boolean not_authenticated: type: boolean format: boolean payment_link_result_enabled_products_pix: type: object description: Item da lista de resultados. properties: enabled: type: boolean format: boolean activated: type: boolean format: boolean payment_link_result_enabled_products_qrcode: type: object description: Item da lista de resultados. properties: enabled: type: boolean format: boolean payment_link_result: type: object description: Item da lista de resultados. properties: link_id: type: string description: ID do link de pagamento. format: uuid label: type: string description: Tag de identificação do link de pagamento. amount: type: integer description: Valor em centávos do carrinho. links: type: array description: Links relacionados ao resultado. items: $ref: '#/definitions/payment_link_links' created_at: type: string description: Data de criacao do GetPay. format: date-time url: type: string description: Url do GetPay access_counter: type: integer description: Contador de acessos. Toda vez que o link é acessado ele é incrementado. status: type: string description: Status do GetPay. enum: - SUSPENDED - ACTIVE - EXPIRED shipping_amount: type: integer description: Valor em centávos do frete. title: type: integer description: Titulo do carrinho apresentado no GetPay. expiration: type: string description: Data de expiração no formato ISO. format: uri max_orders: format: date-time description: Numero máximo de vendas no GetPay. type: integer payment_link_links: type: object description: Links relacionados ao resultado. properties: rel: type: string description: Relacionamento da url em relação ao resultado. href: type: string description: Url do recurso. format: uri payment_link_alteration: type: object properties: max_orders: description: Número máximo de vendas que o GetPay permitirá. type: integer example: 1 expiration: type: string description: Data de expiração do GetPay. format: date-time example: '2028-12-29T14:17:46.348Z' status: type: string description: Status do GetPay. enum: - SUSPENDED - ACTIVE - EXPIRED payment_link_alteration_response: type: object properties: created_at: type: string description: Data de criacao do GetPay format: date-time updated_at: type: string description: Data da ultima atualização do GetPay. format: date-time link_id: type: string description: ID do link de pagamento. format: uuidv4 order: $ref: '#/definitions/payment_link_order_response' payment: $ref: '#/definitions/payment_link_payment_response' status: type: string description: Status do GetPay. enum: - ACTIVE - SUSPENDED - EXPIRED - SOLD_OUT seller_id: type: string description: ID do seller que criou o GetPay. format: uuid max_orders: type: integer description: Número máximo de vendas do GetPay. successfull_orders: type: integer description: Número de vendas com sucesso do GetPay. access_counter: type: integer description: Contador de acessos. Toda vez que o link é acessado ele é incrementado. expiration: type: string description: Data de expiração do GetPay. format: date-time merchant: $ref: '#/definitions/payment_link_merchant_response' url: type: string description: Url do GetPay. payment_orders_created: type: integer description: Número de ordens de venda criados. Asordens são geradas quando um usuário completa oformulário de compra, mesmo que ele abandone a compr. label: type: string description: Tag de identificação do GetPay. last_order_at: type: string description: Data da última ordem criada pelo GetPay. payment_link_order_response: type: object description: Informações sobre o pedido properties: product_type: type: string description: Tipo de produto vinculado a compra. enum: - cash_carry - digital_content - digital_goods - digital_physical - gift_card - physical_goods - renew_subs - shareware - service title: type: string description: Titulo do pedido. description: type: string description: Descrição do pedido. amount: type: integer description: Valor em centávos do carrinho. shipping_amount: type: integer description: Valor em centávos do frete. order_prefix: type: string description: Prefixo de ID de pedido. payment_link_payment_response: type: object description: Configuração dos tipos de pagamento disponibilizados no GetPay. properties: credit: $ref: '#/definitions/payment_link_credit_response' debit: $ref: '#/definitions/payment_link_debit_response' payment_link_credit_response: type: object description: Configurações do tipo de pagamento de crédito. properties: enable: type: boolean description: Habilita o tipo de pagamento no checkout do GetPay. max_installments: type: integer description: Número máximo de parcelas. minimum: 0 maximum: 24 payment_link_debit_response: type: object description: Configurações do tipo de pagamento de débito. properties: enable: type: boolean description: Habilita o tipo de pagamento no checkout do GetPay authenticated: type: boolean default: true description: Habilita a opção de pagamento com autenticação para o meio de pagamento. not_authenticated: type: boolean default: false description: Habilita a opção de pagamento sem autenticação para o meio de pagamento. caixa_virtual_card: type: boolean default: false description: Habilita a opção de cartão virtual Caixa no checkout do GetPay payment_link_merchant_response: type: object description: Dados do EC que criou o GetPay. properties: name: type: string description: Nome Fantasia do EC que criou o GetPay. document: type: string description: Número do documento do EC que criou o GetPay. document_type: type: string description: Tipo do documento do EC que gerou o GetPay. payment_link_consult_response: type: object properties: created_at: type: string description: Data de criacao do GetPay. format: date-time updated_at: type: string description: Data da ultima atualização do GetPay. format: date-time link_id: type: string description: ID do link de pagamento. format: uuid order: $ref: '#/definitions/payment_link_order_response' payment: $ref: '#/definitions/payment_link_payment_response' status: type: string description: Status do GetPay. enum: - ACTIVE - SUSPENDED - EXPIRED - SOLD_OUT seller_id: type: string description: ID do seller que criou o GetPay. format: uuid max_orders: type: integer description: Número máximo de vendas do GetPay. successfull_orders: type: integer description: Número de vendas com sucesso do GetPay. access_counter: type: integer description: Contador de acessos. Toda vez que o link é acessado ele é incrementado. payment_orders_created: type: integer description: Número de ordens de venda criados. Asordens são geradas quando umusuário completa oformulário de compra, mesmo que ele abandonea compr. expiration: type: string description: Data de expiração do GetPay. format: date-time url: type: string description: Url do GetPay. merchant: $ref: '#/definitions/payment_link_merchant_response' label: type: string description: Tag de identificação do GetPay. last_order_at: type: string description: Data da última ordem criada pelo GetPay. payment_link_payment_consult_response: type: object properties: quantity: type: integer description: Quantidade de carrinhos vendidos nessa ordem de pagamento. minimum: 1 amount: type: integer description: Valor em centávos do ordem de compra. minimum: 1 status: type: string description: Status do pedido feito pelo link de pagamento. enum: - SUCCESSFUL - CREATED - FAILED payment_order_id: type: string description: ID da ordem de pagamento. customer: $ref: '#/definitions/payment_link_customer' payments: $ref: '#/definitions/payment_link_payments_response' shippings: $ref: '#/definitions/payment_link_shippings' updated_at: type: string description: Data de atualização da ordem de pagamento. created_at: type: string description: Data de criação da ordem de pagamento. seller_id: type: string description: ID do seller vinculado a ordem de pagamento. link_id: type: string description: ID GetPay que originou a ordem de pagamento. shipping_amount: description: Valor em centávos do frete. type: integer payment_link_customer: type: object description: Conjunto de dados referentes ao comprador. properties: first_name: type: string description: Primeiro nome do comprador. last_name: type: string description: Último nome do comprador. email: type: string description: E-mail do comprador. document_number: type: string description: Número do documento do comprador sem pontuação. (sem máscara) document_type: type: string description: Tipo do documento de identificação do comprador. phone_number: type: string description: Telefone do comprador. (sem máscara) billing_address: $ref: '#/definitions/payment_link_billing_address' payment_link_billing_address: type: object description: Endereço de combrança. properties: postal_code: type: string description: Código Postal, CEP no Brasil ou ZIP nos Estados Unidos. (sem máscara) street: type: string description: Logradouro. number: type: string description: Número do logradouro. complement: type: string description: Complemento do logradouro. district: type: string description: Bairro. city: type: string description: Cidade. state: type: string description: Estado (UF). country: type: string description: País. payment_link_payments_response: type: array description: Lista de dados de pagamento vinculados a ordem. items: type: object properties: payment_id: type: string description: ID do pagamento. registred_at: type: string description: Data e hora do registro de pagamento. status: type: string description: Status da transação. payment_type: type: string description: Tipo de pagamento. enum: - CREDIT - DEBIT amount: type: integer description: Valor da compra em centavos. transaction_type: type: string description: Tipo de transação realizada. enum: - FULL - INSTALL_NO_INTEREST - INSTALL_WITH_INTEREST transaction: type: object description: Valor da compra em centavos. number_installments: description: Número de parcelas para uma transação de crédito parcelado. type: integer payment_link_shippings: type: object description: Conjunto de dados referentes ao endereço de entrega. properties: address: $ref: '#/definitions/address' same_as_billing_address: description: Flag de endereço de entrega igual ao endereço de cobrança. type: boolean payment_link_linked_response: type: array items: type: object properties: page_number: type: integer minimum: 0 description: Número da pagina atual. total_pages: type: integer minimum: 0 description: Número total de paginas. result: $ref: '#/definitions/payment_link_result_response' per_page: type: integer minimum: 0 description: Número total de resultados. total: type: integer minimum: 0 description: Número de resultados por página. payment_link_result_response: type: array description: Lista de resultados da busca. items: type: object properties: status: type: string enum: - SUCCESSFUL - FAILED - CREATED description: Status do pedido feito pelo link de pagamento. quantity: type: integer minimum: 1 description: Quantidade de carrinhos vendidos nessa ordem de pagamento. amount: type: integer minimum: 1 description: Valor em centávos do ordem de compra. payment_order_id: type: string description: ID da ordem de pagamento. links: $ref: '#/definitions/payment_link_links' created_at: type: string format: date-time description: Data de criacao da ordem de pagamento. email: type: string description: E-mail do comprador. first_name: type: string description: Primeiro nome do comprador. last_name: type: string description: Último nome do comprador. document_number: type: string description: Número do documento do portador. document_type: type: string description: Tipo do documento do portador. payment_qrcode_pix_request: type: object description: Conjunto de dados para pagamento PIX com QR Code. required: - amount - currency properties: amount: type: integer description: | Valor da compra em centavos. Para simulação de um pagamento de PIX aprovado com sucesso ou negado no ambiente de homologação, considerar o amount abaixo:

amount	Tempo	Status	Pulling Description	Checkout Status
9000	10 s	APPROVED	O pagamento PIX foi efetuado com sucesso. (00)	Transação realizada com sucesso.
9088	-	DENIED	Não foi possível efetuar a transação PIX. (AF-88)	Não foi possível realizar o pagamento.

example: 100 currency: type: string description: Identificação da moeda (Consultar código em "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 order_id: description: Código de identificação da compra utilizado pelo e-commerce. Caso seja informado ele será repassado na Notificação de Pagamento PIX. type: string example: DEV-1608748980 customer_id: description: Identificador do comprador utilizado pelo e-commerce. Caso seja informado ele será repassado na Notificação de Pagamento PIX. type: string maxLength: 36 payment_qrcode_request: type: object description: Conjunto de dados para pagamento com QRCode. required: - amount - credit - order - customer properties: amount: type: integer description: Valor da compra em centavos. example: 100 currency: type: string description: Identificação da moeda (Consultar código em "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 order: $ref: '#/definitions/order' customer: $ref: '#/definitions/customer_credit' device: $ref: '#/definitions/device_credit' shippings: type: array items: $ref: '#/definitions/shipping_credit' payments: type: array items: $ref: '#/definitions/qrcode_payments' qrcode_payments: type: object description: Conjunto de dados referentes ao pagamento. properties: type: type: string description: Tipo do pagamento. enum: - CREDIT - DEBIT example: CREDIT authenticated: type: boolean description: Identifica se o transação será feito com autenticação. example: false transaction_type: type: string description: | Tipo de transação. Pagamento completo à vista, parcelado sem juros, parcelado com juros.
Obrigatório quando o campo type = CREDIT. enum: - FULL - INSTALL_NO_INTEREST - INSTALL_WITH_INTEREST example: FULL number_installments: type: number description: | Número de parcelas para uma transação de crédito parcelado.
Obrigatório quando o campo type = CREDIT. example: 1 soft_descriptor: $ref: '#/definitions/soft_descriptor_global' dynamic_mcc: $ref: '#/definitions/dynamic_mcc' cardholder_mobile: type: string description: | Telefone do portador do cartão. Obrigatório para Visa.
Utilizar somente em transações de débito autenticado (authenticated = true) example: '5551999887766' payment_qrcode_response: type: object description: Conjunto de dados do QRCode. properties: qr_code: type: string description: QRCode example: 00020101021226580014br.com.padraoq011600000000005439920208E03862520304000252040000530398654041.995802BR5919EC Teste HUB PADRAO6012Porto Alegre62290525b55161ce07c030209c2fe8ef381720014br.com.padraoq01122212201824420204000203020104020105020350088c65d85|50088c65d85|6304B0C0 hash_qr_code: type: string description: Hash do QRCode example: b55161ce07c030209c2fe8ef38c65d85 payment_id: type: string description: Identificador do Pagamento. example: 1a938e0d-26ab-4ac2-b263-ab46a99e4356 payment_qrcode_pix_response: type: object description: Conjunto de dados PIX do QR Code. properties: payment_id: type: string description: Identificador do Pagamento. example: 1a938e0d-26ab-4ac2-b263-ab46a99e4356 status: description: 'Status da transação PIX. Os possíveis status para uma Transação PIX são:
PENDING - O QR Code não gerado com sucesso pois ficou pendente aguardando uma resposta da instituição.
WAITING - O QR Code foi gerado com sucesso e está aguardando o pagamento pelo cliente.
EXPIRED - O QR Code está expirado e é necessário gerar outro.
ERROR - O QR Code não foi gerado pois ocorreu um erro.
APPROVED - A transação PIX foi paga com sucesso. Esse status é enviado por Notificação de transação PIX.
DENIED - A transação PIX foi negada. Esse status é enviado por Notificação de transação PIX.
' type: string enum: - PENDING - WAITING - EXPIRED - ERROR - APPROVED - DENIED example: WAITING description: type: string description: Texto com uma mensagem descritiva do resultado da requisição. example: QR Code gerado com sucesso e aguardando o pagamento. additional_data: $ref: '#/definitions/additional_data_pix' additional_data_pix: type: object description: Grupo de informações adicionais sobre o resultado da requisição de QR Code ou transação PIX. properties: transaction_id: type: string description: Identificador da transação iniciada após a geração do QR Code PIX com a instituição. example: '8289874875871543653292342' qr_code: type: string description: Payload do QR Code PIX gerado. Com esse texto será possível apresentá-lo no modo gráfico ou ainda o cliente pode pagá-lo via função "Copia e Cola" do PIX. example: 00020101021226740014br.gov.bcb.pix210812345678220412342308123456782420001122334455 667788995204000053039865406123.455802BR5913FULANO DE TAL6008BRASILIA62190515RP12345678- 201980720014br.gov.bcb.pix2550bx.com.br/spi/U0VHUkVET1RPVEFMTUVOVEVBTEVBVE9SSU8=63 0434D1 creation_date_qrcode: type: string description: Data de criação do QR Code gerado. format: YYYY-MM-DDTHH:MM:SSZ example: '2021-02-14T17:50:12Z' expiration_date_qrcode: type: string format: YYYY-MM-DDTHH:MM:SSZ description: Data de expiração do QR Code gerado. example: '2021-02-14T17:51:52Z' psp_code: type: string description: Código PSP do Recebedor. PSP (Provedor de Serviço de Pagamento, que é a instituição financeira responsável pelo pagamento ou pelo recebimento dos valores no Pix. example: '033' qrcode_response: type: object description: Dados do QRCode retornados. properties: seller_id: type: string description: Código de identificação do e-commerce. example: 54218a4d-3a3b-48e2-82dc-58f7df8509b2 hash_qr_code: type: string description: Hash do QRCode example: 151b8eb68ac61573f72a84c9ab2feca2 status: description: Status da transação. type: string enum: - PENDING - APPROVED - DENIED example: APPROVED order_id: description: Código de identificação da compra utilizado pelo e-commerce type: string example: DEV-1608748980 amount: type: integer description: Valor da compra em centavos. example: 100 payment_request: $ref: '#/definitions/qrcode_payment_request' payment_response: $ref: '#/definitions/qrcode_payment_response' qrcode_payment_request: type: object description: Conjunto de dados referentes ao pagamento. properties: type: type: string description: Tipo do pagamento. example: CREDIT delayed: type: boolean description: Identifica se o crédito será feito com confirmação tardia. example: false authenticated: type: boolean description: Identifica se o transação será feito com autenticação. example: false pre_authorization: type: boolean description: Indicativo se a transação é uma pré autorização de crédito. example: false save_card_data: type: boolean description: Identifica se o cartão deve ser salvo para futuras compras. example: false transaction_type: type: string description: | Tipo de transação. Pagamento completo à vista, parcelado sem juros, parcelado com juros. example: FULL number_installments: type: number description: Número de parcelas para uma transação de crédito parcelado. example: 1 soft_descriptor: $ref: '#/definitions/soft_descriptor_global' dynamic_mcc: $ref: '#/definitions/dynamic_mcc' qrcode_payment_response: type: object description: Conjunto de dados referentes ao pagamento. properties: payment_id: type: string description: Identificador do Pagamento. example: 1a938e0d-26ab-4ac2-b263-ab46a99e4356 seller_id: type: string description: Código de identificação do e-commerce. example: 54218a4d-3a3b-48e2-82dc-58f7df8509b2 amount: type: integer description: Valor da compra em centavos. example: 100 currency: type: string description: Identificação da moeda (Consultar código em "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL order_id: description: Código de identificação da compra utilizado pelo e-commerce type: string example: DEV-1608748980 status: description: Status da transação. type: string enum: - APPROVED - DENIED - ERROR example: APPROVED received_at: type: string description: Data e hora do registro de pagamento. format: YYYY-MM-DDTHH:mm:ss.SSSZ example: '2017-03-19T16:30:30.764Z' credit: $ref: '#/definitions/qrcode_payment_response_credit' debit: $ref: '#/definitions/qrcode_payment_response_debit' qrcode_payment_response_credit: type: object description: | Conjunto de dados do pagamento.
Retorno exlcusivo para transações de Crédito. properties: delayed: type: boolean description: Identifica se o crédito será feito com confirmação tardia. example: false authorization_code: type: string description: Número de autorização gerado pelo sistema de verificação de cartão. example: '6964722471672911' authorized_at: type: number description: Data/hora da autorização de crédito. format: YYYY-MM-DDTHH:MM:SSZ example: '2017-03-19T16:30:30Z' reason_code: type: string description: Código de retorno. example: '00' reason_message: type: string description: Mensagem de retorno. example: transaction approved maxLength: 250 acquirer: type: string description: Nome do adquirente. example: GETNET maxLength: 30 soft_descriptor: $ref: '#/definitions/soft_descriptor_global' brand: type: string description: Bandeira. (Utilizado também no antifraude). Obrigatório caso os dados de cartão não foram armazenados permanentemente com o token. example: Mastercard enum: - Mastercard - Visa - Amex - Elo - Hipercard maxLength: 50 terminal_nsu: type: string description: Código de Autorização gerado pelo Emissor quando a transação é realizada com sucesso. example: '006090' acquirer_transaction_id: type: string description: Código do adquirente da transação original. example: '113880914' transaction_id: type: string description: Código de transação. example: '1002217281190421' qrcode_payment_response_debit: type: object description: | Conjunto de dados do pagamento.
Retorno exlcusivo para transações de Débito. properties: authorization_code: type: string description: Número de autorização gerado pelo sistema de verificação de cartão. example: '6964722471672911' authorized_at: type: number description: Data/hora da autorização de crédito. format: YYYY-MM-DDTHH:MM:SSZ example: '2017-03-19T16:30:30Z' reason_code: type: string description: Código de retorno. example: '00' reason_message: type: string description: Mensagem de retorno. example: transaction approved maxLength: 250 acquirer: type: string description: Nome do adquirente. example: GETNET maxLength: 30 soft_descriptor: $ref: '#/definitions/soft_descriptor_global' brand: type: string description: Bandeira. (Utilizado também no antifraude). Obrigatório caso os dados de cartão não foram armazenados permanentemente com o token. example: Mastercard enum: - Mastercard - Visa - Amex - Elo - Hipercard maxLength: 50 terminal_nsu: type: string description: Código de Autorização gerado pelo Emissor quando a transação é realizada com sucesso. example: '006090' acquirer_transaction_id: type: string description: Código do adquirente da transação original. example: '113880914' transaction_id: type: string description: Código de transação. example: '1002217281190421' cancel_request: type: object description: Conjunto de dados para solicitação de cancelamento. required: - payment_id - cancel_amount properties: payment_id: type: string description: Código de identificação do pagamento da transação original. example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 cancel_amount: description: Valor da solicitação de cancelamento. Pode ser igual ou menor ao valor da transação original. type: integer example: 19990 cancel_custom_key: description: Chave do cliente utilizada para identificar uma solicitação de cancelamento. (Chave deve ser única por transação). type: string example: 4ec33ee18f9e45bfb73c5c30667f9006 minLength: 3 maxLength: 32 combine_cancel_response: type: object description: Conjunto de dados da solicitação de cancelamento do pagamento combinado. properties: seller_id: description: Código de identificação do e-commerce. type: string format: uuidv4 minLength: 36 maxLength: 36 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 combined_id: description: Código de identificação do pagamento combinado. type: string format: uuidv4 minLength: 36 maxLength: 36 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 order_id: description: Código de identificação da compra utilizado pelo e-commerce. type: string payments: type: array items: $ref: '#/definitions/combined_cancel_dn_response_detail' cancel_request_response: type: object description: Conjunto de dados da solicitação de cancelamento. properties: seller_id: description: Código de identificação do e-commerce. type: string format: uuidv4 minLength: 36 maxLength: 36 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 payment_id: type: string description: Código de identificação do pagamento da transação original. example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 cancel_request_at: type: string description: Data da solicitação de cancelamento. format: YYYY-MM-DDTHH:MM:SSZ example: '2017-11-16T16:30:30Z' cancel_request_id: description: Identificador do request de cancelamento. type: string example: '20171117084237501' minLength: 18 maxLength: 18 cancel_custom_key: description: Chave do cliente utilizada para identificar uma solicitação de cancelamento. (Chave deve ser única por transação). type: string example: 4ec33ee18f9e45bfb73c5c30667f9006 maxLength: 32 status: description: Status da transação aceita ou negada. Para mais informações sobre os status de retorno, veja em Notificações 1.0 ou Notificações 1.1 type: string enum: - ACCEPTED - DENIED example: ACCEPTED cancel_query_response: type: object description: Conjunto de dados da solicitação de cancelamento. properties: seller_id: description: Código de identificação do e-commerce. type: string format: uuidv4 minLength: 36 maxLength: 36 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 payment_id: type: string description: Código de identificação do pagamento da transação original. example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 cancel_request_at: type: string description: Data da solicitação de cancelamento. format: YYYY-MM-DDTHH:MM:SSZ example: '2017-11-16T16:30:30Z' cancel_request_id: description: Identificador do request de cancelamento. type: string example: '20171117084237501' minLength: 18 maxLength: 18 cancel_custom_key: description: Chave do cliente utilizada para identificar uma solicitação de cancelamento. (Chave deve ser única por transação). type: string example: 4ec33ee18f9e45bfb73c5c30667f9006 maxLength: 32 terminal_nsu: type: string description: Código de Autorização gerado pelo Emissor quando a transação é realizada com sucesso. example: '006090' acquirer_transaction_id: type: string description: Código do adquirente da transação original. example: '113880914' transaction_date: type: string description: Data da transação original. example: '17052017' format: DDMMAAAA minLength: 8 maxLength: 8 currency: description: Identificação da moeda da transação original (Consultar código em "https://www.currency-iso.org/en/home/tables/table-a1.html"). type: string minLength: 3 maxLength: 3 example: BRL transaction_type: description: Tipo da transação original. V = Pagamento à vista (FULL) e P = parcelado (INSTALLMENT). type: string enum: - V - P example: FULL number_installments: description: Número de parcelas da transação original. type: integer example: 1 amount: description: Valor da transação original. type: integer example: 19990 cancel_amount: description: Valor da solicitação de cancelamento. type: integer example: 19990 status_processing_cancel_code: description: Código do status da solicitação de cancelamento. Para mais detalhes olhar a Tabela de Códigos de Retornos do Cancelamento D+n type: string example: '100' status_processing_cancel_message: description: Mensagem do status da solicitação de cancelamento. type: string example: SOLICITACAO EM ANDAMENTO credit_confirm: type: object description: Conjunto de dados para confirmação de crédito tardio e pré autorizado. properties: amount: description: Valor de confirmação. Pode ser igual ou menor que o valor original da transação. Caso não seja informado, será acatado o valor original da transação. type: integer example: 19990 soft_descriptor_global: type: string maxLength: 22 description: 'Texto exibido na fatura do cartão do comprador, Este campo é opcional, não sendo informado nada, será considerado o nome fantasia cadastrado para o estabelecimento.É permitido neste campo somente dados alfanuméricos e os seguintes caracteres especiais: % $ , . / & ( ) + = < > - * Espaços serão substituídos pelo caracter ''*'' A transação não será negada se forem enviados caracteres no permitidos. Qualquer informação que exceda o tamanho máximo será desconsiderada.' example: LOJA*TESTE*COMPRA-123 soft_descriptor_global_sub_merchant: type: string maxLength: 22 description: | Texto exibido na fatura do cartão do comprador, este campo é opcional, não sendo informado nada, será considerado o nome fantasia cadastrado para o estabelecimento. É permitido neste campo somente dados alfanuméricos e os seguintes caracteres especiais: % $ , . / & ( ) + = < > - * Espaços serão substituídos pelo caracter '*' A transação não será negada se forem enviados caracteres no permitidos. Qualquer informação que exceda o tamanho máximo será desconsiderada. Obrigatório para Facilitadores de Pagamento. Além do descrito acima, deve seguir as seguintes regras adicionais das Bandeiras:

Identificação do Facilitador de Pagamentos, com 3, 7 ou 12 caracteres
Caracteres de separação "*" (asterisco)
Identificação do subcomércio
Exemplo 1: FAC*SUCOMERCIO
Exemplo 2: FACILIT*SUBCOMERCIO
Exemplo 3: FACILITADOR1*SUBCOMERC

example: LOJA*TESTE*COMPRA-123 dynamic_mcc: type: number maxLength: 4 minLength: 4 description: Campo utilizado para sinalizar a transação com outro Merchant Category Code (Código da Categoria do Estabelecimento) diferente do cadastrado. Caso seja enviado um MCC inválido, será utilizado o padrão. Enviar somente dados numéricos. example: 1799 dynamic_mcc_sub_merchant: type: number maxLength: 4 minLength: 4 description: | Campo utilizado para sinalizar a transação com outro Merchant Category Code (Código da Categoria do Estabelecimento) diferente do cadastrado. Caso seja enviado um MCC inválido, será utilizado o padrão. Enviar somente dados numéricos.

Obrigatório para Facilitadores de Pagamento e SDWO example: 1799 credit_preauthorized_adjustment: type: object required: - amount - currency description: Conjunto de dados para ajuste de valor de Pré-Autorização. properties: amount: type: integer description: Valor do ajuste de Pré-Autorização. example: 19990 currency: type: string description: Identificação da moeda da transação original (Consultar código em "https://www.currency-iso.org/en/home/tables/table-a1.html"). minLength: 3 maxLength: 3 example: BRL soft_descriptor: $ref: '#/definitions/soft_descriptor_global' dynamic_mcc: $ref: '#/definitions/dynamic_mcc' credit_preauthorized_adjustment_response: type: object description: Conjunto de dados da resposta do ajuste de valor de Pré-Autorização. properties: payment_id: type: string description: Código de identificação do pagamento. format: uuidv4 example: 06f256c8-1bbf-42bf-93b4-ce2041bfb87e minLength: 36 maxLength: 36 seller_id: type: string description: Código de identificação do e-commerce. format: uuidv4 example: 6eb2412c-165a-41cd-b1d9-76c575d70a28 minLength: 36 maxLength: 36 amount: type: integer description: Valor ajustado em centavos. example: 19990 currency: type: string description: Identificação da moeda (Consultar código em "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 order_id: type: string description: Código de identificação da compra utilizado pelo e-commerce example: 6d2e4380-d8a3-4ccb-9138-c289182818a3 maxLength: 36 status: type: string description: Status da transação. Para mais informações sobre os status de retorno, veja em Notificações 1.0 ou Notificações 1.1 example: APPROVED enum: - APPROVED - DENIED maxLength: 20 authorization_code: type: string description: Código da autorização de crédito example: '504115596011102460' maxLength: 20 authorized_at: type: number description: Data/hora da autorização de crédito. format: YYYY-MM-DDTHH:MM:SSZ example: '2017-03-19T16:30:30Z' maxLength: 24 reason_code: type: string description: Código de retorno. example: '00' minLength: 1 maxLength: 5 reason_message: type: string description: Mensagem de retorno. example: transaction approved maxLength: 250 acquirer: type: string description: Nome do adquirente. example: GETNET maxLength: 30 soft_descriptor: type: string description: Descrição para a fatura do cartão. example: Descrição para fatura maxLength: 22 terminal_nsu: type: string description: Código de Autorização gerado pelo Emissor quando a transação é realizada com sucesso. example: '006090' acquirer_transaction_id: type: string description: Código de transação do adquirente. example: '160453221' maxLength: 20 adjustment_acquirer_transaction_id: type: string description: Código de transação de ajuste do adquirente. example: '160453231' maxLength: 20 payment_combined: type: object description: Conjunto de dados referentes a transação de pagamento required: - amount - payments - order - customer properties: amount: type: integer description: Valor total da compra em centavos. example: 10000 dynamic_mcc: $ref: '#/definitions/dynamic_mcc' order: $ref: '#/definitions/order' customer: $ref: '#/definitions/customer_credit' device: $ref: '#/definitions/device_credit' shippings: type: array items: $ref: '#/definitions/shipping_credit' payments: type: array items: $ref: '#/definitions/combined_payments' payment_combined_cancel: type: object description: Conjunto de dados para solicitação de cancelamento de pagamento combinado. required: - payments properties: payments: type: array items: $ref: '#/definitions/combined_cancel_dn_request_detail' combined_payments: type: object description: Conjunto de dados referentes ao pagamento combinado required: - type - amount - save_card_data - transaction_type - number_installments - card - payment_tag properties: type: type: string description: Tipo de pagamento enum: - CREDIT example: CREDIT amount: type: integer description: Valor do pagamento em centavos example: 10000 currency: type: string description: Identificação da moeda (Consultar código em "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL minLength: 3 maxLength: 3 save_card_data: type: boolean description: Identifica se o cartão deve ser salvo para futuras compras. example: false transaction_type: type: string description: | Tipo de transação. Pagamento à vista, parcelado sem juros, parcelado com juros. enum: - FULL - INSTALL_NO_INTEREST - INSTALL_WITH_INTEREST example: FULL number_installments: type: number description: Número de parcelas para uma transação de crédito parcelado. example: 1 payment_tag: description: Tag para identificar partes de pagamento do item em mais de um cartão type: string example: pay-1 maxLength: 50 soft_descriptor: $ref: '#/definitions/soft_descriptor_global' card: $ref: '#/definitions/card_credit' credentials_on_file_type: type: string description: |

Tipo do COF (Credential On File).

ONE_CLICK: Usado quando é realizado a primeira transação (parcela) de um pagamento normal.
ONE_CLICK_PAYMENT: Usado quando é realizado transações para as demais parcelas restantes de um pagamento normal. Obs: Necessário informar o transaction_id da primeira transação realizada.
RECURRING: Usado quando é realizado a primeira transação (parcela) de um pagamento recorrente.
RECURRING_PAYMENT: Usado quando é realizado transações para as demais parcelas restantes de um pagamento recorrente. Obs: Necessário informar o transaction_id da primeira transação realizada.

Tipo do COF (Credential On File).

ONE_CLICK: Usado quando é realizado a primeira transação (parcela) de um pagamento normal.
ONE_CLICK_PAYMENT: Usado quando é realizado transações para as demais parcelas restantes de um pagamento normal. Obs: Necessário informar o transaction_id da primeira transação realizada.
RECURRING: Usado quando é realizado a primeira transação (parcela) de um pagamento recorrente.
RECURRING_PAYMENT: Usado quando é realizado transações para as demais parcelas restantes de um pagamento recorrente. Obs: Necessário informar o transaction_id da primeira transação realizada.

Link de Pagamento | Plataforma Digital