PATCH
/
v1
/
payments
/
{id}
Patch Payment
curl --request PATCH \
  --url https://api.monime.io/v1/payments/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Monime-Space-Id: <monime-space-id>' \
  --data '{
  "name": "<string>",
  "metadata": {}
}'
{
  "success": true,
  "messages": [
    "<any>"
  ],
  "result": {
    "id": "<string>",
    "status": "pending",
    "amount": {
      "currency": "<string>",
      "value": 123
    },
    "channel": {
      "type": "bank",
      "provider": "<string>",
      "reference": "<string>",
      "accountNumber": "<string>",
      "fingerprint": "<string>",
      "metadata": {}
    },
    "name": "<string>",
    "reference": "<string>",
    "orderNumber": "<string>",
    "financialAccountId": "<string>",
    "financialTransactionReference": "<string>",
    "fees": [
      {
        "code": "<string>",
        "amount": {
          "currency": "<string>",
          "value": 123
        },
        "metadata": {}
      }
    ],
    "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 authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
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

Path Parameters

​
id
string
required

ID of the payment object to update.

Body

application/json

Updates mutable fields of a payment object like name, description, or metadata.

Response

200 - application/json

OK

The response is of type object.