Payment mode
Retrieves a list of configured payment modes for a given tenant.
Required scopes
payment-gateway.paymentmodes_read
Your Emporix tenant's name. Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$
Get all payment modes configured in the payment-gateway service for a given tenant.
Unauthorized
Access forbidden. The caller is not allowed to access this resource.
Internal Server Error.
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"
}
}
]
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
Your Emporix tenant's name. Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$
Indicates a code of a given method.
Indicates whether a give mode is active.
Indicates which provider should be used.
Payment mode configured in the payment-gateway service for a given tenant.
Bad request. The syntax of the request is incorrect.
Unauthorized
Access forbidden. The caller is not allowed to access this resource.
Conflict. The resource already exists.
Internal Server Error.
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"
}
}
Retrieves a single payment mode configuration for a given tenant based on a payment mode identifier.
Required scopes
payment-gateway.paymentmodes_read
Your Emporix tenant's name. Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$
Unique identifier of a payment mode.
Payment mode configured in the payment-gateway service for a given tenant.
Unauthorized
Access forbidden. The caller is not allowed to access this resource.
Not found. The resource does not exist.
Internal Server Error.
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"
}
}
Updates a single payment mode for a given tenant based on a unique mode identifier.
Required scopes
payment-gateway.paymentmodes_manage
Your Emporix tenant's name. Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$
Unique identifier of a payment mode.
Indicates whether a give mode is active.
Payment mode configured in the payment-gateway service for a given tenant.
Bad request. The syntax of the request is incorrect.
Unauthorized
Access forbidden. The caller is not allowed to access this resource.
Not found. The resource does not exist.
Internal Server Error.
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"
}
}
Deletes a single payment mode for a given tenant based on a unique mode identifier.
Required scopes
payment-gateway.paymentmodes_manage
Your Emporix tenant's name. Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$
Unique identifier of a payment mode.
OK
Bad request. The syntax of the request is incorrect.
Unauthorized
Access forbidden. The caller is not allowed to access this resource.
Not found. The resource does not exist.
Internal Server Error.
DELETE /payment-gateway/{tenant}/paymentmodes/config/{id} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Was this helpful?