Available Actions

Below is a list of the available actions that can be implemented (see or the downloadable for implementation examples):

1. External Payment Redirect Action:
Used for connectors where the payment is conducted on an external page that the user gets redirected to. This is the least ideal flow for Apaya as the user is taken away from our platform, wherever possible we’d try to avoid this flow unless absolutely necessary.

2. External SDK Actions:
Used for connectors that completely rely on a client-side SDK. The request and response objects are passed as they are. The response does not get wrapped in the common response format.

3. Get Transaction Action:
Get the transaction object from the underlying connector. It is mainly used to check a transaction's status in asynchronous flows (i.e. 3DS verification during a card payment).

4. Identify User Action:
This action is commonly used in DCB payment-like flows, where a manual step from the user is required, typically to input a one-time PIN for verification. This can also be utilised for other multi-step identification processes.

5. Process Payment Action:
The main payment processing action that will be used by most connectors. This action is expected to initiate the payment and return any required follow-up actions to complete where necessary.

6. Process Refund Action:
The main refund processing action that will be used by most connectors.

7. Capture Payment Action:
Capture payment functionality refers to the process of capturing the authorized amount from a customer's payment method, such as a credit card. i.e. performing the charge to a customer’s card after having reserved an amount.

8. Void Payment Action:
The void functionality in payment processing allows the cancellation of an authorized but unsettled transaction before the capture process is completed. This is typically used to void a payment after an amount is reserved but before the charge is performed.
Want to print your doc?
This is not the way.
Try clicking the ⋯ next to your doc name or using a keyboard shortcut (
CtrlP
) instead.