POST
/
payouts
curl --request POST \
  --url https://api.monime.io/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
  },
  "destination": {
    "providerCode": "m17",
    "accountId": "+23278000000"
  },
  "source": {
    "financialAccountId": "<string>"
  },
  "metadata": {}
}'
{
  "success": true,
  "messages": [
    "<any>"
  ],
  "result": {
    "id": "<string>",
    "status": "pending",
    "amount": {
      "currency": "<string>",
      "value": 123
    },
    "source": {
      "financialAccountId": "<string>",
      "transactionReference": "<string>"
    },
    "destination": {
      "providerCode": "<string>",
      "accountId": "<string>",
      "transactionReference": "<string>"
    },
    "charges": [
      {
        "name": "<string>",
        "amount": {
          "currency": "<string>",
          "value": 123
        },
        "metadata": {}
      }
    ],
    "delayedReason": "<string>",
    "failureDetail": {
      "code": "unknown",
      "explanation": "<string>"
    },
    "createTime": "2023-11-07T05:31:56Z",
    "metadata": {}
  }
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Monime-Space-Id
string
required

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

Maximum length: 100
​
Idempotency-Key
string
required

This header is used to uniquely identify a request, ensuring that the operation is not performed more than once during retries.

Maximum length: 64

Body

application/json

Response

200 - application/json

OK

The response is of type object.