Skip to main content
POST
/
v1
/
payouts
Create Payout
curl --request POST \
  --url https://api.monime.io/v1/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'Monime-Space-Id: <monime-space-id>' \
  --data '{
  "amount": {
    "currency": "<string>",
    "value": 123
  },
  "source": {
    "financialAccountId": "<string>"
  },
  "destination": {
    "type": "bank",
    "providerId": "slb001",
    "accountNumber": "<string>"
  },
  "metadata": {}
}'
{
  "success": true,
  "messages": [
    "<any>"
  ],
  "result": {
    "id": "<string>",
    "status": "pending",
    "amount": {
      "currency": "<string>",
      "value": 123
    },
    "source": {
      "financialAccountId": "<string>",
      "transactionReference": "<string>"
    },
    "destination": {
      "type": "bank",
      "providerId": "slb001",
      "accountNumber": "<string>",
      "transactionReference": "<string>"
    },
    "fees": [
      {
        "code": "<string>",
        "amount": {
          "currency": "<string>",
          "value": 123
        },
        "metadata": {}
      }
    ],
    "failureDetail": {
      "code": "unknown",
      "message": "<string>"
    },
    "createTime": "2023-11-07T05:31:56Z",
    "updateTime": "2023-11-07T05:31:56Z",
    "ownershipGraph": {
      "owner": {
        "id": "<string>",
        "type": "<string>",
        "metadata": {},
        "owner": {
          "id": "<string>",
          "type": "<string>",
          "metadata": {},
          "owner": {}
        }
      }
    },
    "metadata": {}
  }
}

Authorizations

​
Authorization
string
header
required

Bearer HTTP authentication specified with the header Authorization: Bearer <access_token>

Headers

​
Idempotency-Key
string
required

This header is used to uniquely identify a logical request, ensuring that it is not processed more than once during retries.

Maximum length: 64
​
Monime-Version
enum<string> | null

Specifies which version of the Monime API will handle this request.

Available options:
caph.2025-08-23,
caph.2025-06-20
​
Monime-Space-Id
string
required

The value is the tenancy parameter that Monime uses to determine which space the request is intended for.

Maximum length: 64

Body

application/json

Creates a new payout with a specified amount, destination, and optional source account.

​
amount
object
required

The amount to be paid out to the destination account.

​
destination
object
required

Information about the destination account that will receive the payout.

  • Bank
  • Mobile Money
  • Digital Wallet
​
source
object | null

Optional details of the source account to be debited. If omitted, the default 'main' account is used.

​
metadata
object | null

Optional metadata to associate additional business context with the payout.

Response

200 - application/json

OK

​
success
boolean

Represents the status of the query operation, confirming if it was successful. This field is always true

​
messages
any[]

Contains a list of messages providing relevant information or feedback related to the query or operation

​
result
object

A Payout is a disbursement of funds from a Financial Account to a designated destination such as a Bank Account or Mobile Money Wallet.
It represents outbound money flows and is commonly used for salary disbursements, vendor payments, and refunds in automated workflows.

Each payout records the amount, the source account, the destination details, and optional metadata.
It also tracks status changes throughout its lifecycle and may include provider-specific references for reconciliation.

⌘I