Pular para o conteúdo principal
Nesta página

Use este catálogo para encontrar as operações migradas da referência anterior da API da DEUNA. A matriz de migração mantém cada método e rota publicados representados uma única vez e exclui as demais rotas do API Gateway.

Inventário de endpoints publicados#

Este inventário é gerado a partir da configuração efetiva do API Gateway e limitado pela matriz de migração revisada. Use os filtros para identificar quem deve chamar uma operação, qual serviço é responsável, qual autorização é compatível e quais headers o gateway aceita ou encaminha.

O catálogo inclui apenas operações de backend do lojista e de aplicativos do cliente que já estavam presentes na referência pública anterior da API. Operações internas de Admin, gerenciamento, parceiros, callbacks de provedores e outras operações do gateway são excluídas.

Rotas abaixo /transactions/webhooks/ recebem eventos do processador dentro da DEUNA e não são endpoints de integração do lojista. Quando um provedor exige configuração de callback no lado do lojista, a URL e as etapas de configuração estão no guia de conexão desse provedor — por exemplo, o callback de status de pagamento Stripe OXXOUse DEUNA para notificações entregues ao seu próprio backend.

Inventário verificado de APIs publicadas56 operações publicadas

Gerado a partir das operações efetivas do API Gateway mapeadas da referência pública anterior.

Backend da loja · servidor a servidor 42Aplicativo do cliente · usuário para servidor 14
Exibindo 56 de 56 operações
Backend da loja · servidor a servidorUse a partir de um backend confiável da loja para pedidos, pagamentos e fluxos operacionais.42
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
GET/merchants/checkout/themes
CheckoutBackend da loja · servidor a servidor

Listar ou obter Themes

Domínio
Checkout
Serviço responsável
Checkout configuration
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/checkout/themes
CheckoutBackend da loja · servidor a servidor

Criar Themes

Domínio
Checkout
Serviço responsável
Checkout configuration
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
DELETE/merchants/checkout/themes/{theme_id}
CheckoutBackend da loja · servidor a servidor

Excluir Themes

Domínio
Checkout
Serviço responsável
Checkout configuration
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
PATCH/merchants/checkout/themes/{theme_id}
CheckoutBackend da loja · servidor a servidor

Atualizar Themes

Domínio
Checkout
Serviço responsável
Checkout configuration
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
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}/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}/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
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
POST/v2/merchants/orders/{order_token}/capture
OrdersBackend da loja · servidor a servidor

Capturar Payment

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 Payment

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
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
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/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/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/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
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
POST/subscriptions/{id}/external-settlement
SubscriptionsBackend da loja · servidor a servidor

Criar External Settlement

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
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/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
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
Aplicativo do cliente · usuário para servidorUse em fluxos web ou móveis do cliente com a identidade e o contexto do dispositivo indicados.14
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
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
PATCH/users/{user_id}/cards/{card_id}/set-as-default
Cards and vaultAplicativo do cliente · usuário para servidor

Definir cartão como padrão

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/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/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
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/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/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
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

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

Opcionalmente cria um pedido antes do pagamento e retorna o order_token usado pelos widgets e pelas operações de pagamento da DEUNA. Novas integrações diretas podem enviar o pedido inline ao Purchase V2.

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'

API de Pagamentos#

Criar um pagamento

POST /v2/merchants/orders/purchase

Cria e processa um pedido inline no fluxo recomendado de uma única chamada ou processa um order_token existente quando o pedido foi criado separadamente. 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#

Estas operações opcionais oferecem suporte à identidade do cliente, a endereços reutilizáveis e a instrumentos de pagamento armazenados com segurança. Elas não estão obsoletas, mas não são pré-requisitos para o Purchase V2. Aplicativos web e móveis usam autorização do cliente. Backends confiáveis do lojista usam a autorização indicada para cada rota no inventário acima.

Autenticação

Registrar um usuário

POST /users/register

Opcionalmente cria um usuário que pode se autenticar e reutilizar com segurança os dados do cliente e 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'

Usuários

GET /users/me

Retorna o perfil do usuário autenticado quando a integração usa contas de cliente opcionais.

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'

Endereços

GET /users/{user_id}/addresses

Lista os endereços reutilizáveis associados a um usuário. Esta operação opcional não é necessária antes do Purchase V2.

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

Opcionalmente salva um endereço para reutilização por um usuário autenticado. Um endereço também pode ser fornecido inline em uma solicitação de pagamento.

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 reutilizável existente. O inventário mostra a autorização Bearer e o contexto do lojista exigidos por essas rotas opcionais.

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

Tokeniza e armazena um ou mais cartões para uso futuro. O corpo da solicitação é um array JSON, inclusive quando contém apenas um cartão. Chame este endpoint autorizado pelo cliente com o token Bearer do usuário e o contexto do lojista mostrado no inventário gerado.

