Pular para o conteúdo principal
Todos os sistemas operacionaisNovidadesv1
Entrar
DEUNA API

Catálogo de pontos de extremidade

Rotas canônicas para os pontos de extremidade de pedido, pagamento, usuário, cartão e assinatura da DEUNA, referenciados ao longo da documentação.

Nesta página

Utilize este catálogo quando um guia faz referência a uma operação da API. Os caminhos e os métodos HTTP são mantidos estáveis aqui, para que guias de integração mais antigos apontem para um destino útil e atual.

Inventário completo do API Gateway#

Este inventário é gerado a partir da configuração atual do API Gateway, e não a partir do menor "snapshot" OpenAPI legado. Utilize os filtros para identificar quem deve chamar uma operação, qual serviço a possui, qual autorização ela suporta e quais cabeçalhos o gateway aceita ou encaminha.

O catálogo inclui APIs para comerciantes e clientes, rotas para parceiros, callbacks de provedores e rotas públicas para navegadores. Operações de administração interna e de gestão estão excluídas. Os callbacks de provedores são apresentados para fins de integração e não devem ser chamados por integrações de comerciantes.

Inventário verificado do API Gateway385 operações configuradas

Gerado a partir das rotas públicas da configuração efetiva do API Gateway.

Backend da loja · servidor a servidor 278Aplicativo do cliente · usuário para servidor 62Backend de rede ou parceiro 15Callback do provedor · provedor para DEUNA 27Navegador público ou infraestrutura 3
Exibindo 385 de 385 operações
Backend da loja · servidor a servidorUse a partir de um backend confiável da loja para pedidos, pagamentos e fluxos operacionais.278
GET/cards/bin/{bin}
Cards and vaultBackend da loja · servidor a servidor

Obter Bin.

Domínio
Cards and vault
Serviço responsável
Card metadata
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
X-Api-KeyX-Merchant-Id
Testar
Exemplo de cURL
POST/merchants/external-orders/{order_token}/gift-cards
Cards and vaultBackend da loja · servidor a servidor

Criar Gift Cards.

Domínio
Cards and vault
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-Key
Testar
Exemplo de cURL
POST/merchants/external-orders/{order_token}/coupons
CheckoutBackend da loja · servidor a servidor

Criar Coupons.

Domínio
Checkout
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-Key
Testar
Exemplo de cURL
DELETE/merchants/external-orders/{order_token}/coupons/{coupon_code}
CheckoutBackend da loja · servidor a servidor

Excluir Coupons.

Domínio
Checkout
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-Key
Testar
Exemplo de cURL
PATCH/merchants/external-orders/{order_token}/custom-fields
CheckoutBackend da loja · servidor a servidor

Atualizar Custom Fields.

Domínio
Checkout
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-Key
Testar
Exemplo de cURL
POST/merchants/external-orders/{order_token}/shipping-methods
CheckoutBackend da loja · servidor a servidor

Criar Shipping Methods.

Domínio
Checkout
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-Key
Testar
Exemplo de cURL
PATCH/merchants/external-orders/{order_token}/shipping-methods/{code}
CheckoutBackend da loja · servidor a servidor

Atualizar Shipping Methods.

Domínio
Checkout
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-Key
Testar
Exemplo de cURL
POST/merchants/external-orders/{order_token}/shipping-rate
CheckoutBackend da loja · servidor a servidor

Criar Shipping Rate.

Domínio
Checkout
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-Key
Testar
Exemplo de cURL
GET/merchants/orders/{order_token}/credentials
ConnectionsBackend da loja · servidor a servidor

Listar ou obter Credentials.

Domínio
Connections
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/merchants/disputes
DisputesBackend da loja · servidor a servidor

Listar ou obter Disputes.

Domínio
Disputes
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
POST/merchants/disputes
DisputesBackend da loja · servidor a servidor

Criar Disputes.

Domínio
Disputes
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
GET/merchants/disputes/{id}
DisputesBackend da loja · servidor a servidor

Obter Disputes.

Domínio
Disputes
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
PATCH/merchants/disputes/{id}/draft
DisputesBackend da loja · servidor a servidor

Atualizar Draft.

Domínio
Disputes
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
GET/merchants/disputes/{id}/evidence
DisputesBackend da loja · servidor a servidor

Listar ou obter Evidence.

Domínio
Disputes
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
POST/merchants/disputes/{id}/evidence
DisputesBackend da loja · servidor a servidor

Criar Evidence.

Domínio
Disputes
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
GET/merchants/disputes/{id}/evidence/{evidence_id}
DisputesBackend da loja · servidor a servidor

Obter Evidence.

Domínio
Disputes
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
POST/merchants/disputes/{id}/evidence/{evidence_id}/archive
DisputesBackend da loja · servidor a servidor

Executar Archive para Evidence.

Domínio
Disputes
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
POST/merchants/disputes/{id}/evidence/{evidence_id}/versions
DisputesBackend da loja · servidor a servidor

Criar Versions.

Domínio
Disputes
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
POST/merchants/disputes/{id}/evidence/{evidence_id}/versions/{version_id}/complete
DisputesBackend da loja · servidor a servidor

Executar Complete para Versions.

Domínio
Disputes
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
GET/merchants/disputes/{id}/evidence/{evidence_id}/versions/{version_id}/download
DisputesBackend da loja · servidor a servidor

Executar Download para Versions.

Domínio
Disputes
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
GET/merchants/disputes/{id}/information-requests
DisputesBackend da loja · servidor a servidor

Listar ou obter Information Requests.

Domínio
Disputes
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
POST/merchants/disputes/{id}/information-requests
DisputesBackend da loja · servidor a servidor

Criar Information Requests.

Domínio
Disputes
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
GET/merchants/disputes/{id}/information-requests/{request_id}
DisputesBackend da loja · servidor a servidor

Obter Information Requests.

Domínio
Disputes
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
POST/merchants/disputes/{id}/information-requests/{request_id}/dismiss
DisputesBackend da loja · servidor a servidor

Executar Dismiss para Information Requests.

Domínio
Disputes
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
POST/merchants/disputes/{id}/information-requests/{request_id}/resolve
DisputesBackend da loja · servidor a servidor

Executar Resolve para Information Requests.

Domínio
Disputes
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
POST/merchants/disputes/{id}/information-requests/{request_id}/responses
DisputesBackend da loja · servidor a servidor

Criar Responses.

Domínio
Disputes
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
PATCH/merchants/disputes/{id}/metadata
DisputesBackend da loja · servidor a servidor

Atualizar Metadata.

Domínio
Disputes
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
GET/merchants/disputes/{id}/requirements
DisputesBackend da loja · servidor a servidor

Listar ou obter Requirements.

Domínio
Disputes
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
POST/merchants/disputes/{id}/reviews
DisputesBackend da loja · servidor a servidor

Criar Reviews.

Domínio
Disputes
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
GET/merchants/disputes/{id}/reviews/{review_id}
DisputesBackend da loja · servidor a servidor

Obter Reviews.

Domínio
Disputes
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
POST/merchants/disputes/{id}/reviews/{review_id}/approve
DisputesBackend da loja · servidor a servidor

Executar Approve para Reviews.

Domínio
Disputes
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
GET/merchants/disputes/{id}/reviews/{review_id}/snapshot
DisputesBackend da loja · servidor a servidor

Listar ou obter Snapshot.

Domínio
Disputes
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
GET/merchants/disputes/{id}/submissions
DisputesBackend da loja · servidor a servidor

Listar ou obter Submissions.

Domínio
Disputes
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
GET/merchants/disputes/{id}/submissions/{submission_id}
DisputesBackend da loja · servidor a servidor

Obter Submissions.

Domínio
Disputes
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
POST/merchants/disputes/{id}/submit
DisputesBackend da loja · servidor a servidor

Executar Submit para Disputes.

Domínio
Disputes
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
GET/merchants/disputes/{id}/updates
DisputesBackend da loja · servidor a servidor

Listar ou obter Updates.

Domínio
Disputes
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
GET/merchants/disputes/capabilities
DisputesBackend da loja · servidor a servidor

Listar ou obter Capabilities.

Domínio
Disputes
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
GET/merchants/disputes/connections
DisputesBackend da loja · servidor a servidor

Listar ou obter Connections.

Domínio
Disputes
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
GET/merchants/disputes/connections/{processor_account_id}
DisputesBackend da loja · servidor a servidor

Obter Connections.

Domínio
Disputes
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
GET/avs/codes
Fraud and riskBackend da loja · servidor a servidor

Listar ou obter Codes.

Domínio
Fraud and risk
Serviço responsável
Fraud and risk
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
GET/filters/anti-fraud-providers
Fraud and riskBackend da loja · servidor a servidor

Listar ou obter Anti Fraud Providers.

Domínio
Fraud and risk
Serviço responsável
Fraud and risk
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
AuthorizationX-Merchant-Id
Testar
Exemplo de cURL
GET/merchant/anti-fraud-processor
Fraud and riskBackend da loja · servidor a servidor

Listar ou obter Anti Fraud Processor.

Domínio
Fraud and risk
Serviço responsável
Fraud and risk
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
DELETE/merchants/{merchant_id}/fraud-settings
Fraud and riskBackend da loja · servidor a servidor

Excluir Fraud Settings.

Domínio
Fraud and risk
Serviço responsável
Fraud and risk
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
GET/merchants/{merchant_id}/fraud-settings
Fraud and riskBackend da loja · servidor a servidor

Listar ou obter Fraud Settings.

Domínio
Fraud and risk
Serviço responsável
Fraud and risk
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
PUT/merchants/{merchant_id}/fraud-settings
Fraud and riskBackend da loja · servidor a servidor

Atualizar Fraud Settings.

Domínio
Fraud and risk
Serviço responsável
Fraud and risk
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
GET/filters/acquirers/merchants/{merchant_id}
Merchant administrationBackend da loja · servidor a servidor

Obter Merchants.

Domínio
Merchant administration
Serviço responsável
Reports and reconciliation
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/filters/data_source/merchants/{merchant_id}
Merchant administrationBackend da loja · servidor a servidor

Obter Merchants.

Domínio
Merchant administration
Serviço responsável
Reports and reconciliation
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/fulfillments/{provider}/{merchant_id}
Merchant administrationBackend da loja · servidor a servidor

Criar Fulfillments.

Domínio
Merchant administration
Serviço responsável
Post-transaction
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/merchant/{id}/avs/history
Merchant administrationBackend da loja · servidor a servidor

Listar ou obter History.

Domínio
Merchant administration
Serviço responsável
Fraud and risk
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
GET/merchant/{id}/profile
Merchant administrationBackend da loja · servidor a servidor

Listar ou obter Profile.

Domínio
Merchant administration
Serviço responsável
Fraud and risk
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
PUT/merchant/{id}/profile
Merchant administrationBackend da loja · servidor a servidor

Atualizar Profile.

Domínio
Merchant administration
Serviço responsável
Fraud and risk
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
POST/merchant/profile
Merchant administrationBackend da loja · servidor a servidor

Criar Profile.

Domínio
Merchant administration
Serviço responsável
Fraud and risk
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
GET/merchant/transaction/{id}
Merchant administrationBackend da loja · servidor a servidor

Obter Transaction.

Domínio
Merchant administration
Serviço responsável
Fraud and risk
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
GET/merchants
Merchant administrationBackend da loja · servidor a servidor

Listar ou obter Merchants.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
X-Api-Key
Testar
Exemplo de cURL
POST/merchants
Merchant administrationBackend da loja · servidor a servidor

Criar Merchants.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
GET/merchants-all
Merchant administrationBackend da loja · servidor a servidor

Listar ou obter Merchants All.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
AuthorizationX-Api-Key
Testar
Exemplo de cURL
GET/merchants-tokens/me
Merchant administrationBackend da loja · servidor a servidor

Listar ou obter Me.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
GET/merchants/{merchant_id}
Merchant administrationBackend da loja · servidor a servidor

Obter Merchants.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
PUT/merchants/{merchant_id}
Merchant administrationBackend da loja · servidor a servidor

Atualizar Merchants.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
GET/merchants/{merchant_id}/applications
Merchant administrationBackend da loja · servidor a servidor

