All Methods with Example Params

Please note that not all drivers implement each of these methods. In addition, the params available in each method may not be used in a particular driver's implementation. If you use a param in a request which is not used, it will appear in your error log, but will not create any ill effects in the request - it simply will not be sent to the gateway.

activate_recurring_profile

Parameters:

# Parameter Example
1 identifier 2390229
2 note This is a note for making a note on activating this recurring profile.

authorize_payment

Parameters:

# Parameter Example
1 ip_address 138.29.23.29
2 cc_type Visa
3 cc_number 4111111111111111
4 cc_exp 022012
5 cc_code 203
6 email calvinsemail@gmail.com
7 first_name Calvin
8 last_name Froedge
9 business_name Mango Reservations
10 street Some Street
11 street2
12 city Honolulu
13 state HI
14 country US
15 postal_code 94105
16 amt 50.00
17 phone
18 fax (801) 754 4466
19 identifier 23432
20 currency_code USD
21 item_amt 40.00
22 insurance_amt 2.00
23 shipping_disc_amt 5.00
24 handling_amt 2.00
25 tax_amt 1.00
26 desc Some cool thing Calvin wants, probably a good programming book.
27 custom Some custom info
28 inv_num 234323
29 notify_url http://notify.me/url
30 ship_to_first_name Some
31 ship_to_last_name Dude
32 ship_to_street 100 Somewhere Street
33 ship_to_city Somwheresville
34 ship_to_state TN
35 ship_to_postal_code 38501
36 ship_to_country US
37 ship_to_company Calvin's Company
38 shipping_amt 5.00
39 duty_amt 0.00

authorize_payment_button

Parameters:

# Parameter Example
1 amt 2.00
2 desc Click here to buy me

cancel_recurring_profile

Parameters:

# Parameter Example
1 identifier PROFILE-23928239
2 note The reason for cancelling this profile

capture_payment

Parameters:

# Parameter Example
1 ip_address 191.239.29.23
2 cc_type Visa
3 cc_number 4111111111111111
4 cc_exp 022012
5 cc_code 203
6 custom This is some custom param
7 inv_num 1003
8 note Some note to include with the capture

change_transaction_status

Parameters:

# Parameter Example
1 identifier TRANS-239239
2 action Accept

get_recurring_profile

Parameters:

# Parameter Example
1 identifier PROFILE-2923849

get_transaction_details

Parameters:

# Parameter Example
1 identifier TRANS-239238

oneoff_payment

Parameters:

# Parameter Example
1 ip_address 142.392.29.21
2 cc_type Visa
3 cc_number 4111111111111111
4 cc_exp 022013
5 cc_code 413
6 email calvinsemail@gmail.com
7 first_name Calvin
8 last_name Froedge
9 business_name The Business Name
10 street 251 Somewhere Street
11 street2 Apt B
12 city Somewherton
13 state KY
14 country US
15 postal_code 42105
16 amt 25.00
17 phone (801) 754 4466
18 fax (801) 754 4466
19 identifier YOUR-IDENTIFIER
20 currency_code USD
21 item_amt 25.00
22 insurance_amt 0.00
23 shipping_disc_amt 0.00
24 handling_amt 0.00
25 tax_amt 0.00
26 desc The transaction description
27 custom Anything you want to put here
28 inv_num YOUR-INV-NUMBER
29 po_num YOUR-PO-NUMBER
30 notify_url http://notify.me/url
31 ship_to_first_name Some
32 ship_to_last_name Dude
33 ship_to_street 311 North Washington Avenue
34 ship_to_city Cookeville
35 ship_to_state TN
36 ship_to_postal_code 38501
37 ship_to_country US
38 ship_to_company Some Company
39 shipping_amt 0.00

oneoff_payment_button

Parameters:

# Parameter Example
1 amt 10.00
2 desc Your button text
3 notify_url http://notify.me/url
4 shipping_amt 2.00
5 tax_amt 1.00
6 continue_url http://continue.after/purchase
7 edit_url http://edit.purchase
8 items Array
9 shipping_options Array

recurring_bill_outstanding

Parameters:

# Parameter Example
1 identifier PROFILE-IDENTIFIER
2 amt 35.00
3 note Why the profile is being billed

recurring_payment

Parameters:

