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/AU2UkcVZU94rNqonfcLGZRSJ \
-H "Content-Type: application/vnd.json+api" \
-H 'Finix-Version:2022-02-01' \
-u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
-X PUT \
-d '
{
"void_me": true
}'
Example Response:
{
"id" : "AU2UkcVZU94rNqonfcLGZRSJ",
"application" : "APgPDQrLD52TYvqazjHJJchM",
"amount" : 100,
"tags" : {
"order_number" : "21DFASJSAKAS"
},
"state" : "SUCCEEDED",
"currency" : "USD",
"transfer" : null,
"messages" : [ ],
"raw" : null,
"created_at" : "2022-01-27T07:37:28.10Z",
"updated_at" : "2022-01-27T07:37:29.15Z",
"trace_id" : "710b6745-c424-4101-84e5-4a49cf317dc7",
"source" : "PIe2YvpcjvoVJ6PzoRPBK137",
"merchant_identity" : "IDpYDM7J9n57q849o9E9yNrG",
"3ds_redirect_url" : null,
"is_void" : true,
"void_state" : "PENDING",
"expires_at" : "2022-02-03T07:37:28.10Z",
"idempotency_id" : null,
"_links" : {
"self" : {
"href" : "https://finix.sandbox-payments-api.com/authorizations/AU2UkcVZU94rNqonfcLGZRSJ"
},
"application" : {
"href" : "https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"
},
"merchant_identity" : {
"href" : "https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG"
}
}
}
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 |