Deprecated API Reference
This API Reference is being deprecated. Please use the New API Reference.
Capture an Authorization
If successfully captured, the Transfer
field of the Authorization
will contain the ID for the corresponding Transfer
resource.
By default, Transfers
are in a PENDING state. The PENDING state means the system hasn't submitted the capture request yet. Capture requests are submitted via batch request. Once submitted, the state of the Transfer
will update to SUCCEEDED.
curl https://finix.sandbox-payments-api.com/authorizations/AUvAZfiEH7irXZf49P7o8P1r \
-H "Content-Type: application/json" \
-H 'Finix-Version: 2022-02-01' \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
-X PUT \
-d '
{
"capture_amount": 100,
"fee": 0
}'
Example Response:
{
"id" : "AUbrumLihwhdLixtbU1mfMiF",
"created_at" : "2022-10-06T20:22:42.25Z",
"updated_at" : "2022-10-07T17:09:22.85Z",
"3ds_redirect_url" : null,
"additional_buyer_charges" : null,
"additional_healthcare_data" : null,
"address_verification" : "POSTAL_CODE_AND_STREET_MATCH",
"amount" : 118,
"amount_requested" : 118,
"application" : "APgPDQrLD52TYvqazjHJJchM",
"currency" : "USD",
"expires_at" : "2022-10-13T20:22:42.25Z",
"failure_code" : null,
"failure_message" : null,
"idempotency_id" : null,
"is_void" : false,
"merchant_identity" : "IDuqZpDw28f2KK6YuDk4jNLg",
"messages" : [ ],
"raw" : null,
"security_code_verification" : "MATCHED",
"source" : "PIe2YvpcjvoVJ6PzoRPBK137",
"state" : "SUCCEEDED",
"tags" : {
"test_key_101" : "test_val_101"
},
"trace_id" : "2724719e-6cc4-4cba-a859-2e6ac0bffb9b",
"transfer" : "TRs6APHuUAvSYq2FfTDkb5d8",
"void_state" : "UNATTEMPTED",
"_links" : {
"self" : {
"href" : "https://finix.sandbox-payments-api.com/authorizations/AUbrumLihwhdLixtbU1mfMiF"
},
"application" : {
"href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
},
"transfer" : {
"href" : "https://finix.sandbox-payments-api.com/transfers/TRs6APHuUAvSYq2FfTDkb5d8"
},
"merchant_identity" : {
"href" : "https://finix.sandbox-payments-api.com/identities/IDuqZpDw28f2KK6YuDk4jNLg"
}
}
}
HTTP Request
PUT https://finix.sandbox-payments-api.com/authorizations/:AUTHORIZATION_ID
URL Parameters
Parameter |
Description |
---|---|
:AUTHORIZATION_ID | ID of the Authorization |
Request Arguments
Field | Type | Description |
---|---|---|
capture_amount |
integer, required | The amount of the Authorization you would like to capture in cents. Must be less than or equal to the amount of the Authorization |
fee |
integer, optional | Amount of the captured Authorization you would like to collect as your fee. Must be less than or equal to the amount |