Listar ou obter Applications.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
PATCH/merchants/{merchant_id}/applications
Merchant administrationBackend da loja · servidor a servidor

Atualizar Applications.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
POST/merchants/{merchant_id}/applications
Merchant administrationBackend da loja · servidor a servidor

Criar Applications.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
GET/merchants/{merchant_id}/applications/{application_id}
Merchant administrationBackend da loja · servidor a servidor

Obter Applications.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
POST/merchants/{merchant_id}/applications/{application_id}/stores
Merchant administrationBackend da loja · servidor a servidor

Criar Stores.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
GET/merchants/{merchant_id}/configurations
Merchant administrationBackend da loja · servidor a servidor

Listar ou obter Configurations.

Domínio
Merchant administration
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/merchants/{merchant_id}/configurations
Merchant administrationBackend da loja · servidor a servidor

Criar Configurations.

Domínio
Merchant administration
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
DELETE/merchants/{merchant_id}/configurations/{configuration_id}
Merchant administrationBackend da loja · servidor a servidor

Excluir Configurations.

Domínio
Merchant administration
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/merchants/{merchant_id}/configurations/{configuration_id}
Merchant administrationBackend da loja · servidor a servidor

Obter Configurations.

Domínio
Merchant administration
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/merchants/{merchant_id}/decrypt
Merchant administrationBackend da loja · servidor a servidor

Criar Decrypt.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
POST/merchants/{merchant_id}/external-endpoints
Merchant administrationBackend da loja · servidor a servidor

Criar External Endpoints.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
DELETE/merchants/{merchant_id}/external-endpoints/{external_endpoint_id}
Merchant administrationBackend da loja · servidor a servidor

Excluir External Endpoints.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
PATCH/merchants/{merchant_id}/external-endpoints/{external_endpoint_id}
Merchant administrationBackend da loja · servidor a servidor

Atualizar External Endpoints.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
GET/merchants/{merchant_id}/files
Merchant administrationBackend da loja · servidor a servidor

Listar ou obter Files.

Domínio
Merchant administration
Serviço responsável
Reports and reconciliation
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/merchants/{merchant_id}/onboarding_step/{step}
Merchant administrationBackend da loja · servidor a servidor

Criar Onboarding Step.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
AuthorizationX-Api-Key
Testar
Exemplo de cURL
POST/merchants/{merchant_id}/public-keys
Merchant administrationBackend da loja · servidor a servidor

Criar Public Keys.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
GET/merchants/{merchant_id}/recipients
Merchant administrationBackend da loja · servidor a servidor

Listar ou obter Recipients.

Domínio
Merchant administration
Serviço responsável
Payments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/merchants/{merchant_id}/recipients
Merchant administrationBackend da loja · servidor a servidor

Criar Recipients.

Domínio
Merchant administration
Serviço responsável
Payments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
DELETE/merchants/{merchant_id}/recipients/{recipient_id}
Merchant administrationBackend da loja · servidor a servidor

Excluir Recipients.

Domínio
Merchant administration
Serviço responsável
Payments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
PUT/merchants/{merchant_id}/recipients/{recipient_id}
Merchant administrationBackend da loja · servidor a servidor

Atualizar Recipients.

Domínio
Merchant administration
Serviço responsável
Payments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/merchants/{merchant_id}/stores
Merchant administrationBackend da loja · servidor a servidor

Listar ou obter Stores.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada e token Bearer
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
POST/merchants/{merchant_id}/stores
Merchant administrationBackend da loja · servidor a servidor

Criar Stores.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada e token Bearer
Headers aceitos ou encaminhados
AuthorizationX-Api-Key
Testar
Exemplo de cURL
POST/merchants/{merchant_id}/tokens
Merchant administrationBackend da loja · servidor a servidor

Criar Tokens.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
GET/merchants/applications/validate
Merchant administrationBackend da loja · servidor a servidor

Listar ou obter Validate.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
X-Api-Key
Testar
Exemplo de cURL
PATCH/merchants/applications/validate
Merchant administrationBackend da loja · servidor a servidor

Atualizar Validate.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
POST/merchants/applications/validate
Merchant administrationBackend da loja · servidor a servidor

Criar Validate.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
GET/merchants/audit-logs
Merchant administrationBackend da loja · servidor a servidor

Listar ou obter Audit Logs.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorizationx-merchant-idx-network-id
Testar
Exemplo de cURL
GET/merchants/audit-logs/exports
Merchant administrationBackend da loja · servidor a servidor

Listar ou obter Exports.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorizationx-merchant-idx-network-id
Testar
Exemplo de cURL
POST/merchants/audit-logs/exports
Merchant administrationBackend da loja · servidor a servidor

Criar Exports.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorizationx-merchant-idx-network-id
Testar
Exemplo de cURL
GET/merchants/audit-logs/exports/{export_id}/download
Merchant administrationBackend da loja · servidor a servidor

Executar Download para Exports.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorizationx-merchant-idx-network-id
Testar
Exemplo de cURL
GET/merchants/audit-logs/filters
Merchant administrationBackend da loja · servidor a servidor

Listar ou obter Filters.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
GET/merchants/billing/invoices
Merchant administrationBackend da loja · servidor a servidor

Listar ou obter Invoices.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
AuthorizationX-Api-Key
Testar
Exemplo de cURL
GET/merchants/billing/invoices/{invoice_id}
Merchant administrationBackend da loja · servidor a servidor

Obter Invoices.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/merchants/countries/{country}/{state}/cities
Merchant administrationBackend da loja · servidor a servidor

Listar ou obter Cities.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
O gateway não declara headers de solicitação
Testar
Exemplo de cURL
GET/merchants/countries/{country}/banks
Merchant administrationBackend da loja · servidor a servidor

Listar ou obter Banks.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
O gateway não declara headers de solicitação
Testar
Exemplo de cURL
GET/merchants/countries/{country}/cities
Merchant administrationBackend da loja · servidor a servidor

Listar ou obter Cities.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
O gateway não declara headers de solicitação
Testar
Exemplo de cURL
GET/merchants/countries/{country}/states
Merchant administrationBackend da loja · servidor a servidor

Listar ou obter States.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
O gateway não declara headers de solicitação
Testar
Exemplo de cURL
GET/merchants/countries/list
Merchant administrationBackend da loja · servidor a servidor

Listar ou obter List.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
O gateway não declara headers de solicitação
Testar
Exemplo de cURL
GET/merchants/data/airline-information
Merchant administrationBackend da loja · servidor a servidor

Listar ou obter Airline Information.

Domínio
Merchant administration
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/merchants/data/airline-information
Merchant administrationBackend da loja · servidor a servidor

Criar Airline Information.

Domínio
Merchant administration
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/merchants/data/airline-information/{source_version}/rollback
Merchant administrationBackend da loja · servidor a servidor

Executar Rollback para Airline Information.

Domínio
Merchant administration
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/merchants/domain/{record}/validate
Merchant administrationBackend da loja · servidor a servidor

Criar Validate.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/merchants/domain/validate
Merchant administrationBackend da loja · servidor a servidor

Criar Validate.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
POST/merchants/login
Merchant administrationBackend da loja · servidor a servidor

Executar Login para Merchants.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
O gateway não declara headers de solicitação
Testar
Exemplo de cURL
GET/merchants/merchant-events
Merchant administrationBackend da loja · servidor a servidor

Listar ou obter Merchant Events.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
GET/merchants/merchant-events/{merchant_id}
Merchant administrationBackend da loja · servidor a servidor

Obter Merchant Events.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
POST/merchants/merchant-events/{merchant_id}
Merchant administrationBackend da loja · servidor a servidor

Criar Merchant Events.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
DELETE/merchants/msi
Merchant administrationBackend da loja · servidor a servidor

Excluir Msi.

Domínio
Merchant administration
Serviço responsável
Installments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/merchants/msi
Merchant administrationBackend da loja · servidor a servidor

Listar ou obter Msi.

Domínio
Merchant administration
Serviço responsável
Installments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/merchants/msi
Merchant administrationBackend da loja · servidor a servidor

Criar Msi.

Domínio
Merchant administration
Serviço responsável
Installments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/merchants/msi/{merchant_id}
Merchant administrationBackend da loja · servidor a servidor

Obter Msi.

Domínio
Merchant administration
Serviço responsável
Installments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/merchants/request-code
Merchant administrationBackend da loja · servidor a servidor

Executar Request Code para Merchants.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/merchants/resources/external-endpoints
Merchant administrationBackend da loja · servidor a servidor

Listar ou obter External Endpoints.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
X-Api-Key
Testar
Exemplo de cURL
POST/merchants/self-onboarding
Merchant administrationBackend da loja · servidor a servidor

Criar Self Onboarding.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/merchants/validate-code
Merchant administrationBackend da loja · servidor a servidor

Criar Validate Code.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/tenants
Merchant administrationBackend da loja · servidor a servidor

Listar ou obter Tenants.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
X-Api-Key
Testar
Exemplo de cURL
POST/tenants
Merchant administrationBackend da loja · servidor a servidor

Criar Tenants.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
GET/tenants/{tenant_id}
Merchant administrationBackend da loja · servidor a servidor

Obter Tenants.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
PUT/tenants/{tenant_id}
Merchant administrationBackend da loja · servidor a servidor

Atualizar Tenants.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
GET/v2/merchants-tokens/me
Merchant administrationBackend da loja · servidor a servidor

Listar ou obter Me.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
GET/v2/merchants/{merchant_id}/security/mfa
Merchant administrationBackend da loja · servidor a servidor

Listar ou obter Mfa.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
PUT/v2/merchants/{merchant_id}/security/mfa
Merchant administrationBackend da loja · servidor a servidor

Atualizar Mfa.

Domínio
Merchant administration
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/merchants/{merchant_id}/orders
OrdersBackend da loja · servidor a servidor

Listar ou obter Orders.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/merchants/{merchant_id}/orders/{order_token}
OrdersBackend da loja · servidor a servidor

Obter Orders.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/merchants/{merchant_id}/orders/{order_token}/capture
OrdersBackend da loja · servidor a servidor

Executar Capture para Orders.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
AuthorizationX-Idempotency-KeyX-Prediction-Id
Testar
Exemplo de cURL
GET/merchants/{merchant_id}/orders/{order_token}/payment_options
OrdersBackend da loja · servidor a servidor

Listar ou obter Payment Options.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/merchants/{merchant_id}/orders/{order_token}/refund
OrdersBackend da loja · servidor a servidor

Criar Refund.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/merchants/{merchant_id}/orders/{order_token}/status/{status}
OrdersBackend da loja · servidor a servidor

Criar Status.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/merchants/{merchant_id}/orders/{order_token}/void
OrdersBackend da loja · servidor a servidor

Executar Void para Orders.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/merchants/{merchant_id}/orders/{order_token}/vouchers
OrdersBackend da loja · servidor a servidor

Listar ou obter Vouchers.

Domínio
Orders
Serviço responsável
Vouchers
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
POST/merchants/{merchant_id}/orders/{order_token}/vouchers
OrdersBackend da loja · servidor a servidor

Criar Vouchers.

Domínio
Orders
Serviço responsável
Vouchers
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
POST/merchants/external-orders/{order_token}/billing-address
OrdersBackend da loja · servidor a servidor

Criar Billing Address.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
AuthorizationX-Api-Key
Testar
Exemplo de cURL
POST/merchants/external-orders/{order_token}/schedule
OrdersBackend da loja · servidor a servidor

Criar Schedule.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-Key
Testar
Exemplo de cURL
GET/merchants/orders
OrdersBackend da loja · servidor a servidor

Listar ou obter Orders.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/merchants/orders
OrdersBackend da loja · servidor a servidor

Criar Orders.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Prediction-Id
Testar
Exemplo de cURL
GET/merchants/orders/{order_token}
OrdersBackend da loja · servidor a servidor

Obter Orders.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
AuthorizationX-Api-Keyx-merchant-id
Testar
Exemplo de cURL
PATCH/merchants/orders/{order_token}
OrdersBackend da loja · servidor a servidor

