v2

latestOpenAPI 3.1.02026-07-262279731.3 MB

PayPal

View data submitted for a PayPal PayIn

Retrieve pre-transaction data submitted previously.

get/v2.01/{ClientId}/payins/payment-methods/paypal/data-collection/{DataCollectionId}

Path parameters

ClientIdstring required

Platform's API account identifier, associated with the API key.

DataCollectionIdstring required

The unique identifier of the Data Collection object, returned after sending the requested data to the POST Submit data for a PayPal PayIn endpoint.

Headers

Authorizationstring required

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Response

Success

business_namestring

Format: Alphanumeric; example: Acme Corp.

Business name used by the seller/recipient to register on the marketplace platform.

first_interaction_datestring

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.

sender_phonestring

Format: E.123 - Telephone Number (national notation); example (042) 1123 4567

Phone number (national notation) registered with the sender/buyer’s marketplace account.

receiver_create_datestring

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_address_country_codestring

Format: ISO Alpha-2 Country Code; example: FR

Seller/recipient’s country code registered on the marketplace platform.

rcsstring

The rcs returned by PayPal.

stcstring

The stc returned by PayPal.

sender_create_datestring

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.

transaction_is_tangiblestring

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.

receiver_emailstring

Format: E.123 – Email Address; example: john@example.com

Seller/recipient’s registered email on the marketplace platform.

verticalstring

Format: Alphanumeric; examples: household goods, shoes, clothing, tickets, etc.

Transaction level vertical flag for the seller/receiver’s transactions that are in several verticals.

sender_country_codestring

Format: ISO Alpha-2 Country Code; example: FR

Country code registered with the sender/buyer’s marketplace account.

txn_count_totalstring

Format: Integer; example: 34

Total number of transactions the sender/buyer has had to date on the marketplace platform (through PayPal or otherwise).

sender_signup_ipstring

Format: IP (IPv4 / IPv6); example: 10.220.90.20

IP address that the sender/buyer used to sign up on the marketplace platform.

rdauuidstring

The rdauuid returned by PayPal.

receiver_account_idstring

Format: Alphanumeric; example: A12345N343

Unique identifier of the seller/recipient’s account on the marketplace platform.

sender_last_namestring

Format: Alphanumeric; example: Doe

Last name registered with the sender/buyer’s marketplace account.

sender_account_idstring

Format: Alphanumeric; example: A12345N343

Unique identifier of the sender/buyer account on the marketplace platform.

api_callerstring

The api_caller returned by PayPal.

sender_first_namestring

Format: Alphanumeric; example: Jane

First name registered with the sender/buyer’s marketplace account.

sender_popularity_scorestring

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.

recipient_popularity_scorestring

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.

sender_emailstring

Format: E.123 – Email Address; example: john@example.com

Email address registered with the sender/buyer’s marketplace account.