Overview
Payments may be authorized, processed, updated and voided in real-time using the following payment commands.
Bank accounts can optionally be verified separately or inline during a payment command.
The response to any payment command will indicate success or failure of the requested process.
Payment Commands¶
Attempts to process an ECheck/ACH, Credit Card or Tokenized payment in real-time through your processor and indicates whether the payment was approved or declined.
Modifies a payment transaction if it has not yet been batched by your processor.
Cancels (stops) a payment from processing if it has not yet been batched by your processor.
Track all status changes that occur on a given date.
payment.authorize
Attempts to obtain authorization for a payment but does not process the payment until apayment.capture command is issued.
payment.capture
Finalizes and processes an authorized payment.
payment.verifybankaccount
Performs basic algorithm verification on a routing number and account number of a bank acccount. May also perform additional verification ifyour processorhas you enrolled in a verification service.
payment.update
Modifies a payment transaction if it has not yet been batched by your processor.
payment.refund
Reverses a previous debit and refunds the same amount (or less if specified) to the same payment account used in the original referenced debit.
payment.void
Cancels (stops) a payment from processing if it has not yet been batched by your processor.