# Parameter Example
1 profile_start_date 2012-05-31
2 profile_reference REF-NUM
3 desc This is my description
4 max_failed_payments 3
5 auto_bill_amt 5.00
6 billing_period Year
7 billing_frequency 1
8 total_billing_cycles 3
9 amt 25.00
10 trial_billing_frequency Year
11 trial_billing_cycles 1
12 trial_amt 5.00
13 currency_code USD
14 shipping_amt 0.00
15 tax_amt 0.00
16 initial_amt 0.00
17 failed_init_action Continue
18 inv_num INV-NUM
19 ship_to_first_name Calvin
20 ship_to_last_name Froedge
21 ship_to_street 151 Somewhere Street
22 ship_to_street2 Suite A
23 ship_to_city Somewhere
24 ship_to_state KY
25 ship_to_zip 42167
26 ship_to_country United States
27 ship_to_phone_num (801) 754 4466
28 ship_to_company Some Company
29 cc_type Visa
30 cc_number 4111111111111111
31 exp_date 022015
32 cc_code 203
33 email calvinsemail@gmail.com
34 identifier YOUR-IDENTIFIER
35 countrycode US
36 business_name The Business Name
37 salutation Mr.
38 first_name Calvin
39 middle_name P
40 last_name Froedge
41 suffix PIMP
42 street 317 Kublashayev
43 street2
44 city Simferople
45 state CR
46 postal_code UKR
47 phone (801) 754 4466
48 fax (801) 754 4466

recurring_payment_button

Parameters:

# Parameter Example
1 amt 14.00
2 desc A description for the transaction
3 trial_billing_period Month
4 trial_billing_frequency 1
5 trial_billing_cycles 1
6 trial_amt 10.00
7 profile_start_date 2012-07-18
8 billing_period Month
9 billing_frequency 1
10 total_billing_cycles 12

reference_payment

Parameters:

# Parameter Example
1 identifier PREVIOUS-TRANS-1923932
2 amt 30.00

refund_payment

Parameters:

# Parameter Example
1 identifier TRANS-ID
2 inv_num INV-2392329
3 refund_type Full
4 amt
5 currency_code USD
6 note This is a note to send with the refund.
7 last_4_digits 4111

search_transactions

Parameters:

# Parameter Example
1 start_date 2011-07-02T00:24:59+00:00
2 end_date 2012-07-02T00:24:59+00:00
3 email calvinsemail@gmail.com
4 receiver 293023
5 receipt_id 23929
6 transaction_id 23929232
7 inv_num 23239
8 cc_number 4111111111111111
9 transaction_class DoDirectPayment
10 amt 25.00
11 currency_code USD
12 status
13 salutation Mr.
14 first_name Calvin
15 middle_name P
16 last_name Froedge
17 suffix PIMP

suspend_recurring_profile

Parameters:

# Parameter Example
1 identifier IDENTIFIER-2392032
2 note This is the note

update_recurring_profile

Parameters:

# Parameter Example
1 identifier YOUR-IDENTIFIER
2 ip_address 142.392.29.21
3 cc_type Visa
4 cc_number 4111111111111111
5 cc_exp 022013
6 cc_code 413
7 email calvinsemail@gmail.com
8 first_name Calvin
9 last_name Froedge
10 business_name The Business Name
11 street 251 Somewhere Street
12 street2 Apt B
13 city Somewherton
14 state KY
15 country US
16 postal_code 42105
17 amt 25.00
18 phone (801) 754 4466
19 fax (801) 754 4466
20 currency_code USD
21 item_amt 25.00
22 insurance_amt 0.00
23 shipping_disc_amt 0.00
24 handling_amt 0.00
25 tax_amt 0.00
26 desc The transaction description
27 custom Anything you want to put here
28 inv_num YOUR-INV-NUMBER
29 po_num YOUR-PO-NUMBER
30 notify_url http://notify.me/url
31 ship_to_first_name Some
32 ship_to_last_name Dude
33 ship_to_street 311 North Washington Avenue
34 ship_to_city Cookeville
35 ship_to_state TN
36 ship_to_postal_code 38501
37 ship_to_country US
38 ship_to_company Some Company
39 shipping_amt 0.00

void_payment

Parameters:

# Parameter Example
1 identifier ID2930238
2 note Some note to tell why you voided it.

void_refund

Parameters:

# Parameter Example
1 cc_number 4111111111111111
2 cc_type Visa
3 cc_code 203
4 cc_exp 022012
5 amt 14.00
6 first_name Calvin
7 last_name Froedge
8 phone (801) 754 4466
9 email calvintest@gmail.com
10 street 311 Something Street
11 city Cookeville
12 state TN
13 country US
14 postal_code 38501
15 identifier IDTEST2039

Support PHP-Payments

This stuff takes a lot of hard work. To date, we've logged hundreds of hours on this project, and sadly free code doesn't pay bills.

Contribute Code