swagger: "2.0" schemes: - https consumes: - application/json produces: - application/json host: api-homologacao.getnet.com.br info: title: API de links de pagamento | Referência da plataforma digital version: 1.0.0 description: > # API ## Introdução O objetivo deste documento é descrever a interface das APIs de integração da plataforma digital da Getnet com o comércio eletrônico. tags: - name: Authentication x-displayName: Authentication description: As APIs listadas nesta documentação usam a autenticação OAuth2, o que significa que em todas as solicitações é necessário inserir um token de acesso que será obtido por meio da autenticação com seu ID de cliente e segredo do cliente. - name: GetPay x-displayName: GetPay description: > A API GetPay permite que o lojista crie, edite e consulte transações por meio de link de pagamento. Ao clicar em GetPay, o comprador é levado para o ambiente Getnet com identificação do comprador, endereço de entrega e checkout Getnet para finalizar a compra. Para contratar, procure seu gerente ou entre em contato com o número 4020 4009. Abaixo estão os endpoints para criar e gerenciar o GetPays: paths: /auth/oauth/v2/token: post: summary: Gerando o token de acesso description: > Endpoint responsável por gerar o token de acesso usado em outras solicitações, para isso usamos [Autenticação básica HTTP] ( https://www.w3.org/Protocols/HTTP/1.0/draft-ietf-http-spec.html#BasicAA) tags: - Authentication consumes: - application/x-www-form-urlencoded produces: - application/json parameters: - in: header name: Content-type required: true type: string enum: - application/x-www-form-urlencoded default: application/x-www-form-urlencoded description: | Tipo de conteúdo padrão application/x-www-form-urlencoded. - in: header name: Authorization required: true type: string description: 'Autorização: *AuthString* básica
em que *authString* é a concatenação de seu ID de cliente, seguido por “:" (dois pontos) mais seu segredo de cliente, convertido em base64.
Por exemplo: Para 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 2xPZW50LTaxonnly3JLDC1RZXKTMDI=.
Nesse caso, a Autorização no cabeçalho da solicitação será:
Autorização: Básica 2xPZW50LTaxonNLY3JLDC1RZXKTMDI=' - in: formData required: true type: string name: scope description: Use o valor fixo “oob” default: oob - in: formData required: true type: string name: grant_type description: Use o valor fixo “client_credentials” default: client_credentials responses: "200": description: Retorna o token de acesso. schema: type: object properties: access_token: type: string description: Token de acesso à API a ser enviado com todas as solicitações example: ca22a2ge-1914-4b0c-a0fb-d3ce0fde7346 format: uuidv4 minLength: 36 maxLength: 36 token_type: type: string description: Tipo de token, deve ser enviado no cabeçalho com o token (https://tools.ietf.org/html/rfc6750) example: Bearer expires_in: type: number description: Período de expiração do token em segundos example: 3600 scope: type: string description: Escopo do token example: oob "400": description: Solicitação inválida. schema: $ref: "#/definitions/error_authentication" "401": description: Não autorizado. schema: $ref: "#/definitions/error_authentication" x-code-samples: - lang: cURL source: | curl -X POST \ https://api-homologacao.getnet.com.br/auth/oauth/v2/token \ -H 'authorization: Basic 2xpZW50LTAxOnNlY3JldC1rZXktMDI=' \ -H 'content-type: application/x-www-form-urlencoded' \ -d 'scope=oob&grant_type=client_credentials' /v1/payment-links: post: summary: Criação do GetPay. description: Endpoint responsável pela criação do link de pagamento tags: - GetPay consumes: - application/json produces: - application/json parameters: - required: true description: Tipo de conteúdo. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: > Autorização: Portador *AuthString* Onde *AuthString*
é o token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: false description: Código de identificação do comércio eletrônico. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true in: body name: body description: Requisição contendo os dados do GetPay. schema: $ref: "#/definitions/payment_link_request" responses: "201": description: Criado schema: $ref: "#/definitions/payment_link_request_response" "400": description: Solicitação inválida. schema: $ref: "#/definitions/error" "401": description: Autenticação inválida. schema: $ref: "#/definitions/errorgetpay401" "500": description: Erro interno do servidor ou do serviço. schema: $ref: "#/definitions/error" get: summary: Obtenha uma consulta de pagamento por filtro description: Nesse endpoint, é possível obter dados de todos os links de pagamento criados pelo estabelecimento. Essa API deve ser usada com o objetivo de analisar todos os links criados; para obter mais detalhes, uma API diferente deve ser usada. Vários filtros podem ser usados para ajudar a analisar os dados. tags: - GetPay produces: - application/json parameters: - required: true description: > Autorização: Portador *AuthString* Onde *AuthString*
é o token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: false description: Código de identificação do comércio eletrônico. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - name: label description: Filtre pela etiqueta de identificação do link de pagamento. type: string in: query - name: expiration_since description: Data e hora de validade no formato ISO. Filtro “a partir de”. type: string in: query - name: credit description: Filtre por tipo de pagamento de crédito ativado. type: string in: query - name: debit description: Filtre por tipo de pagamento de débito ativado. type: string in: query - name: created_since description: Data e hora da criação no formato ISO. Filtro “a partir de”. type: string in: query - name: created_until description: Data e hora da criação no formato ISO. Filtro “antes de”. type: string in: query - name: status description: Filtrar por status GetPay. type: string enum: - SUSPENDED - ACTIVE - EXPIRED in: query - name: limit description: Limite de resultados por pesquisa. type: string minimum: 1 maximum: 20 default: 10 in: query - name: page description: Página de resultados. type: integer in: query - name: expiration_until description: Data e hora de expiração no formato ISO. Filtro “antes de”. type: string in: query responses: "200": description: OK schema: $ref: "#/definitions/payment_link_filter_response" "400": description: Solicitação inválida. schema: $ref: "#/definitions/error" "401": description: Autenticação inválida. schema: $ref: "#/definitions/errorgetpay401" "404": description: Não encontrado schema: $ref: "#/definitions/error" "500": description: Erro interno do servidor ou do serviço. schema: $ref: "#/definitions/error" /v1/payment-links/{link_id}: patch: summary: Altere os dados do Getpay. description: Atualize as propriedades do Getpay. tags: - GetPay consumes: - application/json produces: - application/json parameters: - required: false description: Código de identificação do comércio eletrônico. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: Tipo de conteúdo. enum: - application/json; charset=utf-8 default: application/json; charset=utf-8 type: string name: Content-Type in: header - required: true description: > Autorização: Portador *AuthString* Onde *AuthString*
é o token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true in: body name: body description: Conjunto de dados GetPay a ser atualizado. schema: $ref: "#/definitions/payment_link_alteration" - required: true type: string description: ID GetPay que originou a ordem de pagamento. name: link_id in: path responses: "200": description: OK schema: $ref: "#/definitions/payment_link_alteration_response" "400": description: Solicitação inválida. schema: $ref: "#/definitions/error" "401": description: Autenticação inválida. schema: $ref: "#/definitions/error" "500": description: Erro interno do servidor ou do serviço. schema: $ref: "#/definitions/error" get: summary: Consulta de dados Getpay. description: Um link de pagamento pode ter vários pedidos de venda, essa API tem como objetivo principal demonstrar as informações de registro do link e quantos pedidos e vendas ele teve tags: - GetPay produces: - application/json parameters: - required: false description: Código de identificação do comércio eletrônico. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: > Autorização: Portador *AuthString* Onde *AuthString*
é o token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true type: string description: ID GetPay que originou a solicitação de pagamento. name: link_id in: path responses: "200": description: OK schema: $ref: "#/definitions/payment_link_consult_response" "400": description: Solicitação inválida. schema: $ref: "#/definitions/error" "401": description: Autenticação inválida. schema: $ref: "#/definitions/error" "500": description: Erro interno do servidor ou do serviço. schema: $ref: "#/definitions/error" /v1/payment-links/{link_id}/payment-orders/{payment_order_id}: get: summary: Consulta de pagamento relacionada ao GetPay. description: Essa API permite obter todas as informações de tentativas de pagamento, retornando todos os dados autorizados processados pela GetNet. Essa API é essencial para determinar o motivo de um pagamento ser negado, a data e a hora em que o pagamento foi processado, etc... Todas essas informações retornam de forma independente se a transação for aprovada ou negada. tags: - GetPay produces: - application/json parameters: - required: false description: Código de identificação do comércio eletrônico. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: > Autorização: Portador *AuthString* Onde *AuthString*
é o token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: true description: ID GetPay que originou a solicitação de pagamento. type: string name: link_id in: path - required: true description: ID da solicitação de pagamento. type: string name: payment_order_id in: path responses: "200": description: OK - A transação em bloco nos pagamentos pode variar de acordo com o tipo de pagamento (DÉBITO, DÉBITO NÃO AUTENTICADO, CRÉDITO, CRÉDITO NÃO AUTENTICADO, PIX, QRCODE) schema: $ref: "#/definitions/payment_link_payment_consult_response" "400": description: Solicitação inválida. schema: $ref: "#/definitions/error" "401": description: Autenticação inválida. schema: $ref: "#/definitions/error" "500": description: Erro interno do servidor ou do serviço. schema: $ref: "#/definitions/error" /v1/payment-links/{link_id}/payment-orders: get: summary: Consulta de pagamento vinculada ao GetPay. description: Um link de pagamento pode ter vários pedidos e vendas. No pedido de venda, o pagamento só é considerado bem-sucedido quando uma tentativa de pagamento é aprovada com sucesso. Essa API permite obter informações de pedidos e vendas que foram enviados no momento da transação tags: - GetPay produces: - application/json parameters: - required: false description: Código de identificação do comércio eletrônico. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header - required: true description: > Autorização: Portador *AuthString* Onde *AuthString*
é o token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - type: string in: query name: customer_email description: Filtro de pesquisa por endereço de e-mail do cliente. - type: string in: query name: payment_id description: ID do pagamento vinculado à solicitação de pagamento. - type: string in: query name: created_since description: Data e hora de criação no formato ISO. Filtro “a partir de”. - type: string in: query name: created_until description: Data e hora de criação no formato ISO. Filtro “antes de”. - type: string description: ID que originou a solicitação de pagamento. name: link_id in: path required: true responses: "200": description: OK schema: $ref: "#/definitions/payment_link_linked_response" "400": description: Solicitação inválida. schema: $ref: "#/definitions/error" "401": description: Autenticação inválida. schema: $ref: "#/definitions/error" "500": description: Erro interno do servidor ou do serviço. schema: $ref: "#/definitions/error" /v1/payment-links/enabled-products: get: summary: Consulte os produtos habilitados para usar o Getpay description: Consulte os produtos habilitados para usar o Getpay tags: - GetPay produces: - application/json parameters: - required: true description: > Autorização: Portador *AuthString* Onde *AuthString*
é o token de acesso obtido no endpoint de autenticação. type: string name: Authorization in: header - required: false description: Código de identificação do comércio eletrônico. type: string name: seller_id format: uuidv4 minLength: 36 maxLength: 36 in: header responses: "200": description: OK schema: $ref: "#/definitions/payment_link_filter_response_enabled_products" "400": description: Solicitação inválida. schema: $ref: "#/definitions/error" "401": description: Autenticação inválida. schema: $ref: "#/definitions/error" "500": description: Erro interno do servidor ou do serviço. schema: $ref: "#/definitions/error" definitions: address: type: object description: Conjunto de dados relacionados ao endereço do comprador properties: street: type: string description: Rua. maxLength: 60 example: Av. Brasil number: type: string description: Número da rua. maxLength: 10 example: "1000" complement: type: string description: Complemento de rua. maxLength: 60 example: Sala 1 district: type: string description: Distrito. maxLength: 40 example: São Geraldo city: type: string description: Cidade. maxLength: 40 example: Porto Alegre state: type: string description: Estado. 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 CEP nos Estados Unidos - (sem máscara) maxLength: 8 example: "90230060" payment_link_request: type: object description: Solicitação contendo os dados do GetPay. required: - label - order - payment properties: label: type: string description: Etiqueta de identificação GetPay. example: cart1 minLength: 6 maxLength: 36 expiration: type: string description: Data de expiração do GetPay. format: date-time max_orders: type: integer description: Número máximo de vendas que o GetPay permitirá. minimum: 1 order: $ref: "#/definitions/payment_link_order" payment: $ref: "#/definitions/payment_link_payment" payment_link_order: type: object description: Informações do pedido. required: - product_type - title - description - amount properties: product_type: type: string description: Tipo de produto vinculado à compra. enum: - cash_carry - digital_content - digital_goods - digital_physical - gift_card - physical_goods - renew_subs - shareware - service title: type: string description: Título do pedido. maxLength: 128 description: type: string description: Descrição do pedido. maxLength: 1024 order_prefix: type: string description: Prefixo de ID do pedido. maxLength: 16 shipping_amount: type: integer description: Valor em centavos do frete. amount: type: integer description: Valor em centavos do carrinho. payment_link_payment: type: object description: Configuração dos tipos de pagamento disponíveis no GetPay. required: - credit - debit properties: credit: $ref: "#/definitions/payment_link_credit" debit: $ref: "#/definitions/payment_link_debit" wallet: $ref: "#/definitions/payment_link_qrcode" pix: $ref: "#/definitions/payment_link_pix" payment_link_credit: type: object description: Configuração dos tipos de crédito. required: - enable properties: enable: type: boolean description: Ativa o tipo de pagamento na finalização da compra do GetPay. max_installments: type: integer description: Número máximo de parcelas. minimum: 1 maximum: 12 example: 1 not_authenticated: type: boolean description: Ativa a opção de pagamento sem autenticação para o meio de pagamento. default: false authenticated: type: boolean description: Ativa a opção de pagamento com autenticação para os meios de pagamento. default: true payment_link_debit: type: object description: Configuração dos tipos de débito. required: - enable properties: enable: type: boolean description: Ativa o tipo de pagamento na finalização da compra do GetPay. caixa_virtual_card: type: boolean description: Habilita a opção de cartão virtual Caixa na finalização da compra do GetPay. default: false not_authenticated: type: boolean description: Ativa a opção de pagamento sem autenticação para o meio de pagamento. default: false authenticated: type: boolean description: Ativa a opção de pagamento com autenticação para os meios de pagamento. default: true payment_link_qrcode: type: object description: Configuração do método do QRCode. required: - enable properties: enable: type: boolean description: Ativa o método de pagamento na finalização da compra do GetPay. \n(payment.wallet.enabled pode ser enviado = true se payment.credit.enabled ou payment.debit.enabled = true) payment_link_pix: type: object description: Configuração do tipo de pagamento QR Code PIX. required: - enable properties: enable: type: boolean description: Habilita o tipo de pagamento QR Code PIX na finalização da compra do GetPay. payment_link_request_response: type: object properties: amount: type: integer description: Valor em centavos do carrinho. minimum: 0 label: type: string description: Etiqueta de identificação GetPay. link_id: type: string description: ID do link de pagamento. format: uuid created_at: type: string description: Data de criação do GetPay. format: date-time updated_at: type: string description: Data da última atualização do GetPay. format: date-time max_orders: type: string description: Número máximo de vendas que o GetPay permitirá. status: type: string description: Obtenha o status de pagamento. enum: - ACTIVE - SUSPENDED - EXPIRED url: type: string description: URL do GetPay. format: uri expiration: type: string description: Data de expiração do GetPay. format: date-time payment_link_filter_response: type: object properties: page_number: type: integer description: Número da página atual. minimum: 0 total_pages: type: integer description: Número total de páginas. minimum: 0 result: type: array description: Lista de resultados da pesquisa. items: $ref: "#/definitions/payment_link_result" total: type: integer description: Número total de resultados. minimum: 0 per_page: type: integer description: Número de resultados por página. minimum: 0 payment_link_filter_response_enabled_products: type: object properties: debit: type: object description: Lista de resultados de pagamento por débito. items: $ref: "#/definitions/payment_link_result_enabled_products" credit: type: object description: Lista de resultados de pagamento de crédito. items: $ref: "#/definitions/payment_link_result_enabled_products" pix: type: object description: Lista de resultados de pagamento por pix. items: $ref: "#/definitions/payment_link_result_enabled_products_pix" qr-code: type: object description: Lista de resultados de pagamento com código qr. items: $ref: "#/definitions/payment_link_result_enabled_products_qrcode" payment_link_result_enabled_products: type: object description: Item da lista de resultados. properties: enabled: type: boolean description: Identifica se o produto está ativado. example: true authenticated: type: boolean description: Identifica se o pagamento autenticado está ativado. example: true not_authenticated: type: boolean description: Identifica se o pagamento não autenticado está ativado. example: true payment_link_result_enabled_products_pix: type: object description: Item da lista de resultados. properties: enabled: type: boolean description: Identifica se o pix está habilitado. example: true activated: type: boolean description: Identifica se a foto está ativa. example: true payment_link_result_enabled_products_qrcode: type: object description: Item da lista de resultados. properties: enabled: type: boolean description: Identifica se o código qr está ativado. example: true payment_link_result: type: object description: Item da lista de resultados. properties: link_id: type: string description: ID do link de pagamento. format: uuid label: type: string description: Etiqueta de identificação do link de pagamento. amount: type: integer description: Valor em centavos do carrinho. links: type: array description: Links relacionados ao resultado. items: $ref: "#/definitions/payment_link_links" created_at: type: string description: Data de criação do GetPay. format: date-time url: type: string description: URL do GetPay access_counter: type: integer description: | Balcão de acesso. Toda vez que o link é acessado, é incrementado. status: type: string description: Obtenha o status de pagamento. enum: - SUSPENDED - ACTIVE - EXPIRED shipping_amount: type: integer description: Valor em centavos do frete. title: type: integer description: Título do carrinho exibido no GetPay. expiration: type: string description: Data de validade no formato ISO. format: uri max_orders: format: date-time description: Número máximo de vendas no GetPay. type: integer payment_link_links: type: object description: Links relacionados ao resultado. properties: rel: type: string description: Relação do URL em relação ao resultado. href: type: string description: URL do recurso. format: uri payment_link_alteration: type: object properties: max_orders: description: Número máximo de vendas que o GetPay permitirá. type: integer expiration: type: string description: Data de expiração do GetPay. format: date-time status: type: string description: Obtenha o status de pagamento. enum: - SUSPENDED - ACTIVE - EXPIRED payment_link_alteration_response: type: object properties: created_at: type: string description: Data de criação do GetPay. format: date-time updated_at: type: string description: Data da última atualização do GetPay. format: date-time link_id: type: string description: ID do link de pagamento. format: uuidv4 order: $ref: "#/definitions/payment_link_order_response" payment: $ref: "#/definitions/payment_link_payment_response" status: type: string description: Obtenha o status de pagamento. enum: - ACTIVE - SUSPENDED - EXPIRED - SOLD_OUT seller_id: type: string description: ID do vendedor que criou o GetPay. format: uuid max_orders: type: integer description: Número máximo de vendas do GetPay. successfull_orders: type: integer description: Número de vendas bem-sucedidas do GetPay. access_counter: type: integer description: Balcão de acesso. Toda vez que o link é acessado, ele é incrementado. expiration: type: string description: Data de expiração do GetPay. format: date-time merchant: $ref: "#/definitions/payment_link_merchant_response" url: type: string description: URL do GetPay. payment_orders_created: type: integer description: Número de pedidos de venda criados. Os pedidos são gerados quando um usuário preenche o formulário de compra, mesmo que ele abandone a compra. label: type: string description: Etiqueta de identificação GetPay. last_order_at: type: string description: Data do último pedido criado pelo GetPay. payment_link_order_response: type: object description: Informações do pedido properties: product_type: type: string description: Tipo de produto vinculado à compra. enum: - cash_carry - digital_content - digital_goods - digital_physical - gift_card - physical_goods - renew_subs - shareware - service title: type: string description: Título do pedido. description: type: string description: Descrição do pedido. amount: type: integer description: Valor em centavos do carrinho. shipping_amount: type: integer description: Valor em centavos do frete. order_prefix: type: string description: Prefixo de ID do pedido. payment_link_payment_response: type: object description: Configuração dos tipos de pagamento disponíveis no GetPay. properties: credit: $ref: "#/definitions/payment_link_credit_response" debit: $ref: "#/definitions/payment_link_debit_response" wallet: $ref: "#/definitions/payment_link_qrcode_response" pix: $ref: "#/definitions/payment_link_pix_response" payment_link_credit_response: type: object description: Configurações do tipo de pagamento a crédito. properties: enable: type: boolean description: Ativa o tipo de pagamento na finalização da compra do GetPay. max_installments: type: integer description: Número máximo de parcelas. minimum: 0 maximum: 24 payment_link_debit_response: type: object description: Configurações do tipo de pagamento por débito. properties: enable: type: boolean description: Habilita o tipo de pagamento na finalização da compra do GetPay authenticated: type: boolean default: true description: | Habilita a opção de pagamento com autenticação para os meios de pagamento. not_authenticated: type: boolean default: false description: | Permite a opção de pagamento sem autenticação para os meios de pagamento. caixa_virtual_card: type: boolean default: false description: Habilita a opção de cartão virtual Caixa no checkout do GetPay. payment_link_qrcode_response: type: object description: Configurações do método de pagamento QRcode. properties: enable: type: boolean description: Habilita o método de pagamento QRcode na finalização da compra do GetPay payment_link_pix_response: type: object description: Configurações do tipo de pagamento QR Code PIX. properties: enable: type: boolean description: Ativa a opção QR Code PIX na finalização da compra do GetPay. payment_link_merchant_response: type: object description: Dados da CE que criou o GetPay. properties: name: type: string description: Nome do EC que criou o GetPay. document: type: string description: Número do documento da CE que criou o GetPay. document_type: type: string description: Tipo do documento EC que gerou o GetPay. payment_link_consult_response: type: object properties: created_at: type: string description: Data de criação do GetPay. format: date-time updated_at: type: string description: Data da última atualização do GetPay. format: date-time link_id: type: string description: ID do link de pagamento. format: uuid order: $ref: "#/definitions/payment_link_order_response" payment: $ref: "#/definitions/payment_link_payment_response" status: type: string description: Obtenha o status de pagamento. enum: - ACTIVE - SUSPENDED - EXPIRED - SOLD_OUT seller_id: type: string description: ID do vendedor que criou o GetPay. format: uuid max_orders: type: integer description: Número máximo de vendas do GetPay. successfull_orders: type: integer description: Número de vendas bem-sucedidas do GetPay. access_counter: type: integer description: Balcão de acesso. Toda vez que o link é acessado, ele é incrementado. payment_orders_created: type: integer description: | Número de pedidos de venda criados. Os pedidos são gerados quando um usuário preenche o formulário de compra, mesmo que ele saia comprar. expiration: type: string description: Data de expiração do GetPay. format: date-time url: type: string description: URL do GetPay. merchant: $ref: "#/definitions/payment_link_merchant_response" label: type: string description: Etiqueta de identificação GetPay. last_order_at: type: string description: Data do último pedido criado pelo GetPay. payment_link_payment_consult_response: type: object properties: quantity: type: integer description: Número de carrinhos vendidos nesta ordem de pagamento. minimum: 1 amount: type: integer description: Valor em centavos do pedido de compra. minimum: 1 status: type: string description: Status do pedido feito por meio do link de pagamento. enum: - SUCCESSFULL - CREATED - FAILED payment_order_id: type: string description: ID da ordem de pagamento. customer: $ref: "#/definitions/payment_link_customer" payments: $ref: "#/definitions/payment_link_payments_response" shippings: $ref: "#/definitions/payment_link_shippings" updated_at: type: string description: Data de atualização da ordem de pagamento. created_at: type: string description: Data de criação da ordem de pagamento. seller_id: type: string description: ID do vendedor vinculada à ordem de pagamento. link_id: type: string description: ID GetPay que originou a ordem de pagamento. shipping_amount: description: Valor do frete em centavos. type: integer payment_link_customer: type: object description: Conjunto de dados do comprador. properties: first_name: type: string description: Primeiro nome do comprador. last_name: type: string description: Sobrenome do comprador. email: type: string description: E-mail do comprador. document_number: type: string description: Número do documento do comprador. document_type: type: string description: Tipo de documento de identificação do comprador. phone_number: type: string description: Telefone do comprador. billing_address: $ref: "#/definitions/payment_link_billing_address" payment_link_billing_address: type: object description: Endereço de cobrança. properties: postal_code: type: string description: Código postal, CEP no Brasil ou CEP nos Estados Unidos. street: type: string description: Lugar público. number: type: string description: Número da rua. complement: type: string description: Complemento da rua. district: type: string description: Bairro. city: type: string description: Cidade. state: type: string description: Estado (UF). country: type: string description: País. payment_link_payments_response: type: array description: Lista de dados de pagamento vinculados ao pedido. items: type: object properties: payment_id: type: string description: ID de pagamento. registred_at: type: string description: Data e hora do registro do pagamento. status: type: string description: Status da transação. payment_type: type: string description: Tipo de pagamento. enum: - CREDIT - DEBIT amount: type: integer description: Valor da compra em centavos. transaction_type: type: string description: Tipo de transação realizada. enum: - FULL - INSTALL_NO_INTEREST - INSTALL_WITH_INTEREST transaction: type: object description: Devolução da transação. number_installments: description: Número de parcelas de uma transação de crédito parcelado. type: integer payment_link_shippings: type: object description: Conjunto de dados referente ao endereço de entrega. properties: address: $ref: "#/definitions/address" same_as_billing_address: description: Bandeira de endereço de entrega igual ao endereço de cobrança. type: boolean payment_link_linked_response: type: array items: type: object properties: page_number: type: integer minimum: 0 description: Número da página atual. total_pages: type: integer minimum: 0 description: Número total de páginas. result: $ref: "#/definitions/payment_link_result_response" per_page: type: integer minimum: 0 description: Número total de resultados. total: type: integer minimum: 0 description: Número de resultados por página. payment_link_result_response: type: array description: Lista de resultados da pesquisa. items: type: object properties: status: type: string enum: - SUCCESSFULL - FAILED - CREATED description: Status do pedido feito por meio do link de pagamento. quantity: type: integer minimum: 1 description: Número de carrinhos vendidos nesta ordem de pagamento. amount: type: integer minimum: 1 description: Valor em centavos do pedido de compra. payment_order_id: type: string description: ID da ordem de pagamento. links: $ref: "#/definitions/payment_link_links" created_at: type: string format: date-time description: Data de criação da ordem de pagamento. email: type: string description: E-mail do comprador. first_name: type: string description: Primeiro nome do comprador. last_name: type: string description: Sobrenome do comprador. document_number: type: string description: Número do documento do titular. document_type: type: string description: Tipo de documento do titular. error: type: object properties: message: type: string description: Mensagem de erro detalhada. maxLength: 250 name: type: string description: Nome do módulo ou sistema em que o erro ocorreu. maxLength: 250 status_code: type: number description: Código de status HTTP. details: type: array description: Detalhes do erro. items: $ref: "#/definitions/empty" errorgetpay401: type: object properties: message: type: string description: Mensagem de erro detalhada. maxLength: 250 example: Unauthorized name: type: string description: Nome do módulo ou sistema em que o erro ocorreu. maxLength: 250 example: GatewayAuthenticationOAuth2ServiceError status_code: type: number description: Código de status HTTP. example: 401 details: type: array description: Detalhes do erro. items: $ref: "#/definitions/array" array: type: object properties: status: type: string description: Mensagem de erro detalhada. maxLength: 250 example: DENIED error_code: type: string description: Nome do módulo ou sistema em que o erro ocorreu. maxLength: 250 example: AUTHENTICATION-401 description: type: number description: Código de status HTTP. example: UnAuthorized description_detai: type: string description: Detalhes do erro. example: Invalid cliente credentials error_authentication: type: object properties: error: type: string description: Mensagem de erro. error_description: type: string description: Descrição do erro. empty: type: object properties: {}