Home > Examples


Examples

Billing Agreement Examples

Billing Agreement with Payment

This example shows how to create a billing agreement with payment by calling these services:

nics_paypal_ec_set

nics_paypal_ec_get_details

nics_paypal_ec_do_payment

nics_paypal_do_capture

Example 2Request for ics_paypal_ec_set

ics_applications=ics_paypal_ec_set

merchant_id=HomeTownNewspaper

merchant_ref_number=HTNsubscription9647

paypal_ec_set_currency=USD

paypal_return=http://www.cybersource.com

paypal_cancel_return=http://www.cybersource.com/cancel

paypal_billing_agreement_desc=Home Town Newspaper Online*4.99 per month

paypal_billing_agreement_custom=One-year subscription

paypal_billing_type=MerchantInitiatedBilling

paypal_payment_type=instant

grand_total_amount=4.99

Example 3Reply from ics_paypal_ec_set

ics_rcode=1

ics_rflag=SOK

ics_rmsg=Request was processed successfully.

paypal_ec_set_rcode=1

paypal_ec_set_rflag=SOK

paypal_ec_set_rmsg=Request was processed successfully.

request_id=1928320121920167904854

request_token=Aeuvj6IjRRjVhjIZWEEvhhf8jZL4YX/I20gRk

merchant_ref_number=HTNsubscription9647

paypal_ec_set_correlation_id=4lks03uw2lbwxu

paypal_ec_set_paypal_token=EC-2UN29359TV924162S

paypal_ec_set_error_code=93045SLWVO

paypal_ec_set_amount=4.99

Example 4Request for ics_paypal_ec_get_details

ics_applications=ics_paypal_ec_get_details

merchant_id=HomeTownNewspaper

merchant_ref_number=HTNsubscription9647

paypal_ec_set_request_id=1928320121920167904854

paypal_ec_set_request_token=Aeuvj6IjRRjVhjIZWEEvhhf8jZL4YX/I20gRk

paypal_token=EC-2UN29359TV924162S

Example 5Reply from ics_paypal_ec_get_details

ics_rcode=1

ics_rflag=SOK

ics_rmsg=Request was processed successfully.

paypal_ec_get_details_rcode=1

paypal_ec_get_details_rflag=SOK

paypal_ec_get_details_rmsg=Request was processed successfully.

request_id=29FJBLS93TBQPSLDGK3H

request_token=Bxwje3Ijb7OskjK6HGG0XF3vllnoyf

merchant_ref_number=HTNsubscription9647

paypal_ec_get_details_paypal_billing_agreement_accepted_status=1

paypal_ec_get_details_correlation_id=sldkf9325sdfsdlkjgj

paypal_ec_get_details_auth_avs=3

paypal_ec_get_details_paypal_token=EC-2UN29359TV924162S

paypal_ec_get_details_error_code=93045SLWVO

paypal_ec_get_details_address_status=Confirmed

paypal_ec_get_details_payer_id=S6D5ETGSVYX94

paypal_ec_get_details_payer_status=verified

paypal_ec_get_details_payer_firstname=Jane

paypal_ec_get_details_payer_lastname=Smith

paypal_ec_get_details_payer_country=US

paypal_ec_get_details_payer=jsmith@example.com

paypal_ec_get_details_ship_to_name=Jane Smith

paypal_ec_get_details_ship_to_address1=1295 Charleston Rd.

paypal_ec_get_details_ship_to_city=Mountain View

paypal_ec_get_details_ship_to_state=CA

paypal_ec_get_details_ship_to_country=US

paypal_ec_get_details_ship_to_zip=9404

Example 6Request for ics_paypal_ec_do_payment

ics_applications=ics_paypal_ec_do_payment

merchant_id=HomeTownNewspaper

merchant_ref_number=HTNsubscription9647

paypal_ec_set_request_id=1928323124420167904854

paypal_ec_set_request_token=Aeuvj6IjRRjVhjIZWEEvhhf8jZL4YX/I20gRk

paypal_token=EC-2UN29359TV924162S

paypal_customer_email=jsmith@examples.com

paypal_payer_id=S6D5ETGSVYX94

paypal_ec_do_payment_currency=USD

grand_total_amount=4.99

