Sign in
Payments

Voids a payment

Voids the specified payment per the specified parameters

put/payments/{id}/void

Path parameters

idstring required

Request body

paymentIdstring
voidDateinteger required
invoiceBalancenumber required
invoiceNumberstring required
notestring

Response

successful operation

idstring uuid
paymentIdstring
accountIdstring required
paymentMethodIdstring uuid required
currencyCodestring
state'CREATED' | 'CONFIRMED' | 'CAPTURED' | 'PROCESSING' | 'CARD_DECLINED' | 'ACH_TRANSFER_FAILED' | 'RECONCILED' | 'INITIATED' | 'FAILED' | 'SUCCEED' | 'VOIDED'
statusstring
amountnumber
paymentDateinteger
exchangeRateIdstring
exchangeRatenumber
exchangeRateDateinteger
functionalAmountnumber
functionalAmountCapturednumber
functionalBankFeenumber

Changes