• Share
  • Email
  • Embed
  • Like
  • Save
  • Private Content
Authorize.net Recurring Billing Guide
 

Authorize.net Recurring Billing Guide

on

  • 1,606 views

 

Statistics

Views

Total Views
1,606
Views on SlideShare
1,606
Embed Views
0

Actions

Likes
0
Downloads
0
Comments
0

0 Embeds 0

No embeds

Accessibility

Upload Details

Uploaded via as Adobe PDF

Usage Rights

© All Rights Reserved

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
Post Comment
Edit your comment

    Authorize.net Recurring Billing Guide Authorize.net Recurring Billing Guide Document Transcript

    • Merchant Web Services API !"#$%&'()*+,%(&-$.%+)/-+-0'()1!*/2) 3/4)5".6') Authorize.Net Developer Support http://developer.authorize.net Authorize.Net LLC 082007 Ver.1.0
    • Authorize.Net LLC (“Authorize.Net”) has made efforts to ensure the accuracy and completeness of the information in this document. However, Authorize.Net disclaims all representations, warranties and conditions, whether express or implied, arising by statute, operation of law, usage of trade, course of dealing or otherwise, with respect to the information contained herein. Authorize.Net assumes no liability to any party for any loss or damage, whether direct, indirect, incidental, consequential, special or exemplary, with respect to (a) the information; and/or (b) the evaluation, application or use of any product or service described herein. Authorize.Net disclaims any and all representation that its products or services do not infringe upon any existing or future intellectual property rights. Authorize.Net owns and retains all right, title and interest in and to the Authorize.Net intellectual property, including without limitation, its patents, marks, copyrights and technology associated with the Authorize.Net services. No title or ownership of any of the foregoing is granted or otherwise transferred hereunder. Authorize.Net reserves the right to make changes to any information herein without further notice. Authorize.Net Trademarks: Advanced Fraud Detection Suite™ Authorize.Net® Authorize.Net Your Gateway to IP Transactions™ Authorize.Net Verified Merchant Seal™ Authorize.Net Where the World Transacts® Automated Recurring Billing™ eCheck.Net® FraudScreen.Net® 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+) B)
    • Table of Contents Revision History ................................................................................. 4  Section 1............................................................................................. 5  Developer Introduction ...................................................................... 5  /.+.&"&)N'O".('&'+$#)GGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGP  Q'7'M%>'()K">>%($)GGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGP  Section 2............................................................................................. 7  Executing an API Call ........................................................................ 7  R'J)K'(7.L')4%L-$.%+#) GGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGG9  G !*/)S"+L$.%+#)GGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGC  Authentication ............................................................................................................................ 9  Input Elements for createCustomerProfileRequest ............................................................. 10  Input Elements for createCustomerPaymentProfileRequest .............................................. 17  Input Elements for createCustomerShippingAddressRequest .......................................... 21  Input Elements for createCustomerProfileTransactionRequest ......................................... 24  Input Elements for deleteCustomerProfileRequest ............................................................. 59  Input Elements for deleteCustomerPaymentProfileRequest .............................................. 60  Input Elements for deleteCustomerShippingAddressRequest ........................................... 61  Input Elements for getCustomerProfileIdsRequest ............................................................. 62  Input Elements for getCustomerProfileRequest .................................................................. 63  Input Elements for getCustomerPaymentProfileRequest ................................................... 63  Input Elements for getCustomerShippingAddressRequest ................................................ 64  Input Elements for updateCustomerProfileRequest ............................................................ 65  Input Elements for updateCustomerPaymentProfileRequest ............................................. 67  Input Elements for updateCustomerShippingAddressRequest ......................................... 73  Input Elements for validateCustomerPaymentProfileRequest ........................................... 76  Section 3........................................................................................... 78  Responses ........................................................................................ 78  !*/)N'#>%+#'#) GGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGG) C  G 9 Output for createCustomerProfileResponse ........................................................................ 79  Output for createCustomerPaymentProfileResponse ......................................................... 81  4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+) ;)
    • Output for createCustomerShippingAddressResponse...................................................... 83  Output for createCustomerProfileTransactionResponse .................................................... 83  Output for deleteCustomerProfileResponse ........................................................................ 85  Output for deleteCustomerPaymentProfileResponse ......................................................... 85  Output for deleteCustomerShippingAddressResponse ...................................................... 86  Output for getCustomerProfileIdsResponse ........................................................................ 87  Output for getCustomerProfileResponse ............................................................................. 87  Output for getCustomerPaymentProfileResponse .............................................................. 94  Output for getCustomerShippingAddressResponse ........................................................... 98  Output for updateCustomerProfileResponse ..................................................................... 101  Output for updateCustomerPaymentProfileResponse ...................................................... 101  Output for updateCustomerShippingAddressResponse .................................................. 102  Output for validateCustomerPaymentProfileResponse .................................................... 103  Q">M.L-$')U(%,.M')V'(.,.L-$.%+)GGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGG) <W  G B N'#>%+#')!%6'#) GGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGGG) <P  G B Index ............................................................................................... 107  4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<9)E"$@%(.F'GH'$)!%(>G T)
    • Revision History PUBLISH DATE UPDATES H%7'&J'();<<9) *+.$.-M)('M'-#')%,)$@')!"#$%&'()*+,%(&-$.%+)/-+-0'()1!*/2)EU*)) /-?);<<C) N'&%7')K'L"('K%"(L')('O".('&'+$#)-+6)7-(.%"#)">6-$'#) X-+"-(?);<<=) E66.$.%+)%,)0'$!"#$%&'(U(%,.M'*6#N'O"'#$)-+6)7-(.%"#)">6-$'#) X"M?));<<=) !M-(.,.'6)"#-0')%,)7-M.6-$.%+/%6'),%()L('-$'!"#$%&'(U(%,.M'N'O"'#$)L-MM#)Y@'+)+%) >-?&'+$)>(%,.M').+,%(&-$.%+).#).+LM"6'6G)) E66'6).+6'ZG)) E66'6)+%$')-J%"$)%>$.%+-M),.'M6#)-+6)GH[)>(%0(-&&.+0) !%(('L$'6)7-M"'#),%()taxable)7-(.-JM'G)) ) ) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ W)
    • Section 1 Developer Introduction This guide describes the Web development required to create and manage customer profile information for the purpose of submitting transactions to the Authorize.Net Payment Gateway directly from a Web site or other application using extensible markup language (XML). Specifically, the Authorize.Net Customer Information Manager (CIM) Application Programming Interface (API) provides a mechanism for developers and value added resellers (VARs) to create, delete, get, and update customer profile information, including payment and address information, via direct integration between client software or applications and the Authorize.Net Payment Gateway. The CIM API accomplishes these functions through an XML call and subsequent XML response. /.+.&"&)N'O".('&'+$#) Before you begin this integration for an Authorize.Net Payment Gateway account, please check with the merchant to make sure that the following minimum requirements have already been met. !) The merchant must have a U.S. based merchant bank account that allows Internet transactions. !) The merchant must have an active Authorize.Net Card Not Present Payment Gateway account. !) The merchant must be signed up for the CIM service. !) The merchant must store account authentication data securely (for example, API login ID, transaction key). Note: Merchants should avoid storing any type of sensitive cardholder information. However, in the event that a merchant or third party must store sensitive customer business or payment information, compliance with industry standard storage requirements is required. Please see the Developer Security Best Practices White Paper at http://www.authorize.net/files/developerbestpractices.pdf for guidelines. Q'7'M%>'()K">>%($) There are several resources available to help you successfully integrate a merchant Web site or other application to the Authorize.Net Payment Gateway. !) The Integration Center at http://developer.authorize.net provides test accounts, sample code, FAQs, and troubleshooting tools. 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ P)
    • Section 2 Executing an API Call !) If you can’t find what you need in the Integration Center, our Integration Team is available to answer your questions via e-mail at integration@authorize.net. !) Be sure to read our Developer Security Best Practices White Paper at http://www.authorize.net/files/developerbestpractices.pdf for information on how to maximize the security and reliability of your merchant integration solutions. If you have any suggestions about how we can improve or correct this guide, please e-mail documentation@authorize.net. 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ ])
    • Section 2 Executing an API Call The following sections describe the minimum requirements for executing an API call for managing customer profiles using XML. There are two options for developing the request script: !) You may develop a custom script yourself using the API fields information provided in this document, OR !) You may use Authorize.Net sample code in C# and Java available for free from our Integration Center at http://developer.authorize.net/samplecode. Note: If you choose to use Authorize.Net sample code, please be aware that in order to achieve a successful implementation it must be modified with developer test account or the merchant’s specific payment gateway account information. R'J)K'(7.L')4%L-$.%+#) ITEM LOCATION U(%6"L$.%+) @$$>#8::->.G-"$@%(.F'G+'$:Z&M:7B:('O"'#$G->.) Q'7'M%>'()'#$)) @$$>#8::->.$'#$G-"$@%(.F'G+'$:Z&M:7B:('O"'#$G->.) 3/4)KL@'&-) @$$>#8::->.G-"$@%(.F'G+'$:Z&M:7B:#L@'&-:E+'$E>.KL@'&-GZ#6) In order to be processed successfully, API requests and responses must conform to the CIM API XML schema. Note: The Developer Test URL requires the use of a developer test payment gateway account. You can request a test account from our Integration Center at http://developer.authorize.net/testaccount. Developer test accounts cannot be used to test against the Production URL. Note for .NET programmers: When a parameter is optional, and if you use serialization, then the .NET language you are using automatically creates Boolean properties that indicate whether or not non-nullable parameters are specified. For example, if there is a parameter named validationMode that is an Enumeration type, a parameter called validationModeSpecified will automatically be created. By default, these properties are set to “false.”If a request passes a value for an optional parameter, be sure to set these properties to “true” so that the value is not ignored. 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ 9)
    • Section 2 Executing an API Call !*/)S"+L$.%+#) The CIM API includes the following functions: !) createCustomerProfileRequest – Create a new customer profile along with any customer payment profiles and customer shipping addresses for the customer profile. !) createCustomerPaymentProfileRequest – Create a new customer payment profile for an existing customer profile. You can create up to 10 payment profiles for each customer profile. !) createCustomerShippingAddressRequest – Create a new customer shipping address for an existing customer profile. You can create up to 100 customer shipping addresses for each customer profile. !) createCustomerProfileTransactionRequest – Create a new payment transaction from an existing customer profile. !) deleteCustomerProfileRequest – Delete an existing customer profile along with all associated customer payment profiles and customer shipping addresses. !) deleteCustomerPaymentProfileRequest – Delete a customer payment profile from an existing customer profile. !) deleteCustomerShippingAddressRequest – Delete a customer shipping address from an existing customer profile. !) getCustomerProfileIdsRequest – Retrieve all customer profile IDs you have previously created. !) getCustomerProfileRequest – Retrieve an existing customer profile along with all the associated customer payment profiles and customer shipping addresses. !) getCustomerPaymentProfileRequest – Retrieve a customer payment profile for an existing customer profile. !) getCustomerShippingAddressRequest – Retrieve a customer shipping address for an existing customer profile. !) updateCustomerProfileRequest – Update an existing customer profile. !) updateCustomerPaymentProfileRequest – Update a customer payment profile for an existing customer profile. !) updateCustomerShippingAddressRequest – Update a shipping address for an existing customer profile. !) validateCustomerPaymentProfileRequest – Verify an existing customer payment profile by generating a test transaction. The following sections provide information about the input elements required for executing the functions listed above. Indentations in the Element column indicate grouping hierarchy. All 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ C)
    • Merchant Web Services API elements are case sensitive and must be submitted in the order listed here. Elements are required unless otherwise indicated. Optional elements should not be submitted unless they contain valid values. Note: Elements required for individual API calls are in addition to the authentication elements required for all API calls. Authentication ALL calls to the API require merchant authentication to ensure they originate from authorized sources. This implementation of the merchant Web services API supports authentication using the API Login ID and Transaction Key. ELEMENT VALUE FORMAT NOTES merchantAuthentication) !%+$-.+#)&'(L@-+$)"+.O"') ) ) .+,%(&-$.%+),%()>"(>%#'#) %,)-"$@'+$.L-$.%+) name @')7-M.6)EU*)4%0.+)*Q),%() ^>)$%);P)L@-(-L$'(#) K"J&.$)$@')EU*) $@')6'7'M%>'()$'#$)%() 4%0.+)*Q)"#'6)$%) &'(L@-+$)-LL%"+$) #"J&.$)$(-+#-L$.%+#)) transactionKey @')7-M.6)(-+#-L$.%+)_'?) B])L@-(-L$'(#) K"J&.$)$@') ,%()$@')6'7'M%>'()$'#$)%() (-+#-L$.%+)_'?) &'(L@-+$)-LL%"+$) %J$-.+'6),(%&)$@') /'(L@-+$)*+$'(,-L') Example of Authentication with the Login ID and Transaction Key <?xml version="1.0" encoding="utf-8"?> <createCustomerProfileRequest xmlns= "AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <merchantAuthentication> <name>mytestacct</name> <transactionKey>112223344</transactionKey> </merchantAuthentication> </createCustomerProfileRequest> Note: The sample code included in this document uses dummy field values. When using or testing sample code, be sure to enter valid field values. Additional sample code is available for download from the Authorize.Net Integration Center at http://developer.authorize.net/samplecode. 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ =)
    • Section 2 Executing an API Call Input Elements for createCustomerProfileRequest This function is used to create a new customer profile along with any customer payment profiles and customer shipping addresses for the customer profile. The following table lists the input elements for executing an API call to the createCustomerProfileRequest function. ELEMENT VALUE FORMAT NOTES refId /'(L@-+$D ^>)$%);<)L@-(-L$'(#) *,).+LM"6'6).+)$@') -##.0+'6) ('O"'#$I)$@.#)7-M"')Y.MM) (','('+L')*Q),%() J').+LM"6'6).+)$@') $@')('O"'#$) ('#>%+#'G)@.#),'-$"(') &.0@$)J')'#>'L.-MM?) ) "#',"M),%()&"M$.D Optional $@('-6'6)->>M.L-$.%+#G) profile !%+$-.+#) ) E$)M'-#$)%+')%,)$@') .+,%(&-$.%+),%() ,%MM%Y.+0),.'M6#)&"#$)J') $@')L"#$%&'() #"J&.$$'6)"+6'() >(%,.M') profile8) merchantCustomerIdI) description)%()email.) merchantCustomerId /'(L@-+$) ^>)$%);<)L@-(-L$'(#) N'O".('6)%+M?).,)+%) -##.0+'6)*Q),%() 7-M"'#),%()J%$@) $@')L"#$%&'() description)-+6)email) -(')#"J&.$$'6G)) ) Conditional) description Q'#L(.>$.%+)%,) ^>)$%);PP)L@-(-L$'(#) N'O".('6)%+M?).,)+%) $@')L"#$%&'()%() 7-M"'#),%()J%$@) L"#$%&'()>(%,.M') merchantCustomerId) -+6)email)-(') ) #"J&.$$'6G) Conditional) email [&-.M)-66('##) ^>)$%);PP)L@-(-L$'(#) N'O".('6)%+M?).,)+%) -##%L.-$'6)Y.$@) 7-M"'#),%()J%$@) $@')L"#$%&'() description)-+6) >(%,.M') merchantCustomerId) -(')#"J&.$$'6G) ) Conditional) paymentProfiles !%+$-.+#) ) /"M$.>M').+#$-+L'#)%,) >-?&'+$) $@.#)'M'&'+$)&-?)J') >(%,.M'#),%()$@') #"J&.$$'6)$%)L('-$') L"#$%&'()>(%,.M') &"M$.>M')>-?&'+$) >(%,.M'#),%()$@') ) L"#$%&'()>(%,.M'G) Optional) customerType Optional) .+6.7.6"-M) ) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ B<)
    • Merchant Web Services API ELEMENT VALUE FORMAT NOTES J"#.+'##) billTo ) ) ) firstName @')L"#$%&'(`#) ^>)$%)P<)L@-(-L$'(#)1+%) ) ,.(#$)+-&') #?&J%M#2) ) Optional) lastName @')L"#$%&'(`#) ^>)$%)P<)L@-(-L$'(#)1+%) ) M-#$)+-&') #?&J%M#2) ) Optional) company @')+-&')%,) ^>)$%)P<)L@-(-L$'(#)1+%) ) $@')L%&>-+?) #?&J%M#2) -##%L.-$'6)Y.$@) $@')L"#$%&'(I).,) ->>M.L-JM') ) Optional) address @')L"#$%&'(`#) ^>)$%)]<)L@-(-L$'(#)1+%) ) -66('##) #?&J%M#2) ) Optional) city @')L.$?)%,)$@') ^>)$%)W<)L@-(-L$'(#)1+%) ) L"#$%&'(`#) #?&J%M#2) -66('##) ) Optional) state @')#$-$')%,)$@') E)7-M.6)$Y%DL@-(-L$'() ) L"#$%&'(`#) #$-$')L%6') -66('##) ) Optional) zip @')a*U)L%6')%,) ^>)$%);<)L@-(-L$'(#)1+%) ) $@')L"#$%&'(`#) #?&J%M#2) -66('##) ) Optional) country @')L%"+$(?)%,) ^>)$%)]<)L@-(-L$'(#)1+%) ) $@')L"#$%&'(`#) #?&J%M#2) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ BB)
    • Section 2 Executing an API Call ELEMENT VALUE FORMAT NOTES -66('##) ) Optional) phoneNumber @')>@%+') ^>)$%);P)6.0.$#)1+%) ) +"&J'() M'$$'(#2) -##%L.-$'6)Y.$@) $@')L"#$%&'() ) >(%,.M') [ZG)1B;T2B;TDB;TW) ) Optional) faxNumber @'),-Z)+"&J'() ^>)$%);P)6.0.$#)1+%) ) -##%L.-$'6)Y.$@) M'$$'(#2) $@')L"#$%&'() >(%,.M') ) ) [ZG)1B;T2B;TDB;TW) Optional) payment !%+$-.+#) ) !-+)L%+$-.+) >-?&'+$)>(%,.M') creditCard)%() .+,%(&-$.%+),%() bankAccount) $@')L"#$%&'() >(%,.M') creditCard !%+$-.+#)L('6.$) ) @.#)'M'&'+$).#)%+M?) L-(6)>-?&'+$) ('O".('6)Y@'+)$@') .+,%(&-$.%+),%() >-?&'+$)>(%,.M').#) $@')>-?&'+$) L('6.$)L-(6G) >(%,.M') cardNumber @')L"#$%&'(`#) BT)$%)B])6.0.$#) ) L('6.$)L-(6) +"&J'() expirationDate @')'Z>.(-$.%+) bbbbD//) ) 6-$'),%()$@') L"#$%&'(`#) ) L('6.$)L-(6) ) cardCode @')$@(''D)%() H"&'(.L) @.#),.'M6).#)('O".('6).,) ,%"(D6.0.$) $@')&'(L@-+$)Y%"M6) +"&J'()%+)$@') M.c')$%)"#')$@')!-(6) J-Lc)%,)-)L('6.$) !%6')V'(.,.L-$.%+) L-(6)1%+)$@') 1!!V2)#'L"(.$?),'-$"('G) ,(%+$),%() S%()&%(').+,%(&-$.%+I) E&'(.L-+) >M'-#')#'')$@') [Z>('##2)) Merchant Integration Guide -$) ) @$$>8::YYYG-"$@%(.F'G+ Optional) '$:#">>%($:/'(L@-+$:6' ,-"M$G@$&G) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ B;)
    • Merchant Web Services API ELEMENT VALUE FORMAT NOTES ) cardCode).#)%+M?)"#'6) ,%()7-M.6-$.%+)-+6)Y.MM) +%$)J')#$%('6).+)$@') L"#$%&'()>(%,.M'G)*$) #@%"M6)%+M?)J')"#'6) Y@'+)#"J&.$$.+0 validationMode)Y.$@)-) 7-M"')%,)testMode)%() liveModeG) bankAccount !%+$-.+#)J-+c) ) @.#)'M'&'+$).#)%+M?) -LL%"+$) ('O".('6)Y@'+)$@') >-?&'+$) >-?&'+$)>(%,.M').#)J-+c) .+,%(&-$.%+),%() -LL%"+$G) $@')>-?&'+$) >(%,.M') accountType @')$?>')%,) L@'Lc.+0)) ) J-+c)-LL%"+$) ,%()$@')>-?&'+$) #-7.+0#)) >(%,.M') J"#.+'##!@'Lc.+0) ) Optional) routingNumber @')(%"$.+0) =)6.0.$#) ) +"&J'()%,)$@') L"#$%&'(`#) J-+c)) accountNumber @')L"#$%&'(`#) P)$%)B9)6.0.$#) ) J-+c)-LL%"+$) +"&J'() nameOnAccount @')L"#$%&'(`#) ^>)$%);;)L@-(-L$'(#) ) ,"MM)+-&')-#) M.#$'6)%+)$@') J-+c)-LL%"+$))) echeckType @')$?>')%,) !!Q) !"(('+$M?I)$@')!*/)EU*) 'M'L$(%+.L)L@'Lc) 6%'#)+%$)#">>%($)EN!) $(-+#-L$.%+)) UUQ) %()de!)$(-+#-L$.%+) [4) $?>'#G) ) Optional) R[d) bankName @')+-&')%,) ^>)$%)P<)L@-(-L$'(#) ) $@')J-+c) -##%L.-$'6)Y.$@) $@')J-+c) -LL%"+$)+"&J'() ) Optional) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ BT)
    • Section 2 Executing an API Call ELEMENT VALUE FORMAT NOTES shipToList !%+$-.+#) ) ) #@.>>.+0) -66('##) .+,%(&-$.%+),%() $@')L"#$%&'() >(%,.M') firstName @')L"#$%&'(`#) ^>)$%)P<)L@-(-L$'(#)1+%) ) ,.(#$)+-&') #?&J%M#2) ) Optional lastName @')L"#$%&'(`#) ^>)$%)P<)L@-(-L$'(#)1+%) ) M-#$)+-&') #?&J%M#2) ) Optional) company @')+-&')%,) ^>)$%)P<)L@-(-L$'(#)1+%) ) $@')L%&>-+?) #?&J%M#2) -##%L.-$'6)Y.$@) $@')L"#$%&'(I).,) ->>M.L-JM') ) Optional) address @')L"#$%&'(`#) ^>)$%)]<)L@-(-L$'(#)1+%) ) #@.>>.+0) #?&J%M#2) -66('##) ) Optional) city @')L.$?)%,)$@') ^>)$%)W<)L@-(-L$'(#)1+%) ) L"#$%&'(`#) #?&J%M#2) #@.>>.+0) -66('##) ) Optional) state @')#$-$')%,)$@') E)7-M.6)$Y%DL@-(-L$'() ) L"#$%&'(`#) #$-$')L%6') #@.>>.+0) -66('##) ) Optional) zip @')a*U)L%6')%,) ^>)$%);<)L@-(-L$'(#)1+%) ) $@')L"#$%&'(`#) #?&J%M#2) #@.>>.+0) -66('##) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ BW)
    • Merchant Web Services API ELEMENT VALUE FORMAT NOTES ) Optional) country @')L%"+$(?)%,) ^>)$%)]<)L@-(-L$'(#)1+%) ) $@')L"#$%&'(`#) #?&J%M#2) #@.>>.+0) -66('##) ) Optional) phoneNumber @')>@%+') ^>)$%);P)6.0.$#)1+%) ) +"&J'() M'$$'(#2) -##%L.-$'6)Y.$@) $@')L"#$%&'() ) >(%,.M') [ZG)1B;T2B;TDB;TW) ) Optional faxNumber @'),-Z)+"&J'() ^>)$%);P)6.0.$#)1+%) ) -##%L.-$'6)Y.$@) M'$$'(#2) $@')L"#$%&'() >(%,.M') ) ) [ZG)1B;T2B;TDB;TW) Optional) validationMode *+6.L-$'#)$@') +%+') V-M.6-$.%+)&%6')-MM%Y#) >(%L'##.+0) ?%")$%)0'+'(-$')-)$'#$) &%6'),%()$@') $'#$/%6') $(-+#-L$.%+)-$)$@')$.&') ('O"'#$) M.7'/%6') ?%")L('-$')-)L"#$%&'() >(%,.M'G)*+)'#$)/%6'I) ) %+M?),.'M6)7-M.6-$.%+).#) Optional) >'(,%(&'6G)*+)4.7') /%6'I)-)$(-+#-L$.%+).#) ) 0'+'(-$'6)-+6) #"J&.$$'6)$%)$@') >(%L'##%()Y.$@)$@') -&%"+$)%,)f<G<BG)*,) #"LL'##,"MI)$@') $(-+#-L$.%+).#) .&&'6.-$'M?)7%.6'6G R@'+)-)7-M"')%,) g+%+'g).#)#"J&.$$'6I)+%) -66.$.%+-M)7-M.6-$.%+).#) >'(,%(&'6G) ) *,)-)('O"'#$)6%'#)+%$) .+LM"6')-+?)>-?&'+$) >(%,.M').+,%(&-$.%+I)$@') 7-M.6-$.%+)&%6')&"#$) J')#'$)$%)h+%+'Gi)) ) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ BP)
    • Section 2 Executing an API Call ELEMENT VALUE FORMAT NOTES *,)-)7-M.6-$.%+) $(-+#-L$.%+).#) "+#"LL'##,"MI)$@') >(%,.M')Y.MM)+%$)J') L('-$'6)-+6)$@') &'(L@-+$)Y.MM)('L'.7') -+)'((%(G) For information about output for this function, see the section of this document titled “Output Elements for createCustomerProfileResponse.” Example createCustomerProfileRequest <?xml version="1.0" encoding="utf-8"?> <createCustomerProfileRequest xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <merchantAuthentication> <name>API Login ID here</name> <transactionKey>Transaction Key here</transactionKey> </merchantAuthentication> <profile> <merchantCustomerId>Merchant Customer ID here</merchantCustomerId> <description>Profile description here</description> <email>customer profile email address here</email> <paymentProfiles> <customerType>individual</customerType> <payment> <creditCard> <cardNumber>Credit card number here</cardNumber> <expirationDate>Credit card expiration date here</expirationDate> </creditCard> </payment> </paymentProfiles> </profile> <validationMode>liveMode</validationMode> </createCustomerProfileRequest> Note: The sample code included in this document uses dummy field values. When using or testing sample code, be sure to enter valid field values. Additional sample code is available for download from the Authorize.Net Integration Center at http://developer.authorize.net/samplecode. 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ B])
    • Merchant Web Services API Input Elements for createCustomerPaymentProfileRequest This function is used to create a new customer payment profile for an existing customer profile. The following table lists the input elements for executing an API call to the createCustomerPaymentProfileRequest function. ELEMENT VALUE FORMAT NOTES refId /'(L@-+$D-##.0+'6) ^>)$%);<)L@-(-L$'(#) *,).+LM"6'6).+)$@') (','('+L')*Q),%()$@') ('O"'#$I)$@.#)7-M"')Y.MM) ('O"'#$) J').+LM"6'6).+)$@') ('#>%+#'G)@.#),'-$"(') ) &.0@$)J')'#>'L.-MM?) Optional "#',"M),%()&"M$.D$@('-6'6) ->>M.L-$.%+#G) customerProfileId U-?&'+$)0-$'Y-?) H"&'(.L) ) -##.0+'6)*Q) -##%L.-$'6)Y.$@)$@') L"#$%&'()>(%,.M') paymentProfile !%+$-.+#)>-?&'+$) ) ) .+,%(&-$.%+),%()$@') L"#$%&'()>(%,.M') customerType Optional) .+6.7.6"-M) ) J"#.+'##) billTo ) ) ) firstName @')L"#$%&'(`#),.(#$) ^>)$%)P<)L@-(-L$'(#)1+%) ) +-&') #?&J%M#2) ) Optional) lastName @')L"#$%&'(`#)M-#$) ^>)$%)P<)L@-(-L$'(#)1+%) ) +-&') #?&J%M#2) ) Optional) company @')+-&')%,)$@') ^>)$%)P<)L@-(-L$'(#)1+%) ) L%&>-+?)-##%L.-$'6) #?&J%M#2) Y.$@)$@')L"#$%&'(I).,) ->>M.L-JM') ) Optional) address @')L"#$%&'(`#) ^>)$%)]<)L@-(-L$'(#)1+%) ) -66('##) #?&J%M#2) ) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ B9)
    • Section 2 Executing an API Call ELEMENT VALUE FORMAT NOTES Optional) city @')L.$?)%,)$@') ^>)$%)W<)L@-(-L$'(#)1+%) ) L"#$%&'(`#)-66('##) #?&J%M#2) ) Optional) state @')#$-$')%,)$@') E)7-M.6)$Y%DL@-(-L$'() ) L"#$%&'(`#)-66('##) #$-$')L%6') ) Optional) zip @')a*U)L%6')%,)$@') ^>)$%);<)L@-(-L$'(#)1+%) ) L"#$%&'(`#)-66('##) #?&J%M#2) ) Optional) country @')L%"+$(?)%,)$@') ^>)$%)]<)L@-(-L$'(#)1+%) ) L"#$%&'(`#)-66('##) #?&J%M#2) ) Optional) phoneNumber @')>@%+')+"&J'() ^>)$%);P)6.0.$#)1+%) ) -##%L.-$'6)Y.$@)$@') M'$$'(#2) L"#$%&'(`#)-66('##) ) ) [ZG)1B;T2B;TDB;TW) Optional) faxNumber @'),-Z)+"&J'() ^>)$%);P)6.0.$#)1+%) ) -##%L.-$'6)Y.$@)$@') M'$$'(#2) L"#$%&'(`#)-66('##) ) ) [ZG)1B;T2B;TDB;TW) Optional) payment !%+$-.+#)>-?&'+$) ) !-+)L%+$-.+)creditCard) .+,%(&-$.%+),%()$@') %()bankAccount) L"#$%&'()>(%,.M') creditCard !%+$-.+#)L('6.$)L-(6) ) @.#)'M'&'+$).#)%+M?) >-?&'+$).+,%(&-$.%+) ('O".('6)Y@'+)$@') ,%()$@')L"#$%&'() >-?&'+$)>(%,.M').#)L('6.$) >(%,.M') L-(6G) cardNumber @')L"#$%&'(`#) BT)$%)B])6.0.$#) ) L('6.$)L-(6)+"&J'() expirationDate @')'Z>.(-$.%+)6-$') bbbbD//) ) ,%()$@')L"#$%&'(`#) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ BC)
    • Merchant Web Services API ELEMENT VALUE FORMAT NOTES L('6.$)L-(6) cardCode @')$@(''D)%(),%"(D H"&'(.L) @.#),.'M6).#)('O".('6).,) 6.0.$)+"&J'()%+)$@') $@')&'(L@-+$)Y%"M6)M.c') J-Lc)%,)-)L('6.$)L-(6) $%)"#')$@')!-(6)!%6') 1%+)$@'),(%+$),%() V'(.,.L-$.%+)1!!V2) E&'(.L-+)[Z>('##2)) #'L"(.$?),'-$"('G)S%() &%(').+,%(&-$.%+I) ) >M'-#')#'')$@') Optional) Merchant Integration Guide -$) @$$>8::YYYG-"$@%(.F'G+'$ :#">>%($:/'(L@-+$:6',-" M$G@$&G) ) cardCode).#)%+M?)"#'6) ,%()7-M.6-$.%+)-+6)Y.MM) +%$)J')#$%('6).+)$@') L"#$%&'()>(%,.M'G)*$) #@%"M6)%+M?)J')"#'6) Y@'+)#"J&.$$.+0 validationMode)Y.$@)-) 7-M"')%,)testMode)%() liveModeG) bankAccount !%+$-.+#)J-+c) ) @.#)'M'&'+$).#)%+M?) -LL%"+$)>-?&'+$) ('O".('6)Y@'+)$@') .+,%(&-$.%+),%()$@') >-?&'+$)>(%,.M').#)J-+c) L"#$%&'()>(%,.M') -LL%"+$G) accountType @')$?>')%,)J-+c) L@'Lc.+0) ) -LL%"+$),%()$@') >-?&'+$)>(%,.M') #-7.+0#) ) J"#.+'##!@'Lc.+0) Optional) routingNumber @')(%"$.+0)+"&J'() =)6.0.$#) ) %,)$@')L"#$%&'(`#) J-+c)) accountNumber @')L"#$%&'(`#) P)$%)B9)6.0.$#) ) J-+c)-LL%"+$) +"&J'() nameOnAccount @')L"#$%&'(`#),"MM) ^>)$%);;)L@-(-L$'(#) ) +-&')-#)M.#$'6)%+) $@')J-+c)-LL%"+$))) echeckType @')$?>')%,) !!Q) !"(('+$M?I)$@')!*/)EU*) 'M'L$(%+.L)L@'Lc) 6%'#)+%$)#">>%($)EN!) $(-+#-L$.%+)) UUQ) %()de!)$(-+#-L$.%+) [4) $?>'#G) ) Optional) R[d) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ B=)
    • Section 2 Executing an API Call ELEMENT VALUE FORMAT NOTES bankName @')+-&')%,)$@') ^>)$%)P<)L@-(-L$'(#) ) J-+c)-##%L.-$'6) Y.$@)$@')J-+c) -LL%"+$)+"&J'() ) Optional) validationMode *+6.L-$'#)$@') +%+') V-M.6-$.%+)&%6')-MM%Y#) >(%L'##.+0)&%6'),%() ?%")$%)0'+'(-$')-)$'#$) $@')('O"'#$) $'#$/%6') $(-+#-L$.%+)-$)$@')$.&') M.7'/%6') ?%")L('-$')-)L"#$%&'() ) >-?&'+$)>(%,.M'G)*+)'#$) /%6'I)%+M?),.'M6) 7-M.6-$.%+).#)>'(,%(&'6G) *+)4.7')/%6'I)-) $(-+#-L$.%+).#)0'+'(-$'6) -+6)#"J&.$$'6)$%)$@') >(%L'##%()Y.$@)$@') -&%"+$)%,)f<G<BG)*,) #"LL'##,"MI)$@') $(-+#-L$.%+).#) .&&'6.-$'M?)7%.6'6G R@'+)-)7-M"')%,)g+%+'g) .#)#"J&.$$'6I)+%) -66.$.%+-M)7-M.6-$.%+).#) >'(,%(&'6G) For information about output elements for this function, see the section of this document titled “Output Elements for createCustomerPaymentProfileResponse.” Example createCustomerPaymentProfileRequest <?xml version="1.0" encoding="utf-8"?> <createCustomerPaymentProfileRequest xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <merchantAuthentication> <name>YourUserLogin</name> <transactionKey>YourTranKey</transactionKey> </merchantAuthentication> <customerProfileId>10000</customerProfileId> <paymentProfile> <billTo> <firstName>John</firstName> <lastName>Doe</lastName> <company></company> <address>123 Main St.</address> <city>Bellevue</city> 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ ;<)
    • Merchant Web Services API <state>WA</state> <zip>98004</zip> <country>USA</country> <phoneNumber>000-000-0000</phoneNumber> <faxNumber></faxNumber> </billTo> <payment> <creditCard> <cardNumber>4111111111111111</cardNumber> <expirationDate>2023-12</expirationDate> </creditCard> </payment> </paymentProfile> <validationMode>liveMode</validationMode> </createCustomerPaymentProfileRequest> Note: The sample code included in this document uses dummy field values. When using or testing sample code, be sure to enter valid field values. Additional sample code is available for download from the Authorize.Net Integration Center at http://developer.authorize.net/samplecode. Input Elements for createCustomerShippingAddressRequest This function is used to create a new customer shipping address for an existing customer profile. The following table lists the input elements for executing an API call to the createCustomerShippingAddressRequest function. ELEMENT VALUE FORMAT NOTES refId /'(L@-+$D-##.0+'6) ^>)$%);<)L@-(-L$'(#) *,).+LM"6'6).+)$@')('O"'#$I) (','('+L')*Q),%()$@') $@.#)7-M"')Y.MM)J').+LM"6'6) ('O"'#$) .+)$@')('#>%+#'G)@.#) ,'-$"(')&.0@$)J') ) '#>'L.-MM?)"#',"M),%()&"M$.D Optional $@('-6'6)->>M.L-$.%+#G) customerProfileId U-?&'+$)0-$'Y-?) H"&'(.L) ) -##.0+'6)*Q)-##%L.-$'6) Y.$@)$@')L"#$%&'()>(%,.M') address !%+$-.+#)#@.>>.+0) ) ) -66('##).+,%(&-$.%+),%() $@')L"#$%&'()>(%,.M') 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ ;B)
    • Section 2 Executing an API Call ELEMENT VALUE FORMAT NOTES firstName @')L"#$%&'(`#),.(#$)+-&') ^>)$%)P<)L@-(-L$'(#)1+%) ) #?&J%M#2) ) Optional lastName @')L"#$%&'(`#)M-#$)+-&') ^>)$%)P<)L@-(-L$'(#)1+%) ) #?&J%M#2) ) Optional) company @')+-&')%,)$@')L%&>-+?) ^>)$%)P<)L@-(-L$'(#)1+%) ) -##%L.-$'6)Y.$@)$@') #?&J%M#2) L"#$%&'(I).,)->>M.L-JM') ) Optional) address @')L"#$%&'(`#)#@.>>.+0) ^>)$%)]<)L@-(-L$'(#)1+%) ) -66('##) #?&J%M#2) ) Optional) city @')L.$?)%,)$@')L"#$%&'(`#) ^>)$%)W<)L@-(-L$'(#)1+%) ) #@.>>.+0)-66('##) #?&J%M#2) ) Optional) state @')#$-$')%,)$@') E)7-M.6)$Y%DL@-(-L$'() ) L"#$%&'(`#)#@.>>.+0) #$-$')L%6') -66('##) ) Optional) zip @')a*U)L%6')%,)$@') ^>)$%);<)L@-(-L$'(#)1+%) ) L"#$%&'(`#)#@.>>.+0) #?&J%M#2) -66('##) ) Optional) country @')L%"+$(?)%,)$@') ^>)$%)]<)L@-(-L$'(#)1+%) ) L"#$%&'(`#)#@.>>.+0) #?&J%M#2) -66('##) ) Optional) phoneNumber @')>@%+')+"&J'() ^>)$%);P)6.0.$#)1+%)M'$$'(#2) ) -##%L.-$'6)Y.$@)$@') L"#$%&'(`#)#@.>>.+0) ) -66('##) [ZG)1B;T2B;TDB;TW) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ ;;)
    • Merchant Web Services API ELEMENT VALUE FORMAT NOTES ) Optional) faxNumber @'),-Z)+"&J'() ^>)$%);P)6.0.$#)1+%)M'$$'(#2) ) -##%L.-$'6)Y.$@)$@') L"#$%&'(`#)#@.>>.+0) ) -66('##) [ZG)1B;T2B;TDB;TW) ) Optional) For information about output elements for this function, see the section of this document titled “Output Elements for createCustomerShippingAddressResponse.” Example createCustomerShippingAddressRequest <?xml version="1.0" encoding="utf-8"?> <createCustomerShippingAddressRequest xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <merchantAuthentication> <name>YourUserLogin</name> <transactionKey>YourTranKey</transactionKey> </merchantAuthentication> <customerProfileId>10000</customerProfileId> <address> <firstName>John</firstName> <lastName>Doe</lastName> <company></company> <address>123 Main St.</address> <city>Bellevue</city> <state>WA</state> <zip>98004</zip> <country>USA</country> <phoneNumber>000-000-0000</phoneNumber> <faxNumber></faxNumber> </address> </createCustomerShippingAddressRequest> Note: The sample code included in this document uses dummy field values. When using or testing sample code, be sure to enter valid field values. Additional sample code is available for download from the Authorize.Net Integration Center at http://developer.authorize.net/samplecode. 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ ;T)
    • Section 2 Executing an API Call Input Elements for createCustomerProfileTransactionRequest This function is used to create a payment transaction from an existing customer profile. You can submit one of six transaction types: Authorization Only, Authorization and Capture, Capture Only, Prior Authorization and Capture, Refund and Void. For more information on these transaction types, please see the Merchant Integration Guide at http://www.authorize.net/support/Merchant/default.htm. Note: The only transaction types that generate a customer receipt email are Authorization Only, Authorization and Capture, and Refund. The following table lists the input elements for executing an API call to the createCustomerProfileTransactionRequest function for an Authorization Only transaction. ELEMENT VALUE FORMAT NOTES refId /'(L@-+$D ^>)$%);<)L@-(-L$'(#) *,).+LM"6'6).+)$@') -##.0+'6) ('O"'#$I)$@.#) (','('+L')*Q),%() 7-M"')Y.MM)J') $@')('O"'#$) .+LM"6'6).+)$@') ('#>%+#'G)@.#) ) ,'-$"(')&.0@$)J') Optional '#>'L.-MM?)"#',"M) ,%()&"M$.D $@('-6'6) ->>M.L-$.%+#G) transaction !%+$-.+#) ) ))) $(-+#-L$.%+) .+,%(&-$.%+) profileTransAuthOnly @')$(-+#-L$.%+) ) e+M?)%+') $?>')$@-$).#) $(-+#-L$.%+)$?>') J'.+0)('O"'#$'6) ) .#)-MM%Y'6)>'() ) ('O"'#$G) ) ) amount @')$%$-M) ^>)$%)W)6.0.$#)-,$'()$@') @.#)-&%"+$) -&%"+$)%,)$@') 6'L.&-M)>%.+$)1+%)6%MM-() #@%"M6).+LM"6') $(-+#-L$.%+)) #?&J%M2) -MM)%$@'() -&%"+$#)#"L@) ) -#)$-Z)-&%"+$I) [ZG)B;G==)%()B;G====) #@.>>.+0) -&%"+$I)'$LG) tax !%+$-.+#)$-Z) ) ) .+,%(&-$.%+),%() $@')$(-+#-L$.%+) ) Optional 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ ;W)
    • Merchant Web Services API ELEMENT VALUE FORMAT NOTES amount @')$-Z)-&%"+$) ^>)$%)W)6.0.$#)-,$'()$@') @.#)-&%"+$) ,%()$@') 6'L.&-M)>%.+$)1+%)6%MM-() &"#$)J') $(-+#-L$.%+) #?&J%M2) .+LM"6'6).+)$@') $%$-M)-&%"+$),%() ) ) $@')$(-+#-L$.%+G) Optional) [ZG)B;G==)%()B;G====) name @')+-&')%,) ^>)$%)TB)L@-(-L$'(#) ) $@')$-Z),%()$@') $(-+#-L$.%+) ) Optional description @')$-Z) ^>)$%);PP)L@-(-L$'(#) ) 6'#L(.>$.%+),%() $@')$(-+#-L$.%+) ) Optional shipping !%+$-.+#) ) ) #@.>>.+0) .+,%(&-$.%+),%() $@')$(-+#-L$.%+) ) Optional) amount @')#@.>>.+0) ^>)$%)W)6.0.$#)-,$'()$@') @.#)-&%"+$) -&%"+$),%()$@') 6'L.&-M)>%.+$)1+%)6%MM-() &"#$)J') $(-+#-L$.%+) #?&J%M2) .+LM"6'6).+)$@') $%$-M)-&%"+$),%() ) ) $@')$(-+#-L$.%+G) Optional) [ZG)B;G==)%()B;G====) name @')+-&')%,) ^>)$%)TB)L@-(-L$'(#) ) $@')#@.>>.+0),%() $@')$(-+#-L$.%+) ) Optional) description @')#@.>>.+0) ^>)$%);PP)L@-(-L$'(#) ) 6'#L(.>$.%+),%() $@')$(-+#-L$.%+) ) Optional) duty !%+$-.+#)6"$?) ) ) .+,%(&-$.%+),%() $@')$(-+#-L$.%+) ) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ ;P)
    • Section 2 Executing an API Call ELEMENT VALUE FORMAT NOTES Optional) amount @')6"$?) ^>)$%)W)6.0.$#)-,$'()$@') @.#)-&%"+$) -&%"+$),%()$@') 6'L.&-M)>%.+$)1+%)6%MM-() &"#$)J') $(-+#-L$.%+) #?&J%M2) .+LM"6'6).+)$@') $%$-M)-&%"+$),%() ) ) $@')$(-+#-L$.%+G) Optional) [ZG)B;G==)%()B;G====) name @')+-&')%,) ^>)$%)TB)L@-(-L$'(#) ) $@')6"$?),%()$@') $(-+#-L$.%+) ) Optional) description @')6"$?) ^>)$%);PP)L@-(-L$'(#) ) 6'#L(.>$.%+),%() $@')$(-+#-L$.%+) ) Optional) lineItems !%+$-.+#)M.+') ) ^>)$%)T<)6.#$.+L$) .$'&)6'$-.M#) .+#$-+L'#)%,)$@.#) -J%"$)$@')%(6'() 'M'&'+$)&-?)J') .+LM"6'6)>'() ) $(-+#-L$.%+)$%) Optional)) 6'#L(.J').$'&#) .+LM"6'6).+)$@') %(6'(G) itemId @')*Q) ^>)$%)TB)L@-(-L$'(#) ) -##.0+'6)$%)$@') .$'&) ) Optional) name E)#@%($) ^>)$%)TB)L@-(-L$'(#) ) 6'#L(.>$.%+)%,) -+).$'&) ) Optional) description E)6'$-.M'6) ^>)$%);PP)L@-(-L$'(#) ) 6'#L(.>$.%+)%,) -+).$'&) ) Optional) quantity @')O"-+$.$?)%,) ^>)$%)W)6.0.$#)1">)$%)$Y%) ) -+).$'&) 6'L.&-M)>M-L'#2) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ ;])
    • Merchant Web Services API ELEMENT VALUE FORMAT NOTES ) Optional) unitPrice !%#$)%,)-+).$'&) ^>)$%)W)6.0.$#)Y.$@)-)6'L.&-M) ) >'()"+.$) >%.+$)1+%)6%MM-()#?&J%M2) excluding)$-ZI) ,('.0@$I)-+6)6"$?) ) ) [ZG)WG=P) Optional) taxable *+6.L-$'#) ,-M#') ) Y@'$@'()$@') .$'&).#)#"Jj'L$) $("') $%)$-Z) ) Optional) customerProfileId U-?&'+$) H"&'(.L) ) 0-$'Y-?) -##.0+'6)*Q) -##%L.-$'6)Y.$@) $@')L"#$%&'() >(%,.M') customerPaymentProfileId U-?&'+$) H"&'(.L) ) 0-$'Y-?) -##.0+'6)*Q) -##%L.-$'6)Y.$@) $@')L"#$%&'() >-?&'+$)>(%,.M') customerShippingAddressId U-?&'+$) H"&'(.L) *,) 0-$'Y-?) customerShipp -##.0+'6)*Q) ingAddressId).#) -##%L.-$'6)Y.$@) +%$)>-##'6I) $@')L"#$%&'() #@.>>.+0) #@.>>.+0) .+,%(&-$.%+)Y.MM) -66('##) +%$)J').+LM"6'6) Y.$@)$@') ) $(-+#-L$.%+G) Optional order !%+$-.+#) ) ) .+,%(&-$.%+) -J%"$)$@')%(6'() ) Optional) invoiceNumber @')&'(L@-+$) ^>)$%);<)L@-(-L$'(#)1+%) ) -##.0+'6) #?&J%M#2) .+7%.L')+"&J'() ,%()$@') 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ ;9)
    • Section 2 Executing an API Call ELEMENT VALUE FORMAT NOTES $(-+#-L$.%+) ) Optional) description @')$(-+#-L$.%+) ^>)$%);PP)L@-(-L$'(#)1+%) ) 6'#L(.>$.%+) #?&J%M#2) ) Optional) purchaseOrderNumber @')&'(L@-+$) ^>)$%);P)L@-(-L$'(#)1+%) ) -##.0+'6) #?&J%M#2) >"(L@-#')%(6'() +"&J'() ) Optional) taxExempt @')$-Z)'Z'&>$) N^[) ) #$-$"#) SE4K[) ) Optional) recurringBilling @')('L"((.+0) N^[) ) J.MM.+0)#$-$"#) SE4K[) ) Optional) cardCode @')L"#$%&'(`#) T)$%)W)6.0.$#) @.#),.'M6).#) L-(6)L%6')1$@') ('O".('6).,)$@') $@(''D)%(),%"(D &'(L@-+$)Y%"M6) 6.0.$)+"&J'()%+) M.c')$%)"#')$@') $@')J-Lc)%() !!V)#'L"(.$?) ,(%+$)%,)-)L('6.$) ,'-$"('G)S%() L-(62)) &%(') .+,%(&-$.%+I) ) >M'-#')#'')$@') N'O".('6)%+M?) Merchant Y@'+)$@') Integration &'(L@-+$)Y%"M6) Guide)-$) M.c')$%)"#')$@') @$$>8::YYYG-"$@ !-(6)!%6') %(.F'G+'$:#">>%( V'(.,.L-$.%+) $:/'(L@-+$:6',- 1!!V2),.M$'() "M$G@$&G) ) Conditional) extraOptions *+,%(&-$.%+).+) K$(.+0)1#'')'Z-&>M')J'M%Y2) S%()-)L%&>M'$') +-&':7-M"')>-.() M.#$)%,)$@') ,%(&-$)$@-$) $(-+#-L$.%+) 6%'#)+%$)'Z.#$) 7-(.-JM')+-&'#) Y.$@.+)!*/I) -7-.M-JM'I) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ ;C)
    • Merchant Web Services API ELEMENT VALUE FORMAT NOTES #"L@)-#) >M'-#')('7.'Y) L"#$%&'()*U) $@')AIM -66('##I)'$LG) Implementation Guide M%L-$'6)-$) @$$>8::YYYG-"$@ Optional) %(.F'G+'$:#">>%( $:-.&k0".6'G>6,G) For information about output elements for this function, see the section of this document titled “Output Elements for createCustomerProfileTransactionResponse.” Example createCustomerProfileTransactionRequest for an Authorization Only transaction <?xml version="1.0" encoding="utf-8"?> <createCustomerProfileTransactionRequest xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <merchantAuthentication> <name>YourUserLogin</name> <transactionKey>YourTranKey</transactionKey> </merchantAuthentication> <transaction> <profileTransAuthOnly> <amount>10.95</amount> <tax> <amount>1.00</amount> <name>WA state sales tax</name> <description>Washington state sales tax</description> </tax> <shipping> <amount>2.00</amount> <name>ground based shipping</name> <description>Ground based 5 to 10 day shipping </description> </shipping> <lineItems> <itemId>ITEM00001</itemId> <name>name of item sold</name> <description>Description of item sold</description> <quantity>1</quantity> <unitPrice>6.95</unitPrice> 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ ;=)
    • Section 2 Executing an API Call <taxable>true</taxable> </lineItems> <lineItems> <itemId>ITEM00002</itemId> <name>name of other item sold</name> <description>Description of other item sold </description> <quantity>1</quantity> <unitPrice>1.00</unitPrice> <taxable>true</taxable> </lineItems> <customerProfileId>10000</customerProfileId> <customerPaymentProfileId>20000</customerPaymentProfileId> <customerShippingAddressId>30000</customerShippingAddressId> <order> <invoiceNumber>INV000001</invoiceNumber> <description>description of transaction</description> <purchaseOrderNumber>PONUM000001</purchaseOrderNumber> </order> <taxExempt>false</taxExempt> <recurringBilling>false</recurringBilling> <cardCode>000</cardCode> </profileTransAuthOnly> </transaction> <extraOptions><![CDATA[x_customer_ip=100.0.0.1&x_authentication_ indicator=5&x_cardholder_authentication_value=uq3wDbqt8A26rfANAA AAAP]]></extraOptions> </createCustomerProfileTransactionRequest> Note: The sample code included in this document uses dummy field values. When using or testing sample code, be sure to enter valid field values. Additional sample code is available for download from the Authorize.Net Integration Center at http://developer.authorize.net/samplecode. The following table lists the input elements for executing an API call to the createCustomerProfileTransactionRequest function for an Authorization and Capture transaction. ELEMENT VALUE FORMAT NOTES refId /'(L@-+$D ^>)$%);<)L@-(-L$'(#) *,).+LM"6'6).+)$@') -##.0+'6) ('O"'#$I)$@.#) (','('+L')*Q),%() 7-M"')Y.MM)J') 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ T<)
    • Merchant Web Services API ELEMENT VALUE FORMAT NOTES $@')('O"'#$) .+LM"6'6).+)$@') ('#>%+#'G)@.#) ) ,'-$"(')&.0@$)J') Optional '#>'L.-MM?)"#',"M) ,%()&"M$.D $@('-6'6) ->>M.L-$.%+#G) transaction !%+$-.+#) ) )) $(-+#-L$.%+) .+,%(&-$.%+) profileTransAuthCapture @')$(-+#-L$.%+) ) e+M?)%+') $?>')$@-$).#) $(-+#-L$.%+)$?>') J'.+0)('O"'#$'6) ) .#)-MM%Y'6)>'() ) ('O"'#$G) ) ) amount @')$%$-M) ^>)$%)W)6.0.$#)-,$'()$@') @.#)-&%"+$) -&%"+$)%,)$@') 6'L.&-M)>%.+$)1+%)6%MM-() #@%"M6).+LM"6') $(-+#-L$.%+)) #?&J%M2) -MM)%$@'() -&%"+$#)#"L@) ) -#)$-Z)-&%"+$I) [ZG)B;G==)%()B;G====) #@.>>.+0) -&%"+$I)'$LG) tax !%+$-.+#)$-Z) ) ) .+,%(&-$.%+),%() $@')$(-+#-L$.%+) ) Optional amount @')$-Z)-&%"+$) ^>)$%)W)6.0.$#)-,$'()$@') @.#)-&%"+$) ,%()$@') 6'L.&-M)>%.+$)1+%)6%MM-() &"#$)J') $(-+#-L$.%+) #?&J%M2) .+LM"6'6).+)$@') $%$-M)-&%"+$),%() ) ) $@')$(-+#-L$.%+G) Optional) [ZG)B;G==)%()B;G====) name @')+-&')%,) ^>)$%)TB)L@-(-L$'(#) ) $@')$-Z),%()$@') $(-+#-L$.%+) ) Optional description @')$-Z) ^>)$%);PP)L@-(-L$'(#) ) 6'#L(.>$.%+),%() $@')$(-+#-L$.%+) ) Optional 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ TB)
    • Section 2 Executing an API Call ELEMENT VALUE FORMAT NOTES shipping !%+$-.+#) ) ) #@.>>.+0) .+,%(&-$.%+),%() $@')$(-+#-L$.%+) ) Optional) amount @')#@.>>.+0) ^>)$%)W)6.0.$#)-,$'()$@') @.#)-&%"+$) -&%"+$),%()$@') 6'L.&-M)>%.+$)1+%)6%MM-() &"#$)J') $(-+#-L$.%+) #?&J%M2) .+LM"6'6).+)$@') $%$-M)-&%"+$),%() ) ) $@')$(-+#-L$.%+G) Optional) [ZG)B;G==)%()B;G====) name @')+-&')%,) ^>)$%)TB)L@-(-L$'(#) ) $@')#@.>>.+0),%() $@')$(-+#-L$.%+) ) Optional) description @')#@.>>.+0) ^>)$%);PP)L@-(-L$'(#) ) 6'#L(.>$.%+),%() $@')$(-+#-L$.%+) ) Optional) duty !%+$-.+#)6"$?) ) ) .+,%(&-$.%+),%() $@')$(-+#-L$.%+) ) Optional) amount @')6"$?) ^>)$%)W)6.0.$#)-,$'()$@') @.#)-&%"+$) -&%"+$),%()$@') 6'L.&-M)>%.+$)1+%)6%MM-() &"#$)J') $(-+#-L$.%+) #?&J%M2) .+LM"6'6).+)$@') $%$-M)-&%"+$),%() ) ) $@')$(-+#-L$.%+G) Optional) [ZG)B;G==)%()B;G====) name @')+-&')%,) ^>)$%)TB)L@-(-L$'(#) ) $@')6"$?),%()$@') $(-+#-L$.%+) ) Optional) description @')6"$?) ^>)$%);PP)L@-(-L$'(#) ) 6'#L(.>$.%+),%() $@')$(-+#-L$.%+) ) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ T;)
    • Merchant Web Services API ELEMENT VALUE FORMAT NOTES Optional) lineItems !%+$-.+#)M.+') ) ^>)$%)T<)6.#$.+L$) .$'&)6'$-.M#) .+#$-+L'#)%,)$@.#) -J%"$)$@')%(6'() 'M'&'+$)&-?)J') .+LM"6'6)>'() ) $(-+#-L$.%+)$%) Optional)) 6'#L(.J').$'&#) .+LM"6'6).+)$@') %(6'(G) itemId @')*Q) ^>)$%)TB)L@-(-L$'(#) ) -##.0+'6)$%)$@') .$'&) ) Optional) name E)#@%($) ^>)$%)TB)L@-(-L$'(#) ) 6'#L(.>$.%+)%,) -+).$'&) ) Optional) description E)6'$-.M'6) ^>)$%);PP)L@-(-L$'(#) ) 6'#L(.>$.%+)%,) -+).$'&) ) Optional) quantity @')O"-+$.$?)%,) ^>)$%)W)6.0.$#)1">)$%)$Y%) ) -+).$'&) 6'L.&-M)>M-L'#2) ) Optional) unitPrice !%#$)%,)-+).$'&) ^>)$%)W)6.0.$#)Y.$@)-)6'L.&-M) ) >'()"+.$) >%.+$)1+%)6%MM-()#?&J%M2) excluding)$-ZI) ,('.0@$I)-+6)6"$?) ) ) [ZG)WG=P) Optional) taxable *+6.L-$'#) ,-M#') ) Y@'$@'()$@') .$'&).#)#"Jj'L$) $("') $%)$-Z) ) Optional) customerProfileId U-?&'+$) H"&'(.L) ) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ TT)
    • Section 2 Executing an API Call ELEMENT VALUE FORMAT NOTES 0-$'Y-?) -##.0+'6)*Q) -##%L.-$'6)Y.$@) $@')L"#$%&'() >(%,.M') customerPaymentProfileId U-?&'+$) H"&'(.L) ) 0-$'Y-?) -##.0+'6)*Q) -##%L.-$'6)Y.$@) $@')L"#$%&'() >-?&'+$)>(%,.M') customerShippingAddressId U-?&'+$) H"&'(.L) *,) 0-$'Y-?) customerShipp -##.0+'6)*Q) ingAddressId).#) -##%L.-$'6)Y.$@) +%$)>-##'6I) $@')L"#$%&'() #@.>>.+0) #@.>>.+0) .+,%(&-$.%+)Y.MM) -66('##) +%$)J').+LM"6'6) Y.$@)$@') ) $(-+#-L$.%+G) Optional order !%+$-.+#) ) ) .+,%(&-$.%+) -J%"$)$@')%(6'() ) Optional) invoiceNumber @')&'(L@-+$) ^>)$%);<)L@-(-L$'(#)1+%) ) -##.0+'6) #?&J%M#2) .+7%.L')+"&J'() ,%()$@') $(-+#-L$.%+) ) Optional) description @')$(-+#-L$.%+) ^>)$%);PP)L@-(-L$'(#)1+%) ) 6'#L(.>$.%+) #?&J%M#2) ) Optional) purchaseOrderNumber @')&'(L@-+$) ^>)$%);P)L@-(-L$'(#)1+%) ) -##.0+'6) #?&J%M#2) >"(L@-#')%(6'() +"&J'() ) Optional) taxExempt @')$-Z)'Z'&>$) N^[) ) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ TW)
    • Merchant Web Services API ELEMENT VALUE FORMAT NOTES #$-$"#) SE4K[) ) Optional) recurringBilling @')('L"((.+0) N^[) ) J.MM.+0)#$-$"#) SE4K[) ) Optional) cardCode @')L"#$%&'(`#) T)$%)W)6.0.$#) @.#),.'M6).#) L-(6)L%6')1$@') ('O".('6).,)$@') $@(''D)%(),%"(D &'(L@-+$)Y%"M6) 6.0.$)+"&J'()%+) M.c')$%)"#')$@') $@')J-Lc)%() !!V)#'L"(.$?) ,(%+$)%,)-)L('6.$) ,'-$"('G)S%() L-(62)) &%(') .+,%(&-$.%+I) ) >M'-#')#'')$@') N'O".('6)%+M?) Merchant Y@'+)$@') Integration &'(L@-+$)Y%"M6) Guide)-$) M.c')$%)"#')$@') @$$>8::YYYG-"$@ !-(6)!%6') %(.F'G+'$:#">>%( V'(.,.L-$.%+) $:/'(L@-+$:6',- 1!!V2),.M$'() "M$G@$&G) ) Conditional) extraOptions *+,%(&-$.%+).+) K$(.+0)1#'')'Z-&>M')J'M%Y2) S%()-)L%&>M'$') +-&':7-M"')>-.() M.#$)%,)$@') ,%(&-$)$@-$) $(-+#-L$.%+) 6%'#)+%$)'Z.#$) 7-(.-JM')+-&'#) Y.$@.+)!*/I) -7-.M-JM'I) #"L@)-#) >M'-#')('7.'Y) L"#$%&'()*U) $@')AIM -66('##I)'$LG) Implementation Guide M%L-$'6)-$) @$$>8::YYYG-"$@ Optional) %(.F'G+'$:#">>%( $:-.&k0".6'G>6,G) For information about output elements for this function, see the section of this document titled “Output Elements for createCustomerProfileTransactionResponse.” Example createCustomerProfileTransactionRequest for an Authorization and Capture transaction <?xml version="1.0" encoding="utf-8"?> <createCustomerProfileTransactionRequest xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ TP)
    • Section 2 Executing an API Call <merchantAuthentication> <name>YourUserLogin</name> <transactionKey>YourTranKey</transactionKey> </merchantAuthentication> <transaction> <profileTransAuthCapture> <amount>10.95</amount> <tax> <amount>1.00</amount> <name>WA state sales tax</name> <description>Washington state sales tax</description> </tax> <shipping> <amount>2.00</amount> <name>ground based shipping</name> <description>Ground based 5 to 10 day shipping</description> </shipping> <lineItems> <itemId>ITEM00001</itemId> <name>name of item sold</name> <description>Description of item sold</description> <quantity>1</quantity> <unitPrice>6.95</unitPrice> <taxable>true</taxable> </lineItems> <lineItems> <itemId>ITEM00002</itemId> <name>name of other item sold</name> <description>Description of other item sold</description> <quantity>1</quantity> <unitPrice>1.00</unitPrice> <taxable>true</taxable> </lineItems> <customerProfileId>10000</customerProfileId> <customerPaymentProfileId>20000</customerPaymentProfileId> <customerShippingAddressId>30000</customerShippingAddressId> <order> <invoiceNumber>INV000001</invoiceNumber> <description>description of transaction</description> 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ T])
    • Merchant Web Services API <purchaseOrderNumber>PONUM000001</purchaseOrderNumber> </order> <taxExempt>false</taxExempt> <recurringBilling>false</recurringBilling> <cardCode>000</cardCode> </profileTransAuthCapture> </transaction> <extraOptions><![CDATA[x_customer_ip=100.0.0.1]]></extraOptions> </createCustomerProfileTransactionRequest> Note: The sample code included in this document uses dummy field values. When using or testing sample code, be sure to enter valid field values. Additional sample code is available for download from the Authorize.Net Integration Center at http://developer.authorize.net/samplecode. The following table lists the input elements for executing an API call to the createCustomerProfileTransactionRequest function for a Capture Only transaction. ELEMENT VALUE FORMAT NOTES refId /'(L@-+$D ^>)$%);<)L@-(-L$'(#) *,).+LM"6'6).+)$@') -##.0+'6) ('O"'#$I)$@.#) (','('+L')*Q),%() 7-M"')Y.MM)J') $@')('O"'#$) .+LM"6'6).+)$@') ('#>%+#'G)@.#) ) ,'-$"(')&.0@$)J') Optional '#>'L.-MM?)"#',"M) ,%()&"M$.D $@('-6'6) ->>M.L-$.%+#G) transaction !%+$-.+#) ) ) $(-+#-L$.%+) .+,%(&-$.%+) profileTransCaptureOnly @')$(-+#-L$.%+) ) e+M?)%+') $?>')$@-$).#) $(-+#-L$.%+)$?>') J'.+0)('O"'#$'6) ) .#)-MM%Y'6)>'() ) ('O"'#$G) ) ) amount @')$%$-M) ^>)$%)W)6.0.$#)-,$'()$@') @.#)-&%"+$) -&%"+$)%,)$@') 6'L.&-M)>%.+$)1+%)6%MM-() #@%"M6).+LM"6') $(-+#-L$.%+)) #?&J%M2) -MM)%$@'() -&%"+$#)#"L@) ) -#)$-Z)-&%"+$I) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ T9)
    • Section 2 Executing an API Call ELEMENT VALUE FORMAT NOTES [ZG)B;G==)%()B;G====) #@.>>.+0) -&%"+$I)'$LG) tax !%+$-.+#)$-Z) ) ) .+,%(&-$.%+),%() $@')$(-+#-L$.%+) ) Optional amount @')$-Z)-&%"+$) ^>)$%)W)6.0.$#)-,$'()$@') @.#)-&%"+$) ,%()$@') 6'L.&-M)>%.+$)1+%)6%MM-() &"#$)J') $(-+#-L$.%+) #?&J%M2) .+LM"6'6).+)$@') $%$-M)-&%"+$),%() ) ) $@')$(-+#-L$.%+G) Optional) [ZG)B;G==)%()B;G====) name @')+-&')%,) ^>)$%)TB)L@-(-L$'(#) ) $@')$-Z),%()$@') $(-+#-L$.%+) ) Optional description @')$-Z) ^>)$%);PP)L@-(-L$'(#) ) 6'#L(.>$.%+),%() $@')$(-+#-L$.%+) ) Optional shipping !%+$-.+#) ) ) #@.>>.+0) .+,%(&-$.%+),%() $@')$(-+#-L$.%+) ) Optional) amount @')#@.>>.+0) ^>)$%)W)6.0.$#)-,$'()$@') @.#)-&%"+$) -&%"+$),%()$@') 6'L.&-M)>%.+$)1+%)6%MM-() &"#$)J') $(-+#-L$.%+) #?&J%M2) .+LM"6'6).+)$@') $%$-M)-&%"+$),%() ) ) $@')$(-+#-L$.%+G) Optional) [ZG)B;G==)%()B;G====) name @')+-&')%,) ^>)$%)TB)L@-(-L$'(#) ) $@')#@.>>.+0),%() $@')$(-+#-L$.%+) ) Optional) description @')#@.>>.+0) ^>)$%);PP)L@-(-L$'(#) ) 6'#L(.>$.%+),%() 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ TC)
    • Merchant Web Services API ELEMENT VALUE FORMAT NOTES $@')$(-+#-L$.%+) ) Optional) duty !%+$-.+#)6"$?) ) ) .+,%(&-$.%+),%() $@')$(-+#-L$.%+) ) Optional) amount @')6"$?) ^>)$%)W)6.0.$#)-,$'()$@') @.#)-&%"+$) -&%"+$),%()$@') 6'L.&-M)>%.+$)1+%)6%MM-() &"#$)J') $(-+#-L$.%+) #?&J%M2) .+LM"6'6).+)$@') $%$-M)-&%"+$),%() ) ) $@')$(-+#-L$.%+G) Optional) [ZG)B;G==)%()B;G====) name @')+-&')%,) ^>)$%)TB)L@-(-L$'(#) ) $@')6"$?),%()$@') $(-+#-L$.%+) ) Optional) description @')6"$?) ^>)$%);PP)L@-(-L$'(#) ) 6'#L(.>$.%+),%() $@')$(-+#-L$.%+) ) Optional) lineItems !%+$-.+#)M.+') ) ^>)$%)T<)6.#$.+L$) .$'&)6'$-.M#) .+#$-+L'#)%,)$@.#) -J%"$)$@')%(6'() 'M'&'+$)&-?)J') .+LM"6'6)>'() ) $(-+#-L$.%+)$%) Optional)) 6'#L(.J').$'&#) .+LM"6'6).+)$@') %(6'(G) itemId @')*Q) ^>)$%)TB)L@-(-L$'(#) ) -##.0+'6)$%)$@') .$'&) ) Optional) name E)#@%($) ^>)$%)TB)L@-(-L$'(#) ) 6'#L(.>$.%+)%,) -+).$'&) ) Optional) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ T=)
    • Section 2 Executing an API Call ELEMENT VALUE FORMAT NOTES description E)6'$-.M'6) ^>)$%);PP)L@-(-L$'(#) ) 6'#L(.>$.%+)%,) -+).$'&) ) Optional) quantity @')O"-+$.$?)%,) ^>)$%)W)6.0.$#)1">)$%)$Y%) ) -+).$'&) 6'L.&-M)>M-L'#2) ) Optional) unitPrice !%#$)%,)-+).$'&) ^>)$%)W)6.0.$#)Y.$@)-)6'L.&-M) ) >'()"+.$) >%.+$)1+%)6%MM-()#?&J%M2) excluding)$-ZI) ,('.0@$I)-+6)6"$?) ) ) [ZG)WG=P) Optional) taxable *+6.L-$'#) ,-M#') ) Y@'$@'()$@') .$'&).#)#"Jj'L$) $("') $%)$-Z) ) Optional) customerProfileId U-?&'+$) H"&'(.L) ) 0-$'Y-?) -##.0+'6)*Q) -##%L.-$'6)Y.$@) $@')L"#$%&'() >(%,.M') customerPaymentProfileId U-?&'+$) H"&'(.L) ) 0-$'Y-?) -##.0+'6)*Q) -##%L.-$'6)Y.$@) $@')L"#$%&'() >-?&'+$)>(%,.M') customerShippingAddressId U-?&'+$) H"&'(.L) *,) 0-$'Y-?) customerShipp -##.0+'6)*Q) ingAddressId).#) -##%L.-$'6)Y.$@) +%$)>-##'6I) $@')L"#$%&'() #@.>>.+0) #@.>>.+0) .+,%(&-$.%+)Y.MM) -66('##) +%$)J').+LM"6'6) Y.$@)$@') ) $(-+#-L$.%+G) Optional order !%+$-.+#) ) ) .+,%(&-$.%+) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ W<)
    • Merchant Web Services API ELEMENT VALUE FORMAT NOTES -J%"$)$@')%(6'() ) Optional) invoiceNumber @')&'(L@-+$) ^>)$%);<)L@-(-L$'(#)1+%) ) -##.0+'6) #?&J%M#2) .+7%.L')+"&J'() ,%()$@') $(-+#-L$.%+) ) Optional) description @')$(-+#-L$.%+) ^>)$%);PP)L@-(-L$'(#)1+%) ) 6'#L(.>$.%+) #?&J%M#2) ) Optional) purchaseOrderNumber @')&'(L@-+$) ^>)$%);P)L@-(-L$'(#)1+%) ) -##.0+'6) #?&J%M#2) >"(L@-#')%(6'() +"&J'() ) Optional) taxExempt @')$-Z)'Z'&>$) N^[) ) #$-$"#) SE4K[) ) Optional) recurringBilling @')('L"((.+0) N^[) ) J.MM.+0)#$-$"#) SE4K[) ) Optional) cardCode @')L"#$%&'(`#) T)$%)W)6.0.$#) @.#),.'M6).#) L-(6)L%6')1$@') ('O".('6).,)$@') $@(''D)%(),%"(D &'(L@-+$)Y%"M6) 6.0.$)+"&J'()%+) M.c')$%)"#')$@') $@')J-Lc)%() !!V)#'L"(.$?) ,(%+$)%,)-)L('6.$) ,'-$"('G)S%() L-(62)) &%(') .+,%(&-$.%+I) ) >M'-#')#'')$@') N'O".('6)%+M?) Merchant Y@'+)$@') Integration &'(L@-+$)Y%"M6) Guide)-$) M.c')$%)"#')$@') @$$>8::YYYG-"$@ !-(6)!%6') %(.F'G+'$:#">>%( V'(.,.L-$.%+) $:/'(L@-+$:6',- 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ WB)
    • Section 2 Executing an API Call ELEMENT VALUE FORMAT NOTES 1!!V2),.M$'() "M$G@$&G) ) Conditional) approvalCode @') ])L@-(-L$'(#) @.#)'M'&'+$).#) -"$@%(.F-$.%+) %+M?)('O".('6),%() L%6')%,)-+) $@')!->$"(') %(.0.+-M) e+M?)$(-+#-L$.%+) $(-+#-L$.%+) $?>'G) ('O".('6),%()-) !->$"(')e+M?) ) Conditional extraOptions *+,%(&-$.%+).+) K$(.+0)1#'')'Z-&>M')J'M%Y2) S%()-)L%&>M'$') +-&':7-M"')>-.() M.#$)%,)$@') ,%(&-$)$@-$) $(-+#-L$.%+) 6%'#)+%$)'Z.#$) 7-(.-JM')+-&'#) Y.$@.+)!*/I) -7-.M-JM'I) #"L@)-#) >M'-#')('7.'Y) L"#$%&'()*U) $@')AIM -66('##I)'$LG) Implementation Guide M%L-$'6)-$) @$$>8::YYYG-"$@ Optional) %(.F'G+'$:#">>%( $:-.&k0".6'G>6,G) For information about output elements for this function, see the section of this document titled “Output Elements for createCustomerProfileTransactionResponse.” Example createCustomerProfileTransactionRequest for a Capture Only transaction <?xml version="1.0" encoding="utf-8"?> <createCustomerProfileTransactionRequest xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <merchantAuthentication> <name>YourUserLogin</name> <transactionKey>YourTranKey</transactionKey> </merchantAuthentication> <transaction> <profileTransCaptureOnly> <amount>10.95</amount> <tax> <amount>1.00</amount> <name>WA state sales tax</name> <description>Washington state sales tax</description> 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ W;)
    • Merchant Web Services API </tax> <shipping> <amount>2.00</amount> <name>ground based shipping</name> <description>Ground based 5 to 10 day shipping</description> </shipping> <lineItems> <itemId>ITEM00001</itemId> <name>name of item sold</name> <description>Description of item sold</description> <quantity>1</quantity> <unitPrice>6.95</unitPrice> <taxable>true</taxable> </lineItems> <lineItems> <itemId>ITEM00002</itemId> <name>name of other item sold</name> <description>Description of other item sold</description> <quantity>1</quantity> <unitPrice>1.00</unitPrice> <taxable>true</taxable> </lineItems> <customerProfileId>10000</customerProfileId> <customerPaymentProfileId>20000</customerPaymentProfileId> <customerShippingAddressId>30000</customerShippingAddressId> <order> <invoiceNumber>INV000001</invoiceNumber> <description>description of transaction</description> <purchaseOrderNumber>PONUM000001</purchaseOrderNumber> </order> <taxExempt>false</taxExempt> <recurringBilling>false</recurringBilling> <cardCode>000</cardCode> <approvalCode>000000</approvalCode> </profileTransCaptureOnly> </transaction> <extraOptions><![CDATA[x_customer_ip=100.0.0.1]]></extraOptions> </createCustomerProfileTransactionRequest> 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ WT)
    • Section 2 Executing an API Call Note: The sample code included in this document uses dummy field values. When using or testing sample code, be sure to enter valid field values. Additional sample code is available for download from the Authorize.Net Integration Center at http://developer.authorize.net/samplecode. The following table lists the input elements for executing an API call to the createCustomerProfileTransactionRequest function for a Prior Authorization and Capture transaction. ELEMENT VALUE FORMAT NOTES refId /'(L@-+$D ^>)$%);<)L@-(-L$'(#) *,).+LM"6'6).+)$@') -##.0+'6) ('O"'#$I)$@.#) (','('+L')*Q),%() 7-M"')Y.MM)J') $@')('O"'#$) .+LM"6'6).+)$@') ('#>%+#'G)@.#) ) ,'-$"(')&.0@$)J') Optional '#>'L.-MM?)"#',"M) ,%()&"M$.D $@('-6'6) ->>M.L-$.%+#G) transaction !%+$-.+#) ) ) $(-+#-L$.%+) .+,%(&-$.%+) profileTransPriorAuthCapture @')$(-+#-L$.%+) ) e+M?)%+') $?>')$@-$).#) $(-+#-L$.%+)$?>') J'.+0)('O"'#$'6) ) .#)-MM%Y'6)>'() ) ('O"'#$G) ) ) amount @')$%$-M) ^>)$%)W)6.0.$#)-,$'()$@') @.#)-&%"+$) -&%"+$)%,)$@') 6'L.&-M)>%.+$)1+%)6%MM-() #@%"M6).+LM"6') $(-+#-L$.%+)) #?&J%M2) -MM)%$@'() -&%"+$#)#"L@) ) -#)$-Z)-&%"+$I) [ZG)B;G==)%()B;G====) #@.>>.+0) -&%"+$I)'$LG) tax !%+$-.+#)$-Z) ) -Z).+,%(&-$.%+) .+,%(&-$.%+),%() ,(%&)$@')%(.0.+-M) $@')$(-+#-L$.%+) -"$@%(.F-$.%+) $(-+#-L$.%+)Y.MM) ) J')"#'6).,)$@.#) Optional ,.'M6).#)+%$) #"J&.$$'6G) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ WW)
    • Merchant Web Services API ELEMENT VALUE FORMAT NOTES amount @')$-Z)-&%"+$) ^>)$%)W)6.0.$#)-,$'()$@') @.#)-&%"+$) ,%()$@') 6'L.&-M)>%.+$)1+%)6%MM-() &"#$)J') $(-+#-L$.%+) #?&J%M2) .+LM"6'6).+)$@') $%$-M)-&%"+$),%() ) ) $@')$(-+#-L$.%+G) Optional) [ZG)B;G==)%()B;G====) name @')+-&')%,) ^>)$%)TB)L@-(-L$'(#) ) $@')$-Z),%()$@') $(-+#-L$.%+) ) Optional description @')$-Z) ^>)$%);PP)L@-(-L$'(#) ) 6'#L(.>$.%+),%() $@')$(-+#-L$.%+) ) Optional shipping !%+$-.+#) ) K@.>>.+0) #@.>>.+0) .+,%(&-$.%+),(%&) .+,%(&-$.%+),%() $@')%(.0.+-M) $@')$(-+#-L$.%+) -"$@%(.F-$.%+) $(-+#-L$.%+)Y.MM) ) J')"#'6).,)$@.#) Optional) ,.'M6).#)+%$) #"J&.$$'6G) amount @')#@.>>.+0) ^>)$%)W)6.0.$#)-,$'()$@') @.#)-&%"+$) -&%"+$),%()$@') 6'L.&-M)>%.+$)1+%)6%MM-() &"#$)J') $(-+#-L$.%+) #?&J%M2) .+LM"6'6).+)$@') $%$-M)-&%"+$),%() ) ) $@')$(-+#-L$.%+G) Optional) [ZG)B;G==)%()B;G====) name @')+-&')%,) ^>)$%)TB)L@-(-L$'(#) ) $@')#@.>>.+0),%() $@')$(-+#-L$.%+) ) Optional) description @')#@.>>.+0) ^>)$%);PP)L@-(-L$'(#) ) 6'#L(.>$.%+),%() $@')$(-+#-L$.%+) ) Optional) duty !%+$-.+#)6"$?) ) Q"$?).+,%(&-$.%+) .+,%(&-$.%+),%() ,(%&)$@')%(.0.+-M) $@')$(-+#-L$.%+) -"$@%(.F-$.%+) $(-+#-L$.%+)Y.MM) ) J')"#'6).,)$@.#) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ WP)
    • Section 2 Executing an API Call ELEMENT VALUE FORMAT NOTES Optional) ,.'M6).#)+%$) #"J&.$$'6G) amount @')6"$?) ^>)$%)W)6.0.$#)-,$'()$@') @.#)-&%"+$) -&%"+$),%()$@') 6'L.&-M)>%.+$)1+%)6%MM-() &"#$)J') $(-+#-L$.%+) #?&J%M2) .+LM"6'6).+)$@') $%$-M)-&%"+$),%() ) ) $@')$(-+#-L$.%+G) Optional) [ZG)B;G==)%()B;G====) name @')+-&')%,) ^>)$%)TB)L@-(-L$'(#) ) $@')6"$?),%()$@') $(-+#-L$.%+) ) Optional) description @')6"$?) ^>)$%);PP)L@-(-L$'(#) ) 6'#L(.>$.%+),%() $@')$(-+#-L$.%+) ) Optional) lineItems !%+$-.+#)M.+') ) 4.+').$'&) .$'&)6'$-.M#) .+,%(&-$.%+),(%&) -J%"$)$@')%(6'() $@')%(.0.+-M) -"$@%(.F-$.%+) ) $(-+#-L$.%+)Y.MM) Optional)) J')"#'6).,)$@.#) ,.'M6).#)+%$) #"J&.$$'6G) ) ^>)$%)T<)6.#$.+L$) .+#$-+L'#)%,)$@.#) 'M'&'+$)&-?)J') .+LM"6'6)>'() $(-+#-L$.%+)$%) 6'#L(.J').$'&#) .+LM"6'6).+)$@') %(6'(G) itemId @')*Q) ^>)$%)TB)L@-(-L$'(#) ) -##.0+'6)$%)$@') .$'&) ) Optional) name E)#@%($) ^>)$%)TB)L@-(-L$'(#) ) 6'#L(.>$.%+)%,) -+).$'&) ) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ W])
    • Merchant Web Services API ELEMENT VALUE FORMAT NOTES Optional) description E)6'$-.M'6) ^>)$%);PP)L@-(-L$'(#) ) 6'#L(.>$.%+)%,) -+).$'&) ) Optional) quantity @')O"-+$.$?)%,) ^>)$%)W)6.0.$#)1">)$%)$Y%) ) -+).$'&) 6'L.&-M)>M-L'#2) ) Optional) unitPrice !%#$)%,)-+).$'&) ^>)$%)W)6.0.$#)Y.$@)-)6'L.&-M) ) >'()"+.$) >%.+$)1+%)6%MM-()#?&J%M2) excluding)$-ZI) ,('.0@$I)-+6)6"$?) ) ) [ZG)WG=P) Optional) taxable *+6.L-$'#) ,-M#') ) Y@'$@'()$@') .$'&).#)#"Jj'L$) $("') $%)$-Z) ) Optional) customerProfileId U-?&'+$) H"&'(.L) *,)-)7-M"').#) 0-$'Y-?) #"J&.$$'6),%() -##.0+'6)*Q) $@.#),.'M6I).$)&"#$) -##%L.-$'6)Y.$@) J')$@')#-&')*Q) $@')L"#$%&'() "#'6),%()$@') >(%,.M') %(.0.+-M) -"$@%(.F-$.%+) ) $(-+#-L$.%+G) Optional) customerPaymentProfileId U-?&'+$) H"&'(.L) *,)-)7-M"').#) 0-$'Y-?) #"J&.$$'6),%() -##.0+'6)*Q) $@.#),.'M6I).$)&"#$) -##%L.-$'6)Y.$@) J')$@')#-&')*Q) $@')L"#$%&'() "#'6),%()$@') >-?&'+$)>(%,.M') %(.0.+-M) -"$@%(.F-$.%+) ) $(-+#-L$.%+G) Optional) customerShippingAddressId U-?&'+$) H"&'(.L) *,)-)7-M"').#) 0-$'Y-?) #"J&.$$'6),%() -##.0+'6)*Q) $@.#),.'M6I).$)&"#$) -##%L.-$'6)Y.$@) J')$@')#-&')*Q) $@')L"#$%&'() "#'6),%()$@') 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ W9)
    • Section 2 Executing an API Call ELEMENT VALUE FORMAT NOTES #@.>>.+0) %(.0.+-M) -66('##) -"$@%(.F-$.%+) $(-+#-L$.%+G) ) Optional transId @')>-?&'+$) H"&'(.L) ) 0-$'Y-?) -##.0+'6) $(-+#-L$.%+)*Q) %,)$@')%(.0.+-M) $(-+#-L$.%+) extraOptions *+,%(&-$.%+).+) K$(.+0)1#'')'Z-&>M')J'M%Y2) S%()-)L%&>M'$') +-&':7-M"')>-.() M.#$)%,)$@') ,%(&-$)$@-$) $(-+#-L$.%+) 6%'#)+%$)'Z.#$) 7-(.-JM')+-&'#) Y.$@.+)!*/I) -7-.M-JM'I) #"L@)-#) >M'-#')('7.'Y) L"#$%&'()*U) $@')AIM -66('##I)'$LG) Implementation Guide M%L-$'6)-$) @$$>8::YYYG-"$@ Optional) %(.F'G+'$:#">>%( $:-.&k0".6'G>6,G) For information about output elements for this function, see the section of this document titled “Output Elements for createCustomerProfileTransactionResponse.” Example createCustomerProfileTransactionRequest for a Prior Authorization and Capture transaction <?xml version="1.0" encoding="utf-8"?> <createCustomerProfileTransactionRequest xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <merchantAuthentication> <name>YourUserLogin</name> <transactionKey>YourTranKey</transactionKey> </merchantAuthentication> <transaction> <profileTransPriorAuthCapture> <amount>10.95</amount> <tax> <amount>1.00</amount> <name>WA state sales tax</name> <description>Washington state sales tax</description> </tax> 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ WC)
    • Merchant Web Services API <shipping> <amount>2.00</amount> <name>ground based shipping</name> <description>Ground based 5 to 10 day shipping</description> </shipping> <lineItems> <itemId>ITEM00001</itemId> <name>name of item sold</name> <description>Description of item sold</description> <quantity>1</quantity> <unitPrice>6.95</unitPrice> <taxable>true</taxable> </lineItems> <lineItems> <itemId>ITEM00002</itemId> <name>name of other item sold</name> <description>Description of other item sold</description> <quantity>1</quantity> <unitPrice>1.00</unitPrice> <taxable>true</taxable> </lineItems> <customerProfileId>10000</customerProfileId> <customerPaymentProfileId>20000</customerPaymentProfileId> <customerShippingAddressId>30000</customerShippingAddressId> <transId>40000</transId> </profileTransPriorAuthCapture> </transaction> <extraOptions><![CDATA[]]></extraOptions> </createCustomerProfileTransactionRequest> Note: The sample code included in this document uses dummy field values. When using or testing sample code, be sure to enter valid field values. Additional sample code is available for download from the Authorize.Net Integration Center at http://developer.authorize.net/samplecode. The following table lists the input elements for executing an API call to the createCustomerProfileTransactionRequest function for a Refund transaction. 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ W=)
    • Section 2 Executing an API Call ELEMENT VALUE FORMAT NOTES refId /'(L@-+$D ^>)$%);<)L@-(-L$'(#) *,).+LM"6'6).+)$@') -##.0+'6) ('O"'#$I)$@.#)7-M"') (','('+L')*Q),%() Y.MM)J').+LM"6'6).+) $@')('O"'#$) $@')('#>%+#'G)@.#) ,'-$"(')&.0@$)J') ) '#>'L.-MM?)"#',"M) Optional ,%()&"M$.D$@('-6'6) ->>M.L-$.%+#G) transaction !%+$-.+#) ) ) $(-+#-L$.%+) .+,%(&-$.%+) profileTransRefund @')$(-+#-L$.%+) ) e+M?)%+') $?>')$@-$).#) $(-+#-L$.%+)$?>').#) J'.+0)('O"'#$'6) ) -MM%Y'6)>'() ) ('O"'#$G) ) ) amount @')$%$-M) ^>)$%)W)6.0.$#)-,$'()$@') @.#)-&%"+$) -&%"+$)$%)J') 6'L.&-M)>%.+$)1+%)6%MM-() #@%"M6).+LM"6')-MM) (',"+6'6)) #?&J%M2) %$@'()-&%"+$#) #"L@)-#)$-Z) ) -&%"+$I)#@.>>.+0) [ZG)B;G==)%()B;G====) -&%"+$I)'$LG) tax !%+$-.+#)$-Z) ) ) .+,%(&-$.%+),%() $@')(',"+6) ) Optional amount @')$-Z)-&%"+$) ^>)$%)W)6.0.$#)-,$'()$@') @.#)-&%"+$)&"#$) $%)J')(',"+6'6) 6'L.&-M)>%.+$)1+%)6%MM-() J').+LM"6'6).+)$@') #?&J%M2) $%$-M)-&%"+$),%() ) $@')$(-+#-L$.%+G) ) Optional) [ZG)B;G==)%()B;G====) name @')+-&')%,) ^>)$%)TB)L@-(-L$'(#) ) $@')$-Z),%()$@') $(-+#-L$.%+) ) Optional description @')$-Z) ^>)$%);PP)L@-(-L$'(#) ) 6'#L(.>$.%+),%() $@')$(-+#-L$.%+) ) Optional 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ P<)
    • Merchant Web Services API ELEMENT VALUE FORMAT NOTES shipping !%+$-.+#) ) ) #@.>>.+0) .+,%(&-$.%+),%() $@')(',"+6) ) Optional) amount @')#@.>>.+0) ^>)$%)W)6.0.$#)-,$'()$@') @.#)-&%"+$)&"#$) -&%"+$)$%)J') 6'L.&-M)>%.+$)1+%)6%MM-() J').+LM"6'6).+)$@') (',"+6'6) #?&J%M2) $%$-M)-&%"+$),%() $@')$(-+#-L$.%+G) ) ) Optional) [ZG)B;G==)%()B;G====) name @')+-&')%,) ^>)$%)TB)L@-(-L$'(#) ) $@')#@.>>.+0),%() $@')$(-+#-L$.%+) ) Optional) description @')#@.>>.+0) ^>)$%);PP)L@-(-L$'(#) ) 6'#L(.>$.%+),%() $@')$(-+#-L$.%+) ) Optional) duty !%+$-.+#)6"$?) ) ) .+,%(&-$.%+),%() $@')(',"+6) ) Optional) amount @')6"$?) ^>)$%)W)6.0.$#)-,$'()$@') @.#)-&%"+$)&"#$) -&%"+$)$%)J') 6'L.&-M)>%.+$)1+%)6%MM-() J').+LM"6'6).+)$@') (',"+6'6) #?&J%M2) $%$-M)-&%"+$),%() $@')$(-+#-L$.%+G) ) ) Optional) [ZG)B;G==)%()B;G====) name @')+-&')%,) ^>)$%)TB)L@-(-L$'(#) ) $@')6"$?),%()$@') $(-+#-L$.%+) ) Optional) description @')6"$?) ^>)$%);PP)L@-(-L$'(#) ) 6'#L(.>$.%+),%() $@')$(-+#-L$.%+) ) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ PB)
    • Section 2 Executing an API Call ELEMENT VALUE FORMAT NOTES Optional) lineItems !%+$-.+#)M.+') ) ^>)$%)T<)6.#$.+L$) .$'&)6'$-.M#) .+#$-+L'#)%,)$@.#) -J%"$)$@') 'M'&'+$)&-?)J') (',"+6) .+LM"6'6)>'() $(-+#-L$.%+)$%) ) 6'#L(.J').$'&#) Optional)) .+LM"6'6).+)$@') %(6'(G) itemId @')*Q) ^>)$%)TB)L@-(-L$'(#) ) -##.0+'6)$%)$@') .$'&) ) Optional) name E)#@%($) ^>)$%)TB)L@-(-L$'(#) ) 6'#L(.>$.%+)%,) -+).$'&) ) Optional) description E)6'$-.M'6) ^>)$%);PP)L@-(-L$'(#) ) 6'#L(.>$.%+)%,) -+).$'&) ) Optional) quantity @')O"-+$.$?)%,) ^>)$%)W)6.0.$#)1">)$%)$Y%) ) -+).$'&) 6'L.&-M)>M-L'#2) ) Optional) unitPrice !%#$)%,)-+).$'&) ^>)$%)W)6.0.$#)Y.$@)-) ) >'()"+.$) 6'L.&-M)>%.+$)1+%)6%MM-() excluding)$-ZI) #?&J%M2) ,('.0@$I)-+6)6"$?) ) ) [ZG)WG=P) Optional) taxable *+6.L-$'#) ,-M#') ) Y@'$@'()$@') .$'&).#)#"Jj'L$) $("') $%)$-Z) ) Optional) customerProfileId U-?&'+$) H"&'(.L) N'O".('6).,)$@') 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ P;)
    • Merchant Web Services API ELEMENT VALUE FORMAT NOTES 0-$'Y-?) &-#c'6)>-?&'+$) -##.0+'6)*Q) .+,%(&-$.%+).#)+%$) -##%L.-$'6)Y.$@) J'.+0)#"J&.$$'6G) $@')L"#$%&'() /"#$)J')#"J&.$$'6) >(%,.M') Y.$@) customerPaymen ) tProfileId.)) Conditional) ) *,)-)7-M"').#) #"J&.$$'6),%()$@.#) ,.'M6I).$)&"#$)J')$@') #-&')*Q)"#'6),%() $@')%(.0.+-M) $(-+#-L$.%+G) customerPaymentProfileId U-?&'+$) H"&'(.L) N'O".('6).,)$@') 0-$'Y-?) &-#c'6)>-?&'+$) -##.0+'6)*Q) .+,%(&-$.%+).#)+%$) -##%L.-$'6)Y.$@) J'.+0)#"J&.$$'6G) $@')L"#$%&'() /"#$)J')#"J&.$$'6) >-?&'+$)>(%,.M') Y.$@) customerProfileI ) d.)) Conditional) ) *,)-)7-M"').#) #"J&.$$'6),%()$@.#) ,.'M6I).$)&"#$)J')$@') #-&')*Q)"#'6),%() $@')%(.0.+-M) $(-+#-L$.%+G) customerShippingAddressId U-?&'+$) H"&'(.L) *,)-)7-M"').#) 0-$'Y-?) #"J&.$$'6),%()$@.#) -##.0+'6)*Q) ,.'M6I).$)&"#$)J')$@') -##%L.-$'6)Y.$@) #-&')*Q)"#'6),%() $@')L"#$%&'() $@')%(.0.+-M) #@.>>.+0) $(-+#-L$.%+G) -66('##) ) ) Optional creditCardNumberMasked @')M-#$),%"() S%"()3#),%MM%Y'6)J?)$@') N'O".('6),%()L('6.$) 6.0.$#)%,)$@') M-#$),%"()6.0.$#)%,)$@')L('6.$) L-(6)$(-+#-L$.%+#).,) L('6.$)L-(6) L-(6)+"&J'()$%)J') customerProfileI +"&J'()$%)J') (',"+6'6G)) d)AND) (',"+6'6) customerPaymen ) tProfileId)-(')+%$) ) J'.+0)#"J&.$$'6G) [ZG)3333B;TW) Conditional ) V-M"')#"J&.$$'6) &"#$)J')$@')#-&') +"&J'()"#'6),%() $@')%(.0.+-M) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ PT)
    • Section 2 Executing an API Call ELEMENT VALUE FORMAT NOTES $(-+#-L$.%+G) bankRoutingNumberMasked @')M-#$),%"() S%"()3#),%MM%Y'6)J?)$@') N'O".('6),%() 6.0.$#)%,)$@') M-#$),%"()6.0.$#)%,)$@') 'M'L$(%+.L)L@'Lc) (%"$.+0)+"&J'() (%"$.+0)+"&J'()$%)J') $(-+#-L$.%+#).,) $%)J')(',"+6'6) (',"+6'6G)) customerProfileI d)AND) ) ) customerPaymen Conditional) [ZG)3333B;TW) tProfileId)-(')+%$) J'.+0)#"J&.$$'6G) /"#$)J')#"J&.$$'6) Y.$@) bankAccountNu mberMaskedG) ) V-M"')#"J&.$$'6) &"#$)J')$@')#-&') +"&J'()"#'6),%() $@')%(.0.+-M) $(-+#-L$.%+G) @')M-#$),%"() S%"()3#),%MM%Y'6)J?)$@') N'O".('6),%() bankAccountNumberMasked 6.0.$#)%,)$@') M-#$),%"()6.0.$#)%,)$@')J-+c) 'M'L$(%+.L)L@'Lc) J-+c)-LL%"+$) -LL%"+$)$%)J')(',"+6'6G)) $(-+#-L$.%+#).,) +"&J'()$%)J') customerProfileI (',"+6'6) ) d)AND) [ZG)3333B;TW) customerPaymen ) tProfileId)-(')+%$) Conditional) J'.+0)#"J&.$$'6G) /"#$)J')#"J&.$$'6) Y.$@) bankRoutingNum berMaskedG) ) V-M"')#"J&.$$'6) &"#$)J')$@')#-&') +"&J'()"#'6),%() $@')%(.0.+-M) $(-+#-L$.%+G) order !%+$-.+#) ) ) .+,%(&-$.%+) -J%"$)$@')%(6'() ) Optional) invoiceNumber @')&'(L@-+$) ^>)$%);<)L@-(-L$'(#)1+%) ) -##.0+'6) #?&J%M#2) .+7%.L')+"&J'() ,%()$@') $(-+#-L$.%+) ) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ PW)
    • Merchant Web Services API ELEMENT VALUE FORMAT NOTES Optional) description @')$(-+#-L$.%+) ^>)$%);PP)L@-(-L$'(#)1+%) ) 6'#L(.>$.%+) #?&J%M#2) ) Optional) purchaseOrderNumber @')&'(L@-+$) ^>)$%);P)L@-(-L$'(#)1+%) ) -##.0+'6) #?&J%M#2) >"(L@-#')%(6'() +"&J'() ) Optional) transId @')>-?&'+$) H"&'(.L) ) 0-$'Y-?) -##.0+'6) $(-+#-L$.%+)*Q) %,)$@')%(.0.+-M) $(-+#-L$.%+ extraOptions *+,%(&-$.%+).+) K$(.+0)1#'')'Z-&>M')J'M%Y2) S%()-)L%&>M'$')M.#$) +-&':7-M"')>-.() %,)$@')$(-+#-L$.%+) ,%(&-$)$@-$) 7-(.-JM')+-&'#) 6%'#)+%$)'Z.#$) -7-.M-JM'I)>M'-#') Y.$@.+)!*/I) ('7.'Y)$@')AIM #"L@)-#) Implementation L"#$%&'()*U) Guide M%L-$'6)-$) -66('##I)'$LG) @$$>8::YYYG-"$@%(. F'G+'$:#">>%($:-.& k0".6'G>6,G) Optional) For information about output elements for this function, see the section of this document titled “Output Elements for createCustomerProfileTransactionResponse.” Example createCustomerProfileTransactionRequest for a Refund transaction <?xml version="1.0" encoding="utf-8"?> <createCustomerProfileTransactionRequest xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <merchantAuthentication> <name>YourUserLogin</name> <transactionKey>YourTranKey</transactionKey> </merchantAuthentication> <transaction> <profileTransRefund> 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ PP)
    • Section 2 Executing an API Call <amount>10.95</amount> <tax> <amount>1.00</amount> <name>WA state sales tax</name> <description>Washington state sales tax</description> </tax> <shipping> <amount>2.00</amount> <name>ground based shipping</name> <description>Ground based 5 to 10 day shipping</description> </shipping> <lineItems> <itemId>ITEM00001</itemId> <name>name of item sold</name> <description>Description of item sold</description> <quantity>1</quantity> <unitPrice>6.95</unitPrice> <taxable>true</taxable> </lineItems> <lineItems> <itemId>ITEM00002</itemId> <name>name of other item sold</name> <description>Description of other item sold</description> <quantity>1</quantity> <unitPrice>1.00</unitPrice> <taxable>true</taxable> </lineItems> <customerProfileId>10000</customerProfileId> <customerPaymentProfileId>20000</customerPaymentProfileId> <customerShippingAddressId>30000</customerShippingAddressId> <creditCardNumberMasked>XXXX1111</creditCardNumberMasked> <order> <invoiceNumber>INV000001</invoiceNumber> <description>description of transaction</description> <purchaseOrderNumber>PONUM000001</purchaseOrderNumber> </order> <transId>40000</transId> </profileTransRefund> </transaction> 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ P])
    • Merchant Web Services API <extraOptions><![CDATA[]]></extraOptions> </createCustomerProfileTransactionRequest> Note: The sample code included in this document uses dummy field values. When using or testing sample code, be sure to enter valid field values. Additional sample code is available for download from the Authorize.Net Integration Center at http://developer.authorize.net/samplecode. The following table lists the input elements for executing an API call to the createCustomerProfileTransactionRequest function for a Void transaction. ELEMENT VALUE FORMAT NOTES refId /'(L@-+$D ^>)$%);<)L@-(-L$'(#) *,).+LM"6'6).+)$@') -##.0+'6) ('O"'#$I)$@.#) (','('+L')*Q),%() 7-M"')Y.MM)J') $@')('O"'#$) .+LM"6'6).+)$@') ('#>%+#'G)@.#) ) ,'-$"(')&.0@$)J') Optional '#>'L.-MM?)"#',"M) ,%()&"M$.D $@('-6'6) ->>M.L-$.%+#G) transaction !%+$-.+#) ) ) $(-+#-L$.%+) .+,%(&-$.%+) profileTransVoid @')$(-+#-L$.%+) ) e+M?)%+') $?>')$@-$).#) $(-+#-L$.%+)$?>') J'.+0)('O"'#$'6) ) .#)-MM%Y'6)>'() ) ('O"'#$G) ) ) customerProfileId U-?&'+$) H"&'(.L) *,)-)7-M"').#) 0-$'Y-?) #"J&.$$'6),%() -##.0+'6)*Q) $@.#),.'M6I).$)&"#$) -##%L.-$'6)Y.$@) J')$@')#-&')*Q) $@')L"#$%&'() "#'6),%()$@') >(%,.M') %(.0.+-M) $(-+#-L$.%+G) ) Optional) customerPaymentProfileId U-?&'+$) H"&'(.L) *,)-)7-M"').#) 0-$'Y-?) #"J&.$$'6),%() -##.0+'6)*Q) $@.#),.'M6I).$)&"#$) -##%L.-$'6)Y.$@) J')$@')#-&')*Q) $@')L"#$%&'() "#'6),%()$@') >-?&'+$)>(%,.M') %(.0.+-M) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ P9)
    • Section 2 Executing an API Call ELEMENT VALUE FORMAT NOTES ) $(-+#-L$.%+G) Optional) customerShippingAddressId U-?&'+$) H"&'(.L) *,)-)7-M"').#) 0-$'Y-?) #"J&.$$'6),%() -##.0+'6)*Q) $@.#),.'M6I).$)&"#$) -##%L.-$'6)Y.$@) J')$@')#-&')*Q) $@')L"#$%&'() "#'6),%()$@') #@.>>.+0) %(.0.+-M) -66('##) $(-+#-L$.%+G) ) Optional transId @')>-?&'+$) H"&'(.L) ) 0-$'Y-?) -##.0+'6) $(-+#-L$.%+)*Q) %,)$@')%(.0.+-M) $(-+#-L$.%+ extraOptions *+,%(&-$.%+).+) K$(.+0)1#'')'Z-&>M')J'M%Y2) S%()-)L%&>M'$') +-&':7-M"')>-.() M.#$)%,)$@') ,%(&-$)$@-$) $(-+#-L$.%+) 6%'#)+%$)'Z.#$) 7-(.-JM')+-&'#) Y.$@.+)!*/I) -7-.M-JM'I) #"L@)-#) >M'-#')('7.'Y) L"#$%&'()*U) $@')AIM -66('##I)'$LG) Implementation Guide M%L-$'6)-$) @$$>8::YYYG-"$@ Optional) %(.F'G+'$:#">>%( $:-.&k0".6'G>6,G) For information about output elements for this function, see the section of this document titled “Output Elements for createCustomerProfileTransactionResponse.” Example createCustomerProfileTransactionRequest for a Void transaction <?xml version="1.0" encoding="utf-8"?> <createCustomerProfileTransactionRequest xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <merchantAuthentication> <name>YourUserLogin</name> <transactionKey>YourTranKey</transactionKey> </merchantAuthentication> <transaction> <profileTransVoid> <customerProfileId>10000</customerProfileId> 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ PC)
    • Merchant Web Services API <customerPaymentProfileId>20000</customerPaymentProfileId> <customerShippingAddressId>30000</customerShippingAddressId> <transId>40000</transId> </profileTransVoid> </transaction> <extraOptions><![CDATA[]]></extraOptions> </createCustomerProfileTransactionRequest> Note: The sample code included in this document uses dummy field values. When using or testing sample code, be sure to enter valid field values. Additional sample code is available for download from the Authorize.Net Integration Center at http://developer.authorize.net/samplecode. Input Elements for deleteCustomerProfileRequest This function is used to delete an existing customer profile along with all associated customer payment profiles and customer shipping addresses. The following table lists the input elements for executing an API call to the deleteCustomerProfileRequest function. ELEMENT VALUE FORMAT NOTES refId /'(L@-+$D-##.0+'6)(','('+L')*Q),%() ^>)$%);<) *,).+LM"6'6).+)$@') $@')('O"'#$) L@-(-L$'(#) ('O"'#$I)$@.#)7-M"')Y.MM) J').+LM"6'6).+)$@') ) ('#>%+#'G)@.#),'-$"(') Optional &.0@$)J')'#>'L.-MM?) "#',"M),%()&"M$.D$@('-6'6) ->>M.L-$.%+#G) customerProfileId U-?&'+$)0-$'Y-?)-##.0+'6)*Q) H"&'(.L) ) -##%L.-$'6)Y.$@)$@')L"#$%&'()>(%,.M') For information about output elements for this function, see the section of this document titled “Output Elements for deleteCustomerProfileResponse.” Example deleteCustomerProfileRequest <?xml version="1.0" encoding="utf-8"?> <deleteCustomerProfileRequest xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <merchantAuthentication> <name>YourUserLogin</name> <transactionKey>YourTranKey</transactionKey> </merchantAuthentication> 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ P=)
    • Section 2 Executing an API Call <customerProfileId>10000</customerProfileId> </deleteCustomerProfileRequest> Note: The sample code included in this document uses dummy field values. When using or testing sample code, be sure to enter valid field values. Additional sample code is available for download from the Authorize.Net Integration Center at http://developer.authorize.net/samplecode. Input Elements for deleteCustomerPaymentProfileRequest This function is used to delete a customer payment profile from an existing customer profile. The following table lists the input elements for executing an API call to the deleteCustomerPaymentProfileRequest function. ELEMENT VALUE FORMAT NOTES refId /'(L@-+$D-##.0+'6) ^>)$%);<) *,).+LM"6'6).+)$@')('O"'#$I)$@.#) (','('+L')*Q),%()$@') L@-(-L$'(#) 7-M"')Y.MM)J').+LM"6'6).+)$@') ('O"'#$) ('#>%+#'G)@.#),'-$"(')&.0@$)J') '#>'L.-MM?)"#',"M),%()&"M$.D ) $@('-6'6)->>M.L-$.%+#G) Optional customerProfileId U-?&'+$)0-$'Y-?) H"&'(.L) ) -##.0+'6)*Q)-##%L.-$'6) Y.$@)$@')L"#$%&'() >(%,.M') customerPaymentProfileId U-?&'+$)0-$'Y-?) H"&'(.L) ) -##.0+'6)*Q)-##%L.-$'6) Y.$@)$@')L"#$%&'() >-?&'+$)>(%,.M') For information about output elements for this function, see the section of this document titled “Output Elements for deleteCustomerPaymentProfileResponse.” Example deleteCustomerPaymentProfileRequest <?xml version="1.0" encoding="utf-8"?> <deleteCustomerPaymentProfileRequest xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <merchantAuthentication> <name>YourUserLogin</name> <transactionKey>YourTranKey</transactionKey> </merchantAuthentication> 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ ]<)
    • Merchant Web Services API <customerProfileId>10000</customerProfileId> <customerPaymentProfileId>20000</customerPaymentProfileId> </deleteCustomerPaymentProfileRequest> Note: The sample code included in this document uses dummy field values. When using or testing sample code, be sure to enter valid field values. Additional sample code is available for download from the Authorize.Net Integration Center at http://developer.authorize.net/samplecode. Input Elements for deleteCustomerShippingAddressRequest This function is used to delete a customer shipping address from an existing customer profile. The following table lists the input elements for executing an API call to the deleteCustomerShippingAddressRequest function. ELEMENT VALUE FORMAT NOTES refId /'(L@-+$D-##.0+'6) ^>)$%);<) *,).+LM"6'6).+)$@')('O"'#$I)$@.#) (','('+L')*Q),%()$@') L@-(-L$'(#) 7-M"')Y.MM)J').+LM"6'6).+)$@') ('O"'#$) ('#>%+#'G)@.#),'-$"(')&.0@$) J')'#>'L.-MM?)"#',"M),%()&"M$.D ) $@('-6'6)->>M.L-$.%+#G) Optional customerProfileId U-?&'+$)0-$'Y-?) H"&'(.L) ) -##.0+'6)*Q)-##%L.-$'6) Y.$@)$@')L"#$%&'()>(%,.M') customerAddressId U-?&'+$)0-$'Y-?) H"&'(.L) ) -##.0+'6)*Q)-##%L.-$'6) Y.$@)$@')L"#$%&'() #@.>>.+0)-66('##)) For information about output elements for this function, see the section of this document titled “Output Elements for deleteCustomerShippingAddressResponse.” Example deleteCustomerShippingAddressRequest <?xml version="1.0" encoding="utf-8"?> <deleteCustomerShippingAddressRequest xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <merchantAuthentication> <name>YourUserLogin</name> <transactionKey>YourTranKey</transactionKey> </merchantAuthentication> 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ ]B)
    • Section 2 Executing an API Call <customerProfileId>10000</customerProfileId> <customerAddressId>30000</customerAddressId> </deleteCustomerShippingAddressRequest> Note: The sample code included in this document uses dummy field values. When using or testing sample code, be sure to enter valid field values. Additional sample code is available for download from the Authorize.Net Integration Center at http://developer.authorize.net/samplecode. Input Elements for getCustomerProfileIdsRequest This function is used to retrieve all existing customer profile Ids. The following table lists the input elements for executing an API call to the getCustomerProfileIdRequest function. ELEMENT VALUE FORMAT NOTES merchantAuthentication) !%+$-.+#)&'(L@-+$)"+.O"') ) ) .+,%(&-$.%+),%()>"(>%#'#) %,)-"$@'+$.L-$.%+) name @')7-M.6)EU*)4%0.+)*Q),%() ^>)$%);P)L@-(-L$'(#) K"J&.$)$@')EU*) $@')6'7'M%>'()$'#$)%() 4%0.+)*Q)"#'6)$%) &'(L@-+$)-LL%"+$) #"J&.$)$(-+#-L$.%+#) transactionKey @')7-M.6)(-+#-L$.%+)_'?) B])L@-(-L$'(#) K"J&.$)$@') ,%()$@')6'7'M%>'()$'#$)%() (-+#-L$.%+)_'?) &'(L@-+$)-LL%"+$) %J$-.+'6),(%&)$@') /'(L@-+$)*+$'(,-L') For information about output elements for this function, see the section of this document titled “Output Elements for getCustomerProfileIdsResponse.” Example getCustomerProfileIdsRequest <?xml version="1.0" encoding="utf-8"?> <getCustomerProfileIdsRequest xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <merchantAuthentication> <name>YourUserLogin</name> <transactionKey>YourTranKey</transactionKey> </merchantAuthentication> </getCustomerProfileIdsRequest> 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ ];)
    • Merchant Web Services API Note: The sample code included in this document uses dummy field values. When using or testing sample code, be sure to enter valid field values. Additional sample code is available for download from the Authorize.Net Integration Center at http://developer.authorize.net/samplecode. Input Elements for getCustomerProfileRequest This function is used to retrieve an existing customer profile along with all the associated customer payment profiles and customer shipping addresses. The following table lists the input elements for executing an API call to the getCustomerProfileRequest function. ELEMENT VALUE FORMAT NOTES customerProfileId U-?&'+$)0-$'Y-?) H"&'(.L) ) -##.0+'6)*Q)-##%L.-$'6) Y.$@)$@')L"#$%&'()>(%,.M') For information about output elements for this function, see the section of this document titled “Output Elements for getCustomerProfileResponse.” Example getCustomerProfileRequest <?xml version="1.0" encoding="utf-8"?> <getCustomerProfileRequest xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <merchantAuthentication> <name>YourUserLogin</name> <transactionKey>YourTranKey</transactionKey> </merchantAuthentication> <customerProfileId>10000</customerProfileId> </getCustomerProfileRequest> Note: The sample code included in this document uses dummy field values. When using or testing sample code, be sure to enter valid field values. Additional sample code is available for download from the Authorize.Net Integration Center at http://developer.authorize.net/samplecode. Input Elements for getCustomerPaymentProfileRequest This function is used to retrieve a customer payment profile for an existing customer profile. 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ ]T)
    • Section 2 Executing an API Call The following table lists the input elements for executing an API call to the getCustomerPaymentProfileRequest function. ELEMENT VALUE FORMAT NOTES customerProfileId U-?&'+$)0-$'Y-?) H"&'(.L) ) -##.0+'6)*Q)-##%L.-$'6) Y.$@)$@')L"#$%&'() >(%,.M') customerPaymentProfileId U-?&'+$)0-$'Y-?) H"&'(.L) ) -##.0+'6)*Q)-##%L.-$'6) Y.$@)$@')L"#$%&'() >-?&'+$)>(%,.M') For information about output elements for this function, see the section of this document titled “Output Elements for getCustomerPaymentProfileResponse.” Example getCustomerPaymentProfileRequest <?xml version="1.0" encoding="utf-8"?> <getCustomerPaymentProfileRequest xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <merchantAuthentication> <name>YourUserLogin</name> <transactionKey>YourTranKey</transactionKey> </merchantAuthentication> <customerProfileId>10000</customerProfileId> <customerPaymentProfileId>20000</customerPaymentProfileId> </getCustomerPaymentProfileRequest> Note: The sample code included in this document uses dummy field values. When using or testing sample code, be sure to enter valid field values. Additional sample code is available for download from the Authorize.Net Integration Center at http://developer.authorize.net/samplecode. Input Elements for getCustomerShippingAddressRequest This function is used to retrieve a customer shipping address for an existing customer profile. The following table lists the input elements for executing an API call to the getCustomerShippingAddressRequest function. 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ ]W)
    • Merchant Web Services API ELEMENT VALUE FORMAT NOTES customerProfileId U-?&'+$)0-$'Y-?) H"&'(.L) ) -##.0+'6)*Q)-##%L.-$'6) Y.$@)$@')L"#$%&'()>(%,.M') customerAddressId U-?&'+$)0-$'Y-?) H"&'(.L) ) -##.0+'6)*Q)-##%L.-$'6) Y.$@)$@')L"#$%&'()#@.>>.+0) -66('##)) For information about output elements for this function, see the section of this document titled “Output Elements for getCustomerShippingAddressResponse.” Example getCustomerShippingAddressRequest <?xml version="1.0" encoding="utf-8"?> <getCustomerShippingAddressRequest xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <merchantAuthentication> <name>YourUserLogin</name> <transactionKey>YourTranKey</transactionKey> </merchantAuthentication> <customerProfileId>10000</customerProfileId> <customerAddressId>30000</customerAddressId> </getCustomerShippingAddressRequest> Note: The sample code included in this document uses dummy field values. When using or testing sample code, be sure to enter valid field values. Additional sample code is available for download from the Authorize.Net Integration Center at http://developer.authorize.net/samplecode. Input Elements for updateCustomerProfileRequest This function is used to update an existing customer profile. The following table lists the input elements for executing an API call to the updateCustomerProfileRequest function. ELEMENT VALUE FORMAT NOTES refId /'(L@-+$D-##.0+'6) ^>)$%);<)L@-(-L$'(#) *,).+LM"6'6).+)$@') (','('+L')*Q),%()$@') ('O"'#$I)$@.#)7-M"')Y.MM) ('O"'#$) J').+LM"6'6).+)$@') ('#>%+#'G)@.#),'-$"(') ) &.0@$)J')'#>'L.-MM?) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ ]P)
    • Section 2 Executing an API Call Optional "#',"M),%()&"M$.D$@('-6'6) ->>M.L-$.%+#G) profile !%+$-.+#)>-?&'+$) ) ) .+,%(&-$.%+),%()$@') L"#$%&'()>(%,.M') merchantCustomerId /'(L@-+$)-##.0+'6)*Q) ^>)$%);<)L@-(-L$'(#) ) ,%()$@')L"#$%&'() ) Optional) description Q'#L(.>$.%+)%,)$@') ^>)$%);PP)L@-(-L$'(#) ) L"#$%&'()%()L"#$%&'() >(%,.M') ) Optional) email [&-.M)-66('##) ^>)$%);PP)L@-(-L$'(#) ) -##%L.-$'6)Y.$@)$@') L"#$%&'()>(%,.M') ) Optional) customerProfileId U-?&'+$)0-$'Y-?) H"&'(.L) ) -##.0+'6)*Q)-##%L.-$'6) Y.$@)$@')L"#$%&'()>(%,.M') For information about output elements for this function, see the section of this document titled “Output Elements for updateCustomerProfileResponse.” Example updateCustomerProfileRequest <?xml version="1.0" encoding="utf-8"?> <updateCustomerProfileRequest xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <merchantAuthentication> <name>YourUserLogin</name> <transactionKey>YourTranKey</transactionKey> </merchantAuthentication> <profile> <merchantCustomerId>custId123</merchantCustomerId> <description>some description</description> <email>newaddress@example.com</email> <customerProfileId>10000</customerProfileId> </profile> 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ ]])
    • Merchant Web Services API </updateCustomerProfileRequest> Note: The sample code included in this document uses dummy field values. When using or testing sample code, be sure to enter valid field values. Additional sample code is available for download from the Authorize.Net Integration Center at http://developer.authorize.net/samplecode. Input Elements for updateCustomerPaymentProfileRequest This function is used to update a customer payment profile for an existing customer profile. The following table lists the input elements for executing an API call to the updateCustomerPaymentProfileRequest function. Note: If some elements in this request are not submitted or are submitted with a blank value, the values in the original profile are removed. As a best practice to prevent this from happening, before calling updateCustomerPaymentProfileRequest, call getCustomerPaymentProfileRequest. That function returns all current information including masked payment information. Then simply change the field that needs updating and use that XML to call updateCustomerPaymentProfileRequest. ELEMENT VALUE FORMAT NOTES refId /'(L@-+$D-##.0+'6) ^>)$%);<)L@-(-L$'(#) *,).+LM"6'6).+)$@') (','('+L')*Q),%()$@') ('O"'#$I)$@.#)7-M"')Y.MM) ('O"'#$) J').+LM"6'6).+)$@') ('#>%+#'G)@.#),'-$"(') ) &.0@$)J')'#>'L.-MM?) Optional "#',"M),%()&"M$.D $@('-6'6)->>M.L-$.%+#G) customerProfileId U-?&'+$)0-$'Y-?) H"&'(.L) ) -##.0+'6)*Q) -##%L.-$'6)Y.$@)$@') L"#$%&'()>(%,.M') paymentProfile !%+$-.+#)>-?&'+$) ) K'+#.$.7').+,%(&-$.%+) .+,%(&-$.%+),%()$@') $@-$).#)+%$)J'.+0) L"#$%&'()>(%,.M') ">6-$'6)L-+)J') &-#c'6G) customerType Optional) .+6.7.6"-M) *,)$@.#),.'M6).#)+%$) #"J&.$$'6).+)$@') J"#.+'##) ('O"'#$I)%()#"J&.$$'6) Y.$@)-)JM-+c)7-M"'I)$@') %(.0.+-M)7-M"')Y.MM)J') ('&%7'6),(%&)$@') >(%,.M'G) billTo ) ) *,)$@.#)'+$.(')#'L$.%+).#) +%$)#"J&.$$'6I)$@') %(.0.+-M)J.MM.+0) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ ]9)
    • Section 2 Executing an API Call ELEMENT VALUE FORMAT NOTES .+,%(&-$.%+),%()$@') >(%,.M')Y.MM)#$-?)$@') #-&'G)) ) *,)">6-$.+0)%+M?)%+')%() &%(')'M'&'+$#)"+6'() billToI)-MM)'M'&'+$#) &"#$)J')#"J&.$$'6) Y.$@)$@'.()7-M.6)7-M"'#) $%)>('7'+$)$@')%(.0.+-M) 7-M"'#),(%&)J'.+0) ('&%7'6G) firstName @')L"#$%&'(`#),.(#$) ^>)$%)P<)L@-(-L$'(#)1+%) *,)$@.#),.'M6).#)+%$) +-&') #?&J%M#2) #"J&.$$'6).+)$@') ('O"'#$I)%()#"J&.$$'6) ) Y.$@)-)JM-+c)7-M"'I)$@') Optional) %(.0.+-M)7-M"')Y.MM)J') ('&%7'6),(%&)$@') >(%,.M'G) lastName @')L"#$%&'(`#)M-#$) ^>)$%)P<)L@-(-L$'(#)1+%) *,)$@.#),.'M6).#)+%$) +-&') #?&J%M#2) #"J&.$$'6).+)$@') ('O"'#$I)%()#"J&.$$'6) ) Y.$@)-)JM-+c)7-M"'I)$@') Optional) %(.0.+-M)7-M"')Y.MM)J') ('&%7'6),(%&)$@') >(%,.M'G) company @')+-&')%,)$@') ^>)$%)P<)L@-(-L$'(#)1+%) *,)$@.#),.'M6).#)+%$) L%&>-+?)-##%L.-$'6) #?&J%M#2) #"J&.$$'6).+)$@') Y.$@)$@')L"#$%&'(I).,) ('O"'#$I)%()#"J&.$$'6) ->>M.L-JM') Y.$@)-)JM-+c)7-M"'I)$@') %(.0.+-M)7-M"')Y.MM)J') ) ('&%7'6),(%&)$@') Optional) >(%,.M'G) address @')L"#$%&'(`#) ^>)$%)]<)L@-(-L$'(#)1+%) *,)$@.#),.'M6).#)+%$) #@.>>.+0)-66('##) #?&J%M#2) #"J&.$$'6).+)$@') ('O"'#$I)%()#"J&.$$'6) ) Y.$@)-)JM-+c)7-M"'I)$@') Optional) %(.0.+-M)7-M"')Y.MM)J') ('&%7'6),(%&)$@') >(%,.M'G) city @')L.$?)%,)$@') ^>)$%)W<)L@-(-L$'(#)1+%) *,)$@.#),.'M6).#)+%$) L"#$%&'(`#)#@.>>.+0) #?&J%M#2) #"J&.$$'6).+)$@') -66('##) ('O"'#$I)%()#"J&.$$'6) Y.$@)-)JM-+c)7-M"'I)$@') ) %(.0.+-M)7-M"')Y.MM)J') Optional) ('&%7'6),(%&)$@') >(%,.M'G) state @')#$-$')%,)$@') E)7-M.6)$Y%DL@-(-L$'() *,)$@.#),.'M6).#)+%$) L"#$%&'(`#)#@.>>.+0) #$-$')L%6') #"J&.$$'6).+)$@') ('O"'#$I)%()#"J&.$$'6) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ ]C)
    • Merchant Web Services API ELEMENT VALUE FORMAT NOTES -66('##) Y.$@)-)JM-+c)7-M"'I)$@') %(.0.+-M)7-M"')Y.MM)J') ) ('&%7'6),(%&)$@') Optional) >(%,.M'G) zip @')a*U)L%6')%,)$@') ^>)$%);<)L@-(-L$'(#)1+%) *,)$@.#),.'M6).#)+%$) L"#$%&'(`#)#@.>>.+0) #?&J%M#2) #"J&.$$'6).+)$@') -66('##) ('O"'#$I)%()#"J&.$$'6) Y.$@)-)JM-+c)7-M"'I)$@') ) %(.0.+-M)7-M"')Y.MM)J') Optional) ('&%7'6),(%&)$@') >(%,.M'G) country @')L%"+$(?)%,)$@') ^>)$%)]<)L@-(-L$'(#)1+%) *,)$@.#),.'M6).#)+%$) L"#$%&'(`#)#@.>>.+0) #?&J%M#2) #"J&.$$'6).+)$@') -66('##) ('O"'#$I)%()#"J&.$$'6) Y.$@)-)JM-+c)7-M"'I)$@') ) %(.0.+-M)7-M"')Y.MM)J') Optional) ('&%7'6),(%&)$@') >(%,.M'G) phoneNumber @')>@%+')+"&J'() ^>)$%);P)6.0.$#)1+%) *,)$@.#),.'M6).#)+%$) -##%L.-$'6)Y.$@)$@') M'$$'(#2) #"J&.$$'6).+)$@') L"#$%&'(`#)#@.>>.+0) ('O"'#$I)%()#"J&.$$'6) -66('##) ) Y.$@)-)JM-+c)7-M"'I)$@') [ZG)1B;T2B;TDB;TW) %(.0.+-M)7-M"')Y.MM)J') ) ('&%7'6),(%&)$@') Optional) >(%,.M'G) faxNumber @'),-Z)+"&J'() ^>)$%);P)6.0.$#)1+%) *,)$@.#),.'M6).#)+%$) -##%L.-$'6)Y.$@)$@') M'$$'(#2) #"J&.$$'6).+)$@') L"#$%&'(`#)#@.>>.+0) ('O"'#$I)%()#"J&.$$'6) -66('##) ) Y.$@)-)JM-+c)7-M"'I)$@') [ZG)1B;T2B;TDB;TW) %(.0.+-M)7-M"')Y.MM)J') ) ('&%7'6),(%&)$@') Optional) >(%,.M'G) payment !%+$-.+#)>-?&'+$) ) !-+)L%+$-.+) .+,%(&-$.%+),%()$@') creditCard)%() L"#$%&'()>(%,.M') bankAccount) creditCard !%+$-.+#)L('6.$)L-(6) ) @.#)'M'&'+$).#)%+M?) >-?&'+$).+,%(&-$.%+) ('O".('6)Y@'+)$@') ,%()$@')L"#$%&'() >-?&'+$)>(%,.M').#) >(%,.M') L('6.$)L-(6G) ) Conditional cardNumber @')L"#$%&'(`#) BT)$%)B])6.0.$#) *,)7-M"').#)&-#c'6I)$@') L('6.$)L-(6)+"&J'() M-#$),%"()6.0.$#)&"#$) ) &-$L@)$@')%(.0.+-M) H"&J'()L-+)-M#%)J') 7-M"').+)$@')>(%,.M'G)) &-#c'6I)'ZG)3333BBBB) ) *,)-)&-#c'6)7-M"').#) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ ]=)
    • Section 2 Executing an API Call ELEMENT VALUE FORMAT NOTES #"J&.$$'6I)$@')%(.0.+-M) 7-M"')Y.MM)+%$)J') ">6-$'6G) expirationDate @')'Z>.(-$.%+)6-$') bbbbD//) *,)-)&-#c'6)7-M"').#) ,%()$@')L"#$%&'(`#) #"J&.$$'6I)$@')%(.0.+-M) L('6.$)L-(6) ) 7-M"')Y.MM)+%$)J') H"&J'()L-+)-M#%)J') ">6-$'6G) &-#c'6I)'ZG)3333) cardCode @')$@(''D)%(),%"(D H"&'(.L) @.#),.'M6).#)('O".('6).,) 6.0.$)+"&J'()%+)$@') $@')&'(L@-+$)Y%"M6) J-Lc)%,)-)L('6.$)L-(6) M.c')$%)"#')$@')!-(6) 1%+)$@'),(%+$),%() !%6')V'(.,.L-$.%+) E&'(.L-+)[Z>('##2)) 1!!V2)#'L"(.$?) ,'-$"('G)S%()&%(') ) .+,%(&-$.%+I)>M'-#') Optional) #'')$@')Merchant Integration Guide -$) @$$>8::YYYG-"$@%(.F'G+ '$:#">>%($:/'(L@-+$:6 ',-"M$G@$&G) ) cardCode).#)%+M?) "#'6),%()7-M.6-$.%+)-+6) Y.MM)+%$)J')#$%('6).+) $@')L"#$%&'()>(%,.M'G)*$) #@%"M6)%+M?)J')"#'6) Y@'+)#"J&.$$.+0 validationMode)Y.$@) -)7-M"')%,)testMode) %()liveModeG) bankAccount !%+$-.+#)J-+c) ) @.#)'M'&'+$).#)%+M?) -LL%"+$)>-?&'+$) ('O".('6)Y@'+)$@') .+,%(&-$.%+),%()$@') >-?&'+$)>(%,.M').#) L"#$%&'()>(%,.M') J-+c)-LL%"+$G) ) Conditional) accountType @')$?>')%,)J-+c) L@'Lc.+0) *,)$@.#),.'M6).#)+%$) -LL%"+$),%()$@') #"J&.$$'6).+)$@') >-?&'+$)>(%,.M') #-7.+0#) ('O"'#$I)%()#"J&.$$'6) J"#.+'##!@'Lc.+0) Y.$@)-)JM-+c)7-M"'I)$@') ) %(.0.+-M)7-M"')Y.MM)J') Optional) ('&%7'6),(%&)$@') >(%,.M'G) routingNumber @')(%"$.+0)+"&J'() =)6.0.$#) *,)7-M"').#)&-#c'6I)$@') %,)$@')L"#$%&'(`#) M-#$),%"()6.0.$#)&"#$) J-+c)) ) &-$L@)$@')%(.0.+-M) H"&J'()L-+)-M#%)J') 7-M"').+)$@')>(%,.M'G)) &-#c'6I)'ZG)3333BBBB) ) *,)-)&-#c'6)7-M"').#) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ 9<)
    • Merchant Web Services API ELEMENT VALUE FORMAT NOTES #"J&.$$'6I)$@')%(.0.+-M) 7-M"')Y.MM)+%$)J') ">6-$'6G) accountNumber @')L"#$%&'(`#) P)$%)B9)6.0.$#) *,)7-M"').#)&-#c'6I)$@') J-+c)-LL%"+$) M-#$),%"()6.0.$#)&"#$) +"&J'() ) &-$L@)$@')%(.0.+-M) H"&J'()L-+)-M#%)J') 7-M"').+)$@')>(%,.M'G)) &-#c'6I)'ZG)3333BBBB) ) *,)-)&-#c'6)7-M"').#) #"J&.$$'6I)$@')%(.0.+-M) 7-M"')Y.MM)+%$)J') ">6-$'6G) nameOnAccount @')L"#$%&'(`#),"MM) ^>)$%);;)L@-(-L$'(#) *,)$@.#),.'M6).#)+%$) +-&')-#)M.#$'6)%+) #"J&.$$'6).+)$@') $@')J-+c)-LL%"+$))) ('O"'#$I)%()#"J&.$$'6) Y.$@)-)JM-+c)7-M"'I)$@') %(.0.+-M)7-M"')Y.MM)J') ('&%7'6),(%&)$@') >(%,.M'G) echeckType @')$?>')%,) !!Q) !"(('+$M?I)$@')!*/)EU*) 'M'L$(%+.L)L@'Lc) 6%'#)+%$)#">>%($)EN!) $(-+#-L$.%+)) UUQ) %()de!)$(-+#-L$.%+) [4) $?>'#G) ) R[d) ) Optional) *,)$@.#),.'M6).#)+%$) #"J&.$$'6).+)$@') ('O"'#$I)%()#"J&.$$'6) Y.$@)-)JM-+c)7-M"'I)$@') %(.0.+-M)7-M"')Y.MM)J') ('&%7'6),(%&)$@') >(%,.M'G) bankName @')+-&')%,)$@') ^>)$%)P<)L@-(-L$'(#) *,)$@.#),.'M6).#)+%$) J-+c)-##%L.-$'6) #"J&.$$'6).+)$@') Y.$@)$@')J-+c) ('O"'#$I)%()#"J&.$$'6) -LL%"+$)+"&J'() Y.$@)-)JM-+c)7-M"'I)$@') %(.0.+-M)7-M"')Y.MM)J') ) ('&%7'6),(%&)$@') Optional) >(%,.M'G) customerPaymentProfileId U-?&'+$)0-$'Y-?) H"&'(.L) ) -##.0+'6)*Q) -##%L.-$'6)Y.$@)$@') L"#$%&'()>-?&'+$) >(%,.M') validationMode *+6.L-$'#)$@') +%+') V-M.6-$.%+)&%6') >(%L'##.+0)&%6'),%() -MM%Y#)?%")$%)0'+'(-$') $@')('O"'#$) $'#$/%6') -)$'#$)$(-+#-L$.%+)-$) M.7'/%6') $@')$.&')?%")L('-$')-) ) L"#$%&'()>(%,.M'G)*+) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ 9B)
    • Section 2 Executing an API Call ELEMENT VALUE FORMAT NOTES Optional '#$)/%6'I)%+M?),.'M6) 7-M.6-$.%+).#) ) >'(,%(&'6G)*+)4.7') /%6'I)-)$(-+#-L$.%+).#) 0'+'(-$'6)-+6) #"J&.$$'6)$%)$@') >(%L'##%()Y.$@)$@') -&%"+$)%,)f<G<BG)*,) #"LL'##,"MI)$@') $(-+#-L$.%+).#) .&&'6.-$'M?)7%.6'6G) R@'+)-)7-M"')%,) g+%+'g).#)#"J&.$$'6I) +%)-66.$.%+-M) 7-M.6-$.%+).#) >'(,%(&'6G) ) *,)-)7-M.6-$.%+) $(-+#-L$.%+).#) "+#"LL'##,"MI)$@') >(%,.M').#)+%$)) ">6-$'6)-+6)$@') &'(L@-+$)Y.MM)('L'.7') -+)'((%(G) To test to see if the new payment information is valid, you can call validateCustomerPaymentProfileRequest after successfully updating the payment profile. See the section of this document titled “Input Elements for validateCustomerPaymentProfileRequest” for more information. For information about output elements for this function, see the section of this document titled “Output Elements for updateCustomerPaymentProfileResponse.” Example updateCustomerPaymentProfileRequest <?xml version="1.0" encoding="utf-8"?> <updateCustomerPaymentProfileRequest xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <merchantAuthentication> <name>YourUserLogin</name> <transactionKey>YourTranKey</transactionKey> </merchantAuthentication> <customerProfileId>10000</customerProfileId> <paymentProfile> <billTo> <firstName>John</firstName> <lastName>Doe</lastName> 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ 9;)
    • Merchant Web Services API <company></company> <address>123 Main St.</address> <city>Bellevue</city> <state>WA</state> <zip>98004</zip> <country>USA</country> <phoneNumber>000-000-0000</phoneNumber> <faxNumber></faxNumber> </billTo> <payment> <creditCard> <cardNumber>4111111111111111</cardNumber> <expirationDate>2026-01</expirationDate> </creditCard> </payment> <customerPaymentProfileId>20000</customerPaymentProfileId> </paymentProfile> </updateCustomerPaymentProfileRequest> Note: The sample code included in this document uses dummy field values. When using or testing sample code, be sure to enter valid field values. Additional sample code is available for download from the Authorize.Net Integration Center at http://developer.authorize.net/samplecode. Input Elements for updateCustomerShippingAddressRequest This function is used to update a shipping address for an existing customer profile. The following table lists the input elements for executing an API call to the updateCustomerShippingAddressRequest function. ELEMENT VALUE FORMAT NOTES refId /'(L@-+$D-##.0+'6) ^>)$%);<) *,).+LM"6'6).+)$@') (','('+L')*Q),%()$@') L@-(-L$'(#) ('O"'#$I)$@.#)7-M"')Y.MM) ('O"'#$) J').+LM"6'6).+)$@') ('#>%+#'G)@.#),'-$"(') ) &.0@$)J')'#>'L.-MM?) Optional "#',"M),%()&"M$.D $@('-6'6)->>M.L-$.%+#G) customerProfileId U-?&'+$)0-$'Y-?) H"&'(.L) ) -##.0+'6)*Q) -##%L.-$'6)Y.$@)$@') 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ 9T)
    • Section 2 Executing an API Call ELEMENT VALUE FORMAT NOTES L"#$%&'()>(%,.M') address !%+$-.+#)#@.>>.+0) ) ) -66('##).+,%(&-$.%+) ,%()$@')L"#$%&'() >(%,.M') firstName @')L"#$%&'(`#),.(#$) ^>)$%)P<) ) +-&') L@-(-L$'(#)1+%) #?&J%M#2) ) Optional) lastName @')L"#$%&'(`#)M-#$) ^>)$%)P<) ) +-&') L@-(-L$'(#)1+%) #?&J%M#2) ) Optional) company @')+-&')%,)$@') ^>)$%)P<) ) L%&>-+?)-##%L.-$'6) L@-(-L$'(#)1+%) Y.$@)$@')L"#$%&'(I).,) #?&J%M#2) ->>M.L-JM') ) Optional) address @')L"#$%&'(`#) ^>)$%)]<) ) #@.>>.+0)-66('##) L@-(-L$'(#)1+%) #?&J%M#2) ) Optional) city @')L.$?)%,)$@') ^>)$%)W<) ) L"#$%&'(`#)#@.>>.+0) L@-(-L$'(#)1+%) -66('##) #?&J%M#2) ) Optional) state @')#$-$')%,)$@') E)7-M.6)$Y%D ) L"#$%&'(`#)#@.>>.+0) L@-(-L$'()#$-$') -66('##) L%6') ) Optional) zip @')a*U)L%6')%,)$@') ^>)$%);<) ) L"#$%&'(`#)#@.>>.+0) L@-(-L$'(#)1+%) -66('##) #?&J%M#2) ) Optional) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ 9W)
    • Merchant Web Services API ELEMENT VALUE FORMAT NOTES country @')L%"+$(?)%,)$@') ^>)$%)]<) ) L"#$%&'(`#)#@.>>.+0) L@-(-L$'(#)1+%) -66('##) #?&J%M#2) ) Optional) phoneNumber @')>@%+')+"&J'() ^>)$%);P)6.0.$#)1+%) ) -##%L.-$'6)Y.$@)$@') M'$$'(#2) L"#$%&'(`#)#@.>>.+0) -66('##) ) ) [ZG)1B;T2B;TDB;TW) Optional) faxNumber @'),-Z)+"&J'() ^>)$%);P)6.0.$#)1+%) ) -##%L.-$'6)Y.$@)$@') M'$$'(#2) L"#$%&'(`#)#@.>>.+0) -66('##) ) ) [ZG)1B;T2B;TDB;TW) Optional) customerAddressId U-?&'+$)0-$'Y-?) H"&'(.L) ) -##.0+'6)*Q) -##%L.-$'6)Y.$@)$@') L"#$%&'()#@.>>.+0) -66('##)) For information about output elements for this function, see the section of this document titled “Output Elements for updateCustomerShippingAddressResponse.” Example updateCustomerShippingAddressRequest <?xml version="1.0" encoding="utf-8"?> <updateCustomerShippingAddressRequest xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <merchantAuthentication> <name>YourUserLogin</name> <transactionKey>YourTranKey</transactionKey> </merchantAuthentication> <customerProfileId>10000</customerProfileId> <address> <firstName>Newfirstname</firstName> <lastName>Doe</lastName> <company></company> <address>123 Main St.</address> 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ 9P)
    • Section 2 Executing an API Call <city>Bellevue</city> <state>WA</state> <zip>98004</zip> <country>USA</country> <phoneNumber>000-000-0000</phoneNumber> <faxNumber></faxNumber> <customerAddressId>30000</customerAddressId> </address> </updateCustomerShippingAddressRequest> Note: The sample code included in this document uses dummy field values. When using or testing sample code, be sure to enter valid field values. Additional sample code is available for download from the Authorize.Net Integration Center at http://developer.authorize.net/samplecode. Input Elements for validateCustomerPaymentProfileRequest This function is used to verify an existing customer payment profile by generating a test transaction. No customer receipt emails are sent when calling validateCustomerPaymentProfileRequest. The following table lists the input elements for executing an API call to the validateCustomerPaymentProfileRequest function. ELEMENT VALUE FORMAT NOTES customerProfileId U-?&'+$)0-$'Y-?) H"&'(.L) ) -##.0+'6)*Q)-##%L.-$'6) Y.$@)$@')L"#$%&'()>(%,.M') customerPaymentProfileId U-?&'+$)0-$'Y-?) H"&'(.L) ) -##.0+'6)*Q)-##%L.-$'6) Y.$@)$@')L"#$%&'() >-?&'+$)>(%,.M') customerShippingAddressId U-?&'+$)0-$'Y-?) H"&'(.L) *,) -##.0+'6)*Q)-##%L.-$'6) customerShippingAddres Y.$@)$@')L"#$%&'() sId).#)+%$)>-##'6I)#@.>>.+0) #@.>>.+0)-66('##) .+,%(&-$.%+)Y.MM)+%$)J') .+LM"6'6)Y.$@)$@') ) $(-+#-L$.%+G) Optional cardCode @')$@(''D)%(),%"(D6.0.$) H"&'(.L) @.#),.'M6).#)('O".('6).,)$@') +"&J'()%+)$@')J-Lc)%,)-) &'(L@-+$)Y%"M6)M.c')$%)"#') L('6.$)L-(6)1%+)$@'),(%+$) $@')!-(6)!%6')V'(.,.L-$.%+) ,%()E&'(.L-+)[Z>('##2)) 1!!V2)#'L"(.$?),'-$"('G)S%() &%(').+,%(&-$.%+I)>M'-#') ) #'')$@')Merchant 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ 9])
    • Merchant Web Services API ELEMENT VALUE FORMAT NOTES Optional) Integration Guide -$) @$$>8::YYYG-"$@%(.F'G+'$:#" >>%($:/'(L@-+$:6',-"M$G@$&G) ) cardCode).#)%+M?)"#'6),%() 7-M.6-$.%+)-+6)Y.MM)+%$)J') #$%('6).+)$@')L"#$%&'() >(%,.M'G)*$)#@%"M6)%+M?)J') "#'6)Y@'+)#"J&.$$.+0 validationMode)Y.$@)-) 7-M"')%,)testMode)%() liveModeG) validationMode *+6.L-$'#)$@')>(%L'##.+0) $'#$/%6') V-M.6-$.%+)&%6')-MM%Y#)?%") &%6'),%()$@')('O"'#$) $%)0'+'(-$')-)$'#$) M.7'/%6') $(-+#-L$.%+).+)'.$@'()'#$) ) /%6')%()4.7')/%6')$%) L@'Lc)$@')7-M.6.$?)%,) L"#$%&'().+,%(&-$.%+G)*+) '#$)/%6'I)%+M?),.'M6) 7-M.6-$.%+).#)>'(,%(&'6G)*+) 4.7')/%6'I)-)$(-+#-L$.%+).#) 0'+'(-$'6)-+6)#"J&.$$'6)$%) $@')>(%L'##%()Y.$@)$@') -&%"+$)%,)f<G<BG)*,) #"LL'##,"MI)$@')$(-+#-L$.%+) .#).&&'6.-$'M?)7%.6'6G) For information about output elements for this function, see the section of this document titled “Output Elements for validateCustomerPaymentProfileResponse.” Example validateCustomerPaymentProfileRequest <?xml version="1.0" encoding="utf-8"?> <validateCustomerPaymentProfileRequest xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <merchantAuthentication> <name>YourUserLogin</name> <transactionKey>YourTranKey</transactionKey> </merchantAuthentication> <customerProfileId>10000</customerProfileId> <customerPaymentProfileId>20000</customerPaymentProfileId> <customerShippingAddressId>30000</customerShippingAddressId> <validationMode>liveMode</validationMode> </validateCustomerPaymentProfileRequest> 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ 99)
    • Section 2 Executing an API Call Note: The sample code included in this document uses dummy field values. When using or testing sample code, be sure to enter valid field values. Additional sample code is available for download from the Authorize.Net Integration Center at http://developer.authorize.net/samplecode. Section 3 Responses The response from the payment gateway to the API call is a set of fields that provides information about the status of the request. The following table lists output for API calls. ELEMENT VALUE FORMAT NOTES refId /'(L@-+$D-##.0+'6) ^>)$%);<)L@-(-L$'(#) *,).+LM"6'6).+)$@')('O"'#$I) (','('+L')*Q),%()$@')('O"'#$) $@.#)7-M"')Y.MM)J').+LM"6'6) .+)$@')('#>%+#'G)@.#) ) ,'-$"(')&.0@$)J')'#>'L.-MM?) Optional "#',"M),%()&"M$.D$@('-6'6) ->>M.L-$.%+#G) messages !%+$-.+#).+,%(&-$.%+)-J%"$) ) ) $@')('#"M$#)%,)$@')('O"'#$) resultCode !%+$-.+#)-66.$.%+-M) ec) ) .+,%(&-$.%+)-J%"$)$@') ('#"M$#)%,)$@')('O"'#$) [((%() message !%+$-.+#)$@')('#"M$)L%6') ) /'##-0')>(%7.6'#)&%(') -+6)$'Z$) 6'$-.M#)-J%"$)$@')'((%(1#2G) code E)L%6')$@-$)('>('#'+$#)$@') K$(.+0) K'')$@')hN'#>%+#')!%6'#i) ('-#%+),%()$@')'((%() #'L$.%+)%,)$@.#)6%L"&'+$),%() >%##.JM')7-M"'#G) text E)$'Z$)6'#L(.>$.%+)%,)$@') K$(.+0) K'')$@')hN'#>%+#')!%6'#i) '((%() #'L$.%+)%,)$@.#)6%L"&'+$),%() >%##.JM')7-M"'#G) !*/)N'#>%+#'#) The sample below illustrates the structure of a typical response from the payment gateway for any of the CIM API calls. 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ 9C)
    • Merchant Web Services API Sample Response <?xml version="1.0" encoding="utf-8" ?> <createCustomerProfileResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <refId>refid1</refId> <messages> <resultCode>Ok</resultCode> <message> <code>I00001</code> <text>Successful.</text> </message> </messages> <customerProfileId>3187</customerProfileId> </createCustomerProfileResponse>) Output for createCustomerProfileResponse The following table lists the additional output returned from the payment gateway for an API call to the createCustomerProfileRequest function. Note: The createCustomerProfileResponse only returns the assigned customerProfileId for the created profile. To retrieve the customerPaymentProfileId and the customerShippingId that may also be created when using the createCustomerProfileRequest function, you must submit the getCustomerProfileRequest function, using the assigned customerProfileId for that customer profile. ELEMENT VALUE FORMAT NOTES refId /'(L@-+$D-##.0+'6) ^>)$%);<)L@-(-L$'(#) *,).+LM"6'6).+)$@') (','('+L')*Q),%()$@') ('O"'#$I)$@.#)7-M"') ('O"'#$) Y.MM)J').+LM"6'6).+) $@')('#>%+#'G)@.#) ) ,'-$"(')&.0@$)J') Optional '#>'L.-MM?)"#',"M),%() &"M$.D$@('-6'6) ->>M.L-$.%+#G) customerProfileId U-?&'+$)0-$'Y-?) H"&'(.L) @.#)%"$>"$).#)%+M?) -##.0+'6)*Q) >('#'+$),%() -##%L.-$'6)Y.$@)$@') #"LL'##,"M)('O"'#$#G) L"#$%&'()>(%,.M') customerPaymentProfileIdList E)M.#$)%,)-MM)>-?&'+$) H"&'(.L) @.#)%"$>"$).#)%+M?) >(%,.M')*Q#)L('-$'6) >('#'+$),%()('O"'#$#) Y.$@)$@')('O"'#$) $@-$)L%+$-.+)%+')%() 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ 9=)
    • Section 3 Responses ) &%(')>-?&'+$) >(%,.M'#G) Optional) ) @')>-?&'+$)>(%,.M') *Q#)Y.MM)J')('$"(+'6) .+)$@')#-&')%(6'()-#) $@'?)Y'(').+)$@') ('O"'#$G) customerShippingAddressIdList E)M.#$)%,)-MM)#@.>>.+0) H"&'(.L) @.#)%"$>"$).#)%+M?) >(%,.M')*Q#)L('-$'6) >('#'+$),%()('O"'#$#) Y.$@)$@')('O"'#$) $@-$)L%+$-.+)&"M$.>M') #@.>>.+0)>(%,.M'#G) ) ) Optional) @')#@.>>.+0)>(%,.M') *Q#)Y.MM)J')('$"(+'6) .+)$@')#-&')%(6'()-#) $@'?)Y'(').+)$@') ('O"'#$G) validationDirectResponseList E)M.#$)%,)$@')6.('L$) K$(.+0) @.#)%"$>"$).#)%+M?) ('#>%+#')('#"M$#),%() >('#'+$).,)$@') $@')7-M.6-$.%+) ) ValidationMode) $(-+#-L$.%+),%()'-L@) K'')$@')Advanced .+>"$)'M'&'+$).#) >-?&'+$)>(%,.M'G) Integration Guide)-$) >-##'6)Y.$@)-)7-M"') ) @$$>8::YYYG-"$@%(.F'G %,)testMode)%() +'$:#">>%($:E*/k0".6 liveModeG) Optional) 'G>6,),%()6'$-.M#)-J%"$) ) .+,%(&-$.%+).+LM"6'6) .+)$@')>-?&'+$) @')M.#$)Y.MM)J') 0-$'Y-?)$(-+#-L$.%+) ('$"(+'6).+)$@')#-&') ('#>%+#'G) %(6'()-#)$@') >-?&'+$)>(%,.M'#) Y'(')#"J&.$$'6).+) $@')('O"'#$G) Sample Successful createCustomerProfileResponse <?xml version="1.0" encoding="utf-8"?> <createCustomerProfileResponse xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <messages> <resultCode>Ok</resultCode> <message> <code>I00001</code> <text>Successful.</text> </message> </messages> <customerProfileId>10000</customerProfileId> <customerPaymentProfileIdList> 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ C<)
    • Merchant Web Services API <numericString>20000</numericString> <numericString>20001</numericString> </customerPaymentProfileIdList> <customerShippingAddressIdList> <numericString>30000</numericString> <numericString>30001</numericString> </customerShippingAddressIdList> <validationDirectResponseList> <string>1,1,1,This transaction has been approved.,000000,Y,2000000000,none,Test transaction for ValidateCustomerPaymentProfile.,0.01,CC,auth_only,custId123, John,Doe,,123 Main St.,Bellevue,WA,98004,USA,000-000- 0000,,mark@example.com,,,,,,,,,0.00,0.00,0.00,,none, D18EB6B211FE0BBF556B271FDA6F92EE,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,</string> <string>1,1,1,This transaction has been approved.,000000,Y,2000000001,none,Test transaction for ValidateCustomerPaymentProfile.,0.01,CC,auth_only,custId123, John,Doe,,123 Main St.,Bellevue,WA,98004,USA,000-000- 0000,,mark@example.com,,,,,,,,,0.00,0.00,0.00,,none, D18EB6B211FE0BBF556B271FDA6F92EE,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,</string> </validationDirectResponseList> </createCustomerProfileResponse> Sample Unsuccessful createCustomerProfileResponse <?xml version="1.0" encoding="utf-8"?> <createCustomerProfileResponse xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <messages> <resultCode>Error</resultCode> <message> <code>E00044</code> <text>Customer Information Manager is not enabled.</text> </message> </messages> </createCustomerProfileResponse> Output for createCustomerPaymentProfileResponse The following table lists the additional output returned from the payment gateway for an API call to the createCustomerPaymentProfileRequest function. 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ CB)
    • Section 3 Responses ELEMENT VALUE FORMAT NOTES refId /'(L@-+$D ^>)$%);<)L@-(-L$'(#) *,).+LM"6'6).+)$@') -##.0+'6) ('O"'#$I)$@.#)7-M"') (','('+L')*Q),%() Y.MM)J').+LM"6'6).+) $@')('O"'#$) $@')('#>%+#'G)@.#) ,'-$"(')&.0@$)J') ) '#>'L.-MM?)"#',"M),%() Optional &"M$.D$@('-6'6) ->>M.L-$.%+#G) customerPaymentProfileId U-?&'+$) H"&'(.L) @.#)%"$>"$).#)%+M?) 0-$'Y-?) >('#'+$),%() -##.0+'6)*Q) #"LL'##,"M) -##%L.-$'6)Y.$@) ('O"'#$#G) $@')L"#$%&'() >-?&'+$)>(%,.M') validationDirectResponse !%+$-.+#) K$(.+0) @.#)%"$>"$).#)%+M?) 6'$-.M'6) >('#'+$).,)$@') .+,%(&-$.%+) ) ValidationMode) -J%"$)$@')('#"M$) K'')$@')Advanced .+>"$)'M'&'+$).#) %,)$@') Integration Guide)-$) >-##'6)Y.$@)-)7-M"') $(-+#-L$.%+G) @$$>8::YYYG-"$@%(.F'G+' %,)testMode)%() $:#">>%($:E*/k0".6'G>6,) liveModeG) ,%()6'$-.M#)-J%"$) .+,%(&-$.%+).+LM"6'6).+) $@')>-?&'+$)0-$'Y-?) $(-+#-L$.%+)('#>%+#'G) Sample createCustomerPaymentProfileResponse <?xml version="1.0" encoding="utf-8"?> <createCustomerPaymentProfileResponse xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <messages> <resultCode>Ok</resultCode> <message> <code>I00001</code> <text>Successful.</text> </message> </messages> <customerPaymentProfileId>20000</customerPaymentProfileId> <validationDirectResponse>1,1,1,This transaction has been approved.,000000,Y,2000000000,none,Test transaction for ValidateCustomerPaymentProfile.,0.01,CC,auth_only,custId123, John,Doe,,123 Main St.,Bellevue,WA,98004,USA,000-000- 0000,,mark@example.com,,,,,,,,,0.00,0.00,0.00,,none, D18EB6B211FE0BBF556B271FDA6F92EE,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, </validationDirectResponse> 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ C;)
    • Merchant Web Services API </createCustomerPaymentProfileResponse> Output for createCustomerShippingAddressResponse The following table represents the additional output returned from the payment gateway for an API call to the createCustomerShippingAddressRequest function. ELEMENT VALUE FORMAT NOTES refId /'(L@-+$D ^>)$%);<) *,).+LM"6'6).+)$@') -##.0+'6) L@-(-L$'(#) ('O"'#$I)$@.#)7-M"')Y.MM) (','('+L')*Q),%() J').+LM"6'6).+)$@') $@')('O"'#$) ('#>%+#'G)@.#),'-$"(') &.0@$)J')'#>'L.-MM?) ) "#',"M),%()&"M$.D$@('-6'6) Optional ->>M.L-$.%+#G) customerAddressId U-?&'+$) H"&'(.L) @.#)%"$>"$).#)%+M?) 0-$'Y-?) >('#'+$),%()#"LL'##,"M) -##.0+'6)*Q) ('O"'#$#G) -##%L.-$'6)Y.$@) $@')L"#$%&'() #@.>>.+0)-66('##)) Sample createCustomerShippingAddressResponse <?xml version="1.0" encoding="utf-8"?> <createCustomerShippingAddressResponse xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <messages> <resultCode>Ok</resultCode> <message> <code>I00001</code> <text>Successful.</text> </message> </messages> <customerAddressId>30000</customerAddressId> </createCustomerShippingAddressResponse> Output for createCustomerProfileTransactionResponse The following table represents the additional output returned from the payment gateway for an API call to the createCustomerProfileTransactionRequest function. 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ CT)
    • Section 3 Responses ELEMENT VALUE FORMAT NOTES refId /'(L@-+$D ^>)$%);<)L@-(-L$'(#) *,).+LM"6'6).+)$@') -##.0+'6) ('O"'#$I)$@.#)7-M"') (','('+L')*Q),%() Y.MM)J').+LM"6'6).+) $@')('O"'#$) $@')('#>%+#'G)@.#) ,'-$"(')&.0@$)J') ) '#>'L.-MM?)"#',"M) Optional ,%()&"M$.D$@('-6'6) ->>M.L-$.%+#G) directResponse !%+$-.+#) K$(.+0) (-+#-L$.%+#) 6'$-.M'6) L('-$'6),(%&)-) .+,%(&-$.%+) ) L"#$%&'()>(%,.M') -J%"$)$@')('#"M$) K'')$@')Advanced Y.MM)J'@-7')$@') %,)$@') Integration Guide)-$) #-&')-#)('0"M-() $(-+#-L$.%+G) @$$>8::YYYG-"$@%(.F'G+ $(-+#-L$.%+#)D)?%") '$:#">>%($:E*/k0".6'G -+6)?%"()L"#$%&'() >6,),%()6'$-.M#)-J%"$) Y.MM)('L'.7')-MM) .+,%(&-$.%+).+LM"6'6).+) -##%L.-$'6)'&-.M) $@')>-?&'+$)0-$'Y-?) +%$.,.L-$.%+#G) $(-+#-L$.%+)('#>%+#'G) E66.$.%+-MM?I)-MM) ,(-"6)#'$$.+0#I) .+LM"6.+0)SQK) ,.M$'(#)-+6)EVK) -+6)!!V)#'$$.+0#I) Y.MM)J')'+,%(L'6G) Sample createCustomerProfileTransactionResponse <?xml version="1.0" encoding="utf-8"?> <createCustomerProfileTransactionResponse xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <messages> <resultCode>Ok</resultCode> <message> <code>I00001</code> <text>Successful.</text> </message> </messages> <directResponse>1,1,1,This transaction has been approved.,000000,Y,2000000001,INV000001,description of transaction,10.95,CC,auth_capture,custId123,John,Doe,,123 Main St.,Bellevue,WA,98004,USA,000-000- 0000,,mark@example.com,John,Doe,,123 Main St.,Bellevue,WA,98004,USA,1.00,0.00,2.00,FALSE,PONUM000001, D18EB6B211FE0BBF556B271FDA6F92EE,M,2,,,,,,,,,,,,,,,,,,,,,,,,,,,, </directResponse> </createCustomerProfileTransactionResponse> 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ CW)
    • Merchant Web Services API Output for deleteCustomerProfileResponse The following table lists the additional output returned from the payment gateway for an API call to the deleteCustomerProfileRequest function. ELEMENT VALUE FORMAT NOTES refId /'(L@-+$D-##.0+'6) ^>)$%);<) *,).+LM"6'6).+)$@') (','('+L')*Q),%()$@') L@-(-L$'(#) ('O"'#$I)$@.#)7-M"')Y.MM) ('O"'#$) J').+LM"6'6).+)$@') ('#>%+#'G)@.#),'-$"(') ) &.0@$)J')'#>'L.-MM?) Optional "#',"M),%()&"M$.D $@('-6'6)->>M.L-$.%+#G) Sample deleteCustomerProfileResponse <?xml version="1.0" encoding="utf-8"?> <deleteCustomerProfileResponse xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <messages> <resultCode>Ok</resultCode> <message> <code>I00001</code> <text>Successful.</text> </message> </messages> </deleteCustomerProfileResponse> Output for deleteCustomerPaymentProfileResponse The following table lists the additional output returned from the payment gateway for an API call to the deleteCustomerPaymentProfileRequest function. ELEMENT VALUE FORMAT NOTES refId /'(L@-+$D ^>)$%);<) *,).+LM"6'6).+)$@')('O"'#$I) -##.0+'6) L@-(-L$'(#) $@.#)7-M"')Y.MM)J').+LM"6'6) (','('+L')*Q),%() .+)$@')('#>%+#'G)@.#) $@')('O"'#$) ,'-$"(')&.0@$)J')'#>'L.-MM?) "#',"M),%()&"M$.D$@('-6'6) ) ->>M.L-$.%+#G) Optional 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ CP)
    • Section 3 Responses Sample deleteCustomerPaymentProfileResponse <?xml version="1.0" encoding="utf-8"?> <deleteCustomerPaymentProfileResponse xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <messages> <resultCode>Ok</resultCode> <message> <code>I00001</code> <text>Successful.</text> </message> </messages> </deleteCustomerPaymentProfileResponse> Output for deleteCustomerShippingAddressResponse The following table lists the additional output returned from the payment gateway for an API call to the deleteCustomerShippingAddressRequest function. ELEMENT VALUE FORMAT NOTES refId /'(L@-+$D ^>)$%);<) *,).+LM"6'6).+)$@') -##.0+'6) L@-(-L$'(#) ('O"'#$I)$@.#)7-M"')Y.MM) (','('+L')*Q),%() J').+LM"6'6).+)$@') $@')('O"'#$) ('#>%+#'G)@.#),'-$"(') &.0@$)J')'#>'L.-MM?) ) "#',"M),%()&"M$.D Optional $@('-6'6)->>M.L-$.%+#G) Sample deleteCustomerShippingAddressResponse <?xml version="1.0" encoding="utf-8"?> <deleteCustomerShippingAddressResponse xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <messages> <resultCode>Ok</resultCode> <message> <code>I00001</code> <text>Successful.</text> </message> </messages> </deleteCustomerShippingAddressResponse> 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ C])
    • Merchant Web Services API Output for getCustomerProfileIdsResponse The following table lists the additional output returned from the payment gateway for an API call to the getCustomerProfileIdsRequest function. ELEMENT VALUE FORMAT NOTES refId /'(L@-+$D ^>)$%);<)L@-(-L$'(#) *,).+LM"6'6).+)$@') -##.0+'6) ('O"'#$I)$@.#)7-M"') (','('+L')*Q),%() Y.MM)J').+LM"6'6).+) $@')('O"'#$) $@')('#>%+#'G)@.#) ,'-$"(')&.0@$)J') ) '#>'L.-MM?)"#',"M),%() Optional &"M$.D$@('-6'6) ->>M.L-$.%+#G) ids U-?&'+$) H"&'(.L) @.#)%"$>"$).#)%+M?) 0-$'Y-?) >('#'+$),%() -##.0+'6)*Q#) #"LL'##,"M)('O"'#$#G) -##%L.-$'6)Y.$@) $@')L"#$%&'() >(%,.M'#) Sample Successful getCustomerProfileIdsResponse <?xml version="1.0" encoding="utf-8"?> <getCustomerProfileIdsResponse xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <messages> <resultCode>Ok</resultCode> <message> <code>I00001</code> <text>Successful.</text> </message> </messages> <ids> <numericString>10000</numericString> <numericString>10001</numericString> <numericString>10002</numericString> </ids> </getCustomerProfileIdsResponse> Output for getCustomerProfileResponse The following table lists the additional output returned from the payment gateway for an API call to the getCustomerProfileRequest function. 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ C9)
    • Section 3 Responses ELEMENT VALUE FORMAT NOTES profile !%+$-.+#) ) ) .+,%(&-$.%+),%() $@')L"#$%&'() >(%,.M') customerProfileId U-?&'+$) H"&'(.L) @.#)%"$>"$).#) 0-$'Y-?) %+M?)>('#'+$),%() -##.0+'6)*Q) #"LL'##,"M) -##%L.-$'6) ('O"'#$#G) Y.$@)$@') L"#$%&'() >(%,.M') merchantCustomerId /'(L@-+$) ^>)$%);<)L@-(-L$'(#) ) -##.0+'6)*Q) ,%()$@') L"#$%&'() ) Optional) description Q'#L(.>$.%+)%,) ^>)$%);PP)L@-(-L$'(#) ) $@')L"#$%&'() %()L"#$%&'() >(%,.M') ) Optional) email [&-.M)-66('##) ^>)$%);PP)L@-(-L$'(#) ) -##%L.-$'6) Y.$@)$@') L"#$%&'() >(%,.M') ) Optional) paymentProfiles !%+$-.+#) ) ) >-?&'+$) >(%,.M'#),%()$@') L"#$%&'() >(%,.M') customerPaymentProfileId U-?&'+$) H"&'(.L) ) 0-$'Y-?) -##.0+'6)*Q) -##%L.-$'6) Y.$@)$@') L"#$%&'() >-?&'+$) >(%,.M') payment !%+$-.+#) ) ) >-?&'+$)) >(%,.M') 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ CC)
    • Merchant Web Services API ELEMENT VALUE FORMAT NOTES .+,%(&-$.%+),%() $@')L"#$%&'() >(%,.M') creditCard !%+$-.+#)L('6.$) ) ) L-(6)>-?&'+$) .+,%(&-$.%+),%() $@')L"#$%&'() >(%,.M') cardNumber @') BT)$%)B])6.0.$#) EMM)#'+#.$.7') L"#$%&'(`#) >-?&'+$) L('6.$)L-(6) .+,%(&-$.%+).+)$@') +"&J'() %"$>"$).#)&-#c'6G) expirationDate @')'Z>.(-$.%+) bbbbD//) EMM)#'+#.$.7') 6-$'),%()$@') >-?&'+$) L"#$%&'(`#) .+,%(&-$.%+).+)$@') L('6.$)L-(6) %"$>"$).#)&-#c'6G) bankAccount !%+$-.+#)J-+c) ) ) -LL%"+$) >-?&'+$) .+,%(&-$.%+),%() $@')L"#$%&'() >(%,.M') routingNumber @')(%"$.+0) =)6.0.$#) EMM)#'+#.$.7') +"&J'()%,)$@') >-?&'+$) L"#$%&'(`#) .+,%(&-$.%+).+)$@') J-+c)) %"$>"$).#)&-#c'6G) accountNumber @') P)$%)B9)6.0.$#) EMM)#'+#.$.7') L"#$%&'(`#) >-?&'+$) J-+c)-LL%"+$) .+,%(&-$.%+).+)$@') +"&J'() %"$>"$).#)&-#c'6G) driversLicense !%+$-.+#)$@') ) @.#),.'M6).#)+%) L"#$%&'(`#) M%+0'()#">>%($'6) 6(.7'(`#)M.L'+#') .+)!*/)('O"'#$#) .+,%(&-$.%+) -+6).#)%+M?) ('$"(+'6),%() >(%,.M'#)$@-$)Y'(') L('-$'6)"+6'()$@') K'L"('K%"(L') >(%6"L$G) state @')#$-$')%,) E)7-M.6)$Y%DL@-(-L$'() @.#),.'M6).#)+%) $@')L"#$%&'(`#) #$-$')L%6') M%+0'()#">>%($'6) 6(.7'(`#)M.L'+#') .+)!*/)('O"'#$#) -+6).#)%+M?) ('$"(+'6),%() >(%,.M'#)$@-$)Y'(') L('-$'6)"+6'()$@') K'L"('K%"(L') >(%6"L$G) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ C=)
    • Section 3 Responses ELEMENT VALUE FORMAT NOTES number @') P)$%);<)L@-(-L$'(#) @.#),.'M6).#)+%) L"#$%&'(`#) M%+0'()#">>%($'6) 6(.7'(`#)M.L'+#') .+)!*/)('O"'#$#) +"&J'() -+6).#)%+M?) ('$"(+'6),%() >(%,.M'#)$@-$)Y'(') L('-$'6)"+6'()$@') K'L"('K%"(L') >(%6"L$G)) ) EMM)#'+#.$.7') >-?&'+$) .+,%(&-$.%+).+)$@') %"$>"$).#)&-#c'6G) dateOfBirth @')6-$')%,) bbbbD//DQQ) @.#),.'M6).#)+%) J.($@)M.#$'6)%+) M%+0'()#">>%($'6) $@')L"#$%&'(`#) .+)!*/)('O"'#$#) 6(.7'(`#)M.L'+#') -+6).#)%+M?) ('$"(+'6),%() >(%,.M'#)$@-$)Y'(') L('-$'6)"+6'()$@') K'L"('K%"(L') >(%6"L$G)) ) EMM)#'+#.$.7') >-?&'+$) .+,%(&-$.%+).+)$@') %"$>"$).#)&-#c'6G) taxId @') =)6.0.$#) @.#),.'M6).#)+%) L"#$%&'(`#) M%+0'()#">>%($'6) K%L.-M)K'L"(.$?) .+)!*/)('O"'#$#) H"&J'()%()$-Z) -+6).#)%+M?) *Q) ('$"(+'6),%() >(%,.M'#)$@-$)Y'(') L('-$'6)"+6'()$@') K'L"('K%"(L') >(%6"L$G)) ) EMM)#'+#.$.7') >-?&'+$) .+,%(&-$.%+).+)$@') %"$>"$).#)&-#c'6G) shipToList !%+$-.+#) ) ) #@.>>.+0) -66('##)>(%,.M') .+,%(&-$.%+),%() $@')L"#$%&'() >(%,.M') customerShippingAddressId U-?&'+$) H"&'(.L) ) 0-$'Y-?) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ =<)
    • Merchant Web Services API ELEMENT VALUE FORMAT NOTES -##.0+'6)*Q) -##%L.-$'6) Y.$@)$@') L"#$%&'() #@.>>.+0) -66('##)) firstName @') ^>)$%)P<)L@-(-L$'(#)1+%) ) L"#$%&'(`#) #?&J%M#2) ,.(#$)+-&') ) Optional) lastName @') ^>)$%)P<)L@-(-L$'(#)1+%) ) L"#$%&'(`#)M-#$) #?&J%M#2) +-&') ) Optional) company @')+-&')%,) ^>)$%)P<)L@-(-L$'(#)1+%) ) $@')L%&>-+?) #?&J%M#2) -##%L.-$'6) Y.$@)$@') L"#$%&'(I).,) ->>M.L-JM') ) Optional) address @') ^>)$%)]<)L@-(-L$'(#)1+%) ) L"#$%&'(`#) #?&J%M#2) #@.>>.+0) -66('##) ) Optional) city @')L.$?)%,)$@') ^>)$%)W<)L@-(-L$'(#)1+%) ) L"#$%&'(`#) #?&J%M#2) #@.>>.+0) -66('##) ) Optional) state @')#$-$')%,) E)7-M.6)$Y%DL@-(-L$'() ) $@')L"#$%&'(`#) #$-$')L%6') #@.>>.+0) -66('##) ) Optional) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ =B)
    • Section 3 Responses ELEMENT VALUE FORMAT NOTES zip @')a*U)L%6') ^>)$%);<)L@-(-L$'(#)1+%) ) %,)$@') #?&J%M#2) L"#$%&'(`#) #@.>>.+0) -66('##) ) Optional) country @')L%"+$(?)%,) ^>)$%)]<)L@-(-L$'(#)1+%) ) $@')L"#$%&'(`#) #?&J%M#2) #@.>>.+0) -66('##) ) Optional) phoneNumber @')>@%+') ^>)$%);P)6.0.$#)1+%)M'$$'(#2) ) +"&J'() -##%L.-$'6) ) Y.$@)$@') [ZG)1B;T2B;TDB;TW) L"#$%&'(`#) #@.>>.+0) -66('##) ) Optional) faxNumber @'),-Z) ^>)$%);P)6.0.$#)1+%)M'$$'(#2) ) +"&J'() -##%L.-$'6) ) Y.$@)$@') [ZG)1B;T2B;TDB;TW) L"#$%&'(`#) #@.>>.+0) -66('##) ) Optional) Sample getCustomerProfileResponse <?xml version="1.0" encoding="utf-8"?> <getCustomerProfileResponse xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <messages> <resultCode>Ok</resultCode> <message> <code>I00001</code> <text>Successful.</text> </message> </messages> 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ =;)
    • Merchant Web Services API <profile> <merchantCustomerId>custId123</merchantCustomerId> <description>some description</description> <email>mark@example.com</email> <customerProfileId>10000</customerProfileId> <paymentProfiles> <billTo> <firstName>John</firstName> <lastName>Doe</lastName> <company></company> <address>123 Main St.</address> <city>Bellevue</city> <state>WA</state> <zip>98004</zip> <country>USA</country> <phoneNumber>000-000-0000</phoneNumber> <faxNumber></faxNumber> </billTo> <customerPaymentProfileId>20000</customerPaymentProfileId> <payment> <creditCard> <cardNumber>XXXX1111</cardNumber> <expirationDate>XXXX</expirationDate> </creditCard> </payment> </paymentProfiles> <paymentProfiles> <customerPaymentProfileId>20001</customerPaymentProfileId> <payment> <bankAccount> <accountType>checking</accountType> <routingNumber>XXXX0000</routingNumber> <accountNumber>XXXX0000</accountNumber> <nameOnAccount>John Doe</nameOnAccount> <bankName>Bank of Washington</bankName> </bankAccount> </payment> </paymentProfiles> <shipToList> <firstName>John</firstName> 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ =T)
    • Section 3 Responses <lastName>Doe</lastName> <company></company> <address>123 Main St.</address> <city>Bellevue</city> <state>WA</state> <zip>98004</zip> <country>USA</country> <phoneNumber>000-000-0000</phoneNumber> <faxNumber></faxNumber> </shipToList> <shipToList> <firstName>Jane</firstName> <lastName>Doe</lastName> <address>123 Main St.</address> <city>Bellevue</city> <state>WA</state> <zip>98004</zip> <country>USA</country> <phoneNumber>000-000-0000</phoneNumber> </shipToList> </profile> </getCustomerProfileResponse> Output for getCustomerPaymentProfileResponse The following table lists the additional output returned from the payment gateway for an API call to the getCustomerPaymentProfileRequest function. ELEMENT VALUE FORMAT NOTES paymentProfile !%+$-.+#)>-?&'+$) ) ) .+,%(&-$.%+),%()$@') L"#$%&'()>(%,.M') customerPaymentProfileId U-?&'+$)0-$'Y-?) H"&'(.L) ) -##.0+'6)*Q) -##%L.-$'6)Y.$@) $@')L"#$%&'() >-?&'+$)>(%,.M') customerType ) .+6.7.6"-M) ) J"#.+'##) billTo ) ) ) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ =W)
    • Merchant Web Services API ELEMENT VALUE FORMAT NOTES firstName @')L"#$%&'(`#) ^>)$%)P<)L@-(-L$'(#)1+%) ) ,.(#$)+-&') #?&J%M#2) lastName @')L"#$%&'(`#) ^>)$%)P<)L@-(-L$'(#)1+%) ) M-#$)+-&') #?&J%M#2) company @')+-&')%,)$@') ^>)$%)P<)L@-(-L$'(#)1+%) ) L%&>-+?) #?&J%M#2) -##%L.-$'6)Y.$@) $@')L"#$%&'(I).,) ->>M.L-JM') address @')L"#$%&'(`#) ^>)$%)]<)L@-(-L$'(#)1+%) ) -66('##) #?&J%M#2) city @')L.$?)%,)$@') ^>)$%)W<)L@-(-L$'(#)1+%) ) L"#$%&'(`#) #?&J%M#2) -66('##) state @')#$-$')%,)$@') E)7-M.6)$Y%DL@-(-L$'() ) L"#$%&'(`#) #$-$')L%6') -66('##) zip @')a*U)L%6')%,) ^>)$%);<)L@-(-L$'(#)1+%) ) $@')L"#$%&'(`#) #?&J%M#2) -66('##) country @')L%"+$(?)%,)$@') ^>)$%)]<)L@-(-L$'(#)1+%) ) L"#$%&'(`#) #?&J%M#2) -66('##) phoneNumber @')>@%+') ^>)$%);P)6.0.$#)1+%)M'$$'(#2) ) +"&J'() -##%L.-$'6)Y.$@) ) $@')L"#$%&'(`#) [ZG)1B;T2B;TDB;TW) -66('##) faxNumber @'),-Z)+"&J'() ^>)$%);P)6.0.$#)1+%)M'$$'(#2) ) -##%L.-$'6)Y.$@) $@')L"#$%&'(`#) ) -66('##) [ZG)1B;T2B;TDB;TW) payment !%+$-.+#)>-?&'+$)) ) ) >(%,.M').+,%(&-$.%+) ,%()$@')L"#$%&'() >(%,.M') creditCard !%+$-.+#)L('6.$) ) ) L-(6)>-?&'+$) .+,%(&-$.%+),%()$@') >-?&'+$)>(%,.M') cardNumber @')L"#$%&'(`#) BT)$%)B])6.0.$#) EMM)#'+#.$.7') L('6.$)L-(6) >-?&'+$) .+,%(&-$.%+).+)$@') 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ =P)
    • Section 3 Responses ELEMENT VALUE FORMAT NOTES +"&J'() %"$>"$).#)&-#c'6G) expirationDate @')'Z>.(-$.%+) bbbbD//) EMM)#'+#.$.7') 6-$'),%()$@') >-?&'+$) L"#$%&'(`#)L('6.$) .+,%(&-$.%+).+)$@') L-(6) %"$>"$).#)&-#c'6G) bankAccount !%+$-.+#)J-+c) ) ) -LL%"+$)>-?&'+$) .+,%(&-$.%+),%()$@') >-?&'+$)>(%,.M') accountType @')$?>')%,)J-+c) L@'Lc.+0) ) -LL%"+$),%()$@') >-?&'+$)>(%,.M') #-7.+0#) J"#.+'##!@'Lc.+0) routingNumber @')(%"$.+0) =)6.0.$#) EMM)#'+#.$.7') +"&J'()%,)$@') >-?&'+$) L"#$%&'(`#)J-+c)) .+,%(&-$.%+).+)$@') %"$>"$).#)&-#c'6G) accountNumber @')L"#$%&'(`#) P)$%)B9)6.0.$#) EMM)#'+#.$.7') J-+c)-LL%"+$) >-?&'+$) +"&J'() .+,%(&-$.%+).+)$@') %"$>"$).#)&-#c'6G) nameOnAccount @')L"#$%&'(`#) ^>)$%);;)L@-(-L$'(#) ) ,"MM)+-&')-#)M.#$'6) %+)$@')J-+c) -LL%"+$))) echeckType @')$?>')%,) !!Q) !"(('+$M?I)$@')!*/) 'M'L$(%+.L)L@'Lc) EU*)6%'#)+%$) $(-+#-L$.%+) UUQ) #">>%($)EN!)%() [4) de!)$(-+#-L$.%+) $?>'#G) R[d) bankName @')+-&')%,)$@') ^>)$%)P<)L@-(-L$'(#) ) J-+c)-##%L.-$'6) Y.$@)$@')J-+c) -LL%"+$)+"&J'() driversLicense !%+$-.+#)$@') ) @.#),.'M6).#)+%) L"#$%&'(`#) M%+0'()#">>%($'6) 6(.7'(`#)M.L'+#') .+)!*/)('O"'#$#) .+,%(&-$.%+) -+6).#)%+M?) ('$"(+'6),%() >(%,.M'#)$@-$)Y'(') L('-$'6)"+6'()$@') K'L"('K%"(L') >(%6"L$G)) state @')#$-$')%,)$@') E)7-M.6)$Y%DL@-(-L$'() @.#),.'M6).#)+%) L"#$%&'(`#) M%+0'()#">>%($'6) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ =])
    • Merchant Web Services API ELEMENT VALUE FORMAT NOTES 6(.7'(`#)M.L'+#') #$-$')L%6') .+)!*/)('O"'#$#) -+6).#)%+M?) ('$"(+'6),%() >(%,.M'#)$@-$)Y'(') L('-$'6)"+6'()$@') K'L"('K%"(L') >(%6"L$G) number @')L"#$%&'(`#) d'$Y''+)P)-+6);<) @.#),.'M6).#)+%) 6(.7'(`#)M.L'+#') L@-(-L$'(#) M%+0'()#">>%($'6) +"&J'() .+)!*/)('O"'#$#) -+6).#)%+M?) ('$"(+'6),%() >(%,.M'#)$@-$)Y'(') L('-$'6)"+6'()$@') K'L"('K%"(L') >(%6"L$G)) ) EMM)#'+#.$.7') >-?&'+$) .+,%(&-$.%+).+)$@') %"$>"$).#)&-#c'6G) dateOfBirth @')6-$')%,)J.($@) bbbbD//DQQ) @.#),.'M6).#)+%) M.#$'6)%+)$@') M%+0'()#">>%($'6) L"#$%&'(`#) .+)!*/)('O"'#$#) 6(.7'(`#)M.L'+#') -+6).#)%+M?) ('$"(+'6),%() >(%,.M'#)$@-$)Y'(') L('-$'6)"+6'()$@') K'L"('K%"(L') >(%6"L$G)) ) EMM)#'+#.$.7') >-?&'+$) .+,%(&-$.%+).+)$@') %"$>"$).#)&-#c'6G) taxId @')L"#$%&'(`#) =)6.0.$#) @.#),.'M6).#)+%) K%L.-M)K'L"(.$?) M%+0'()#">>%($'6) H"&J'()%()$-Z)*Q) .+)!*/)('O"'#$#) -+6).#)%+M?) ('$"(+'6),%() >(%,.M'#)$@-$)Y'(') L('-$'6)"+6'()$@') K'L"('K%"(L') >(%6"L$G)) ) EMM)#'+#.$.7') >-?&'+$) .+,%(&-$.%+).+)$@') %"$>"$).#)&-#c'6G) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ =9)
    • Section 3 Responses Sample getCustomerPaymentProfileResponse <?xml version="1.0" encoding="utf-8"?> <getCustomerPaymentProfileResponse xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <messages> <resultCode>Ok</resultCode> <message> <code>I00001</code> <text>Successful.</text> </message> </messages> <paymentProfile> <billTo> <firstName>John</firstName> <lastName>Doe</lastName> <company></company> <address>123 Main St.</address> <city>Bellevue</city> <state>WA</state> <zip>98004</zip> <country>USA</country> <phoneNumber>000-000-0000</phoneNumber> <faxNumber></faxNumber> </billTo> <customerPaymentProfileId>20000</customerPaymentProfileId> <payment> <creditCard> <cardNumber>XXXX1111</cardNumber> <expirationDate>XXXX</expirationDate> </creditCard> </payment> </paymentProfile> </getCustomerPaymentProfileResponse> Output for getCustomerShippingAddressResponse The following table lists the additional output returned from the payment gateway for an API call to the getCustomerShippingAddressRequest function. 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ =C)
    • Merchant Web Services API ELEMENT VALUE FORMAT NOTES address !%+$-.+#)#@.>>.+0) ) ) -66('##).+,%(&-$.%+) ,%()$@')L"#$%&'() >(%,.M') customerShippingAddressId U-?&'+$)0-$'Y-?) H"&'(.L) ) -##.0+'6)*Q) -##%L.-$'6)Y.$@)$@') L"#$%&'()#@.>>.+0) -66('##)) firstName @')L"#$%&'(`#),.(#$) ^>)$%)P<)L@-(-L$'(#) ) +-&') 1+%)#?&J%M#2) ) Optional) lastName @')L"#$%&'(`#)M-#$) ^>)$%)P<)L@-(-L$'(#) ) +-&') 1+%)#?&J%M#2) ) Optional) company @')+-&')%,)$@') ^>)$%)P<)L@-(-L$'(#) ) L%&>-+?) 1+%)#?&J%M#2) -##%L.-$'6)Y.$@)$@') L"#$%&'(I).,) ->>M.L-JM') ) Optional) address @')L"#$%&'(`#) ^>)$%)]<)L@-(-L$'(#) ) #@.>>.+0)-66('##) 1+%)#?&J%M#2) ) Optional) city @')L.$?)%,)$@') ^>)$%)W<)L@-(-L$'(#) ) L"#$%&'(`#)#@.>>.+0) 1+%)#?&J%M#2) -66('##) ) Optional) state @')#$-$')%,)$@') E)7-M.6)$Y%D ) L"#$%&'(`#)#@.>>.+0) L@-(-L$'()#$-$')L%6') -66('##) ) Optional) zip @')a*U)L%6')%,)$@') ^>)$%);<)L@-(-L$'(#) ) L"#$%&'(`#)#@.>>.+0) 1+%)#?&J%M#2) -66('##) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ ==)
    • Section 3 Responses ELEMENT VALUE FORMAT NOTES ) Optional) country @')L%"+$(?)%,)$@') ^>)$%)]<)L@-(-L$'(#) ) L"#$%&'(`#)#@.>>.+0) 1+%)#?&J%M#2) -66('##) ) Optional) phoneNumber @')>@%+')+"&J'() ^>)$%);P)6.0.$#)1+%) ) -##%L.-$'6)Y.$@)$@') M'$$'(#2) L"#$%&'(`#)#@.>>.+0) -66('##) ) ) [ZG)1B;T2B;TDB;TW) Optional) faxNumber @'),-Z)+"&J'() ^>)$%);P)6.0.$#)1+%) ) -##%L.-$'6)Y.$@)$@') M'$$'(#2) L"#$%&'(`#)#@.>>.+0) -66('##) ) ) [ZG)1B;T2B;TDB;TW) Optional) Sample getCustomerShippingAddressResponse <?xml version="1.0" encoding="utf-8"?> <getCustomerShippingAddressResponse xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <messages> <resultCode>Ok</resultCode> <message> <code>I00001</code> <text>Successful.</text> </message> </messages> <address> <firstName>John</firstName> <lastName>Doe</lastName> <company></company> <address>123 Main St.</address> <city>Bellevue</city> <state>WA</state> <zip>98004</zip> 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ B<<)
    • Merchant Web Services API <country>USA</country> <phoneNumber>000-000-0000</phoneNumber> <faxNumber></faxNumber> <customerShippingAddressId>30000</customerShippingAddressId> </address> </getCustomerShippingAddressResponse> Output for updateCustomerProfileResponse The following table lists the additional output returned from the payment gateway for an API call to the updateCustomerProfileRequest function. ELEMENT VALUE FORMAT NOTES refId /'(L@-+$D-##.0+'6) ^>)$%);<)L@-(-L$'(#) *,).+LM"6'6).+)$@') (','('+L')*Q),%()$@') ('O"'#$I)$@.#)7-M"')Y.MM) ('O"'#$) J').+LM"6'6).+)$@') ('#>%+#'G)@.#),'-$"(') ) &.0@$)J')'#>'L.-MM?) Optional "#',"M),%()&"M$.D $@('-6'6)->>M.L-$.%+#G) Sample updateCustomerProfileResponse <?xml version="1.0" encoding="utf-8"?> <updateCustomerProfileResponse xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <messages> <resultCode>Ok</resultCode> <message> <code>I00001</code> <text>Successful.</text> </message> </messages> </updateCustomerProfileResponse> Output for updateCustomerPaymentProfileResponse The following table lists the additional output returned from the payment gateway for an API call to the updateCustomerPaymentProfileRequest function. 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ B<B)
    • Section 3 Responses ELEMENT VALUE FORMAT NOTES refId /'(L@-+$D-##.0+'6) ^>)$%);<) *,).+LM"6'6).+)$@')('O"'#$I) (','('+L')*Q),%()$@')('O"'#$) L@-(-L$'(#) $@.#)7-M"')Y.MM)J').+LM"6'6) .+)$@')('#>%+#'G)@.#) ) ,'-$"(')&.0@$)J') Optional '#>'L.-MM?)"#',"M),%() &"M$.D$@('-6'6) ->>M.L-$.%+#G) validationDirectResponse !%+$-.+#)6'$-.M'6) K$(.+0) @.#)%"$>"$).#)%+M?) .+,%(&-$.%+)-J%"$)$@')('#"M$) >('#'+$).,)$@') %,)$@')$(-+#-L$.%+G) ) ValidationMode).+>"$) ) 'M'&'+$).#)>-##'6)Y.$@)-) ) 7-M"')%,)testMode)%() Optional) liveModeG) ) K'')$@')Advanced Integration Guide)-$) @$$>8::YYYG-"$@%(.F'G+'$: #">>%($:E*/k0".6'G>6,) ,%()6'$-.M#)-J%"$) .+,%(&-$.%+).+LM"6'6).+) $@')>-?&'+$)0-$'Y-?) $(-+#-L$.%+)('#>%+#'G) Sample updateCustomerPaymentProfileResponse <?xml version="1.0" encoding="utf-8"?> <updateCustomerPaymentProfileResponse xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <messages> <resultCode>Ok</resultCode> <message> <code>I00001</code> <text>Successful.</text> </message> </messages> </updateCustomerPaymentProfileResponse> Output for updateCustomerShippingAddressResponse The following table lists the additional output returned from the payment gateway for an API call to the updateCustomerShippingAddressRequest function. 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ B<;)
    • Merchant Web Services API ELEMENT VALUE FORMAT NOTES refId /'(L@-+$D ^>)$%);<) *,).+LM"6'6).+)$@') -##.0+'6) L@-(-L$'(#) ('O"'#$I)$@.#)7-M"') (','('+L')*Q),%() Y.MM)J').+LM"6'6).+) $@')('O"'#$) $@')('#>%+#'G)@.#) ,'-$"(')&.0@$)J') ) '#>'L.-MM?)"#',"M),%() Optional &"M$.D$@('-6'6) ->>M.L-$.%+#G) Sample updateCustomerShippingAddressResponse <?xml version="1.0" encoding="utf-8"?> <updateCustomerShippingAddressResponse xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <messages> <resultCode>Ok</resultCode> <message> <code>I00001</code> <text>Successful.</text> </message> </messages> </updateCustomerShippingAddressResponse> Output for validateCustomerPaymentProfileResponse The following table represents the additional output returned from the payment gateway for an API call to the validateCustomerPaymentProfileRequest function. ELEMENT VALUE FORMAT NOTES directResponse !%+$-.+#)6'$-.M'6).+,%(&-$.%+) K$(.+0) K'')$@')Advanced -J%"$)$@')('#"M$)%,)$@') Integration Guide)-$) $(-+#-L$.%+G) ) @$$>8::YYYG-"$@%(.F'G+'$:# ) ">>%($:E*/k0".6'G>6,),%() 6'$-.M#)-J%"$).+,%(&-$.%+) .+LM"6'6).+)$@')>-?&'+$) 0-$'Y-?)$(-+#-L$.%+) ('#>%+#'G) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ B<T)
    • Section 3 Responses Sample validateCustomerPaymentProfileResponse <?xml version="1.0" encoding="utf-8"?> <validateCustomerPaymentProfileResponse xmlns="AnetApi/xml/v1/schema/AnetApiSchema.xsd"> <messages> <resultCode>Ok</resultCode> <message> <code>I00001</code> <text>Successful.</text> </message> </messages> <directResponse>1,1,1,This transaction has been approved.,000000,Y,2000000003,none,Test transaction for ValidateCustomerPaymentProfile.,0.01,CC,auth_only,custId123, John,Doe,,123 Main St.,Bellevue,WA,98004,USA,000-000- 0000,,mark@example.com,John,Doe,,123 Main St.,Bellevue,WA,98004,USA,0.00,0.00,0.00,,none, D18EB6B211FE0BBF556B271FDA6F92EE,,,,,,,,,,,,,,,,,,,,,,,,,,,,,, </directResponse> </validateCustomerPaymentProfileResponse> Q">M.L-$')U(%,.M')V'(.,.L-$.%+) When submitting calls to the createCustomerProfileRequest, createCustomerPaymentProfileRequest, and createCustomerShippingAddressRequest functions, the payment gateway will check certain fields in each request to determine that a profile with that same information does not already exist. If a profile already exists that contains the values being submitted in the new request, then the payment gateway will return an error that contains the ID of the already-created profile. The duplicate profile verification serves as a safeguard against accidental duplicate submissions. The following table lists the fields for each function that cannot match any other profile already created. An error will only occur if ALL the values for each field being submitted match ALL the values for each field in the already existing profile. FUNCTION FIELDS USED FOR DUPLICATE PROFILE VERIFICATION L('-$'!"#$%&'(U(%,.M'N'O"'#$) &'(L@-+$!"#$%&'(*6I)6'#L(.>$.%+I)'&-.M) L('-$'!"#$%&'(U-?&'+$U(%,.M'N'O"'#$) L"#$%&'(U(%,.M'*6I)L-(6H"&J'(I)-LL%"+$H"&J'(I) (%"$.+0H"&J'(I)J.MM%S.(#$H-&'I)J.MM%4-#$H-&'I) J.MM%E66('##I)-+6)J.MM%a.>) L('-$'!"#$%&'(K@.>>.+0E66('##N'O"'#$) L"#$%&'(U(%,.M'*6I),.(#$H-&'I)M-#$H-&'I)-66('##I)F.>)-+6) >@%+'H"&J'() 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ B<W)
    • Merchant Web Services API N'#>%+#')!%6'#) The following table lists the common response codes and texts for requests to the Customer Information Manager API. CODE TEXT DESCRIPTION *<<<<B) K"LL'##,"M) @')('O"'#$)Y-#)>(%L'##'6)#"LL'##,"MM?G) *<<<<T) @')('L%(6)@-#)-M('-6?)J''+)6'M'$'6G) @')('L%(6)@-#)-M('-6?)J''+)6'M'$'6G) [<<<<B) E+)'((%()%LL"(('6)6"(.+0)>(%L'##.+0G)UM'-#')$(?) E+)"+'Z>'L$'6)#?#$'&)'((%()%LL"(('6)Y@.M') -0-.+G) >(%L'##.+0)$@.#)('O"'#$G) [<<<<;) @')L%+$'+$D$?>')#>'L.,.'6).#)+%$)#">>%($'6G) @')%+M?)#">>%($'6)L%+$'+$D$?>'#)-(')$'Z$:Z&M) -+6)->>M.L-$.%+:Z&MG) [<<<<T) E+)'((%()%LL"(('6)Y@.M')>-(#.+0)$@')3/4) @.#).#)$@')('#"M$)%,)-+)3/4)>-(#'()'((%(G) ('O"'#$G) [<<<<W) @')+-&')%,)$@')('O"'#$'6)EU*)&'$@%6).#) @')+-&')%,)$@')(%%$)+%6')%,)$@')3/4)('O"'#$) .+7-M.6G) .#)$@')EU*)&'$@%6)J'.+0)L-MM'6G)*$).#)+%$)7-M.6G) [<<<<P) @')&'(L@-+$E"$@'+$.L-$.%+G$(-+#-L$.%+_'?).#) /'(L@-+$)-"$@'+$.L-$.%+)('O".('#)-)7-M.6)7-M"') .+7-M.6)%()+%$)>('#'+$G) ,%()$(-+#-L$.%+)c'?G) [<<<<]) @')&'(L@-+$E"$@'+$.L-$.%+G+-&').#).+7-M.6)%() /'(L@-+$)-"$@'+$.L-$.%+)('O".('#)-)7-M.6)7-M"') +%$)>('#'+$G) ,%()+-&'G) [<<<<9) ^#'()-"$@'+$.L-$.%+),-.M'6)6"')$%).+7-M.6) @')+-&':-+6)%()$(-+#-L$.%+)c'?).#).+7-M.6G) -"$@'+$.L-$.%+)7-M"'#G) [<<<<C) ^#'()-"$@'+$.L-$.%+),-.M'6G)@')>-?&'+$) @')>-?&'+$)0-$'Y-?)%()"#'()-LL%"+$).#)+%$) 0-$'Y-?)-LL%"+$)%()"#'().#).+-L$.7'G) L"(('+$M?)-L$.7'G) [<<<<=) @')>-?&'+$)0-$'Y-?)-LL%"+$).#).+)'#$)/%6'G) @')('O"'#$'6)EU*)&'$@%6)L-++%$)J')'Z'L"$'6) @')('O"'#$)L-++%$)J')>(%L'##'6G) Y@.M')$@')>-?&'+$)0-$'Y-?)-LL%"+$).#).+)'#$) /%6'G) [<<<B<) ^#'()-"$@'+$.L-$.%+),-.M'6G)b%")6%)+%$)@-7')$@') @')"#'()6%'#)+%$)@-7')>'(&.##.%+)$%)L-MM)$@') ->>(%>(.-$')>'(&.##.%+#G) EU*G) [<<<BB) ELL'##)6'+.'6G)b%")6%)+%$)@-7')$@') @')"#'()6%'#)+%$)@-7')>'(&.##.%+)$%)L-MM)$@') ->>(%>(.-$')>'(&.##.%+#G) EU*)&'$@%6G) [<<<BT) @'),.'M6).#).+7-M.6G) e+')%,)$@'),.'M6)7-M"'#).#)+%$)7-M.6G) [<<<BW) E)('O".('6),.'M6).#)+%$)>('#'+$G) e+')%,)$@')('O".('6),.'M6#)Y-#)+%$)>('#'+$G) [<<<BP) @'),.'M6)M'+0$@).#).+7-M.6G) e+')%,)$@'),.'M6#)@-#)-+).+7-M.6)M'+0$@G) [<<<B]) @'),.'M6)$?>').#).+7-M.6G) @'),.'M6)$?>').#)+%$)7-M.6G) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ B<P)
    • Section 3 Responses CODE TEXT DESCRIPTION [<<<B=) @')L"#$%&'()$-Z*6)%()6(.7'(#4.L'+#') @')L"#$%&'()$-Z)*Q)%()6(.7'(`#)M.L'+#') .+,%(&-$.%+).#)('O".('6G) .+,%(&-$.%+)16(.7'(`#)M.L'+#')+"&J'(I)6(.7'(`#) M.L'+#')#$-$'I)6(.7'(`#)M.L'+#')Qed2).#)('O".('6) ,%()$@')#"J#L(.>$.%+G) [<<<;9) @')$(-+#-L$.%+)Y-#)"+#"LL'##,"MG) E+)->>(%7-M)Y-#)+%$)('$"(+'6),%()$@') $(-+#-L$.%+G) [<<<;= U-?&'+$).+,%(&-$.%+).#)('O".('6G) U-?&'+$).+,%(&-$.%+).#)('O".('6)Y@'+)L('-$.+0) -)#"J#L(.>$.%+)%()>-?&'+$)>(%,.M'G) [<<<T= E)6">M.L-$')('L%(6)-M('-6?)'Z.#$#G) E)6">M.L-$')%,)$@')L"#$%&'()>(%,.M'I)L"#$%&'() >-?&'+$)>(%,.M'I)%()L"#$%&'()-66('##)Y-#) -M('-6?)#"J&.$$'6G) [<<<W<) @')('L%(6)L-++%$)J'),%"+6G) @')>(%,.M'*QI)>-?&'+$U(%,.M'*6I)%() #@.>>.+0E66('##*6),%()$@.#)('O"'#$).#)+%$)7-M.6) ,%()$@.#)&'(L@-+$G)) [<<<WB) e+')%()&%('),.'M6#)&"#$)L%+$-.+)-)7-M"'G) EMM)%,)$@'),.'M6#)Y'(')'&>$?)%()&.##.+0G) [<<<W; @')&-Z.&"&)+"&J'()%,)>-?&'+$)>(%,.M'#) @')&-Z.&"&)+"&J'()%,)>-?&'+$)>(%,.M'#),%() -MM%Y'6),%()$@')L"#$%&'()>(%,.M').#)l<mG) $@')L"#$%&'()>(%,.M')@-#)J''+)('-L@'6G) [<<<WT @')&-Z.&"&)+"&J'()%,)#@.>>.+0)-66('##'#) @')&-Z.&"&)+"&J'()%,)#@.>>.+0)-66('##'#) -MM%Y'6),%()$@')L"#$%&'()>(%,.M').#)l<mG) ,%()$@')L"#$%&'()>(%,.M')@-#)J''+)('-L@'6G) [<<<WW !"#$%&'()*+,%(&-$.%+)/-+-0'().#)+%$)'+-JM'6G) @')>-?&'+$)0-$'Y-?)-LL%"+$).#)+%$)'+-JM'6) ,%()!"#$%&'()*+,%(&-$.%+)/-+-0'()1!*/2G) [<<<WP) @')(%%$)+%6')6%'#)+%$)(','('+L')-)7-M.6)3/4) E+)'((%()'Z.#$#).+)$@')3/4)+-&'#>-L'G)@.#) +-&'#>-L'G)) '((%().#)#.&.M-()$%)E00003. ) 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ B<])
    • Merchant Web Services API Index API calls........................................................ 7 developer support ......................................... 5 responses ................................................. 78 duplicate profile verification .................... 104 Authentication............................................... 9 error messages .......................................... 105 CIM Functions .............................................. 8 getCustomerPaymentProfileRequest .......... 63 CIM Responses ........................................... 78 getCustomerPaymentProfileResponse........ 94 createCustomerPaymentProfileRequest ...... 17 getCustomerProfileIdsRequest ................... 62 createCustomerPaymentProfileResponse ... 81 getCustomerProfileIdsResponse ................. 87 createCustomerProfileRequest .................... 10 getCustomerProfileRequest ........................ 63 createCustomerProfileResponse ................. 79 getCustomerProfileResponse...................... 87 createCustomerProfileTransactionRequest . 24 getCustomerShippingAddressRequest ....... 64 Authorization and Capture ...................... 30 getCustomerShippingAddressResponse ..... 98 Authorization Only ................................. 24 Minimum Requirements ............................... 5 Capture Only ........................................... 37 profile Refund..................................................... 49 duplicate ............................................... 104 Void transaction ...................................... 57 response codes .......................................... 105 createCustomerProfileTransactionRequest sample code .................................................. 7 function support .......................................................... 5 Prior Authorization and Capture ............. 44 updateCustomerPaymentProfileRequest .... 67 createCustomerProfileTransactionResponse updateCustomerPaymentProfileResponse 101 ................................................................ 83 updateCustomerProfileRequest .................. 65 createCustomerShippingAddressRequest ... 21 updateCustomerProfileResponse .............. 101 createCustomerShippingAddressResponse. 83 updateCustomerShippingAddressRequest.. 73 deleteCustomerPaymentProfileRequest ...... 60 updateCustomerShippingAddressResponse deleteCustomerPaymentProfileResponse ... 85 .............................................................. 102 deleteCustomerProfileRequest .................... 59 validateCustomerPaymentProfileRequest .. 76 deleteCustomerProfileResponse ................. 85 validateCustomerPaymentProfileResponse deleteCustomerShippingAddressRequest ... 61 .............................................................. 103 deleteCustomerShippingAddressResponse. 86 4-#$)('7.#'68)9:;;:;<<=) !%>?(.0@$)A)B==C)D);<<=)E"$@%(.F'GH'$I)-)!?J'(K%"(L')#%M"$.%+ B<9)