Payment mode frontend

Retrieving all the payment modes

get

Retrieves a list of configured payment modes for a given tenant with publicly available properties (excluding all secrets, signatures etc). The endpoint should be used by a frontend application to fetch all the possible payment methods configured for a particular tenant. No scope is required.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Available scopes:

• : Needed for reading payment modes by a tenant employee.
• : Needed to manage payment modes by a tenant employee.
• : Needed to perform a payment authorization flow by a tenant employee.
• : Needed to perform a payment capture flow by a tenant employee.
• : Needed to perform a payment refund flow by a tenant employee.
• : Needed to perform a payment cancel flow by a tenant employee.
• : Needed to read all transaction details by a tenant employee.

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

Payment modes configured in the payment-gateway service for a given tenant that returns only properties publicly available.

application/json

401

Unauthorized

application/json

get

/payment-gateway/{tenant}/paymentmodes/frontend

HTTPcURLJavaScriptPython

GET /payment-gateway/{tenant}/paymentmodes/frontend HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "92d77b2b-9385-43ad-a859-55176fbcbd2f",
    "code": "credit_card",
    "integrationType": "TOKENIZED",
    "javascriptUrl": "https://core.spreedly.com/iframe/iframe-v1.min.js",
    "paymentMethodType": "credit_card",
    "environmentKey": "Zrg5UfAqQefDY8KGvU4b9OKuxz"
  },
  {
    "id": "a8c96773-1cdf-4ea7-b1a2-1453d17f5374",
    "code": "sprel",
    "integrationType": "OFFSITE",
    "paymentMethodType": "sprel",
    "environmentKey": "Zrg5UfAqQefDY8KGvU4b9OKuxz"
  },
  {
    "id": "ef48f439-1c3c-42ff-807d-ef4cac237745",
    "code": "paypal",
    "integrationType": "OFFSITE",
    "paymentMethodType": "paypal",
    "environmentKey": "Zrg5UfAqQefDY8KGvU4b9OKuxz"
  }
]

Retrieving a single payment mode

get

Retrieves a single payment mode for a given tenant with publicly available properties (excluding all secrets, signatures etc). The endpoint should be used by a frontend application to fetch a payment method configuration for a particular tenant. No scope is required.

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Available scopes:

• : Needed for reading payment modes by a tenant employee.
• : Needed to manage payment modes by a tenant employee.
• : Needed to perform a payment authorization flow by a tenant employee.
• : Needed to perform a payment capture flow by a tenant employee.
• : Needed to perform a payment refund flow by a tenant employee.
• : Needed to perform a payment cancel flow by a tenant employee.
• : Needed to read all transaction details by a tenant employee.

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 modes configured in the payment-gateway service for a given tenant that returns only properties publicly available.

application/json

401

Unauthorized

application/json

404

Not found. The resource does not exist.

application/json

get

/payment-gateway/{tenant}/paymentmodes/frontend/{id}

HTTPcURLJavaScriptPython

GET /payment-gateway/{tenant}/paymentmodes/frontend/{id} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "92d77b2b-9385-43ad-a859-55176fbcbd2f",
    "code": "credit_card",
    "integrationType": "TOKENIZED",
    "javascriptUrl": "https://core.spreedly.com/iframe/iframe-v1.min.js",
    "paymentMethodType": "credit_card",
    "environmentKey": "Zrg5UfAqQefDY8KGvU4b9OKuxz"
  },
  {
    "id": "a8c96773-1cdf-4ea7-b1a2-1453d17f5374",
    "code": "sprel",
    "integrationType": "OFFSITE",
    "paymentMethodType": "sprel",
    "environmentKey": "Zrg5UfAqQefDY8KGvU4b9OKuxz"
  },
  {
    "id": "ef48f439-1c3c-42ff-807d-ef4cac237745",
    "code": "paypal",
    "integrationType": "OFFSITE",
    "paymentMethodType": "paypal",
    "environmentKey": "Zrg5UfAqQefDY8KGvU4b9OKuxz"
  }
]