| METHOD: |
|
|
|
| VERSION: |
|
|
|
Main Request Fields: |
| BillingAgreementID: |
(Required!) |
|
|
|
|
| AGREEMENTID: |
(Required!) |
|
|
|
|
| REFERENCEID: |
(Required!) |
|
|
|
A transaction ID from a previous purchase, such as a credit card charge using the DoDirectPayment API, or a billing agreement ID.
|
| PAYMENTACTION: |
(Required!) |
|
|
|
How you want to obtain payment:
- Authorization indicates that this payment is a basic authorization subject to settlement with PayPal Authorization & Capture.
- Sale indicates that this is a final sale for which you are requesting payment.
|
| RETURNFMFDETAILS: |
|
|
|
|
Flag to indicate whether you want the results returned by Fraud Management Filters. By default, you do not receive this information.
- 0 - do not receive FMF details (default)
- 1 - receive FMF details
|
| SOFTDESCRIPTOR: |
|
|
|
|
The soft descriptor is a per transaction description of the payment that is passed to the consumer's credit card statement.
If a value for the soft descriptor field is provided, the full descriptor displayed on the customer's statement has the following format:
<PP * or PAYPAL *><Merchant descriptor as set in the Payment Receiving Preferences><1 space><soft descriptor>
The soft descriptor can contain only the following characters:
- Alphanumeric characters
- - (dash)
- * (asterisk)
- . (period)
- {space}
If you use any other characters (such as “,”), an error code is returned.
The soft descriptor does not include the phone number, which can be toggled between the merchant' customer service number and PayPal's customer service number.
The maximum length of the total soft descriptor is 22 characters. Of this, either 4 or 8 characters are used by the PayPal prefix shown in the data format. Thus, the maximum length of the soft descriptor passed in the API request is:
22 - len(<PP * or PAYPAL *>) - len(<Descriptor set in Payment Receiving Preferences> + 1)
For example, assume the following conditions:
- The PayPal prefix toggle is set to PAYPAL * in PayPal's admin tools.
- The merchant descriptor set in the Payment Receiving Preferences is set to EBAY.
- The soft descriptor is passed in as JanesFlowerGifts LLC.
The resulting descriptor string on the credit card would be:
PAYPAL *EBAY JanesFlow
|
Ship To Address Fields |
| SHIPTONAME: |
|
|
|
|
Person' name associated with this address. This field is required for shipping addresses but is optional for credit card billing addresses.
Character length and limitations: 32 single-byte characters.
|
| SHIPTOSTREET: |
|
|
|
|
First street address. This field is required if the shipping address is used.
Character length and limitations: 100 single-byte characters.
|
| SHIPTOSTREET2: |
|
|
|
|
Second street address.
Character length and limitations: 100 single-byte characters.
|
| SHIPTOCITY: |
|
|
|
|
Name of city. This field is required if the shipping address is used.
Character length and limitations: 40 single-byte characters.
|
| SHIPTOSTATE: |
|
|
|
|
State or province. This field is required if the shipping address is used.
Character length and limitations: 40 single-byte characters.
|
| SHIPTOZIP: |
|
|
|
|
U.S. ZIP code or other country-specific postal code. This field is required if a U.S. shipping address is used and may be required for other countries.
Character length and limitations: 20 single-byte characters.
|
| SHIPTOCOUNTRYCODE: |
|
|
|
|
Country code. This field is required if the shipping address is used.
Character limit: 2 single-byte characters.
|
| SHIPTOPHONENUM: |
|
|
|
|
Phone number.
Character length and limit: 20 single-byte characters.
|
Payment Details Type Fields |
| AMT: |
(Required!) |
|
|
|
The total cost of the transaction to the customer. If shipping cost and tax charges are known, include them in this value; if not, this value should be the current sub-total of the order.
If the transaction includes one or more one-time purchases, this field must be equal to the sum of the purchases.
Set this field to 0 if the transaction does not include a one-time purchase; for example, when you set up a billing agreement for a recurring payment that is not immediately charged.
Limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Must have two decimal places, decimal separator must be a period (.), and the optional thousands separator must be a comma (,).
|
| CURRENCYCODE: |
|
|
|
|
A three-character currency code. Default: USD.
|
| ITEMAMT: |
|
|
|
|
Sum of cost of all items in this order.
Limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Must have two decimal places, decimal separator must be a period (.), and the optional thousands separator must be a comma (,).
Note:
ITEMAMT is required if you specify L_AMTn .
|
| SHIPPINGAMT: |
|
|
|
|
Total shipping costs for this order.
Note:
Character length and limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Equivalent to nine characters maximum for USD.
Note:If you specify a value for SHIPPINGAMT, you must also specify a value for ITEMAMT.
|
| INSURANCEAMT: |
|
|
|
|
Total shipping insurance costs for this order.
Note:
Character length and limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Equivalent to nine characters maximum for USD.
|
| SHIPPINGDISCOUNT: |
|
|
|
|
Shipping discount for this order, specified as a negative number.
Note:
Character length and limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Equivalent to nine characters maximum for USD.
|
| HANDLINGAMT: |
|
|
|
|
Total handling costs for this order.
Note:
Character length and limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Equivalent to nine characters maximum for USD.
Note:
If you specify a value for HANDLINGAMT, you must also specify a value for ITEMAMT.
|
| TAXAMT: |
|
|
|
|
Sum of tax for all items in this order.
Note:
Character length and limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Equivalent to nine characters maximum for USD.
Note:
TAXAMT is required if you specify L_TAXAMTn
|
| DESC: |
|
|
|
|
Description of items the customer is purchasing.
Character length and limitations: 127 single-byte alphanumeric characters
|
| CUSTOM: |
|
|
|
|
A free-form field for your own use.
Character length and limitations: 256 single-byte alphanumeric characters
|
| INVNUM: |
|
|
|
|
Your own invoice or tracking number.
Character length and limitations: 127 single-byte alphanumeric characters
|
| BUTTONSOURCE: |
|
|
|
|
|
| NOTIFYURL: |
|
|
|
|
Your URL for receiving Instant Payment Notification (IPN) about this transaction.
Note:
If you do not specify this value in the request, the notification URL from your Merchant Profile is used, if one exists.
Character length and limitations: 2,048 single-byte alphanumeric characters
|
Payment Details Item Type Fields |
| L_NAME0: |
|
|
|
|
Item name.
These parameters must be ordered sequentially beginning with 0 (for example L_NAME0, L_NAME1).
Character length and limitations: 127 single-byte characters
|
| L_DESC0: |
|
|
|
|
Item description.
Character length and limitations: 127 single-byte characters
|
| L_AMT0: |
|
|
|
|
Cost of item.
These parameters must be ordered sequentially beginning with 0 (for example L_AMT0, L_AMT1).
Note:
Character length and limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Equivalent to nine characters maximum for USD.
Note:
If you specify a value for L_AMTn , you must specify a value for ITEMAMT.
|
| L_NUMBER0: |
|
|
|
|
Item number.
These parameters must be ordered sequentially beginning with 0 (for example L_NUMBER0, L_NUMBER1).
Character length and limitations: 127 single-byte characters
|
| L_QTYn: |
|
|
|
|
Item quantity.
These parameters must be ordered sequentially beginning with 0 (for example L_QTY0, L_QTY1).
Character length and limitations: Any positive integer
|
| L_TAXAMT0: |
|
|
|
|
Item sales tax.
Note:
Character length and limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Equivalent to nine characters maximum for USD.
These parameters must be ordered sequentially beginning with 0 (for example L_TAXAMT0, L_TAXAMT1).
|
EbayItemPaymentDetailsItemType Fields |
| L_EBAYITEMNUMBER0: |
|
|
|
|
Auction item number.
These parameters must be ordered sequentially beginning with 0 (for example L_EBAYITEMNUMBER0, L_EBAYITEMNUMBER1).
Character length: 765 single-byte characters.
|
| L_EBAYITEMAUCTIONTXNID0: |
|
|
|
|
Auction transaction identification number.
These parameters must be ordered sequentially beginning with 0 (for example L_EBAYITEMAUCTIONTXNID0, L_EBAYITEMAUCTIONTXNID1).
Character length: 255 single-byte characters
|
| L_EBAYITEMORDERID0: |
|
|
|
|
Auction order identification number.
These parameters must be ordered sequentially beginning with 0 (for example L_EBAYITEMORDERID0, L_EBAYITEMORDERID1).
Character length: 64 single-byte characters.
|
Credit Card Details Fields |
| CREDITCARDTYPE: |
|
|
|
|
Type of credit card.
Character length and limitations: Up to ten single-byte alphabetic characters.
Allowable values:
- Visa
- MasterCard
- Discover
- Amex
- Maestro: See note.
- Solo: See note.
For Canada, only MasterCard and Visa are allowable; Interac debit cards are not supported.
Note:
If the credit card type is Maestro or Solo, the CURRENCYCODE must be GBP. In addition, either STARTDATE or ISSUENUMBER must be specified.
|
| ACCT: |
|
|
|
|
Credit card number. Character length and limitations: numeric characters only. No spaces or punctutation. Must conform with modulo and length required by each credit card type.
|
| EXPDATE: |
|
|
|
|
Credit card expiration date.This field is required if you are using recurring payments with direct payments.
Format: MMYYYY
Character length and limitations: Six single-byte alphanumeric characters, including leading zero.
|
| CVV2: |
|
|
|
|
Card Verification Value, version 2. Your Merchant Account settings determine whether this field is required. Character length for Visa, MasterCard, and Discover: exactly three digits.Character length for American Express: exactly four digits.To comply with credit card processing regulations, you must not store this value after a transaction has been completed.
|
| STARTDATE: |
|
|
|
|
Month and year that Maestro or Solo card was issued, the MMYYYY format.
Character length: Must be six digits, including leading zero.
|
| ISSUENUMBER: |
|
|
|
|
Issue number of Maestro or Solo card.Character length: two numeric digits maximum.
|
Payer Info Type Fields |
| EMAIL: |
|
|
|
|
Email address of payer.
Character length and limitations: 127 single-byte characters.
|
| FIRSTNAME: |
(Required!) |
|
|
|
Payer's first name.Character length and limitations: 25 single-byte characters.
|
| LASTNAME: |
(Required!) |
|
|
|
|
Address Fields |
| STREET: |
(Required!) |
|
|
|
|
| STREET2: |
|
|
|
|
Second street address.
Character length and limitations: 100 single-byte characters.
|
| CITY: |
(Required!) |
|
|
|
Name of city.
Character length and limitations: 40 single-byte characters.
|
| STATE: |
(Required!) |
|
|
|
State or province.
Character length and limitations: 40 single-byte characters.
|
| COUNTRYCODE: |
(Required!) |
|
|
|
Country code.
Character limit: Two single-byte characters.
|
| ZIP: |
(Required!) |
|
|
|
U.S. ZIP code or other country-specific postal code.
Character length and limitations: 20 single-byte characters.
|
| PHONENUM: |
|
|
|
|
Phone number.
Character length and limit: 20 single-byte characters.
|
|
wait........ |
|
|
|