Payment
Authorizes a given 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]+$Payment authorized
Unauthorized
Access forbidden. The caller is not allowed to access this resource.
Unprocessable Entity. The payment action is not supported.
Internal Server Error.
POST /payment-gateway/{tenant}/payment/authorize HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 172
{
"order": {
"id": "text"
},
"paymentModeId": "text",
"creditCardToken": "text",
"threeDSToken": "text",
"browserInfo": "text",
"clientIP": "text",
"amountToAuthorize": 1,
"currency": "text"
}{
"successful": true,
"paymentTransactionId": "FTrjO4SrNF0Had7yBCeVU5ziqwL",
"requiresExternalPayment": true,
"externalPaymentRedirectURL": "https://www.sandbox.paypal.com/checkoutnow?token=0SC35196GX656501J",
"externalPaymentParameters": {}
}Creates a flow to capture a given payment transaction. The capture operation requires transactionId, thus it can be invoked only if the payment had been previously authorized.
- : 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
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.
POST /payment-gateway/{tenant}/payment/{transactionId}/capture HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 32
{
"amount": 3.99,
"currency": "EUR"
}{
"successful": true,
"message": "text",
"captureId": "text"
}Creates a flow to return a given payment. The refund operation requires transactionId, thus it can be invoked only if the payment has been authorized and captured previously.
- : 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
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.
POST /payment-gateway/{tenant}/payment/{transactionId}/refund HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 32
{
"amount": 3.99,
"currency": "EUR"
}{
"successful": true,
"message": "Success!"
}Creates a flow to cancel a given payment transaction. The cancel operation requires transactionId, thus it can be invoked only if the payment has been authorized previously.
- : 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
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.
POST /payment-gateway/{tenant}/payment/{transactionId}/cancel HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"successful": true,
"message": "Success!"
}Last updated
Was this helpful?