Payment AUTH

post https://example.com/v2/payment/auth

Authorizes a payment

Body Params

Authorizes a payment from an Adyen reader or Adyen custom web component. This API endpoint is not applicable if your processor is Stripe.

external_account_id

string

required

Defaults to null

Your business/merchant/store ID that maps to the account.

payment_id

string

required

Our unique id for the payment.

card_number

string

Encrypted card data. Required when using Adyen custom card component.

card_month_exp

string

Encrypted card expiration month. Required when using Adyen custom card component.

card_year_exp

string

Encrypted card expiration year. Required when using Adyen custom card component.

card_cvv

string

Encrypted cvv. Required when using Adyen custom card component.

card_name

string

Name of the card holder on the card

terminal_id

string

The terminal id for the terminal the payment will be collected from. Required when collecting payment through a terminal.

amount

string

Optional since payment intent has the amount. Can be used to override the payment intent amount and authorize a specific amount.

external_payment_id

string

Optional since payment intent should have this ID. Your unique ID for this payment (a payment ID, transaction ID, Cart ID, etc).

dupe_protection_in_seconds

integer

Number of seconds to enable duplicate protection. After a successful terminal payment, another payment with the same amount at the same card will be blocked. Maximum value is 300. [Adyen]

client_ip_address

string

customer_account

object

shipping_address

object

billing_address

object

required

shopper_details

object

Adyen only, CNP only

src_ver

string

A string to identify which version of your software made this request.

suppress_tips

boolean

Adyen, Quilt hardware only If tipping on the terminal is enabled, it can be suppressed on this payment by passing true.

Responses

Language

Credentials

Bearer

JWT


xxxxxxxxxx
12
1
curl --request POST \
2
     --url https://example.com/v2/payment/auth \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "external_account_id": null,
8
  "customer_account": {
9
    "is_logged_in": true
10
  }
11
}
12
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Payment Auth Result

400invalid input, object invalid

401Unauthorized

409Resource is busy and cannot be used right now

422Unprocessable - usually means a configuration issue