Atualizar Orders.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
X-Api-Key
Testar
Exemplo de cURL
POST/merchants/orders/{order_token}/cancel
OrdersBackend da loja · servidor a servidor

Executar Cancel para Orders.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
X-Api-Key
Testar
Exemplo de cURL
POST/merchants/orders/{order_token}/capture
OrdersBackend da loja · servidor a servidor

Executar Capture para Orders.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/merchants/orders/{order_token}/capture-async
OrdersBackend da loja · servidor a servidor

Criar Capture Async.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/merchants/orders/{order_token}/consent
OrdersBackend da loja · servidor a servidor

Listar ou obter Consent.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Store-Code
Testar
Exemplo de cURL
POST/merchants/orders/{order_token}/consent
OrdersBackend da loja · servidor a servidor

Criar Consent.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Store-Code
Testar
Exemplo de cURL
POST/merchants/orders/{order_token}/expire
OrdersBackend da loja · servidor a servidor

Executar Expire para Orders.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
X-Api-Key
Testar
Exemplo de cURL
GET/merchants/orders/{order_token}/payments-methods
OrdersBackend da loja · servidor a servidor

Listar ou obter Payments Methods.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada ou token Bearer, conforme o fluxo
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Store-Code
Testar
Exemplo de cURL
POST/merchants/orders/{order_token}/promotions
OrdersBackend da loja · servidor a servidor

Criar Promotions.

Domínio
Orders
Serviço responsável
Merchant middleware
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
X-Api-Key
Testar
Exemplo de cURL
POST/merchants/orders/{order_token}/refund
OrdersBackend da loja · servidor a servidor

Criar Refund.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-Keyx-merchant-idX-Prediction-Id
Testar
Exemplo de cURL
POST/merchants/orders/{order_token}/refund-async
OrdersBackend da loja · servidor a servidor

Criar Refund Async.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/merchants/orders/{order_token}/success
OrdersBackend da loja · servidor a servidor

Executar Success para Orders.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
X-Api-Key
Testar
Exemplo de cURL
POST/merchants/orders/{order_token}/transactions/nequi/verify
OrdersBackend da loja · servidor a servidor

Executar Verify para Nequi.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
X-Api-KeyX-Merchant-IDX-Store-Code
Testar
Exemplo de cURL
POST/merchants/orders/{order_token}/transactions/verify
OrdersBackend da loja · servidor a servidor

Executar Verify para Transactions.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada ou token Bearer, conforme o fluxo
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Merchant-IDX-Store-Code
Testar
Exemplo de cURL
POST/merchants/orders/{order_token}/void
OrdersBackend da loja · servidor a servidor

Executar Void para Orders.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/merchants/orders/{order_token}/void-async
OrdersBackend da loja · servidor a servidor

Executar Void Async para Orders.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/merchants/orders/filters-options
OrdersBackend da loja · servidor a servidor

Listar ou obter Filters Options.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/merchants/orders/id/{order_id}
OrdersBackend da loja · servidor a servidor

Obter Id.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/merchants/transactions/orders/{order_token}/installments
OrdersBackend da loja · servidor a servidor

Listar ou obter Installments.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada ou token Bearer, conforme o fluxo
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Merchant-IDX-Prediction-Id
Testar
Exemplo de cURL
GET/orders/status
OrdersBackend da loja · servidor a servidor

Listar ou obter Status.

Domínio
Orders
Serviço responsável
Payments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
POST/v2/merchants/{merchant_id}/orders/{order_token}/capture
OrdersBackend da loja · servidor a servidor

Executar Capture para Orders.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Idempotency-KeyX-Prediction-Id
Testar
Exemplo de cURL
POST/v2/merchants/orders/{order_token}/capture
OrdersBackend da loja · servidor a servidor

Executar Capture para Orders.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/v2/merchants/orders/{order_token}/refund
OrdersBackend da loja · servidor a servidor

Criar Refund.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/v2/merchants/orders/purchase
OrdersBackend da loja · servidor a servidor

Criar Purchase.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationCookieUser-AgentX-Api-KeyX-Device-IdX-Merchant-IDX-Prediction-IdX-Session-IdX-Store-Code
Testar
Exemplo de cURL
GET/merchants/{merchant_id}/payments/links/templates
Payment linksBackend da loja · servidor a servidor

Listar ou obter Templates.

Domínio
Payment links
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/merchants/{merchant_id}/payments/links/templates
Payment linksBackend da loja · servidor a servidor

Criar Templates.

Domínio
Payment links
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/merchants/{merchant_id}/payments/links/templates/{template_id}
Payment linksBackend da loja · servidor a servidor

Obter Templates.

Domínio
Payment links
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
PATCH/merchants/{merchant_id}/payments/links/templates/{template_id}
Payment linksBackend da loja · servidor a servidor

Atualizar Templates.

Domínio
Payment links
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/merchants/payment-links
Payment linksBackend da loja · servidor a servidor

Criar Payment Links.

Domínio
Payment links
Serviço responsável
Payment links
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/merchants/payment-links/{payment_link_id}
Payment linksBackend da loja · servidor a servidor

Obter Payment Links.

Domínio
Payment links
Serviço responsável
Payment links
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
PATCH/merchants/payment-links/{payment_link_id}
Payment linksBackend da loja · servidor a servidor

Atualizar Payment Links.

Domínio
Payment links
Serviço responsável
Payment links
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/merchants/payment-links/{payment_link_id}/orders
Payment linksBackend da loja · servidor a servidor

Listar ou obter Orders.

Domínio
Payment links
Serviço responsável
Payment links
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/merchants/payment-links/all
Payment linksBackend da loja · servidor a servidor

Listar ou obter All.

Domínio
Payment links
Serviço responsável
Payment links
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/merchants/payments/links/templates/{template_id}/orders
Payment linksBackend da loja · servidor a servidor

Listar ou obter Orders.

Domínio
Payment links
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/payment-links/{payment_link_id}
Payment linksBackend da loja · servidor a servidor

Obter Payment Links.

Domínio
Payment links
Serviço responsável
Payment links
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/merchants/{merchant_id}/batch-transactions
PaymentsBackend da loja · servidor a servidor

Listar ou obter Batch Transactions.

Domínio
Payments
Serviço responsável
Batch transactions
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
POST/merchants/{merchant_id}/batch-transactions
PaymentsBackend da loja · servidor a servidor

Criar Batch Transactions.

Domínio
Payments
Serviço responsável
Batch transactions
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
GET/merchants/{merchant_id}/batch-transactions/{batch_id}
PaymentsBackend da loja · servidor a servidor

Obter Batch Transactions.

Domínio
Payments
Serviço responsável
Batch transactions
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
DELETE/merchants/{merchant_id}/installments
PaymentsBackend da loja · servidor a servidor

Excluir Installments.

Domínio
Payments
Serviço responsável
Installments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/merchants/{merchant_id}/installments
PaymentsBackend da loja · servidor a servidor

Listar ou obter Installments.

Domínio
Payments
Serviço responsável
Installments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/merchants/{merchant_id}/installments
PaymentsBackend da loja · servidor a servidor

Criar Installments.

Domínio
Payments
Serviço responsável
Installments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/merchants/{merchant_id}/transactions
PaymentsBackend da loja · servidor a servidor

Listar ou obter Transactions.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/merchants/stores/payments-methods
PaymentsBackend da loja · servidor a servidor

Listar ou obter Payments Methods.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
X-Idempotency-KeyX-Merchant-IdX-Prediction-IdX-Store-Code
Testar
Exemplo de cURL
GET/payments-middleware/manifest
PaymentsBackend da loja · servidor a servidor

Listar ou obter Manifest.

Domínio
Payments
Serviço responsável
Merchant middleware
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/payments-middleware/payment-methods
PaymentsBackend da loja · servidor a servidor

Listar ou obter Payment Methods.

Domínio
Payments
Serviço responsável
Merchant middleware
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/payments-middleware/payments
PaymentsBackend da loja · servidor a servidor

Criar Payments.

Domínio
Payments
Serviço responsável
Merchant middleware
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/payments-middleware/payments/{payment_id}/cancellations
PaymentsBackend da loja · servidor a servidor

Criar Cancellations.

Domínio
Payments
Serviço responsável
Merchant middleware
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/payments-middleware/payments/{payment_id}/refunds
PaymentsBackend da loja · servidor a servidor

Criar Refunds.

Domínio
Payments
Serviço responsável
Merchant middleware
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/payments-vault/tokenization
PaymentsBackend da loja · servidor a servidor

Criar Tokenization.

Domínio
Payments
Serviço responsável
Vault
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/payments-vault/tokenization/{uuid}/cvv
PaymentsBackend da loja · servidor a servidor

Criar Cvv.

Domínio
Payments
Serviço responsável
Vault
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/post-transactions/{provider}
PaymentsBackend da loja · servidor a servidor

Criar Post Transactions.

Domínio
Payments
Serviço responsável
Post-transaction
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/telcel-middleware/transactions/inquiry
PaymentsBackend da loja · servidor a servidor

Criar Inquiry.

Domínio
Payments
Serviço responsável
Telcel middleware
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/transactions/{transaction_id}/{request_id_hash}/cancel
PaymentsBackend da loja · servidor a servidor

Executar Cancel para Transactions.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/transactions/{transaction_id}/capture
PaymentsBackend da loja · servidor a servidor

Executar Capture para Transactions.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/transactions/{transaction_id}/refund
PaymentsBackend da loja · servidor a servidor

Criar Refund.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
PUT/transactions/{transaction_id}/status
PaymentsBackend da loja · servidor a servidor

Atualizar Status.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/transactions/{transaction_id}/status/nequi
PaymentsBackend da loja · servidor a servidor

Criar Nequi.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/transactions/{transaction_id}/three-ds-flow
PaymentsBackend da loja · servidor a servidor

Listar ou obter Three Ds Flow.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/transactions/{transaction_id}/three-ds-flow/complete
PaymentsBackend da loja · servidor a servidor

Executar Complete para Three Ds Flow.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/transactions/{transaction_id}/three-ds-flow/complete
PaymentsBackend da loja · servidor a servidor

Executar Complete para Three Ds Flow.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/transactions/{transaction_id}/three-ds-flow/continue
PaymentsBackend da loja · servidor a servidor

Executar Continue para Three Ds Flow.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/transactions/{transaction_id}/transfer/{current_store_code}/{new_store_code}
PaymentsBackend da loja · servidor a servidor

Executar Transfer para Transactions.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/transactions/{transaction_id}/verify
PaymentsBackend da loja · servidor a servidor

Executar Verify para Transactions.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/transactions/{transaction_id}/void
PaymentsBackend da loja · servidor a servidor

Executar Void para Transactions.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/transactions/{transaction_id}/void-async
PaymentsBackend da loja · servidor a servidor

Executar Void Async para Transactions.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/transactions/internal-search
PaymentsBackend da loja · servidor a servidor

Listar ou obter Internal Search.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/transactions/payments-methods
PaymentsBackend da loja · servidor a servidor

Listar ou obter Payments Methods.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/transactions/payments-methods/{method_type}/installments
PaymentsBackend da loja · servidor a servidor

Listar ou obter Installments.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/transactions/search
PaymentsBackend da loja · servidor a servidor

Executar Search para Transactions.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/transactions/update-processing-transactions
PaymentsBackend da loja · servidor a servidor

Listar ou obter Update Processing Transactions.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/transactions/verify3ds
PaymentsBackend da loja · servidor a servidor

Listar ou obter Verify3ds.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
O gateway não declara headers de solicitação
Testar
Exemplo de cURL
POST/transactions/verify3ds
PaymentsBackend da loja · servidor a servidor

Criar Verify3ds.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/transactions/view_challenge
PaymentsBackend da loja · servidor a servidor

Listar ou obter View Challenge.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
O gateway não declara headers de solicitação
Testar
Exemplo de cURL
POST/manual-review
Post-transactionBackend da loja · servidor a servidor

Criar Manual Review.

Domínio
Post-transaction
Serviço responsável
Post-transaction
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/post-transaction-manual-process/{action}
Post-transactionBackend da loja · servidor a servidor

Criar Post Transaction Manual Process.

