post https://api.test.kalixa.com/PaymentRedirectionService/PaymentService.svc/pox/executePaymentAction
executePaymentActionRequest fields
field (type, required) | description |
---|---|
merchantID (stringID, required) | Merchant ID |
shopID (stringID, required) | Shop ID |
paymentID (stringID, required) | PXP Financial’s Unique ID of the payment It is returned either in the initiatePaymentResponse or notified in the handlePaymentStateChangedNotificationRequest |
actionID (positiveInt, required) | 1 = Cancel 2 = Capture Payment 154 = Partially Capture 205 = Initiate Capturing |
remark (stringID) | Optional remark text related to the action to be executed |
Actions Available per Payment Method
Payment Method (ID) | Current State (ID) | Action (ID) | Expected State (ID) |
---|---|---|---|
Visa Deposit (2) | Cancel (1) Capture (205) | Cancelled (113) CaptureRequestReceived (413) PendingToBeCaptured (306) | |
VISA Debit Deposit (167) | Cancel (1) Capture (205) | Cancelled (113) CaptureRequestReceived (413) PendingToBeCaptured (306) | |
VISA Withdrawal (12) | Cancel (1) | Cancelled (113) | |
Mastercard Deposit (1) | Cancel (1) Capture (205) | Cancelled (113) CaptureRequestReceived (413) PendingToBeCaptured (306) | |
Mastercard Debit Deposit (168) | Cancel (1) Capture (205) | Cancelled (113) CaptureRequestReceived (413) PendingToBeCaptured (306) | |
Mastercard Withdrawal (38) | Cancel (1) | Cancelled (113) | |
Maestro Deposit (73) | Cancel (1) Capture (205) | Cancelled (113) CaptureRequestReceived (413) PendingToBeCaptured (306) | |
Maestro Withdrawal (147) | Cancel (1) | Cancelled (113) | |
American Express Deposit (113) | Cancel (1) Capture (205) | Cancelled (113) CaptureRequestReceived (413) PendingToBeCaptured (306) | |
Diners Deposit (3) | Cancel (1) Capture (205) | Cancelled (113) CaptureRequestReceived (413) PendingToBeCaptured (306) | |
Diners Withdrawal (14) | Cancel (1) | Cancelled (113) | |
Bank Transfer Withdrawal (24) | Cancel (1) | Cancelled (113) | |
Neteller Withdrawal (5) | Cancel (1) | Cancelled (113) | |
Webmoney Withdrawal (35) | Cancel (1) | Cancelled (113) | |
PayPal Withdrawal (64) | Cancel (1) | Cancelled (113) | |
Skrill Withdrawal (16) | Cancel (1) | Cancelled (113) | |
Mastercard PreAuthorisation (304) | AuthorisedByProvider (13) | Cancel (1) Partially Capture (154) | Cancelled (113) AuthorisedByProvider (13) |
Visa Estimated Authorisation (305) | AuthorisedByProvider (13) | Cancel (1) Partially Capture (154) | Cancelled (113) AuthorisedByProvider (13) |
Visa MultiCapture Authorisation (311) | AuthorisedByProvider (13) | Cancel (1) Partially Capture (154) | Cancelled (113) AuthorisedByProvider (13) |
executePaymentActionResponse fields
field (type, required) | description |
---|---|
statusCode (nonNegativeInt) | 0 – successful execution 1 – unsuccessful execution 2 – unknown status/actionResults must be investigated. |
actionResults (array of keyValueBasePairs) | Contains the results of the executed payment action. If successful, it will contain e.g.: key = lastStateDefinition value = 113 (Cancelled) or value = 413 (CaptureRequestReceived) or value = 306 (PendingToBeCaptured) |
ThreeDSecureVersion (string) | The 3DS 2.0 protocol version |
CardholderAuthenticationVerificationValue (string) | Corresponds to the authentication value |
ThreeDSecureTransactionStatus (string) | The Transaction Status value in the ARes or CRes depending on whether the authentication was frictionless or not |
ThreeDSecureTransactionStatusReason (string) | This field is sent only when ThreeDSecureTransactionStatus is different from Y or A |
DirectoryServerTransactionID (string) | The unique ID assigned by the Directory Server for this payment. |
IsScaWhitelistingSuccessful (boolean) | Indicates if whitelisting of trusted beneficiary by cardholder has been successful. Possible values: true false |
ScaWhitelistStatus (string) | Indicates the whitelisting status of trusted beneficiary by cardholder. Possible values: Y - Merchant is whitelisted by cardholder P - Pending confirmation by cardholder N - Merchant is not whitelisted by cardholder |
ECIAfterAuthentication (string) | The Electronic Commerce Indicator assigned to a payment as a result of authentication. |
If the action is processed successfully, Payment Service will send a PaymentStateChangeNotificaitonRequest with the same content as for the payments initiated through the redirect pages. For further details see handlePaymentStateChangedNotification.
For additional sample requests/responses please refer to Payment Actions Backend2Backend Integration