Dots home pagelight logo
  1. Payment Intents
  2. Create a Payment Intent
POST

/api/v2/payment-intents

client_id*
api_key*
curl --request POST \
     --url https://api.senddotssandbox.com/api/v2/payment-intents \
     --header 'Authorization: Basic AUTH_VALUE' \
     --header 'Content-Type: application/json' \
     --data '{
 "amount": integer,
 "currency": "string"
}'

​
Body

amountRequired
integer

Amount in cents

currencyRequired
string

Currency of the payment. Currently only usd is supported.

Available options: usd
confirm
boolean

Set to true to attempt to confirm this payment intent immediately. Defaults to false.

user_id
string

ID of a Dots user making this payment.

description
string

An arbitrary string attached to the object. Often useful for displaying to users.

payment_method_id
string

ID of the payment method to attach to this payment intent.

payment_method_types
string[]

Currently only card is supported.

setup_future_usage
string
Available options: on_session
metadata
boolean

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

transfer_data
object
application_fee_amount
integer

Amount in cents to transfer to the application's wallet as a platform fee.

​
Response

idRequired
string
amountRequired
integer

Amount in cents

currencyRequired
string
Available options: usd
user_id
string
status
string
Available options: initialized, created, requires_payment_method, requires_confirmation, requires_action, processing, succeeded, requires_capture, canceled, failed
transfer_id
string
payment_method_id
string
metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

client_secret
string

Only availble on payment intent creation.