Domínio
Post-transaction
Serviço responsável
Post-transaction
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
X-Api-KeyX-Merchant-Id
Testar
Exemplo de cURL
GET/merchants/{merchant_id}/files/{file_id}/presigned-url
ReportsBackend da loja · servidor a servidor

Listar ou obter Presigned Url.

Domínio
Reports
Serviço responsável
Reports and reconciliation
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/merchants/{merchant_id}/subscriptions/{id}/orders
SubscriptionsBackend da loja · servidor a servidor

Listar ou obter Orders.

Domínio
Subscriptions
Serviço responsável
Orders and checkout
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/merchants/installments/plans/{installment_plan_option_id}
SubscriptionsBackend da loja · servidor a servidor

Obter Plans.

Domínio
Subscriptions
Serviço responsável
Installments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
X-Api-Key
Testar
Exemplo de cURL
GET/subscriptions
SubscriptionsBackend da loja · servidor a servidor

Listar ou obter Subscriptions.

Domínio
Subscriptions
Serviço responsável
Subscriptions
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorizationx-Api-KeyX-Merchant-ID
Testar
Exemplo de cURL
POST/subscriptions
SubscriptionsBackend da loja · servidor a servidor

Criar Subscriptions.

Domínio
Subscriptions
Serviço responsável
Subscriptions
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorizationx-Api-KeyX-Merchant-ID
Testar
Exemplo de cURL
DELETE/subscriptions/{id}
SubscriptionsBackend da loja · servidor a servidor

Excluir Subscriptions.

Domínio
Subscriptions
Serviço responsável
Subscriptions
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorizationx-Api-KeyX-Merchant-ID
Testar
Exemplo de cURL
GET/subscriptions/{id}
SubscriptionsBackend da loja · servidor a servidor

Obter Subscriptions.

Domínio
Subscriptions
Serviço responsável
Subscriptions
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorizationx-Api-KeyX-Merchant-ID
Testar
Exemplo de cURL
PATCH/subscriptions/{id}
SubscriptionsBackend da loja · servidor a servidor

Atualizar Subscriptions.

Domínio
Subscriptions
Serviço responsável
Subscriptions
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorizationx-Api-KeyX-Merchant-ID
Testar
Exemplo de cURL
POST/subscriptions/{id}/cancel
SubscriptionsBackend da loja · servidor a servidor

Executar Cancel para Subscriptions.

Domínio
Subscriptions
Serviço responsável
Subscriptions
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorizationx-Api-KeyX-Merchant-ID
Testar
Exemplo de cURL
PATCH/subscriptions/{id}/cards
SubscriptionsBackend da loja · servidor a servidor

Atualizar Cards.

Domínio
Subscriptions
Serviço responsável
Subscriptions
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorizationx-Api-KeyX-Merchant-ID
Testar
Exemplo de cURL
GET/subscriptions/{id}/history
SubscriptionsBackend da loja · servidor a servidor

Listar ou obter History.

Domínio
Subscriptions
Serviço responsável
Subscriptions
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorizationx-Api-KeyX-Merchant-ID
Testar
Exemplo de cURL
POST/subscriptions/{id}/pause
SubscriptionsBackend da loja · servidor a servidor

Executar Pause para Subscriptions.

Domínio
Subscriptions
Serviço responsável
Subscriptions
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorizationx-Api-KeyX-Merchant-ID
Testar
Exemplo de cURL
POST/subscriptions/{id}/resume
SubscriptionsBackend da loja · servidor a servidor

Executar Resume para Subscriptions.

Domínio
Subscriptions
Serviço responsável
Subscriptions
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorizationx-Api-KeyX-Merchant-ID
Testar
Exemplo de cURL
GET/subscriptions/plans
SubscriptionsBackend da loja · servidor a servidor

Listar ou obter Plans.

Domínio
Subscriptions
Serviço responsável
Subscriptions
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorizationx-Api-KeyX-Merchant-ID
Testar
Exemplo de cURL
POST/subscriptions/plans
SubscriptionsBackend da loja · servidor a servidor

Criar Plans.

Domínio
Subscriptions
Serviço responsável
Subscriptions
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorizationx-Api-KeyX-Merchant-ID
Testar
Exemplo de cURL
DELETE/subscriptions/plans/{id}
SubscriptionsBackend da loja · servidor a servidor

Excluir Plans.

Domínio
Subscriptions
Serviço responsável
Subscriptions
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorizationx-Api-KeyX-Merchant-ID
Testar
Exemplo de cURL
GET/subscriptions/plans/{id}
SubscriptionsBackend da loja · servidor a servidor

Obter Plans.

Domínio
Subscriptions
Serviço responsável
Subscriptions
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorizationx-Api-KeyX-Merchant-ID
Testar
Exemplo de cURL
PATCH/subscriptions/plans/{id}
SubscriptionsBackend da loja · servidor a servidor

Atualizar Plans.

Domínio
Subscriptions
Serviço responsável
Subscriptions
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorizationx-Api-KeyX-Merchant-ID
Testar
Exemplo de cURL
GET/subscriptions/plans/statuses
SubscriptionsBackend da loja · servidor a servidor

Listar ou obter Statuses.

Domínio
Subscriptions
Serviço responsável
Subscriptions
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/subscriptions/retries
SubscriptionsBackend da loja · servidor a servidor

Listar ou obter Retries.

Domínio
Subscriptions
Serviço responsável
Subscription retries
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorizationx-Api-KeyX-Merchant-ID
Testar
Exemplo de cURL
POST/subscriptions/retries
SubscriptionsBackend da loja · servidor a servidor

Criar Retries.

Domínio
Subscriptions
Serviço responsável
Subscription retries
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorizationx-Api-KeyX-Merchant-ID
Testar
Exemplo de cURL
DELETE/subscriptions/retries/{id}
SubscriptionsBackend da loja · servidor a servidor

Excluir Retries.

Domínio
Subscriptions
Serviço responsável
Subscription retries
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorizationx-Api-KeyX-Merchant-ID
Testar
Exemplo de cURL
GET/subscriptions/retries/{id}
SubscriptionsBackend da loja · servidor a servidor

Obter Retries.

Domínio
Subscriptions
Serviço responsável
Subscription retries
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorizationx-Api-KeyX-Merchant-ID
Testar
Exemplo de cURL
PUT/subscriptions/retries/{id}
SubscriptionsBackend da loja · servidor a servidor

Atualizar Retries.

Domínio
Subscriptions
Serviço responsável
Subscription retries
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorizationx-Api-KeyX-Merchant-ID
Testar
Exemplo de cURL
GET/subscriptions/statuses
SubscriptionsBackend da loja · servidor a servidor

Listar ou obter Statuses.

Domínio
Subscriptions
Serviço responsável
Subscriptions
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorizationx-Api-KeyX-Merchant-ID
Testar
Exemplo de cURL
GET/trace/logs
Trace and audit logsBackend da loja · servidor a servidor

Listar ou obter Logs.

Domínio
Trace and audit logs
Serviço responsável
Trace and audit logs
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
AuthorizationX-Merchant-Id
Testar
Exemplo de cURL
GET/trace/logs/visibility/grouped
Trace and audit logsBackend da loja · servidor a servidor

Listar ou obter Grouped.

Domínio
Trace and audit logs
Serviço responsável
Trace and audit logs
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
AuthorizationX-Merchant-Id
Testar
Exemplo de cURL
GET/v2/trace/logs
Trace and audit logsBackend da loja · servidor a servidor

Listar ou obter Logs.

Domínio
Trace and audit logs
Serviço responsável
Trace and audit logs
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Merchant-Id
Testar
Exemplo de cURL
POST/hermes/merchants/users/notifications
Users and identityBackend da loja · servidor a servidor

Criar Notifications.

Domínio
Users and identity
Serviço responsável
Notifications
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/merchant-users
Users and identityBackend da loja · servidor a servidor

Listar ou obter Merchant Users.

Domínio
Users and identity
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/merchants/{merchant_id}/policies
Users and identityBackend da loja · servidor a servidor

Listar ou obter Policies.

Domínio
Users and identity
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
POST/merchants/identity-token
Users and identityBackend da loja · servidor a servidor

Criar Identity Token.

Domínio
Users and identity
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
POST/merchants/users
Users and identityBackend da loja · servidor a servidor

Criar Users.

Domínio
Users and identity
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
GET/merchants/users/{user_id}
Users and identityBackend da loja · servidor a servidor

Obter Users.

Domínio
Users and identity
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/merchants/users/{user_id}
Users and identityBackend da loja · servidor a servidor

Criar Users.

Domínio
Users and identity
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
PUT/merchants/users/{user_id}
Users and identityBackend da loja · servidor a servidor

Atualizar Users.

Domínio
Users and identity
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/merchants/users/{user_id}/authorize
Users and identityBackend da loja · servidor a servidor

Executar Authorize para Users.

Domínio
Users and identity
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/merchants/users/{user_id}/generate-change-password-token
Users and identityBackend da loja · servidor a servidor

Criar Generate Change Password Token.

Domínio
Users and identity
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/merchants/users/change-password
Users and identityBackend da loja · servidor a servidor

Criar Change Password.

Domínio
Users and identity
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/merchants/validate-oauth
Users and identityBackend da loja · servidor a servidor

Criar Validate Oauth.

Domínio
Users and identity
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/users/authorize
Users and identityBackend da loja · servidor a servidor

Executar Authorize para Users.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
X-Api-KeyX-Merchant-Id
Testar
Exemplo de cURL
POST/users/external-authorize
Users and identityBackend da loja · servidor a servidor

Criar External Authorize.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Auth-MessageX-Device-IdX-Merchant-Id
Testar
Exemplo de cURL
GET/v1/users/{user_id}/transactions/{transaction_id}
Users and identityBackend da loja · servidor a servidor

Obter Transactions.

Domínio
Users and identity
Serviço responsável
Payments
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/v2/auth/identity/change-password
Users and identityBackend da loja · servidor a servidor

Criar Change Password.

Domínio
Users and identity
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/v2/auth/identity/user
Users and identityBackend da loja · servidor a servidor

Listar ou obter User.

Domínio
Users and identity
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/v2/auth/log-stream
Users and identityBackend da loja · servidor a servidor

Criar Log Stream.

Domínio
Users and identity
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/v2/auth/login
Users and identityBackend da loja · servidor a servidor

Executar Login para Auth.

Domínio
Users and identity
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/v2/auth/mfa-sync
Users and identityBackend da loja · servidor a servidor

Criar Mfa Sync.

Domínio
Users and identity
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/v2/auth/session/bootstrap
Users and identityBackend da loja · servidor a servidor

Executar Bootstrap para Session.

Domínio
Users and identity
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/v2/auth/user-org-sync
Users and identityBackend da loja · servidor a servidor

Criar User Org Sync.

Domínio
Users and identity
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/v2/generate-custom-token
Users and identityBackend da loja · servidor a servidor

Listar ou obter Generate Custom Token.

Domínio
Users and identity
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
POST/v2/merchants/users
Users and identityBackend da loja · servidor a servidor

Criar Users.

Domínio
Users and identity
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
PATCH/v2/merchants/users/{user_id}
Users and identityBackend da loja · servidor a servidor

Atualizar Users.

Domínio
Users and identity
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
POST/v2/merchants/users/{user_id}/ban
Users and identityBackend da loja · servidor a servidor

Executar Ban para Users.

Domínio
Users and identity
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
POST/v2/merchants/users/{user_id}/invite
Users and identityBackend da loja · servidor a servidor

Executar Invite para Users.

Domínio
Users and identity
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
POST/v2/merchants/users/{user_id}/mfa/reset
Users and identityBackend da loja · servidor a servidor

Executar Reset para Mfa.

Domínio
Users and identity
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
DELETE/v2/merchants/users/{user_id}/security-block
Users and identityBackend da loja · servidor a servidor

Excluir Security Block.

Domínio
Users and identity
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
GET/v2/merchants/users/{user_id}/security-block
Users and identityBackend da loja · servidor a servidor

Listar ou obter Security Block.

Domínio
Users and identity
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
POST/v2/merchants/users/{user_id}/security-block
Users and identityBackend da loja · servidor a servidor

Criar Security Block.

