Skip to main content
POST
/
{version}
/
executions
/
payout
Payout
curl --request POST \
  --url https://api.example.com/{version}/executions/payout \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "session_id": "<string>",
  "payout_account_id": "<string>",
  "reference_id": "<string>",
  "passcode": {
    "token": {
      "code": "<string>",
      "user_id": "<string>",
      "phone": "<string>"
    },
    "device": {
      "name": "<string>",
      "type": "<string>",
      "platform": "<string>",
      "user_agent": "<string>",
      "client_ip": "<string>"
    }
  }
}
'
{
  "reference_id": "<string>",
  "status": "<string>",
  "payer_amount": 123,
  "payer_currency": "<string>",
  "payee_currency": "<string>",
  "payee_amount": 123,
  "operation_type": "<string>",
  "provider_transaction_id": "<string>",
  "gateway_message": "<string>",
  "wallet_message": "<string>",
  "client_secret": "<string>",
  "requires_action": true
}

Authorizations

Authorization
string
header
required

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

Path Parameters

version
string
required
Allowed value: "v1"

Body

application/json

PayoutExecutionPayload

session_id
string
required
payout_account_id
string
required
reference_id
string
required

A version-4 UUID (e.g. 550e8400-e29b-41d4-a716-446655440000)

passcode
DollrPaymentModelsWithDeviceVerifyPasscodePayloadWithDeviceVerifyPasscodePayload · object
required

WithDeviceVerifyPasscodePayload

Response

Successful Response

ExecutionResponse

reference_id
string
required
status
string
required
payer_amount
required
payer_currency
string
required
payee_currency
string
required
payee_amount
required
operation_type
string
required
provider_transaction_id
string | null
gateway_message
string | null
wallet_message
string | null
client_secret
string | null
requires_action
boolean | null
Last modified on June 23, 2026