Skip to main content

Preauthorize

We are improving our documentation

We're currently working on improving this page to provide you with the best possible experience. Please bear with us while we make some changes.

Thank you for your patience!

A Preauthorize reserves the payment amount on the customer's payment instrument.

Depending on the payment method you have up to 7 days until you must Capture the transaction before the authorization expires.

POST /transaction/{apiKey}/preauthorize

Path parameters

NameTypeRequiredDescription
apiKeystringtrueAPI Key of Connector
Request body example
{
"cardData": {
"cardHolder": "Alex Smith",
"pan": "4111111111111111",
"cvv": "123",
"expirationMonth": "5",
"expirationYear": "2029"
},
"merchantTransactionId": "your-unique-identifier",
"merchantMetaData": "my-category-1",
"amount": "9.99",
"currency": "EUR",
"successUrl": "https://shop.example.org/checkout/success",
"cancelUrl": "https://shop.example.org/checkout/cancelled",
"errorUrl": "https://shop.example.org/checkout/error",
"callbackUrl": "https://api.example.org/callback",
"description": "Purchase description shown on credit card statement.",
"withRegister": false,
"transactionIndicator": "SINGLE",
"customer": {
"identification": "616c6578-2e73-6d69-7468-406578616d70",
"firstName": "Alex",
"lastName": "Smith",
"billingCountry": "US",
"email": "[email protected]",
"ipAddress": "198.51.100.123"
}
}