Os dados brutos do cartão não devem passar pelos servidores do lojista, a menos que ele tenha o escopo PCI necessário. Consulte o fluxo de vaulting da API de Cards para ver o formato da solicitação, o limite de segurança, a resposta de sucesso e as orientações de nova tentativa.

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

Qual rota POST de cartão devo usar?

Somente POST /v2/users/{user_id}/cards faz parte do contrato atual da API externa de Cartões. As outras rotas POST que podem aparecer nos inventários do Gateway servem a diferentes propósitos de compatibilidade ou da plataforma; elas não são três maneiras intercambiáveis de criar um cartão.

RotaO que ela realmente fazOrientação de integração externa
POST /v2/users/{user_id}/cardsTokeniza e armazena um ou mais cartões do cliente. Seu corpo de solicitação é um array, mesmo quando contém um cartão, e a resposta retorna DEUNA card_id values.Use esta rota para novas integrações da API de Cartões autorizadas pelo cliente.
POST /users/{user_id}/cardsPreserva o contrato de solicitação de cartão único legado v1 para integrações existentes.Rota de compatibilidade; ela é intencionalmente excluída do catálogo atual da API externa. Não inicie uma nova integração com ela, a menos que a DEUNA oriente explicitamente a fazê-lo.
POST /users/{user_id}/cards/{card_id}/tokensAdiciona um token específico do processador ou um resultado de verificação a um cartão que já existe. Ela não cria um cartão do cliente nem substitui a /v2 operação de armazenamento seguro.Operação gerenciada pela plataforma; ela é intencionalmente excluída da documentação externa e não deve ser chamada diretamente, a menos que a DEUNA aprove o fluxo e o contrato.

:::info Por que uma rota pode existir sem aparecer aqui O inventário do API Gateway inclui rotas de compatibilidade e operadas pela plataforma, além de contratos públicos do lojista. A presença no Gateway não torna, por si só, uma operação uma API externa suportada. O catálogo publica apenas operações que já fazem parte da referência externa ou têm aprovação explícita da equipe proprietária. :::

Listar cartões armazenados

GET /users/{user_id}/cards

Retorna os cartões associados ao usuário autenticado.

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

Obter um cartão armazenado

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

Retorna um cartão associado ao usuário autenticado.

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

Definir um cartão como padrão

PATCH /users/{user_id}/cards/{card_id}/set-as-default

Define ou remove o cartão salvo selecionado como padrão do usuário autenticado. Quando um cartão se torna o padrão, a DEUNA remove esse status dos demais cartões do usuário. Consulte Definir um cartão como padrão para ver o corpo opcional da solicitação, a resposta e as etapas de verificação.

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

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#

API de Temas

A API de Temas é suportada e não está obsoleta. Ela gerencia configurações JSON nomeadas e com escopo do lojista que podem ser aplicadas às experiências DEUNA Checkout e Widget. Chame essas operações apenas de um backend confiável do lojista com a X-Api-Keyprivada; o serviço de Configuração do Checkout deriva o escopo do lojista dessa credencial.

Recurso Tema

CampoRetornadoCriarAtualizarDescrição
idSimGeradoParâmetro de caminhoUUID do tema gerado pela DEUNA. Use-o como theme_id para atualizar e excluir.
nameSimObrigatórioOpcional quando config é fornecidoNome exclusivo do lojista contendo letras, números ou sublinhados.
configSimObrigatórioOpcional quando name é fornecidoObjeto JSON contendo a configuração do tema consumida pela experiência Checkout ou Widget.

A operação de criação rejeita nomes duplicados e aplica a contagem máxima de temas do serviço de Configuração do Checkout. Atualizar e excluir retornam um erro quando theme_id não pertence a um tema existente na configuração do lojista.

curl --request POST \
  --url 'https://api.sandbox.deuna.io/merchants/checkout/themes' \
  --header 'X-Api-Key: YOUR_PRIVATE_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "checkout_default",
    "config": {
      "theme": {
        "mainColor": "#1479A8",
        "secondaryColor": "#111827",
        "backgroundColor": "#FFFFFF"
      }
    }
  }'
TemaJSON
{
  "id": "bfcabe59-48c9-4c36-b041-71597478689c",
  "name": "checkout_default",
  "config": {
    "theme": {
      "mainColor": "#1479A8",
      "secondaryColor": "#111827",
      "backgroundColor": "#FFFFFF"
    }
  }
}

A operação de lista retorna a mesma forma de recurso em data[]. Criar e atualizar retornam o tema afetado. Excluir tem sucesso com uma resposta vazia.

:::note Esquema de configuração do tema O serviço valida que config é um objeto JSON, mas não valida suas chaves aninhadas. Use a forma de configuração suportada pela versão do Checkout ou Widget que consumirá o tema. Não assuma que um objeto config da API de Temas e um objeto CustomStyle do SDK são intercambiáveis. :::

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}'

GET /merchants/payment-links/all

Lista os links de pagamento associados à loja do lojista autenticado.

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

GET /merchants/payment-links/{payment_link_id}/orders

Lista os pedidos associados a um link de pagamento.

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

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