LogoLogo
CommunitySupport PortalYouTubeStart a free trial
  • Welcome
  • Commerce Engine
  • Orchestration Engine
  • API Documentation
  • Release Notes
  • Changelog
  • Emporix API
    • List of API Services
  • OpenAPI Generator
  • Standard Practices
    • General Info
    • Mixins
    • Query Parameter
    • Translations
    • Custom ID
    • Upsert
    • B2B Token
  • API Guides and References
    • Authorization
      • OAuth Service
        • API Reference
          • Customer Token
          • Anonymous Token
          • Service Access Token
          • Models
        • View Raw API Specification
    • Artificial Intelligence
      • AI Service
        • AI Tutorials
        • API Reference
          • Text Generation
          • AI Completions
          • Models
        • View Raw API Specification
    • Configuration
      • Configuration Service
        • Language Tutorials
        • API Reference
          • Tenant configurations
          • Client configurations
          • Global configurations
          • Models
        • View Raw API Specification
      • Country Service
        • Country Tutorial
        • API Reference
          • Countries
          • Regions
          • Models
        • View Raw API Specification
      • Currency Service
        • Currency Tutorial
        • API Reference
          • Currencies
          • Currency exchange
          • Models
        • View Raw API Specification
      • Unit Handling Service
        • Unit Handling Tutorial
        • API Reference
          • Unit management
          • Type management
          • Unit conversion
          • Models
        • View Raw API Specification
      • Site Settings Service
        • Site Settings Tutorial
        • API Reference
          • Mixins
          • Site settings
          • Models
        • View Raw API Specification
      • Indexing Service
        • Indexing Tutorial
        • API Reference
          • Configuration
          • Public Configuration
          • Reindex
          • Models
        • View Raw API Specification
    • Catalogs and Categories
      • Catalog Service
        • Catalog Tutorials
        • API Reference
          • List catalogs
          • Catalog management
          • Models
        • View Raw API Specification
      • Category Service
        • Category Tutorials
        • API Reference
          • Category Resources
          • Category Assignment Resources
          • Assignment Resources
          • Category Tree Resources
          • Models
        • View Raw API Specification
    • Products, Labels and Brands
      • Product Service
        • Product Tutorial
        • API Reference
          • Products
          • Product Templates
          • Models
        • View Raw API Specification
      • Label Service
        • Label Tutorial
        • API Reference
          • Label
          • Media
          • Models
        • View Raw API Specification
      • Brand Service
        • Brand Tutorial
        • API Reference
          • Brands
          • Media
          • Models
        • View Raw API Specification
    • Prices and Taxes
      • Price Service
        • Price Tutorials
        • API Reference
          • Price lists
          • Price matching
          • Price models
          • Prices
          • Prices assigned to price lists
          • Models
        • View Raw API Specification
      • Tax Service
        • Tax Tutorials
        • API Reference
          • Taxes
          • Tax calculation
          • Models
        • View Raw API Specification
    • Users and Permissions
      • IAM Service
        • IAM Tutorial
        • API Reference
          • Access Controls
          • Group Assignments
          • Groups
          • Permissions
          • Resources
          • Roles
          • Access Control Templates
          • Users
          • Management Dashboard Users
          • Models
        • View Raw API Specification
      • Session-context Service
        • Session-context Tutorial
        • API Reference
          • Session management
          • Session context modification
          • Own session management
          • Own session context modification
          • Models
        • View Raw API Specification
    • Companies and Customers
      • Customer Management
        • Customer Management Tutorial
        • API Reference
          • Locations
          • Contact Assignments
          • Legal Entities
          • Models
        • View Raw API Specification
      • Customer Service (Customer Managed)
        • API Reference
          • Addresses
          • Authentication and authorization
          • Account and profile
          • Double opt In
          • Credentials
          • Models
        • View Raw API Specification
      • Customer Service (Tenant Managed)
        • API Reference
          • Account and profile
          • Addresses
          • Models
        • View Raw API Specification
      • Customer Segments
        • Segments Tutorial
        • API Reference
          • Segments
          • Customers Assignments
          • Items Assignments
          • Models
        • View Raw API Specification
      • Approval Service
        • Approval Tutorials
        • API Reference
          • Approvals
          • Approval
          • Search
          • Models
        • View Raw API Specification
    • Delivery and Shipping
      • Shipping Service
        • Shipping Tutorial
        • API Reference
          • Customer Group Relations
          • Delivery Windows
          • Shipping Cost
          • Shipping Methods
          • Shipping Zones
          • Shipping Groups
          • Sites
          • Delivery Times Management
          • Delivery Times Slots Management
          • Delivery Cycles
          • Models
        • View Raw API Specification
      • Delivery Providers Service
        • API Reference
          • Delivery Orders
          • Delivery Plan
          • Models
        • View Raw API Specification
    • Rewards and Promotions
      • Coupon Service
        • Coupon Tutorial
        • API Reference
          • Coupon Management
          • Coupon Validation
          • Coupon Redemption
          • Referral Coupon Management
          • Models
        • View Raw API Specification
      • Reward-points Service
        • Reward-points Tutorial
        • API Reference
          • Redeem Options Management
          • Signed In Customer Reward Points
          • Reward Points Management
          • Models
        • View Raw API Specification
    • Quotes
      • Quote Service
        • Quote Tutorial
        • API Reference
          • Quote management
          • Quote history
          • Quote pdf
          • Quote reason
          • Models
        • View Raw API Specification
    • Checkout
      • Cart Service
        • Cart Tutorial
        • API Reference
          • Carts
          • Cart items
          • Discounts
          • Models
        • View Raw API Specification
      • Payment-gateway Service
        • Payment-gateway Tutorial
        • API Reference
          • Payment
          • Payment frontend
          • Payment mode
          • Transaction
          • Payment mode frontend
          • Models
        • View Raw API Specification
      • Checkout Service
        • Checkout Tutorial
        • API Reference
          • Checkouts
          • Models
        • View Raw API Specification
      • Fee Service
        • Fee Tutorial
        • API Reference
          • Fee management
          • Item Fee management
          • Product Fees management
          • Item Fee search
          • Models
        • View Raw API Specification
      • Shopping List
        • API Reference
          • Shopping Lists
          • Models
        • View Raw API Specification
    • Orders
      • Availability Service
        • Availability Tutorial
        • API Reference
          • Locations
          • Availabilities
          • Models
        • View Raw API Specification
      • Order Service
        • Order Tutorial
        • API Reference
          • Orders (tenant Managed)
          • Orders (customer Managed)
          • Models
        • View Raw API Specification
      • Pick-pack Service
        • API Reference
          • Orders
          • Assignees
          • Order cycles
          • Recalculations
          • Events
          • Models
        • View Raw API Specification
      • Invoice Service
        • Invoice Tutorial
        • API Reference
          • Invoice Jobs
          • Models
        • View Raw API Specification
      • Returns Service
        • Returns Tutorial
        • API Reference
          • Returns
          • Models
        • View Raw API Specification
      • SEPA Export Service
        • API Reference
          • Files
          • Jobs
          • Models
        • View Raw API Specification
    • Utilities
      • Schema Service
        • Schema Tutorial
        • API Reference
          • Schema
          • Type
          • Reference
          • Custom Schema Type
          • Custom Instance
          • Models
        • View Raw API Specification
      • Sequential-id Service
        • Sequential-id Tutorial
        • API Reference
          • Sequential IDs management
          • Models
        • View Raw API Specification
    • Media
      • Media Service
        • Media Tutorial
        • API Reference
          • Assets
          • Models
        • View Raw API Specification
    • Webhooks
      • Webhook Service
        • Webhooks Tutorial
        • API Reference
          • Config
          • Events
          • Svix Emporix Shared Account
          • Models
        • View Raw API Specification
      • Events-Availability
      • Events-Cart
      • Events-Catalog
      • Events-Category
      • Events-Client Management
      • Events-Customer
      • Events-Index
      • Events-Order
      • Events-Price
      • Events-Product
      • Events-Quote
      • Events-Product
    • Integrations
      • Identity Providers
        • Auth0
      • Workflow Automation
        • Emporix and Make
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. API Guides and References
  2. Checkout
  3. Payment-gateway Service
  4. API Reference

