Deprecated API Reference
This API Reference is being deprecated. Please use the New API Reference.
Void an Authorization
Void an Authorization
to release funds and stop a transaction from completing. If an Authorization
is voided, it can no longer be captured.
curl https://finix.sandbox-payments-api.com/authorizations/AUeYYckKJTrBVu1j8FYLzJ3W \
-H "Content-Type: application/json" \
-H 'Finix-Version: 2022-02-01' \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
-X PUT \
-d '
{
"void_me": true
}'
Example Response:
{
"id" : "AUeYYckKJTrBVu1j8FYLzJ3W",
"created_at" : "2022-10-07T18:25:23.30Z",
"updated_at" : "2022-10-07T18:29:59.38Z",
"3ds_redirect_url" : null,
"additional_buyer_charges" : null,
"additional_healthcare_data" : null,
"address_verification" : "POSTAL_CODE_AND_STREET_MATCH",
"amount" : 100,
"amount_requested" : 100,
"application" : "APgPDQrLD52TYvqazjHJJchM",
"currency" : "USD",
"expires_at" : "2022-10-14T18:25:23.30Z",
"failure_code" : null,
"failure_message" : null,
"idempotency_id" : null,
"is_void" : true,
"merchant_identity" : "IDuqZpDw28f2KK6YuDk4jNLg",
"messages" : [ ],
"raw" : null,
"security_code_verification" : "MATCHED",
"source" : "PIe2YvpcjvoVJ6PzoRPBK137",
"state" : "SUCCEEDED",
"tags" : {
"order_number" : "21DFASJSAKAS"
},
"trace_id" : "560e44af-5d22-4af2-801e-03d2dad69dc7",
"transfer" : null,
"void_state" : "PENDING",
"_links" : {
"self" : {
"href" : "https://finix.sandbox-payments-api.com/authorizations/AUeYYckKJTrBVu1j8FYLzJ3W"
},
"application" : {
"href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
},
"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 |
---|---|---|
void_me |
boolean, required | Set to True to void the Authorization |