2009
Table Of Contents
- Name-Value Pair API Developer Guide
- Preface
- This Document
- Intended Audience
- Revision History
- PayPal NVP API Overview
- Authorization and Capture API Operation Reference
- DoDirectPayment API
- Express Checkout API Operations
- GetTransactionDetails API
- MassPay API
- RefundTransaction API
- TransactionSearch API
- Recurring Payments and Reference Transactions API Operations
- DoNonReferencedCredit API
- ManagePendingTransactionStatu s API
- GetBalance API
- AddressVerify API
- API Error Codes
- General API Errors
- Validation Errors
- Direct Payment API Errors
- SetExpressCheckout API Errors
- GetExpressCheckoutDetails API Errors
- DoExpressCheckoutPayment API Errors
- Authorization and Capture API Errors
- GetTransactionDetails API Errors
- TransactionSearch API Errors
- RefundTransaction API Errors
- Mass Pay API Errors
- Recurring Payments Errors
- SetCustomerBillingAgreement Errors
- GetBillingAgreementCustomerDetails Errors
- CreateBillingAgreement Errors
- UpdateBillingAgreement Errors
- DoReferenceTransaction Errors
- AddressVerify API Errors
- ManagePendingTransactionStatus API Errors
- Country Codes
- State and Province Codes
- Currency Codes
- AVS and CVV2 Response Codes
Name-Value Pair API Developer Guide 08 April 2009 5
Contents
Chapter 8 TransactionSearch API . . . . . . . . . . . . . . . . . . .91
TransactionSearch Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
TransactionSearch Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Chapter 9 Recurring Payments and Reference Transactions API
Operations95
CreateRecurringPaymentsProfile API . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
CreateRecurringPaymentsProfile Request . . . . . . . . . . . . . . . . . . . . . . . 95
CreateRecurringPaymentsProfile Response . . . . . . . . . . . . . . . . . . . . . .105
GetRecurringPaymentsProfileDetails API . . . . . . . . . . . . . . . . . . . . . . . . . .106
GetRecurringPaymentsProfileDetails Request . . . . . . . . . . . . . . . . . . . . .106
GetRecurringPaymentsProfileDetails Response . . . . . . . . . . . . . . . . . . . .106
ManageRecurringPaymentsProfileStatus API . . . . . . . . . . . . . . . . . . . . . . . .113
ManageRecurringPaymentsProfileStatus Request . . . . . . . . . . . . . . . . . . . 114
ManageRecurringPaymentsProfileStatus Response . . . . . . . . . . . . . . . . . . 114
BillOutstandingAmount API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114
BillOutstandingAmount Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
BillOutstandingAmount Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
UpdateRecurringPaymentsProfile API . . . . . . . . . . . . . . . . . . . . . . . . . . . .115
UpdateRecurringPaymentsProfile Request . . . . . . . . . . . . . . . . . . . . . . . 116
UpdateRecurringPaymentsProfile Response . . . . . . . . . . . . . . . . . . . . . .123
SetCustomerBillingAgreement API . . . . . . . . . . . . . . . . . . . . . . . . . . . . .123
SetCustomerBillingAgreement Request . . . . . . . . . . . . . . . . . . . . . . . . .124
SetCustomerBillingAgreement Response . . . . . . . . . . . . . . . . . . . . . . . .127
GetBillingAgreementCustomerDetails API . . . . . . . . . . . . . . . . . . . . . . . . . .127
GetBillingAgreementCustomerDetails Request . . . . . . . . . . . . . . . . . . . . .128
GetBillingAgreementCustomerDetails Response . . . . . . . . . . . . . . . . . . . .128
BAUpdate API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .130
BAUpdate Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .131
BAUpdateResponseDetails Response . . . . . . . . . . . . . . . . . . . . . . . . .131
DoReferenceTransaction API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .133
DoReferenceTransaction Request. . . . . . . . . . . . . . . . . . . . . . . . . . . .134
DoReferenceTransaction Response . . . . . . . . . . . . . . . . . . . . . . . . . . .143
Chapter 10 DoNonReferencedCredit API . . . . . . . . . . . . . . . 147
DoNonReferencedCredit Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147
DoNonReferencedCredit Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . .150