Adjust an estimated authorization
Last updated: June 28, 2023
If you've performed an estimated authorization, you can request an incremental authorization to either increase the original authorization amount (Visa and Mastercard), or increase the authorization's validity period (Mastercard only).
For example, a car rental agency may need to increase the authorization amount when a vehicle is returned due to additional fees.
Information
Mastercard refers to estimated authorizations as 'preauthorizations'.
An incremental authorization increases the original authorization amount by the amount you specify in the request. The final authorization amount will be the sum of the estimated authorization and all subsequent incremental authorizations.
Note
You cannot perform an incremental authorization after an authorization in which you passed "authorization_type": "Final"
in the request.
You can perform any number of incremental authorizations within the estimated authorization's validity period. However, you cannot perform any further incremental authorizations once you have fully or partially captured the payment.
Call the following endpoint with the payment id
returned in the original authorization's response:
post
https://api.checkout.com/payments/{id}/authorizations
1{2"amount": 100,3"reference": "ORD-5023-4E89",4"metadata": {5"partner_id": 1239896}7}
1{2"action_id": "act_oqpt7d4wacaexa7aoupddxlvtm",3"amount": 100,4"currency": "USD",5"approved": true,6"auth_code": "410961",7"scheme_id": "168679383391401",8"response_code": "10000",9"response_summary": "Approved",10"risk": {11"flagged": false12},13"reference": "ORD-5023-4E89",14"processed_on": "2023-06-21T17:17:25.4737666Z",15"processing": {16"acquirer_transaction_id": "900604935930035384724",17"retrieval_reference_number": "444143809558"18},19"balances": {20"total_authorized": 200,21"total_voided": 0,22"available_to_void": 200,23"total_captured": 0,24"available_to_capture": 200,25"total_refunded": 0,26"available_to_refund": 027},28"expires_on": "2023-06-21T17:18:53.8703087Z",29"_links": {30"self": {31"href": "https://api.checkout.com/payments/pay_slonfnum2g7evlg47zhno7ao4q"32},33"actions": {34"href": "https://api.checkout.com/payments/pay_slonfnum2g7evlg47zhno7ao4q/actions"35},36"capture": {37"href": "https://api.checkout.com/payments/pay_slonfnum2g7evlg47zhno7ao4q/captures"38},39"void": {40"href": "https://api.checkout.com/payments/pay_slonfnum2g7evlg47zhno7ao4q/voids"41},42"authorizations": {43"href": "https://api.checkout.com/payments/pay_slonfnum2g7evlg47zhno7ao4q/authorizations"44}45}46}
For Mastercard payments, you have 30 days from the date of the original estimated authorization to capture the payment.
You can perform an incremental authorization to increase the amount of time you have to capture the payment before it expires. Each incremental authorization you perform resets the 30-day expiry period.
Note
The expiry period for Visa estimated authorizations cannot be extended.
To increase the authorization's validity period, send a request with the amount
field set to 0
.
Call the following endpoint with the payment id
returned in the original authorization's response:
post
https://api.checkout.com/payments/{id}/authorizations
1{2"amount": 0,3"reference": "ORD-5023-4E89",4"metadata": {5"partner_id": 1239896}7}
1{2"action_id": "act_oqpt7d4wacaexa7aoupddxlvtm",3"amount": 0,4"currency": "USD",5"approved": true,6"auth_code": "410961",7"scheme_id": "168679383391401",8"response_code": "10000",9"response_summary": "Approved",10"risk": {11"flagged": false12},13"reference": "ORD-5023-4E89",14"processed_on": "2023-06-21T17:17:25.4737666Z",15"processing": {16"acquirer_transaction_id": "900604935930035384724",17"retrieval_reference_number": "444143809558"18},19"balances": {20"total_authorized": 100,21"total_voided": 0,22"available_to_void": 100,23"total_captured": 0,24"available_to_capture": 100,25"total_refunded": 0,26"available_to_refund": 027},28"expires_on": "2023-06-21T17:18:53.8703087Z",29"_links": {30"self": {31"href": "https://api.checkout.com/payments/pay_slonfnum2g7evlg47zhno7ao4q"32},33"actions": {34"href": "https://api.checkout.com/payments/pay_slonfnum2g7evlg47zhno7ao4q/actions"35},36"capture": {37"href": "https://api.checkout.com/payments/pay_slonfnum2g7evlg47zhno7ao4q/captures"38},39"void": {40"href": "https://api.checkout.com/payments/pay_slonfnum2g7evlg47zhno7ao4q/voids"41},42"authorizations": {43"href": "https://api.checkout.com/payments/pay_slonfnum2g7evlg47zhno7ao4q/authorizations"44}45}46}