Skip to content
Xaalis

Send money from your balance to a mobile wallet

POST
/v1/payouts
curl --request POST \
  --url http://localhost:4000/v1/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: example' \
  --data '{ "amount": 15000, "currency": "XOF", "provider": "wave", "recipient": { "phone": "+221771234567", "name": "example" }, "client_reference": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters”
idempotency-key
required

Required retry-safe key; reuse it only for the same operation and request body

string
>= 1 characters <= 255 characters

Required retry-safe key; reuse it only for the same operation and request body

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
amount
required

Integer XOF

integer
> 0 <= 100000000
Example
15000
currency
string
default: XOF
Allowed values: XOF
provider
required
string
Allowed values: wave orange_money
recipient
required
object
phone
required
string
/^\+2217[0-9]{8}$/
Example
+221771234567
name
string
<= 100 characters
client_reference
string
<= 100 characters

Responses

Section titled “ Responses ”

201

Section titled “201”

Payout created

Media typeapplication/json
object
id
required
string
object
required
string
Allowed values: payout
agent_wallet_id
required
string | null
livemode
required
boolean
amount
required
integer
fee
required
integer
currency
required
string
provider
required
string
Allowed values: wave orange_money mock
status
required
string
Allowed values: pending processing succeeded failed
recipient
required
object
phone
required
string
name
required
string | null
client_reference
required
string | null
failure_reason
required
string | null
created_at
required
string
updated_at
required
string
Example
{
  "object": "payout",
  "provider": "wave",
  "status": "pending"
}

400

Section titled “400”

Validation error

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

401

Section titled “401”

Authentication error

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

404

Section titled “404”

Not found

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

422

Section titled “422”

Insufficient funds / unsupported

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

429

Section titled “429”

Rate limited; see Retry-After response header

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

503

Section titled “503”

Ledger reservation temporarily unavailable

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}