Emporix Payment - frontend API

The Payment - frontend API from Emporix — 2 operation(s) for payment - frontend.

GitHub OpenAPI
Business capability
Consumer Payment Options AE-140.30

Operations 2

POST /payment-gateway/{tenant}/payment/frontend/initialize Initializing a payment #
POST /payment-gateway/{tenant}/payment/frontend/authorize Authorizing a payment #

Documentation

📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-1
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-23
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-6
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-7
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-5
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-8
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-17
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-25
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-37
📖
Documentation
https://developer.emporix.io/api-references/readme/approval-api-reference
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-15
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-13
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-16
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-14
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-41
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-9
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-10
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-12
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-19
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-38
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-40
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-36
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-22
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-3
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-20
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-24
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-29
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-26
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-39
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-4
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-21
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-27
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-28
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-11
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-30
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-18
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-35
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-2
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-33
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-31
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-32
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-34
📖
Documentation
https://developer.emporix.io/api-references/readme/api-reference-42

Specifications

Schemas & Data

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/emporix:emporix-payment-frontend-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

emporix-payment-frontend-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Emporix Payment - frontend API
  version: ''
  contact:
    email: documentation@emporix.com
  description: 'Operations tagged Payment - frontend across 2 of this provider''s published API definitions: emporix-payment-gateway-openapi.yml, emporix-payment-gateway-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.emporix.io
security:
- OAuth2: []
tags:
- name: Payment - frontend
paths:
  /payment-gateway/{tenant}/payment/frontend/initialize:
    parameters:
    - $ref: '#/components/parameters/path_tenant'
    post:
      summary: Initializing a payment
      operationId: POST-payment-gateway-initialize-payment-frontend
      responses:
        '200':
          $ref: '#/components/responses/paymentInitializeResponse'
        '400':
          $ref: '#/components/responses/common_response_BadRequest_400'
        '401':
          $ref: '#/components/responses/common_response_Unauthorized_401'
        '422':
          $ref: '#/components/responses/common_response_Unprocessable_Entity_422'
        '500':
          $ref: '#/components/responses/common_response_InternalServerError_500'
      tags:
      - Payment - frontend
      description: 'Initializes a payment by accepting a request sent from the frontend.

        No scope is required.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/initializePaymentRequest'
    servers:
    - url: https://api.emporix.io
  /payment-gateway/{tenant}/payment/frontend/authorize:
    parameters:
    - $ref: '#/components/parameters/path_tenant'
    post:
      summary: Authorizing a payment
      operationId: POST-payment-gateway-authorize-payment-frontend
      responses:
        '200':
          $ref: '#/components/responses/paymentAuthorizeResponse'
        '400':
          $ref: '#/components/responses/common_response_BadRequest_400'
        '401':
          $ref: '#/components/responses/common_response_Unauthorized_401'
        '422':
          $ref: '#/components/responses/common_response_Unprocessable_Entity_422'
        '500':
          $ref: '#/components/responses/common_response_InternalServerError_500'
      tags:
      - Payment - frontend
      description: 'Authorize a payment by accepting a request sent from the frontend.

        No scope is required.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/authorizeFrontendPaymentRequest'
    servers:
    - url: https://api.emporix.io
