SOsocotra

PATCH /billing/{tenantLocator}/payments/{locator}

Request

Path parameters

tenantLocatorstring uuid required
locatorstring ulid required

Request body

accountLocatorstring ulid
typestring
amountnumber
setDataobject required
removeDataobject required
removeTargetsstring[] required
useDefaultFinancialInstrumentboolean
financialInstrumentLocatorstring ulid
transactionMethod'ach' | 'cash' | 'eft' | 'standard' | 'wire'
transactionNumberstring
currencystring
paymentMode'normal' | 'aggregate'
retryPlanNamestring
nextRequestTimestring date-time

Response

OK

locatorstring ulid required
paymentState'draft' | 'validated' | 'requested' | 'executing' | 'posting' | 'posted' | 'failed' | 'cancelled' | 'reversing' | 'reversed' | 'discarded' required
typestring required
currencystring required
amountnumber required
remainingAmountnumber
dataobject
createdAtstring date-time required
createdBystring uuid required
accountLocatorstring ulid
externalCashTransactionLocatorstring ulid
postedAtstring date-time
reversalReasonstring
reversedAtstring date-time
reversedBystring uuid
shortfallCreditLocatorsstring[] required
paymentMode'normal' | 'aggregate'
aggregatePaymentLocatorstring ulid
paymentNumberstring
anonymizedAtstring date-time
nextRequestTimestring date-time
retryPlanNamestring

Changes

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