2013

SOAP API Developer Reference February 01, 2013 7
Contents
CreateBillingAgreement API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . .236
CreateBillingAgreement Request Message . . . . . . . . . . . . . . . . . . . . . . .236
CreateBillingAgreement API Response Message . . . . . . . . . . . . . . . . . . . .237
GetBillingAgreementCustomerDetails API Operation . . . . . . . . . . . . . . . . . . . .238
GetBillingAgreementCustomerDetails Request Message . . . . . . . . . . . . . . . .238
GetBillingAgreementCustomerDetails Response Message . . . . . . . . . . . . . . .239
BAUpdate API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .243
BAUpdate Request Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .243
BAUpdate Response Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . .244
DoReferenceTransaction API Operation. . . . . . . . . . . . . . . . . . . . . . . . . . .249
DoReferenceTransaction Request Message . . . . . . . . . . . . . . . . . . . . . .249
DoReferenceTransaction Response Message . . . . . . . . . . . . . . . . . . . . .263
Chapter 13 RefundTransaction API Operation. . . . . . . . . . . . . 273
RefundTransaction Request Message . . . . . . . . . . . . . . . . . . . . . . . . . . . .273
RefundTransaction Request Fields . . . . . . . . . . . . . . . . . . . . . . . . . . .274
MerchantStoreDetailsTypeFields . . . . . . . . . . . . . . . . . . . . . . . . . . . .276
RefundTransaction Response Message . . . . . . . . . . . . . . . . . . . . . . . . . . .277
RefundTransaction Response Fields . . . . . . . . . . . . . . . . . . . . . . . . . .277
RefundInfoType Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .279
Chapter 14 TransactionSearch API Operation . . . . . . . . . . . . . 281
TransactionSearch Request Message . . . . . . . . . . . . . . . . . . . . . . . . . . . .281
TransactionSearch Request Fields . . . . . . . . . . . . . . . . . . . . . . . . . . .282
PayerName Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .284
TransactionSearch Response Message . . . . . . . . . . . . . . . . . . . . . . . . . . .285
TransactionSearch Response Fields . . . . . . . . . . . . . . . . . . . . . . . . . .285
Appendix A API Error Codes . . . . . . . . . . . . . . . . . . . . . . 287
General API Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .287
Validation Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .288
DirectPayment API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .291
SetExpressCheckout API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .303
GetExpressCheckoutDetails API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . .317
DoExpressCheckoutPayment API Errors . . . . . . . . . . . . . . . . . . . . . . . . . .318
Authorization and Capture API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . .328
GetTransactionDetails API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .332