Skip to main content
POST
Create typed data for payments

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-idempotency-key
string
required

Required. A key you generate for each request (1–255 characters). Send the same key on the create (POST) and execute (PUT) of that request, including retries, so a retry is not applied twice. Use a new key for each new request.

Required string length: 1 - 255

Body

application/json
from
string<starts_with>
required

Identifier of a Rise team (a workspace below a company). 15-character nanoid prefixed with te-.

Required string length: 15
Pattern: ^te-.*
to
object[]
required
pay_now
boolean
required

true: the payment is created and executed immediately. false: the payment is created as an intent and is not processed straight away — it must be approved by a user with payment execution permission before it is sent.

network
enum<string>
default:arbitrum

Optional. Defaults to arbitrum, currently the only supported network, so you can leave it out.

Available options:
arbitrum

Response

Default Response

success
enum<boolean>
required
Available options:
true
data
object
required