| $trans_expecting_id |
?ID_TEXT |
required parameter |
N/A |
N/A |
Our internal temporary transaction ID (null: an immediate transaction that didn't require this table). For a live payment you should always pass a $trans_expecting_id in case tax rates or price changes over the interim, which can cause a mismatch or tax filing errors. |
| $txn_id |
?ID_TEXT |
Null |
N/A |
N/A |
The transaction ID (null: randomised - for debugging only) |
| $type_code |
?ID_TEXT |
Null |
N/A |
N/A |
The product codename (null: lookup from $trans_expecting_id - for debugging only) |
| $item_name |
?SHORT_TEXT |
Null |
N/A |
N/A |
The human-readable product title (blank: doing a subscription cancellation, unknown item name; but can get from $found) (null: lookup from $trans_expecting_id - for debugging only) |
| $purchase_id |
?ID_TEXT |
Null |
N/A |
N/A |
The ID of the purchase-type (meaning depends on item_name) (null: lookup from $trans_expecting_id - for debugging only) |
| $is_subscription |
boolean |
False |
N/A |
N/A |
Whether this is a subscription |
| $status |
ID_TEXT |
Completed |
N/A |
N/A |
The status this transaction is telling of |
| $reason |
SHORT_TEXT |
Blank (empty string) |
N/A |
N/A |
A reason for the transaction's status (blank: unknown or N/A) |
| $price |
?REAL |
Null |
N/A |
N/A |
Transaction price paid excluding tax, shipping, and transaction fees (null: lookup from $trans_expecting_id - for debugging only) |
| $tax |
?REAL |
Null |
N/A |
N/A |
Transaction tax (null: not separated out, find the tax due and take it out of $price) |
| $shipping |
?REAL |
Null |
N/A |
N/A |
Transaction shipping (null: not separated out, find the shipping due and take it out of $price) |
| $transaction_fee |
?REAL |
Null |
N/A |
N/A |
The transaction fee (null: we do not know; run get_transaction_fee to determine this) |
| $currency |
?ID_TEXT |
Null |
N/A |
N/A |
The currency (points: was done fully with points) (null: lookup from $trans_expecting_id - for debugging only) |
| $check_amounts |
boolean |
True |
N/A |
N/A |
Check the amounts related to this transaction; if not set no points will be charged |
| $parent_txn_id |
ID_TEXT |
Blank (empty string) |
N/A |
N/A |
The ID of the parent transaction (blank: unknown or N/A) |
| $pending_reason |
SHORT_TEXT |
Blank (empty string) |
N/A |
N/A |
The reason it is in pending status (if it is) (blank: unknown or N/A) |
| $memo |
LONG_TEXT |
Blank (empty string) |
N/A |
N/A |
A note attached to the transaction (blank: not set) |
| $period |
string |
Blank (empty string) |
N/A |
N/A |
The subscription period (blank: N/A or unknown because trust is checked on the gateway's code) |
| $member_id_paying |
?MEMBER |
Null |
N/A |
N/A |
The member ID of who is doing the transaction (null: unknown) |
| $payment_gateway |
ID_TEXT |
Blank (empty string) |
N/A |
N/A |
The payment gateway (manual: was a manual transaction, not through a real gateway) |
| $silent_fail |
boolean |
False |
N/A |
N/A |
Always return null on failure rather than showing any error message. Used when not sure a valid & finalised transaction is in the POST environment, but you want to try just in case (e.g. on a redirect back from the gateway). |
| $send_notifications |
boolean |
True |
N/A |
N/A |
Whether to send notifications. Set to false if this is not the primary payment handling (e.g. a POST redirect rather than the real IPN). |
