Payments

Payment agreements, payment links, manual payments, charges and refunds.

• POSTCreate payment agreementPaymentstype=create_payment_planCreates a payment agreement (a schedule of payments) for an account and sends it to the account holder by SMS, email or both to sign.
• POSTGet agreement detailstype=agreement_detailsReturns a payment agreement with its schedule and payment history.
• POSTGet payment scheduletype=get_schedulesReturns every scheduled payment of a payment agreement or recurring plan, with dates, amounts, the balance after each payment and its status.
• POSTGet agreement documenttype=get_agreement_docReturns the signed agreement document: account holder details, payment schedule, terms and authorization.
• POSTCancel agreementPaymentstype=cancel_payment_planCancels a payment agreement and all its future payments. The account holder is notified.
• POSTRecord a manual paymentPaymentstype=add_paymentRecords a payment received outside DCDial (cash, check, wire…) and applies it to the account balance. No money is moved.
• POSTVoid a paymentPaymentstype=remove_paymentVoids a recorded payment, for example after a refund, NSF or chargeback, and reverses it on the account balance.
• POSTRefund a paymentPaymentstype=payment_refundRefunds all or part of a card or ACH payment to the original payment method.
• POSTProcess a paymentPaymentstype=charge_customerCharges a card or bank account now, once or on a recurring schedule.
• POSTCreate a payment linkPaymentstype=get_payment_linkCreates a secure payment link for an account. Send it yourself, or have DCDial text it to the account holder.
• POSTGet payment statustype=get_payment_statusReturns the status of a payment by invoice or transaction ID.