Developer's Guide
Table Of Contents
- Adaptive Payments Developer Guide
- Contents
- What’s New?
- Introducing Adaptive Payments
- Adaptive Payments Actors and Objects
- Simple, Parallel, and Chained Payments
- Payment Approval
- Adaptive Payments Service Permissions
- Explicit Approval Payment Flow
- Preapproved Payments Flow
- Implicit Approval Payments Flow
- Embedded Payments
- Embedded Payment Flow Presentations
- Kinds of Embedded Payments
- Embedded Payments Implementation Basics
- Embedded Payment Experience
- Preapprove Future Payments Checkbox
- Shipping Address Information
- Embedded Payment Experience
- Setting Up Web Pages to Invoke the Embedded Payment Flow Using a Lightbox
- Setting Up Web Pages to Invoke the Embedded Payment Flow Using a Minibrowser
- Displaying and Collecting Shipping Addresses
- Guest Payments
- Fee Payment Configuration
- Getting Started
- Pay API Operation
- PaymentDetails API Operation
- ExecutePayment API Operation
- GetPaymentOptions API Operation
- SetPaymentOptions API Operation
- Preapproval API Operation
- PreapprovalDetails API Operation
- CancelPreapproval API Operation
- ConvertCurrency API Operation
- Refund API Operation
- GetFundingPlans API Operation
- GetShippingAddresses API Operation
- Adaptive Payment Commands and Redirects
- Instant Payment Notifications
- Older Versions of the Adaptive Payments API
- 1.8.0 Features
- 1.7.0 Features
- 1.6.0 Features
- New API Operations for Version 1.6.0
- Changes to PayRequest Fields for Version 1.6.0
- Changes to PayResponse Fields for Version 1.6.0
- Changes to ExecutePaymentRequest Fields for Version 1.6.0
- Changes to GetPaymentOptionsResponse Fields for Version 1.6.0
- Changes to SetPaymentOptionsRequest Fields for Version 1.6.0
- Changes to PreapprovalRequest Fields for Version 1.6.0
- Changes to Address Structure for Version 1.6.0
- Changes to DisplayOptions Structure for Version 1.6.0
- New CurrencyConversion Structure for Version 1.6.0
- New InvoiceData Structure for Version 1.6.0
- New InvoiceItem Structure for Version 1.6.0
- New SenderOptions Structure for Version 1.6.0
- New SenderIdentifier Structure for Version 1.6.0
- New AccountIdentifier Structure for Version 1.6.0
- New ReceiverOptions Structure for Version 1.6.0
- New ReceiverIdentifier Structure for Version 1.6.0
- Additional Error Messages for Version 1.6.0
- 1.5.0 Features
- 1.4.0 Features
- 1.3.0 Features
- 1.2.0 Features
- 1.1.0 Features
- Revision History
- Index
Instant Payment Notifications
Pay Message Variables
258 August 7, 2012 Adaptive Payments Developer Guide
status The status of the payment. Possible values are:
CREATED – The payment request was received; funds will be transferred
once the payment is approved
COMPLETED – The payment was successful
INCOMPLETE – Some transfers succeeded and some failed for a parallel
payment or, for a delayed chained payment, secondary receivers have not
been paid
ERROR – The payment failed and all attempted transfers failed or all
completed transfers were successfully reversed
REVERSALERROR – One or more transfers failed when attempting to
reverse a payment
PROCESSING – The payment is in progress
PENDING – The payment is awaiting processing
sender_email Sender’s email address.
action_type Whether the Pay API is used with or without the SetPaymentOptions and
ExecutePayment API operations. Possible values are:
PAY – If you are not using the SetPaymentOptions and
ExecutePayment API operations
CREATE – If you are using the SetPaymentOptions and
ExecutePayment API operations
payment_request_date The date on which the payment request was initiated.
reverse_all_parallel_pay
ments_on_error
Whether the payment request specified to reverse parallel payments if an error
occurs. Possible values are:
true – Each parallel payment is reversed if an error occurs
false – Only incomplete payments are reversed (default)
transaction[n].id The transaction ID, where [n] is a number from 0 to 5. For simple, single
receiver payments, this number will be 0. Numbers larger than 0 indicate the
payment to a particular receiver in chained and parallel payments.
transaction[n].status The transaction status, where [n] is a number from 0 to 5. For simple single-
receiver payments, this number will be 0. Numbers larger than 0 indicate the
payment to a particular receiver in chained and parallel payments.
Possible values are:
Completed
Pending
Refunded
transaction[n].id_for_se
nder
The transaction ID for the sender, where [n] is a number from 0 to 5. For
simple, single receiver payments, this number will be 0. Numbers larger than 0
indicate the payment to a particular receiver in chained and parallel payments.
Variable Description