Immediate capture provides a simplified and efficient payment process. It’s ideal for merchants who want to finalize and settle payments immediately upon order confirmation, or who want to minimize complexity. It combines the following actions into a single API call:
- Completing payment approval.
- Starting the customer’s payment plan.
- Settling the full order value into the merchant’s bank account.
- Create a checkout. If the customer confirms their order with Afterpay, they’re returned to your website with an order token and the
SUCCESS status.
- Use the order token to call the Capture Full Payment endpoint. Once the capture completes, you’ll receive a Payment object with a status of
APPROVED or DECLINED.
- If Afterpay approves the payment, present the customer with an order confirmation page. The full payment is captured.
- If Afterpay declines the payment (for example, if the customer’s credit card details are incorrect), present the customer with suggested corrections or alternative payment methods at checkout.
Considerations
- Immediate capture is supported by all platforms.
- You must call the Capture Full Payment endpoint within 180 minutes of receiving the token from the Create Checkout call.
- The Capture Full Payment call is idempotent. It’s safe to retry requests within 24 hours using the same unique requestId.
- Express checkout requires additional data. See Express Checkout Integration to learn more.