Example 7Reply from ics_paypal_ec_do_payment

ics_rcode=1

ics_rflag=SOK

ics_rmsg=Request was processed successfully.

paypal_ec_do_payment_rcode=1

paypal_ec_do_payment_rflag=SOK

paypal_ec_do_payment_rmsg=Request was processed successfully.

request_id=TN10C8B3MHS0AK3BKSGN8

request_token=Crdug4OkpF2Qfd8oXDD0ZE4vpp24

merchant_ref_number=HTNsubscription9647

paypal_ec_do_payment_paypal_billing_agreement_id=3ADOib340UWM8923lf20

paypal_ec_do_payment_correlation_id=sldkf9325sdfsdlkjgj

paypal_ec_do_payment_paypal_token=EC-2UN29359TV924162S

paypal_ec_do_payment_paypal_payment_status=Pending

paypal_ec_do_payment_paypal_transaction_id=2YG99268YE540943P

paypal_ec_do_payment_payment_type=None

paypal_ec_do_payment_paypal_tax_amount=0.00

paypal_ec_do_payment_order_id=O-58X525738C493004E

paypal_ec_do_payment_paypal_transactiontype=expresscheckout

paypal_ec_do_payment_paypal_pending_reason=order

paypal_ec_do_payment_error_code=93045SLWVO

Example 8Request for ics_paypal_do_capture

ics_applications=ics_paypal_do_capture

merchant_id=HomeTownNewspaper

merchant_ref_number=HTNsubscription9647

paypal_ec_do_payment_request_id=TN10C8B3MHS0AK3BKSGN8

paypal_ec_do_payment_request_token=Crdug4OkpF2Qfd8oXDD0ZE4vpp24

complete_type=Complete

paypal_authorization_id=2YG99268YE540943P

grand_total_amount=4.99

Example 9Reply from ics_paypal_do_capture

ics_rcode=1

ics_rflag=SOK

ics_rmsg=Request was processed successfully.

paypal_do_capture_rcode=1

paypal_do_capture_rflag=SOK

paypal_do_capture_rmsg=Request was processed successfully.

request_id=FY25W8N9OWC2LE7WOCBU5

request_token=Dtely5OsoW3Pnw0mWVV9x26mll35

merchant_ref_number=HTNsubscription9647

paypal_do_capture_paypal_transaction_id=2SA82969X3543562X

paypal_do_capture_parent_transaction_id=2YG99268YE540943P

paypal_do_capture_authorization_id=2YG99268YE540943P

paypal_do_capture_paypal_payment_status=Completed

paypal_do_capture_error_code=93045SLWVO

paypal_do_capture_correlation_id=gwlbof9325biwflpaj

paypal_do_capture_paypal_payment_type=instant

paypal_do_capture_paypal_payment_gross_amount=4.99

paypal_do_capture_paypal_tax_amount=0.00

paypal_do_capture_paypal_fee_amount=0.36

paypal_do_capture_paypal_transactiontype=expresscheckout

Billing Agreement without Payment

This example shows how to create a billing agreement without payment by calling these services:

nics_paypal_ec_set

nics_paypal_ec_get_details

nics_paypal_create_agreement

Example 10Request for ics_paypal_ec_set

ics_applications=ics_paypal_ec_set

merchant_id=HomeTownNewspaper

merchant_ref_number=HTNsubscription9647

paypal_ec_set_currency=USD

paypal_return=http://www.cybersource.com

paypal_cancel_return=http://www.cybersource.com/cancel

paypal_billing_agreement_desc=Home Town Newspaper Online*4.99 per month

paypal_billing_agreement_custom=One-year subscription

paypal_billing_type=MerchantInitiatedBilling

paypal_payment_type=instant

grand_total_amount=0

Example 11Reply from ics_paypal_ec_set

ics_rcode=1

ics_rflag=SOK

ics_rmsg=Request was processed successfully.

paypal_ec_set_rcode=1

paypal_ec_set_rflag=SOK

paypal_ec_set_rmsg=Request was processed successfully.

request_id=1928320121920167904854

request_token=Aeuvj6IjRRjVhjIZWEEvhhf8jZL4YX/I20gRk

merchant_ref_number=HTNsubscription9647

