method
to paypal
and the redirect_url
to the endpoint of your application that can handle the customer returning once they’ve completed approving the transaction on paypal.com
.
See the POST /transactions
API endpoint for more details.
status
set to buyer_approval_pending
as well as a payment_method.approval_url
.
store=true
parameter to each request to vault a buyer’s PayPal account for future use.
This does require you to tick the Payment tokenization toggle for your PayPal connection in your dashboard.
payment_method.approval_url
. After they’ve authenticated themselves, the customer will be redirected back to the redirect_url
that you set when creating the transaction.
redirect_url
will be appended with the transaction_id
.
transaction_status
in this callback, it’s
recommended to also fetch the latest status via the API, as the status may
have changed since.connection_options[paypal-paypal]
). Below are examples for a retail or a marketplace transaction where retail transactions are those sold directly by the merchant on record, while a marketplace transaction is sold by a third party on the merchant’s website.
PayPal uses sender
and receiver
to refer to the transfer of funds where the sender
is the buyer who is transmitting funds to the reciever
or merchant.
Data Field Name | Description | Use case | Sample values |
---|---|---|---|
sender_account_id | Unique buyer ID | Both | buyer_id or buyer’s external_identifier |
sender_first_name | Buyer’s first name | Both | first_name |
sender_last_name | Buyer’s last name | Both | last_name |
sender_email | Buyer’s email address | Both | email_address |
sender_phone | Buyer’s phone number | Both | phone_number |
sender_country_code | Buyer’s country code in ISO Alpha-2 Country code | Both | AU or NZ |
sender_create_date | Creation date of the buyer’s account in ISO 8601 date format | Both | created_at |
sender_signup_ip | IP address that the buyer used to sign up to the platform | Marketplace | 10.220.90.20 |
sender_popularity_score | Risk-based scoring on the buyer, best efforts assessment by the marketplace | Marketplace | high, medium or low |
receiver_account_id | Unique seller ID | Marketplace | A12345N343 |
receiver_create_date | Date of seller creation on marketplace platform in ISO 8601 date format | Marketplace | 2024-06-09T 19:14:55.277-0:00 |
receiver_email | Seller’s registered email on the marketplace platform | Marketplace | seller@marketplace.com |
receiver_address_country_code | Sellers’s country code in ISO Alpha-2 Country code | Marketplace | US |
business_name | Seller’s business name on the marketplace | Marketplace | Seller Pty Ltd |
recipient_popularity_score | Risk-based scoring on the seller, best efforts assessment by the marketplace | Marketplace | high, medium or low |
first_interaction_date | Date of the first integration between the buyer and seller on the marketplace | Marketplace | 2024-06-09T 19:14:55.277-0:00 |
txn_count_total | Total number of transactions between the buyer and seller to date, across all methods | Marketplace | 3 |
delivery_information | Delivery method for an intangible item if there is an associated email/phone. It acts as the shipping address for an intangible, only required for intangible goods (e.g. gift cards) | Retail | phone_number or email_address |
highrisk_txn_flag | Flag for high-risk items such as gift cards where (1) is high risk and (0) is non high risk | Retail | Boolean value (0 or 1) |
transaction_is_tangible | The item being solid is tangible (1) or intangible (0) | Marketplace | Boolean value (0 or 1) |
vertical | Vertical flag for the seller transactions that are in several verticals | Both | Retail, Household goods, clothing, tickets |