Skip to main content
Create Direct Payment

Authorizations

Authorization
string
header
required

Authorization header containing an SDP JWT (ES256) or an SDP_ API key.

Headers

X-Wallet-Id
string

Names the distribution account this request acts on. Required when the tenant has more than one active account. With a single active account, or an API key scoped to exactly one account, it may be omitted.

Body

application/json
amount
string
required

The payment amount

asset
object
required

Asset reference - specify either id or type with required fields

receiver
object
required

Receiver reference - specify exactly one identifier

wallet
object
required

Wallet reference - specify either id or address

external_payment_id
string

Optional external payment identifier

Response

Direct payment created successfully

id
string
Example:

"ddf22f55-3259-4822-a4e2-ce01334997f4"

amount
string

The amount of the payment

Example:

"100.00"

stellar_transaction_id
string

The ID of the transaction in the Stellar network. It can be used to track the payment in the Stellar network using Stellar Laboratory, or StellarExpert.

Example:

"0b339d1c89d314186b8147c2af4c9a9ed5bbdbcd7ada8d138633907649b"

circle_transaction_id
string

The Circle transaction ID. It is only present when the payment was made using Circle.

Example:

"74a68b6a-3f67-424b-b8b0-e593a19d7463"

circle_transaction_type
enum<string>

Which Circle API the payment went through. It is only present when the payment was made using Circle.

Available options:
PAYOUT,
TRANSFER
Example:

"TRANSFER"

stellar_operation_id
string
source_wallet_id
string

ID of the distribution account the payment was sent from.

Example:

"4c379f5e-09b5-4472-a286-b84e249a1512"

status
enum<string>

The status of the payment

Available options:
DRAFT,
READY,
PENDING,
PAUSED,
SUCCESS,
FAILED,
CANCELED
status_history
object[]

An aggregated list of metadata objects containing the statuses and the timestamp of when these status changes occurred.

type
enum<string>

The type of the payment.

Available options:
DISBURSEMENT,
DIRECT
disbursement
object
asset
object

The Stellar asset object

receiver_wallet
object
external_payment_id
string

Optional external payment identifier provided by the client.

Example:

"payment-001"

created_at
string<date-time>
Example:

"2023-02-03T10:45:51Z"

updated_at
string<date-time>
Example:

"2023-02-03T10:45:51Z"