Independently cancel an unposted payment or recover its committed journal
POST
/facilities/{id}/payment-cancellationsPath parameters
idstringRequiredHeaders
Idempotency-KeystringOptionalSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Body parameters
payment_keystringRequiredreasonstringRequiredReturns
200 OK
actorstringRequiredatstring · date-timeRequiredcompleted_atstring · date-time or nullOptionalexecuted_bystringOptionalfacility_idstringRequiredoutcomestringOptionalpaymentobject or nullOptionalFacilityPayment is money applied to a facility.
10 child attributes
amountintegerRequiredcreated_atstring · date-timeRequiredfacility_idstringRequiredfees_amountintegerRequiredidstringRequiredincome_amountintegerRequiredFactor income recognised on a remittance, or a factoring fee
interest_amountintegerRequiredjournal_idstringRequiredExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
kindstringRequiredPayment, remittance (merchant cash advance), settlement (of an item)
principal_amountintegerRequiredpayment_keystringRequiredreasonstringRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503