Endpoint catalog
Canonical routes for the DEUNA order, payment, user, card, and subscription endpoints referenced throughout the documentation.
On this page
Use this catalog when a guide links to an API operation. Paths and HTTP methods are kept stable here so older integration guides resolve to a useful, current destination.
Complete API Gateway inventory#
This inventory is generated from the effective API Gateway configuration, rather than from the smaller legacy OpenAPI snapshot. Use the filters to identify who should call an operation, which service owns it, what authorization it supports, and which headers the gateway accepts or forwards.
The catalog includes merchant and customer APIs, partner routes, provider callbacks, and public browser routes. Internal Admin and management operations are excluded. Provider callbacks are shown for integration context and must not be called by merchant integrations.
Verified gateway inventory385 configured operations
Generated from the public-facing portion of the effective API Gateway configuration.
Merchant backend · server to server 278Customer application · user to server 62Network or partner backend 15Provider callback · provider to DEUNA 27Public browser or infrastructure 3
Showing 385 of 385 operations
Merchant backend · server to serverUse from a trusted merchant backend for orders, payments and operational workflows.278
GET
/cards/bin/{bin}Cards and vaultMerchant backend · server to server
Retrieve Bin.
- Domain
- Cards and vault
- Owning service
- Card metadata
- Intended for
- Merchant backend · server to server
POST
/merchants/external-orders/{order_token}/gift-cardsCards and vaultMerchant backend · server to server
Create Gift Cards.
- Domain
- Cards and vault
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/external-orders/{order_token}/couponsCheckoutMerchant backend · server to server
Create Coupons.
- Domain
- Checkout
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
DELETE
/merchants/external-orders/{order_token}/coupons/{coupon_code}CheckoutMerchant backend · server to server
Delete Coupons.
- Domain
- Checkout
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
PATCH
/merchants/external-orders/{order_token}/custom-fieldsCheckoutMerchant backend · server to server
Update Custom Fields.
- Domain
- Checkout
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/external-orders/{order_token}/shipping-methodsCheckoutMerchant backend · server to server
Create Shipping Methods.
- Domain
- Checkout
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
PATCH
/merchants/external-orders/{order_token}/shipping-methods/{code}CheckoutMerchant backend · server to server
Update Shipping Methods.
- Domain
- Checkout
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/external-orders/{order_token}/shipping-rateCheckoutMerchant backend · server to server
Create Shipping Rate.
- Domain
- Checkout
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/orders/{order_token}/credentialsConnectionsMerchant backend · server to server
List or retrieve Credentials.
- Domain
- Connections
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/disputesDisputesMerchant backend · server to server
List or retrieve Disputes.
- Domain
- Disputes
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/disputesDisputesMerchant backend · server to server
Create Disputes.
- Domain
- Disputes
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/disputes/{id}DisputesMerchant backend · server to server
Retrieve Disputes.
- Domain
- Disputes
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
PATCH
/merchants/disputes/{id}/draftDisputesMerchant backend · server to server
Update Draft.
- Domain
- Disputes
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/disputes/{id}/evidenceDisputesMerchant backend · server to server
List or retrieve Evidence.
- Domain
- Disputes
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/disputes/{id}/evidenceDisputesMerchant backend · server to server
Create Evidence.
- Domain
- Disputes
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/disputes/{id}/evidence/{evidence_id}DisputesMerchant backend · server to server
Retrieve Evidence.
- Domain
- Disputes
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/disputes/{id}/evidence/{evidence_id}/archiveDisputesMerchant backend · server to server
Run Archive for Evidence.
- Domain
- Disputes
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/disputes/{id}/evidence/{evidence_id}/versionsDisputesMerchant backend · server to server
Create Versions.
- Domain
- Disputes
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/disputes/{id}/evidence/{evidence_id}/versions/{version_id}/completeDisputesMerchant backend · server to server
Run Complete for Versions.
- Domain
- Disputes
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/disputes/{id}/evidence/{evidence_id}/versions/{version_id}/downloadDisputesMerchant backend · server to server
Run Download for Versions.
- Domain
- Disputes
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/disputes/{id}/information-requestsDisputesMerchant backend · server to server
List or retrieve Information Requests.
- Domain
- Disputes
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/disputes/{id}/information-requestsDisputesMerchant backend · server to server
Create Information Requests.
- Domain
- Disputes
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/disputes/{id}/information-requests/{request_id}DisputesMerchant backend · server to server
Retrieve Information Requests.
- Domain
- Disputes
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/disputes/{id}/information-requests/{request_id}/dismissDisputesMerchant backend · server to server
Run Dismiss for Information Requests.
- Domain
- Disputes
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/disputes/{id}/information-requests/{request_id}/resolveDisputesMerchant backend · server to server
Run Resolve for Information Requests.
- Domain
- Disputes
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/disputes/{id}/information-requests/{request_id}/responsesDisputesMerchant backend · server to server
Create Responses.
- Domain
- Disputes
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
PATCH
/merchants/disputes/{id}/metadataDisputesMerchant backend · server to server
Update Metadata.
- Domain
- Disputes
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/disputes/{id}/requirementsDisputesMerchant backend · server to server
List or retrieve Requirements.
- Domain
- Disputes
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/disputes/{id}/reviewsDisputesMerchant backend · server to server
Create Reviews.
- Domain
- Disputes
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/disputes/{id}/reviews/{review_id}DisputesMerchant backend · server to server
Retrieve Reviews.
- Domain
- Disputes
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/disputes/{id}/reviews/{review_id}/approveDisputesMerchant backend · server to server
Run Approve for Reviews.
- Domain
- Disputes
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/disputes/{id}/reviews/{review_id}/snapshotDisputesMerchant backend · server to server
List or retrieve Snapshot.
- Domain
- Disputes
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/disputes/{id}/submissionsDisputesMerchant backend · server to server
List or retrieve Submissions.
- Domain
- Disputes
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/disputes/{id}/submissions/{submission_id}DisputesMerchant backend · server to server
Retrieve Submissions.
- Domain
- Disputes
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/disputes/{id}/submitDisputesMerchant backend · server to server
Run Submit for Disputes.
- Domain
- Disputes
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/disputes/{id}/updatesDisputesMerchant backend · server to server
List or retrieve Updates.
- Domain
- Disputes
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/disputes/capabilitiesDisputesMerchant backend · server to server
List or retrieve Capabilities.
- Domain
- Disputes
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/disputes/connectionsDisputesMerchant backend · server to server
List or retrieve Connections.
- Domain
- Disputes
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/disputes/connections/{processor_account_id}DisputesMerchant backend · server to server
Retrieve Connections.
- Domain
- Disputes
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/avs/codesFraud and riskMerchant backend · server to server
List or retrieve Codes.
- Domain
- Fraud and risk
- Owning service
- Fraud and risk
- Intended for
- Merchant backend · server to server
GET
/filters/anti-fraud-providersFraud and riskMerchant backend · server to server
List or retrieve Anti Fraud Providers.
- Domain
- Fraud and risk
- Owning service
- Fraud and risk
- Intended for
- Merchant backend · server to server
GET
/merchant/anti-fraud-processorFraud and riskMerchant backend · server to server
List or retrieve Anti Fraud Processor.
- Domain
- Fraud and risk
- Owning service
- Fraud and risk
- Intended for
- Merchant backend · server to server
DELETE
/merchants/{merchant_id}/fraud-settingsFraud and riskMerchant backend · server to server
Delete Fraud Settings.
- Domain
- Fraud and risk
- Owning service
- Fraud and risk
- Intended for
- Merchant backend · server to server
GET
/merchants/{merchant_id}/fraud-settingsFraud and riskMerchant backend · server to server
List or retrieve Fraud Settings.
- Domain
- Fraud and risk
- Owning service
- Fraud and risk
- Intended for
- Merchant backend · server to server
PUT
/merchants/{merchant_id}/fraud-settingsFraud and riskMerchant backend · server to server
Update Fraud Settings.
- Domain
- Fraud and risk
- Owning service
- Fraud and risk
- Intended for
- Merchant backend · server to server
GET
/filters/acquirers/merchants/{merchant_id}Merchant administrationMerchant backend · server to server
Retrieve Merchants.
- Domain
- Merchant administration
- Owning service
- Reports and reconciliation
- Intended for
- Merchant backend · server to server
GET
/filters/data_source/merchants/{merchant_id}Merchant administrationMerchant backend · server to server
Retrieve Merchants.
- Domain
- Merchant administration
- Owning service
- Reports and reconciliation
- Intended for
- Merchant backend · server to server
POST
/fulfillments/{provider}/{merchant_id}Merchant administrationMerchant backend · server to server
Create Fulfillments.
- Domain
- Merchant administration
- Owning service
- Post-transaction
- Intended for
- Merchant backend · server to server
GET
/merchant/{id}/avs/historyMerchant administrationMerchant backend · server to server
List or retrieve History.
- Domain
- Merchant administration
- Owning service
- Fraud and risk
- Intended for
- Merchant backend · server to server
GET
/merchant/{id}/profileMerchant administrationMerchant backend · server to server
List or retrieve Profile.
- Domain
- Merchant administration
- Owning service
- Fraud and risk
- Intended for
- Merchant backend · server to server
PUT
/merchant/{id}/profileMerchant administrationMerchant backend · server to server
Update Profile.
- Domain
- Merchant administration
- Owning service
- Fraud and risk
- Intended for
- Merchant backend · server to server
POST
/merchant/profileMerchant administrationMerchant backend · server to server
Create Profile.
- Domain
- Merchant administration
- Owning service
- Fraud and risk
- Intended for
- Merchant backend · server to server
GET
/merchant/transaction/{id}Merchant administrationMerchant backend · server to server
Retrieve Transaction.
- Domain
- Merchant administration
- Owning service
- Fraud and risk
- Intended for
- Merchant backend · server to server
GET
/merchantsMerchant administrationMerchant backend · server to server
List or retrieve Merchants.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/merchantsMerchant administrationMerchant backend · server to server
Create Merchants.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/merchants-allMerchant administrationMerchant backend · server to server
List or retrieve Merchants All.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/merchants-tokens/meMerchant administrationMerchant backend · server to server
List or retrieve Me.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/merchants/{merchant_id}Merchant administrationMerchant backend · server to server
Retrieve Merchants.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
PUT
/merchants/{merchant_id}Merchant administrationMerchant backend · server to server
Update Merchants.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/merchants/{merchant_id}/applicationsMerchant administrationMerchant backend · server to server
List or retrieve Applications.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
PATCH
/merchants/{merchant_id}/applicationsMerchant administrationMerchant backend · server to server
Update Applications.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/merchants/{merchant_id}/applicationsMerchant administrationMerchant backend · server to server
Create Applications.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/merchants/{merchant_id}/applications/{application_id}Merchant administrationMerchant backend · server to server
Retrieve Applications.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/merchants/{merchant_id}/applications/{application_id}/storesMerchant administrationMerchant backend · server to server
Create Stores.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/merchants/{merchant_id}/configurationsMerchant administrationMerchant backend · server to server
List or retrieve Configurations.
- Domain
- Merchant administration
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/{merchant_id}/configurationsMerchant administrationMerchant backend · server to server
Create Configurations.
- Domain
- Merchant administration
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
DELETE
/merchants/{merchant_id}/configurations/{configuration_id}Merchant administrationMerchant backend · server to server
Delete Configurations.
- Domain
- Merchant administration
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/{merchant_id}/configurations/{configuration_id}Merchant administrationMerchant backend · server to server
Retrieve Configurations.
- Domain
- Merchant administration
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/{merchant_id}/decryptMerchant administrationMerchant backend · server to server
Create Decrypt.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/merchants/{merchant_id}/external-endpointsMerchant administrationMerchant backend · server to server
Create External Endpoints.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
DELETE
/merchants/{merchant_id}/external-endpoints/{external_endpoint_id}Merchant administrationMerchant backend · server to server
Delete External Endpoints.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
PATCH
/merchants/{merchant_id}/external-endpoints/{external_endpoint_id}Merchant administrationMerchant backend · server to server
Update External Endpoints.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/merchants/{merchant_id}/filesMerchant administrationMerchant backend · server to server
List or retrieve Files.
- Domain
- Merchant administration
- Owning service
- Reports and reconciliation
- Intended for
- Merchant backend · server to server
POST
/merchants/{merchant_id}/onboarding_step/{step}Merchant administrationMerchant backend · server to server
Create Onboarding Step.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/merchants/{merchant_id}/public-keysMerchant administrationMerchant backend · server to server
Create Public Keys.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/merchants/{merchant_id}/recipientsMerchant administrationMerchant backend · server to server
List or retrieve Recipients.
- Domain
- Merchant administration
- Owning service
- Payments
- Intended for
- Merchant backend · server to server
POST
/merchants/{merchant_id}/recipientsMerchant administrationMerchant backend · server to server
Create Recipients.
- Domain
- Merchant administration
- Owning service
- Payments
- Intended for
- Merchant backend · server to server
DELETE
/merchants/{merchant_id}/recipients/{recipient_id}Merchant administrationMerchant backend · server to server
Delete Recipients.
- Domain
- Merchant administration
- Owning service
- Payments
- Intended for
- Merchant backend · server to server
PUT
/merchants/{merchant_id}/recipients/{recipient_id}Merchant administrationMerchant backend · server to server
Update Recipients.
- Domain
- Merchant administration
- Owning service
- Payments
- Intended for
- Merchant backend · server to server
GET
/merchants/{merchant_id}/storesMerchant administrationMerchant backend · server to server
List or retrieve Stores.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/merchants/{merchant_id}/storesMerchant administrationMerchant backend · server to server
Create Stores.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/merchants/{merchant_id}/tokensMerchant administrationMerchant backend · server to server
Create Tokens.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/merchants/applications/validateMerchant administrationMerchant backend · server to server
List or retrieve Validate.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
PATCH
/merchants/applications/validateMerchant administrationMerchant backend · server to server
Update Validate.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/merchants/applications/validateMerchant administrationMerchant backend · server to server
Create Validate.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/merchants/audit-logsMerchant administrationMerchant backend · server to server
List or retrieve Audit Logs.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/merchants/audit-logs/exportsMerchant administrationMerchant backend · server to server
List or retrieve Exports.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/merchants/audit-logs/exportsMerchant administrationMerchant backend · server to server
Create Exports.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/merchants/audit-logs/exports/{export_id}/downloadMerchant administrationMerchant backend · server to server
Run Download for Exports.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/merchants/audit-logs/filtersMerchant administrationMerchant backend · server to server
List or retrieve Filters.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/merchants/billing/invoicesMerchant administrationMerchant backend · server to server
List or retrieve Invoices.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/merchants/billing/invoices/{invoice_id}Merchant administrationMerchant backend · server to server
Retrieve Invoices.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/merchants/countries/{country}/{state}/citiesMerchant administrationMerchant backend · server to server
List or retrieve Cities.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/merchants/countries/{country}/banksMerchant administrationMerchant backend · server to server
List or retrieve Banks.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/merchants/countries/{country}/citiesMerchant administrationMerchant backend · server to server
List or retrieve Cities.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/merchants/countries/{country}/statesMerchant administrationMerchant backend · server to server
List or retrieve States.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/merchants/countries/listMerchant administrationMerchant backend · server to server
List or retrieve List.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/merchants/data/airline-informationMerchant administrationMerchant backend · server to server
List or retrieve Airline Information.
- Domain
- Merchant administration
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/data/airline-informationMerchant administrationMerchant backend · server to server
Create Airline Information.
- Domain
- Merchant administration
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/data/airline-information/{source_version}/rollbackMerchant administrationMerchant backend · server to server
Run Rollback for Airline Information.
- Domain
- Merchant administration
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/domain/{record}/validateMerchant administrationMerchant backend · server to server
Create Validate.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/merchants/domain/validateMerchant administrationMerchant backend · server to server
Create Validate.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/merchants/loginMerchant administrationMerchant backend · server to server
Run Login for Merchants.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/merchants/merchant-eventsMerchant administrationMerchant backend · server to server
List or retrieve Merchant Events.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/merchants/merchant-events/{merchant_id}Merchant administrationMerchant backend · server to server
Retrieve Merchant Events.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/merchants/merchant-events/{merchant_id}Merchant administrationMerchant backend · server to server
Create Merchant Events.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
DELETE
/merchants/msiMerchant administrationMerchant backend · server to server
Delete Msi.
- Domain
- Merchant administration
- Owning service
- Installments
- Intended for
- Merchant backend · server to server
GET
/merchants/msiMerchant administrationMerchant backend · server to server
List or retrieve Msi.
- Domain
- Merchant administration
- Owning service
- Installments
- Intended for
- Merchant backend · server to server
POST
/merchants/msiMerchant administrationMerchant backend · server to server
Create Msi.
- Domain
- Merchant administration
- Owning service
- Installments
- Intended for
- Merchant backend · server to server
GET
/merchants/msi/{merchant_id}Merchant administrationMerchant backend · server to server
Retrieve Msi.
- Domain
- Merchant administration
- Owning service
- Installments
- Intended for
- Merchant backend · server to server
POST
/merchants/request-codeMerchant administrationMerchant backend · server to server
Run Request Code for Merchants.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/merchants/resources/external-endpointsMerchant administrationMerchant backend · server to server
List or retrieve External Endpoints.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/merchants/self-onboardingMerchant administrationMerchant backend · server to server
Create Self Onboarding.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/merchants/validate-codeMerchant administrationMerchant backend · server to server
Create Validate Code.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/tenantsMerchant administrationMerchant backend · server to server
List or retrieve Tenants.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/tenantsMerchant administrationMerchant backend · server to server
Create Tenants.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/tenants/{tenant_id}Merchant administrationMerchant backend · server to server
Retrieve Tenants.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
PUT
/tenants/{tenant_id}Merchant administrationMerchant backend · server to server
Update Tenants.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/v2/merchants-tokens/meMerchant administrationMerchant backend · server to server
List or retrieve Me.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/v2/merchants/{merchant_id}/security/mfaMerchant administrationMerchant backend · server to server
List or retrieve Mfa.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
PUT
/v2/merchants/{merchant_id}/security/mfaMerchant administrationMerchant backend · server to server
Update Mfa.
- Domain
- Merchant administration
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/merchants/{merchant_id}/ordersOrdersMerchant backend · server to server
List or retrieve Orders.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/{merchant_id}/orders/{order_token}OrdersMerchant backend · server to server
Retrieve Orders.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/{merchant_id}/orders/{order_token}/captureOrdersMerchant backend · server to server
Run Capture for Orders.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/{merchant_id}/orders/{order_token}/payment_optionsOrdersMerchant backend · server to server
List or retrieve Payment Options.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/{merchant_id}/orders/{order_token}/refundOrdersMerchant backend · server to server
Create Refund.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/{merchant_id}/orders/{order_token}/status/{status}OrdersMerchant backend · server to server
Create Status.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/{merchant_id}/orders/{order_token}/voidOrdersMerchant backend · server to server
Run Void for Orders.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/{merchant_id}/orders/{order_token}/vouchersOrdersMerchant backend · server to server
List or retrieve Vouchers.
- Domain
- Orders
- Owning service
- Vouchers
- Intended for
- Merchant backend · server to server
POST
/merchants/{merchant_id}/orders/{order_token}/vouchersOrdersMerchant backend · server to server
Create Vouchers.
- Domain
- Orders
- Owning service
- Vouchers
- Intended for
- Merchant backend · server to server
POST
/merchants/external-orders/{order_token}/billing-addressOrdersMerchant backend · server to server
Create Billing Address.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/external-orders/{order_token}/scheduleOrdersMerchant backend · server to server
Create Schedule.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/ordersOrdersMerchant backend · server to server
List or retrieve Orders.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/ordersOrdersMerchant backend · server to server
Create Orders.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/orders/{order_token}OrdersMerchant backend · server to server
Retrieve Orders.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
PATCH
/merchants/orders/{order_token}OrdersMerchant backend · server to server
Update Orders.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/orders/{order_token}/cancelOrdersMerchant backend · server to server
Run Cancel for Orders.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/orders/{order_token}/captureOrdersMerchant backend · server to server
Run Capture for Orders.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/orders/{order_token}/capture-asyncOrdersMerchant backend · server to server
Create Capture Async.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/orders/{order_token}/consentOrdersMerchant backend · server to server
List or retrieve Consent.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/orders/{order_token}/consentOrdersMerchant backend · server to server
Create Consent.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/orders/{order_token}/expireOrdersMerchant backend · server to server
Run Expire for Orders.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/orders/{order_token}/payments-methodsOrdersMerchant backend · server to server
List or retrieve Payments Methods.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/orders/{order_token}/promotionsOrdersMerchant backend · server to server
Create Promotions.
- Domain
- Orders
- Owning service
- Merchant middleware
- Intended for
- Merchant backend · server to server
POST
/merchants/orders/{order_token}/refundOrdersMerchant backend · server to server
Create Refund.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/orders/{order_token}/refund-asyncOrdersMerchant backend · server to server
Create Refund Async.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/orders/{order_token}/successOrdersMerchant backend · server to server
Run Success for Orders.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/orders/{order_token}/transactions/nequi/verifyOrdersMerchant backend · server to server
Run Verify for Nequi.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/orders/{order_token}/transactions/verifyOrdersMerchant backend · server to server
Run Verify for Transactions.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/orders/{order_token}/voidOrdersMerchant backend · server to server
Run Void for Orders.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/orders/{order_token}/void-asyncOrdersMerchant backend · server to server
Run Void Async for Orders.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/orders/filters-optionsOrdersMerchant backend · server to server
List or retrieve Filters Options.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/orders/id/{order_id}OrdersMerchant backend · server to server
Retrieve Id.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/transactions/orders/{order_token}/installmentsOrdersMerchant backend · server to server
List or retrieve Installments.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/orders/statusOrdersMerchant backend · server to server
List or retrieve Status.
- Domain
- Orders
- Owning service
- Payments
- Intended for
- Merchant backend · server to server
POST
/v2/merchants/{merchant_id}/orders/{order_token}/captureOrdersMerchant backend · server to server
Run Capture for Orders.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/v2/merchants/orders/{order_token}/captureOrdersMerchant backend · server to server
Run Capture for Orders.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/v2/merchants/orders/{order_token}/refundOrdersMerchant backend · server to server
Create Refund.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/v2/merchants/orders/purchaseOrdersMerchant backend · server to server
Create Purchase.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/{merchant_id}/payments/links/templatesPayment linksMerchant backend · server to server
List or retrieve Templates.
- Domain
- Payment links
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/{merchant_id}/payments/links/templatesPayment linksMerchant backend · server to server
Create Templates.
- Domain
- Payment links
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/{merchant_id}/payments/links/templates/{template_id}Payment linksMerchant backend · server to server
Retrieve Templates.
- Domain
- Payment links
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
PATCH
/merchants/{merchant_id}/payments/links/templates/{template_id}Payment linksMerchant backend · server to server
Update Templates.
- Domain
- Payment links
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
POST
/merchants/payment-linksPayment linksMerchant backend · server to server
Create Payment Links.
- Domain
- Payment links
- Owning service
- Payment links
- Intended for
- Merchant backend · server to server
GET
/merchants/payment-links/{payment_link_id}Payment linksMerchant backend · server to server
Retrieve Payment Links.
- Domain
- Payment links
- Owning service
- Payment links
- Intended for
- Merchant backend · server to server
PATCH
/merchants/payment-links/{payment_link_id}Payment linksMerchant backend · server to server
Update Payment Links.
- Domain
- Payment links
- Owning service
- Payment links
- Intended for
- Merchant backend · server to server
GET
/merchants/payment-links/{payment_link_id}/ordersPayment linksMerchant backend · server to server
List or retrieve Orders.
- Domain
- Payment links
- Owning service
- Payment links
- Intended for
- Merchant backend · server to server
GET
/merchants/payment-links/allPayment linksMerchant backend · server to server
List or retrieve All.
- Domain
- Payment links
- Owning service
- Payment links
- Intended for
- Merchant backend · server to server
GET
/merchants/payments/links/templates/{template_id}/ordersPayment linksMerchant backend · server to server
List or retrieve Orders.
- Domain
- Payment links
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/payment-links/{payment_link_id}Payment linksMerchant backend · server to server
Retrieve Payment Links.
- Domain
- Payment links
- Owning service
- Payment links
- Intended for
- Merchant backend · server to server
GET
/merchants/{merchant_id}/batch-transactionsPaymentsMerchant backend · server to server
List or retrieve Batch Transactions.
- Domain
- Payments
- Owning service
- Batch transactions
- Intended for
- Merchant backend · server to server
POST
/merchants/{merchant_id}/batch-transactionsPaymentsMerchant backend · server to server
Create Batch Transactions.
- Domain
- Payments
- Owning service
- Batch transactions
- Intended for
- Merchant backend · server to server
GET
/merchants/{merchant_id}/batch-transactions/{batch_id}PaymentsMerchant backend · server to server
Retrieve Batch Transactions.
- Domain
- Payments
- Owning service
- Batch transactions
- Intended for
- Merchant backend · server to server
DELETE
/merchants/{merchant_id}/installmentsPaymentsMerchant backend · server to server
Delete Installments.
- Domain
- Payments
- Owning service
- Installments
- Intended for
- Merchant backend · server to server
GET
/merchants/{merchant_id}/installmentsPaymentsMerchant backend · server to server
List or retrieve Installments.
- Domain
- Payments
- Owning service
- Installments
- Intended for
- Merchant backend · server to server
POST
/merchants/{merchant_id}/installmentsPaymentsMerchant backend · server to server
Create Installments.
- Domain
- Payments
- Owning service
- Installments
- Intended for
- Merchant backend · server to server
GET
/merchants/{merchant_id}/transactionsPaymentsMerchant backend · server to server
List or retrieve Transactions.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Merchant backend · server to server
GET
/merchants/stores/payments-methodsPaymentsMerchant backend · server to server
List or retrieve Payments Methods.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Merchant backend · server to server
GET
/payments-middleware/manifestPaymentsMerchant backend · server to server
List or retrieve Manifest.
- Domain
- Payments
- Owning service
- Merchant middleware
- Intended for
- Merchant backend · server to server
GET
/payments-middleware/payment-methodsPaymentsMerchant backend · server to server
List or retrieve Payment Methods.
- Domain
- Payments
- Owning service
- Merchant middleware
- Intended for
- Merchant backend · server to server
POST
/payments-middleware/paymentsPaymentsMerchant backend · server to server
Create Payments.
- Domain
- Payments
- Owning service
- Merchant middleware
- Intended for
- Merchant backend · server to server
POST
/payments-middleware/payments/{payment_id}/cancellationsPaymentsMerchant backend · server to server
Create Cancellations.
- Domain
- Payments
- Owning service
- Merchant middleware
- Intended for
- Merchant backend · server to server
POST
/payments-middleware/payments/{payment_id}/refundsPaymentsMerchant backend · server to server
Create Refunds.
- Domain
- Payments
- Owning service
- Merchant middleware
- Intended for
- Merchant backend · server to server
POST
/payments-vault/tokenizationPaymentsMerchant backend · server to server
Create Tokenization.
- Domain
- Payments
- Owning service
- Vault
- Intended for
- Merchant backend · server to server
POST
/payments-vault/tokenization/{uuid}/cvvPaymentsMerchant backend · server to server
Create Cvv.
- Domain
- Payments
- Owning service
- Vault
- Intended for
- Merchant backend · server to server
POST
/post-transactions/{provider}PaymentsMerchant backend · server to server
Create Post Transactions.
- Domain
- Payments
- Owning service
- Post-transaction
- Intended for
- Merchant backend · server to server
POST
/telcel-middleware/transactions/inquiryPaymentsMerchant backend · server to server
Create Inquiry.
- Domain
- Payments
- Owning service
- Telcel middleware
- Intended for
- Merchant backend · server to server
GET
/transactions/{transaction_id}/{request_id_hash}/cancelPaymentsMerchant backend · server to server
Run Cancel for Transactions.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Merchant backend · server to server
POST
/transactions/{transaction_id}/capturePaymentsMerchant backend · server to server
Run Capture for Transactions.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Merchant backend · server to server
POST
/transactions/{transaction_id}/refundPaymentsMerchant backend · server to server
Create Refund.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Merchant backend · server to server
PUT
/transactions/{transaction_id}/statusPaymentsMerchant backend · server to server
Update Status.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Merchant backend · server to server
POST
/transactions/{transaction_id}/status/nequiPaymentsMerchant backend · server to server
Create Nequi.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Merchant backend · server to server
GET
/transactions/{transaction_id}/three-ds-flowPaymentsMerchant backend · server to server
List or retrieve Three Ds Flow.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Merchant backend · server to server
GET
/transactions/{transaction_id}/three-ds-flow/completePaymentsMerchant backend · server to server
Run Complete for Three Ds Flow.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Merchant backend · server to server
POST
/transactions/{transaction_id}/three-ds-flow/completePaymentsMerchant backend · server to server
Run Complete for Three Ds Flow.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Merchant backend · server to server
POST
/transactions/{transaction_id}/three-ds-flow/continuePaymentsMerchant backend · server to server
Run Continue for Three Ds Flow.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Merchant backend · server to server
POST
/transactions/{transaction_id}/transfer/{current_store_code}/{new_store_code}PaymentsMerchant backend · server to server
Run Transfer for Transactions.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Merchant backend · server to server
POST
/transactions/{transaction_id}/verifyPaymentsMerchant backend · server to server
Run Verify for Transactions.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Merchant backend · server to server
POST
/transactions/{transaction_id}/voidPaymentsMerchant backend · server to server
Run Void for Transactions.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Merchant backend · server to server
POST
/transactions/{transaction_id}/void-asyncPaymentsMerchant backend · server to server
Run Void Async for Transactions.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Merchant backend · server to server
GET
/transactions/internal-searchPaymentsMerchant backend · server to server
List or retrieve Internal Search.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Merchant backend · server to server
GET
/transactions/payments-methodsPaymentsMerchant backend · server to server
List or retrieve Payments Methods.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Merchant backend · server to server
GET
/transactions/payments-methods/{method_type}/installmentsPaymentsMerchant backend · server to server
List or retrieve Installments.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Merchant backend · server to server
GET
/transactions/searchPaymentsMerchant backend · server to server
Run Search for Transactions.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Merchant backend · server to server
GET
/transactions/update-processing-transactionsPaymentsMerchant backend · server to server
List or retrieve Update Processing Transactions.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Merchant backend · server to server
GET
/transactions/verify3dsPaymentsMerchant backend · server to server
List or retrieve Verify3ds.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Merchant backend · server to server
POST
/transactions/verify3dsPaymentsMerchant backend · server to server
Create Verify3ds.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Merchant backend · server to server
GET
/transactions/view_challengePaymentsMerchant backend · server to server
List or retrieve View Challenge.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Merchant backend · server to server
POST
/manual-reviewPost-transactionMerchant backend · server to server
Create Manual Review.
- Domain
- Post-transaction
- Owning service
- Post-transaction
- Intended for
- Merchant backend · server to server
POST
/post-transaction-manual-process/{action}Post-transactionMerchant backend · server to server
Create Post Transaction Manual Process.
- Domain
- Post-transaction
- Owning service
- Post-transaction
- Intended for
- Merchant backend · server to server
GET
/merchants/{merchant_id}/files/{file_id}/presigned-urlReportsMerchant backend · server to server
List or retrieve Presigned Url.
- Domain
- Reports
- Owning service
- Reports and reconciliation
- Intended for
- Merchant backend · server to server
GET
/merchants/{merchant_id}/subscriptions/{id}/ordersSubscriptionsMerchant backend · server to server
List or retrieve Orders.
- Domain
- Subscriptions
- Owning service
- Orders and checkout
- Intended for
- Merchant backend · server to server
GET
/merchants/installments/plans/{installment_plan_option_id}SubscriptionsMerchant backend · server to server
Retrieve Plans.
- Domain
- Subscriptions
- Owning service
- Installments
- Intended for
- Merchant backend · server to server
GET
/subscriptionsSubscriptionsMerchant backend · server to server
List or retrieve Subscriptions.
- Domain
- Subscriptions
- Owning service
- Subscriptions
- Intended for
- Merchant backend · server to server
POST
/subscriptionsSubscriptionsMerchant backend · server to server
Create Subscriptions.
- Domain
- Subscriptions
- Owning service
- Subscriptions
- Intended for
- Merchant backend · server to server
DELETE
/subscriptions/{id}SubscriptionsMerchant backend · server to server
Delete Subscriptions.
- Domain
- Subscriptions
- Owning service
- Subscriptions
- Intended for
- Merchant backend · server to server
GET
/subscriptions/{id}SubscriptionsMerchant backend · server to server
Retrieve Subscriptions.
- Domain
- Subscriptions
- Owning service
- Subscriptions
- Intended for
- Merchant backend · server to server
PATCH
/subscriptions/{id}SubscriptionsMerchant backend · server to server
Update Subscriptions.
- Domain
- Subscriptions
- Owning service
- Subscriptions
- Intended for
- Merchant backend · server to server
POST
/subscriptions/{id}/cancelSubscriptionsMerchant backend · server to server
Run Cancel for Subscriptions.
- Domain
- Subscriptions
- Owning service
- Subscriptions
- Intended for
- Merchant backend · server to server
PATCH
/subscriptions/{id}/cardsSubscriptionsMerchant backend · server to server
Update Cards.
- Domain
- Subscriptions
- Owning service
- Subscriptions
- Intended for
- Merchant backend · server to server
GET
/subscriptions/{id}/historySubscriptionsMerchant backend · server to server
List or retrieve History.
- Domain
- Subscriptions
- Owning service
- Subscriptions
- Intended for
- Merchant backend · server to server
POST
/subscriptions/{id}/pauseSubscriptionsMerchant backend · server to server
Run Pause for Subscriptions.
- Domain
- Subscriptions
- Owning service
- Subscriptions
- Intended for
- Merchant backend · server to server
POST
/subscriptions/{id}/resumeSubscriptionsMerchant backend · server to server
Run Resume for Subscriptions.
- Domain
- Subscriptions
- Owning service
- Subscriptions
- Intended for
- Merchant backend · server to server
GET
/subscriptions/plansSubscriptionsMerchant backend · server to server
List or retrieve Plans.
- Domain
- Subscriptions
- Owning service
- Subscriptions
- Intended for
- Merchant backend · server to server
POST
/subscriptions/plansSubscriptionsMerchant backend · server to server
Create Plans.
- Domain
- Subscriptions
- Owning service
- Subscriptions
- Intended for
- Merchant backend · server to server
DELETE
/subscriptions/plans/{id}SubscriptionsMerchant backend · server to server
Delete Plans.
- Domain
- Subscriptions
- Owning service
- Subscriptions
- Intended for
- Merchant backend · server to server
GET
/subscriptions/plans/{id}SubscriptionsMerchant backend · server to server
Retrieve Plans.
- Domain
- Subscriptions
- Owning service
- Subscriptions
- Intended for
- Merchant backend · server to server
PATCH
/subscriptions/plans/{id}SubscriptionsMerchant backend · server to server
Update Plans.
- Domain
- Subscriptions
- Owning service
- Subscriptions
- Intended for
- Merchant backend · server to server
GET
/subscriptions/plans/statusesSubscriptionsMerchant backend · server to server
List or retrieve Statuses.
- Domain
- Subscriptions
- Owning service
- Subscriptions
- Intended for
- Merchant backend · server to server
GET
/subscriptions/retriesSubscriptionsMerchant backend · server to server
List or retrieve Retries.
- Domain
- Subscriptions
- Owning service
- Subscription retries
- Intended for
- Merchant backend · server to server
POST
/subscriptions/retriesSubscriptionsMerchant backend · server to server
Create Retries.
- Domain
- Subscriptions
- Owning service
- Subscription retries
- Intended for
- Merchant backend · server to server
DELETE
/subscriptions/retries/{id}SubscriptionsMerchant backend · server to server
Delete Retries.
- Domain
- Subscriptions
- Owning service
- Subscription retries
- Intended for
- Merchant backend · server to server
GET
/subscriptions/retries/{id}SubscriptionsMerchant backend · server to server
Retrieve Retries.
- Domain
- Subscriptions
- Owning service
- Subscription retries
- Intended for
- Merchant backend · server to server
PUT
/subscriptions/retries/{id}SubscriptionsMerchant backend · server to server
Update Retries.
- Domain
- Subscriptions
- Owning service
- Subscription retries
- Intended for
- Merchant backend · server to server
GET
/subscriptions/statusesSubscriptionsMerchant backend · server to server
List or retrieve Statuses.
- Domain
- Subscriptions
- Owning service
- Subscriptions
- Intended for
- Merchant backend · server to server
GET
/trace/logsTrace and audit logsMerchant backend · server to server
List or retrieve Logs.
- Domain
- Trace and audit logs
- Owning service
- Trace and audit logs
- Intended for
- Merchant backend · server to server
GET
/trace/logs/visibility/groupedTrace and audit logsMerchant backend · server to server
List or retrieve Grouped.
- Domain
- Trace and audit logs
- Owning service
- Trace and audit logs
- Intended for
- Merchant backend · server to server
GET
/v2/trace/logsTrace and audit logsMerchant backend · server to server
List or retrieve Logs.
- Domain
- Trace and audit logs
- Owning service
- Trace and audit logs
- Intended for
- Merchant backend · server to server
POST
/hermes/merchants/users/notificationsUsers and identityMerchant backend · server to server
Create Notifications.
- Domain
- Users and identity
- Owning service
- Notifications
- Intended for
- Merchant backend · server to server
GET
/merchant-usersUsers and identityMerchant backend · server to server
List or retrieve Merchant Users.
- Domain
- Users and identity
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/merchants/{merchant_id}/policiesUsers and identityMerchant backend · server to server
List or retrieve Policies.
- Domain
- Users and identity
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/merchants/identity-tokenUsers and identityMerchant backend · server to server
Create Identity Token.
- Domain
- Users and identity
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/merchants/usersUsers and identityMerchant backend · server to server
Create Users.
- Domain
- Users and identity
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/merchants/users/{user_id}Users and identityMerchant backend · server to server
Retrieve Users.
- Domain
- Users and identity
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/merchants/users/{user_id}Users and identityMerchant backend · server to server
Create Users.
- Domain
- Users and identity
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
PUT
/merchants/users/{user_id}Users and identityMerchant backend · server to server
Update Users.
- Domain
- Users and identity
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/merchants/users/{user_id}/authorizeUsers and identityMerchant backend · server to server
Run Authorize for Users.
- Domain
- Users and identity
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/merchants/users/{user_id}/generate-change-password-tokenUsers and identityMerchant backend · server to server
Create Generate Change Password Token.
- Domain
- Users and identity
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/merchants/users/change-passwordUsers and identityMerchant backend · server to server
Create Change Password.
- Domain
- Users and identity
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/merchants/validate-oauthUsers and identityMerchant backend · server to server
Create Validate Oauth.
- Domain
- Users and identity
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/users/authorizeUsers and identityMerchant backend · server to server
Run Authorize for Users.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Merchant backend · server to server
POST
/users/external-authorizeUsers and identityMerchant backend · server to server
Create External Authorize.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Merchant backend · server to server
GET
/v1/users/{user_id}/transactions/{transaction_id}Users and identityMerchant backend · server to server
Retrieve Transactions.
- Domain
- Users and identity
- Owning service
- Payments
- Intended for
- Merchant backend · server to server
POST
/v2/auth/identity/change-passwordUsers and identityMerchant backend · server to server
Create Change Password.
- Domain
- Users and identity
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/v2/auth/identity/userUsers and identityMerchant backend · server to server
List or retrieve User.
- Domain
- Users and identity
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/v2/auth/log-streamUsers and identityMerchant backend · server to server
Create Log Stream.
- Domain
- Users and identity
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/v2/auth/loginUsers and identityMerchant backend · server to server
Run Login for Auth.
- Domain
- Users and identity
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/v2/auth/mfa-syncUsers and identityMerchant backend · server to server
Create Mfa Sync.
- Domain
- Users and identity
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/v2/auth/session/bootstrapUsers and identityMerchant backend · server to server
Run Bootstrap for Session.
- Domain
- Users and identity
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/v2/auth/user-org-syncUsers and identityMerchant backend · server to server
Create User Org Sync.
- Domain
- Users and identity
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/v2/generate-custom-tokenUsers and identityMerchant backend · server to server
List or retrieve Generate Custom Token.
- Domain
- Users and identity
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/v2/merchants/usersUsers and identityMerchant backend · server to server
Create Users.
- Domain
- Users and identity
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
PATCH
/v2/merchants/users/{user_id}Users and identityMerchant backend · server to server
Update Users.
- Domain
- Users and identity
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/v2/merchants/users/{user_id}/banUsers and identityMerchant backend · server to server
Run Ban for Users.
- Domain
- Users and identity
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/v2/merchants/users/{user_id}/inviteUsers and identityMerchant backend · server to server
Run Invite for Users.
- Domain
- Users and identity
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/v2/merchants/users/{user_id}/mfa/resetUsers and identityMerchant backend · server to server
Run Reset for Mfa.
- Domain
- Users and identity
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
DELETE
/v2/merchants/users/{user_id}/security-blockUsers and identityMerchant backend · server to server
Delete Security Block.
- Domain
- Users and identity
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/v2/merchants/users/{user_id}/security-blockUsers and identityMerchant backend · server to server
List or retrieve Security Block.
- Domain
- Users and identity
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/v2/merchants/users/{user_id}/security-blockUsers and identityMerchant backend · server to server
Create Security Block.
- Domain
- Users and identity
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
POST
/v2/merchants/users/mfa/disableUsers and identityMerchant backend · server to server
Run Disable for Mfa.
- Domain
- Users and identity
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
PUT
/v2/merchants/users/passwordUsers and identityMerchant backend · server to server
Update Password.
- Domain
- Users and identity
- Owning service
- Users and identity
- Intended for
- Merchant backend · server to server
GET
/vaults/activeVaultMerchant backend · server to server
List or retrieve Active.
- Domain
- Vault
- Owning service
- Vault
- Intended for
- Merchant backend · server to server
PUT
/vaults/activeVaultMerchant backend · server to server
Update Active.
- Domain
- Vault
- Owning service
- Vault
- Intended for
- Merchant backend · server to server
POST
/hermes/events/create-campaignWebhooks and notificationsMerchant backend · server to server
Create Create Campaign.
- Domain
- Webhooks and notifications
- Owning service
- Notifications
- Intended for
- Merchant backend · server to server
POST
/hermes/template/{merchantID}Webhooks and notificationsMerchant backend · server to server
Create Template.
- Domain
- Webhooks and notifications
- Owning service
- Notifications
- Intended for
- Merchant backend · server to server
DELETE
/hermes/template/{templateID}Webhooks and notificationsMerchant backend · server to server
Delete Template.
- Domain
- Webhooks and notifications
- Owning service
- Notifications
- Intended for
- Merchant backend · server to server
POST
/hermes/template/defaultWebhooks and notificationsMerchant backend · server to server
Create Default.
- Domain
- Webhooks and notifications
- Owning service
- Notifications
- Intended for
- Merchant backend · server to server
PATCH
/notifications/{userId}Webhooks and notificationsMerchant backend · server to server
Update Notifications.
- Domain
- Webhooks and notifications
- Owning service
- Notifications
- Intended for
- Merchant backend · server to server
Customer application · user to serverUse from customer-facing web or mobile flows with the user identity and device context shown.62
GET
/payments-cards/users/{user_id}/cardsCards and vaultCustomer application · user to server
List or retrieve Cards.
- Domain
- Cards and vault
- Owning service
- Payment cards
- Intended for
- Customer application · user to server
POST
/payments-cards/users/{user_id}/cardsCards and vaultCustomer application · user to server
Create Cards.
- Domain
- Cards and vault
- Owning service
- Payment cards
- Intended for
- Customer application · user to server
DELETE
/payments-cards/users/{user_id}/cards/{card_id}Cards and vaultCustomer application · user to server
Delete Cards.
- Domain
- Cards and vault
- Owning service
- Payment cards
- Intended for
- Customer application · user to server
GET
/payments-cards/users/{user_id}/cards/{card_id}Cards and vaultCustomer application · user to server
Retrieve Cards.
- Domain
- Cards and vault
- Owning service
- Payment cards
- Intended for
- Customer application · user to server
GET
/users/{user_id}/cardsCards and vaultCustomer application · user to server
List or retrieve Cards.
- Domain
- Cards and vault
- Owning service
- Payments
- Intended for
- Customer application · user to server
POST
/users/{user_id}/cardsCards and vaultCustomer application · user to server
Create Cards.
- Domain
- Cards and vault
- Owning service
- Payments
- Intended for
- Customer application · user to server
DELETE
/users/{user_id}/cards/{card_id}Cards and vaultCustomer application · user to server
Delete Cards.
- Domain
- Cards and vault
- Owning service
- Payments
- Intended for
- Customer application · user to server
GET
/users/{user_id}/cards/{card_id}Cards and vaultCustomer application · user to server
Retrieve Cards.
- Domain
- Cards and vault
- Owning service
- Payments
- Intended for
- Customer application · user to server
POST
/users/{user_id}/cards/{card_id}/refresh-cvvCards and vaultCustomer application · user to server
Run Refresh Cvv for Cards.
- Domain
- Cards and vault
- Owning service
- Payments
- Intended for
- Customer application · user to server
PATCH
/users/{user_id}/cards/{card_id}/set-as-defaultCards and vaultCustomer application · user to server
Run Set As Default for Cards.
- Domain
- Cards and vault
- Owning service
- Payments
- Intended for
- Customer application · user to server
POST
/users/{user_id}/cards/{card_id}/tokensCards and vaultCustomer application · user to server
Create Tokens.
- Domain
- Cards and vault
- Owning service
- Payments
- Intended for
- Customer application · user to server
POST
/v2/users/{user_id}/cardsCards and vaultCustomer application · user to server
Create Cards.
- Domain
- Cards and vault
- Owning service
- Payments
- Intended for
- Customer application · user to server
GET
/{merchant_id}/checkoutCheckoutCustomer application · user to server
List or retrieve Checkout.
- Domain
- Checkout
- Owning service
- Orders and checkout
- Intended for
- Customer application · user to server
PATCH
/checkout/{merchant_id}/configurationCheckoutCustomer application · user to server
Update Configuration.
- Domain
- Checkout
- Owning service
- Orders and checkout
- Intended for
- Customer application · user to server
POST
/checkout/{merchant_id}/configurationCheckoutCustomer application · user to server
Create Configuration.
- Domain
- Checkout
- Owning service
- Orders and checkout
- Intended for
- Customer application · user to server
GET
/checkout/readyCheckoutCustomer application · user to server
List or retrieve Ready.
- Domain
- Checkout
- Owning service
- Orders and checkout
- Intended for
- Customer application · user to server
GET
/checkout/statusCheckoutCustomer application · user to server
List or retrieve Status.
- Domain
- Checkout
- Owning service
- Users and identity
- Intended for
- Customer application · user to server
POST
/shortener/{hash_id}PaymentsCustomer application · user to server
Create Shortener.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Customer application · user to server
GET
/transactions/{transaction_id}/consent/{consent_id}/redirectPaymentsCustomer application · user to server
List or retrieve Redirect.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Customer application · user to server
GET
/transactions/next-action/{next_action_id}PaymentsCustomer application · user to server
Retrieve Next Action.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Customer application · user to server
GET
/usersUsers and identityCustomer application · user to server
List or retrieve Users.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
DELETE
/users/{user_id}Users and identityCustomer application · user to server
Delete Users.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
PATCH
/users/{user_id}Users and identityCustomer application · user to server
Update Users.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
GET
/users/{user_id}/accepted-policiesUsers and identityCustomer application · user to server
List or retrieve Accepted Policies.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
POST
/users/{user_id}/accepted-policiesUsers and identityCustomer application · user to server
Create Accepted Policies.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
POST
/users/{user_id}/accepted-policies/preferencesUsers and identityCustomer application · user to server
Create Preferences.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
GET
/users/{user_id}/addressesUsers and identityCustomer application · user to server
List or retrieve Addresses.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
POST
/users/{user_id}/addressesUsers and identityCustomer application · user to server
Create Addresses.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
DELETE
/users/{user_id}/addresses/{address_id}Users and identityCustomer application · user to server
Delete Addresses.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
GET
/users/{user_id}/addresses/{address_id}Users and identityCustomer application · user to server
Retrieve Addresses.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
PATCH
/users/{user_id}/addresses/{address_id}Users and identityCustomer application · user to server
Update Addresses.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
POST
/users/{user_id}/change-passwordUsers and identityCustomer application · user to server
Create Change Password.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
GET
/users/{user_id}/transactionsUsers and identityCustomer application · user to server
List or retrieve Transactions.
- Domain
- Users and identity
- Owning service
- Payments
- Intended for
- Customer application · user to server
GET
/users/addresses/{address_id}Users and identityCustomer application · user to server
Retrieve Addresses.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
POST
/users/auth/verifyUsers and identityCustomer application · user to server
Run Verify for Auth.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
POST
/users/bulkUsers and identityCustomer application · user to server
Create Bulk.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
POST
/users/change-passwordUsers and identityCustomer application · user to server
Create Change Password.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
POST
/users/forgot-passwordUsers and identityCustomer application · user to server
Create Forgot Password.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
POST
/users/generateUsers and identityCustomer application · user to server
Run Generate for Users.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
POST
/users/loginUsers and identityCustomer application · user to server
Run Login for Users.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
POST
/users/login/device-fingerprintUsers and identityCustomer application · user to server
Create Device Fingerprint.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
POST
/users/logoutUsers and identityCustomer application · user to server
Run Logout for Users.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
GET
/users/meUsers and identityCustomer application · user to server
List or retrieve Me.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
DELETE
/users/payment-methods/{payment_method_id}/tokens/{payment_method}Users and identityCustomer application · user to server
Delete Tokens.
- Domain
- Users and identity
- Owning service
- Payments
- Intended for
- Customer application · user to server
POST
/users/payment-methods/tokensUsers and identityCustomer application · user to server
Create Tokens.
- Domain
- Users and identity
- Owning service
- Payments
- Intended for
- Customer application · user to server
POST
/users/probeUsers and identityCustomer application · user to server
Run Probe for Users.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
GET
/users/probe/{id}Users and identityCustomer application · user to server
Run Probe for Users.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
POST
/users/registerUsers and identityCustomer application · user to server
Run Register for Users.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
POST
/users/request-codeUsers and identityCustomer application · user to server
Run Request Code for Users.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
GET
/users/sessionsUsers and identityCustomer application · user to server
List or retrieve Sessions.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
GET
/users/sessions/{session_id}/deviceUsers and identityCustomer application · user to server
List or retrieve Device.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
POST
/users/sign-messageUsers and identityCustomer application · user to server
Create Sign Message.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
POST
/users/signupUsers and identityCustomer application · user to server
Run Signup for Users.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
GET
/users/web/forgot-passwordUsers and identityCustomer application · user to server
List or retrieve Forgot Password.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
GET
/users/web/loginUsers and identityCustomer application · user to server
Run Login for Web.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
GET
/users/web/password-loginUsers and identityCustomer application · user to server
List or retrieve Password Login.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
GET
/users/web/passwordlessUsers and identityCustomer application · user to server
List or retrieve Passwordless.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
GET
/users/web/signupUsers and identityCustomer application · user to server
Run Signup for Web.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
GET
/v2/usersUsers and identityCustomer application · user to server
List or retrieve Users.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
GET
/v2/users/{user_id}Users and identityCustomer application · user to server
Retrieve Users.
- Domain
- Users and identity
- Owning service
- Users and identity
- Intended for
- Customer application · user to server
GET
/v2/users/{user_id}/addressesUsers and identityCustomer application · user to server
List or retrieve Addresses.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
POST
/v2/users/loginUsers and identityCustomer application · user to server
Run Login for Users.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Customer application · user to server
Network or partner backendUsed by an authorized network, platform or integration partner backend.15
GET
/networks/{network_id}/processorsConnectionsNetwork or partner backend
List or retrieve Processors.
- Domain
- Connections
- Owning service
- Payments
- Intended for
- Network or partner backend
GET
/networks/ordersOrdersNetwork or partner backend
List or retrieve Orders.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Network or partner backend
GET
/networks/orders/filters-optionsOrdersNetwork or partner backend
List or retrieve Filters Options.
- Domain
- Orders
- Owning service
- Orders and checkout
- Intended for
- Network or partner backend
GET
/networks/fieldsReportsNetwork or partner backend
List or retrieve Fields.
- Domain
- Reports
- Owning service
- Reports
- Intended for
- Network or partner backend
GET
/networks/reports/{id}/downloadReportsNetwork or partner backend
Run Download for Reports.
- Domain
- Reports
- Owning service
- Reports
- Intended for
- Network or partner backend
POST
/networks/reports/adhocReportsNetwork or partner backend
Create Adhoc.
- Domain
- Reports
- Owning service
- Reports
- Intended for
- Network or partner backend
GET
/networks/reports/adhoc/{report_id}ReportsNetwork or partner backend
Retrieve Adhoc.
- Domain
- Reports
- Owning service
- Reports
- Intended for
- Network or partner backend
GET
/networks/reports/adhoc/{report_id}/logsReportsNetwork or partner backend
List or retrieve Logs.
- Domain
- Reports
- Owning service
- Reports
- Intended for
- Network or partner backend
GET
/networks/reports/adhoc/filesReportsNetwork or partner backend
List or retrieve Files.
- Domain
- Reports
- Owning service
- Reports
- Intended for
- Network or partner backend
GET
/networks/reports/schedulesReportsNetwork or partner backend
List or retrieve Schedules.
- Domain
- Reports
- Owning service
- Reports
- Intended for
- Network or partner backend
POST
/networks/reports/schedulesReportsNetwork or partner backend
Create Schedules.
- Domain
- Reports
- Owning service
- Reports
- Intended for
- Network or partner backend
DELETE
/networks/reports/schedules/{id}ReportsNetwork or partner backend
Delete Schedules.
- Domain
- Reports
- Owning service
- Reports
- Intended for
- Network or partner backend
GET
/networks/reports/schedules/{id}ReportsNetwork or partner backend
Retrieve Schedules.
- Domain
- Reports
- Owning service
- Reports
- Intended for
- Network or partner backend
PATCH
/networks/reports/schedules/{id}ReportsNetwork or partner backend
Update Schedules.
- Domain
- Reports
- Owning service
- Reports
- Intended for
- Network or partner backend
PUT
/networks/reports/schedules/{id}ReportsNetwork or partner backend
Update Schedules.
- Domain
- Reports
- Owning service
- Reports
- Intended for
- Network or partner backend
Provider callback · provider to DEUNACallback receiver for payment, fraud or platform providers; merchants do not call these routes.27
POST
/transactions/webhooks/processors/{processor_name}ConnectionsProvider callback · provider to DEUNA
Create Processors.
- Domain
- Connections
- Owning service
- Payments
- Intended for
- Provider callback · provider to DEUNA
POST
/transactions/webhooks/processors/{processor_name}/refundsConnectionsProvider callback · provider to DEUNA
Create Refunds.
- Domain
- Connections
- Owning service
- Payments
- Intended for
- Provider callback · provider to DEUNA
POST
/transactions/webhooks/processors/{processor_name}/uninstallConnectionsProvider callback · provider to DEUNA
Run Uninstall for Processors.
- Domain
- Connections
- Owning service
- Payments
- Intended for
- Provider callback · provider to DEUNA
POST
/merchants/{merchant_id}/chargebacks/kushkiDisputesProvider callback · provider to DEUNA
Create Kushki.
- Domain
- Disputes
- Owning service
- Chargebacks
- Intended for
- Provider callback · provider to DEUNA
POST
/merchants/{merchant_id}/chargebacks/stripeDisputesProvider callback · provider to DEUNA
Create Stripe.
- Domain
- Disputes
- Owning service
- Chargebacks
- Intended for
- Provider callback · provider to DEUNA
POST
/transactions/webhooks/addiPaymentsProvider callback · provider to DEUNA
Create Addi.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Provider callback · provider to DEUNA
POST
/transactions/webhooks/aplazoPaymentsProvider callback · provider to DEUNA
Create Aplazo.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Provider callback · provider to DEUNA
POST
/transactions/webhooks/conektaPaymentsProvider callback · provider to DEUNA
Create Conekta.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Provider callback · provider to DEUNA
POST
/transactions/webhooks/dlocalPaymentsProvider callback · provider to DEUNA
Create Dlocal.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Provider callback · provider to DEUNA
POST
/transactions/webhooks/kueskiPaymentsProvider callback · provider to DEUNA
Create Kueski.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Provider callback · provider to DEUNA
POST
/transactions/webhooks/mercadopagoPaymentsProvider callback · provider to DEUNA
Create Mercadopago.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Provider callback · provider to DEUNA
POST
/transactions/webhooks/openpayPaymentsProvider callback · provider to DEUNA
Create Openpay.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Provider callback · provider to DEUNA
POST
/transactions/webhooks/opm-speiPaymentsProvider callback · provider to DEUNA
Create Opm Spei.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Provider callback · provider to DEUNA
POST
/transactions/webhooks/oxxoPaymentsProvider callback · provider to DEUNA
Create Oxxo.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Provider callback · provider to DEUNA
POST
/transactions/webhooks/paypalplatform/{transaction_id}PaymentsProvider callback · provider to DEUNA
Create Paypalplatform.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Provider callback · provider to DEUNA
POST
/transactions/webhooks/payuPaymentsProvider callback · provider to DEUNA
Create Payu.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Provider callback · provider to DEUNA
POST
/transactions/webhooks/stpPaymentsProvider callback · provider to DEUNA
Create Stp.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Provider callback · provider to DEUNA
POST
/transactions/webhooks/stripe_oxxoPaymentsProvider callback · provider to DEUNA
Create Stripe Oxxo.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Provider callback · provider to DEUNA
POST
/transactions/webhooks/webpayPaymentsProvider callback · provider to DEUNA
Create Webpay.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Provider callback · provider to DEUNA
POST
/transactions/webhooks/wompiPaymentsProvider callback · provider to DEUNA
Create Wompi.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Provider callback · provider to DEUNA
PATCH
/transactions/webhooks/zipPaymentsProvider callback · provider to DEUNA
Update Zip.
- Domain
- Payments
- Owning service
- Payments
- Intended for
- Provider callback · provider to DEUNA
DELETE
/subscriptions/webhook-configurationsSubscriptionsProvider callback · provider to DEUNA
Delete Webhook Configurations.
- Domain
- Subscriptions
- Owning service
- Subscriptions
- Intended for
- Provider callback · provider to DEUNA
GET
/subscriptions/webhook-configurationsSubscriptionsProvider callback · provider to DEUNA
List or retrieve Webhook Configurations.
- Domain
- Subscriptions
- Owning service
- Subscriptions
- Intended for
- Provider callback · provider to DEUNA
PATCH
/subscriptions/webhook-configurationsSubscriptionsProvider callback · provider to DEUNA
Update Webhook Configurations.
- Domain
- Subscriptions
- Owning service
- Subscriptions
- Intended for
- Provider callback · provider to DEUNA
POST
/subscriptions/webhook-configurationsSubscriptionsProvider callback · provider to DEUNA
Create Webhook Configurations.
- Domain
- Subscriptions
- Owning service
- Subscriptions
- Intended for
- Provider callback · provider to DEUNA
GET
/subscriptions/webhook-configurations/event-typesSubscriptionsProvider callback · provider to DEUNA
List or retrieve Event Types.
- Domain
- Subscriptions
- Owning service
- Subscriptions
- Intended for
- Provider callback · provider to DEUNA
POST
/hermes/waf/report-data/bts-deliveryWebhooks and notificationsProvider callback · provider to DEUNA
Create Bts Delivery.
- Domain
- Webhooks and notifications
- Owning service
- Notifications
- Intended for
- Provider callback · provider to DEUNA
Public browser or infrastructureUnauthenticated browser redirects, public metadata, assets or health surfaces.3
GET
/users/.well-known/jwks.jsonUsers and identityPublic browser or infrastructure
List or retrieve Jwks.Json.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Public browser or infrastructure
GET
/users/static/css/{file}Users and identityPublic browser or infrastructure
Retrieve Css.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Public browser or infrastructure
GET
/users/static/js/{file}Users and identityPublic browser or infrastructure
Retrieve Js.
- Domain
- Users and identity
- Owning service
- Merchant management
- Intended for
- Public browser or infrastructure
Core integration endpoints#
The operations below retain stable anchors used by integration guides and provide additional context for the most common merchant workflows.
Orders API#
Create an order
POST /merchants/orders
Creates an order and returns the order_token used by DEUNA widgets and payment operations.
The required object varies by order type: Checkout and Subscriptions orders require the items array, while Airline orders require airline information. The base contract does not mark an individual item property as universally required. See the item field reference and vertical field guide.
cURL example
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.jsonconst response = await fetch("https://api.sandbox.deuna.io/merchants/orders", {
method: "POST",
headers: {
"X-Api-Key": "YOUR_PRIVATE_API_KEY",
"Authorization": "Bearer USER_ACCESS_TOKEN",
"X-Idempotency-Key": "IDEMPOTENCY_KEY",
"X-Prediction-Id": "PREDICTION_ID_VALUE",
"Content-Type": "application/json"
},
body: "@request.json"
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"POST",
"https://api.sandbox.deuna.io/merchants/orders",
headers={
"X-Api-Key": "YOUR_PRIVATE_API_KEY",
"Authorization": "Bearer USER_ACCESS_TOKEN",
"X-Idempotency-Key": "IDEMPOTENCY_KEY",
"X-Prediction-Id": "PREDICTION_ID_VALUE",
"Content-Type": "application/json"
},
data="@request.json",
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/merchants/orders",
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"X-Api-Key: YOUR_PRIVATE_API_KEY",
"Authorization: Bearer USER_ACCESS_TOKEN",
"X-Idempotency-Key: IDEMPOTENCY_KEY",
"X-Prediction-Id: PREDICTION_ID_VALUE",
"Content-Type: application/json"
],
CURLOPT_POSTFIELDS => "@request.json"
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("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")
.method("POST", HttpRequest.BodyPublishers.ofString("@request.json"))
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
request, err := http.NewRequest("POST", "https://api.sandbox.deuna.io/merchants/orders", strings.NewReader("@request.json"))
if err != nil { panic(err) }
request.Header.Set("X-Api-Key", "YOUR_PRIVATE_API_KEY")
request.Header.Set("Authorization", "Bearer USER_ACCESS_TOKEN")
request.Header.Set("X-Idempotency-Key", "IDEMPOTENCY_KEY")
request.Header.Set("X-Prediction-Id", "PREDICTION_ID_VALUE")
request.Header.Set("Content-Type", "application/json")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}Get an order
GET /merchants/orders/{order_token}
Retrieves the current order, payment, and processing state for an order token.
cURL example
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'const response = await fetch("https://api.sandbox.deuna.io/merchants/orders/{order_token}", {
method: "GET",
headers: {
"X-Api-Key": "YOUR_PRIVATE_API_KEY",
"Authorization": "Bearer USER_ACCESS_TOKEN",
"x-merchant-id": "MERCHANT_ID"
}
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"GET",
"https://api.sandbox.deuna.io/merchants/orders/{order_token}",
headers={
"X-Api-Key": "YOUR_PRIVATE_API_KEY",
"Authorization": "Bearer USER_ACCESS_TOKEN",
"x-merchant-id": "MERCHANT_ID"
},
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/merchants/orders/{order_token}",
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"X-Api-Key: YOUR_PRIVATE_API_KEY",
"Authorization: Bearer USER_ACCESS_TOKEN",
"x-merchant-id: MERCHANT_ID"
]
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("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")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
)
func main() {
request, err := http.NewRequest("GET", "https://api.sandbox.deuna.io/merchants/orders/{order_token}", nil)
if err != nil { panic(err) }
request.Header.Set("X-Api-Key", "YOUR_PRIVATE_API_KEY")
request.Header.Set("Authorization", "Bearer USER_ACCESS_TOKEN")
request.Header.Set("x-merchant-id", "MERCHANT_ID")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}Get payment methods for an order
GET /merchants/orders/{order_token}/payments-methods
Returns the payment methods available to a specific order and merchant configuration.
cURL example
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'const response = await fetch("https://api.sandbox.deuna.io/merchants/orders/{order_token}/payments-methods", {
method: "GET",
headers: {
"X-Api-Key": "YOUR_PRIVATE_API_KEY",
"Authorization": "Bearer USER_ACCESS_TOKEN",
"X-Store-Code": "STORE_CODE"
}
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"GET",
"https://api.sandbox.deuna.io/merchants/orders/{order_token}/payments-methods",
headers={
"X-Api-Key": "YOUR_PRIVATE_API_KEY",
"Authorization": "Bearer USER_ACCESS_TOKEN",
"X-Store-Code": "STORE_CODE"
},
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/merchants/orders/{order_token}/payments-methods",
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"X-Api-Key: YOUR_PRIVATE_API_KEY",
"Authorization: Bearer USER_ACCESS_TOKEN",
"X-Store-Code: STORE_CODE"
]
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("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")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
)
func main() {
request, err := http.NewRequest("GET", "https://api.sandbox.deuna.io/merchants/orders/{order_token}/payments-methods", nil)
if err != nil { panic(err) }
request.Header.Set("X-Api-Key", "YOUR_PRIVATE_API_KEY")
request.Header.Set("Authorization", "Bearer USER_ACCESS_TOKEN")
request.Header.Set("X-Store-Code", "STORE_CODE")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}Create wallet consent
POST /merchants/orders/{order_token}/consent
Creates the customer authorization required by supported wallet connections. The response can include a provider redirect_url. See Consent flows.
cURL example
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.jsonconst response = await fetch("https://api.sandbox.deuna.io/merchants/orders/{order_token}/consent", {
method: "POST",
headers: {
"X-Api-Key": "YOUR_PRIVATE_API_KEY",
"Authorization": "Bearer USER_ACCESS_TOKEN",
"X-Store-Code": "STORE_CODE",
"Content-Type": "application/json"
},
body: "@request.json"
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"POST",
"https://api.sandbox.deuna.io/merchants/orders/{order_token}/consent",
headers={
"X-Api-Key": "YOUR_PRIVATE_API_KEY",
"Authorization": "Bearer USER_ACCESS_TOKEN",
"X-Store-Code": "STORE_CODE",
"Content-Type": "application/json"
},
data="@request.json",
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/merchants/orders/{order_token}/consent",
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"X-Api-Key: YOUR_PRIVATE_API_KEY",
"Authorization: Bearer USER_ACCESS_TOKEN",
"X-Store-Code: STORE_CODE",
"Content-Type: application/json"
],
CURLOPT_POSTFIELDS => "@request.json"
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("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")
.method("POST", HttpRequest.BodyPublishers.ofString("@request.json"))
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
request, err := http.NewRequest("POST", "https://api.sandbox.deuna.io/merchants/orders/{order_token}/consent", strings.NewReader("@request.json"))
if err != nil { panic(err) }
request.Header.Set("X-Api-Key", "YOUR_PRIVATE_API_KEY")
request.Header.Set("Authorization", "Bearer USER_ACCESS_TOKEN")
request.Header.Set("X-Store-Code", "STORE_CODE")
request.Header.Set("Content-Type", "application/json")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}Get wallet consent
GET /merchants/orders/{order_token}/consent
Returns the latest consent state. For connections that support provider polling, DEUNA refreshes an eligible pending consent before returning it.
cURL example
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'const response = await fetch("https://api.sandbox.deuna.io/merchants/orders/{order_token}/consent", {
method: "GET",
headers: {
"X-Api-Key": "YOUR_PRIVATE_API_KEY",
"Authorization": "Bearer USER_ACCESS_TOKEN",
"X-Store-Code": "STORE_CODE"
}
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"GET",
"https://api.sandbox.deuna.io/merchants/orders/{order_token}/consent",
headers={
"X-Api-Key": "YOUR_PRIVATE_API_KEY",
"Authorization": "Bearer USER_ACCESS_TOKEN",
"X-Store-Code": "STORE_CODE"
},
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/merchants/orders/{order_token}/consent",
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"X-Api-Key: YOUR_PRIVATE_API_KEY",
"Authorization: Bearer USER_ACCESS_TOKEN",
"X-Store-Code: STORE_CODE"
]
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("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")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
)
func main() {
request, err := http.NewRequest("GET", "https://api.sandbox.deuna.io/merchants/orders/{order_token}/consent", nil)
if err != nil { panic(err) }
request.Header.Set("X-Api-Key", "YOUR_PRIVATE_API_KEY")
request.Header.Set("Authorization", "Bearer USER_ACCESS_TOKEN")
request.Header.Set("X-Store-Code", "STORE_CODE")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}Payments API#
Create a payment
POST /v2/merchants/orders/purchase
Processes a payment for an existing order token or for the order supplied in the request. See the detailed payment request guide.
cURL example
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.jsonconst response = await fetch("https://api.sandbox.deuna.io/v2/merchants/orders/purchase", {
method: "POST",
headers: {
"X-Api-Key": "YOUR_PRIVATE_API_KEY",
"Authorization": "Bearer USER_ACCESS_TOKEN",
"Cookie": "COOKIE_VALUE",
"X-Device-Id": "DEVICE_ID",
"X-Merchant-ID": "MERCHANT_ID",
"X-Prediction-Id": "PREDICTION_ID_VALUE",
"X-Session-Id": "SESSION_ID",
"X-Store-Code": "STORE_CODE",
"Content-Type": "application/json"
},
body: "@request.json"
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"POST",
"https://api.sandbox.deuna.io/v2/merchants/orders/purchase",
headers={
"X-Api-Key": "YOUR_PRIVATE_API_KEY",
"Authorization": "Bearer USER_ACCESS_TOKEN",
"Cookie": "COOKIE_VALUE",
"X-Device-Id": "DEVICE_ID",
"X-Merchant-ID": "MERCHANT_ID",
"X-Prediction-Id": "PREDICTION_ID_VALUE",
"X-Session-Id": "SESSION_ID",
"X-Store-Code": "STORE_CODE",
"Content-Type": "application/json"
},
data="@request.json",
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/v2/merchants/orders/purchase",
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"X-Api-Key: YOUR_PRIVATE_API_KEY",
"Authorization: Bearer USER_ACCESS_TOKEN",
"Cookie: COOKIE_VALUE",
"X-Device-Id: DEVICE_ID",
"X-Merchant-ID: MERCHANT_ID",
"X-Prediction-Id: PREDICTION_ID_VALUE",
"X-Session-Id: SESSION_ID",
"X-Store-Code: STORE_CODE",
"Content-Type: application/json"
],
CURLOPT_POSTFIELDS => "@request.json"
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("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")
.method("POST", HttpRequest.BodyPublishers.ofString("@request.json"))
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
request, err := http.NewRequest("POST", "https://api.sandbox.deuna.io/v2/merchants/orders/purchase", strings.NewReader("@request.json"))
if err != nil { panic(err) }
request.Header.Set("X-Api-Key", "YOUR_PRIVATE_API_KEY")
request.Header.Set("Authorization", "Bearer USER_ACCESS_TOKEN")
request.Header.Set("Cookie", "COOKIE_VALUE")
request.Header.Set("X-Device-Id", "DEVICE_ID")
request.Header.Set("X-Merchant-ID", "MERCHANT_ID")
request.Header.Set("X-Prediction-Id", "PREDICTION_ID_VALUE")
request.Header.Set("X-Session-Id", "SESSION_ID")
request.Header.Set("X-Store-Code", "STORE_CODE")
request.Header.Set("Content-Type", "application/json")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}Capture a payment
POST /v2/merchants/orders/{order_token}/capture
Captures all or part of an authorized payment. Call it from the merchant backend only when the connection supports separate authorization and capture.
cURL example
curl --request POST \
--url 'https://api.sandbox.deuna.io/v2/merchants/orders/{order_token}/capture' \
--header 'Content-Type: application/json' \
--data @request.jsonconst response = await fetch("https://api.sandbox.deuna.io/v2/merchants/orders/{order_token}/capture", {
method: "POST",
headers: {
"Content-Type": "application/json"
},
body: "@request.json"
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"POST",
"https://api.sandbox.deuna.io/v2/merchants/orders/{order_token}/capture",
headers={
"Content-Type": "application/json"
},
data="@request.json",
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/v2/merchants/orders/{order_token}/capture",
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
CURLOPT_POSTFIELDS => "@request.json"
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.sandbox.deuna.io/v2/merchants/orders/{order_token}/capture"))
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("@request.json"))
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
request, err := http.NewRequest("POST", "https://api.sandbox.deuna.io/v2/merchants/orders/{order_token}/capture", strings.NewReader("@request.json"))
if err != nil { panic(err) }
request.Header.Set("Content-Type", "application/json")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}Void an authorization
POST /merchants/orders/{order_token}/void
Releases an eligible authorization before capture. A successful synchronous request returns HTTP 204 No Content; asynchronous processor flows must still be tracked to their final payment status.
cURL example
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.jsonconst response = await fetch("https://api.sandbox.deuna.io/merchants/orders/{order_token}/void", {
method: "POST",
headers: {
"X-Api-Key": "YOUR_PRIVATE_API_KEY",
"Content-Type": "application/json"
},
body: "@request.json"
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"POST",
"https://api.sandbox.deuna.io/merchants/orders/{order_token}/void",
headers={
"X-Api-Key": "YOUR_PRIVATE_API_KEY",
"Content-Type": "application/json"
},
data="@request.json",
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/merchants/orders/{order_token}/void",
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"X-Api-Key: YOUR_PRIVATE_API_KEY",
"Content-Type: application/json"
],
CURLOPT_POSTFIELDS => "@request.json"
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.sandbox.deuna.io/merchants/orders/{order_token}/void"))
.header("X-Api-Key", "YOUR_PRIVATE_API_KEY")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("@request.json"))
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
request, err := http.NewRequest("POST", "https://api.sandbox.deuna.io/merchants/orders/{order_token}/void", strings.NewReader("@request.json"))
if err != nil { panic(err) }
request.Header.Set("X-Api-Key", "YOUR_PRIVATE_API_KEY")
request.Header.Set("Content-Type", "application/json")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}Refund a payment
POST /v2/merchants/orders/{order_token}/refund
Creates a full or partial refund for a processed payment.
cURL example
curl --request POST \
--url 'https://api.sandbox.deuna.io/v2/merchants/orders/{order_token}/refund' \
--header 'Content-Type: application/json' \
--data @request.jsonconst response = await fetch("https://api.sandbox.deuna.io/v2/merchants/orders/{order_token}/refund", {
method: "POST",
headers: {
"Content-Type": "application/json"
},
body: "@request.json"
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"POST",
"https://api.sandbox.deuna.io/v2/merchants/orders/{order_token}/refund",
headers={
"Content-Type": "application/json"
},
data="@request.json",
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/v2/merchants/orders/{order_token}/refund",
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
CURLOPT_POSTFIELDS => "@request.json"
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.sandbox.deuna.io/v2/merchants/orders/{order_token}/refund"))
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("@request.json"))
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
request, err := http.NewRequest("POST", "https://api.sandbox.deuna.io/v2/merchants/orders/{order_token}/refund", strings.NewReader("@request.json"))
if err != nil { panic(err) }
request.Header.Set("Content-Type", "application/json")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}User Network API#
These operations support customer identity, addresses, and securely stored payment instruments. Browser and mobile applications use customer authorization. Trusted merchant backends use the authorization shown for each route in the inventory above.
Authentication
Register a user
POST /users/register
Creates a user that can authenticate and securely reuse stored payment methods.
cURL example
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.jsonconst response = await fetch("https://api.sandbox.deuna.io/users/register", {
method: "POST",
headers: {
"X-Api-Key": "YOUR_PRIVATE_API_KEY",
"X-Merchant-Id": "MERCHANT_ID",
"Content-Type": "application/json"
},
body: "@request.json"
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"POST",
"https://api.sandbox.deuna.io/users/register",
headers={
"X-Api-Key": "YOUR_PRIVATE_API_KEY",
"X-Merchant-Id": "MERCHANT_ID",
"Content-Type": "application/json"
},
data="@request.json",
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/users/register",
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"X-Api-Key: YOUR_PRIVATE_API_KEY",
"X-Merchant-Id: MERCHANT_ID",
"Content-Type: application/json"
],
CURLOPT_POSTFIELDS => "@request.json"
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("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")
.method("POST", HttpRequest.BodyPublishers.ofString("@request.json"))
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
request, err := http.NewRequest("POST", "https://api.sandbox.deuna.io/users/register", strings.NewReader("@request.json"))
if err != nil { panic(err) }
request.Header.Set("X-Api-Key", "YOUR_PRIVATE_API_KEY")
request.Header.Set("X-Merchant-Id", "MERCHANT_ID")
request.Header.Set("Content-Type", "application/json")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}Request an OTP
POST /users/request-code
Sends the one-time code used by the passwordless authentication flow.
cURL example
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.jsonconst response = await fetch("https://api.sandbox.deuna.io/users/request-code", {
method: "POST",
headers: {
"Authorization": "Bearer USER_ACCESS_TOKEN",
"X-Api-Key": "YOUR_PRIVATE_API_KEY",
"X-Device-Id": "DEVICE_ID",
"X-Merchant-Id": "MERCHANT_ID",
"Content-Type": "application/json"
},
body: "@request.json"
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"POST",
"https://api.sandbox.deuna.io/users/request-code",
headers={
"Authorization": "Bearer USER_ACCESS_TOKEN",
"X-Api-Key": "YOUR_PRIVATE_API_KEY",
"X-Device-Id": "DEVICE_ID",
"X-Merchant-Id": "MERCHANT_ID",
"Content-Type": "application/json"
},
data="@request.json",
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/users/request-code",
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer USER_ACCESS_TOKEN",
"X-Api-Key: YOUR_PRIVATE_API_KEY",
"X-Device-Id: DEVICE_ID",
"X-Merchant-Id: MERCHANT_ID",
"Content-Type: application/json"
],
CURLOPT_POSTFIELDS => "@request.json"
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("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")
.method("POST", HttpRequest.BodyPublishers.ofString("@request.json"))
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
request, err := http.NewRequest("POST", "https://api.sandbox.deuna.io/users/request-code", strings.NewReader("@request.json"))
if err != nil { panic(err) }
request.Header.Set("Authorization", "Bearer USER_ACCESS_TOKEN")
request.Header.Set("X-Api-Key", "YOUR_PRIVATE_API_KEY")
request.Header.Set("X-Device-Id", "DEVICE_ID")
request.Header.Set("X-Merchant-Id", "MERCHANT_ID")
request.Header.Set("Content-Type", "application/json")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}Log in with an OTP
POST /users/login
Exchanges a valid one-time code for a user authorization token.
cURL example
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.jsonconst response = await fetch("https://api.sandbox.deuna.io/users/login", {
method: "POST",
headers: {
"Authorization": "Bearer USER_ACCESS_TOKEN",
"X-Api-Key": "YOUR_PRIVATE_API_KEY",
"X-Device-Id": "DEVICE_ID",
"X-Merchant-Id": "MERCHANT_ID",
"X-Qa-Api-Key": "QA_API_KEY_VALUE",
"X-Recaptcha-Token": "RECAPTCHA_TOKEN_VALUE",
"X-Session-ID": "SESSION_ID",
"Content-Type": "application/json"
},
body: "@request.json"
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"POST",
"https://api.sandbox.deuna.io/users/login",
headers={
"Authorization": "Bearer USER_ACCESS_TOKEN",
"X-Api-Key": "YOUR_PRIVATE_API_KEY",
"X-Device-Id": "DEVICE_ID",
"X-Merchant-Id": "MERCHANT_ID",
"X-Qa-Api-Key": "QA_API_KEY_VALUE",
"X-Recaptcha-Token": "RECAPTCHA_TOKEN_VALUE",
"X-Session-ID": "SESSION_ID",
"Content-Type": "application/json"
},
data="@request.json",
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/users/login",
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer USER_ACCESS_TOKEN",
"X-Api-Key: YOUR_PRIVATE_API_KEY",
"X-Device-Id: DEVICE_ID",
"X-Merchant-Id: MERCHANT_ID",
"X-Qa-Api-Key: QA_API_KEY_VALUE",
"X-Recaptcha-Token: RECAPTCHA_TOKEN_VALUE",
"X-Session-ID: SESSION_ID",
"Content-Type: application/json"
],
CURLOPT_POSTFIELDS => "@request.json"
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("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")
.method("POST", HttpRequest.BodyPublishers.ofString("@request.json"))
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
request, err := http.NewRequest("POST", "https://api.sandbox.deuna.io/users/login", strings.NewReader("@request.json"))
if err != nil { panic(err) }
request.Header.Set("Authorization", "Bearer USER_ACCESS_TOKEN")
request.Header.Set("X-Api-Key", "YOUR_PRIVATE_API_KEY")
request.Header.Set("X-Device-Id", "DEVICE_ID")
request.Header.Set("X-Merchant-Id", "MERCHANT_ID")
request.Header.Set("X-Qa-Api-Key", "QA_API_KEY_VALUE")
request.Header.Set("X-Recaptcha-Token", "RECAPTCHA_TOKEN_VALUE")
request.Header.Set("X-Session-ID", "SESSION_ID")
request.Header.Set("Content-Type", "application/json")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}External authorization
POST /users/external-authorize
Authenticates a user through a merchant-managed identity flow.
cURL example
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.jsonconst response = await fetch("https://api.sandbox.deuna.io/users/external-authorize", {
method: "POST",
headers: {
"X-Api-Key": "YOUR_PRIVATE_API_KEY",
"Authorization": "Bearer USER_ACCESS_TOKEN",
"X-Auth-Message": "AUTH_MESSAGE_VALUE",
"X-Device-Id": "DEVICE_ID",
"X-Merchant-Id": "MERCHANT_ID",
"Content-Type": "application/json"
},
body: "@request.json"
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"POST",
"https://api.sandbox.deuna.io/users/external-authorize",
headers={
"X-Api-Key": "YOUR_PRIVATE_API_KEY",
"Authorization": "Bearer USER_ACCESS_TOKEN",
"X-Auth-Message": "AUTH_MESSAGE_VALUE",
"X-Device-Id": "DEVICE_ID",
"X-Merchant-Id": "MERCHANT_ID",
"Content-Type": "application/json"
},
data="@request.json",
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/users/external-authorize",
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"X-Api-Key: YOUR_PRIVATE_API_KEY",
"Authorization: Bearer USER_ACCESS_TOKEN",
"X-Auth-Message: AUTH_MESSAGE_VALUE",
"X-Device-Id: DEVICE_ID",
"X-Merchant-Id: MERCHANT_ID",
"Content-Type: application/json"
],
CURLOPT_POSTFIELDS => "@request.json"
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("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")
.method("POST", HttpRequest.BodyPublishers.ofString("@request.json"))
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
request, err := http.NewRequest("POST", "https://api.sandbox.deuna.io/users/external-authorize", strings.NewReader("@request.json"))
if err != nil { panic(err) }
request.Header.Set("X-Api-Key", "YOUR_PRIVATE_API_KEY")
request.Header.Set("Authorization", "Bearer USER_ACCESS_TOKEN")
request.Header.Set("X-Auth-Message", "AUTH_MESSAGE_VALUE")
request.Header.Set("X-Device-Id", "DEVICE_ID")
request.Header.Set("X-Merchant-Id", "MERCHANT_ID")
request.Header.Set("Content-Type", "application/json")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}Users
GET /users/me
Returns the authenticated user profile.
cURL example
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'const response = await fetch("https://api.sandbox.deuna.io/users/me", {
method: "GET",
headers: {
"Authorization": "Bearer USER_ACCESS_TOKEN",
"X-Device-Id": "DEVICE_ID",
"X-Merchant-Id": "MERCHANT_ID"
}
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"GET",
"https://api.sandbox.deuna.io/users/me",
headers={
"Authorization": "Bearer USER_ACCESS_TOKEN",
"X-Device-Id": "DEVICE_ID",
"X-Merchant-Id": "MERCHANT_ID"
},
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/users/me",
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer USER_ACCESS_TOKEN",
"X-Device-Id: DEVICE_ID",
"X-Merchant-Id: MERCHANT_ID"
]
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("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")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
)
func main() {
request, err := http.NewRequest("GET", "https://api.sandbox.deuna.io/users/me", nil)
if err != nil { panic(err) }
request.Header.Set("Authorization", "Bearer USER_ACCESS_TOKEN")
request.Header.Set("X-Device-Id", "DEVICE_ID")
request.Header.Set("X-Merchant-Id", "MERCHANT_ID")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}GET /v2/users/{user_id}
Retrieves a user by ID for an authorized customer context.
cURL example
curl --request GET \
--url 'https://api.sandbox.deuna.io/v2/users/{user_id}' \
--header 'Authorization: Bearer USER_ACCESS_TOKEN'const response = await fetch("https://api.sandbox.deuna.io/v2/users/{user_id}", {
method: "GET",
headers: {
"Authorization": "Bearer USER_ACCESS_TOKEN"
}
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"GET",
"https://api.sandbox.deuna.io/v2/users/{user_id}",
headers={
"Authorization": "Bearer USER_ACCESS_TOKEN"
},
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/v2/users/{user_id}",
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer USER_ACCESS_TOKEN"
]
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.sandbox.deuna.io/v2/users/{user_id}"))
.header("Authorization", "Bearer USER_ACCESS_TOKEN")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
)
func main() {
request, err := http.NewRequest("GET", "https://api.sandbox.deuna.io/v2/users/{user_id}", nil)
if err != nil { panic(err) }
request.Header.Set("Authorization", "Bearer USER_ACCESS_TOKEN")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}Addresses
GET /users/{user_id}/addresses
Lists the addresses associated with a user.
cURL example
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'const response = await fetch("https://api.sandbox.deuna.io/users/{user_id}/addresses", {
method: "GET",
headers: {
"Authorization": "Bearer USER_ACCESS_TOKEN",
"X-Device-Id": "DEVICE_ID",
"X-Merchant-Id": "MERCHANT_ID"
}
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"GET",
"https://api.sandbox.deuna.io/users/{user_id}/addresses",
headers={
"Authorization": "Bearer USER_ACCESS_TOKEN",
"X-Device-Id": "DEVICE_ID",
"X-Merchant-Id": "MERCHANT_ID"
},
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/users/{user_id}/addresses",
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer USER_ACCESS_TOKEN",
"X-Device-Id: DEVICE_ID",
"X-Merchant-Id: MERCHANT_ID"
]
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("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")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
)
func main() {
request, err := http.NewRequest("GET", "https://api.sandbox.deuna.io/users/{user_id}/addresses", nil)
if err != nil { panic(err) }
request.Header.Set("Authorization", "Bearer USER_ACCESS_TOKEN")
request.Header.Set("X-Device-Id", "DEVICE_ID")
request.Header.Set("X-Merchant-Id", "MERCHANT_ID")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}POST /users/{user_id}/addresses
Creates an address for a user.
cURL example
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.jsonconst response = await fetch("https://api.sandbox.deuna.io/users/{user_id}/addresses", {
method: "POST",
headers: {
"Authorization": "Bearer USER_ACCESS_TOKEN",
"X-Device-Id": "DEVICE_ID",
"X-Merchant-Id": "MERCHANT_ID",
"Content-Type": "application/json"
},
body: "@request.json"
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"POST",
"https://api.sandbox.deuna.io/users/{user_id}/addresses",
headers={
"Authorization": "Bearer USER_ACCESS_TOKEN",
"X-Device-Id": "DEVICE_ID",
"X-Merchant-Id": "MERCHANT_ID",
"Content-Type": "application/json"
},
data="@request.json",
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/users/{user_id}/addresses",
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer USER_ACCESS_TOKEN",
"X-Device-Id: DEVICE_ID",
"X-Merchant-Id: MERCHANT_ID",
"Content-Type: application/json"
],
CURLOPT_POSTFIELDS => "@request.json"
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("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")
.method("POST", HttpRequest.BodyPublishers.ofString("@request.json"))
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
request, err := http.NewRequest("POST", "https://api.sandbox.deuna.io/users/{user_id}/addresses", strings.NewReader("@request.json"))
if err != nil { panic(err) }
request.Header.Set("Authorization", "Bearer USER_ACCESS_TOKEN")
request.Header.Set("X-Device-Id", "DEVICE_ID")
request.Header.Set("X-Merchant-Id", "MERCHANT_ID")
request.Header.Set("Content-Type", "application/json")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}PATCH /users/{user_id}/addresses/{address_id}
Updates an existing address. The inventory shows the Bearer authorization and merchant context required by these routes.
cURL example
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.jsonconst response = await fetch("https://api.sandbox.deuna.io/users/{user_id}/addresses/{address_id}", {
method: "PATCH",
headers: {
"Authorization": "Bearer USER_ACCESS_TOKEN",
"X-Device-Id": "DEVICE_ID",
"X-Merchant-Id": "MERCHANT_ID",
"Content-Type": "application/json"
},
body: "@request.json"
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"PATCH",
"https://api.sandbox.deuna.io/users/{user_id}/addresses/{address_id}",
headers={
"Authorization": "Bearer USER_ACCESS_TOKEN",
"X-Device-Id": "DEVICE_ID",
"X-Merchant-Id": "MERCHANT_ID",
"Content-Type": "application/json"
},
data="@request.json",
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/users/{user_id}/addresses/{address_id}",
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer USER_ACCESS_TOKEN",
"X-Device-Id: DEVICE_ID",
"X-Merchant-Id: MERCHANT_ID",
"Content-Type: application/json"
],
CURLOPT_POSTFIELDS => "@request.json"
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("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")
.method("PATCH", HttpRequest.BodyPublishers.ofString("@request.json"))
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
request, err := http.NewRequest("PATCH", "https://api.sandbox.deuna.io/users/{user_id}/addresses/{address_id}", strings.NewReader("@request.json"))
if err != nil { panic(err) }
request.Header.Set("Authorization", "Bearer USER_ACCESS_TOKEN")
request.Header.Set("X-Device-Id", "DEVICE_ID")
request.Header.Set("X-Merchant-Id", "MERCHANT_ID")
request.Header.Set("Content-Type", "application/json")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}Cards
Store a card
POST /v2/users/{user_id}/cards
Stores a tokenized card for later use. Raw card data must not pass through merchant servers unless the merchant has the required PCI scope.
cURL example
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.jsonconst response = await fetch("https://api.sandbox.deuna.io/v2/users/{user_id}/cards", {
method: "POST",
headers: {
"Authorization": "Bearer USER_ACCESS_TOKEN",
"X-Merchant-ID": "MERCHANT_ID",
"Content-Type": "application/json"
},
body: "@request.json"
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"POST",
"https://api.sandbox.deuna.io/v2/users/{user_id}/cards",
headers={
"Authorization": "Bearer USER_ACCESS_TOKEN",
"X-Merchant-ID": "MERCHANT_ID",
"Content-Type": "application/json"
},
data="@request.json",
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/v2/users/{user_id}/cards",
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer USER_ACCESS_TOKEN",
"X-Merchant-ID: MERCHANT_ID",
"Content-Type: application/json"
],
CURLOPT_POSTFIELDS => "@request.json"
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("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")
.method("POST", HttpRequest.BodyPublishers.ofString("@request.json"))
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
request, err := http.NewRequest("POST", "https://api.sandbox.deuna.io/v2/users/{user_id}/cards", strings.NewReader("@request.json"))
if err != nil { panic(err) }
request.Header.Set("Authorization", "Bearer USER_ACCESS_TOKEN")
request.Header.Set("X-Merchant-ID", "MERCHANT_ID")
request.Header.Set("Content-Type", "application/json")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}List stored cards
GET /payments-cards/users/{user_id}/cards
Returns the cards stored for the authenticated user. Verification metadata is conditional. Unverified cards omit all verification fields.
cURL example
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'const response = await fetch("https://api.sandbox.deuna.io/payments-cards/users/{user_id}/cards", {
method: "GET",
headers: {
"Authorization": "Bearer USER_ACCESS_TOKEN",
"X-Api-Key": "YOUR_PRIVATE_API_KEY"
}
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"GET",
"https://api.sandbox.deuna.io/payments-cards/users/{user_id}/cards",
headers={
"Authorization": "Bearer USER_ACCESS_TOKEN",
"X-Api-Key": "YOUR_PRIVATE_API_KEY"
},
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/payments-cards/users/{user_id}/cards",
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer USER_ACCESS_TOKEN",
"X-Api-Key: YOUR_PRIVATE_API_KEY"
]
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("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")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
)
func main() {
request, err := http.NewRequest("GET", "https://api.sandbox.deuna.io/payments-cards/users/{user_id}/cards", nil)
if err != nil { panic(err) }
request.Header.Set("Authorization", "Bearer USER_ACCESS_TOKEN")
request.Header.Set("X-Api-Key", "YOUR_PRIVATE_API_KEY")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}Retrieve a stored card
GET /payments-cards/users/{user_id}/cards/{card_id}
Returns one stored card. When DEUNA has successfully verified the card, the response includes the verification fields shown below.
cURL example
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'const response = await fetch("https://api.sandbox.deuna.io/payments-cards/users/{user_id}/cards/{card_id}", {
method: "GET",
headers: {
"Authorization": "Bearer USER_ACCESS_TOKEN",
"X-Api-Key": "YOUR_PRIVATE_API_KEY"
}
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"GET",
"https://api.sandbox.deuna.io/payments-cards/users/{user_id}/cards/{card_id}",
headers={
"Authorization": "Bearer USER_ACCESS_TOKEN",
"X-Api-Key": "YOUR_PRIVATE_API_KEY"
},
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/payments-cards/users/{user_id}/cards/{card_id}",
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer USER_ACCESS_TOKEN",
"X-Api-Key: YOUR_PRIVATE_API_KEY"
]
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("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")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
)
func main() {
request, err := http.NewRequest("GET", "https://api.sandbox.deuna.io/payments-cards/users/{user_id}/cards/{card_id}", nil)
if err != nil { panic(err) }
request.Header.Set("Authorization", "Bearer USER_ACCESS_TOKEN")
request.Header.Set("X-Api-Key", "YOUR_PRIVATE_API_KEY")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}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"
}
}| Field | When it is returned | Meaning |
|---|---|---|
is_valid | Only after successful verification | Always true when present. An absent field means the card has not been successfully verified; it does not mean that a verification attempt failed. |
verified_by | Only after successful verification | card_verifier identifies a zero-amount authorization. payment identifies verification through a payment transaction. A processor-specific verifier can be returned when a processor validates the card during tokenization. |
verified_at | Only after successful verification | ISO 8601 timestamp recorded when DEUNA marked the card as verified. |
A payment verifies a card only after its transaction reaches processing, processed, authorized, or captured. Failed and pending transactions do not verify the card. See Card tokenization for how verification relates to stored-card reuse.
Remove a stored wallet account
DELETE /users/payment-methods/{payment_method_id}/tokens/{payment_method}
Removes the authenticated user's stored wallet account and its reusable consent. See Consent flows.
cURL example
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'const response = await fetch("https://api.sandbox.deuna.io/users/payment-methods/{payment_method_id}/tokens/{payment_method}", {
method: "DELETE",
headers: {
"Authorization": "Bearer USER_ACCESS_TOKEN",
"X-Merchant-ID": "MERCHANT_ID"
}
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"DELETE",
"https://api.sandbox.deuna.io/users/payment-methods/{payment_method_id}/tokens/{payment_method}",
headers={
"Authorization": "Bearer USER_ACCESS_TOKEN",
"X-Merchant-ID": "MERCHANT_ID"
},
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/users/payment-methods/{payment_method_id}/tokens/{payment_method}",
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer USER_ACCESS_TOKEN",
"X-Merchant-ID: MERCHANT_ID"
]
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("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")
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
)
func main() {
request, err := http.NewRequest("DELETE", "https://api.sandbox.deuna.io/users/payment-methods/{payment_method_id}/tokens/{payment_method}", nil)
if err != nil { panic(err) }
request.Header.Set("Authorization", "Bearer USER_ACCESS_TOKEN")
request.Header.Set("X-Merchant-ID", "MERCHANT_ID")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}Get card BIN information
GET /cards/bin/{bin}
Returns card network, issuer, and type metadata for a six-digit BIN.
cURL example
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'const response = await fetch("https://api.sandbox.deuna.io/cards/bin/{bin}", {
method: "GET",
headers: {
"X-Api-Key": "YOUR_PRIVATE_API_KEY",
"X-Merchant-Id": "MERCHANT_ID"
}
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"GET",
"https://api.sandbox.deuna.io/cards/bin/{bin}",
headers={
"X-Api-Key": "YOUR_PRIVATE_API_KEY",
"X-Merchant-Id": "MERCHANT_ID"
},
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/cards/bin/{bin}",
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"X-Api-Key: YOUR_PRIVATE_API_KEY",
"X-Merchant-Id: MERCHANT_ID"
]
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.sandbox.deuna.io/cards/bin/{bin}"))
.header("X-Api-Key", "YOUR_PRIVATE_API_KEY")
.header("X-Merchant-Id", "MERCHANT_ID")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
)
func main() {
request, err := http.NewRequest("GET", "https://api.sandbox.deuna.io/cards/bin/{bin}", nil)
if err != nil { panic(err) }
request.Header.Set("X-Api-Key", "YOUR_PRIVATE_API_KEY")
request.Header.Set("X-Merchant-Id", "MERCHANT_ID")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}Merchant API#
Payment methods
GET /merchants/stores/payments-methods
Returns the payment methods enabled for a store. Pass the store code in the required X-Store-Code header.
cURL example
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'const response = await fetch("https://api.sandbox.deuna.io/merchants/stores/payments-methods", {
method: "GET",
headers: {
"X-Api-Key": "YOUR_PRIVATE_API_KEY",
"X-Idempotency-Key": "IDEMPOTENCY_KEY",
"X-Merchant-Id": "MERCHANT_ID",
"X-Prediction-Id": "PREDICTION_ID_VALUE",
"X-Store-Code": "STORE_CODE"
}
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"GET",
"https://api.sandbox.deuna.io/merchants/stores/payments-methods",
headers={
"X-Api-Key": "YOUR_PRIVATE_API_KEY",
"X-Idempotency-Key": "IDEMPOTENCY_KEY",
"X-Merchant-Id": "MERCHANT_ID",
"X-Prediction-Id": "PREDICTION_ID_VALUE",
"X-Store-Code": "STORE_CODE"
},
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/merchants/stores/payments-methods",
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"X-Api-Key: YOUR_PRIVATE_API_KEY",
"X-Idempotency-Key: IDEMPOTENCY_KEY",
"X-Merchant-Id: MERCHANT_ID",
"X-Prediction-Id: PREDICTION_ID_VALUE",
"X-Store-Code: STORE_CODE"
]
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("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")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
)
func main() {
request, err := http.NewRequest("GET", "https://api.sandbox.deuna.io/merchants/stores/payments-methods", nil)
if err != nil { panic(err) }
request.Header.Set("X-Api-Key", "YOUR_PRIVATE_API_KEY")
request.Header.Set("X-Idempotency-Key", "IDEMPOTENCY_KEY")
request.Header.Set("X-Merchant-Id", "MERCHANT_ID")
request.Header.Set("X-Prediction-Id", "PREDICTION_ID_VALUE")
request.Header.Set("X-Store-Code", "STORE_CODE")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}Payment Links API#
POST /merchants/payment-links
Creates a payment link from a trusted merchant backend.
cURL example
curl --request POST \
--url 'https://api.sandbox.deuna.io/merchants/payment-links' \
--header 'Content-Type: application/json' \
--data @request.jsonconst response = await fetch("https://api.sandbox.deuna.io/merchants/payment-links", {
method: "POST",
headers: {
"Content-Type": "application/json"
},
body: "@request.json"
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"POST",
"https://api.sandbox.deuna.io/merchants/payment-links",
headers={
"Content-Type": "application/json"
},
data="@request.json",
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/merchants/payment-links",
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
CURLOPT_POSTFIELDS => "@request.json"
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.sandbox.deuna.io/merchants/payment-links"))
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("@request.json"))
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
request, err := http.NewRequest("POST", "https://api.sandbox.deuna.io/merchants/payment-links", strings.NewReader("@request.json"))
if err != nil { panic(err) }
request.Header.Set("Content-Type", "application/json")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}GET /merchants/payment-links/{payment_link_id}
Retrieves a payment link and its current state.
cURL example
curl --request GET \
--url 'https://api.sandbox.deuna.io/merchants/payment-links/{payment_link_id}'const response = await fetch("https://api.sandbox.deuna.io/merchants/payment-links/{payment_link_id}", {
method: "GET"
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"GET",
"https://api.sandbox.deuna.io/merchants/payment-links/{payment_link_id}",
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/merchants/payment-links/{payment_link_id}",
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_RETURNTRANSFER => true
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.sandbox.deuna.io/merchants/payment-links/{payment_link_id}"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
)
func main() {
request, err := http.NewRequest("GET", "https://api.sandbox.deuna.io/merchants/payment-links/{payment_link_id}", nil)
if err != nil { panic(err) }
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}PATCH /merchants/payment-links/{payment_link_id}
Updates an existing payment link.
cURL example
curl --request PATCH \
--url 'https://api.sandbox.deuna.io/merchants/payment-links/{payment_link_id}' \
--header 'Content-Type: application/json' \
--data @request.jsonconst response = await fetch("https://api.sandbox.deuna.io/merchants/payment-links/{payment_link_id}", {
method: "PATCH",
headers: {
"Content-Type": "application/json"
},
body: "@request.json"
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"PATCH",
"https://api.sandbox.deuna.io/merchants/payment-links/{payment_link_id}",
headers={
"Content-Type": "application/json"
},
data="@request.json",
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/merchants/payment-links/{payment_link_id}",
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
CURLOPT_POSTFIELDS => "@request.json"
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.sandbox.deuna.io/merchants/payment-links/{payment_link_id}"))
.header("Content-Type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("@request.json"))
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
request, err := http.NewRequest("PATCH", "https://api.sandbox.deuna.io/merchants/payment-links/{payment_link_id}", strings.NewReader("@request.json"))
if err != nil { panic(err) }
request.Header.Set("Content-Type", "application/json")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}See the Payment Links integration guide for the end-to-end flow.
Subscriptions API#
Plans
GET /subscriptions/plans
Lists subscription plans available to the authenticated merchant.
cURL example
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'const response = await fetch("https://api.sandbox.deuna.io/subscriptions/plans", {
method: "GET",
headers: {
"Authorization": "Bearer USER_ACCESS_TOKEN",
"x-Api-Key": "YOUR_PRIVATE_API_KEY",
"X-Merchant-ID": "MERCHANT_ID"
}
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"GET",
"https://api.sandbox.deuna.io/subscriptions/plans",
headers={
"Authorization": "Bearer USER_ACCESS_TOKEN",
"x-Api-Key": "YOUR_PRIVATE_API_KEY",
"X-Merchant-ID": "MERCHANT_ID"
},
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/subscriptions/plans",
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer USER_ACCESS_TOKEN",
"x-Api-Key: YOUR_PRIVATE_API_KEY",
"X-Merchant-ID: MERCHANT_ID"
]
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("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")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
)
func main() {
request, err := http.NewRequest("GET", "https://api.sandbox.deuna.io/subscriptions/plans", nil)
if err != nil { panic(err) }
request.Header.Set("Authorization", "Bearer USER_ACCESS_TOKEN")
request.Header.Set("x-Api-Key", "YOUR_PRIVATE_API_KEY")
request.Header.Set("X-Merchant-ID", "MERCHANT_ID")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}POST /subscriptions/plans
Creates a subscription plan.
cURL example
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.jsonconst response = await fetch("https://api.sandbox.deuna.io/subscriptions/plans", {
method: "POST",
headers: {
"Authorization": "Bearer USER_ACCESS_TOKEN",
"x-Api-Key": "YOUR_PRIVATE_API_KEY",
"X-Merchant-ID": "MERCHANT_ID",
"Content-Type": "application/json"
},
body: "@request.json"
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"POST",
"https://api.sandbox.deuna.io/subscriptions/plans",
headers={
"Authorization": "Bearer USER_ACCESS_TOKEN",
"x-Api-Key": "YOUR_PRIVATE_API_KEY",
"X-Merchant-ID": "MERCHANT_ID",
"Content-Type": "application/json"
},
data="@request.json",
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/subscriptions/plans",
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer USER_ACCESS_TOKEN",
"x-Api-Key: YOUR_PRIVATE_API_KEY",
"X-Merchant-ID: MERCHANT_ID",
"Content-Type: application/json"
],
CURLOPT_POSTFIELDS => "@request.json"
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("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")
.method("POST", HttpRequest.BodyPublishers.ofString("@request.json"))
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
request, err := http.NewRequest("POST", "https://api.sandbox.deuna.io/subscriptions/plans", strings.NewReader("@request.json"))
if err != nil { panic(err) }
request.Header.Set("Authorization", "Bearer USER_ACCESS_TOKEN")
request.Header.Set("x-Api-Key", "YOUR_PRIVATE_API_KEY")
request.Header.Set("X-Merchant-ID", "MERCHANT_ID")
request.Header.Set("Content-Type", "application/json")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}Subscriptions
List subscriptions
GET /subscriptions
Returns subscriptions available to the authenticated merchant.
cURL example
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'const response = await fetch("https://api.sandbox.deuna.io/subscriptions", {
method: "GET",
headers: {
"Authorization": "Bearer USER_ACCESS_TOKEN",
"x-Api-Key": "YOUR_PRIVATE_API_KEY",
"X-Merchant-ID": "MERCHANT_ID"
}
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"GET",
"https://api.sandbox.deuna.io/subscriptions",
headers={
"Authorization": "Bearer USER_ACCESS_TOKEN",
"x-Api-Key": "YOUR_PRIVATE_API_KEY",
"X-Merchant-ID": "MERCHANT_ID"
},
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/subscriptions",
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer USER_ACCESS_TOKEN",
"x-Api-Key: YOUR_PRIVATE_API_KEY",
"X-Merchant-ID: MERCHANT_ID"
]
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("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")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
)
func main() {
request, err := http.NewRequest("GET", "https://api.sandbox.deuna.io/subscriptions", nil)
if err != nil { panic(err) }
request.Header.Set("Authorization", "Bearer USER_ACCESS_TOKEN")
request.Header.Set("x-Api-Key", "YOUR_PRIVATE_API_KEY")
request.Header.Set("X-Merchant-ID", "MERCHANT_ID")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}Create a subscription
POST /subscriptions
Creates a subscription using an existing plan and payment method.
cURL example
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.jsonconst response = await fetch("https://api.sandbox.deuna.io/subscriptions", {
method: "POST",
headers: {
"Authorization": "Bearer USER_ACCESS_TOKEN",
"x-Api-Key": "YOUR_PRIVATE_API_KEY",
"X-Merchant-ID": "MERCHANT_ID",
"Content-Type": "application/json"
},
body: "@request.json"
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"POST",
"https://api.sandbox.deuna.io/subscriptions",
headers={
"Authorization": "Bearer USER_ACCESS_TOKEN",
"x-Api-Key": "YOUR_PRIVATE_API_KEY",
"X-Merchant-ID": "MERCHANT_ID",
"Content-Type": "application/json"
},
data="@request.json",
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/subscriptions",
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer USER_ACCESS_TOKEN",
"x-Api-Key: YOUR_PRIVATE_API_KEY",
"X-Merchant-ID: MERCHANT_ID",
"Content-Type: application/json"
],
CURLOPT_POSTFIELDS => "@request.json"
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("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")
.method("POST", HttpRequest.BodyPublishers.ofString("@request.json"))
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
request, err := http.NewRequest("POST", "https://api.sandbox.deuna.io/subscriptions", strings.NewReader("@request.json"))
if err != nil { panic(err) }
request.Header.Set("Authorization", "Bearer USER_ACCESS_TOKEN")
request.Header.Set("x-Api-Key", "YOUR_PRIVATE_API_KEY")
request.Header.Set("X-Merchant-ID", "MERCHANT_ID")
request.Header.Set("Content-Type", "application/json")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}Update a subscription
PATCH /subscriptions/{id}
Updates an active subscription’s supported attributes.
cURL example
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.jsonconst response = await fetch("https://api.sandbox.deuna.io/subscriptions/{id}", {
method: "PATCH",
headers: {
"Authorization": "Bearer USER_ACCESS_TOKEN",
"x-Api-Key": "YOUR_PRIVATE_API_KEY",
"X-Merchant-ID": "MERCHANT_ID",
"Content-Type": "application/json"
},
body: "@request.json"
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();import requests
response = requests.request(
"PATCH",
"https://api.sandbox.deuna.io/subscriptions/{id}",
headers={
"Authorization": "Bearer USER_ACCESS_TOKEN",
"x-Api-Key": "YOUR_PRIVATE_API_KEY",
"X-Merchant-ID": "MERCHANT_ID",
"Content-Type": "application/json"
},
data="@request.json",
)
response.raise_for_status()
data = response.json()<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.deuna.io/subscriptions/{id}",
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer USER_ACCESS_TOKEN",
"x-Api-Key: YOUR_PRIVATE_API_KEY",
"X-Merchant-ID: MERCHANT_ID",
"Content-Type: application/json"
],
CURLOPT_POSTFIELDS => "@request.json"
]);
$response = curl_exec($curl);
curl_close($curl);import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("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")
.method("PATCH", HttpRequest.BodyPublishers.ofString("@request.json"))
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request, HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
request, err := http.NewRequest("PATCH", "https://api.sandbox.deuna.io/subscriptions/{id}", strings.NewReader("@request.json"))
if err != nil { panic(err) }
request.Header.Set("Authorization", "Bearer USER_ACCESS_TOKEN")
request.Header.Set("x-Api-Key", "YOUR_PRIVATE_API_KEY")
request.Header.Set("X-Merchant-ID", "MERCHANT_ID")
request.Header.Set("Content-Type", "application/json")
response, err := http.DefaultClient.Do(request)
if err != nil { panic(err) }
defer response.Body.Close()
body, _ := io.ReadAll(response.Body)
fmt.Println(string(body))
}