openapi: 3.0.1 info: title: Referência da API | Plataforma Digital description: > # Introdução Este manual visa auxiliar o desenvolvedor que irá consumir a api de Pagamento da Plataforma Digital. version: 1.0.9 servers: - url: https://api-homologacao.getnet.com.br/ tags: - name: Consulta 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. - name: Criptografia description: > Use o serviço **/v1/keys** para obter a chave pública para criptografar os dados de pagamento e verificação do cartão. **Formato de chave**: formato X509 SubjectKeyInfo PEM em Base64 codificado O atributo crypted_data deve ser um JWE válido (verifique [jwt.io](https://jwt.io) para mais informações e bibliotecas verificadas). Oferecemos suporte a RSA para criptografia e algoritmos de criptografia simétrica (conteúdo) A256CBC-HS512 e A128CBC-HS256. Este modelo de criptografia é usado para as cargas dos endpoints da API **/v1/payments** e **/v1/verifycard** Para contratar o serviço ou outras dúvidas, entre em contato com a equipe Getnet: ***produtos_digitais@getnet.com.br*** - name: 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 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 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: Verificação de Cartão description: > Verifica se o cartão de crédito informado pelo portador é um cartão válido. - name: 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: Autenticação 3DS description: > Para efetuar transações relacionadas a autenticação 3DS utilize os endpoints descritos abaixo mediante autenticação OAuth2. - name: Pagamento description: '' - name: Pix description: '' - name: 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 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 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 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. paths: /auth/oauth/v2/token: post: tags: - Autenticação summary: Gera 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 operationId: post-auth-oauth-v2-token parameters: - name: Content-Type in: header description: application/x-www-form-urlencoded required: true schema: type: string - name: Authorization in: header 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= required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: required: - grant_type - scope properties: scope: type: string description: Usar o valor fixo "oob" example: "oob" grant_type: type: string description: Usar O valor fixo "client_credentials" example: "client_credentials" required: true responses: '200': description: Retorna o token de acesso content: application/json: schema: $ref: '#/components/schemas/AuthOauthV2TokenResponse' '400': description: Requisição inválida content: application/json: schema: $ref: '#/components/schemas/errorOAuth' '401': description: Não autorizado content: application/json: schema: $ref: '#/components/schemas/errorOAuth' deprecated: false /v1/cards/verification: post: tags: - Verificação de Cartão 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 de crédito válido um cartão que não está cancelado, bloqueado ou com restrições. operationId: post-v1-verification parameters: - name: Content-Type in: header description: application/json required: true schema: type: string - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: > Código de identificação do e-commerce. ***Obrigatório quando o cliente for tratado como Plataforma.*** required: false schema: type: string requestBody: description: Request de verificação de cartão. content: application/json: schema: $ref: '#/components/schemas/verify_request' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/verify_response' '400': description: Requisição inválida content: application/json: schema: $ref: '#/components/schemas/badRequestVerify' '401': description: Autenticação inválida content: application/json: schema: $ref: '#/components/schemas/unauthorized' '500': description: Erro interno do servidor ou serviço content: application/json: schema: $ref: '#/components/schemas/internalServerError' deprecated: false x-codegen-request-body-name: body /v2/payments: post: tags: - Pagamento summary: Autorização description: Realizar pagamento ou autorização de pagamento. operationId: payment_1 parameters: - name: Content-Type in: header description: Tipo do conteúdo. required: true schema: type: string default: application/json; charset=utf-8 enum: - application/json; charset=utf-8 - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentDTO' required: true responses: '200': description: Transação executada com sucesso. content: application/json: schema: $ref: '#/components/schemas/AutorizationResponseDTO' '400': description: Invalid Requisition content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '401': description: Invalid Authentication content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Unauthorized name: Module or service that returned the error status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: Unauthorized description_detail: Invalid client credentials '403': description: Product not Enable content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Forbidden name: Module or service that returned the error status_code: 403 details: - status: DENIED error_code: CONFIG-403 description: Forbidden description_detail: Product not enabled '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Not Found name: Module or service that returned the error status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: Not Found description_detail: card_id Not Found '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Unprocessable Entity name: Module or service that returned the error status_code: 422 details: - status: DENIED error_code: Error code description: Unprocessable Entity description_detail: Detailed error description '429': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Bad Request name: Module or service that returned the error status_code: 429 details: - status: DENIED error_code: Error code description: Too Many Requests description_detail: Detailed error description '500': description: Internal server or service error content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. '503': description: Internal server or service error content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Service Unavailable name: Module or service that returned the error status_code: 503 details: - status: ERROR error_code: GENERIC-503 description: Service Unavailable description_detail: The server encountered an unexpected error. '504': description: Gateway Timeout content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Gateway Timeout name: Module or service that returned the error status_code: 504 details: - status: ERROR error_code: GENERIC-504 description: Gateway Timeout description_detail: The server encountered an unexpected error. patch: tags: - Pagamento summary: Ajuste description: > Realizar o ajuste de uma autorização. disponível apenas para transações com o método de pagamento **CREDIT_PRE_AUTHORIZATION** operationId: adjustment_1 parameters: - name: Content-Type in: header description: Tipo do conteúdo. required: true schema: type: string default: application/json; charset=utf-8 enum: - application/json; charset=utf-8 - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentAdjustmentDTO' required: true responses: '200': description: Transação executada com sucesso. content: application/json: schema: $ref: '#/components/schemas/PreAutorizationResponseDTO' '400': description: Invalid Requisition content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '401': description: Invalid Authentication content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Unauthorized name: Module or service that returned the error status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: Unauthorized description_detail: Invalid client credentials '403': description: Product not Enable content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Forbidden name: Module or service that returned the error status_code: 403 details: - status: DENIED error_code: CONFIG-403 description: Forbidden description_detail: Product not enabled '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Not Found name: Module or service that returned the error status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: Not Found description_detail: card_id Not Found '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Unprocessable Entity name: Module or service that returned the error status_code: 422 details: - status: DENIED error_code: Error code description: Unprocessable Entity description_detail: Detailed error description '429': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Bad Request name: Module or service that returned the error status_code: 429 details: - status: DENIED error_code: Error code description: Too Many Requests description_detail: Detailed error description '500': description: Internal server or service error content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. '503': description: Internal server or service error content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Service Unavailable name: Module or service that returned the error status_code: 503 details: - status: ERROR error_code: GENERIC-503 description: Service Unavailable description_detail: The server encountered an unexpected error. '504': description: Gateway Timeout content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Gateway Timeout name: Module or service that returned the error status_code: 504 details: - status: ERROR error_code: GENERIC-504 description: Gateway Timeout description_detail: The server encountered an unexpected error. /v2/payments/capture: post: tags: - Pagamento summary: Captura description: Captura uma transação autorizada. operationId: capture_3 parameters: - name: Content-Type in: header description: Tipo do conteúdo. required: true schema: type: string default: application/json; charset=utf-8 enum: - application/json; charset=utf-8 - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CapturetDTO' required: true responses: '200': description: Transação executada com sucesso. content: application/json: schema: $ref: '#/components/schemas/CaptureResponseDTO' '400': description: Invalid Requisition content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '401': description: Invalid Authentication content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Unauthorized name: Module or service that returned the error status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: Unauthorized description_detail: Invalid client credentials '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Not Found name: Module or service that returned the error status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: Not Found description_detail: card_id Not Found '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Unprocessable Entity name: Module or service that returned the error status_code: 422 details: - status: DENIED error_code: Error code description: Unprocessable Entity description_detail: Detailed error description '429': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Bad Request name: Module or service that returned the error status_code: 429 details: - status: DENIED error_code: Error code description: Too Many Requests description_detail: Detailed error description '500': description: Internal server or service error content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. '503': description: Internal server or service error content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Service Unavailable name: Module or service that returned the error status_code: 503 details: - status: ERROR error_code: GENERIC-503 description: Service Unavailable description_detail: The server encountered an unexpected error. '504': description: Gateway Timeout content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Gateway Timeout name: Module or service that returned the error status_code: 504 details: - status: ERROR error_code: GENERIC-504 description: Gateway Timeout description_detail: The server encountered an unexpected error. /v2/payments/cancel: post: tags: - Pagamento summary: Cancelamento description: > Cancela uma transação realizada. Caso a solicitação de cancelamento seja feita no **mesmo dia (D0)** que a transação (estorno), **é permitido apenas o estorno do valor total**. Caso a solicitação de cancelamento seja feita **a partir do dia seguinte (D+N)** que a transação (cancelamento), **é permitido o cancelamento do valor parcial ou total**. Neste último caso, é necessário apenas o preenchimento do campo amount com o valor que deseja cancelar. Caso o campo não seja preenchido, a transação será cancelada no valor total. operationId: cancel_5 parameters: - name: Content-Type in: header description: Tipo do conteúdo. required: true schema: type: string default: application/json; charset=utf-8 enum: - application/json; charset=utf-8 - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CancelDTO' required: true responses: '200': description: Transação executada com sucesso. content: application/json: schema: $ref: '#/components/schemas/CancelResponseDTO' '400': description: Invalid Requisition content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '401': description: Invalid Authentication content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Unauthorized name: Module or service that returned the error status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: Unauthorized description_detail: Invalid client credentials '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Not Found name: Module or service that returned the error status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: Not Found description_detail: card_id Not Found '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Unprocessable Entity name: Module or service that returned the error status_code: 422 details: - status: DENIED error_code: Error code description: Unprocessable Entity description_detail: Detailed error description '429': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Bad Request name: Module or service that returned the error status_code: 429 details: - status: DENIED error_code: Error code description: Too Many Requests description_detail: Detailed error description '500': description: Internal server or service error content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. '503': description: Internal server or service error content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Service Unavailable name: Module or service that returned the error status_code: 503 details: - status: ERROR error_code: GENERIC-503 description: Service Unavailable description_detail: The server encountered an unexpected error. '504': description: Gateway Timeout content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Gateway Timeout name: Module or service that returned the error status_code: 504 details: - status: ERROR error_code: GENERIC-504 description: Gateway Timeout description_detail: The server encountered an unexpected error. /v2/payments/{paymentId}/release: post: tags: - Pagamento summary: Release description: Release do pagamento capturado. operationId: release parameters: - name: Content-Type in: header description: Tipo do conteúdo. required: true schema: type: string default: application/json; charset=utf-8 enum: - application/json; charset=utf-8 - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: paymentId in: path required: true description: Código de identificação do pagamento. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ReleaseDTO' required: true responses: '200': description: Transação executada com sucesso. content: application/json: schema: $ref: '#/components/schemas/releaseResponse' '400': description: Invalid Requisition content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Bad Request name: Module or service that returned the error status_code: 400 details: - status: DENIED error_code: Error code description: Bad Request description_detail: Detailed error description '401': description: Invalid Authentication content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Unauthorized name: Module or service that returned the error status_code: 401 details: - status: DENIED error_code: AUTHENTICATION-401 description: Unauthorized description_detail: Invalid client credentials '402': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Unprocessable Entity name: Module or service that returned the error status_code: 422 details: - status: DENIED error_code: Error code description: Unprocessable Entity description_detail: Detailed error description '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Not Found name: Module or service that returned the error status_code: 404 details: - status: DENIED error_code: TOKENIZATION-404 description: Not Found description_detail: card_id Not Found '500': description: Internal server or service error content: application/json: schema: $ref: '#/components/schemas/DefaultErrorHttpResponse' example: message: Internal Server Error name: Module or service that returned the error status_code: 500 details: - status: ERROR error_code: GENERIC-500 description: Internal Server Error description_detail: The server encountered an unexpected error. /v2/payments/boleto: post: tags: - Pagamento summary: Registra Boleto 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. #### 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.1](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=uis74ikqfv8v87u3y5prgp68&from=/documentations/jytvcqzffngtur8jix24tvpu) parameters: - name: Content-Type in: header description: Tipo do conteúdo. required: true schema: type: string default: application/json; charset=utf-8 enum: - application/json; charset=utf-8 - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string requestBody: description: Requisição contendo os dados para pagamento com boleto. content: application/json: schema: $ref: '#/components/schemas/payment_boleto_v2' required: true responses: '201': description: Boleto emitido com sucesso. content: application/json: schema: $ref: '#/components/schemas/payment_boleto_response_v2' '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '402': description: > Requisição é válida mas pagamento negado. Pode ser negado por vários motivos / regras de negócios. content: application/json: schema: $ref: '#/components/schemas/error_boleto_402' '404': description: Não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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" } } } }' x-codegen-request-body-name: payment_boleto_v2 /v1/payments/info/{payment_id}: get: summary: Consulta de transações tags: - Pagamento description: Consultar um pagamento por payment_id. operationId: get-v1-payments parameters: - name: Content-Type in: header description: Tipo do conteúdo. required: true schema: type: string default: application/json; charset=utf-8 - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: payment_id in: path description: Identificador do pagamento. required: true schema: type: string format: uuid example: '8719d0c4-2c3f-4360-abd9-8daf3834fe1f' minLength: 36 maxLength: 36 responses: '200': description: OK content: application/json: schema: type: object properties: payment_id: $ref: '#/components/schemas/payment_id' order_id: $ref: '#/components/schemas/order_id' status: $ref: '#/components/schemas/statusInfo' payment: $ref: '#/components/schemas/payment' records: type: array items: $ref: '#/components/schemas/record' '404': description: Não encontrado content: application/json: schema: $ref: '#/components/schemas/notFound' application/xml: schema: type: object properties: {} '500': description: Erro interno ou servidor content: application/json: schema: $ref: '#/components/schemas/internalServerError' '503': description: Serviço indisponível content: application/json: schema: $ref: '#/components/schemas/serviceUnavailable' '504': description: Gateway Timeout content: application/json: schema: $ref: '#/components/schemas/gatewayTimeout' /v1/payments/info/{payment_id}/{idempotency_key}: get: summary: Consulta de operação idempotente de pagamento tags: - Pagamento description: Consulte uma operação idempotente de pagamento por idempotency_key. operationId: get-v1-payment-info-payment_id-component_id parameters: - name: Content-Type in: header description: Tipo do conteúdo. required: true schema: type: string default: application/json; charset=utf-8 - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: payment_id in: path description: ID do pagamento. required: true schema: type: string format: uuid - name: idempotency_key in: path description: ID idempotente da operação. required: true schema: type: string responses: '200': description: OK content: application/json: schema: type: object properties: rel: $ref: '#/components/schemas/rel' idempotency_key: $ref: '#/components/schemas/idempotency_key' registred_at: $ref: '#/components/schemas/registred_at' items: type: array items: type: object properties: registred_at: $ref: '#/components/schemas/registred_at' type: type: string enum: - request - response - result description: Tipo de registro. example: request content: description: Conteúdo do registro. oneOf: - $ref: '#/components/schemas/requestPayment' - $ref: '#/components/schemas/paymentAuthorizationResponse' - $ref: '#/components/schemas/paymentPurchaseResponse' - $ref: '#/components/schemas/paymentCaptureResponse' - $ref: '#/components/schemas/V1PaymentsCaptureRequest' - $ref: '#/components/schemas/V1PaymentsCancelRequest' - $ref: '#/components/schemas/paymentCanceledCancelResponse' - $ref: '#/components/schemas/paymentAcceptedCancelResponse' - $ref: '#/components/schemas/cancelResult' '404': description: Não encontrado content: application/json: schema: $ref: '#/components/schemas/notFound' '500': description: Erro interno do servidor content: application/json: schema: $ref: '#/components/schemas/internalServerError' '503': description: Serviço indisponível content: application/json: schema: $ref: '#/components/schemas/serviceUnavailable' '504': description: Gateway Timeout content: application/json: schema: $ref: '#/components/schemas/gatewayTimeout' /v2/payments/qrcode/pix: post: tags: - Pix summary: Geração de QR Code para pagamento PIX description: > Nesse endpoint serão recebidos dados para pagamento PIX com QR Code. 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ção de PIX](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=uis74ikqfv8v87u3y5prgp68&from=/documentations/jytvcqzffngtur8jix24tvpu#notifica%C3%A7%C3%A3o-de-pix) em [Notificações 1.1](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=uis74ikqfv8v87u3y5prgp68&from=/documentations/jytvcqzffngtur8jix24tvpu#notifica%C3%A7%C3%B5es-1.1). parameters: - name: Content-Type in: header description: Tipo do conteúdo. required: true schema: type: string default: application/json; charset=utf-8 - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: Código de identificação do e-commerce. schema: maxLength: 36 minLength: 36 type: string format: uuid - name: x-qrcode-expiration-time in: header 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. required: false schema: type: number default: 180 maximum: 1800 requestBody: description: Requisição contendo os dados para pagamento com PIX. content: application/json: schema: $ref: '#/components/schemas/pix' responses: '200': description: QR Code gerado com sucesso e aguardando o pagamento. content: application/json: schema: $ref: '#/components/schemas/payment_pix_qrcode' '400': description: Requisição inválida content: application/json: schema: $ref: '#/components/schemas/badRequest' '401': description: Autenticação inválida content: application/json: schema: $ref: '#/components/schemas/unauthorized' '404': description: Não encontrado content: application/json: schema: $ref: '#/components/schemas/paymentNotFound' '500': description: Erro interno do servidor ou serviço content: application/json: schema: $ref: '#/components/schemas/internalServerError' /v1/3ds/tokens: post: tags: - Autenticação 3DS 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. parameters: - name: Content-Type in: header description: Tipo do conteúdo. required: true schema: type: string default: application/json; charset=utf-8 enum: - application/json; charset=utf-8 - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: > Código de identificação do e-commerce. ***Obrigatório quando o cliente for tratado como Plataforma.*** schema: maxLength: 36 minLength: 36 type: string format: uuidv4 requestBody: description: > Dados que identificam a sessão e a compra que está sendo efetuada (Order). content: application/json: schema: $ref: '#/components/schemas/3ds_token' required: true responses: '201': description: > Retorna o token de acesso para sessão de autenticação 3DS junto à GetNet content: application/json: schema: type: object properties: access_token: maxLength: 2000 type: string description: Token de acesso para sessão de autenticação 3DS. example: > eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIzZjczZGQ3MS03NjkyLTQyYTItYjU2Ni1jYmUzMzJkYzU3OTQiLCJpYXQiOjE1NzY2NzI3NDUsImlzcyI6IjVkNzVhYzYxNmZlM2QxMmYxODhmZmQ3YyIsIk9yZ1VuaXRJZCI6IjVkNzRlZDczZTA5MTlmMTk1ODNjMzE5MyIsIlBheWxvYWQiOiJ7XCJvcmRlck51bWJlclwiOlwic3RyaW5nXCIsXCJwYXltZW50SWRcIjpcImRhMGU4ZDkwLTQ0OGMtNGJhMC1iZGUyLTQxN2Q2YTdmZjliOVwiLFwibWVyY2hhbnRJZFwiOlwiMDU0Mzk5MlwiLFwibWVyY2hhbnROYW1lXCI6XCJFQyBUZXN0ZSBIVUIg4oCTIFBBRFJBT1wiLFwiY3VycmVuY3lcIjpcImJybFwiLFwidG90YWxBbW91bnRcIjpcIjEwMDBcIixcImpzVmVyc2lvblwiOlwic3RyaW5nXCIsXCJjbGllbnRDb2RlXCI6XCJzdHJpbmctM2Y3M2RkNzEtNzY5Mi00MmEyLWI1NjYtY2JlMzMyZGM1Nzk0XCIsXCJvdmVycmlkZVBheW1lbnRNZXRob2RcIjpcIjAyXCIsXCJpdGVtc1wiOlt7XCJ0b3RhbEFtb3VudFwiOlwiOTAwXCIsXCJ1bml0UHJpY2VcIjpcIjg5OVwiLFwicXVhbnRpdHlcIjowLFwic2t1XCI6XCJzdHJpbmdcIixcImRlc2NyaXB0aW9uXCI6XCJzdHJpbmdcIixcIm5hbWVcIjpcInN0cmluZ1wifSx7XCJ0b3RhbEFtb3VudFwiOlwiOTAwXCIsXCJ1bml0UHJpY2VcIjpcIjgwMFwiLFwicXVhbnRpdHlcIjowLFwic2t1XCI6XCJzdHJpbmdcIixcImRlc2NyaXB0aW9uXCI6XCJzdHJpbmdcIixcIm5hbWVcIjpcInN0cmluZ1wifV19IiwiT2JqZWN0aWZ5UGF5bG9hZCI6ZmFsc2UsIlJlZmVyZW5jZUlkIjoiM2Y3M2RkNzEtNzY5Mi00MmEyLWI1NjYtY2JlMzMyZGM1Nzk0IiwiZXhwIjoxNTc2NjcyODY1fQ.jrPvIjtvSY6HukI-PjBE0ACWo68whA2FhCCfKeEfB4g token_type: maxLength: 6 minLength: 6 type: string description: Tipo do token. example: bearer expiration_date: maxLength: 23 minLength: 23 type: string description: Data de expiração do token. format: YYYY-MM-DDTHH:mm:ss.SSS example: '2019-09-05T18:54:53.153' '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Acesso negado. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/error' '503': description: Erro servidor ou serviço indisponivel. content: application/json: schema: $ref: '#/components/schemas/error' '504': description: Erro gateway timeout. content: application/json: schema: $ref: '#/components/schemas/error' x-codegen-request-body-name: 3ds_token /v1/3ds/authentications: post: tags: - Autenticação 3DS summary: Solicita a autenticação 3DS description: > Endpoint responsável pela solicitação de autenticação 3DS junto à GetNet. parameters: - name: Content-Type in: header description: Tipo do conteúdo. required: true schema: type: string default: application/json; charset=utf-8 enum: - application/json; charset=utf-8 - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: > Código de identificação do e-commerce. ***Obrigatório quando o cliente for tratado como Plataforma.*** schema: maxLength: 36 minLength: 36 type: string format: uuidv4 requestBody: description: > Dados que identificam a compra que está sendo efetuada (Order), detalhes sobre autenticação, histórico do cliente, dados do cartão. content: application/json: schema: $ref: '#/components/schemas/3ds_authentication' required: true responses: '201': description: Retorna da autenticação 3DS junto à GetNet. content: application/json: schema: type: object properties: card: $ref: '#/components/schemas/3ds_authentications_resp_card_ref' id: maxLength: 26 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: maxLength: 20 type: string description: | Hora da solicitação em UTC. format: YYYY-MM-DDThh:mm:ssZ example: '2019-12-18T17:46:02.000Z' status: maxLength: 25 type: string description: | Status da solicitação de autenticação 3DS. example: AUTHENTICATION_SUCCESSFUL enum: - AUTHENTICATION_SUCCESSFUL - PENDING_AUTHENTICATION - AUTHENTICATION_FAILED client_reference_information: $ref: '#/components/schemas/3ds_authentications_resp_client_reference_information_ref' consumer_authentication_information: $ref: '#/components/schemas/3ds_authentications_resp_consumer_authentication_information_ref' error_information: $ref: '#/components/schemas/3ds_authentications_resp_error_information_ref' reference_id: maxLength: 36 type: string description: | Número de referência gerado pelo 3DS Getnet 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. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Acesso negado. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/error' '503': description: Erro servidor ou serviço indisponivel. content: application/json: schema: $ref: '#/components/schemas/error' '504': description: Erro gateway timeout. content: application/json: schema: $ref: '#/components/schemas/error' x-codegen-request-body-name: 3ds_authentication /v1/3ds/authentications/results: post: tags: - Autenticação 3DS summary: Solicita resultado da autenticação 3DS description: > Endpoint responsável pela solicitação do resultado da autenticação 3DS junto à GetNet. parameters: - name: Content-Type in: header description: | Tipo do conteúdo. required: true schema: type: string default: application/json; charset=utf-8 enum: - application/json; charset=utf-8 - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: > Código de identificação do e-commerce. ***Obrigatório quando o cliente for tratado como Plataforma.*** schema: maxLength: 36 minLength: 36 type: string format: uuidv4 requestBody: content: application/json: schema: $ref: '#/components/schemas/3ds_results_ref' required: false responses: '201': description: Retorna resultado da autenticação 3DS junto à GetNet. content: application/json: schema: type: object properties: card: $ref: '#/components/schemas/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: maxLength: 25 type: string description: | Status da solicitação de autenticação 3DS. example: AUTHENTICATION_SUCCESSFUL enum: - AUTHENTICATION_SUCCESSFUL - PENDING_AUTHENTICATION - AUTHENTICATION_FAILED client_reference_information: $ref: '#/components/schemas/3ds_authentications_resp_client_reference_information_ref' consumer_authentication_information: $ref: '#/components/schemas/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. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Acesso negado. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/error' '503': description: Erro servidor ou serviço indisponivel. content: application/json: schema: $ref: '#/components/schemas/error' '504': description: Erro gateway timeout. content: application/json: schema: $ref: '#/components/schemas/error' x-codegen-request-body-name: body /v1/tokens/card: post: tags: - Tokenização PCI 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. parameters: - name: Content-Type in: header description: Tipo do conteúdo. required: true schema: type: string default: application/json; charset=utf-8 enum: - application/json; charset=utf-8 - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: > Código de identificação do e-commerce. ***Obrigatório quando o cliente for tratado como Plataforma.*** schema: maxLength: 36 minLength: 36 type: string format: uuidv4 requestBody: description: Dados do cartão e do comprador content: application/json: schema: required: - card_number type: object properties: card_number: maxLength: 19 minLength: 13 type: string description: Número do cartão example: '5155901222280001' customer_id: maxLength: 100 type: string description: > Identificador do comprador. Informação definida pela aplicação que consome a api da Plataforma Digital. example: 'customer_21081826' required: false responses: '201': description: Retorna o token do cartão. content: application/json: schema: type: object properties: number_token: maxLength: 128 minLength: 128 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](https://www.ietf.org/rfc/rfc2616.txt)) 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 '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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" }' x-codegen-request-body-name: token_card /v1/tokenization/token: post: tags: - Tokenização Bandeira 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. parameters: - name: Content-Type in: header description: Tipo do conteúdo. required: true schema: type: string default: application/json; charset=utf-8 enum: - application/json; charset=utf-8 - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string requestBody: description: Dados do cartão e do comprador content: application/json: schema: required: - customer_id (cpf ou identificador unico) - card_pan - card_pan_source - card_brand - expiration_year - expiration_month - email type: object 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) ou 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: '2030' expiration_month: type: string description: Mês de expiração. format: string example: '12' security_code: type: string description: cvv. format: string example: '1234' email: type: string description: Email do comprador. format: email example: tokenizacao_bandeira@getnet.com.br responses: '200': description: Retorna o token do cartão. content: application/json: 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. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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: '2030' }' /v1/tokenization/crypt: post: tags: - Tokenização Bandeira 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. parameters: - name: Content-Type in: header description: Tipo do conteúdo. required: true schema: type: string default: application/json; charset=utf-8 enum: - application/json; charset=utf-8 - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string requestBody: description: Dados do cartão e do comprador content: application/json: schema: required: - network_token_id - transaction_type - cryptogram_type - amount - customer_id - email - card_brand type: object 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 required: false responses: '200': description: Retorna o token do cartão. content: application/json: 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: '12' token_expiration_year: type: string description: Novo ano de expiração do pan tokenizado. example: '2030' token_status: type: string description: Criptograma do cartão que será utilizado nas transações. example: ACTIVE '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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: "12", token_expiration_year: "2030", token_status: "ACTIVE" }' x-codegen-request-body-name: token_card /v1/customers: post: tags: - Clientes summary: Cadastra um novo cliente description: > Neste endpoint você pode cadastrar os dados de um novo cliente para recorrência. parameters: - name: Content-Type in: header description: Tipo do conteúdo. required: true schema: type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: Código de identificação do e-commerce. required: true schema: type: string minLength: 36 maxLength: 36 format: uuidv4 - name: username in: header description: > Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. required: false schema: type: string requestBody: description: Requisição contendo os dados para cadastro de um novo cliente. content: application/json: schema: $ref: '#/components/schemas/customer_info' responses: '200': description: Cadastro do cliente realizado com sucesso content: application/json: schema: $ref: '#/components/schemas/customer_info_response' '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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: tags: - Clientes summary: Lista dos clientes description: > Neste endpoint você pode listar todos os clientes previamente cadastrados com base nos filtros escolhidos. parameters: - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: Código de identificação do e-commerce. required: true schema: type: string format: uuidv4 minLength: 36 maxLength: 36 - name: page in: query description: Número da página em que inicia a paginação. required: true schema: type: number minimum: 1 - name: limit in: query description: Limite de resultados por página. required: true schema: minimum: 0 maximum: 9999 type: number - name: customer_id in: query description: Identificador do comprador. required: false schema: type: string maxLength: 100 - name: document_number in: query description: Número do documento do comprador. required: false schema: minLength: 11 maxLength: 15 type: string - name: first_name in: query description: Primeiro nome do comprador. required: false schema: maxLength: 40 type: string - name: last_name in: query description: Último nome do comprador. required: false schema: maxLength: 80 type: string - name: sort in: query description: Campo para realizar a ordenação. required: false schema: default: last_name type: string - name: sort_type in: query description: Tipo de ordenação. Ascendente ou Descendente. required: false schema: enum: - asc - desc type: string responses: '200': description: Lista de clientes cadastrados. content: application/json: schema: $ref: '#/components/schemas/customer_filter_response' '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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: tags: - Clientes summary: Retorna um cliente description: > Neste endpoint você pode buscar os dados de um cliente específico, previamente cadastrado. parameters: - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: Código de identificação do e-commerce. required: true schema: format: uuidv4 minLength: 36 maxLength: 36 type: string - name: customer_id in: path description: Identificador do comprador. required: true schema: type: string maxLength: 100 responses: '200': description: Retorna os dados do cliente. content: application/json: schema: $ref: '#/components/schemas/customer_info' '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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: tags: - Planos summary: Cadastra um novo plano description: Neste endpoint você pode criar um plano de recorrência. parameters: - name: Content-Type in: header description: Tipo do conteúdo. required: true schema: enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: Código de identificação do e-commerce. required: true schema: format: uuidv4 minLength: 36 maxLength: 36 type: string - name: username in: header description: > Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. required: false schema: type: string requestBody: description: Requisição contendo os dados para cadastro de um novo plano. content: application/json: schema: $ref: '#/components/schemas/plan' responses: '200': description: Cadastro de plano realizado com sucesso content: application/json: schema: $ref: '#/components/schemas/plan_response' '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Produto recorrência não habilitado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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: tags: - Planos summary: Lista de planos description: > Neste endpoint você pode listar os planos previamente cadastrados com base nos filtros escolhidos. parameters: - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: Código de identificação do e-commerce. required: true schema: format: uuidv4 minLength: 36 maxLength: 36 type: string - name: page in: query description: Número da página em que inicia a paginação. required: true schema: minimum: 1 type: number - name: limit in: query description: Limite de resultados por página. required: true schema: minimum: 0 maximum: 9999 type: number - name: plan_id in: query description: Identificador do plano. required: false schema: minLength: 36 maxLength: 36 format: uuidv4 type: string - name: status in: query description: Status do plano. required: false schema: default: active enum: - active - inactive type: string - name: name in: query description: Nome do plano. required: false schema: minLength: 3 type: string - name: sort in: query description: Campo para realizar a ordenação. required: false schema: default: name type: string - name: sort_type in: query description: Tipo de ordenação. Ascendente ou Descendente. required: false schema: enum: - asc - desc type: string - name: expand in: query 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. required: false schema: type: array items: type: string responses: '200': description: Lista de planos cadastrados. content: application/json: schema: $ref: '#/components/schemas/plan_filter_response' '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Produto recorrência não habilitado. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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: tags: - Planos summary: Retorna um plano description: > Neste endpoint você pode buscar os dados de um plano específico, previamente cadastrado. parameters: - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: Código de identificação do e-commerce. required: true schema: format: uuidv4 minLength: 36 maxLength: 36 type: string - name: plan_id in: path description: Identificador do plano. required: true schema: minLength: 36 maxLength: 36 format: uuidv4 type: string - name: expand in: query 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. required: false schema: type: array items: type: string responses: '200': description: Retorna os dados do plano. content: application/json: schema: $ref: '#/components/schemas/plan_response' '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Produto recorrência não habilitado. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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: tags: - Planos 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. parameters: - name: Content-Type in: header description: Tipo do conteúdo. required: true schema: enum: - application/json; charset=utf-8 type: string default: application/json; charset=utf-8 - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: Código de identificação do e-commerce. required: true schema: type: string format: uuidv4 minLength: 36 maxLength: 36 - name: username in: header description: > Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. required: false schema: type: string - name: plan_id in: path description: Identificador do plano. required: true schema: minLength: 36 maxLength: 36 format: uuid type: string requestBody: description: Conjunto de dados do plano a ser atualizado. content: application/json: schema: $ref: '#/components/schemas/plan_update' responses: '200': description: Retorna o plano atualizado. content: application/json: schema: $ref: '#/components/schemas/plan_response' '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Produto recorrência não habilitado. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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 parameters: - name: Content-Type in: header description: Tipo do conteúdo. required: true schema: type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: Código de identificação do e-commerce. required: true schema: format: uuidv4 minLength: 36 maxLength: 36 type: string - name: username in: header description: > Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. required: false schema: type: string - name: plan_id in: path description: Identificador do plano. required: true schema: minLength: 36 maxLength: 36 format: uuidv4 type: string - name: status in: path description: Status do plano. required: true schema: type: string enum: - active - inactive responses: '200': description: Retorna os dados do plano. content: application/json: schema: $ref: '#/components/schemas/plan_response' '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Produto recorrência não habilitado. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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 para uma lista de Assinaturas, ou ainda, solicitar a alteração do Plano de todas as Assinaturas de um Plano origem para um Plano destino. tags: - Planos parameters: - name: Content-Type in: header description: Tipo do conteúdo. required: true schema: type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header required: true description: Código de identificação do e-commerce. schema: format: uuidv4 minLength: 36 maxLength: 36 type: string - name: username in: header description: > Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. required: false schema: type: string requestBody: description: > Aqui serão informados os identificadores dos Planos de origem e Plano de 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). content: application/json: schema: $ref: '#/components/schemas/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. content: application/json: schema: $ref: '#/components/schemas/subscription_plan_migration' '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Produto recorrência não habilitado. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/error' '503': description: Serviço indisponível. content: application/json: schema: $ref: '#/components/schemas/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 parameters: - name: Content-Type in: header description: Tipo do conteúdo. required: true schema: enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: Código de identificação do e-commerce. required: true schema: type: string format: uuidv4 minLength: 36 maxLength: 36 - name: username in: header description: > Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. required: false schema: type: string requestBody: description: Requisição contendo os dados para cadastro de uma nova assinatura. content: application/json: schema: $ref: '#/components/schemas/subscription' responses: '201': description: Assinatura criada com sucesso. content: application/json: schema: $ref: '#/components/schemas/subscription_response' '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Produto recorrência não habilitado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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": "30", "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 parameters: - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: Código de identificação do e-commerce. required: true schema: type: string format: uuidv4 minLength: 36 maxLength: 36 - name: page in: query description: Número da página em que inicia a paginação. required: true schema: minimum: 1 type: number - name: limit in: query description: Limite de resultados por página. required: true schema: minimum: 0 maximum: 9999 type: number - name: customer_id in: query description: Identificador do comprador. required: false schema: type: string maxLength: 100 - name: plan_id in: query description: Identificador do plano de recorrência. required: false schema: type: string minLength: 36 maxLength: 36 format: uuidv4 - name: subscription_id in: query description: Identificador da assinatura de recorrência. required: false schema: minLength: 36 maxLength: 36 format: uuidv4 type: string - name: next_scheduled_date[start] in: query description: Data inicial do próximo agendamento. required: false schema: type: string - name: next_scheduled_date[end] in: query description: Data final do próximo agendamento. required: false schema: type: string - name: create_date[start] in: query description: Data inicial de criação da assinatura. required: false schema: type: string - name: create_date[end] in: query description: Data final de criação da assinatura. required: false schema: type: string - name: end_date[start] in: query description: Data inicial da assinatura. required: false schema: type: string - name: end_date[end] in: query description: Data final da assinatura. required: false schema: type: string - name: sort in: query description: Campo para realizar a ordenação. required: false schema: default: create_date enum: - order_id - create_date - end_date type: string - name: sort_type in: query description: Tipo de ordenação. Ascendente ou Descendente. required: false schema: default: asc enum: - asc - desc type: string - name: status in: query description: Status da assinatura. required: false schema: enum: - processing - canceled - success - delayed - expired type: string - name: expand in: query 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. required: false schema: type: array items: type: string responses: '200': description: Lista retornada com sucesso. content: application/json: schema: $ref: '#/components/schemas/subscription_filter_response' '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Produto recorrência não habilitado. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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 parameters: - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: Código de identificação do e-commerce. required: true schema: type: string format: uuidv4 minLength: 36 maxLength: 36 - name: subscription_id in: path description: Identificador da assinatura de recorrência. required: true schema: type: string minLength: 36 maxLength: 36 format: uuidv4 - name: expand in: query 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. required: false schema: type: array items: type: string responses: '200': description: Assinatura retornada com sucesso. content: application/json: schema: $ref: '#/components/schemas/subscription_response' '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Produto recorrência não habilitado. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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 parameters: - name: Content-Type in: header description: Tipo do conteúdo. required: true schema: enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: Código de identificação do e-commerce. required: true schema: type: string format: uuidv4 minLength: 36 maxLength: 36 - name: username in: header description: > Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. required: false schema: type: string - name: subscription_id in: path description: Identificador da assinatura de recorrência. required: true schema: type: string minLength: 36 maxLength: 36 format: uuidv4 requestBody: description: Conjundo de dados adicionais para cancelamento. content: application/json: schema: $ref: '#/components/schemas/subscription_cancel' responses: '200': description: Assinatura cancelada com sucesso. content: application/json: schema: $ref: '#/components/schemas/subscription_response' '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Produto recorrência não habilitado. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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/2025 - 30/11/2025 - 31/12/2025 tags: - Assinaturas parameters: - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: Código de identificação do e-commerce. required: true schema: type: string format: uuidv4 minLength: 36 maxLength: 36 - name: subscription_id in: path description: Identificador da assinatura de recorrência. required: true schema: type: string minLength: 36 maxLength: 36 format: uuidv4 - name: expand in: query 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. required: false schema: type: array items: type: string responses: '200': description: Projeção retornada com sucesso. content: application/json: schema: $ref: '#/components/schemas/subscription_projection_response' '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Produto recorrência não habilitado. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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 parameters: - name: Content-Type in: header description: Tipo do conteúdo. required: true schema: enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: Código de identificação do e-commerce. required: true schema: type: string format: uuidv4 minLength: 36 maxLength: 36 - name: username in: header description: > Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. required: false schema: type: string - name: subscription_id in: path description: Identificador da assinatura de recorrência. required: true schema: type: string minLength: 36 maxLength: 36 format: uuidv4 requestBody: description: Conjunto de informações para confirmação de pagamento de assinatura. content: application/json: schema: $ref: '#/components/schemas/subscription_confirm' responses: '200': description: Pagamento confirmado com sucesso. content: application/json: schema: $ref: '#/components/schemas/subscription_response' '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Produto recorrência não habilitado. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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 parameters: - name: Content-Type in: header description: Tipo do conteúdo. required: true schema: enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: Código de identificação do e-commerce. required: true schema: type: string format: uuidv4 minLength: 36 maxLength: 36 - name: username in: header description: > Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. required: false schema: type: string - name: subscription_id in: path description: Identificador da assinatura de recorrência. required: true schema: type: string minLength: 36 maxLength: 36 format: uuidv4 requestBody: description: Conjunto de dados para atualização de data de pagamento. content: application/json: schema: $ref: '#/components/schemas/subscription_payment_date' responses: '200': description: Data atualizada com sucesso. content: application/json: schema: $ref: '#/components/schemas/subscription_response' '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Produto recorrência não habilitado. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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 parameters: - name: Content-Type in: header description: Tipo do conteúdo. required: true schema: enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: Código de identificação do e-commerce. required: true schema: type: string format: uuidv4 minLength: 36 maxLength: 36 - name: username in: header description: > Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. required: false schema: type: string - name: subscription_id in: path description: Identificador da assinatura de recorrência. required: true schema: type: string minLength: 36 maxLength: 36 format: uuidv4 requestBody: description: Conjunto de dados para troca de tipo de pagamento. content: application/json: schema: $ref: '#/components/schemas/subscription_update_payment_type' responses: '200': description: Dados de pagamento atualizados com sucesso. content: application/json: schema: $ref: '#/components/schemas/subscription_response' '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Produto recorrência não habilitado. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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": "30", "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 para alteração de data](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=we1vrlcdn9tyz8la8d9tgfze&from=). tags: - Assinaturas parameters: - name: Content-Type in: header description: Tipo do conteúdo. required: true schema: enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: Código de identificação do e-commerce. required: true schema: type: string format: uuidv4 minLength: 36 maxLength: 36 - name: subscription_id in: path description: Identificador da assinatura de recorrência. required: true schema: type: string minLength: 36 maxLength: 36 format: uuidv4 - name: username in: header description: > Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. required: false schema: type: string requestBody: description: > Requisição contendo os dados para cadastro das alterações de data e/ou valor para determinadas cobranças. content: application/json: schema: $ref: '#/components/schemas/subscription_floating_data_array_creation' responses: '201': description: Assinatura alterada com sucesso. content: application/json: schema: $ref: '#/components/schemas/subscription_floating_data_response' '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Produto recorrência não habilitado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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 para alteração de data](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=we1vrlcdn9tyz8la8d9tgfze&from=). tags: - Assinaturas parameters: - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: Código de identificação do e-commerce. required: true schema: type: string format: uuidv4 minLength: 36 maxLength: 36 - name: subscription_id in: path description: Identificador da assinatura de recorrência. required: true schema: type: string minLength: 36 maxLength: 36 format: uuidv4 responses: '200': description: > Alterações de data e/ou valor das cobranças da Assinatura retornadas com sucesso. content: application/json: schema: $ref: '#/components/schemas/subscription_floating_data_response' '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Produto recorrência não habilitado. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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 parameters: - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: Código de identificação do e-commerce. required: true schema: type: string format: uuidv4 minLength: 36 maxLength: 36 - name: subscription_id in: path description: Identificador da assinatura de recorrência. required: true schema: type: string minLength: 36 maxLength: 36 format: uuidv4 - name: username in: header description: > Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. required: false schema: type: string responses: '200': description: Alterações de data e valor foram removidos parcialmente. content: application/json: schema: $ref: '#/components/schemas/subscription_floating_data_remove_response' '204': description: Alterações de data e valor foram removidos com sucesso. '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Produto cofre não habilitado. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Recurso não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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 para alteração de data](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=we1vrlcdn9tyz8la8d9tgfze&from=).. tags: - Assinaturas parameters: - name: Content-Type in: header description: Tipo do conteúdo. required: true schema: enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: Código de identificação do e-commerce. required: true schema: type: string format: uuidv4 minLength: 36 maxLength: 36 - name: subscription_id in: path required: true description: Identificador da assinatura de recorrência. schema: type: string minLength: 36 maxLength: 36 format: uuidv4 - name: username in: header description: > Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. required: false schema: type: string requestBody: description: > Requisição contendo os dados para adição das alterações de data e/ou valor para determinadas cobranças. content: application/json: schema: $ref: '#/components/schemas/subscription_floating_data_array_creation' responses: '200': description: Alterações de data e valor inseridas com sucesso. content: application/json: schema: $ref: '#/components/schemas/subscription_floating_data_response' '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Produto recorrência não habilitado. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '422': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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 parameters: - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: Código de identificação do e-commerce. required: true schema: type: string format: uuidv4 minLength: 36 maxLength: 36 - name: subscription_id in: path description: Identificador da assinatura de recorrência. required: true schema: type: string minLength: 36 maxLength: 36 format: uuidv4 - name: installment in: path description: Número da parcela que será aplicada a alteração. required: true schema: type: integer minimum: 1 format: int32 - name: username in: header description: > Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. required: false schema: type: string responses: '200': description: Alterações de data e valor foram removidos parcialmente. content: application/json: schema: $ref: '#/components/schemas/subscription_floating_data_remove_response' '204': description: Alterações de data e valor foram removidos com sucesso. '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Produto cofre não habilitado. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Recurso não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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 para alteração de data](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=we1vrlcdn9tyz8la8d9tgfze&from=). tags: - Assinaturas parameters: - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: Código de identificação do e-commerce. required: true schema: type: string format: uuidv4 minLength: 36 maxLength: 36 - name: subscription_id in: path description: Identificador da assinatura de recorrência. required: true schema: type: string minLength: 36 maxLength: 36 format: uuidv4 - name: installment in: path description: Número da parcela que será aplicada a alteração. required: true schema: type: integer minimum: 1 format: int32 - name: username in: header description: > Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. required: false schema: type: string requestBody: description: Dados para atualização de data e/ou valor de uma determinada cobrança. content: application/json: schema: $ref: '#/components/schemas/subscription_floating_data_update' responses: '200': description: Alterações de data e valor inseridas com sucesso. content: application/json: schema: $ref: '#/components/schemas/subscription_floating_data_response' '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Produto recorrência não habilitado. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '422': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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. tags: - Assinaturas parameters: - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: Código de identificação do e-commerce. required: true schema: type: string format: uuidv4 minLength: 36 maxLength: 36 - name: subscription_id in: path required: true schema: type: string - name: username in: header description: > Usuário que está realizando o cadastro. Esta informação pode ser utilizada para fins de auditoria. required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/plan_migration_request' responses: '200': description: Assinatura migrada com sucesso. content: application/json: schema: $ref: '#/components/schemas/subscription_response' '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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/charges: get: summary: Lista de cobranças description: > Neste endpoint você pode listar as cobranças cadastradas com base nos filtros escolhidos tags: - Assinaturas parameters: - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: Código de identificação do e-commerce. required: true schema: type: string format: uuidv4 minLength: 36 maxLength: 36 - name: page in: query description: Número da página em que inicia a paginação. required: true schema: minimum: 1 type: number - name: limit in: query description: Limite de resultados por página. required: true schema: minimum: 0 maximum: 9999 type: number - name: charge_id in: query description: Identificador da cobrança. required: false schema: type: string minLength: 36 maxLength: 36 format: uuidv4 - name: seller_id in: query description: Código de identificação do e-commerce. required: false schema: type: string format: uuidv4 minLength: 36 maxLength: 36 - name: subscription_id in: query description: Identificador da assinatura de recorrência. required: false schema: type: string minLength: 36 maxLength: 36 format: uuidv4 - name: status in: query description: Status da cobrança. required: false schema: enum: - paid - denied - processing - scheduled - canceled type: string - name: start_date in: query description: Data de início. required: false schema: type: string - name: end_date in: query description: Data final. required: false schema: type: string - name: scheduled_date in: query description: Data de agendamento. required: false schema: type: string - name: retries in: query description: Número de retentativas. required: false schema: minimum: 0 type: number - name: sort in: query description: Campo para realizar a ordenação. required: false schema: default: create_date enum: - create_date - installment - scheduled_date type: string - name: sort_type in: query description: Tipo de ordenação. Ascendente ou Descendente. required: false schema: enum: - asc - desc type: string responses: '200': description: Retorna a lista de cobranças. content: application/json: schema: $ref: '#/components/schemas/charge_filter_response' '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Produto recorrência não habilitado. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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' /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 parameters: - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: bin in: path description: bin required: true schema: type: string responses: '200': description: Retorna a lista dos BINs encontrados. content: application/json: schema: $ref: '#/components/schemas/consulta_bin_response' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /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 parameters: - name: Content-Type in: header description: Tipo do conteúdo. required: true schema: type: string enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: Código de identificação do e-commerce. required: false schema: type: string minLength: 36 maxLength: 36 format: uuidv4 requestBody: required: true description: Requisição contendo os dados de cartão para salvamento no cofre. content: application/json: schema: $ref: '#/components/schemas/vault_card' responses: '201': description: Identificador do cartão criado com sucesso. Cartão salvo no cofre. content: application/json: 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. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Produto cofre não habilitado. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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": "30", "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 parameters: - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: > Código de identificação do e-commerce. ***Obrigatório quando o cliente for tratado como Plataforma.*** required: false schema: type: string minLength: 36 maxLength: 36 format: uuidv4 - name: customer_id in: query description: > Identificador do comprador. Informação definida pela aplicação que consome a api da Plataforma Digital. required: true schema: type: string maxLength: 100 - name: status in: query description: > Filtro de status dos cartões retornados. Caso não seja informado nenhum filtro, serão retornados os cartões ativos e renovados. required: false schema: type: string maxLength: 25 enum: - all - active - renewed responses: '200': description: Lista de cartões salvos. content: application/json: schema: type: object properties: cards: type: array items: $ref: '#/components/schemas/vault_card_response' '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Produto cofre não habilitado. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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 parameters: - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: > Código de identificação do e-commerce. ***Obrigatório quando o cliente for tratado como Plataforma.*** required: false schema: type: string minLength: 36 maxLength: 36 format: uuidv4 - name: card_id in: path description: Identificador único do cartão na plataforma digital Getnet. required: true schema: type: string maxLength: 36 responses: '200': description: Dados do cartão. content: application/json: schema: $ref: '#/components/schemas/vault_card_response' '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Produto cofre não habilitado. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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 parameters: - name: Authorization in: header description: > Authorization: Bearer *AuthString* Onde *AuthString* é token de acesso obtido no endpoint de autenticação. required: true schema: type: string - name: seller_id in: header description: > Código de identificação do e-commerce. ***Obrigatório quando o cliente for tratado como Plataforma.*** required: false schema: type: string minLength: 36 maxLength: 36 format: uuidv4 - name: card_id in: path description: Identificador único do cartão na plataforma digital Getnet. required: true schema: type: string maxLength: 36 responses: '204': description: Cartão removido com sucesso. '400': description: Requisição inválida. content: application/json: schema: $ref: '#/components/schemas/error' '401': description: Autenticação inválida. content: application/json: schema: $ref: '#/components/schemas/error' '403': description: Produto cofre não habilitado. content: application/json: schema: $ref: '#/components/schemas/error' '404': description: Recurso não encontrado. content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Erro interno do servidor ou serviço. content: application/json: schema: $ref: '#/components/schemas/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' components: schemas: serviceUnavailable: title: serviceUnavailable type: object properties: message: type: string description: Mensagem de erro name: type: string description: Nome do módulo ou sistema onde ocorreu o erro status_code: type: number description: Código de status HTTPe format: double details: type: array description: Array de objetos contendo detalhes do erro items: type: object properties: status: type: string description: Status example: 'ERROR' error_code: type: string description: Erro de código example: 'GENERIC-503' description: type: string description: Breve descrição do erro example: 'Service Unavailable' description_detail: type: string description: Descrição detalhada do erro example: 'The service is unavailable' description: Conjunto de informações retornadas em caso de erros PaymentDTO: type: object required: - idempotency_key - request_id - order_id - data 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: > Identificador da requisição. Único para cada requisição. Caso não seja informado, será gerado automaticamente. example: '20bde238-08f5-41a8-9925-8095b1b1db76' maxLength: 36 minLength: 36 format: uuidv4 order_id: type: string description: > Código de identificação da compra utilizado pelo e-commerce (código ou número do pedido). maxLength: 36 example: '63c7f8ee-51a6-470d-bb76-ef762b62bfb7' data: $ref: '#/components/schemas/DataDTO' DataDTO: description: Dados para realização de uma autorização. type: object required: - amount - order - payment properties: amount: type: integer format: int32 description: Valor da compra em centavos example: 118708 currency: type: string description: > Identificação da moeda (Consultar código em "https://www.currency-iso.org/en/home/tables/table-a1.html"). ***Campo obrigatório para o [Antifraude](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=)*** example: 'BRL' enum: - BRL customer_id: type: string description: > Identificador do comprador. Informação definida pela aplicação que consome a api da Plataforma Digital. ***Campo obrigatório para o [Antifraude](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=)*** example: 'teste' payment: $ref: '#/components/schemas/PaymentDataDTO' sub_merchant: $ref: '#/components/schemas/SubMerchantDTO' additional_data: type: object description: > Dados adicionais da autorização. Campo obrigatório para split de pagamento. required: - billing_address - shippings - customer properties: split: $ref: '#/components/schemas/split_data' device: $ref: '#/components/schemas/DeviceDTO' customer: $ref: '#/components/schemas/CustomerDTO' order: $ref: '#/components/schemas/OrderDTO' PaymentDataDTO: type: object description: Conjunto de dados contendo os itens do pedido. required: - payment_id - payment_method - transaction_type - number_installments - card properties: payment_id: type: string description: Código de identificação do pagamento. maxLength: 36 example: '173f9e8d-4e0b-4503-8016-5cdafba89bee' payment_method: type: string description: Tipo da transação. example: 'CREDIT' enum: - CREDIT - DEBIT - CREDIT_AUTHORIZATION - CREDIT_PRE_AUTHORIZATION 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' enum: - FULL - INSTALL_NO_INTEREST - INSTALL_WITH_INTEREST number_installments: type: integer description: Número de parcelas para uma transação de crédito parcelado. example: 1 soft_descriptor: 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 não permitidos. Qualquer informação que exceda o tamanho máximo será desconsiderada. **Obrigatório para facilitadores de Pagamento e SDWO**. 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 - Exemplo 4: para SDWO back-to-back: Carteira*Subcomercio - Exemplo 5: para SDWO cash-in apenas preencher com o nome da carteira: Carteira Digital 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. **Obrigatório para Facilitadores de Pagamento e SDWO.** example: 1799 card: $ref: '#/components/schemas/CardDTO' tokenization: $ref: '#/components/schemas/TokenizationDTO' wallet: $ref: '#/components/schemas/WalletCreditDTO' xid: type: string description: > Campo 3DS disponível a partir da versão 2.0. Identificador do MPI para cada transação autenticada. O conteúdo do campo pode ser um valor HEXA ou Base64, de acordo com o MPI utilizado. maxLength: 40 example: 'string' ucaf: type: string description: > Campo 3DS disponível a partir da versão 2.0. Código de autenticação criptografado pela Bandeira. O conteúdo do campo pode ser um valor HEXA ou Base64, de acordo com o MPI utilizado. maxLength: 40 example: 'string' eci: type: string description: > Campo 3DS disponível a partir da versão 2.0. Código ECI da transação Autenticada 3D Secure. Gerado por um MPI Externo. maxLength: 2 example: '00' tdsdsxid: type: string description: Identificador da transação do servidor 3DS versão 2. example: 'string' tdsver: type: string description: Indica a versão 3DS utilizada na autenticação, example: '2.1.0' 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. example: 'ONE_CLICK_PAYMENT' enum: - ONE_CLICK - ONE_CLICK_PAYMENT - RECURRING - RECURRING_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' PaymentAdjustmentDTO: type: object required: - idempotency_key - request_id - order_id - data 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: > Identificador da requisição. Único para cada requisição. Caso não seja informado, será gerado automaticamente. example: '20bde238-08f5-41a8-9925-8095b1b1db76' maxLength: 36 minLength: 36 format: uuidv4 order_id: type: string description: > Código de identificação da compra utilizado pelo e-commerce (código ou número do pedido). maxLength: 36 example: '63c7f8ee-51a6-470d-bb76-ef762b62bfb7' data: $ref: '#/components/schemas/AdjustmentDataDTO' AdjustmentDataDTO: description: Dados para realização de uma autorização. type: object required: - amount - order - payment properties: amount: type: integer format: int32 description: Valor da compra em centavos example: 118708 currency: type: string description: > Identificação da moeda (Consultar código em "https://www.currency-iso.org/en/home/tables/table-a1.html"). ***Campo obrigatório para o [Antifraude](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=)*** example: 'BRL' enum: - BRL customer_id: type: string description: > Identificador do comprador. Informação definida pela aplicação que consome a api da Plataforma Digital. ***Campo obrigatório para o [Antifraude](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=)*** example: 'teste' payment: $ref: '#/components/schemas/PaymentAdjustmentDataDTO' sub_merchant: $ref: '#/components/schemas/SubMerchantDTO' additional_data: type: object description: > Dados adicionais da autorização. Campo obrigatório para split de pagamento. required: - billing_address - shippings - customer properties: split: $ref: '#/components/schemas/split_data' device: $ref: '#/components/schemas/DeviceDTO' customer: $ref: '#/components/schemas/CustomerDTO' order: $ref: '#/components/schemas/OrderDTO' PaymentAdjustmentDataDTO: type: object description: Conjunto de dados contendo os itens do pedido. required: - payment_id - payment_method - transaction_type - number_installments - card properties: payment_id: type: string description: Código de identificação do pagamento. maxLength: 36 example: '173f9e8d-4e0b-4503-8016-5cdafba89bee' payment_method: type: string description: Tipo da transação. example: 'CREDIT_PRE_AUTHORIZATION' enum: - CREDIT_PRE_AUTHORIZATION 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' enum: - FULL - INSTALL_NO_INTEREST - INSTALL_WITH_INTEREST number_installments: type: integer description: Número de parcelas para uma transação de crédito parcelado. example: 1 soft_descriptor: 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 não permitidos. Qualquer informação que exceda o tamanho máximo será desconsiderada. **Obrigatório para facilitadores de Pagamento e SDWO**. 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 - Exemplo 4: para SDWO back-to-back: Carteira*Subcomercio - Exemplo 5: para SDWO cash-in apenas preencher com o nome da carteira: Carteira Digital 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. **Obrigatório para Facilitadores de Pagamento e SDWO.** example: 1799 card: $ref: '#/components/schemas/CardDTO' tokenization: $ref: '#/components/schemas/TokenizationDTO' wallet: $ref: '#/components/schemas/WalletCreditDTO' xid: type: string description: > Campo 3DS disponível a partir da versão 2.0. Identificador do MPI para cada transação autenticada. O conteúdo do campo pode ser um valor HEXA ou Base64, de acordo com o MPI utilizado. maxLength: 40 example: 'teste' ucaf: type: string description: > Campo 3DS disponível a partir da versão 2.0. Código de autenticação criptografado pela Bandeira. O conteúdo do campo pode ser um valor HEXA ou Base64, de acordo com o MPI utilizado. maxLength: 40 example: 'string' eci: type: string description: > Campo 3DS disponível a partir da versão 2.0. Código ECI da transação Autenticada 3D Secure. Gerado por um MPI Externo. maxLength: 2 example: '00' tdsdsxid: type: string description: Identificador da transação do servidor 3DS versão 2. example: 'string' tdsver: type: string description: Indica a versão 3DS utilizada na autenticação, example: '2.1.0' 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. example: 'ONE_CLICK_PAYMENT' enum: - ONE_CLICK - ONE_CLICK_PAYMENT - RECURRING - RECURRING_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' SubMerchantDTO: 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. maxLength: 15 example: '9058345' 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 enum: - CPF - CNPJ description: Tipo de documento do subcomércio. example: 'CNPJ' minLength: 3 maxLength: 4 document_number: type: string description: CNPJ ou CPF do subcomércio. minLength: 11 maxLength: 14 example: '77415914000148' 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 207' maxLength: 40 city: type: string description: Cidade do subcomércio. example: 'Cidade' maxLength: 13 state: type: string description: Estado (UF) do subcomércio. example: 'RS' minLength: 2 maxLength: 2 postal_code: type: string description: > Código Postal do subcomércio, CEP no Brasil ou ZIP nos Estados Unidos. (sem máscara) example: '90520000' minLength: 8 maxLength: 8 ShippingsDTO: type: object properties: address: $ref: '#/components/schemas/AddressDTO' description: Conjunto de dados referentes ao endereço de entrega. OrderDTO: type: object properties: items: $ref: '#/components/schemas/items_array' description: > Conjunto de dados para identificação da compra. ***Campo obrigatório para o [Antifraude](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=)*** DeviceDTO: type: object description: Conjunto de dados referentes ao dispositivo utilizado pelo comprador. properties: ip_address: type: string description: > string 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](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=)*** example: '10.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](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=)*** example: 'ae44e06c-3e85-44af-8542-bcaccd54ef2e' CustomerDTO: type: object properties: document_type: type: string example: 'CPF' description: > Tipo do documento de identificação do comprador. Valores Sugeridos **CPF**, **CNPJ**, **RNE**, **RG**, **CNAE**, **PASSPORT** ou **Documento conforme legislação vigente no país de origem** ***Campo obrigatório para o [Antifraude](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=)*** document_number: type: string example: '2441356709' description: > Número do documento do comprador sem pontuação (sem máscara). ***Campo obrigatório para o [Antifraude](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=)*** email: type: string example: 'aceitei@getnet.com.br' description: > Email do comprador. ***Campo obrigatório para o [Antifraude](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=)*** name: type: string example: 'Jose da Silva' description: > Nome completo do comprador. ***Campo obrigatório para o [Antifraude](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=)*** phone_number: type: string example: '11999999999' description: > Telefone do comprador (sem máscara). ***Campo obrigatório para o [Antifraude](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=)*** billing_address: $ref: '#/components/schemas/BillingAddressDTO' shippings: $ref: '#/components/schemas/ShippingsDTO' BillingAddressDTO: type: object description: > Conjunto de dados referentes ao endereço de cobrança. ***Campo obrigatório para o [Antifraude](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=)*** properties: street: type: string description: > Logradouro. ***Campo obrigatório para o [Antifraude](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=)*** example: 'Av. Brasil' number: type: string example: '1000' description: > Número do logradouro. ***Campo obrigatório para o [Antifraude](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=)*** district: type: string example: 'São Geraldo' description: > Bairro. ***Campo obrigatório para o [Antifraude](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=)*** city: type: string example: 'Porto Alegre' description: > Cidade. ***Campo obrigatório para o [Antifraude](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=)*** state: type: string example: 'RS' description: > Estado (UF). ***Campo obrigatório para o [Antifraude](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=)*** country: type: string example: 'BRA' description: > País. (Informe no padrão ISO 3166-1 alfa-3) **Exemplo**: BRA, USA e ARG. ***Campo obrigatório para o [Antifraude](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=)*** postal_code: type: string example: '90230060' description: > Código Postal, CEP no Brasil ou ZIP nos Estados Unidos (sem máscara). ***Campo obrigatório para o [Antifraude](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=)*** complement: type: string description: Complemento do logradouro. type: type: string enum: - RESIDENCIAL - INSTALACAO - CORRESPONDENCIA - FISCAL - COBRANCA description: > Tipo de endereço. ***Campo obrigatório para o [Antifraude](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=)*** ReleaseDTO: type: object required: - release_payment_date - subseller_id - order_item_release properties: release_payment_date: type: string description: Data de Liberação do Pagamento para o vendedor (SubSeller). example: '2023-12-23T12:00:00.000' subseller_id: type: string description: ID do subseller cadastrado na plataforma de marketplace (MGM). example: '700104158' order_item_release: $ref: '#/components/schemas/OrderItemReleaseDTO' paymentPurchaseResponse: title: paymentPurchaseResponse type: object properties: idempotency_key: type: string description: Chave de idempotência example: 'ORDER-10187383-8719d0c4-2c3f-4360-abd9-8daf3834fe1f' seller_id: type: string description: Código de identificação do eCommerce format: uuid example: '9406df6c-3100-49ba-b4df-d81c1ad8a62b' request_id: type: string description: > Identificador da requisição. Único para cada requisição. Caso não seja informado, será gerado automaticamente. maxLength: 36 minLength: 36 format: uuid example: 'daac03dc-73db-453f-9bea-b1391669d5d3' payment_id: type: string description: Identificador do pagamento format: uuid example: '2c341d28-491b-4cf8-aec7-eeb60136b7a5' order_id: type: string description: Identificador do pedido example: 'ORDER-10187383' amount: type: number description: Valor da compra em centavos format: double example: 8900 currency: maxLength: 3 minLength: 3 type: string description: > Identificação da moeda (Consultar código em "https://www.currency-iso.org/en/home/tables/table-a1.html") example: 'BRL' status: $ref: '#/components/schemas/Status' payment_method: $ref: '#/components/schemas/payment_method' received_at: type: string description: Data da transação example: '2020-06-30T18:32:51.222Z' transaction_id: maxLength: 18 type: string description: Identificador da transação gerado pela plataforma de eCommerce example: '3729756321501820' original_transaction_id: maxLength: 18 type: string description: Identificador da transação original example: '6534812321501821' authorized_at: type: string description: Data de autorização da transação example: '2020-06-30T18:32:51.815Z' reason_code: maxLength: 2 minLength: 2 type: string description: > Código de resposta da transação. Se diferente de '00' transação negada. example: '00' reason_message: type: string description: Mensagem de resposta example: 'TRANSACAO EXECUTADA COM SUCESSO' acquirer: type: string description: Adquirente. example: 'GETNET' default: 'GETNET' soft_descriptor: maxLength: 22 type: string 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 não permitidos. Qualquer informação que exceda o tamanho máximo será desconsiderada. example: 'MEUECOMM*ORDER10187383' brand: $ref: '#/components/schemas/brand' authorization_code: maxLength: 6 minLength: 6 type: string description: > Código de Autorização gerado pelo Emissor quando a transação é realizada com sucesso example: '017060' acquirer_transaction_id: maxLength: 12 minLength: 12 type: string description: NSU da transação da GETNET (Adquirente) example: '152147981' eci: $ref: '#/components/schemas/eci' total_installment_amount: $ref: '#/components/schemas/total_installment_amount' first_installment_amount: $ref: '#/components/schemas/first_installment_amount' other_installment_amount: $ref: '#/components/schemas/other_installment_amount' description: Conjunto de dados de resposta de crédito e débito. statusInfo: type: string example: 'APPROVED' description: transaction status enum: - APPROVED - AUTHORIZED - DENIED - CANCELED - CAPTURED - ERROR idempotency_key: type: string title: idempotency_key format: uuid example: '8719d0c4-2c3f-4360-abd9-8daf3834fe1f' minLength: 36 maxLength: 36 description: idempotency key rel: title: rel type: string example: 'AUTHORIZATION' enum: - AUTHORIZATION - CANCEL - CONFIRM - PURCHASE description: Relação do item com o pagamento. protocol: title: protocol type: string minLength: 18 maxLength: 18 example: '202006302344230001' description: Protocolo de cancelamento brand: title: brand maxLength: 50 type: string description: > Bandeira do cartão. Preenchido automaticamente pela API caso não seja informado. ***Campo obrigatório para o [Antifraude](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=)*** enum: - MASTERCARD - VISA - AMEX - ELO - HIPERCARD paymentCaptureResponse: title: paymentCaptureResponse type: object properties: idempotency_key: type: string description: Chave de idempotência example: 'ORDER-10187383-8719d0c4-2c3f-4360-abd9-8daf3834fe1f' seller_id: type: string description: Código de identificação do eCommerce format: uuid example: '9406df6c-3100-49ba-b4df-d81c1ad8a62b' request_id: type: string description: > Identificador da requisição. Único para cada requisição. Caso não seja informado, será gerado automaticamente. maxLength: 36 minLength: 36 format: uuidv4 example: 'daac03dc-73db-453f-9bea-b1391669d5d3' payment_id: type: string description: Identificador do pagamento format: uuid example: '2c341d28-491b-4cf8-aec7-eeb60136b7a5' order_id: type: string description: Identificador do pedido example: 'ORDER-10187383' amount: type: number description: Valor da compra em centavos format: double example: 8900 currency: maxLength: 3 minLength: 3 type: string description: > Identificação da moeda (Consultar código em "https://www.currency-iso.org/en/home/tables/table-a1.html") example: 'BRL' status: type: string description: Status da transação example: 'CAPTURED' captured_at: type: string description: Data da captura example: '2020-06-30T22:33:41.172Z' reason_code: maxLength: 2 minLength: 2 type: string description: > Código de resposta da transação. Se diferente de '00' transação negada. example: '00' reason_message: type: string description: Mensagem de resposta example: 'TRANSACAO EXECUTADA COM SUCESSO' payment_method: title: payment_method type: string description: Método de pagamento enum: - CREDIT - DEBIT - CREDIT_AUTHORIZATION seller_id: title: seller_id type: string example: '9406df6c-3100-49ba-b4df-d81c1ad8a62b' minLength: 36 maxLength: 36 format: uuid description: eCommerce ID Code request_id: title: request_id type: string example: 'daac03dc-73db-453f-9bea-b1391669d5d3' maxLength: 36 minLength: 36 format: uuid description: Identificador da solicitação. Exclusivo para cada solicitação payment_id: title: payment_id type: string description: Identificador de pagamento example: '2c341d28-491b-4cf8-aec7-eeb60136b7a5' format: uuid minLength: 36 maxLength: 36 order_id: title: order_id type: string example: 'ORDER-10187383' description: Identificador de pedido minLength: 1 maxLength: 32 amount: type: integer title: amount description: Valor da compra em centavos example: 8900 currency: title: currency type: string example: 'BRL' minLength: 3 maxLength: 3 description: > Identificação da moeda (Ver código em "https://www.currency-iso.org/en/home/tables/table-a1.html") received_at: title: received_at type: string example: '2020-06-30T18:32:51.222Z' description: Data da transação transaction_id: title: transaction_id type: string example: '3729756321501820' description: Identificador de transação gerado pela plataforma de comércio eletrônico maxLength: 18 authorized_at: title: authorized_at type: string example: '2020-06-30T18:32:51.815Z' description: Data de autorização da transação acquirer: title: acquirer type: string description: Comprador. example: 'GETNET' default: 'GETNET' soft_descriptor: title: soft_descriptor type: string example: 'MYUECOMM*ORDER10187383' maxLength: 22 description: > Texto exibido na fatura do cartão do comprador, Este campo é opcional, caso nada seja informado será considerado o nome comercial cadastrado para o estabelecimento. Somente dados alfanuméricos e os seguintes caracteres especiais são permitidos neste campo: % $ , . / & ( ) + = = < > - * Os espaços serão substituídos pelo caracter **\*** A transação não será negada caso sejam enviados caracteres não permitidos. Qualquer informação que exceda o tamanho máximo será desconsiderada. reason_code: title: reason code type: string minLength: 2 maxLength: 2 example: '00' description: Código de resposta da transação. Se diferente de '00' transação negada. reason_message: title: reason_message type: string example: 'TRANSACAO EXECUTADA COM SUCESSO' description: reply message authorization_code: title: authorization_code type: string example: '017060' minLength: 6 maxLength: 6 description: > Código de Autorização gerado pelo Emissor quando a transação é realizada com sucesso acquirer_transaction_id: title: acquirer_transaction_id type: string example: '152147981' maxLength: 12 minLength: 12 description: NSU da transação GETNET (Adquirente) eci: maxLength: 2 minLength: 2 type: string description: > Código indicando se a transação foi processada com Autenticação do Portador. 00, 01 e 02 para Mastercard e 05, 06 e 07 para Visa e demais bandeiras. example: '07' total_installment_amount: type: number description: > Para as transações parceladas, este contém o valor total a ser pago (valor acrescido dos juros, impostos, taxas, etc). format: double example: 8900 first_installment_amount: type: number description: > Para as transações parceladas, este contém o valor da primeira parcela a ser paga. format: double example: 1485 other_installment_amount: type: number description: > Para as transações parceladas, este contém o valor das demais parcelas a serem pagas. format: double example: 1483 registred_at: type: string description: Data e hora do registro de pagamento. errorOAuth: title: errorOAuth type: object properties: error: type: string description: Mensagem de erro error_description: type: string description: Descrição do erro verify_request: title: verify_request required: - key_id type: object 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: '30' security_code: type: string description: Código de segurança. CVV ou CVC. minLength: 3 maxLength: 4 example: '123' gateway_id: type: string description: ID do Merchant Payment Gateway (MPG). minLength: 11 maxLength: 11 example: '00000999998' verify_response: title: verify_response type: object properties: status: $ref: '#/components/schemas/Status1' verification_id: type: string format: uuid 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 description: Conjunto de dados de resposta de crédito e débito. AuthOauthV2TokenResponse: title: AuthOauthV2TokenResponse type: object properties: access_token: type: string format: uuid example: '0acc450b-cb7a-4e94-9881-d674f9e31947' 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: string description: Tempo de expiração do token em segundos example: '3600' default: '3600' scope: type: string description: Escopo example: 'oob' default: 'oob' Status: title: Status type: string description: Status da transação enum: - APPROVED - AUTHORIZED - DENIED Status1: title: Status1 type: string description: Status da transação enum: - VERIFIED - NOT VERIFIED - RETRY - DENIED - ERROR V1PaymentsCancelRequest: title: V1PaymentsCancelRequest required: - idempotency_key - payment_id - payment_method type: object properties: idempotency_key: maxLength: 64 minLength: 1 type: string description: Chave de idempotência example: 'ORDER-10187383-8719d0c4-2c3f-4360-abd9-8daf3834fe1f' request_id: type: string description: > Identificador da requisição. Único para cada requisição. Caso não seja informado, será gerado automaticamente. maxLength: 36 minLength: 36 format: uuid example: 'daac03dc-73db-453f-9bea-b1391669d5d3' payment_id: type: string description: Identificador do pagamento format: uuid example: '2c341d28-491b-4cf8-aec7-eeb60136b7a5' payment_method: $ref: '#/components/schemas/payment_method' amount: type: number description: > Valor igual ou menor a transação original. Utilizar apena no caso de cancelamentos parciais em D+N. Caso não seja informado será considerado o valor da transação original. format: double example: 8900 custom_key: maxLength: 32 minLength: 3 type: string description: > Chave do cliente utilizada para identificar uma solicitação de cancelamento. (Chave deve ser única por transação). example: '20200630-8900' additional_data: type: object properties: split: $ref: '#/components/schemas/split_data' description: > Dados adicionais do pagamento. Campos obrigatório para split de pagamento. V1PaymentsCaptureRequest: title: V1PaymentsCaptureRequest required: - idempotency_key - payment_id - payment_method type: object properties: idempotency_key: maxLength: 64 minLength: 1 type: string description: Chave de idempotência example: 'ORDER-10187383-8719d0c4-2c3f-4360-abd9-8daf3834fe1f' request_id: type: string description: > Identificador da requisição. Único para cada requisição. Caso não seja informado, será gerado automaticamente. maxLength: 36 minLength: 36 format: uuid example: 'daac03dc-73db-453f-9bea-b1391669d5d3' payment_id: type: string description: Identificador do pagamento format: uuid example: '2c341d28-491b-4cf8-aec7-eeb60136b7a5' payment_method: type: string description: Método de pagamento example: 'CREDIT_AUTHORIZATION' default: 'CREDIT_AUTHORIZATION' amount: type: number description: Valor igual ou menor ao transação original em centavos format: double example: 8900 additional_data: type: object properties: split: $ref: '#/components/schemas/split_data' description: > Dados adicionais do pagamento. Campos obrigatório para split de pagamento. paymentAuthorizationResponse: title: Resposta de autorização type: object description: Objeto de corpo de resposta de autorização. properties: seller_id: $ref: '#/components/schemas/seller_id' request_id: $ref: '#/components/schemas/request_id' payment_id: $ref: '#/components/schemas/payment_id' order_id: $ref: '#/components/schemas/order_id' amount: $ref: '#/components/schemas/amount' currency: $ref: '#/components/schemas/currency' status: type: string example: 'AUTHORIZED' description: transaction status payment_method: type: string example: 'CREDIT_AUTHORIZATION' description: Payment method enum: - CREDIT_AUTHORIZATION received_at: $ref: '#/components/schemas/received_at' transaction_id: $ref: '#/components/schemas/transaction_id' original_transaction_id: type: string example: '-1' maxLength: 18 description: Original transaction identifier authorized_at: $ref: '#/components/schemas/authorized_at' reason_code: $ref: '#/components/schemas/reason_code' reason_message: $ref: '#/components/schemas/reason_message' acquirer: $ref: '#/components/schemas/acquirer' soft_descriptor: $ref: '#/components/schemas/soft_descriptor' brand: $ref: '#/components/schemas/brand' authorization_code: $ref: '#/components/schemas/authorization_code' acquirer_transaction_id: $ref: '#/components/schemas/acquirer_transaction_id' eci: $ref: '#/components/schemas/eci' total_installment_amount: $ref: '#/components/schemas/total_installment_amount' first_installment_amount: $ref: '#/components/schemas/first_installment_amount' other_installment_amount: $ref: '#/components/schemas/other_installment_amount' record: title: Record Object type: object description: '' properties: rel: $ref: '#/components/schemas/rel' registred_at: $ref: '#/components/schemas/registred_at' idempotency_key: $ref: '#/components/schemas/idempotency_key' href: type: string format: uri description: URI para consultar um componente relacionado ao item. requestPayment: type: object title: Pedido de autorização ou compra properties: idempotency_key: $ref: '#/components/schemas/idempotency_key' request_id: $ref: '#/components/schemas/request_id' order_id: $ref: '#/components/schemas/order_id' data: type: object description: Conjunto de dados a ser criptografado required: - payment properties: amount: $ref: '#/components/schemas/amount' currency: $ref: '#/components/schemas/currency' customer_id: type: string maxLength: 100 description: identificador do comprador example: '6df370e7-8f97-4e7a-a36e-16ad2db6c5fc' payment: $ref: '#/components/schemas/payment' sub_merchant: type: object description: > Conjunto de dados referente ao facilitador de pagamento. Se informado, todos os atributos são obrigatórios. properties: identification_code: type: string example: '9058344' maxLength: 15 description: Identificador da sub-negociação. document_type: type: string enum: - CPF - CNPJ example: 'CNPJ' maxLength: 4 minLength: 3 description: Document type. document_number: type: string example: '20551625000159' minLength: 11 maxLength: 14 description: Documento de sub-negociação (sem máscara). address: type: string example: 'Dark Tower 44' maxLength: 40 description: Endereço de subcomércio. city: type: string maxLength: 13 example: 'city' description: Cidade do sub-comércio. state: type: string example: 'RS' minLength: 2 maxLength: 2 description: Estado da subnegociação postal_code: type: string example: '90520000' maxLength: 8 description: Código Postal (CEP) do subcomércio required: - identification_code - document_type - document_number - address - city - state - postal_code additional_data: type: object required: - idempotency_key - request_id - order_id - data description: Pedido de autorização ou compra. paymentCanceledCancelResponse: title: Cancelar resposta preenchida type: object properties: idempotency_key: type: string description: Idempotency Key example: 'ORDER-10187383-8719d0c4-2c3f-4360-abd9-8daf3834fe1f' seller_id: type: string description: código de identificação de comércio eletrônico format: uuid example: '9406df6c-3100-49ba-b4df-d81c1ad8a62b' request_id: type: string description: > Identificador de solicitação. Exclusivo para cada solicitação. Caso não informado, será gerado automaticamente. maxLength: 36 minLength: 36 format: uuid example: 'daac03dc-73db-453f-9bea-b1391669d5d3' payment_id: type: string description: Identificador de pagamento format: uuid example: '2c341d28-491b-4cf8-aec7-eeb60136b7a5' order_id: type: string description: Identificador de pedido example: 'ORDER-10187383' maxLength: 32 minLength: 1 amount: type: integer description: Valor da compra em centavos example: 8900 currency: maxLength: 3 minLength: 3 type: string description: > Identificação da moeda (Consulte em "https://www.currency-iso.org/en/home/tables/table-a1.html") example: 'BRL' status: type: string description: Status da transação example: 'CANCELED' canceled_at: type: string description: Data de Cancelamento example: '2020-07-01T02:15:03.603Z' reason_code: maxLength: 2 minLength: 2 type: string description: > Código de resposta da transação. Se diferente de '00' a transação é negada. example: '00' reason_message: type: string description: Response Message example: 'TRANSACAO EXECUTADA COM SUCESSO' custom_key: maxLength: 32 minLength: 3 type: string description: > Chave do cliente usada para identificar uma solicitação de cancelamento. (A chave deve ser única por transação). example: '20200630-8900' description: Objeto de corpo de resposta de cancelamento síncrono. paymentAcceptedCancelResponse: title: Cancelar resposta aceita type: object properties: idempotency_key: type: string description: Idempotency Key example: 'ORDER-10187383-8719d0c4-2c3f-4360-abd9-8daf3834fe1f' seller_id: type: string description: código de identificação de comércio eletrônico format: uuid example: '9406df6c-3100-49ba-b4df-d81c1ad8a62b' request_id: type: string description: > Identificador de solicitação. Exclusivo para cada solicitação. Caso não informado, será gerado automaticamente. maxLength: 36 minLength: 36 format: uuid example: 'daac03dc-73db-453f-9bea-b1391669d5d3' payment_id: type: string description: Identificador de pagamento format: uuid example: '2c341d28-491b-4cf8-aec7-eeb60136b7a5' order_id: type: string description: Identificador de pedido example: 'ORDER-10187383' maxLength: 32 minLength: 1 amount: type: integer description: Valor da compra em centavos example: 8900 currency: maxLength: 3 minLength: 3 type: string description: > Identificação da moeda (Consulte em "https://www.currency-iso.org/en/home/tables/table-a1.html") example: 'BRL' status: type: string description: Status da transação example: 'CANCELED' reason_code: maxLength: 2 minLength: 2 type: string description: > Código de resposta da transação. Se diferente de '00' a transação é negada. example: '00' reason_message: type: string description: Mensagem de resposta example: 'TRANSACAO EXECUTADA COM SUCESSO' custom_key: maxLength: 32 minLength: 3 type: string description: > Chave do cliente usada para identificar uma solicitação de cancelamento. (A chave deve ser única por transação). example: '20200630-8900' protocol: maxLength: 18 minLength: 18 type: string description: Protocolo de cancelamento example: '202006302344230001' description: > Cancele o corpo da resposta aceita. O reembolso assíncrono foi aceito e está sendo processado. cancelResult: title: Cancelar resultado type: object properties: payment_id: $ref: '#/components/schemas/payment_id' protocol: $ref: '#/components/schemas/protocol' authorization_code: $ref: '#/components/schemas/authorization_code' acquirer_transaction_id: $ref: '#/components/schemas/acquirer_transaction_id' currency: $ref: '#/components/schemas/currency' amount: $ref: '#/components/schemas/amount' status_processing_cancel_code: type: string description: Código de status da solicitação de cancelamento. status_processing_cancel_message: type: string description: Mensagem de status da solicitação de cancelamento. description: > Cancelar objeto de resultado. Este resultado só é registrado quando um reembolso assíncrono é processado. badRequest: title: badRequest type: object properties: message: type: string description: Mensagem de erro example: 'Bad Request' name: type: string description: Módulo ou serviço que retornou o erro example: 'GatewayPaymentServiceError' status_code: type: number description: HTTP Status Code example: 400 details: type: array description: Detalhes do erro items: type: object properties: status: type: string description: Status example: 'DENIED' error_code: type: string description: Código de erro example: 'GENERIC-400' payment_id: type: string description: Identificador do pagamento format: uuid example: '2c341d28-491b-4cf8-aec7-eeb60136b7a5' description: type: string description: Descrição curta do erro example: 'payment_method is invalid' description_detail: type: string description: Descrição detalhada do erro example: > The payment_method attribute is required. Please check your request and try again badRequestVerify: title: badRequest type: object properties: message: type: string description: Mensagem de erro example: 'Bad Request' name: type: string description: Módulo ou serviço que retornou o erro example: 'GatewayVerifyServiceError' status_code: type: number description: HTTP Status Code example: 400 details: type: array description: Detalhes do erro items: type: object properties: status: type: string description: Status example: 'DENIED' error_code: type: string description: Código de erro example: 'GENERIC-400' description: type: string description: Descrição curta do erro example: 'Descrição curta do erro' description_detail: type: string description: Descrição detalhada do erro example: 'Descrição detalhada do erro' unauthorized: title: unauthorized type: object properties: message: type: string description: Mensagem de erro example: 'Unauthorized' name: type: string description: Módulo ou serviço que retornou o erro example: 'GatewayAuthenticationOAuth2ServiceError' status_code: type: number description: HTTP Status Code example: 401 details: type: array description: Detalhes do erro items: type: object properties: status: type: string description: Status example: 'DENIED' error_code: type: string description: Código de erro example: 'AUTHENTICATION-401' description: type: string description: Descrição curta do erro example: 'Unauthorized' description_detail: type: string description: Descrição detalhada do erro example: 'Invalid client credentials' notFound: title: notFound type: object properties: message: type: string description: Mensagem de erro example: 'Not Found' name: type: string description: Módulo ou serviço que retornou o erro example: 'GatewayCryptoServiceError' status_code: type: number description: HTTP Status Code example: 404 details: type: array description: Detalhes do erro items: type: object properties: status: type: string description: Status example: 'DENIED' error_code: type: string description: Código de erro example: 'GENERIC-404' payment_id: type: string description: Identificador do pagamento format: uuid example: '2c341d28-491b-4cf8-aec7-eeb60136b7a5' description: type: string description: Descrição curta do erro example: 'Not Found' description_detail: type: string description: Descrição detalhada do erro example: 'The key_id not found' paymentNotFound: title: notFoundCapture type: object properties: message: type: string description: Mensagem de erro example: 'Not Found' name: type: string description: Módulo ou serviço que retornou o erro example: 'GatewayPaymentServiceError' status_code: type: number description: HTTP Status Code example: 404 details: type: array description: Detalhes do erro items: type: object properties: status: type: string description: Status example: 'DENIED' error_code: type: string description: Código de erro example: 'GENERIC-404' description: type: string description: Descrição curta do erro example: 'Not Found' description_detail: type: string description: Descrição detalhada do erro example: 'Payment not found' internalServerError: title: internalServerError type: object properties: message: type: string description: Mensagem de erro example: 'Internal Server Error' name: type: string description: Módulo ou serviço que retornou o erro example: 'GatewayRouterHTTPServicesError' status_code: type: number description: HTTP Status Code example: 500 details: type: array description: Detalhes do erro items: type: object properties: status: type: string description: Status example: 'ERROR' error_code: type: string description: Código de erro example: 'GENERIC-500' description: type: string description: Descrição curta do erro example: 'Internal Server Error' description_detail: type: string description: Descrição detalhada do erro example: 'The server encountered an unexpected error' gatewayTimeout: title: gatewayTimeout type: object properties: message: type: string description: Mensagem de erro example: 'Gateway Timeout' name: type: string description: Módulo ou serviço que retornou o erro example: 'GatewayRouterHTTPServicesError' status_code: type: number description: HTTP Status Code example: 504 details: type: array description: Detalhes do erro items: type: object properties: status: type: string description: Status example: 'ERROR' error_code: type: string description: Código de erro example: 'GENERIC-504' description: type: string description: Descrição curta do erro example: 'Gateway Timeout' description_detail: type: string description: Descrição detalhada do erro example: 'Connection timeout' 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' last_name: type: string description: Segundo nome do comprador. maxLength: 40 example: 'da Silva' 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' phone_number: type: string description: Telefone do comprador. maxLength: 15 example: '5511955554444' email: type: string description: Email do comprador. maxLength: 50 example: 'joaodasilva@dominio.com' 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: '#/components/schemas/address_boleto' payment: type: object required: - payment_method properties: payment_id: maxLength: 36 type: string description: Código do pagamento example: '6d2e4380-d8a3-4ccb-9138-c289182818a3' payment_method: type: string description: Metodo de pagamento example: 'BOLETO' enum: - BOLETO description: Id do pagamento boleto: description: Dados para geração do boleto type: object properties: our_number: maxLength: 12 minLength: 12 type: string description: > Denominado pelos bancos como **Nosso Número**. É a identificação única do boleto no sistema de cobrança e não possui máscara. É composto por regras que variam em função do banco e do serviço de cobrança. Por exemplo, no caso do Santander existem duas formas de se numerar: 1. Se o cliente informar o número, o cliente fica encarregado de informar o dv (dígito verificador); 2. Se o cliente omitir o número, o Banco fica encarregado da geração de um sequêncial, sem um DV. example: '1946598.0' document_number: maxLength: 15 minLength: 15 type: string description: > Seu Número. Número controlado pelo cliente, geralmente é gerenciado pelo sistema que está gerando o boleto. (sem máscara) 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/2030' instructions: maxLength: 1000 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."; example: 'Não receber após o vencimento' provider: maxLength: 40 type: string description: Banco provedor. example: 'santander' default: santander enum: - santander guarantor_name: type: string description: Nome do avalista. example: 'Ze pequeno' default: Ze pequeno guarantor_document_type: type: string description: Tipo de documento do avalista. example: CPF guarantor_document_number: type: string description: Numero do documento do avalista. example: '78009200021' default: '78009200021' order_final: 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 em percentual. example: 12 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 address_boleto: required: - city - district - number - postal_code - state - street type: object properties: street: maxLength: 20 type: string description: Logradouro. example: 'Av. Brasil' number: maxLength: 6 type: string description: Número do logradouro. example: '1000' complement: maxLength: 12 type: string description: Complemento do logradouro. example: 'Sala 1' district: maxLength: 30 type: string description: Bairro. example: 'São Geraldo' city: maxLength: 20 type: string description: Cidade. example: 'Porto Alegre' state: maxLength: 2 type: string description: Estado (UF). example: 'RS' postal_code: maxLength: 8 minLength: 8 type: string description: > Código Postal, CEP no Brasil ou ZIP nos Estados Unidos. (sem máscara) example: '90230060' description: Conjunto de dados referentes ao endereço do comprador error: type: object properties: message: maxLength: 250 type: string description: Mensagem detalhada do erro. name: maxLength: 250 type: string description: Nome do modulo ou sistema em que o erro ocorreu. status_code: type: number description: HTTP Status code. details: type: array description: Detalhes do erro. items: $ref: '#/components/schemas/empty' error_boleto_402: type: object properties: message: maxLength: 250 type: string description: Mensagem detalhada do erro. name: maxLength: 250 type: string description: Nome do modulo ou sistema em que o erro ocorreu. status_code: type: number description: HTTP Status code. details: type: array description: > Para mais detalhes olhar a [Tabela de Erros - Boleto](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=k54cr52h5vxfwp487okeaww9&from=#boleto). items: $ref: '#/components/schemas/empty' empty: type: object split_data: type: object required: - subseller_list_payment properties: subseller_list_payment: type: array description: Lista de Lojas e seus devidos valores para pagamento. items: type: object required: - subseller_id - document_number - subseller_sale_amount - items properties: subseller_id: maxLength: 25 minLength: 0 type: string description: ID do subseller cadastrado na plataforma de marketplace (MGM). example: '700104158' document_type: maxLength: 4 minLength: 3 type: string description: Tipo de documento do Subcomércio. example: 'CNPJ' enum: - CPF - CNPJ document_number: maxLength: 15 minLength: 11 type: string description: > Número do documento do Subcomércio sem pontuação. (sem máscara) example: '12345678912' subseller_sale_amount: type: integer description: Parte do Valor da loja em relação ao Pedido (em centavos). example: 118708 items: type: array description: Lista de items do Subcomércio. items: type: object required: - id - description - amount properties: id: maxLength: 25 minLength: 1 type: string description: Identificador do Item/Produto. example: 'MR1' description: type: string description: Descrição do Item/Produto. example: 'Produto MR1.' amount: type: integer description: Valor do Item/Produto (em centavos). example: 118708 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 **transaction_rate_percent** for informado não se deve enviar o **transaction_rate_amount**. **Obs**: Caso **transaction_rate_percent** e **transaction_rate_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 **transaction_rate_amount** for informado não se deve enviar o **transaction_rate_percent**. **Obs**: Caso **transaction_rate_percent** e **transaction_rate_amount** forem enviado para um mesmo item, os valores serão somados. example: 235 payment_plan: type: integer description: Plano de Pagamento do Subseller. example: 3 description: > Dados para realização de split de pagamento. ***Campo obrigatório para o Split de pagamento***. payment_boleto_v2: required: - idempotency_key - request_id type: object properties: idempotency_key: maxLength: 64 minLength: 1 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. example: '1eb2412c-165a-41cd-b1d9-76c575d70a21' request_id: maxLength: 36 minLength: 36 type: string description: ID de identifcação da requisição. format: uuidv4 example: '6eb2412c-165a-41cd-b1d9-76c575d70a28' data: type: object required: - amount - payment - order - boleto - customer properties: amount: type: integer description: Valor da compra em centavos. example: 100 payment: $ref: '#/components/schemas/payment' currency: maxLength: 3 minLength: 3 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: $ref: '#/components/schemas/order_final' boleto: $ref: '#/components/schemas/boleto' customer: $ref: '#/components/schemas/customer_boleto' additional_data: type: object description: > Dados adicionais da autorização. Campo obrigatório para split de pagamento. properties: split: $ref: '#/components/schemas/split_data' description: Dados do pagamento. description: Conjunto de dados referentes a transação de boleto. payment_boleto_response_v2: type: object properties: payment_id: maxLength: 24 minLength: 24 type: string description: Código de identificação do pagamento. example: '599ca35059028b001023b323' status: maxLength: 20 type: string description: > Status da transação. Para mais informações sobre os status de retorno, veja em [Notificações 1.1](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=uis74ikqfv8v87u3y5prgp68&from=) example: 'PENDING' enum: - PENDING seller_id: maxLength: 36 minLength: 36 type: string description: Código de identificação do e-commerce. format: uuidv4 example: '6eb2412c-165a-41cd-b1d9-76c575d70a28' amount: type: string description: Valor da compra em centavos. example: '100' currency: maxLength: 3 minLength: 3 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: maxLength: 36 type: string description: Código de identificação da compra utilizado pelo e-commerce. example: '6d2e4380-d8a3-4ccb-9138-c289182818a3' boleto: $ref: '#/components/schemas/payment_boleto_detail_pix' description: Conjunto de dados da resposta da emissão do boleto. payment_boleto_detail_pix: type: object properties: boleto_id: maxLength: 36 minLength: 36 type: string description: Identificação do boleto. format: uuidv4 example: 'e587cefe-8832-4fc0-acff-acc83dd66e9e' bank: maxLength: 4 minLength: 3 type: string description: Número do banco EC. (sem máscara) example: '0033' status_code: type: string description: Código do status do pagamento. example: '1' status_label: maxLength: 20 type: string description: Status do pagamento em texto example: 'EM ABERTO' typeful_line: maxLength: 54 minLength: 54 type: string description: Linha digitável do boleto. example: '03399.58910 93000.000013 94659.801016 8 71670000030015' bar_code: maxLength: 44 minLength: 44 type: string description: Código de barras do boleto. (sem máscara) example: '03397999200000002309235515900000026629840101' issue_date: maxLength: 10 minLength: 10 type: string description: Data de geração do boleto. example: '17/05/2017' expiration_date: maxLength: 10 minLength: 10 type: string description: Data de vencimento do boleto. example: '22/05/2017' our_number: maxLength: 13 minLength: 12 type: string description: Nosso número. (sem máscara) example: '0000001946598' document_number: maxLength: 15 minLength: 15 type: string description: Número do documento controlado pelo cliente. (sem máscara) example: '170500000019763' pix: type: object properties: cod_qrcode: type: string description: Código Base64 para geração da imagem do QRCode. format: Base64 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 description: URL de visualização do QRCode. format: url example: 'pix.santander.com.br/qr/v2/cobv/a796c937-80ee-483c-a8d5-72f95759fd99' description: Dados de pagamento via Pix. _links: type: array 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 items: type: object properties: {} description: Corpo com os dados do boleto. 3ds_token: required: - client_code - currency - js_version - override_payment_method - total_amount type: object properties: client_code: maxLength: 13 type: string description: > Código identificador da sessão de autenticação 3DS. O valor deve ser uma referência do pedido gerado pelo ecommerce ou número de rastreamento. Recomendamos que você envie um valor exclusivo para cada transação. Este valor será retornado na resposta dos requests nos endpoints /v1/3ds/authentications e /v1/3ds/authentications/results. O retorno será no campo client_reference_information.code na forma de uma string composta por [client_code] + [-] + [UUID] (Exemplo: client_code-00000000-0000-0000-0000-000000000000). currency: maxLength: 3 minLength: 3 type: string description: > Identificação da moeda (Consultar código em "https://en.wikipedia.org/wiki/ISO_4217"). example: 'BRL' default: 'BRL' items: $ref: '#/components/schemas/3ds_item_array_ref' js_version: maxLength: 10 type: string description: Identificação da versão da biblioteca JavaScript getnet_3ds220.js. example: '1.0.0' order_number: maxLength: 40 type: string description: > Código de identificação da compra utilizado pelo seu e-commerce (código ou número do pedido). example: '1234-2019' override_payment_method: maxLength: 2 minLength: 2 type: string description: | Indica o tipo de conta.
02 = Crédito
03 = Débito example: '02' enum: - '02' - '03' total_amount: type: integer description: Valor da compra em centavos. example: 100 additional_data: type: string description: Dados Adicionais example: '' additional_object: type: object properties: {} description: Objet Adicional example: null 3ds_authentication: required: - override_payment_method type: object properties: customer_card_alias: maxLength: 50 type: string description: > Alias que identifica exclusivamente a conta e o cartão de crédito do cliente registrados. **Nota**: Este campo é obrigatório se a tokenização estiver ativada nas configurações do perfil do ecommerce. example: 'João da Silva' override_payment_method: maxLength: 2 minLength: 2 type: string description: > Indica o tipo de conta. - 02: Crédito - 03: Débito example: '02' enum: - '02' - '03' alternate_authentication_method: maxLength: 2 minLength: 2 type: string description: > Mecanismo usado pelo titular do cartão para autenticar no seu ecommerce.
Valores possíveis:
01: Nenhuma autenticação ocorreu
02: Login usando credenciais do sistema comercial
03: Login usando ID federado
04: Login usando o FIDO Authenticator example: '02' enum: - '01' - '02' - '03' - '04' authentication: $ref: '#/components/schemas/3ds_authentication_ref' device: $ref: '#/components/schemas/3ds_device_ref' costumer_risk_information: $ref: '#/components/schemas/3ds_costumer_risk_information_ref' recurring: $ref: '#/components/schemas/3ds_recurring_ref' card: $ref: '#/components/schemas/3ds_card_ref' order: $ref: '#/components/schemas/3ds_order_ref' additional_data: type: string description: Dados Adicionais example: '' additional_object: type: object properties: {} description: Objet Adicional example: null 3ds_item_array_ref: type: array description: Lista dos items do pedido. items: $ref: '#/components/schemas/3ds_item_ref' 3ds_ship_to_ref: type: object properties: address1: maxLength: 60 minLength: 0 type: string description: > Primeira linha do endereço de entrega requisitado pelo portador. example: 'Rua XXXX, XX' address2: maxLength: 60 minLength: 0 type: string description: > Segunda linha do endereço de entrega requisitado pelo portador. Informações adicionais de endereço. example: 'Apartamento XX' administrative_area: maxLength: 2 minLength: 2 type: string description: | Estado (UF) do endereço de entrega requisitado pelo portador. example: 'RS' country: maxLength: 2 minLength: 2 type: string description: > País do endereço de entrega requisitado pelo portador (Consultar código em "https://www.iso.org/iso-3166-country-codes.html"). example: 'BR' first_name: maxLength: 60 minLength: 0 type: string description: > Primeiro nome do destinatário. example: 'João' last_name: maxLength: 60 minLength: 0 type: string description: > Sobrenome do destinatário. example: 'da Silva' locality: maxLength: 50 minLength: 0 type: string description: > Cidade do endereço de entrega requisitado pelo portador. example: Porto Alegre method: maxLength: 8 type: string description: > Método de envio para o produto. Valores possíveis: - lowcost - serviço de menor custo - sameday - serviço de correio ou mesmo dia - oneday - serviço no dia seguinte ou pernoite - twoday - serviço de dois dias - threeday - serviço de três dias - pickup - retirada da loja - other - outro método de envio - none - nenhum método de envio porque o produto é um serviço ou assinatura. Necessário para o American Express SafeKey (US). example: 'lowcost' enum: - lowcost - sameday - oneday - twoday - threeday - pickup - other - none phone_number: maxLength: 15 minLength: 0 type: string description: > Número de telefone do endereço de entrega requisitado pelo portador. (sem máscara) Código de país: 1–3 caracteres example: '555199988776' postal_code: maxLength: 10 minLength: 5 type: string description: CEP do endereço de entrega requisitado pelo portador. example: '686593' description: Conjunto de dados do endereço de entrega. 3ds_item_ref: type: object properties: description: maxLength: 255 type: string description: Descrição do item. example: 'Descricao do item' name: maxLength: 255 type: string description: Nome do item. example: 'Nome do item' sku: maxLength: 255 type: string description: Código do item na loja (Stock Keeping Unit (SKU)). example: 'XXX-00-XXX-00' quantity: type: integer description: Quantidade de itens deste produto. example: 1 total_amount: type: integer description: Valor total do item/produto em centavos. example: 100 unit_price: type: integer description: Valor unitário do item/produto em centavos. example: 100 3ds_authentication_ref: required: - token type: object properties: token: maxLength: 2000 type: string description: Token de acesso para sessão de autenticação 3DS. example: > eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIzZjczZGQ3MS03NjkyLTQyYTItYjU2Ni1jYmUzMzJkYzU3OTQiLCJpYXQiOjE1NzY2NzI3NDUsImlzcyI6IjVkNzVhYzYxNmZlM2QxMmYxODhmZmQ3YyIsIk9yZ1VuaXRJZCI6IjVkNzRlZDczZTA5MTlmMTk1ODNjMzE5MyIsIlBheWxvYWQiOiJ7XCJvcmRlck51bWJlclwiOlwic3RyaW5nXCIsXCJwYXltZW50SWRcIjpcImRhMGU4ZDkwLTQ0OGMtNGJhMC1iZGUyLTQxN2Q2YTdmZjliOVwiLFwibWVyY2hhbnRJZFwiOlwiMDU0Mzk5MlwiLFwibWVyY2hhbnROYW1lXCI6XCJFQyBUZXN0ZSBIVUIg4oCTIFBBRFJBT1wiLFwiY3VycmVuY3lcIjpcImJybFwiLFwidG90YWxBbW91bnRcIjpcIjEwMDBcIixcImpzVmVyc2lvblwiOlwic3RyaW5nXCIsXCJjbGllbnRDb2RlXCI6XCJzdHJpbmctM2Y3M2RkNzEtNzY5Mi00MmEyLWI1NjYtY2JlMzMyZGM1Nzk0XCIsXCJvdmVycmlkZVBheW1lbnRNZXRob2RcIjpcIjAyXCIsXCJpdGVtc1wiOlt7XCJ0b3RhbEFtb3VudFwiOlwiOTAwXCIsXCJ1bml0UHJpY2VcIjpcIjg5OVwiLFwicXVhbnRpdHlcIjowLFwic2t1XCI6XCJzdHJpbmdcIixcImRlc2NyaXB0aW9uXCI6XCJzdHJpbmdcIixcIm5hbWVcIjpcInN0cmluZ1wifSx7XCJ0b3RhbEFtb3VudFwiOlwiOTAwXCIsXCJ1bml0UHJpY2VcIjpcIjgwMFwiLFwicXVhbnRpdHlcIjowLFwic2t1XCI6XCJzdHJpbmdcIixcImRlc2NyaXB0aW9uXCI6XCJzdHJpbmdcIixcIm5hbWVcIjpcInN0cmluZ1wifV19IiwiT2JqZWN0aWZ5UGF5bG9hZCI6ZmFsc2UsIlJlZmVyZW5jZUlkIjoiM2Y3M2RkNzEtNzY5Mi00MmEyLWI1NjYtY2JlMzMyZGM1Nzk0IiwiZXhwIjoxNTc2NjcyODY1fQ.jrPvIjtvSY6HukI-PjBE0ACWo68whA2FhCCfKeEfB4g npa_code: maxLength: 2 minLength: 2 type: string description: > Código NPA.
01 = Adicionar cartão
02 = Manter informações do cartão
03 = Verificação do titular do cartão para o token EMV example: '01' enum: - '01' - '02' - '03' challenge_code: maxLength: 2 minLength: 2 type: string description: > Indica se um desafio é requerido pelo solicitante para essa transação.
01 = Sem preferência.
02 = Solicitado que não desafie.
03 = Desafio solicitado (preferência do 3DS Requestor).
04 = Desafio solicitado (mandate)
Nota: Se este elemento não é fornecido se utilizado o valor 01. example: '01' enum: - '01' - '02' - '03' - '04' installment_total_count: maximum: 9999 minimum: 2 type: integer description: > Indica o número máximo de parcelas permitidas para um pagamento parcelado.
Valor deve ser maior que 1 somente para compras parceladas.
Nota: É necessário se o ecommerce e o titular do cartão concordarem com os pagamentos parcelados. example: 3 message_category: maxLength: 2 minLength: 2 type: string description: > Categoria da mensagem para um caso de uso específico.
Valores possíveis:
01: autenticação de pagamento PA
02: autenticação sem pagamento NPA
80: para indicar mastercard dataonly. example: '01' enum: - '01' - '02' - '80' transaction_mode: maxLength: 1 minLength: 1 type: string description: > Identificador do modo de transação.
Identifica o canal do qual a transação se origina.
Valores possíveis:
M = Pedido por email ou telefone
P = Dispositivo Móvel
R = Varejo (Loja Física)
S = Computador
T = Tablet example: M enum: - M - P - R - S - T device_channel: maxLength: 10 type: string description: Canal do Dispositivo example: Browser acs_window_size: maxLength: 2 type: string description: > Indicação do tamanho desejado (pixels) da tela de desafio, quando for o caso.
Valores possíveis:
01: (250x400)
02: (390x400)
03: (500x600)
04: (600x400)
05: (Full page) example: '02' enum: - '01' - '02' - '03' - '04' - '05' description: Conjunto de dados do processo de autenticação. 3ds_device_ref: type: object required: - ip_address - http_browser_screen_height - http_browser_screen_width properties: http_accept_browser_value: maxLength: 255 type: string description: > Valor do cabeçalho Accept enviado pelo navegador da web do cliente.
Nota: Se o navegador do cliente fornecer um valor, você deverá incluí-lo em sua solicitação. example: text/html,application/xhtml+xml,application/xml http_accept_content: maxLength: 255 type: string description: O conteúdo exato do cabeçalho HTTP accepter. example: text/html user_agent_browser_value: maxLength: 255 type: string description: > Valor do cabeçalho User-Agent do usuário enviado pelo navegador da web do cliente.
Nota: Se o navegador do cliente fornecer um valor, você deverá incluí-lo em sua solicitação. example: Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) http_browser_color_depth: maxLength: 2 type: string description: > O valor representa a profundidade de bits da paleta de cores para exibir imagens, em bits por pixel. example: '24' http_browser_java_enabled: maxLength: 1 type: string description: > Valor que representa a habilidade do navegador do titular do cartão para execute Java. example: 'N' enum: - 'Y' - 'N' http_browser_java_script_enabled: maxLength: 1 type: string description: > Valor que representa a habilidade do navegador do titular do cartão para execute JavaScript. example: 'Y' enum: - 'Y' - 'N' http_browser_language: maxLength: 8 type: string description: > O valor representa o idioma do navegador conforme definido em IETF BCP47. example: pt-BR http_browser_screen_height: maxLength: 6 type: string description: Altura total da tela do titular do cartão em pixels. example: '260' http_browser_screen_width: maxLength: 6 type: string description: Largura total da tela do titular do cartão em pixels. example: '1366' http_browser_time_difference: maxLength: 5 type: string description: > Diferença horária entre o horário UTC e o horário local do titular do cartão, em minutos. example: '180' ip_address: maxLength: 45 type: string description: Endereço I.P. do cliente. example: 127.0.0.1 description: Conjunto de dados referentes ao dispositivo utilizado pelo comprador. 3ds_costumer_risk_information_ref: type: object properties: transaction_count_year: maximum: 999 minimum: 0 type: integer description: > Número de transações bem-sucedidas e abandonadas desta conta do titular do cartão com seu ecommerce no ultimo ano. example: 12 transaction_count_day: maximum: 999 minimum: 0 type: integer description: > Número de transações bem-sucedidas e abandonadas desta conta do titular do cartão com seu ecommerce nas ultimas 24 hora. example: 1 add_card_attempts: maximum: 999 minimum: 0 type: integer description: | Número de tentativas de adicionar cartão nas últimas 24 horas. example: 1 customer_id: maxLength: 26 type: string description: > Número do documento de identificação (NATIONAL, CPF, CPNJ, CURP, SSN, DRIVER_LICENSE). example: '12345678912' customer_type_id: maxLength: 14 type: string description: | Tipo de documento de identificação. example: CPF enum: - NATIONAL - CPF - CPNJ - CURP - SSN - DRIVER_LICENSE payment_account_history: maxLength: 23 type: string description: > Indica o tipo da conta de pagamento. Isso se aplica apenas a NEWACCOUNT e EXISTINGACCOUNT no campo creation_history. enum: - PAYMENTACCOUNTEXISTS - PAYMENTACCOUNTADDED_NOW payment_account_date: maxLength: 8 minLength: 8 type: string description: > Data de criação da conta de pagamento. Isso se aplica apenas para PAYMENTACCOUNTEXISTS no campo payment_account_history. format: YYYYMMDD example: '20191125' prior_suspicious_activity: type: boolean description: > Indica se o ecommerce teve atividade suspeita (incluindo fraude anterior) na conta. example: false description: Conjunto de dados de risco do cliente. 3ds_recurring_ref: type: object properties: end_date: maxLength: 8 minLength: 8 type: string description: > Data após a qual nenhum autorização recorrente adicional deve ser realizada.
Nota: Este campo é obrigatório para transações recorrentes. format: YYYYMMDD example: '20191201' frequency: maximum: 999 minimum: 0 type: integer description: > Indica o número mínimo de dias entre pedidos de autorização de transações recorrentes. Uma frequência mensal é indicada pelo valor 28. Múltiplos de 28 dias serão usados para indicar meses.
Exemplo: 6 meses = 168
Nota: Este campo é obrigatório para transações recorrentes. example: 4 original_purchase_date: maxLength: 17 minLength: 17 type: string description: > Data da compra original. Necessário para transações recorrentes.
Nota: Se este campo estiver vazio, a data atual será usada. format: YYYYMMDD:HH:MM:SS example: '20191201:13:40:23' description: Conjunto de dados referente ao pagamento recorente. 3ds_card_ref: required: - expiration_month - expiration_year - number_token - type_card type: object properties: number_token: maxLength: 128 minLength: 128 type: string description: Número do cartão tokenizado. example: > dfe05208b105578c070f806c80abd3af09e246827d29b866cf4ce16c205849977c9496cbf0d0234f42339937f327747075f68763537b90b31389e01231d4d13c expiration_month: maxLength: 2 minLength: 2 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' expiration_year: maxLength: 4 minLength: 4 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: '30' type_card: maxLength: 3 minLength: 3 type: string description: > Indica o código do tipo da bandeira.
001 = Visa
002 = Mastercard
003 = Amex
054 = ELO example: '1' enum: - '001' - '002' - '003' - '054' description: Conjunto de dados do cartão. 3ds_order_ref: required: - currency - product_code type: object properties: product_code: maxLength: 2 type: string description: > Especifica o código do produto, que designa o tipo de transação.
Especifique um dos seguintes valores para este campo:
01 = Compra de bens / serviços
03 = Aceitação de cheques
10 = Financiamento da conta
11 = Transação quase em dinheiro
28 = Ativação pré-paga e financiamento da conta example: '1' default: '01' enum: - '01' - '03' - '10' - '11' - '28' currency: maxLength: 3 minLength: 3 type: string description: > Identificação da moeda (Consultar código em "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL default: BRL total_amount: type: integer description: Valor total do item/produto em centavos do pedido. example: 1000 bill_to: $ref: '#/components/schemas/3ds_bill_to_ref' items: $ref: '#/components/schemas/3ds_item_array_ref' ship_to: $ref: '#/components/schemas/3ds_ship_to_ref' description: Conjunto de dados para identificação da compra. 3ds_bill_to_ref: required: - mobile_phone type: object properties: address1: maxLength: 60 minLength: 0 type: string description: > Primeira linha do endereço de cobrança do portador associado ao cartão utilizado na compra. example: Rua XXXX, XX address2: maxLength: 60 minLength: 0 type: string description: > Segunda linha do endereço de cobrança do portador associado ao cartão utilizado na compra. Informações adicionais de endereço. example: Apartamento XX administrative_area: maxLength: 2 minLength: 2 type: string description: > Estado (UF) do endereço de cobrança do portador associado ao cartão utilizado na compra. example: RS country: maxLength: 2 minLength: 2 type: string description: > País do endereço de cobrança do portador associado ao cartão utilizado na compra (Consultar código em "https://www.iso.org/iso-3166-country-codes.html"). example: BR email: maxLength: 255 minLength: 0 type: string description: > Endereço de email associado a conta que foi informado pelo portador ou já estava armazenado em cadastro prévio pelo 3DS Requestor. example: customer@email.com first_name: maxLength: 60 minLength: 0 type: string description: > Primeiro nome do cliente. Este nome deve ser o mesmo que o nome no cartão. example: João last_name: maxLength: 60 minLength: 0 type: string description: > Sobrenome do cliente. Este sobrenome deve ser o mesmo que o sobrenome no cartão. example: da Silva locality: maxLength: 50 minLength: 0 type: string description: > Cidade do endereço de cobrança do portador associado ao cartão utilizado na compra. example: Porto Alegre mobile_phone: maxLength: 15 minLength: 0 type: string description: > Número de celular fornecido pelo portador. (sem máscara) Código de país: 1–3 caracteres example: '5551999887766' phone_number: maxLength: 15 minLength: 0 type: string description: > Número de telefone fornecido pelo portador. (sem máscara) Código de país: 1–3 caracteres example: '555199988776' postal_code: maxLength: 10 minLength: 5 type: string description: > CEP do endereço de cobrança do portador associado ao cartão utilizado na compra. example: '90230060' description: Conjunto de dados do endereço de cobrança. 3ds_authentications_resp_card_ref: type: object properties: number_token: maxLength: 128 minLength: 128 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](https://www.ietf.org/rfc/rfc2616.txt)) 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 description: Conjunto de dados do cartão. 3ds_authentications_resp_client_reference_information_ref: type: object properties: code: maxLength: 13 type: string description: > Código identificador da sessão de autenticação 3DS. O valor retornado segue a forma de uma string composta por [client_code] + [-] + [UUID] (Exemplo: client_code-00000000-0000-0000-0000-000000000000). O valor client_code corresponde ao valor enviado no resquest do endpoint /v1/3ds/tokens. description: Conjunto de dados de referência do cliente. 3ds_authentications_resp_consumer_authentication_information_ref: type: object properties: acs_url: maxLength: 2048 type: string description: > URL para o formulário de autenticação do banco emissor do cartão que você recebe quando o cartão é enrolled. example: > https://merchantacsstag.cardinalcommerce.com/MerchantACSWeb/pareq.jsp?vaa=b&gold=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA authentication_path: maxLength: 12 type: string description: > Indica o que é exibido para o cliente durante o processo de autenticação. Este campo pode conter um destes valores:
ADS = cliente (cartão not enrolled) solicitado a ativar o cartão durante o processo de checkout.
ATTEMPTS = (processamento de tentativas) o processamento é exibido brevemente antes que o processo de checkout seja concluído.
ENROLLED = (Cartão enrolled) a janela de autenticação do emissor do cartão é exibida.
UNKNOWN = o status de enrollment do cartão não pode ser determinado.
NOREDIRECT = (cartão not enrolled, autenticação indisponível ou erro) nada é exibido ao cliente.
Os seguintes valores podem ser retornados se você estiver usando autenticação de pagador baseada em regras.
RIBA = o banco emissor do cartão suporta autenticação baseada em risco, mas não é possível determinar se o titular do cartão é passível de contestação.
RIBA_PASS = o banco emissor do cartão suporta autenticação baseada em risco e é provável que o titular do cartão não seja desafiado a fornecer credenciais, também conhecidas como autenticação silenciosa. example: ADS enum: - ADS - ATTEMPTS - ENROLLED - UNKNOWN - NOREDIRECT - RIBA - RIBA_PASS authentication_transaction_id: maxLength: 20 type: string description: > O identificador da transação de autenticação do pagador passado para vincular o enrollment de verificação e validar as mensagens de autenticação. example: gz3aQ1z6YBS8kK4B0A40 pareq: type: string description: > Payer authentication request (PAReq) mensagem que precisar ser encaminhada para o ACS. example: > eNpVkm1P4zAMx9/nU1Rw4hVaHja6dphIHQMNJMYYHOzuXS/1rUVrWtL0xr79Jd3Gw5vIP8t27L8NT7lBnDyiag1KuMOmSVcYFNnFUbb8uxwXabMK86Gtn0X7ELIjCfNkgW8S/qFpikpL3mM9AfSAxJUwKk+1lZCqt/HNTA7CWPAQ6B4JlGhuJpKdDfpx7FJ3SECnJcqry+AJG4vB9Oc4ODkWIjw/OeYi8u9geB7Mk8kiuQfaBRNQVaut2cpowIAegEBr1jK3tm5GlG42m57a/nH9Va1R2FNVCdQHEKCfvc5bbzVOgvcik7+v8/Ll6rb+tZzpWbnqZ9Pxy51+XsxekwugPoJAllqUggnGOIsCPhydxSMWAe38BNLSdyMXPwJ2yribfscEav9TsiPn/4puntYY1Gor48gp9kEE8L2uNLoYJ9iHTaDQjU3Xa+89mG6sz2Eup34NyjqB+yLmcRj7PXTc1SycXEJw3hUtOu2oz6H7LdP9QTjr26H8B6XetU0= proof_xml: type: string description: > Data e hora da verificação de enrollment combinada com os elementos VEReq e VERes. example: > 2020 Jan 08 17:59:08https://merchantacsstag.cardinalcommerce.com/MerchantACSWeb/vereq.jsp?acqid=CYBS1.0.2XXXXXXXXXXXX1112469216054399201.0.2Y3291969https://merchantacsstag.cardinalcommerce.com/MerchantACSWeb/pareq.jsp?gold=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAThreeDSecure proxy_pan: type: string description: > Versão criptografada do número do cartão usado na mensagem de solicitação de autenticação do pagador. example: '3291969' specification_version: maxLength: 10 type: string description: > Este campo contém a versão 3D Secure que foi usada para processar a transação. example: 2.0.0 veres_enrolled: maxLength: 1 minLength: 1 type: string description: > Resultado da verificação de enrollment.
Este campo pode conter um destes valores:
Y = cartão enrolled ou pode ser enrolled; você deve se autenticar. Mudança de responsabilidade.
N = cartão not enrolled; prossiga com a autorização. Mudança de responsabilidade.
U = não é possível autenticar independentemente do motivo. Nenhuma mudança de responsabilidade. example: 'Y' enum: - 'Y' - 'N' - U xid: maxLength: 255 type: string description: > Campo 3DS disponível a partir da versão 2.0. Identificador do MPI para cada transação autenticada. O conteúdo do campo pode ser um valor HEXA ou Base64, de acordo com o MPI utilizado. example: ODZ3MlMyZFpMZG5DRmJPUnM1ODA= token: type: string description: | Token example: AxjzbwSTOJ/N1W2cYUdd/+YBUaf/qJNr7RTZSQkiIZNJMvRiueI7APAAqRQK description: Conjunto de dados de autenticação do consumidor. 3ds_authentications_resp_error_information_ref: type: object properties: reason: type: string description: A razão do status. example: PENDING_AUTHENTICATION enum: - AVS_FAILED - CONTACT_PROCESSOR - EXPIRED_CARD - PROCESSOR_DECLINED - INSUFFICIENT_FUND - STOLEN_LOST_CARD - ISSUER_UNAVAILABLE - UNAUTHORIZED_CARD - CVN_NOT_MATCH - EXCEEDS_CREDIT_LIMIT - INVALID_CVN - DECLINED_CHECK - BLACKLISTED_CUSTOMER - SUSPENDED_ACCOUNT - PAYMENT_REFUSED - CV_FAILED - INVALID_ACCOUNT - GENERAL_DECLINE - INVALID_MERCHANT_CONFIGURATION - DECISION_PROFILE_REJECT - SCORE_EXCEEDS_THRESHOLD - PENDING_AUTHENTICATION message: type: string description: 'A mensagem descrevendo a razão do status. ' example: Este campo não está sendo devolvido pela API cybersource. description: Informações do erro. 3ds_results_ref: required: - currency - override_payment_method - total_amount type: object properties: currency: maxLength: 3 minLength: 3 type: string description: > Identificação da moeda (Consultar código em "https://www.currency-iso.org/en/home/tables/table-a1.html"). example: BRL default: BRL override_payment_method: maxLength: 2 minLength: 2 type: string description: | Indica o tipo de conta.
02 = Crédito
03 = Débito example: '02' enum: - '02' - '03' token: type: string description: Token token_challenge: type: string description: Token retornado no desafio. total_amount: type: integer description: Valor total do item/produto em centavos do pedido. example: 1000 card: $ref: '#/components/schemas/3ds_card_ref' additional_data: type: string description: Dados Adicionais example: '' additional_object: type: object properties: {} description: Objet Adicional example: null 3ds_authentication_results_resp_consumer_authentication_information_ref: type: object properties: authentication_result: maxLength: 1 type: string description: > Campo de autenticação primária que indica se a autenticação foi bem sucedida e se ocorreu a mudança de responsabilidade. Este campo contém um desses valores: - -1: PARes inválidos. - 0: Validação bem sucedida. - 1: Titular de cartão não está participando, mas a tentativa de autenticação foi registrada. - 6: Emissor incapaz de realizar autenticação. - 9: Titular de cartão não completou a autenticação. example: '0' enum: - '-1' - '0' - '1' - '6' - '9' authentication_status_msg: type: string description: > Mensagem que explica a authenticationresult do campo de resposta. example: Success indicator: maxLength: 1 type: string description: > Indicador usado para diferenciar transações de Internet de outros tipos. O valor deste campo é repassado automaticamente ao serviço de autorização se você solicitar os serviços em conjunto. example: 'spa' enum: - aesk - aesk_attempted - dipb - dipb_attempted - internet - js - js_attempted - moto - pb_attempted - recurring - spa - spa_failure - vbv - vbv_attempted - vbv_failure eci: maxLength: 2 minLength: 2 type: string description: > Campo 3DS disponível a partir da versão 2.0. Código ECI da transação Autenticada 3D Secure. Gerado por um MPI Externo. pares_status: maxLength: 1 minLength: 1 type: string description: > Resultado da verificação de autenticação. Este campo pode conter um desses valores: - A: Foi gerada a prova de tentativa de autenticação. - B: Autenticação contornada. - N: O cliente falhou ou cancelou a autenticação. Transação negada. - R: Autenticação rejeitada (usada apenas para transações 3D Secure 2.0) - U: Autenticação não concluída independentemente do motivo. - Y: O cliente foi autenticado com sucesso. example: 'Y' enum: - 'A' - 'B' - 'N' - 'R' - 'U' - 'Y' specification_version: type: string description: > Este campo contém a versão 3D Secure que foi usada para processar a transação. xid: maxLength: 40 minLength: 40 type: string description: > Campo 3DS disponível a partir da versão 2.0. Identificador do MPI para cada transação autenticada. O conteúdo do campo pode ser um valor HEXA ou Base64, de acordo com o MPI utilizado. Retorna apenas para Visa. token: type: string description: Token cavv_algorithm: maxLength: 1 type: string description: > Campo que é devolvido somente quando o CAVV é gerado, que ocorre quando paresStatus contém os valores Y (autenticação bem sucedida) ou A (tentativa de autenticação). Este campo contém um desses valores: - 2: Visa, American Express, JCB, Diners Club e Discover - 3: Mastercard example: '2' enum: - '2' - '3' ucaf: maxLength: 40 minLength: 40 type: string description: > Campo 3DS disponível a partir da versão 2.0. Código de autenticação criptografado pela Bandeira. O conteúdo do campo pode ser um valor HEXA ou Base64, de acordo com o MPI utilizado. ucaf_authentication_data: type: string description: > O AAV é um identificador exclusivo gerado pelo banco de cartões para transações Mastercard SecureCode depois que o cliente é autenticado. Retorna apenas para a Mastercard, para a Visa o campo correspondente é o CAVV. example: 'jELUbgG+Tfj0AREACMLdCae+oIs=' ucaf_collection_indicator: maxLength: 1 minLength: 1 type: string description: > Para inscrição, retornou apenas para transações mastercard. Indica que a autenticação não é necessária porque o cliente não está inscrito. Este campo contém um desses valores: - 0: Dados de autenticação não coletados, e a autenticação do cliente não foi concluída. - 1: Dados de autenticação não coletados porque a autenticação do cliente não foi concluída. - 2: Dados de autenticação coletados porque o cliente completou a autenticação. example: '2' enum: - '0' - '1' - '2' cavv: maxLength: 255 type: string description: > Identificador exclusivo gerado pelo banco emissor depois que o cliente é autenticado. example: 'AAABAWFlmQAAAABjRWWZEEFgFz+=' description: Conjunto de dados de autenticação do consumidor. pix: required: - amount - currency - idempotency_key type: object properties: amount: type: integer description: Valor da compra em centavos. example: 9000 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. Caso seja informado ele será repassado na Notificação de Pagamento PIX. example: 'DEV-1608748980' customer_id: type: string description: > Identificador do comprador utilizado pelo e-commerce. Caso seja informado ele será repassado na Notificação de Pagamento PIX. maxLength: 36 idempotency_key: maxLength: 64 minLength: 1 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. example: '1eb2412c-165a-41cd-b1d9-76c575d30a21' payment_pix_qrcode: type: object properties: payment_id: type: string description: Identificador do Pagamento. maxLength: 36 minLength: 36 format: uuid example: 'cd966c8a-cda4-4ea6-8d20-bfdd1c3da312' status: type: string description: > Status da transação. Para mais informações sobre os status de retorno, veja em [Notificações 1.1](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=uis74ikqfv8v87u3y5prgp68&from=) maxLength: 8 example: 'WAITING' enum: - PENDING - WAITING - EXPIRED - ERROR - APPROVED - DENIED description: type: string description: | Texto com uma mensagem descritiva do resultado da requisição. example: O QR Code foi gerado com sucesso e aguardando o pagamento. additional_data: 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: '9000TRXIDdnmnefxzmvfckki' 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.pix210812345678 22041234230812345678242000112233445566778899520400005303986540690005802BR5913JOHN DOE6008SAO PAULO62190515RP12345678-201980720014br.gov.bcb.pix2550bx.com.br/spi/U0VHUkVET1RPVEFMTUVOVEVBTEVBVE9SSU8=630434D1 creation_date_qrcode: type: string description: Data de criação do QR Code gerado. format: YYYY-MM-DDTHH:MM:SSZ example: '2022-06-08T10:55:07.890' expiration_date_qrcode: type: string description: Data de expiração do QR Code gerado. format: YYYY-MM-DDTHH:MM:SSZ example: '2022-06-08T10:56:07.890' 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: 45454 idempotency_key: maxLength: 64 minLength: 1 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. example: 1eb2412c-165a-41cd-b1d9-76c575d30a21 AutorizationResponseDTO: type: object 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. example: '1eb2412c-165a-41cd-b1d9-76c575d70a21' seller_id: type: string description: Código de identificação do e-commerce. example: '6eb2412c-165a-41cd-b1d9-76c575d70a28' request_id: type: string description: Identificador da requisição. Único para cada requisição. example: '6eb2412c-165a-41cd-b1d9-76c575d70a28' maxLength: 36 minLength: 36 format: uuid payment_id: type: string description: Identificador da pagamento. Único para cada pagamento. example: '06f256c8-1bbf-42bf-93b4-ce2041bfb87e' order_id: type: string description: > Código de identificação da compra utilizado pelo e-commerce (código ou número do pedido). example: '6d2e4380-d8a3-4ccb-9138-c289182818a3' amount: type: string description: Valor da compra em centavos. example: '118708' 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' status: type: string description: Status da transação. default: 'AUTHORIZED' example: 'AUTHORIZED' payment_method: type: string description: Tipo da transação. example: 'CREDIT_AUTHORIZATION' received_at: type: string description: Data e hora do registro de pagamento. example: '2017-03-19T16:30:30.764Z' transaction_id: type: string description: Código de transação da autorização. example: '1002217281190421' original_transaction_id: type: string description: Código de transação da autorização. authorized_at: type: string description: Data/hora da autorização de crédito. example: '2017-03-19T16:30:30Z' reason_code: type: string description: Código de retorno do emissor ou do sistema de captura da getnet. reason_message: type: string description: Mensagem de retorno do emissor ou do sistema de captura da getnet. example: '0' acquirer: type: string description: Nome do adquirente. example: 'GETNET' soft_descriptor: type: string description: Descrição para a fatura do cartão. example: 'Descrição para fatura' brand: type: string description: Bandeira resposável pelo o processamento da transação. example: 'Maestro' authorization_code: type: string description: Código de autorização. example: '6964722471672911' acquirer_transaction_id: type: string description: Código de transação do adquirente. example: '113880914' eci: type: string description: > Campo 3DS disponível a partir da versão 2.0. Código ECI da transação Autenticada 3D Secure. Gerado por um MPI Externo. example: '01' merchant_advice_code: type: string description: > Código complementar ao reason_code exclusivo para a bandeira Mastercard. Sua combinação com o reason_code sugere se a transação pode ser retentada ou não. example: '210' PreAutorizationResponseDTO: type: object 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. example: '1eb2412c-165a-41cd-b1d9-76c575d70a21' seller_id: type: string description: Código de identificação do e-commerce. example: '6eb2412c-165a-41cd-b1d9-76c575d70a28' payment_id: type: string description: Identificador da pagamento. Único para cada pagamento. example: '06f256c8-1bbf-42bf-93b4-ce2041bfb87e' order_id: type: string description: > Código de identificação da compra utilizado pelo e-commerce (código ou número do pedido). example: '6d2e4380-d8a3-4ccb-9138-c289182818a3' amount: type: string description: Valor da compra em centavos. example: '118708' 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' status: type: string description: Status da transação. default: 'AUTHORIZED' example: 'AUTHORIZED' adjustment_transaction_id: type: string description: Código de ajuste da transação identificado pelo Ecommerce. example: '377241145590926400' received_at: type: string description: Data e hora do registro de pagamento. example: '2017-03-19T16:30:30.764Z' original_transaction_id: type: string description: Código de transação da autorização. authorized_at: type: string description: Data/hora da autorização de crédito. example: '2017-03-19T16:30:30Z' reason_code: type: string description: Código de retorno do emissor ou do sistema de captura da getnet. reason_message: type: string description: Mensagem de retorno do emissor ou do sistema de captura da getnet. example: 'TRANSACAO EXECUTADA COM SUCESSO' acquirer: type: string description: Nome do adquirente. example: 'GETNET' soft_descriptor: type: string description: Descrição para a fatura do cartão. example: 'Descrição para fatura' brand: type: string description: Bandeira resposável pelo o processamento da transação. example: 'Maestro' authorization_code: type: string description: Código de autorização. example: '6964722471672911' acquirer_transaction_id: type: string description: Código de transação do adquirente. example: '113880914' total_installment_amount: $ref: '#/components/schemas/total_installment_amount' first_installment_amount: $ref: '#/components/schemas/first_installment_amount' other_installment_amount: $ref: '#/components/schemas/other_installment_amount' DefaultErrorHttpResponse: type: object properties: message: maxLength: 250 type: string description: Mensagem detalhada do erro. name: maxLength: 250 type: string description: Nome do modulo ou sistema em que o erro ocorreu. status_code: type: integer description: Status code HTTP do erro. format: int32 details: type: array description: Detalhes do erro. items: $ref: '#/components/schemas/ErrorDetail' ErrorDetail: type: object properties: status: type: string description: Situação do erro. default: 'DENIED' error_code: type: string description: Código de erro. description: type: string description: Descrição do erro. description_detail: type: string description: Descrição detalhada do erro. description: Detalhes do erro. CapturetDTO: type: object required: - payment_id - idempotency_key - payment_method 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: > Identificador da requisição. Único para cada requisição. Caso não seja informado, será gerado automaticamente. example: '449474ed-fd5a-421c-9108-9ecedcf02499' maxLength: 36 minLength: 36 format: uuid payment_id: type: string description: Identificador do pagamento example: 'a183f814-8c4c-47b8-8dcf-7a480bec7d7c' amount: type: integer description: Valor igual ou menor a transação original em centavos example: 118708 payment_method: type: string description: Método de pagamento enum: - CREDIT_AUTHORIZATION - CREDIT_PRE_AUTHORIZATION default: 'CREDIT_AUTHORIZATION' example: 'CREDIT_AUTHORIZATION' CaptureResponseDTO: type: object 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. example: '1eb2412c-165a-41cd-b1d9-76c575d70a21' seller_id: type: string description: Código de identificação do e-commerce. example: '6eb2412c-165a-41cd-b1d9-76c575d70a28' request_id: type: string description: > Identificador da requisição. Único para cada requisição. Caso não seja informado, será gerado automaticamente. example: '449474ed-fd5a-421c-9108-9ecedcf02499' maxLength: 36 minLength: 36 format: uuid payment_id: type: string description: Identificador do pagamento example: 'a183f814-8c4c-47b8-8dcf-7a480bec7d7c' order_id: type: string description: Código de identificação da compra utilizado pelo e-commerce example: '6d2e4380-d8a3-4ccb-9138-c289182818a3' amount: type: integer description: Valor igual ou menor a transação original em centavos example: 118708 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' status: type: string description: Status da transação. example: 'CAPTURED' reason_code: type: string description: Código de retorno. example: '0' reason_message: type: string description: Mensagem de retorno. example: 'transaction approved' captured_at: type: string description: Data da captura. format: YYYY-MM-DDTHH:mm:ss.SSSZ example: '2018-07-22T18:47:32.270Z' CancelDTO: type: object required: - idempotency_key - payment_id - payment_method 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: > Identificador da requisição. Único para cada requisição. Caso não seja informado, será gerado automaticamente. example: '05b1d7f6-532b-41d5-ac17-c1913f84919b' maxLength: 36 minLength: 36 format: uuidv4 payment_id: type: string description: Identificador do pagamento example: '78ab3a70-ea73-4cbf-904a-5fd7b0184492' additional_data: type: object description: > Dados adicionais do cancelamento. ***Campo obrigatório para o Split de pagamento***. properties: split: $ref: '#/components/schemas/split_data' amount: type: integer format: int32 description: > Valor (menor ou igual) da compra em centavos. **É permitido o cancelamento parcial (de valor menor) apenas a partir do dia seguinte à transação (D+N)** example: 118708 payment_method: type: string description: Método de pagamento enum: - CREDIT - DEBIT - CREDIT_AUTHORIZATION - CREDIT_PRE_AUTHORIZATION default: 'CREDIT_AUTHORIZATION' example: 'CREDIT_AUTHORIZATION' custom_key: type: string description: > Chave do cliente utilizada para identificar uma solicitação de cancelamento. (Chave deve ser única por transação). minLength: 3 maxLength: 32 CancelResponseDTO: type: object 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. seller_id: type: string request_id: type: string description: > Identificador da requisição. Único para cada requisição. Caso não seja informado, será gerado automaticamente. example: '449474ed-fd5a-421c-9108-9ecedcf02499' maxLength: 36 minLength: 36 format: uuidv4 payment_id: type: string description: Identificador do pagamento example: 'a183f814-8c4c-47b8-8dcf-7a480bec7d7c' order_id: type: string description: Código de identificação da compra utilizado pelo e-commerce amount: type: integer description: Valor igual ou menor a transação original em centavos example: 118708 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' status: type: string description: Status da transação. reason_code: type: string description: Código de retorno. example: '0' reason_message: type: string description: Mensagem de retorno. example: 'transaction approved' canceled_at: type: string description: Data/hora do cancelamento da transação. format: YYYY-MM-DDTHH:mm:ss.SSSZ example: '2018-07-22T18:47:32.270Z' custom_key: type: string description: > Chave do cliente utilizada para identificar uma solicitação de cancelamento. (Chave deve ser única por transação). example: '4ec33ee18f9e45bfb73c5c30667f9006' OrderItemReleaseDTO: type: object required: - id - amount properties: id: type: string description: ID do conjunto de dados. example: 'MR1' amount: type: integer description: Valor da compra em centavos format: int32 example: 118708 description: Conjunto de dados contendo os itens do pedido. releaseResponse: type: object properties: success: type: string description: Indica se houve sucesso no release. example: 'true' errors: type: array description: Array de erros. items: type: object properties: cod_error: description: Código de erro caso exista. type: string example: '0' message: type: string description: Mensagem de erro. example: 'string' 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: '#/components/schemas/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: '#/components/schemas/address' customer_filter_response: type: object required: - page - limit - total properties: customers: description: Lista de clientes type: array items: $ref: '#/components/schemas/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 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: uuid 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: '#/components/schemas/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: '#/components/schemas/plan_floating_data_with_details' plan_response: type: object properties: seller_id: description: Código de identificação do e-commerce. type: string format: uuid example: '6eb2412c-165a-41cd-b1d9-76c575d70a28' minLength: 36 maxLength: 36 plan_id: description: Identificador do plano. type: string format: uuid 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: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/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_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: '#/components/schemas/plan_floating_data_with_details' 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: '#/components/schemas/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 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: 36 maxLength: 36 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: '#/components/schemas/subscription_payment_type_shippings' device: $ref: '#/components/schemas/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_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: '#/components/schemas/subscription_payment_type_shippings_response' customer: $ref: '#/components/schemas/subscription_customer_response' plan: $ref: '#/components/schemas/subscription_plan_response' device: $ref: '#/components/schemas/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: '#/components/schemas/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_filter_response: type: object properties: subscriptions: description: Conjunto de assinaturas de recorrência. type: array items: $ref: '#/components/schemas/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_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_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: '#/components/schemas/subscription_floating_data_projection' 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: '30' bin: type: string description: Seis primeiros números do cartão. minLength: 6 maxLength: 9 example: '123412' subscription_floating_data_array_creation: type: array description: Lista de cobranças com a alterações de data e/ou valor items: $ref: '#/components/schemas/subscription_floating_data_creation' 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_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: '#/components/schemas/subscription_floating_data' 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_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: '#/components/schemas/subscription_floating_data_with_details' 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. 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. charge_filter_response: type: object required: - page - limit - total properties: charges: type: array items: $ref: '#/components/schemas/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: '13978' 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' consulta_bin_response: type: object properties: results: type: array items: $ref: '#/components/schemas/results' status: description: Mensagem de retorno do Status do BIN. type: string title: consulta_bin_response xml: name: consulta_bin_response attribute: false wrapped: false results: type: object description: Lista de informações do BIN. properties: bin: type: integer description: BIN da consulta. brand: type: string description: Nome da bandeira. brand_code: type: integer description: Código da bandeira. brazilian_issued: type: string description: Informa se o emissor é do Brasil. country: type: string description: Nome do País. country_code: type: string description: Código numérico do país. country_code_iso: type: string description: Código ISO_3166-1 do país. issuer: type: string description: Nome do emissor. product: type: string description: Produto vinculado ao BIN. type: type: string description: Tipe do BIN (credit, debit, prepaid). enum: - credit - debit - prepaid title: results xml: name: results attribute: false wrapped: false 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: '30' 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 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: '30' 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 CardDTO: type: object required: - expiration_month - expiration_year - cardholder_name properties: number: type: string description: > Número do cartão (enviar somente quando não for enviado o campo **number_token**). maxLength: 36 example: '4012001037141112' expiration_month: type: string description: Mês de expiração do cartão com dois dígitos. maxLength: 2 example: '12' expiration_year: type: string description: Ano de expiração do cartão com dois dígitos. maxLength: 2 example: '30' cardholder_name: type: string description: > Nome do comprador impresso no cartão. ***Campo obrigatório para o [Antifraude](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=)*** maxLength: 26 example: Roland Deschain security_code: type: string description: > Código de segurança. CVV ou CVC. ***Campo obrigatório para o [Antifraude](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=)*** minLength: 3 maxLength: 4 example: '517' brand: type: string description: > Bandeira do cartão. Preenchido automaticamente pela API caso não seja informado. ***Campo obrigatório para o [Antifraude](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=)*** enum: - MASTERCARD - VISA - AMEX - ELO - HIPERCARD maxLength: 50 example: Visa number_token: type: string description: > Número do cartão tokenizado (enviar somente quando não for enviado o campo **number**). maxLength: 128 minLength: 128 example: > e71084449bc70e344f77d4c382704ea2868b5e9775dced7ffcd40b3f66b167f51e352a2f289b518a11180c81478dfbdbeffd8a41f0b34564f2f0e41be8a88e11 description: Conjunto de dados do cartão. TokenizationDTO: type: object required: - type - cryptogram properties: type: type: string description: Tipo de tokenização example: TAVV enum: - UCAF - TAVV cryptogram: type: string description: Valor do criptograma gerado pelo TSP (Token Service Provider) example: '0006010865799300000620111679930000000000' eci: type: string description: Indicador ECI (Electronic Commerce Indicator) example: '00' requestor_id: type: string description: Indica o identificador do requerente do Token. example: '1234567' description: > Tipo de criptograma utilizado pelo TSP (Token Service Provider). Os valores podem ser: - TAVV Para cartões da bandeira Visa e ELO - UCAF Para cartões da bandeira Mastercard WalletCreditDTO: type: object description: > 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 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 error_payment_subscription: type: object description: > Retorno de detalhes do erro de pagamento em caso de status failed na criação da Assinatura. properties: message: type: string description: > Mensagem detalhada do erro em caso de status da Assinatura igual a failed. maxLength: 250 name: type: string description: Nome do modulo ou sistema em que o erro ocorreu. maxLength: 250 status_code: type: number description: HTTP Status code. details: type: array description: > Para mais detalhes olhar a [Tabela de Erros](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=kc4ioplsrds6qyng1epjldoz&from=). items: $ref: '#/components/schemas/error_payment_subscription_detail' error_payment_subscription_detail: type: object properties: acquirer_transaction_id: type: string description: Código de transação. maxLength: 36 description: type: string description: characters Descrição da transação. maxLength: 250 description_detail: type: string description: Detalhe da descrição da transação. maxLength: 250 error_code: type: string description: Código de erro da transação. maxLength: 36 payment_id: type: string description: Código de Pagamento. maxLength: 36 status: type: string description: Status da Transação. maxLength: 36 terminal_nsu: type: string description: Código do Terminal NSU. maxLength: 36 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](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=). example: 'hash-device-id' subscription_plan_response: description: Informações sobre o plano. type: object properties: plan_id: description: Identificador do plano. type: string format: uuid 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: '#/components/schemas/period' 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 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: '#/components/schemas/address' 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' 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: uuid example: '5d740ea0-b7d1-42f5-ad64-5a5521e12er9' minLength: 36 maxLength: 36 payment_type: $ref: '#/components/schemas/subscription_payment_type_credit_response' shippings: description: Conjunto de endereços de entrega. type: array items: $ref: '#/components/schemas/subscription_shippings' subscription_payment_type_credit_response: description: Informações do tipo de pagamento da assinatura. type: object properties: credit: $ref: '#/components/schemas/subscription_credit_response' 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: '#/components/schemas/address' 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: '#/components/schemas/address' card: $ref: '#/components/schemas/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: '30' minLength: 2 maxLength: 2 bin: type: string description: Seis primeiros números do cartão. example: '123412' minLength: 6 maxLength: 9 subscription_payment_type_shippings: description: Informações da assinatura. type: object properties: payment_type: $ref: '#/components/schemas/subscription_payment_type_credit' shippings: description: Conjunto de endereços de entrega. type: array items: $ref: '#/components/schemas/subscription_shippings' subscription_payment_type_credit: description: Informações do tipo de pagamento da assinatura. type: object required: - credit properties: credit: $ref: '#/components/schemas/subscription_credit' 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: '#/components/schemas/soft_descriptor_global' billing_address: $ref: '#/components/schemas/address' card: $ref: '#/components/schemas/subscription_card' 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 não permitidos. Qualquer informação que exceda o tamanho máximo será desconsiderada. example: 'LOJA*TESTE*COMPRA-123' 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: '30' bin: type: string description: Seis primeiros números do cartão. minLength: 6 maxLength: 9 example: '123412' 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_filter: type: object properties: plan_id: description: Identificador do plano. type: string format: uuid 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: '#/components/schemas/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: '#/components/schemas/plan_floating_data_with_details' 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' items_array: type: array description: > Conjunto de dados que descrevem os itens da compra. ***Campo obrigatório para o [Antifraude](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=)*** items: type: object properties: name: type: string description: > Nome do Produto. ***Campo obrigatório para o [Antifraude](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=)*** example: 'Copo térmico 473ML preto Stanley' price: type: integer description: > Preço unitário em centavos. ***Campo obrigatório para o [Antifraude](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=)*** example: 139.9 quantity: type: integer description: > Quantidade de itens desse produto. ***Campo obrigatório para o [Antifraude](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=)*** example: 1 sku: type: string description: > Código do item na loja (Stock Keeping Unit (SKU)). ***Campo obrigatório para o [Antifraude](https://devportalgetnetbr-hml.sensedia-eng.com/products-docs/rv4tz0jamap7lsor1myfb6zs?doc=n8cqrhshx04swnfxkx99iw9r&from=)*** example: 'XXX-00-XXX-00' AddressDTO: 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. Informe no padrão ISO 3166-1 alfa-3 Exemplo BRA, USA e ARG. 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'

API de Idempotência | Plataforma Digital