Domínio
Users and identity
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
POST/v2/merchants/users/mfa/disable
Users and identityBackend da loja · servidor a servidor

Executar Disable para Mfa.

Domínio
Users and identity
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
PUT/v2/merchants/users/password
Users and identityBackend da loja · servidor a servidor

Atualizar Password.

Domínio
Users and identity
Serviço responsável
Users and identity
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
GET/vaults/active
VaultBackend da loja · servidor a servidor

Listar ou obter Active.

Domínio
Vault
Serviço responsável
Vault
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
PUT/vaults/active
VaultBackend da loja · servidor a servidor

Atualizar Active.

Domínio
Vault
Serviço responsável
Vault
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
POST/hermes/events/create-campaign
Webhooks and notificationsBackend da loja · servidor a servidor

Criar Create Campaign.

Domínio
Webhooks and notifications
Serviço responsável
Notifications
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/hermes/template/{merchantID}
Webhooks and notificationsBackend da loja · servidor a servidor

Criar Template.

Domínio
Webhooks and notifications
Serviço responsável
Notifications
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
DELETE/hermes/template/{templateID}
Webhooks and notificationsBackend da loja · servidor a servidor

Excluir Template.

Domínio
Webhooks and notifications
Serviço responsável
Notifications
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
POST/hermes/template/default
Webhooks and notificationsBackend da loja · servidor a servidor

Criar Default.

Domínio
Webhooks and notifications
Serviço responsável
Notifications
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
PATCH/notifications/{userId}
Webhooks and notificationsBackend da loja · servidor a servidor

Atualizar Notifications.

Domínio
Webhooks and notifications
Serviço responsável
Notifications
Destinado a
Backend da loja · servidor a servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
Aplicativo do cliente · usuário para servidorUse em fluxos web ou móveis do cliente com a identidade e o contexto do dispositivo indicados.62
GET/payments-cards/users/{user_id}/cards
Cards and vaultAplicativo do cliente · usuário para servidor

Listar ou obter Cards.

Domínio
Cards and vault
Serviço responsável
Payment cards
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
AuthorizationX-Api-Key
Testar
Exemplo de cURL
POST/payments-cards/users/{user_id}/cards
Cards and vaultAplicativo do cliente · usuário para servidor

Criar Cards.

Domínio
Cards and vault
Serviço responsável
Payment cards
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
AuthorizationX-Api-Key
Testar
Exemplo de cURL
DELETE/payments-cards/users/{user_id}/cards/{card_id}
Cards and vaultAplicativo do cliente · usuário para servidor

Excluir Cards.

Domínio
Cards and vault
Serviço responsável
Payment cards
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
AuthorizationX-Api-Key
Testar
Exemplo de cURL
GET/payments-cards/users/{user_id}/cards/{card_id}
Cards and vaultAplicativo do cliente · usuário para servidor

Obter Cards.

Domínio
Cards and vault
Serviço responsável
Payment cards
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
AuthorizationX-Api-Key
Testar
Exemplo de cURL
GET/users/{user_id}/cards
Cards and vaultAplicativo do cliente · usuário para servidor

Listar ou obter Cards.

Domínio
Cards and vault
Serviço responsável
Payments
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
AuthorizationX-Merchant-ID
Testar
Exemplo de cURL
POST/users/{user_id}/cards
Cards and vaultAplicativo do cliente · usuário para servidor

Criar Cards.

Domínio
Cards and vault
Serviço responsável
Payments
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
AuthorizationX-Merchant-ID
Testar
Exemplo de cURL
DELETE/users/{user_id}/cards/{card_id}
Cards and vaultAplicativo do cliente · usuário para servidor

Excluir Cards.

Domínio
Cards and vault
Serviço responsável
Payments
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
GET/users/{user_id}/cards/{card_id}
Cards and vaultAplicativo do cliente · usuário para servidor

Obter Cards.

Domínio
Cards and vault
Serviço responsável
Payments
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
POST/users/{user_id}/cards/{card_id}/refresh-cvv
Cards and vaultAplicativo do cliente · usuário para servidor

Executar Refresh Cvv para Cards.

Domínio
Cards and vault
Serviço responsável
Payments
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
AuthorizationX-Merchant-ID
Testar
Exemplo de cURL
PATCH/users/{user_id}/cards/{card_id}/set-as-default
Cards and vaultAplicativo do cliente · usuário para servidor

Executar Set As Default para Cards.

Domínio
Cards and vault
Serviço responsável
Payments
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
AuthorizationX-Merchant-ID
Testar
Exemplo de cURL
POST/users/{user_id}/cards/{card_id}/tokens
Cards and vaultAplicativo do cliente · usuário para servidor

Criar Tokens.

Domínio
Cards and vault
Serviço responsável
Payments
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
O Gateway não declara um validador; o serviço responsável trata o contexto temporário do cliente
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/v2/users/{user_id}/cards
Cards and vaultAplicativo do cliente · usuário para servidor

Criar Cards.

Domínio
Cards and vault
Serviço responsável
Payments
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
AuthorizationX-Merchant-ID
Testar
Exemplo de cURL
GET/{merchant_id}/checkout
CheckoutAplicativo do cliente · usuário para servidor

Listar ou obter Checkout.

Domínio
Checkout
Serviço responsável
Orders and checkout
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
PATCH/checkout/{merchant_id}/configuration
CheckoutAplicativo do cliente · usuário para servidor

Atualizar Configuration.

Domínio
Checkout
Serviço responsável
Orders and checkout
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
O Gateway não declara um validador; o serviço responsável trata o contexto temporário do cliente
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/checkout/{merchant_id}/configuration
CheckoutAplicativo do cliente · usuário para servidor

Criar Configuration.

Domínio
Checkout
Serviço responsável
Orders and checkout
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
O Gateway não declara um validador; o serviço responsável trata o contexto temporário do cliente
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/checkout/ready
CheckoutAplicativo do cliente · usuário para servidor

Listar ou obter Ready.

Domínio
Checkout
Serviço responsável
Orders and checkout
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
X-Api-Key
Testar
Exemplo de cURL
GET/checkout/status
CheckoutAplicativo do cliente · usuário para servidor

Listar ou obter Status.

Domínio
Checkout
Serviço responsável
Users and identity
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
X-Api-Key
Testar
Exemplo de cURL
POST/shortener/{hash_id}
PaymentsAplicativo do cliente · usuário para servidor

Criar Shortener.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
O Gateway não declara um validador; o serviço responsável trata o contexto temporário do cliente
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/transactions/{transaction_id}/consent/{consent_id}/redirect
PaymentsAplicativo do cliente · usuário para servidor

Listar ou obter Redirect.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
O Gateway não declara um validador; o serviço responsável trata o contexto temporário do cliente
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/transactions/next-action/{next_action_id}
PaymentsAplicativo do cliente · usuário para servidor

Obter Next Action.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
O gateway não declara headers de solicitação
Testar
Exemplo de cURL
GET/users
Users and identityAplicativo do cliente · usuário para servidor

Listar ou obter Users.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Device-IdX-Merchant-Id
Testar
Exemplo de cURL
DELETE/users/{user_id}
Users and identityAplicativo do cliente · usuário para servidor

Excluir Users.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
AuthorizationX-Device-IdX-Merchant-Id
Testar
Exemplo de cURL
PATCH/users/{user_id}
Users and identityAplicativo do cliente · usuário para servidor

Atualizar Users.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
AuthorizationX-Device-IdX-Merchant-Id
Testar
Exemplo de cURL
GET/users/{user_id}/accepted-policies
Users and identityAplicativo do cliente · usuário para servidor

Listar ou obter Accepted Policies.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Merchant-IDX-Request-ID
Testar
Exemplo de cURL
POST/users/{user_id}/accepted-policies
Users and identityAplicativo do cliente · usuário para servidor

Criar Accepted Policies.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Merchant-IDX-Request-ID
Testar
Exemplo de cURL
POST/users/{user_id}/accepted-policies/preferences
Users and identityAplicativo do cliente · usuário para servidor

Criar Preferences.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Merchant-IDX-Request-ID
Testar
Exemplo de cURL
GET/users/{user_id}/addresses
Users and identityAplicativo do cliente · usuário para servidor

Listar ou obter Addresses.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
AuthorizationX-Device-IdX-Merchant-Id
Testar
Exemplo de cURL
POST/users/{user_id}/addresses
Users and identityAplicativo do cliente · usuário para servidor

Criar Addresses.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
AuthorizationX-Device-IdX-Merchant-Id
Testar
Exemplo de cURL
DELETE/users/{user_id}/addresses/{address_id}
Users and identityAplicativo do cliente · usuário para servidor

Excluir Addresses.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
AuthorizationX-Device-IdX-Merchant-Id
Testar
Exemplo de cURL
GET/users/{user_id}/addresses/{address_id}
Users and identityAplicativo do cliente · usuário para servidor

Obter Addresses.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
AuthorizationX-Device-IdX-Merchant-Id
Testar
Exemplo de cURL
PATCH/users/{user_id}/addresses/{address_id}
Users and identityAplicativo do cliente · usuário para servidor

Atualizar Addresses.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
AuthorizationX-Device-IdX-Merchant-Id
Testar
Exemplo de cURL
POST/users/{user_id}/change-password
Users and identityAplicativo do cliente · usuário para servidor

Criar Change Password.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Device-IdX-Merchant-Id
Testar
Exemplo de cURL
GET/users/{user_id}/transactions
Users and identityAplicativo do cliente · usuário para servidor

Listar ou obter Transactions.

Domínio
Users and identity
Serviço responsável
Payments
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
O Gateway não declara um validador; o serviço responsável trata o contexto temporário do cliente
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/users/addresses/{address_id}
Users and identityAplicativo do cliente · usuário para servidor

Obter Addresses.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
X-Api-KeyX-Device-IdX-Merchant-Id
Testar
Exemplo de cURL
POST/users/auth/verify
Users and identityAplicativo do cliente · usuário para servidor

Executar Verify para Auth.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
O gateway não declara headers de solicitação
Testar
Exemplo de cURL
POST/users/bulk
Users and identityAplicativo do cliente · usuário para servidor

Criar Bulk.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
O Gateway não declara um validador; o serviço responsável trata o contexto temporário do cliente
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/users/change-password
Users and identityAplicativo do cliente · usuário para servidor

Criar Change Password.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Device-IdX-Merchant-Id
Testar
Exemplo de cURL
POST/users/forgot-password
Users and identityAplicativo do cliente · usuário para servidor

Criar Forgot Password.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
O gateway não declara headers de solicitação
Testar
Exemplo de cURL
POST/users/generate
Users and identityAplicativo do cliente · usuário para servidor

Executar Generate para Users.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
X-Api-Key
Testar
Exemplo de cURL
POST/users/login
Users and identityAplicativo do cliente · usuário para servidor

Executar Login para Users.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Fluxo público de credenciais com contexto validado do aplicativo da loja
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Device-IdX-Merchant-IdX-Qa-Api-KeyX-Recaptcha-TokenX-Session-ID
Testar
Exemplo de cURL
POST/users/login/device-fingerprint
Users and identityAplicativo do cliente · usuário para servidor

Criar Device Fingerprint.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Chave de API privada ou token Bearer, conforme o fluxo
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Device-IdX-Merchant-IdX-Session-ID
Testar
Exemplo de cURL
POST/users/logout
Users and identityAplicativo do cliente · usuário para servidor

Executar Logout para Users.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
AuthorizationX-Device-IDX-Session-ID
Testar
Exemplo de cURL
GET/users/me
Users and identityAplicativo do cliente · usuário para servidor

Listar ou obter Me.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
AuthorizationX-Device-IdX-Merchant-Id
Testar
Exemplo de cURL
DELETE/users/payment-methods/{payment_method_id}/tokens/{payment_method}
Users and identityAplicativo do cliente · usuário para servidor

Excluir Tokens.

Domínio
Users and identity
Serviço responsável
Payments
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
AuthorizationX-Merchant-ID
Testar
Exemplo de cURL
POST/users/payment-methods/tokens
Users and identityAplicativo do cliente · usuário para servidor

Criar Tokens.

