Skip to main content
POST
Fund a user's balance
Creates a link the user pays in their own browser. Verify their phone first. A deposit that shows as processing is already on the way, so never ask the user to pay again.

Authorizations

Authorization
string
header
required

A platform access token. Get one on the Create an access token endpoint by exchanging your client_id + client_secret, then send it as Authorization: Bearer <token>. Tokens live one hour.

Body

application/json
user_id
string
required

The connected user.

amount_cents
integer
required

What the user should receive, in cents.

payment_method
enum<string>
default:apple_pay

apple_pay or google_pay.

Available options:
apple_pay,
google_pay

Response

The funding session.

object
enum<string>
required

Always funding_session.

Available options:
funding_session
id
string
required

The session's id.

user_id
string
required

The connected user.

status
string
required

Where the payment stands: pending, processing, completed, failed or expired.

amount_cents
integer
required

What the user receives.

livemode
boolean

false on a sandbox user.

currency
string

USD.

payment_method
string

apple_pay or google_pay.

checkout_url
string | null

The link the user pays. Null in sandbox.

expires_at
string<date-time>

When the link stops working.