Sign in

v1

latestOpenAPI 3.1.12026-07-2452287575.4 KB
Payables

Update a Payable

Update an existing Payable.

🏁 This endpoint's rate limit is 100 calls per minute.

patch/v1/payables/{id}

Path parameters

idstring uuid required
Example:8c581d79-bb84-4bc1-b1c5-8c073264a569

The ID for the resource being accessed.

Headers

Idempotency-Keystring

An idempotency key to prevent duplicate requests. All requests with the same key will be considered attempts for the same request.

These keys are stored for a period of 24 hours. To ensure these keys are sufficiently tied to a request, we recommend either storing generated idempotency keys alongside your payment data, or using a hash of the request JSON itself to generate your idempotency key.

Request body

OR
OR
OR
OR

Example request

{
  "send_on": "2022-11-26",
  "pay_to_payment_method": "de3cda28-2771-4ca9-acef-cdde35ec6a8d"
}

Response

OK

OR
OR
OR
OR
OR

Example response

{
  "created_at": "2021-05-15T03:49:53.299680+00:00",
  "pay_to_payment_method": {
    "type_details": {
      "primary_color": "#0075a3"
    }
  },
  "send_on": "2022-11-26",
  "withdraw_from_account": {
    "type_details": {
      "primary_color": "#0075a3"
    }
  },
  "type_details": {
    "receiver": {
      "transaction_id": "IK746XVY",
      "trace_id": "1d5a5516babb4bfb9d2c091bd5ffc15c"
    },
    "sender": {
      "transaction_id": "IK746XVY",
      "trace_id": "1d5a5516babb4bfb9d2c091bd5ffc15c"
    },
    "transaction_id": "IK746XVY"
  }
}