paypal_ec_set_correlation_id=4lks03uw2lbwxu

paypal_ec_set_paypal_token=EC-2UN29359TV924162S

paypal_ec_set_error_code=93045SLWVO

paypal_ec_set_amount=0

Example 12Request for ics_paypal_ec_get_details

ics_applications=ics_paypal_ec_get_details

merchant_id=HomeTownNewspaper

merchant_ref_number=HTNsubscription9647

paypal_ec_set_request_id=1928320121920167904854

paypal_ec_set_request_token=Aeuvj6IjRRjVhjIZWEEvhhf8jZL4YX/I20gRk

paypal_token=EC-2UN29359TV924162S

Example 13Reply from ics_paypal_ec_get_details

ics_rcode=1

ics_rflag=SOK

ics_rmsg=Request was processed successfully.

paypal_ec_get_details_rcode=1

paypal_ec_get_details_rflag=SOK

paypal_ec_get_details_rmsg=Request was processed successfully.

request_id=29FJBLS93TBQPSLDGK3H

request_token=Bxwje3Ijb7OskjK6HGG0XF3vllnoyf

merchant_ref_number=HTNsubscription9647

paypal_ec_get_details_paypal_billing_agreement_accepted_status=1

paypal_ec_get_details_correlation_id=sldkf9325sdfsdlkjgj

paypal_ec_get_details_auth_avs=3

paypal_ec_get_details_paypal_token=EC-2UN29359TV924162S

paypal_ec_get_details_error_code=93045SLWVO

paypal_ec_get_details_address_status=Confirmed

paypal_ec_get_details_payer_id=S6D5ETGSVYX94

paypal_ec_get_details_payer_status=verified

paypal_ec_get_details_payer_firstname=Jane

paypal_ec_get_details_payer_lastname=Smith

paypal_ec_get_details_payer_country=US

paypal_ec_get_details_payer=jsmith@example.com

paypal_ec_get_details_ship_to_name=Jane Smith

paypal_ec_get_details_ship_to_address1=1295 Charleston Rd.

paypal_ec_get_details_ship_to_city=Mountain View

paypal_ec_get_details_ship_to_state=CA

paypal_ec_get_details_ship_to_country=US

paypal_ec_get_details_ship_to_zip=94043

Example 14Request for ics_paypal_create_agreement

ics_applications=ics_paypal_create_agreement

merchant_id=HomeTownNewspaper

merchant_ref_number=HTNsubscription9647

paypal_ec_set_request_id=1928320121920167904854

paypal_ec_set_request_token=Aeuvj6IjRRjVhjIZWEEvhhf8jZL4YX/I20gRk

paypal_token=EC-2UN29359TV924162S

Example 15Reply from ics_paypal_create_agreement

ics_rcode=1

ics_rflag=SOK

ics_rmsg=Request was processed successfully.

paypal_create_agreement_rcode=1

paypal_create_agreement_rflag=SOK

paypal_create_agreement_rmsg=Request was processed successfully.

request_id=TN10C8B3MHS0AK3BKSGN8

request_token=Crdug4OkpF2Qfd8oXDD0ZE4vpp24

merchant_ref_number=HTNsubscription9647

paypal_create_agreement_paypal_billing_agreement_id=3ADOib340UWM8923lf20

Reference Transaction

This example shows how to use a reference transaction to authorize and capture a payment by calling these services:

nics_paypal_do_ref_transaction

nics_paypal_authorization

nics_paypal_do_capture

Example 16Request for ics_paypal_do_ref_transaction

ics_applications=ics_paypal_do_ref_transaction

merchant_id=HomeTownNewspaper

merchant_ref_number=HTNsubscription9647

currency=USD

grand_total_amount=4.99

paypal_billing_agreement_id=3ADOib340UWM8923lf20

paypal_payment_type=instant

Example 17Reply from ics_paypal_do_ref_transaction

ics_rcode=1

ics_rflag=SOK

ics_rmsg=Request was processed successfully.

paypal_do_ref_transaction_rcode=1

paypal_do_ref_transaction_rflag=SOK

paypal_do_ref_transaction_rmsg=Request was processed successfully.

request_id=023mbdgil2spfkgjqdbvn

request_token=slbiw9345BJldbodflBNQCPE1409D9k

merchant_ref_number=HTNsubscription9647

paypal_do_ref_transaction_correlation_id=4lks03uw2lbwxu

paypal_do_ref_transaction_paypal_token=EC-2UN29359TV924162S

paypal_do_ref_transaction_error_code=93045SLWVO

paypal_do_ref_transaction_amount=4.99

paypal_do_ref_transaction_currency=USD

paypal_do_ref_transaction_paypal_amount=4.99

paypal_do_ref_transaction_paypal_billing_agreement_id=
   3ADOib340UWM8923lf20

paypal_do_ref_transaction_paypal_order_time=2009-08-15T17:23:09Z

paypal_do_ref_transaction_paypal_payment_status=Completed

paypal_do_ref_transaction_paypal_payment_type=instant

paypal_do_ref_transaction_paypal_pending_reason=none

paypal_do_ref_transaction_paypal_reason_code=none

paypal_do_ref_transaction_paypal_tax_amount=0.00

paypal_do_ref_transaction_paypal_transactiontype=express-checkout

paypal_do_ref_transaction_paypal_transaction_id=htnsubw30bwlbnq2

Example 18Request for ics_paypal_authorization

ics_applications=ics_paypal_authorization

paypal_order_id=58X525738C493004E

merchant_id=HomeTownNewspaper

merchant_ref_number=HTNsubscription9647

currency=USD

grand_total_amount=4.99

paypal_do_ref_transaction_request_id=023mbdgil2spfkgjqdbvn

paypal_do_ref_transaction_request_token=slbiw9345BJldbodflBNQCPE1409D9k

paypal_customer_email=jsmith@example.com

customer_email=jsmith@example.com

Example 19Reply from ics_paypal_authorization

ics_rcode=1

ics_rmsg=Request was processed successfully.

ics_rflag=SOK

merchant_ref_number=HTNsubscription9647

request_id=49gks2og0g12wrg879aergsk

request_token=SLGQ30B235b0XCV0lskb2369awopSgm

paypal_authorization_rcode=1

paypal_authorization_rmsg=Request was processed successfully.

paypal_authorization_rflag=SOK

paypal_authorization_amount=4.99

paypal_authorization_currency=USD

paypal_authorization_paypal_transaction_id=3GT12375C398240X

paypal_authorization_paypal_amount=4.99

paypal_authorization_correlation_id=r2lvp9325sdfsdlkjgj

paypal_authorization_error_code=sboe93045

Example 20Request for ics_paypal_do_capture

ics_applications=ics_paypal_do_capture

merchant_id=HomeTownNewspaper

merchant_ref_number=HTNsubscription9647

currency=USD

grand_total_amount=4.99

complete_type=Complete

paypal_authorization_request_id=49gks2og0g12wrg879aergsk

paypal_authorization_request_token=SLGQ30B235b0XCV0lskb2369awopSgm

paypal_authorization_id=9XT12375C2469923X

Example 21Reply from ics_paypal_do_capture

ics_rcode=1

ics_rflag=SOK

ics_rmsg=Request was processed successfully.

merchant_ref_number=HTNsubscription9647

paypal_do_capture_rcode=1

paypal_do_capture_rflag=SOK

paypal_do_capture_rmsg=Request was processed successfully.

request_id=203948106391278015965

request_token=FFv9VEdZAOGh084W7RJzIIzHUTUL

paypal_do_capture_paypal_payment_type=instant

paypal_do_capture_paypal_payment_gross_amount=4.99

paypal_do_capture_paypal_tax_amount=0.00

paypal_do_capture_currency=USD

paypal_do_capture_paypal_fee_amount=0.36

paypal_do_capture_amount=4.99

paypal_do_capture_paypal_transactiontype=cart

paypal_do_capture_paypal_transaction_id=4M8612956X2810426

paypal_do_capture_parent_transaction_id=9XT12375C2469923X

paypal_do_capture_authorization_id=0YU23486D3570034Y

paypal_do_capture_paypal_payment_status=Completed

paypal_do_capture_correlation_id=r2lvp9325sdfsdlkjgj

paypal_do_capture_error_code=sboe93045