POST
/
v2
/
payment-intents
Authorization
Body
curl --request POST \
  --url https://api.senddotssandbox.com/api/v2/payment-intents \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 0,
  "currency": "<currency>"
}'
{
  "amount": "integer",
  "client_secret": "string",
  "currency": "usd",
  "id": "string",
  "metadata": "object",
  "payment_method_id": "string",
  "status": "initialized",
  "transfer_id": "string",
  "user_id": "string"
}

Authorizations

Authorizationheaderrequired
string

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
amountrequired
integer

Amount in cents

application_fee_amount
integer

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

confirm
Default: false
boolean

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

currencyrequired
enum<string>

Currency of the payment. Currently only usd is supported.

Available options:
usd
customer_id
string

ID of a Dots payment_customer making this payment.

description
string

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

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.

payment_method_id
string

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

payment_method_types
enum<string>[]

Currently only card is supported.

Available options:
card
setup_future_usage
enum<string>
Available options:
on_session
transfer_data
object
user_id
string

ID of a Dots user making this payment.

Response

200 - application/json
amountrequired
integer

Amount in cents

client_secret
string

Only availble on payment intent creation.

currencyrequired
enum<string>
Available options:
usd
idrequired
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.

payment_method_id
string
status
enum<string>
Available options:
initialized,
created,
requires_payment_method,
requires_confirmation,
requires_action,
processing,
succeeded,
requires_capture,
canceled,
failed
transfer_id
string
user_id
string
List all Payment CustomersRetrieve a Payment Intent