Authorize a payment

Authorize a payment and charge your customer later.

About authorization

You can reserve an amount on your customer’s account, and then charge that amount at a later date.

Payment service providers guarantee the authorized amount for up to 7 days.

Supported payment methods

The following payment methods support authorization:

Authorize a payment

To authorize a payment, follow the steps below.

When testing, do not use real customer data. Use the test data prepared by Unzer.

Step 1: Authorize an amount

To authorize an amount, make a POST call to payments/authorize, with the following parameters in the request body:

Parameter	Required	Type	Default	Description	Example
`amount`	Yes	Float	`/`	The authorization amount.	`100`
`currency`	Yes	String	`/`	The authorization currency, in the ISO 4217 alpha-3 format.	`EUR`
`returnUrl`	Yes	String	`/`	Needed for redirect payments and credit card payments if 3-D Secure is used.	`https://www.unzer.com`
`customerId`	No	String	`/`	The ID of the `customers` resource to be used.	`s-cst-3a0daffe47cb`
`typeId`	Yes	String	`/`	The ID of the payment type resource to be used.	`s-crd-fm7tifzkqewy`
`orderId`	No	String	`/`	The order ID that identifies the payment on the merchant side.	`123460`
`invoiceId`	No	String	`/`	The invoice ID that is assigned to the payment on merchant side.	`inv_12360`

POST https://api.unzer.com/v1/payments/authorize
{
  "amount" : "100",
  "currency" : "EUR",
  "returnUrl": "https://www.unzer.com",
     "paymentReference":"Shop XYZ says Thank you",
  "resources" : {
    "typeId" : "{{payment_method_id}}"
  },
    "orderId" : "123460",
    "invoiceId" : "inv_12360"
}

{
    "id": "s-aut-1",
    "isSuccess": true,
    "isPending": false,
    "isError": false,
    "card3ds": false,
    "redirectUrl": "",
    "message": {
        "code": "COR.000.100.112",
        "merchant": "Request successfully processed in 'Merchant in Connector Test Mode'",
        "customer": "Your payments have been successfully processed in sandbox mode."
    },
    "amount": "100.0000",
    "currency": "EUR",
    "returnUrl": "https://www.unzer.com",
    "date": "2021-11-29 11:18:26",
    "resources": {
        "paymentId": "s-pay-151067",
        "traceId": "65856079285898f6650e1411333bdd63",
        "typeId": "s-crd-6gwiclnlsa2u"
    },
    "orderId": "123460",
    "invoiceId": "inv_12360",
    "paymentReference": "Shop XYZ says Thank you",
    "processing": {
        "uniqueId": "31HA07BC816F54F58AF20172A6961C43",
        "shortId": "5021.1110.6219",
        "traceId": "65856079285898f6650e1411333bdd63"
    }
}

Property	Type	Description
`id`	String	The authorization’s unique ID.
`isSuccess`	Boolean	Set to `true` if the transaction was successful.
`isPending`	Boolean	Set to `true` if the transaction is pending (e.g. if a redirect to an external system is required).
`isError`	Boolean	Set to `true` if an error occurs.
`card3ds`	Boolean	Only for the card payment method: if set to `true`, the card is configured with the 3-D Secure protocol enabled.
`message`	String	An error message describing the error in more detail.
`code`	String	A unique ID of the message. For details, go to Error `code` structure.
`merchant`	String	Message displayed to the merchant.
`customer`	String	Message displayed to the customer.
`amount`	Number	The authorization amount.
`currency`	String	The authorization currency, in the ISO 4217 alpha-3 format.
`returnUrl`	String	The URL to redirect the customer to after the payment is completed.
`paymentReference`	String	Additional description of the transaction.
`date`	String	Date and time of the transaction.
`paymentId`	String	The ID of the related payment resource.
`typeId`	String	The ID of the related payment type resource.
`orderId`	String	The order ID for the transaction.
`invoiceId`	String	The invoice ID for the transaction.
`uniqueId`	String	The ID of the transaction process.
`shortId`	String	The short ID of the transaction process.

Step 2: Charge the authorized amount

To charge the authorized amount, make a POST call to payments/{authorization_ID}/charges, with an empty request body:

POST https://api.unzer.com/v1/payments/s-aut-1/charges