Domínio
Users and identity
Serviço responsável
Payments
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
AuthorizationX-Merchant-ID
Testar
Exemplo de cURL
POST/users/probe
Users and identityAplicativo do cliente · usuário para servidor

Executar Probe para Users.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Accept-LanguageSec-CH-UASec-CH-UA-MobileSec-CH-UA-PlatformX-Api-KeyX-Device-IdX-Merchant-Id
Testar
Exemplo de cURL
GET/users/probe/{id}
Users and identityAplicativo do cliente · usuário para servidor

Executar Probe para Users.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
X-Api-KeyX-Device-IdX-Merchant-Id
Testar
Exemplo de cURL
POST/users/register
Users and identityAplicativo do cliente · usuário para servidor

Executar Register para Users.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Chave de API privada ou token Bearer, conforme o fluxo
Headers aceitos ou encaminhados
X-Api-KeyX-Merchant-Id
Testar
Exemplo de cURL
POST/users/request-code
Users and identityAplicativo do cliente · usuário para servidor

Executar Request Code para Users.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Fluxo público de credenciais com contexto validado do aplicativo da loja
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Device-IdX-Merchant-Id
Testar
Exemplo de cURL
GET/users/sessions
Users and identityAplicativo do cliente · usuário para servidor

Listar ou obter Sessions.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
AuthorizationX-Device-IDX-Session-ID
Testar
Exemplo de cURL
GET/users/sessions/{session_id}/device
Users and identityAplicativo do cliente · usuário para servidor

Listar ou obter Device.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Device-IdX-Merchant-Id
Testar
Exemplo de cURL
POST/users/sign-message
Users and identityAplicativo do cliente · usuário para servidor

Criar Sign Message.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Merchant-Id
Testar
Exemplo de cURL
POST/users/signup
Users and identityAplicativo do cliente · usuário para servidor

Executar Signup para Users.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
X-Api-KeyX-Merchant-Id
Testar
Exemplo de cURL
GET/users/web/forgot-password
Users and identityAplicativo do cliente · usuário para servidor

Listar ou obter Forgot Password.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
O gateway não declara headers de solicitação
Testar
Exemplo de cURL
GET/users/web/login
Users and identityAplicativo do cliente · usuário para servidor

Executar Login para Web.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
O gateway não declara headers de solicitação
Testar
Exemplo de cURL
GET/users/web/password-login
Users and identityAplicativo do cliente · usuário para servidor

Listar ou obter Password Login.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
O gateway não declara headers de solicitação
Testar
Exemplo de cURL
GET/users/web/passwordless
Users and identityAplicativo do cliente · usuário para servidor

Listar ou obter Passwordless.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
O gateway não declara headers de solicitação
Testar
Exemplo de cURL
GET/users/web/signup
Users and identityAplicativo do cliente · usuário para servidor

Executar Signup para Web.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
O gateway não declara headers de solicitação
Testar
Exemplo de cURL
GET/v2/users
Users and identityAplicativo do cliente · usuário para servidor

Listar ou obter Users.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Chave de API privada (`X-Api-Key`)
Headers aceitos ou encaminhados
X-Api-Key
Testar
Exemplo de cURL
GET/v2/users/{user_id}
Users and identityAplicativo do cliente · usuário para servidor

Obter Users.

Domínio
Users and identity
Serviço responsável
Users and identity
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
Authorization
Testar
Exemplo de cURL
GET/v2/users/{user_id}/addresses
Users and identityAplicativo do cliente · usuário para servidor

Listar ou obter Addresses.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Token Bearer do usuário autenticado
Headers aceitos ou encaminhados
AuthorizationX-Device-IdX-Merchant-Id
Testar
Exemplo de cURL
POST/v2/users/login
Users and identityAplicativo do cliente · usuário para servidor

Executar Login para Users.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Aplicativo do cliente · usuário para servidor
Autorização compatível
Chave de API privada validada; o header Bearer do usuário é encaminhado quando existe
Headers aceitos ou encaminhados
AuthorizationX-Api-KeyX-Device-IdX-Merchant-IdX-Recaptcha-TokenX-Session-ID
Testar
Exemplo de cURL
Backend de rede ou parceiroUsado pelo backend autorizado de uma rede, plataforma ou parceiro de integração.15
GET/networks/{network_id}/processors
ConnectionsBackend de rede ou parceiro

Listar ou obter Processors.

Domínio
Connections
Serviço responsável
Payments
Destinado a
Backend de rede ou parceiro
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/networks/orders
OrdersBackend de rede ou parceiro

Listar ou obter Orders.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend de rede ou parceiro
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/networks/orders/filters-options
OrdersBackend de rede ou parceiro

Listar ou obter Filters Options.

Domínio
Orders
Serviço responsável
Orders and checkout
Destinado a
Backend de rede ou parceiro
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/networks/fields
ReportsBackend de rede ou parceiro

Listar ou obter Fields.

Domínio
Reports
Serviço responsável
Reports
Destinado a
Backend de rede ou parceiro
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/networks/reports/{id}/download
ReportsBackend de rede ou parceiro

Executar Download para Reports.

Domínio
Reports
Serviço responsável
Reports
Destinado a
Backend de rede ou parceiro
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/networks/reports/adhoc
ReportsBackend de rede ou parceiro

Criar Adhoc.

Domínio
Reports
Serviço responsável
Reports
Destinado a
Backend de rede ou parceiro
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/networks/reports/adhoc/{report_id}
ReportsBackend de rede ou parceiro

Obter Adhoc.

Domínio
Reports
Serviço responsável
Reports
Destinado a
Backend de rede ou parceiro
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/networks/reports/adhoc/{report_id}/logs
ReportsBackend de rede ou parceiro

Listar ou obter Logs.

Domínio
Reports
Serviço responsável
Reports
Destinado a
Backend de rede ou parceiro
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/networks/reports/adhoc/files
ReportsBackend de rede ou parceiro

Listar ou obter Files.

Domínio
Reports
Serviço responsável
Reports
Destinado a
Backend de rede ou parceiro
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/networks/reports/schedules
ReportsBackend de rede ou parceiro

Listar ou obter Schedules.

Domínio
Reports
Serviço responsável
Reports
Destinado a
Backend de rede ou parceiro
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/networks/reports/schedules
ReportsBackend de rede ou parceiro

Criar Schedules.

Domínio
Reports
Serviço responsável
Reports
Destinado a
Backend de rede ou parceiro
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
DELETE/networks/reports/schedules/{id}
ReportsBackend de rede ou parceiro

Excluir Schedules.

Domínio
Reports
Serviço responsável
Reports
Destinado a
Backend de rede ou parceiro
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/networks/reports/schedules/{id}
ReportsBackend de rede ou parceiro

Obter Schedules.

Domínio
Reports
Serviço responsável
Reports
Destinado a
Backend de rede ou parceiro
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
PATCH/networks/reports/schedules/{id}
ReportsBackend de rede ou parceiro

Atualizar Schedules.

Domínio
Reports
Serviço responsável
Reports
Destinado a
Backend de rede ou parceiro
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
PUT/networks/reports/schedules/{id}
ReportsBackend de rede ou parceiro

Atualizar Schedules.

Domínio
Reports
Serviço responsável
Reports
Destinado a
Backend de rede ou parceiro
Autorização compatível
O Gateway não declara um validador de credenciais; o acesso depende do serviço responsável ou da política de rede
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
Callback do provedor · provedor para DEUNAReceptor de callbacks de provedores; as lojas não chamam estas rotas.27
POST/transactions/webhooks/processors/{processor_name}
ConnectionsCallback do provedor · provedor para DEUNA

Criar Processors.

Domínio
Connections
Serviço responsável
Payments
Destinado a
Callback do provedor · provedor para DEUNA
Autorização compatível
O Gateway não declara um validador de credenciais; os headers do provedor são encaminhados ao serviço responsável
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/transactions/webhooks/processors/{processor_name}/refunds
ConnectionsCallback do provedor · provedor para DEUNA

Criar Refunds.

Domínio
Connections
Serviço responsável
Payments
Destinado a
Callback do provedor · provedor para DEUNA
Autorização compatível
O Gateway não declara um validador de credenciais; os headers do provedor são encaminhados ao serviço responsável
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/transactions/webhooks/processors/{processor_name}/uninstall
ConnectionsCallback do provedor · provedor para DEUNA

Executar Uninstall para Processors.

Domínio
Connections
Serviço responsável
Payments
Destinado a
Callback do provedor · provedor para DEUNA
Autorização compatível
O Gateway não declara um validador de credenciais; os headers do provedor são encaminhados ao serviço responsável
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/merchants/{merchant_id}/chargebacks/kushki
DisputesCallback do provedor · provedor para DEUNA

Criar Kushki.

Domínio
Disputes
Serviço responsável
Chargebacks
Destinado a
Callback do provedor · provedor para DEUNA
Autorização compatível
O Gateway não declara um validador de credenciais; os headers do provedor são encaminhados ao serviço responsável
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/merchants/{merchant_id}/chargebacks/stripe
DisputesCallback do provedor · provedor para DEUNA

Criar Stripe.

Domínio
Disputes
Serviço responsável
Chargebacks
Destinado a
Callback do provedor · provedor para DEUNA
Autorização compatível
O Gateway não declara um validador de credenciais; os headers do provedor são encaminhados ao serviço responsável
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/transactions/webhooks/addi
PaymentsCallback do provedor · provedor para DEUNA

Criar Addi.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Callback do provedor · provedor para DEUNA
Autorização compatível
O Gateway não declara um validador de credenciais; os headers do provedor são encaminhados ao serviço responsável
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/transactions/webhooks/aplazo
PaymentsCallback do provedor · provedor para DEUNA

Criar Aplazo.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Callback do provedor · provedor para DEUNA
Autorização compatível
O Gateway não declara um validador de credenciais; os headers do provedor são encaminhados ao serviço responsável
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/transactions/webhooks/conekta
PaymentsCallback do provedor · provedor para DEUNA

Criar Conekta.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Callback do provedor · provedor para DEUNA
Autorização compatível
O Gateway não declara um validador de credenciais; os headers do provedor são encaminhados ao serviço responsável
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/transactions/webhooks/dlocal
PaymentsCallback do provedor · provedor para DEUNA

Criar Dlocal.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Callback do provedor · provedor para DEUNA
Autorização compatível
O Gateway não declara um validador de credenciais; os headers do provedor são encaminhados ao serviço responsável
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/transactions/webhooks/kueski
PaymentsCallback do provedor · provedor para DEUNA

Criar Kueski.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Callback do provedor · provedor para DEUNA
Autorização compatível
O Gateway não declara um validador de credenciais; os headers do provedor são encaminhados ao serviço responsável
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/transactions/webhooks/mercadopago
PaymentsCallback do provedor · provedor para DEUNA

Criar Mercadopago.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Callback do provedor · provedor para DEUNA
Autorização compatível
O Gateway não declara um validador de credenciais; os headers do provedor são encaminhados ao serviço responsável
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/transactions/webhooks/openpay
PaymentsCallback do provedor · provedor para DEUNA

Criar Openpay.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Callback do provedor · provedor para DEUNA
Autorização compatível
O Gateway não declara um validador de credenciais; os headers do provedor são encaminhados ao serviço responsável
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/transactions/webhooks/opm-spei
PaymentsCallback do provedor · provedor para DEUNA

Criar Opm Spei.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Callback do provedor · provedor para DEUNA
Autorização compatível
O Gateway não declara um validador de credenciais; os headers do provedor são encaminhados ao serviço responsável
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/transactions/webhooks/oxxo
PaymentsCallback do provedor · provedor para DEUNA

Criar Oxxo.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Callback do provedor · provedor para DEUNA
Autorização compatível
O Gateway não declara um validador de credenciais; os headers do provedor são encaminhados ao serviço responsável
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/transactions/webhooks/paypalplatform/{transaction_id}
PaymentsCallback do provedor · provedor para DEUNA

Criar Paypalplatform.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Callback do provedor · provedor para DEUNA
Autorização compatível
O Gateway não declara um validador de credenciais; os headers do provedor são encaminhados ao serviço responsável
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/transactions/webhooks/payu
PaymentsCallback do provedor · provedor para DEUNA

