Skip to main content
POST
Create a payment route

Authorizations

Api-Key
string
header
required

Body

application/json

Payment route configuration

source
Crypto Source ยท object
required

Crypto source configuration

destination
Onchain Destination ยท object
required

Onchain destination with direct address

userId
string<uuid>

User ID (for individual teams; provide either userId or companyId)

companyId
string<uuid>

Company ID (for company teams; provide either userId or companyId)

refundAddress
string

The address to refund funds to. Required when source is a crypto rail.

Pattern: ^(0x[a-fA-F0-9]{40}|T[1-9A-HJ-NP-Za-km-z]{31,43}|[1-9A-HJ-NP-Za-km-z]{32,44}|[GC][A-Z2-7]{55}|M[A-Z2-7]{68})$
senderFees
object[]

Optional array of sender fee configurations. Each fee is applied to transfers processed by this automation. Requires sender fees to be enabled for your account.

developerFees
object[]
deprecated

Deprecated: use senderFees instead. Still accepted for backward compatibility. If both are provided, senderFees takes precedence.

Response

Successful operation

id
string<uuid>
required

The unique identifier of the payment route

status
enum<string>
required

Status of the payment route

Available options:
active,
frozen,
deleted
source
Crypto Source ยท object
required

Crypto source configuration

destination
Onchain Destination ยท object
required

Onchain destination with direct address

depositAddress
Fiat Deposit Address ยท object
required

The deposit address for funds to be sent to this payment route

createdAt
string<date-time>
required

When the payment route was created

updatedAt
string<date-time>
required

When the payment route was last updated

userId
string<uuid>

User ID (present for individual teams; omit for company teams)

companyId
string<uuid>

Company ID (present for company teams; omit for individual teams)

refundAddress
string

The onchain address where funds are returned if a transaction cannot be completed. Present when the source is a crypto rail.

senderFees
object[]

Array of sender fee configurations for this payment route. Present when sender fees are configured.

developerFees
object[]
deprecated

Deprecated: use senderFees instead. Returns the same values as senderFees for backward compatibility.