Payment mode

PreviousPayment frontendNextTransaction

Was this helpful?

LogoLogo

Resources

  • Emporix.com
  • Developer Policy
  • Terms of Use

Find us

  • LinkedIn

© 2025 Emporix. All Rights Reserved.

Retrieving a single payment mode

get

Retrieves a single payment mode configuration for a given tenant based on a payment mode identifier.


Required scopes

  • payment-gateway.paymentmodes_read

Authorizations
Path parameters
tenantstring · min: 3 · max: 16Required

Your Emporix tenant's name. Note: The tenant name should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$
idstringRequired

Unique identifier of a payment mode.

Responses
200
Payment mode configured in the payment-gateway service for a given tenant.
application/json
401
Unauthorized
application/json
403
Access forbidden. The caller is not allowed to access this resource.
application/json
404
Not found. The resource does not exist.
application/json
500
Internal Server Error.
application/json
get
GET /payment-gateway/{tenant}/paymentmodes/config/{id} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "id": "92d77b2b-9385-43ad-a859-55176fbcbd36",
  "code": "credit_card",
  "active": true,
  "provider": "SPREEDLY",
  "configuration": {
    "Spreedly/GatewayToken": "5xGx9vcZlMe1AVuHQk00CZTS8YM",
    "Spreedly/EnvironmentKey": "Zrg5UfAqQefDY8KGvU4b31Kuxz",
    "Spreedly/AccessSecret": "ZbvF3kkV4KgapqzXzR67SsTR4IMbCGTnXLMasskPXKWePSOgnU3XO4EpIvIPUMcF",
    "Spreedly/PaymentMethodType": "credit_card",
    "Spreedly/RedirectURL": "https://example.com",
    "Spreedly/SCAProviderToken": "Fnj4SPHmrrbCaHFkWjMItJWzNql"
  }
}

