Preauthorization

Create Reservations With Payrexx API

In our API, you can process preauthorizations with the Gateway or the Paylink endpoint.
We will explain it using the Gateway endpoint for this example. However, the links to the corresponding Paylink API endpoints are also attached.

Step 1
Gateway Creation

Create a Gateway with the parameter Reservation set to true.

Create a Gateway
Create a Paylink
All the required fields of the gateway must always be set!

Make sure that there are payment provider activated in your Payrexx account which support preauthorizations .
Click here to find out which payment provider can be used for preauthorizations

Step 2
Customer authorization

After creating your Gateway you will get a link to the payment form as a response to your request.
Send this to your customer and let him authorize the payment.
A Notifications (Webhooks) and an email notification will be triggered once the customer authorized the payment.

Step 3
Get the transaction ID

This ID is provided when you retrieve the Gateway from Step 1

Retrieve a Gateway
Retrieve a Paylink

You can find this ID also in the webhook which is sent once the transaction is authorized Step 2

Example on where the Transaction ID can be found:

{
    "status": "success",
    "data": [
        {
            "id": 1,
            "status": "(waiting|confirmed|authorized|reserved)",
            "invoices": [
                {
                    "transactions": [
                        {
                            "id": 2012844,
                        }
                    ],
                }
            ],
        }
    ]
}

Step 4
Charge the customers card

Use Charge a Pre-Authorized/Reserved Transaction to make a charge on the authorized transaction. Use here the transaction ID which you got in Step 3 and any amount you want to charge.

Information
You can charge any lower amount but no higher one as set in Step 1.
The amount is reserved for 2-3 working days and the possiblity to debit the amount is guaranteed.

There is no possibility to make further charges using this authorized transaction.

Updated 7 months ago

Preauthorization


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.