Criar Payu.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Callback do provedor · provedor para DEUNA
Autorização compatível
O Gateway não declara um validador de credenciais; os headers do provedor são encaminhados ao serviço responsável
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/transactions/webhooks/stp
PaymentsCallback do provedor · provedor para DEUNA

Criar Stp.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Callback do provedor · provedor para DEUNA
Autorização compatível
O Gateway não declara um validador de credenciais; os headers do provedor são encaminhados ao serviço responsável
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/transactions/webhooks/stripe_oxxo
PaymentsCallback do provedor · provedor para DEUNA

Criar Stripe Oxxo.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Callback do provedor · provedor para DEUNA
Autorização compatível
O Gateway não declara um validador de credenciais; os headers do provedor são encaminhados ao serviço responsável
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/transactions/webhooks/webpay
PaymentsCallback do provedor · provedor para DEUNA

Criar Webpay.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Callback do provedor · provedor para DEUNA
Autorização compatível
O Gateway não declara um validador de credenciais; os headers do provedor são encaminhados ao serviço responsável
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
POST/transactions/webhooks/wompi
PaymentsCallback do provedor · provedor para DEUNA

Criar Wompi.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Callback do provedor · provedor para DEUNA
Autorização compatível
O Gateway não declara um validador de credenciais; os headers do provedor são encaminhados ao serviço responsável
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
PATCH/transactions/webhooks/zip
PaymentsCallback do provedor · provedor para DEUNA

Atualizar Zip.

Domínio
Payments
Serviço responsável
Payments
Destinado a
Callback do provedor · provedor para DEUNA
Autorização compatível
O Gateway não declara um validador de credenciais; os headers do provedor são encaminhados ao serviço responsável
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
DELETE/subscriptions/webhook-configurations
SubscriptionsCallback do provedor · provedor para DEUNA

Excluir Webhook Configurations.

Domínio
Subscriptions
Serviço responsável
Subscriptions
Destinado a
Callback do provedor · provedor para DEUNA
Autorização compatível
O Gateway não declara um validador de credenciais; os headers do provedor são encaminhados ao serviço responsável
Headers aceitos ou encaminhados
Authorizationx-Api-KeyX-Internal-API-KeyX-Merchant-ID
Testar
Exemplo de cURL
GET/subscriptions/webhook-configurations
SubscriptionsCallback do provedor · provedor para DEUNA

Listar ou obter Webhook Configurations.

Domínio
Subscriptions
Serviço responsável
Subscriptions
Destinado a
Callback do provedor · provedor para DEUNA
Autorização compatível
O Gateway não declara um validador de credenciais; os headers do provedor são encaminhados ao serviço responsável
Headers aceitos ou encaminhados
Authorizationx-Api-KeyX-Internal-API-KeyX-Merchant-ID
Testar
Exemplo de cURL
PATCH/subscriptions/webhook-configurations
SubscriptionsCallback do provedor · provedor para DEUNA

Atualizar Webhook Configurations.

Domínio
Subscriptions
Serviço responsável
Subscriptions
Destinado a
Callback do provedor · provedor para DEUNA
Autorização compatível
O Gateway não declara um validador de credenciais; os headers do provedor são encaminhados ao serviço responsável
Headers aceitos ou encaminhados
Authorizationx-Api-KeyX-Internal-API-KeyX-Merchant-ID
Testar
Exemplo de cURL
POST/subscriptions/webhook-configurations
SubscriptionsCallback do provedor · provedor para DEUNA

Criar Webhook Configurations.

Domínio
Subscriptions
Serviço responsável
Subscriptions
Destinado a
Callback do provedor · provedor para DEUNA
Autorização compatível
O Gateway não declara um validador de credenciais; os headers do provedor são encaminhados ao serviço responsável
Headers aceitos ou encaminhados
Authorizationx-Api-KeyX-Internal-API-KeyX-Merchant-ID
Testar
Exemplo de cURL
GET/subscriptions/webhook-configurations/event-types
SubscriptionsCallback do provedor · provedor para DEUNA

Listar ou obter Event Types.

Domínio
Subscriptions
Serviço responsável
Subscriptions
Destinado a
Callback do provedor · provedor para DEUNA
Autorização compatível
O Gateway não declara um validador de credenciais; os headers do provedor são encaminhados ao serviço responsável
Headers aceitos ou encaminhados
Authorizationx-Api-KeyX-Internal-API-KeyX-Merchant-ID
Testar
Exemplo de cURL
POST/hermes/waf/report-data/bts-delivery
Webhooks and notificationsCallback do provedor · provedor para DEUNA

Criar Bts Delivery.

Domínio
Webhooks and notifications
Serviço responsável
Notifications
Destinado a
Callback do provedor · provedor para DEUNA
Autorização compatível
O Gateway não declara um validador de credenciais; os headers do provedor são encaminhados ao serviço responsável
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
Navegador público ou infraestruturaRedirecionamentos, metadados, recursos ou superfícies de saúde sem autenticação.3
GET/users/.well-known/jwks.json
Users and identityNavegador público ou infraestrutura

Listar ou obter Jwks.Json.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Navegador público ou infraestrutura
Autorização compatível
Nenhuma credencial declarada
Headers aceitos ou encaminhados
O gateway não declara headers de solicitação
Testar
Exemplo de cURL
GET/users/static/css/{file}
Users and identityNavegador público ou infraestrutura

Obter Css.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Navegador público ou infraestrutura
Autorização compatível
Nenhuma credencial declarada
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL
GET/users/static/js/{file}
Users and identityNavegador público ou infraestrutura

Obter Js.

Domínio
Users and identity
Serviço responsável
Merchant management
Destinado a
Navegador público ou infraestrutura
Autorização compatível
Nenhuma credencial declarada
Headers aceitos ou encaminhados
*
Testar
Exemplo de cURL

Pontos de extremidade de integração principais#

As operações abaixo mantêm os pontos de extremidade estáveis, utilizados em guias de integração, e fornecem contexto adicional para os fluxos de trabalho mais comuns dos comerciantes.

API de Pedidos#

Criar um pedido

POST /merchants/orders

Cria um pedido e retorna os order_token utilizados pelos widgets e operações de pagamento da DEUNA.

O objeto necessário varia de acordo com o tipo de pedido: pedidos de checkout e assinaturas exigem a matriz de itens, enquanto pedidos de companhias aéreas exigem informações da companhia aérea. O contrato base não marca uma propriedade de item individual como exigida universalmente. Veja o referência de campo de item e guia de campo vertical.

Exemplo de cURL
curl --request POST \
  --url 'https://api.sandbox.deuna.io/merchants/orders' \
  --header 'X-Api-Key: YOUR_PRIVATE_API_KEY' \
  --header 'Authorization: Bearer USER_ACCESS_TOKEN' \
  --header 'X-Idempotency-Key: IDEMPOTENCY_KEY' \
  --header 'X-Prediction-Id: PREDICTION_ID_VALUE' \
  --header 'Content-Type: application/json' \
  --data @request.json

Obter um pedido

GET /merchants/orders/{order_token}

Recupera o estado atual do pedido, pagamento e processamento para um token de pedido.

Exemplo de cURL
curl --request GET \
  --url 'https://api.sandbox.deuna.io/merchants/orders/{order_token}' \
  --header 'X-Api-Key: YOUR_PRIVATE_API_KEY' \
  --header 'Authorization: Bearer USER_ACCESS_TOKEN' \
  --header 'x-merchant-id: MERCHANT_ID'

Obter métodos de pagamento para um pedido

GET /merchants/orders/{order_token}/payments-methods

Retorna os métodos de pagamento disponíveis para um pedido específico e configuração de comerciante.

Exemplo de cURL
curl --request GET \
  --url 'https://api.sandbox.deuna.io/merchants/orders/{order_token}/payments-methods' \
  --header 'X-Api-Key: YOUR_PRIVATE_API_KEY' \
  --header 'Authorization: Bearer USER_ACCESS_TOKEN' \
  --header 'X-Store-Code: STORE_CODE'

POST /merchants/orders/{order_token}/consent

Cria a autorização do cliente necessária para conexões de carteiras suportadas. A resposta pode incluir um provedor redirect_url. Consulte Fluxos de consentimento.

Exemplo de cURL
curl --request POST \
  --url 'https://api.sandbox.deuna.io/merchants/orders/{order_token}/consent' \
  --header 'X-Api-Key: YOUR_PRIVATE_API_KEY' \
  --header 'Authorization: Bearer USER_ACCESS_TOKEN' \
  --header 'X-Store-Code: STORE_CODE' \
  --header 'Content-Type: application/json' \
  --data @request.json

GET /merchants/orders/{order_token}/consent

Retorna o estado de consentimento mais recente. Para conexões que suportam a consulta do provedor, a DEUNA renova um consentimento pendente elegível antes de retorná-lo.

Exemplo de cURL
curl --request GET \
  --url 'https://api.sandbox.deuna.io/merchants/orders/{order_token}/consent' \
  --header 'X-Api-Key: YOUR_PRIVATE_API_KEY' \
  --header 'Authorization: Bearer USER_ACCESS_TOKEN' \
  --header 'X-Store-Code: STORE_CODE'

API de Pagamentos#

Criar um pagamento

POST /v2/merchants/orders/purchase

Processa um pagamento para um token de pedido existente ou para o pedido fornecido na solicitação. Consulte o guia detalhado de requisição de pagamento.

Exemplo de cURL
curl --request POST \
  --url 'https://api.sandbox.deuna.io/v2/merchants/orders/purchase' \
  --header 'X-Api-Key: YOUR_PRIVATE_API_KEY' \
  --header 'Authorization: Bearer USER_ACCESS_TOKEN' \
  --header 'Cookie: COOKIE_VALUE' \
  --header 'X-Device-Id: DEVICE_ID' \
  --header 'X-Merchant-ID: MERCHANT_ID' \
  --header 'X-Prediction-Id: PREDICTION_ID_VALUE' \
  --header 'X-Session-Id: SESSION_ID' \
  --header 'X-Store-Code: STORE_CODE' \
  --header 'Content-Type: application/json' \
  --data @request.json

Capturar um pagamento

POST /v2/merchants/orders/{order_token}/capture

Captura todo ou parte de um pagamento autorizado. Utilize apenas no backend do comerciante quando a conexão suporta a autorização e captura separadas.

Exemplo de cURL
curl --request POST \
  --url 'https://api.sandbox.deuna.io/v2/merchants/orders/{order_token}/capture' \
  --header 'Content-Type: application/json' \
  --data @request.json

Anular uma autorização

POST /merchants/orders/{order_token}/void

Libera uma autorização elegível antes da captura. Uma solicitação sincrônica bem-sucedida retorna HTTP 204 No Content; os processadores assíncronos ainda devem ser rastreados até o status final do pagamento.

Exemplo de cURL
curl --request POST \
  --url 'https://api.sandbox.deuna.io/merchants/orders/{order_token}/void' \
  --header 'X-Api-Key: YOUR_PRIVATE_API_KEY' \
  --header 'Content-Type: application/json' \
  --data @request.json

Reembolsar um pagamento

POST /v2/merchants/orders/{order_token}/refund

Cria um reembolso total ou parcial para um pagamento processado.

Exemplo de cURL
curl --request POST \
  --url 'https://api.sandbox.deuna.io/v2/merchants/orders/{order_token}/refund' \
  --header 'Content-Type: application/json' \
  --data @request.json

API de Rede do Usuário#

Essas operações suportam a identidade do cliente, endereços e instrumentos de pagamento armazenados com segurança. Os aplicativos de navegador e móveis utilizam a autorização do cliente. Os sistemas de back-end de comerciantes confiáveis utilizam a autorização apresentada para cada rota na lista acima.

Autenticação

Registrar um usuário

POST /users/register

Cria um usuário que pode autenticar e reutilizar de forma segura os métodos de pagamento armazenados.

Exemplo de cURL
curl --request POST \
  --url 'https://api.sandbox.deuna.io/users/register' \
  --header 'X-Api-Key: YOUR_PRIVATE_API_KEY' \
  --header 'X-Merchant-Id: MERCHANT_ID' \
  --header 'Content-Type: application/json' \
  --data @request.json

