--- title: "Submit data for a PayPal PayIn" method: POST path: "/v2.01/{ClientId}/payins/payment-methods/paypal/data-collection" tags: ["PayPal"] --- # Submit data for a PayPal PayIn `POST /v2.01/{ClientId}/payins/payment-methods/paypal/data-collection` Provide transaction data to PayPal prior to initiating a pay-in ([read guide](/guides/payment-methods/paypal#submit-pre-transaction-risk-data)). **Note – Data to submit depends on industry** The request body parameters described below are required for all marketplace businesses. Additional data points are required for platforms operating in the following industries: - Events and ticketing - Online travel agents: - Car rentals - Hotels - Transportation - Travel packages - Retail and groceries - Cruise lines - Buy online, pick up in store (BOPIS) - Crypto Before integrating this endpoint, platforms operating in the verticals above need to contact Mangopay via the Dashboard. The `DataCollectionId` returned in the response must be sent on the associated pay-in call for both one-time and recurring payments: - [POST Create a PayPal PayIn](/api-reference/paypal/create-paypal-payin) - [POST Create a Recurring PayPal PayIn](/api-reference/paypal/create-recurring-paypal-payin) with the CIT payload - [POST Create a Recurring PayPal PayIn](/api-reference/paypal/create-recurring-paypal-payin) with the MIT payload Each PayPal pay-in or preauth requires a new `DataCollectionId`. The property is not returned on the pay-in endpoints. ## Path parameters - `ClientId` string, required ## Headers - `Authorization` string, required ## Request body - SubmitDataForAPayPalPayInRequest - `sender_account_id` string — Format: Alphanumeric; example: `A12345N343` Unique identifier of the sender/buyer account on the marketplace platform. - `sender_first_name` string — Format: Alphanumeric; example: `Jane` First name registered with the sender/buyer’s marketplace account. - `sender_last_name` string — Format: Alphanumeric; example: `Doe` Last name registered with the sender/buyer’s marketplace account. - `sender_email` string — Format: E.123 – Email Address; example: `john@example.com` Email address registered with the sender/buyer’s marketplace account. - `sender_phone` string — Format: E.123 - Telephone Number (national notation); example `(042) 1123 4567` Phone number (national notation) registered with the sender/buyer’s marketplace account. - `sender_country_code` string — Format: ISO Alpha-2 Country Code; example: `FR` Country code registered with the sender/buyer’s marketplace account. - `sender_create_date` string — Format: ISO 8601 date format; example: `2012-12-09T19:14:55.277-0:00` Date of creation of the sender/buyer’s account on the marketplace platform. - `sender_signup_ip` string — Format: IP (IPv4 / IPv6); example: `10.220.90.20` IP address that the sender/buyer used to sign up on the marketplace platform. - `sender_popularity_score` string — Possible values: `high`, `medium`, `low`; example: `high` Risk-based scoring on the sender/buyer by the marketplace platform (e.g., social score, identity score, risk score). This score is likely unique for each platform based on marketplace platform’s risk platform capabilities. - `receiver_account_id` string — Format: Alphanumeric; example: `A12345N343` Unique identifier of the seller/recipient’s account on the marketplace platform. - `receiver_create_date` string — Format: ISO 8601 date format; example: `2012-12-09T19:14:55.277-0:00` Date of creation of the seller/recipient’s account on the marketplace platform. - `receiver_email` string — Format: E.123 – Email Address; example: `john@example.com` Seller/recipient’s registered email on the marketplace platform. - `receiver_address_country_code` string — Format: ISO Alpha-2 Country Code; example: `FR` Seller/recipient’s country code registered on the marketplace platform. - `business_name` string — Format: Alphanumeric; example: `Acme Corp.` Business name used by the seller/recipient to register on the marketplace platform. - `recipient_popularity_score` string — Possible values: `high`, `medium`, `low`; example: `high` Risk-based scoring on the seller/recipient by the marketplace platform (e.g., social score, identity score, risk score). This score is likely unique for each platform based on marketplace platform’s risk platform capabilities. - `first_interaction_date` string — Format: ISO 8601 date format; example: `2012-12-09T 19:14:55.277-0:00` Date of the first interaction between the sender and receiver on the marketplace platform. Definition of ‘interaction’ is to be defined by the marketplace platform. Examples are: first transaction attempt between sender and receiver, add friend date between sender and receiver, etc. - `txn_count_total` string — Format: Integer; example: `34` Total number of transactions the sender/buyer has had to date on the marketplace platform (through PayPal or otherwise). - `vertical` string — Format: Alphanumeric; examples: `household goods`, `shoes`, `clothing`, `tickets`, etc. Transaction level vertical flag for the seller/receiver’s transactions that are in several verticals. - `transaction_is_tangible` string — Possible values: `0`, `1`; example: `0` The seller/receiver’s transaction is for tangible rather than digital goods. If tangible, value = 1. If intangible, value = 0. ## Response `200` Success - SubmitDataForAPayPalPayInResponse - `DataCollectionId` string — The unique identifier of the Data Collection object. A new `DataCollectionId` is needed for each call to: - [POST Create a PayPal PayIn](/api-reference/paypal/create-paypal-payin) - [POST Create a Recurring PayPal PayIn](/api-reference/paypal/create-recurring-paypal-payin), with both the CIT and MIT payloads - [POST Create a PayPal Deposit Preauthorization](/api-reference/deposit-preauthorizations/create-paypal-deposit-preauthorization) ## Other responses - `400` — Bad Request --- [API](https://skmtc.net/mangopay/apis/api-reference.md) · [All operations](https://skmtc.net/mangopay/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mangopay/api-reference/versions/795281070285/schema)