Deleting a single payment mode

delete

Deletes a single payment mode for a given tenant based on a unique mode identifier.


Required scopes

  • payment-gateway.paymentmodes_manage

Authorizations
Path parameters
tenantstring · min: 3 · max: 16Required

Your Emporix tenant's name. Note: The tenant name should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$
idstringRequired

Unique identifier of a payment mode.

Responses
200
OK
400
Bad request. The syntax of the request is incorrect.
application/json
401
Unauthorized
application/json
403
Access forbidden. The caller is not allowed to access this resource.
application/json
404
Not found. The resource does not exist.
application/json
500
Internal Server Error.
application/json
delete
DELETE /payment-gateway/{tenant}/paymentmodes/config/{id} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

  • GETRetrieving a list of payment modes
  • POSTCreating a single payment mode entity
  • GETRetrieving a single payment mode
  • PUTUpdating a single payment mode
  • DELETEDeleting a single payment mode

Retrieving a list of payment modes

get

Retrieves a list of configured payment modes for a given tenant.


Required scopes

  • payment-gateway.paymentmodes_read

Authorizations
Path parameters
tenantstring · min: 3 · max: 16Required

Your Emporix tenant's name. Note: The tenant name should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$
Responses
200
Get all payment modes configured in the payment-gateway service for a given tenant.
401
Unauthorized
application/json
403
Access forbidden. The caller is not allowed to access this resource.
application/json
500
Internal Server Error.
application/json
get
GET /payment-gateway/{tenant}/paymentmodes/config HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
  {
    "id": "92d77b2b-9385-43ad-a859-55176fbcbd36",
    "code": "credit_card",
    "active": true,
    "provider": "SPREEDLY",
    "configuration": {
      "Spreedly/GatewayToken": "5xGx9vcZlMe1AVuHQk00CZTS8YM",
      "Spreedly/EnvironmentKey": "Zrg5UfAqQefDY8KGvU4b31Kuxz",
      "Spreedly/AccessSecret": "ZbvF3kkV4KgapqzXzR67SsTR4IMbCGTnXLMasskPXKWePSOgnU3XO4EpIvIPUMcF",
      "Spreedly/PaymentMethodType": "credit_card",
      "Spreedly/RedirectURL": "https://example.com",
      "Spreedly/SCAProviderToken": "Fnj4SPHmrrbCaHFkWjMItJWzNql"
    }
  },
  {
    "id": "a8c96773-1cdf-4ea7-b1a2-1453d17f5324",
    "code": "sprel",
    "active": true,
    "provider": "SPREEDLY",
    "configuration": {
      "Spreedly/GatewayToken": "5xGx9vcZlMe1AVuHQk00CZTS8YM",
      "Spreedly/EnvironmentKey": "Zrg5UfAqQefDY8KGvU4b31Kuxz",
      "Spreedly/AccessSecret": "ZbvF3kkV4KgapqzXzR67SsTR4IMbCGTnXLMasskPXKWePSOgnU3XO4EpIvIPUMcF",
      "Spreedly/SignatureSecret": "_eJMkqevWxXcq6qOyA1fjnfCseO7gISG28rSRBHKJVeKHM6i_Pqt6fGa_cWhzGvc",
      "Spreedly/PaymentMethodType": "sprel",
      "Spreedly/RedirectURL": "https://storefront.emporix.io/emporix/payment-callback"
    }
  },
  {
    "id": "ef48f439-1c2c-42ff-807d-ed4cac287741",
    "code": "paypal",
    "siteCode": "main",
    "active": true,
    "provider": "SPREEDLY",
    "configuration": {
      "Spreedly/GatewayToken": "5xGx9vcZlMe1AVuHQk00CZTS8YM",
      "Spreedly/EnvironmentKey": "Zrg5UfAqQefDY8KGvU4b31Kuxz",
      "Spreedly/AccessSecret": "ZbvF3kkV4KgapqzXzR67SsTR4IMbCGTnXLMasskPXKWePSOgnU3XO4EpIvIPUMcF",
      "Spreedly/PaymentMethodType": "paypal",
      "Spreedly/RedirectURL": "https://storefront.emporix.io/emporix/payment-callback",
      "Spreedly/SignatureSecret": "_eJMkqevWxXcq9qOyA7fjnfCseO7gISG28rSRBHKPVeKDM6i_Uqt6fGa_cWhzGvc"
    }
  }
]