components:
  responses:
    paymentAuthorizeResponse:
      description: Payment authorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/authorizePaymentResponse'
          examples:
            Authorize response:
              value:
                successful: true
                paymentTransactionId: FTrjO4SrNF0Had7yBCeVU5ziqwL
                requiresExternalPayment: true
                externalPaymentRedirectURL: https://www.sandbox.paypal.com/checkoutnow?token=0SC35196GX656501J
                externalPaymentParameters: {}
    paymentInitializeResponse:
      description: Payment initialized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/initializePaymentResponse'
          examples:
            Authorize response:
              value:
                successful: true
                paymentTransactionId: FTrjO4SrNF0Had7yBCeVU5ziqwL
                externalPaymentRedirectURL: https://www.sandbox.paypal.com/checkoutnow?token=0SC35196GX656501J
                externalPaymentParameters: {}
    common_response_BadRequest_400:
      description: Bad request. The syntax of the request is incorrect.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/coreErrorMessage'
          examples:
            BadRequest:
              value:
                code: 400
                timestamp: '2023-10-03T12:23:31.485306Z'
                message: The syntax of the request is incorrect.
    common_response_Unauthorized_401:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            properties:
              fault:
                type: object
                properties:
                  faultstring:
                    type: string
                  detail:
                    type: object
                    properties:
                      errorcode:
                        type: string
          examples:
            Invalid access token:
              value:
                fault:
                  faultstring: Invalid access token
                  detail:
                    errorcode: oauth.v2.InvalidAccessToken
            Access token expired:
              value:
                fault:
                  faultstring: Access Token expired
                  detail:
                    errorcode: keymanagement.service.access_token_expired
    common_response_Unprocessable_Entity_422:
      description: Unprocessable Entity. The payment action is not supported.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/coreErrorMessage'
          examples:
            Unprocessable Entity:
              value:
                code: 422
                timestamp: '2023-10-03T12:23:31.485306Z'
                message: The payment action is not supported.
    common_response_InternalServerError_500:
      description: Internal Server Error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/coreErrorMessage'
          examples:
            Internal Server Error:
              value:
                code: 500
                timestamp: '2023-10-03T12:23:31.485306Z'
                message: Problem encountered while trying to connect to the database.
  schemas:
    initializePaymentRequest:
      title: initializePaymentRequest
      type: object
      properties:
        order:
          type: object
          properties:
            id:
              type: string
              description: Identifier of an order for which the payment should be authorized.
        paymentModeId:
          type: string
          description: Identifier of a payment mode configured in the payment-gateway service for a given tenant.
        creditCardToken:
          type: string
          description: Indicates a payment method token, usually generated on a frontend site, when an user provides a credit card information.
    authorizeFrontendPaymentRequest:
      title: authorizeFrontendPaymentRequest
      allOf:
      - $ref: '#/components/schemas/initializePaymentRequest'
      - type: object
        properties:
          threeDSToken:
            type: string
            description: Contains a token generated during the 3DS authentication process.
          browserInfo:
            type: string
            description: Holds information related to the user's web browser.
          clientIP:
            type: string
            description: Stores the IP address of the client or user making the request.
    initializePaymentResponse:
      title: initializePaymentResponse
      type: object
      properties:
        successful:
          type: boolean
          description: Indicates if the authorization process finished with success.
        paymentTransactionId:
          type: string
          description: 'Unique payment transaction identifier. '
        authorizationToken:
          type: string
          description: Authorization token
        externalPaymentRedirectURL:
          type: string
          description: Indicates a URL address where a user should be redirected in order to finish the authorization process.
        externalPaymentHttpMethod:
          type: string
          description: Indicates a HTTP Method which should be used in order to finish the authorization process.
        externalPaymentParameters:
          type: object
          additionalProperties:
            type: string
          description: 'Map of additional parameters that may be needed in order to complete the authorization flow. '
    authorizePaymentResponse:
      title: authorizePaymentResponse
      allOf:
      - $ref: '#/components/schemas/initializePaymentResponse'
      - type: object
        properties:
          requiresExternalPayment:
            type: boolean
            description: Indicates if a redirect to an external site is required in order to finish the authorization flow.
    coreErrorMessage:
      anyOf:
      - type: object
        properties:
          code:
            type: integer
            description: HTTP Status code.
          timestamp:
            type: string
            description: Indicates a timestamp when the error occurred.
          message:
            type: string
            description: Error message.
      - type: object
        properties:
          type:
            type: string
            description: HTTP error type.
          status:
            type: integer
            description: HTTP Status code.
          message:
            type: string
            description: Error message.
          moreInfo:
            type: string
            description: URL which additional information.
          details:
            type: array
            items:
              type: object
              properties:
                message:
                  type: string
                  description: Detailed message.
  parameters:
    path_tenant:
      name: tenant
      in: path
      required: true
      description: 'Your Emporix tenant''s name.

        **Note**: The tenant name should always be written in lowercase.

        '
      schema:
        pattern: ^[a-z][a-z0-9]+$
        minLength: 3
        maxLength: 16
        type: string
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.emporix.io/oauth/token
          scopes:
            payment-gateway.paymentmodes_read: Needed for reading payment modes by a tenant employee.
            payment-gateway.paymentmodes_manage: Needed to manage payment modes by a tenant employee.
            payment-gateway.authorize_manage: Needed to perform a payment authorization flow by a tenant employee.
            payment-gateway.capture_manage: Needed to perform a payment capture flow by a tenant employee.
            payment-gateway.refund_manage: Needed to perform a payment refund flow by a tenant employee.
            payment-gateway.cancel_manage: Needed to perform a payment cancel flow by a tenant employee.
            payment-gateway.paymenttransactions_read: Needed to read all transaction details by a tenant employee.
x-refined-from:
- emporix-payment-gateway-openapi.yml
- emporix-payment-gateway-openapi.yml