POST
/
payouts
curl --request POST \
  --url https://api.sulu.sh/v0/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "organizationId": "<string>",
  "description": "<string>",
  "amountInCents": 123,
  "currency": "<string>",
  "method": "bank_transfer",
  "sourceId": "<string>",
  "destinationId": "<string>",
  "metadata": {}
}'
{
  "id": "<string>",
  "object": "payout",
  "organizationId": "<string>",
  "status": "pending",
  "description": "<string>",
  "amountInCents": 123,
  "currency": "<string>",
  "method": "bank_transfer",
  "sourceId": "<string>",
  "destinationId": "<string>",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "platformFee": 123,
  "methodFee": 123,
  "transactionId": "<string>",
  "failureCode": "<string>",
  "failureMessage": "<string>",
  "transferredAmountInCents": 123
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
organizationId
string
required

Unique identifier for an organization

​
amountInCents
integer
required

Amount requested to be transferred in cents.

​
currency
string
required

3-letter currency code.

​
method
enum<string>
required

Method of payout.

Available options:
bank_transfer
​
sourceId
string
required

ID of the source (wallet, etc).

​
destinationId
string
required

ID of the destination (bank account, card, etc).

​
description
string

Description of the payout.

​
metadata
object

Response

201
application/json
Payout created successfully
​
id
string

Unique identifier for the payout.

​
object
enum<string>

Type of the object

Available options:
payout
​
organizationId
string

Organization ID

​
status
enum<string>

Current status of the payout

Available options:
pending,
success,
failed,
cancelled
​
description
string

Description of the payout

​
amountInCents
integer

Amount in cents

​
currency
string

3-letter currency code

​
method
enum<string>

Method of payout.

Available options:
bank_transfer
​
sourceId
string

ID of the source (wallet, etc)

​
destinationId
string

ID of the destination (bank account, card, etc)

​
metadata
object

Key-value pairs for storing additional data related to the merchant.

​
createdAt
string

Timestamp when the payout was created

​
updatedAt
string

Timestamp when the payout was last updated

​
platformFee
integer

Platform fee in cents

​
methodFee
integer

Method fee in cents

​
transactionId
string

Transaction ID

​
failureCode
string

Failure code

​
failureMessage
string

Failure message

​
transferredAmountInCents
integer

Final amount in cents that was transferred