Creating a single payment mode entity

post

Creates a new payment mode for a given tenant. Currently the service supports the following payment methods:

  • Payment methods supported by Spreedly: https://docs.spreedly.com/reference/supported-gateways/

  • Saferpay: https://docs.saferpay.com/home/interfaces/payment-api

  • Unzer Invoice: https://docs.unzer.com/payment-methods/unzer-invoice-upl/


Required scopes

  • payment-gateway.paymentmodes_manage

Authorizations
Path parameters
tenantstring · min: 3 · max: 16Required

Your Emporix tenant's name. Note: The tenant name should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$
Body
codestringRequired

Indicates a code of a given method.

activebooleanOptional

Indicates whether a give mode is active.

providerall ofRequired

Indicates which provider should be used.

string · enumOptionalPossible values:
Responses
200
Payment mode configured in the payment-gateway service for a given tenant.
application/json
400
Bad request. The syntax of the request is incorrect.
application/json
401
Unauthorized
application/json
403
Access forbidden. The caller is not allowed to access this resource.
application/json
409
Conflict. The resource already exists.
application/json
500
Internal Server Error.
application/json
post
POST /payment-gateway/{tenant}/paymentmodes/config HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 488

{
  "code": "paypal",
  "active": true,
  "provider": "SPREEDLY",
  "configuration": {
    "Spreedly/GatewayToken": "KnQsG1FFJjfcKEUt5ObMilP2Rs4",
    "Spreedly/EnvironmentKey": "Zrg5UfAqQefDY8KGvU5b9OKuxz",
    "Spreedly/AccessSecret": "ZrvF6kkV4KgapqzXzR67SsTR4PMbCGTnXLMasskAXKWePSOgnU3XO4EpIvIPUDcF",
    "Spreedly/PaymentMethodType": "paypal",
    "Spreedly/RedirectURL": "https://storefront.emporix.io/exmporix/my-account/my-orders",
    "Spreedly/SignatureSecret": "_eJMkqevWxAdq9qOyA7fjnfCseO7gIaG28rSRBHKJVeKHM6i_Uqt6fGa_cWhzGvc"
  }
}
{
  "id": "92d77b2b-9385-43ad-a859-55176fbcbd36",
  "code": "credit_card",
  "active": true,
  "provider": "SPREEDLY",
  "configuration": {
    "Spreedly/GatewayToken": "5xGx9vcZlMe1AVuHQk00CZTS8YM",
    "Spreedly/EnvironmentKey": "Zrg5UfAqQefDY8KGvU4b31Kuxz",
    "Spreedly/AccessSecret": "ZbvF3kkV4KgapqzXzR67SsTR4IMbCGTnXLMasskPXKWePSOgnU3XO4EpIvIPUMcF",
    "Spreedly/PaymentMethodType": "credit_card",
    "Spreedly/RedirectURL": "https://example.com",
    "Spreedly/SCAProviderToken": "Fnj4SPHmrrbCaHFkWjMItJWzNql"
  }
}

