v1

latestOpenAPI 3.1.02026-07-241910582.8 KB

Update Incoming Payment Detail

Update a single Incoming Payment Detail's metadata.

patch/incoming_payment_details/{id}

Path parameters

idstring required

The ID of the Incoming Payment Detail.

Request body

metadatastring json

Response

200

idstring

objectstring

live_modeboolean

internal_account_idstring

{"stackTrail":"paths:/incoming_payment_details/{id}:patch:responses:200:content:application/json:schema:properties:virtual_account_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/incoming_payment_details/{id}:patch:responses:200:content:application/json:schema:properties:virtual_account","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/incoming_payment_details/{id}:patch:responses:200:content:application/json:schema:properties:transaction_line_item_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/incoming_payment_details/{id}:patch:responses:200:content:application/json:schema:properties:transaction_id","oasType":"schema","type":"unknown"}

typestring

dataobject

amountinteger

currencystring

directionstring

statusstring

as_of_datestring

{"stackTrail":"paths:/incoming_payment_details/{id}:patch:responses:200:content:application/json:schema:properties:vendor_id","oasType":"schema","type":"unknown"}

created_atstring

updated_atstring

Example response

{
  "id": "20952b6f-1a4e-45bb-b071-f4cf698861a9",
  "object": "incoming_payment_detail",
  "live_mode": true,
  "internal_account_id": "0186a991-809a-4696-a47a-fe7db5013eee",
  "type": "ach",
  "amount": 10000,
  "currency": "USD",
  "direction": "debit",
  "status": "pending",
  "metadata": {
    "foo": "bar"
  },
  "as_of_date": "2021-11-05",
  "created_at": "2021-11-05T03:21:59Z",
  "updated_at": "2021-11-05T16:27:48Z"
}