PATCH
/
payouts
/
{id}
curl --request PATCH \
  --url https://api.monime.io/payouts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Monime-Space-Id: <monime-space-id>' \
  --data '{
  "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

Path Parameters

​
id
string
required

The ID for the payout object to update

Body

application/json
​
metadata
object | null

Metadata attributes of 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

Was this page helpful?

Suggest editsRaise issue