Authorization API (v1)
Authorize a payment by securing funds for a transaction without capturing them immediately.
Key Points
-
The Authorization API secures the specified amount on the customer’s payment method, but the funds are not transferred until a capture is performed.
-
Capture: Finalizes the transaction by transferring the authorized funds from the customer’s account.
-
Void: Cancels the authorization, releasing the held funds back to the customer.
-
Use cases for this API include scenarios where the exact final amount may vary, such as hotel bookings, car rentals, or pre-order situations.
Flow diagram
Api Parameters
Authorizations
API Key for Authorization. Format: 'Basic YOUR_API_KEY_HERE'
API Key specific to x-api-key.
Body
The request payload to authorize a payment transaction.
The body is of type object
.
Response
Payment authorized successfully
The response is of type object
.