Solicitar um OTP

POST /users/request-code

Envia o código de uso único usado no fluxo de autenticação sem senha.

Exemplo de cURL
curl --request POST \
  --url 'https://api.sandbox.deuna.io/users/request-code' \
  --header 'Authorization: Bearer USER_ACCESS_TOKEN' \
  --header 'X-Api-Key: YOUR_PRIVATE_API_KEY' \
  --header 'X-Device-Id: DEVICE_ID' \
  --header 'X-Merchant-Id: MERCHANT_ID' \
  --header 'Content-Type: application/json' \
  --data @request.json

Fazer login com um OTP

POST /users/login

Troca um código de uso único válido por um token de autorização do usuário.

Exemplo de cURL
curl --request POST \
  --url 'https://api.sandbox.deuna.io/users/login' \
  --header 'Authorization: Bearer USER_ACCESS_TOKEN' \
  --header 'X-Api-Key: YOUR_PRIVATE_API_KEY' \
  --header 'X-Device-Id: DEVICE_ID' \
  --header 'X-Merchant-Id: MERCHANT_ID' \
  --header 'X-Qa-Api-Key: QA_API_KEY_VALUE' \
  --header 'X-Recaptcha-Token: RECAPTCHA_TOKEN_VALUE' \
  --header 'X-Session-ID: SESSION_ID' \
  --header 'Content-Type: application/json' \
  --data @request.json

Autorização externa

POST /users/external-authorize

Autentica um usuário através de um fluxo de identidade gerenciado pelo comerciante.

Exemplo de cURL
curl --request POST \
  --url 'https://api.sandbox.deuna.io/users/external-authorize' \
  --header 'X-Api-Key: YOUR_PRIVATE_API_KEY' \
  --header 'Authorization: Bearer USER_ACCESS_TOKEN' \
  --header 'X-Auth-Message: AUTH_MESSAGE_VALUE' \
  --header 'X-Device-Id: DEVICE_ID' \
  --header 'X-Merchant-Id: MERCHANT_ID' \
  --header 'Content-Type: application/json' \
  --data @request.json

Usuários

GET /users/me

Retorna o perfil do usuário autenticado.

Exemplo de cURL
curl --request GET \
  --url 'https://api.sandbox.deuna.io/users/me' \
  --header 'Authorization: Bearer USER_ACCESS_TOKEN' \
  --header 'X-Device-Id: DEVICE_ID' \
  --header 'X-Merchant-Id: MERCHANT_ID'

GET /v2/users/{user_id}

Recupera um usuário por ID, no contexto de um cliente autorizado.

Exemplo de cURL
curl --request GET \
  --url 'https://api.sandbox.deuna.io/v2/users/{user_id}' \
  --header 'Authorization: Bearer USER_ACCESS_TOKEN'

Endereços

GET /users/{user_id}/addresses

Lista os endereços associados a um usuário.

Exemplo de cURL
curl --request GET \
  --url 'https://api.sandbox.deuna.io/users/{user_id}/addresses' \
  --header 'Authorization: Bearer USER_ACCESS_TOKEN' \
  --header 'X-Device-Id: DEVICE_ID' \
  --header 'X-Merchant-Id: MERCHANT_ID'

POST /users/{user_id}/addresses

Cria um endereço para um usuário.

Exemplo de cURL
curl --request POST \
  --url 'https://api.sandbox.deuna.io/users/{user_id}/addresses' \
  --header 'Authorization: Bearer USER_ACCESS_TOKEN' \
  --header 'X-Device-Id: DEVICE_ID' \
  --header 'X-Merchant-Id: MERCHANT_ID' \
  --header 'Content-Type: application/json' \
  --data @request.json

PATCH /users/{user_id}/addresses/{address_id}

Atualiza um endereço existente. A API exige a autorização Bearer e o contexto do comerciante para estas rotas.

Exemplo de cURL
curl --request PATCH \
  --url 'https://api.sandbox.deuna.io/users/{user_id}/addresses/{address_id}' \
  --header 'Authorization: Bearer USER_ACCESS_TOKEN' \
  --header 'X-Device-Id: DEVICE_ID' \
  --header 'X-Merchant-Id: MERCHANT_ID' \
  --header 'Content-Type: application/json' \
  --data @request.json

Cartões

Armazena um cartão

POST /v2/users/{user_id}/cards

Armazena um cartão tokenizado para uso posterior. Os dados brutos do cartão não devem passar pelos servidores do comerciante, a menos que o comerciante possua o escopo PCI necessário.

Exemplo de cURL
curl --request POST \
  --url 'https://api.sandbox.deuna.io/v2/users/{user_id}/cards' \
  --header 'Authorization: Bearer USER_ACCESS_TOKEN' \
  --header 'X-Merchant-ID: MERCHANT_ID' \
  --header 'Content-Type: application/json' \
  --data @request.json

Listar cartões armazenados

GET /payments-cards/users/{user_id}/cards

Retorna os cartões armazenados do usuário autenticado. Os metadados de verificação são condicionais. Cartões não verificados omitem todos os campos de verificação.

Exemplo de cURL
curl --request GET \
  --url 'https://api.sandbox.deuna.io/payments-cards/users/{user_id}/cards' \
  --header 'Authorization: Bearer USER_ACCESS_TOKEN' \
  --header 'X-Api-Key: YOUR_PRIVATE_API_KEY'

Obter um cartão armazenado

GET /payments-cards/users/{user_id}/cards/{card_id}

Retorna um cartão armazenado. Quando a DEUNA verifica o cartão com sucesso, a resposta inclui os campos de verificação exibidos abaixo.

Exemplo de cURL
curl --request GET \
  --url 'https://api.sandbox.deuna.io/payments-cards/users/{user_id}/cards/{card_id}' \
  --header 'Authorization: Bearer USER_ACCESS_TOKEN' \
  --header 'X-Api-Key: YOUR_PRIVATE_API_KEY'
JSON
{
  "data": {
    "id": "8b5d0b45-e34f-4fd3-8cb5-79a7041f86ec",
    "company": "visa",
    "last_four": "4242",
    "expiration_date": "12/29",
    "is_valid": true,
    "verified_by": "card_verifier",
    "verified_at": "2026-10-03T12:00:00Z"
  }
}
CampoQuando é retornadoSignificado
is_validSomente após uma verificação bem-sucedidaSempre true quando presente. A ausência do campo significa que o cartão ainda não foi verificado com sucesso; não significa que uma tentativa de verificação falhou.
verified_bySomente após uma verificação bem-sucedidacard_verifier identifica uma autorização de valor zero. payment identifica a verificação por meio de uma transação de pagamento. Um verificador específico do processador pode ser retornado quando o processador valida o cartão durante a tokenização.
verified_atSomente após uma verificação bem-sucedidaData e hora ISO 8601 registradas quando a DEUNA marcou o cartão como verificado.

Um pagamento verifica um cartão somente depois que a transação atinge processing, processed, authorized, ou captured. Transações com falha ou pendentes não verificam o cartão. Consulte Tokenização de cartão para entender como a verificação se relaciona à reutilização de cartões armazenados.

Remove uma conta de carteira armazenada

DELETE /users/payment-methods/{payment_method_id}/tokens/{payment_method}

Remove a conta de carteira armazenada do usuário autenticado e seu consentimento reutilizável. Consulte Fluxos de consentimento.

Exemplo de cURL
curl --request DELETE \
  --url 'https://api.sandbox.deuna.io/users/payment-methods/{payment_method_id}/tokens/{payment_method}' \
  --header 'Authorization: Bearer USER_ACCESS_TOKEN' \
  --header 'X-Merchant-ID: MERCHANT_ID'

Obtém informações do BIN do cartão

GET /cards/bin/{bin}

Retorna informações de rede, emissor e tipo de cartão para um BIN de seis dígitos.

Exemplo de cURL
curl --request GET \
  --url 'https://api.sandbox.deuna.io/cards/bin/{bin}' \
  --header 'X-Api-Key: YOUR_PRIVATE_API_KEY' \
  --header 'X-Merchant-Id: MERCHANT_ID'

API do Comerciante#

Métodos de pagamento

GET /merchants/stores/payments-methods

Retorna os métodos de pagamento habilitados para uma loja. Passe o código da loja nos parâmetros necessários. X-Store-Code header.

Exemplo de cURL
curl --request GET \
  --url 'https://api.sandbox.deuna.io/merchants/stores/payments-methods' \
  --header 'X-Api-Key: YOUR_PRIVATE_API_KEY' \
  --header 'X-Idempotency-Key: IDEMPOTENCY_KEY' \
  --header 'X-Merchant-Id: MERCHANT_ID' \
  --header 'X-Prediction-Id: PREDICTION_ID_VALUE' \
  --header 'X-Store-Code: STORE_CODE'

POST /merchants/payment-links

Cria um link de pagamento a partir do backend de um comerciante confiável.

Exemplo de cURL
curl --request POST \
  --url 'https://api.sandbox.deuna.io/merchants/payment-links' \
  --header 'Content-Type: application/json' \
  --data @request.json

GET /merchants/payment-links/{payment_link_id}

Recupera um link de pagamento e seu estado atual.

Exemplo de cURL
curl --request GET \
  --url 'https://api.sandbox.deuna.io/merchants/payment-links/{payment_link_id}'

PATCH /merchants/payment-links/{payment_link_id}

Atualiza um link de pagamento existente.

Exemplo de cURL
curl --request PATCH \
  --url 'https://api.sandbox.deuna.io/merchants/payment-links/{payment_link_id}' \
  --header 'Content-Type: application/json' \
  --data @request.json

Consulte o Guia de integração de Links de Pagamento para o fluxo completo.

API de Assinaturas#

Planos

GET /subscriptions/plans

Lista os planos de assinatura disponíveis para o comerciante autenticado.

Exemplo de cURL
curl --request GET \
  --url 'https://api.sandbox.deuna.io/subscriptions/plans' \
  --header 'Authorization: Bearer USER_ACCESS_TOKEN' \
  --header 'x-Api-Key: YOUR_PRIVATE_API_KEY' \
  --header 'X-Merchant-ID: MERCHANT_ID'

POST /subscriptions/plans

Cria um plano de assinatura.

Exemplo de cURL
curl --request POST \
  --url 'https://api.sandbox.deuna.io/subscriptions/plans' \
  --header 'Authorization: Bearer USER_ACCESS_TOKEN' \
  --header 'x-Api-Key: YOUR_PRIVATE_API_KEY' \
  --header 'X-Merchant-ID: MERCHANT_ID' \
  --header 'Content-Type: application/json' \
  --data @request.json

Assinaturas

Lista as assinaturas

GET /subscriptions

Retorna as assinaturas disponíveis para o comerciante autenticado.

Exemplo de cURL
curl --request GET \
  --url 'https://api.sandbox.deuna.io/subscriptions' \
  --header 'Authorization: Bearer USER_ACCESS_TOKEN' \
  --header 'x-Api-Key: YOUR_PRIVATE_API_KEY' \
  --header 'X-Merchant-ID: MERCHANT_ID'

Criar uma assinatura

POST /subscriptions

Cria uma assinatura utilizando um plano e método de pagamento existentes.

Exemplo de cURL
curl --request POST \
  --url 'https://api.sandbox.deuna.io/subscriptions' \
  --header 'Authorization: Bearer USER_ACCESS_TOKEN' \
  --header 'x-Api-Key: YOUR_PRIVATE_API_KEY' \
  --header 'X-Merchant-ID: MERCHANT_ID' \
  --header 'Content-Type: application/json' \
  --data @request.json

Atualizar uma assinatura

PATCH /subscriptions/{id}

Atualiza os atributos suportados de uma assinatura ativa.

Exemplo de cURL
curl --request PATCH \
  --url 'https://api.sandbox.deuna.io/subscriptions/{id}' \
  --header 'Authorization: Bearer USER_ACCESS_TOKEN' \
  --header 'x-Api-Key: YOUR_PRIVATE_API_KEY' \
  --header 'X-Merchant-ID: MERCHANT_ID' \
  --header 'Content-Type: application/json' \
  --data @request.json