JUjustifi
Payouts

Update a Payout

Change a payout's metadata.

patch/payouts/{id}

Request

Path parameters

idstring uuid required

Headers

Idempotency-Keystring uuid required

a string to identify your request (we recommend using a generated uuid, but you may use any unique string) see Idempotent Requests

Authorizationstring required

the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)

Request body

metadataobject

any useful information you'd like to store alongside this payout; when you update metadata, any previous metadata will be overwritten

Example request

{
  "metadata": {
    "customer_payout_id": "cp_12345"
  }
}

Response

Payout update was successful

idstring uuid

the object id, also found in the data object

typestring

the object type, or array of objects

page_infounknown

Example response

{
  "id": "prefix_xyz (same as id of data object)",
  "type": "payout",
  "data": {
    "id": "po_xyz",
    "amount": 100000,
    "bank_account": {
      "country": "US",
      "currency": "usd"
    },
    "currency": "usd",
    "deposits_at": "2021-01-01T12:00:00Z",
    "fees_total": 5000,
    "refunds_count": 5,
    "refunds_total": 10000,
    "payments_count": 50,
    "payments_total": 110000,
    "other_total": 100,
    "status": "paid",
    "settlement_priority": "standard",
    "metadata": {
      "customer_payout_id": "cp_12345"
    },
    "created_at": "2021-01-01T12:00:00Z",
    "updated_at": "2021-01-01T12:00:00Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.