Sign in
payment_intents

Create Payment Intent

post/v2/payment_intents/

Request body

descriptionstring
amountinteger required
currency'eur' | 'aud' | 'cad' | 'chf' | 'dkk' | 'gbp' | 'nok' | 'pln' | 'sek' | 'usd'
customerstring
order_idstring binary
methods_allowedPaymentMethod[]
cardstring
sepastring
{"stackTrail":"components:schemas:PaymentIntentCreate:properties:metadata","oasType":"schema","type":"unknown","title":"Metadata"}
return_urlstring uri
threeds'required' | 'none'

An enumeration.

date_settlementstring date
billing_addressstring

Billing address ID

shipping_addressstring

Shipping address ID

captureboolean

Example request

{
  "customer": "cust_yWYfCSzsUUhr9KwMv7vuLZHX",
  "card": "card_yWYfCSzsUUhr9KwMv7vuLZHX",
  "sepa": "sepa_yWYfCSzsUUhr9KwMv7vuLZHX",
  "billing_address": "addr_yWYfCSzsUUhr9KwMv7vuLZHX",
  "shipping_address": "addr_yWYfCSzsUUhr9KwMv7vuLZHX"
}

Response

Successful Response

idstring required
customerstring
paymentstring
methods_allowedPaymentMethod[]
order_idstring binary
cardstring
sepastring
amountinteger required
currency'eur' | 'aud' | 'cad' | 'chf' | 'dkk' | 'gbp' | 'nok' | 'pln' | 'sek' | 'usd' required
descriptionstring
status'require_payment_method' | 'require_authentication' | 'require_authorization' | 'authorized' | 'processing' | 'captured' | 'canceled' | 'unpaid' required

An enumeration.

{"stackTrail":"components:schemas:PaymentIntentOut:properties:metadata","oasType":"schema","type":"unknown","title":"Metadata"}
urlstring uri required

Payment page url

threeds'required' | 'none' required

An enumeration.

return_urlstring uri
created_atstring date-time required
date_settlementstring date
origin1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 required

An enumeration.

billing_addressstring

Billing address ID

shipping_addressstring

Shipping address ID

captureboolean

Example response

{
  "id": "pi_yWYfCSzsUUhr9KwMv7vuLZHX",
  "customer": "cust_yWYfCSzsUUhr9KwMv7vuLZHX",
  "payment": "paym_yWYfCSzsUUhr9KwMv7vuLZHX",
  "card": "card_yWYfCSzsUUhr9KwMv7vuLZHX",
  "sepa": "sepa_yWYfCSzsUUhr9KwMv7vuLZHX",
  "billing_address": "addr_yWYfCSzsUUhr9KwMv7vuLZHX",
  "shipping_address": "addr_yWYfCSzsUUhr9KwMv7vuLZHX"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.