Updating a single payment mode

put

Updates a single payment mode for a given tenant based on a unique mode identifier.


Required scopes

  • payment-gateway.paymentmodes_manage

Authorizations
Path parameters
tenantstring · min: 3 · max: 16Required

Your Emporix tenant's name. Note: The tenant name should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$
idstringRequired

Unique identifier of a payment mode.

Body
activebooleanOptional

Indicates whether a give mode is active.

Responses
200
Payment mode configured in the payment-gateway service for a given tenant.
application/json
400
Bad request. The syntax of the request is incorrect.
application/json
401
Unauthorized
application/json
403
Access forbidden. The caller is not allowed to access this resource.
application/json
404
Not found. The resource does not exist.
application/json
500
Internal Server Error.
application/json
put
PUT /payment-gateway/{tenant}/paymentmodes/config/{id} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 450

{
  "active": true,
  "configuration": {
    "Spreedly/GatewayToken": "KnQsG1FFJjfcKEUt5ObMilP2Rs4",
    "Spreedly/EnvironmentKey": "Zrg5UfAqQefDY8KGvU5b9OKuxz",
    "Spreedly/AccessSecret": "ZrvF6kkV4KgapqzXzR67SsTR4PMbCGTnXLMasskAXKWePSOgnU3XO4EpIvIPUDcF",
    "Spreedly/PaymentMethodType": "paypal",
    "Spreedly/RedirectURL": "https://storefront.emporix.io/exmporix/my-account/my-orders",
    "Spreedly/SignatureSecret": "_eJMkqevWxAdq9qOyA7fjnfCseO7gIaG28rSRBHKJVeKHM6i_Uqt6fGa_cWhzGvc"
  }
}
{
  "id": "92d77b2b-9385-43ad-a859-55176fbcbd36",
  "code": "credit_card",
  "active": true,
  "provider": "SPREEDLY",
  "configuration": {
    "Spreedly/GatewayToken": "5xGx9vcZlMe1AVuHQk00CZTS8YM",
    "Spreedly/EnvironmentKey": "Zrg5UfAqQefDY8KGvU4b31Kuxz",
    "Spreedly/AccessSecret": "ZbvF3kkV4KgapqzXzR67SsTR4IMbCGTnXLMasskPXKWePSOgnU3XO4EpIvIPUMcF",
    "Spreedly/PaymentMethodType": "credit_card",
    "Spreedly/RedirectURL": "https://example.com",
    "Spreedly/SCAProviderToken": "Fnj4SPHmrrbCaHFkWjMItJWzNql"
  }
}