Docs For Class escrow

Description

Function to handle escrow payments

author: ILance
version: $Revision: 1.0.0 $

Located in /api/class.escrow_payment.inc.php (line 28)

escrow
   |
   --escrow_payment

Method Summary

bool payment ([integer $userid = 0], [integer $invoiceid = 0], [string $invoicetype = 'escrow'], [integer $amount = 0], [string $method = 'account'], [string $gateway = ''], [string $gatewaytxn = ''], [boolean $silentmode = false])

Methods

payment (line 44)

Function to process an escrow payment for a particular user for a specific invoice id

return: Returns true or false if reversal could be completed

bool payment ([integer $userid = 0], [integer $invoiceid = 0], [string $invoicetype = 'escrow'], [integer $amount = 0], [string $method = 'account'], [string $gateway = ''], [string $gatewaytxn = ''], [boolean $silentmode = false])

integer $userid: user id
integer $invoiceid: invoice id
string $invoicetype: invoice type
integer $amount: invoice amount
string $method: payment method
string $gateway: payment gateway to use
string $gatewaytxn: payment gateway txn
boolean $silentmode: silent mode (return only true or false; default false)

Inherited Methods

Inherited From escrow

escrow::cancel_unlinked_escrow_invoices()
escrow::fetch_escrow_commission()
escrow::fetch_escrow_commission_logic()
escrow::fetch_escrow_opponent()
escrow::fetch_escrow_owner()
escrow::status()

Class escrow_payment

Inherited Methods