Airwallex logo

Capture

The capture step initiates the financial transfer from the funds you put on hold with the initial payment intent confirmation.This is a required step for Card payments (Credit or Debit Cards) or for any other payment method requiring a second step to capture funds.

Note

Not executing this step on time or note executing it at all means you will not receive any funds. If you do not want to worry about it you have the option to use the auto_capture parameter in your payment intent or to set it up by default in your account.

You need to follow the below process:

  1. Use the POST/api/v1/pa/payment_intents/{id}/capture, to request the capture of your payment. Upon successful completion the appropriate financial transactions will be generated and the payment intent will subsequently appear on your settlement report. You will receive a synchronous response to inform you the request has been taken into account.
curl -X POST \
  https://pci-api.airwallex.com/api/v1/pa/payment_intents/int_tkZsvKMHzf37yTFqlztZ5NYEAvD/capture \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer your_bearer_token' \
  -d '{
  "amount": 1, 
  "request_id": "285ecfc8-4c53-4543-8b9b-87d75e8666b9"
}'
{
    "id": "int_tkZsvKMHzf37yTFqlztZ5NYEAvD",
    "request_id": "285ecfc8-4c53-4543-8b9b-87d75e8666b9",
    "amount": 100.0,
    "currency": "HKD",
    "merchant_order_id": "d566b126-4e49-4233-93f4-b9ac809847db",
    "status": "SUCCEEDED",
    "captured_amount": 1.0,
    "latest_payment_attempt": {
        "id": "att_raOACk4zg17OZvmTzyFwKgOKWs",
        "amount": 100.0,
        "payment_method": {
            "id": "mtd_hq24SfHPX8Ft4d0T8tA3a905nYB",
            "type": "card",
            "card": {
                "expiry_month": "01",
                "expiry_year": "2023",
                "name": "Adam",
                "bin": "401200",
                "last4": "1003",
                "brand": "visa",
                "issuer_country_code": "RU",
                "card_type": "credit",
                "fingerprint": "Viy7U4n4UoLAcY9MVrdVqDFdXt0=",
                "cvc_check": "unknown",
                "avs_check": "unknown"
            },
            "status": "VERIFIED",
            "created_at": "2020-06-28T10:04:10+0000",
            "updated_at": "2020-06-28T10:04:10+0000"
        },
        "status": "CAPTURE_REQUIRED",
        "provider_original_response_code": "00",
        "authorization_code": "647902",
        "captured_amount": 1.0,
        "refunded_amount": 0,
        "created_at": "2020-06-28T10:04:10+0000",
        "updated_at": "2020-06-28T10:04:18+0000",
        "authentication_data": {
            "ds_data": {},
            "fraud_data": {
                "action": "ACCEPT",
                "score": "-1"
            },
            "avs_result": "U",
            "cvc_result": "U"
        }
    },
    "created_at": "2020-06-28T10:04:08+0000",
    "updated_at": "2020-06-28T10:04:14+0000"
}

We will also send you a notification in case the capture has failed or succeeded. Make sure to subscribe to it.