Payment
- : Needed to perform a payment authorization flow by a tenant employee.
Your Emporix tenant's name. Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$Identifier of a payment mode configured in the payment-gateway service for a given tenant.
Indicates a payment method token, usually generated on a frontend site, when an user provides a credit card information.
Contains a token generated during the 3DS authentication process.
Holds information related to the user's web browser.
Stores the IP address of the client or user making the request.
Amount that should be authorized.
Currency for the amount that should be authorized.
Payment authorized
Indicates if the authorization process finished with success.
Unique payment transaction identifier.
Authorization token
Indicates a URL address where a user should be redirected in order to finish the authorization process.
Indicates a HTTP Method which should be used in order to finish the authorization process.
Indicates if a redirect to an external site is required in order to finish the authorization flow.
Unauthorized
Access forbidden. The caller is not allowed to access this resource.
Unprocessable Entity. The payment action is not supported.
Internal Server Error.
- : Needed to perform a payment capture flow by a tenant employee.
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 transaction.
Amount that should be captured. The amount should not be greater than amount that was authorized.
Currency for the amount that should be captured.
Payment capture response
Indicates if the operation finished with success or not.
In case of failed operation, the field provides error details.
Identifier of a capture operation that is returned by a payment provider.
Unauthorized
Access forbidden. The caller is not allowed to access this resource.
Not found. The resource does not exist.
Unprocessable Entity. The payment action is not supported.
Internal Server Error.
- : Needed to perform a payment refund flow by a tenant employee.
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 transaction.
Amount that should be refunded. The amount should not be greater than amount that was captured.
Currency for the amount that should be refunded.
Capture identifier. The value is mandatory only if there were more captures for a payment and the refund should be related to a specific capture. In another case the value can be skipped and the capture related to the payment will be chosen automatically.
Payment transaction response
Indicates if the operation finished with success or not.
In case of failed operation, the field provides error details.
Unauthorized
Access forbidden. The caller is not allowed to access this resource.
Not found. The resource does not exist.
Unprocessable Entity. The payment action is not supported.
Internal Server Error.
- : Needed to perform a payment cancel flow by a tenant employee.
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 transaction.
Payment transaction response
Indicates if the operation finished with success or not.
In case of failed operation, the field provides error details.
Unauthorized
Access forbidden. The caller is not allowed to access this resource.
Not found. The resource does not exist.
Unprocessable Entity. The payment action is not supported.
Internal Server Error.
Last updated
Was this helpful?