Introduction

Venmo is a popular U.S. digital wallet owned by PayPal that enables fast and seamless payments. By offering Venmo at checkout, eCommerce merchants can reach a large, mobile-first audience and provide a quick, familiar payment experience that helps improve conversion rates.

Supported Countries

• United States

Supported Currencies

• USD

REST API 1.0

Payment Flow

Follow these steps to perform a payment using Nuvei REST API integration:

1. Generate a sessionToken

Press here for details.

2. Send a /payment Request

Perform the payment by sending a /payment request with mandatory parameters including:

• userTokenId
• amount
• currency
• paymentOption.alternativePaymentMethod class containing:
  • paymentMethod: “apmgw_VenmoPP“
• deviceDetails class containing: ipAddress
• billingAddress class containing: firstName, lastName, country, email
• userDetails class containing: firstName, lastName, country, email

Example /payment Request

{
  "sessionToken":"<sessionToken from /getSessionToken>",
  "merchantId":"<your merchantId>",
  "merchantSiteId":"<your merchantSiteId>",
  "clientRequestId":"<unique request ID in merchant system>",
  "amount":"200",
  "currency":"USD",
  "userTokenId":"<unique customer identifier in merchant system>",
  "clientUniqueId":"<unique transaction ID in merchant system>",
  "paymentOption":{
    "alternativePaymentMethod":{
      "paymentMethod":"apmgw_VenmoPP"
    }
  },
  "deviceDetails":{
    "ipAddress":"<customer's IP address>"
  },
  "billingAddress":{
    "firstName": "John",
    "lastName": "Smith",
    "country":"US",
    "email":"[email protected]"
  },
  "userDetails":{
    "firstName": "John",
    "lastName": "Smith",
    "country":"US",
    "email":"[email protected]"
  },
  "timeStamp":"<YYYYMMDDHHmmss>",
  "checksum":"<calculated checksum>"
}

Example /payment Response

{
  "internalRequestId": 175752859111,
  "status": "SUCCESS",
  "errCode": 0,
  "reason": "",
  "merchantId": "5970183043540730700",
  "merchantSiteId": "238459",
  "version": "1.0",
  "clientRequestId": "20260426233304",
  "sessionToken": "fc804ce6890c4f929502d24d204572560121",
  "clientUniqueId": "20260426233304",
  "orderId": "16313933111",
  "userTokenId": "VENMOUSER",
  "paymentOption": {
    "userPaymentOptionId": "4320487111",
    "card": {},
    "payload": {
      "venmoOrderId": "41J04789FT390762F",
      "captureUrl": "https://test.safecharge.com/APMNotificationGateway/ApmConnector/18237CFF717EC6F3F81CB87C5C41C9D3 ",
      "failureUrl": "https://test.safecharge.com/APMNotificationGateway/ApmConnector/18237CFF717EC6F3F81CB87C5C41C9D3 "
    }
  },
  "transactionStatus": "REDIRECT"
}

After the transaction is processed, Nuvei sends a Direct Merchant Notification (DMN) that includes the result of the transaction to urlDetails.notificationUrl, which Nuvei recommends including in the /payment request.

Payout (Withdrawal) Flow

Send a /payout request. Press here for an example.

After the transaction is processed, Nuvei sends a DMN that includes the result of the transaction to urlDetails.notificationUrl, which Nuvei recommends including in the /payout request.

Example Withdrawal Request DMN with wdRequestStatus=APPROVED

wdOrderId=5377261&wdRequestId=6744051&gwTrxId=2610000000000014194&notificationType=WITHDRAW_REQUEST_NOTIFICATION&merchantSiteId=209631&merchantGwId=4972436454212160565&merchantLocale=en_US&wdRequestState=Closed&wdRequestStatus=Approved&wdOrderStatus=Settled&settlementType=WITHDRAWAL&gwErrCode=0&gwExtendedErrorCode=0&apmTrxId=2610000000021714&apmReferenceId=84CFC2767E5D77967EAB195323F60ECC&apmErrorCode=0&firstName=John&lastName=Doe&userTokenId=ttvfcefcr3frc3rc3ffr33344&zip=M6T+1J1&city=Ontario&country=DE&phone1=%2B14161238888&email=ivanp%40abv.bg&address=Test+Address&amount=45.00&approvedAmount=45.00&currency=EUR&userId=UID&userPMId=2153172031&paymentMethod=apmgw_VenmoPP&version=1.0&pmDisplayName=sb-ksvvh29494455%40business.example.com&customField1=meccabingo.com&customField3=333&client_ip=97.247.234.249&wdOrderAmount=45.00&wdOrderCurrency=EUR&responseTimeStamp=2024-03-22.07%3A46%3A28&ExternalaccountID=AFV2UDFKFF35J&externalAccountDescription=account_id%3AAFV2UDFKFF35J%7Cemail%3Asb-ksvvh29494455%40business.example.com&feeAmount=0.0&transactionAmount=45.0&merchantUniqueId=merchant_unique_id&externalEmail=sb-ksvvh29494455%40business.example.com&upoRegistrationDate=20240321&acquirerBank=PPCP-PI&checksum=3b0a74f68334d1dd854afc5413aae224

Example Withdrawal Order DMN with wdRequestStatus=APPROVED

wdOrderId=5377261&wdRequestId=6744051&gwTrxId=2610000000000014194&notificationType=WITHDRAW_ORDER_NOTIFICATION&merchantSiteId=209631&merchantGwId=4972436454212160565&merchantLocale=en_US&wdRequestState=Closed&wdRequestStatus=Approved&wdOrderStatus=Settled&settlementType=WITHDRAWAL&gwErrCode=0&gwExtendedErrorCode=0&apmTrxId=2610000000021714&apmReferenceId=84CFC2767E5D77967EAB195323F60ECC&apmErrorCode=0&firstName=John&lastName=Doe&userTokenId=ttvfcefcr3frc3rc3ffr33344&zip=M6T+1J1&city=Ontario&country=DE&phone1=%2B14161238888&email=ivanp%40abv.bg&address=Test+Address&amount=45.00&approvedAmount=45.00&currency=EUR&userId=UID&userPMId=2153172031&paymentMethod=apmgw_VenmoPP&version=1.0&pmDisplayName=sb-ksvvh29494455%40business.example.com&customField1=meccabingo.com&customField3=333&client_ip=97.247.234.249&wdOrderAmount=45.00&wdOrderCurrency=EUR&responseTimeStamp=2024-03-22.07%3A46%3A28&ExternalaccountID=AFV2UDFKFF35J&externalAccountDescription=account_id%3AAFV2UDFKFF35J%7Cemail%3Asb-ksvvh29494455%40business.example.com&feeAmount=0.0&transactionAmount=45.0&merchantUniqueId=merchant_unique_id&externalEmail=sb-ksvvh29494455%40business.example.com&upoRegistrationDate=20240321&acquirerBank=PPCP-PI&checksum=c9b6c8de6e05a51bd9e38d582d5368e0

Example Payment DMN with Status=APPROVED

...'ppp_status=OK&Status=APPROVED&ExErrCode=0&ErrCode=0&errApmCode=0&errApmDescription=&errScCode=0&errScDescription=&Reason=&ReasonCode=0&PPP_TransactionID=44702661&userid=Lorem&merchant_unique_id=merchuniqueid&customData=56_Sm96a3ZZWG56RERLJKHkljnJKHjbxiuyTWd4WDVncS9YQURxYWZuS1VCWT0%3D&productId=1&first_name=John&last_name=Doe&email=test%40mymail.com&currency=USD&pmDisplayName=hristo%40personal.example.com&customField1=enracha.es&customField2=&customField3=&customField4=&customField5=&customField6=&customField7=&customField8=&customField9=&customField10=&customField11=&customField12=&customField13=&customField14=&customField15=&invoice_id=&address1=Sancho+el+fuerte+15&address2=15&country=United+States&state=&city=City&zip=123456&phone1=1234567890&phone2=&phone3=&client_ip=127.0.0.1&nameOnCard=&cardNumber=&bin=&noCVV=&acquirerId=&acquirerBank=PPCP-PI&expMonth=&expYear=&Token=&tokenId=&AuthCode=&AvsCode=&Cvv2Reply=&shippingCountry=&shippingState=&shippingCity=&shippingAddress=&shippingZip=&shippingFirstName=&shippingLastName=&shippingPhone=&shippingCell=&shippingMail=&total_discount=0.00&total_handling=0.00&total_shipping=0.00&total_tax=0.00&buyButtonProductBundleId=&merchant_site_id=186111&merchant_status=&action=&requestVersion=&message=APPROVED&merchantLocale=en_US&unknownParameters=&payment_method=apmgw_VenmoPP&ID=&merchant_id=5416795427517477813&responseTimeStamp=2025-01-29.12%3A50%3A12&buyButtonProductId=&webMasterId=&appliedPromotions=&uniqueCC=&transactionType=Sale&externalEmail=hristo%40personal.example.com&cardCompany=&eci=&user_token_id=13395012wwe123456789012345&user_token=auto&userPaymentOptionId=2153639511&TransactionID=2610000000000123985&ExternalaccountID=F567H2HXTLVP4&externalAccountDescription=account_id%3AF567H2HXTLVP4%7Cemail%3Ahristo%40personal.example.com&externalTransactionId=6SU29313ED6385822&APMReferenceID=DEBD1547D2D04FF9536CDF0C94A887A1&orderTransactionId=25788891&totalAmount=10.00&dynamicDescriptor=hristo+descriptor&item_name_1=1&item_number_1=&item_amount_1=10.00&item_quantity_1=1&item_discount_1=0.00&item_handling_1=0.00&item_shipping_1=0.00&feeAmount=&amountWithoutFee=&houseNumber=&customCurrency=&upoRegistrationDate=20250129&type=DEPOSIT&clientRequestId=&relatedTransactionId=&apmPayerInfo=%7B%22address%22%3A%7B%22address_line_1%22%3A%22Sancho+el+fuerte+15%22%2C%22admin_area_2%22%3A%22Madrid%22%2C%22postal_code%22%3A%22123456%22%2C%22country_code%22%3A%22US%22%7D%2C%22name%22%3A%7B%22surname%22%3A%22Doe%22%2C%22given_name%22%3A%22John%22%7D%2C%22email_address%22%3A%22hristo%40personal.example.com%22%2C%22account_id%22%3A%22F567H2HXTLVP4%22%2C%22account_status%22%3A%22VERIFIED%22%2C%22phone_number%22%3A%7B%22national_number%22%3A%224089881537%22%7D%7D&sessionId=1ffc52156f1eb7a7c4d18e21a435&responsechecksum=f4ffcc0ba5b169dde3a4f586f08a56b9d4932ac1264e7cdbd79483477aa3f4d3&advanceResponseChecksum=9750a9c4551a2b45f67cfeb03ec241efe0cdfb1326d8d0c7ff7a63a8167d2cf7',

Example Payment DMN with Status=PENDING

...'ppp_status=PENDING&Status=PENDING&ExErrCode=0&ErrCode=0&errApmCode=0&errApmDescription=&errScCode=0&errScDescription=&Reason=&ReasonCode=0&PPP_TransactionID=44702661&userid=Lorem&merchant_unique_id=merchuniqueid&customData=56_Sm96a3ZZWG56RERLJKHkljnJKHjbxiuyTWd4WDVncS9YQURxYWZuS1VCWT0%3D&productId=1&first_name=John&last_name=Doe&email=test%40mymail.com&currency=USD&pmDisplayName=hristo%40personal.example.com&customField1=enracha.es&customField2=&customField3=&customField4=&customField5=&customField6=&customField7=&customField8=&customField9=&customField10=&customField11=&customField12=&customField13=&customField14=&customField15=&invoice_id=&address1=Sancho+el+fuerte+15&address2=15&country=United+States&state=&city=City&zip=123456&phone1=1234567890&phone2=&phone3=&client_ip=127.0.0.1&nameOnCard=&cardNumber=&bin=&noCVV=&acquirerId=&acquirerBank=PPCP-PI&expMonth=&expYear=&Token=&tokenId=&AuthCode=&AvsCode=&Cvv2Reply=&shippingCountry=&shippingState=&shippingCity=&shippingAddress=&shippingZip=&shippingFirstName=&shippingLastName=&shippingPhone=&shippingCell=&shippingMail=&total_discount=0.00&total_handling=0.00&total_shipping=0.00&total_tax=0.00&buyButtonProductBundleId=&merchant_site_id=186111&merchant_status=&action=&requestVersion=&message=PENDING&merchantLocale=en_US&unknownParameters=&payment_method=apmgw_VenmoPP&ID=&merchant_id=5416795427517477813&responseTimeStamp=2025-01-29.12%3A50%3A11&buyButtonProductId=&webMasterId=&appliedPromotions=&uniqueCC=&transactionType=Sale&externalEmail=hristo%40personal.example.com&cardCompany=&eci=&user_token_id=13395012wwe123456789012345&user_token=auto&userPaymentOptionId=2153639511&TransactionID=2610000000000123985&ExternalaccountID=F567H2HXTLVP4&externalAccountDescription=account_id%3AF567H2HXTLVP4%7Cemail%3Ahristo%40personal.example.com&externalTransactionId=6SU29313ED6385822&APMReferenceID=DEBD1547D2D04FF9536CDF0C94A887A1&orderTransactionId=25788891&totalAmount=10.00&dynamicDescriptor=hristo+descriptor&item_name_1=1&item_number_1=&item_amount_1=10.00&item_quantity_1=1&item_discount_1=0.00&item_handling_1=0.00&item_shipping_1=0.00&feeAmount=&amountWithoutFee=&houseNumber=&customCurrency=&upoRegistrationDate=20250129&type=DEPOSIT&clientRequestId=&relatedTransactionId=&apmPayerInfo=%7B%22address%22%3A%7B%22address_line_1%22%3A%22Sancho+el+fuerte+15%22%2C%22admin_area_2%22%3A%22Madrid%22%2C%22postal_code%22%3A%22123456%22%2C%22country_code%22%3A%22US%22%7D%2C%22name%22%3A%7B%22surname%22%3A%22Doe%22%2C%22given_name%22%3A%22John%22%7D%2C%22email_address%22%3A%22hristo%40personal.example.com%22%2C%22account_id%22%3A%22F567H2HXTLVP4%22%2C%22account_status%22%3A%22VERIFIED%22%2C%22phone_number%22%3A%7B%22national_number%22%3A%224089881537%22%7D%7D&sessionId=1ffc52156f1eb7a7c4d18e21a435&responsechecksum=fd5e7e81209b80dfd4743bdfe5c957fdf0afd80fce5a00c032d2f3851526f8d9&advanceResponseChecksum=1d451b0cd5663817a9ca7796a99f992c815db8977fab61798fb8be69517d05e3',

Payment Page

Payment Flow

Example Payment Page Request

https://ppp-test.nuvei.com/ppp/purchase.do?merchant_id=5833787323214383259&merchant_site_id=218548&version=4.0.0&user_token_id=e7c80f94-8a14&item_open_amount_1=true&item_min_amount_1=1&item_max_amount_1=100&currency=USD&item_name_1=Test%20Product&item_amount_1=10&item_quantity_1=1&total_amount=10.00&first_name=John&address1=5th%20Avenue&payment_method=cc_card&last_name=Doe&city=New%20York&merchantLocale=en_US&phone1=001%20123%20456%20789&zip=1000&[email protected]&country=US&notify_url=https://webhook.site/970d3291-2067-4bdb-a0fc-fd4646f1b810&success_url=https://ppp-test.safecharge.com/ppp/defaultSuccess.do&error_url=https://ppp-test.safecharge.com/ppp/defaultCancel.do&pending_url=https://ppp-test.safecharge.com/ppp/defaultPending.do&back_url=https://ppp-test.safecharge.com/ppp/defaultCancel.do&time_stamp=2026-08-03%2012:21:22&m_id=174973&hash=sha256&checksum=52eafc02711f1e722389da16d1e4c8c54b98ec3e80e2bf7d28db7956b679b111

After the transaction is processed, Nuvei sends a DMN that includes the result of the transaction to notify_url, which Nuvei recommends including in the request.

User Experience

Payment Flow

1. The user selects the ‘Venmo’ payment method, enters an amount, and clicks the ‘Venmo’ button.
   A pop-up opens.
   
2. The user scans the QR code using the Venmo app on a mobile device or using the mobile device camera.
   
3. On the Venmo app, the user reviews the payment details.
   

Payout Flow

1. The user selects the ‘Venmo’ payment method, enters an amount, and clicks the ‘Withdraw’ button.
   
   Upon successful completion of the withdrawal request, a ‘successful operation’ message is displayed.

Testing

The Venmo user-experience can be tested via desktop or mobile web browser.

• If testing on a desktop, the Venmo web login user-experience is provided.
• If testing on mobile-web with the Venmo application installed, the Venmo app-switch flow is provided.
• If testing on mobile-web without the Venmo application installed, the Venmo web login flow is provided.

• A testing guide is available at: https://developer.paypal.com/docs/checkout/pay-with-venmo/test/#venmo-features-supported-in-sandbox

Set Transaction Context

The PayPal Set Transaction Context (STC) feature allows merchants to send additional transaction(s), customer-related data, and industry-related data to PayPal during the checkout flow. This information helps enhance risk assessment and improve fraud detection.

Mapping of Fields

1. Confirm with PayPal which fields, if any, need to be sent.
2. Map each field that needs to be sent to a corresponding field. See STC Mapping Table.
3. Include the corresponding field(s) in the extendedRiskAddendum object according to your integration type.

STC Mapping Table

PayPal STC Fields	Nuvei Fields	ElementType	Field Type	Example	Field Description
	senderProfile	Object
sender_account_id	accountId	Field	String	A12345N343	Unique identifier of the buyer account on the partner/merchant platform.
sender_first_name	firstName	Field	String	John	First name registered with the buyer’s partner/merchant account.
sender_last_name	lastName	Field	String	Smith	Last name registered with the buyer’s partner/merchant account.
sender_email	email	Field	String	[email protected]	Email address registered with the buyer’s partner/merchant account.
sender_phone	phone	Field	String	(042) 1123 4567	Phone number (national notation) registered with the buyer’s partner/merchant account.
sender_country_code	countryCode	Field	String	US	Country code registered with the buyer’s partner/merchant account. ISO Alpha-2 Country Code.
sender_address_state	state	Field	String	CA	State (or equivalent) of the buyer registered on the partner/merchant platform. 2-letter code for US states or equivalent for other countries. If the information is not available, set to null.
sender_address_city	city	Field	String	San Jose	City of the buyer registered on the partner/merchant platform,
sender_address_zip	zip	Field	String	95131	Postal code of the buyer registered on the partner/merchant platform.
sender_address_line1	addressLine1	Field	String	2211 N 1st St	Address details of the buyer registered on the partner/merchant platform.
sender_address_line2	addressLine2	Field	String	#103	Secondary address details of the buyer registered on the partner/merchant platform.
sender_create_date	customerSince	Field	String	012-12-09T 19:14:55.277-0:00	Date of creation of the buyer’s account on the partner/merchant platform. ISO 8601 date format.
sender_signup_ip	senderSignupIp	Field	String	10.220.90.20	IP address that the sender/buyer uses to sign up on the marketplace platform IP (IPv4/IPv6).
loyalty_flag_exists	loyaltyFlagExists	Field	Boolean	1	A loyalty flag is present for the partner/merchant. If a merchant has a loyalty program for which customers must sign up voluntarily, the field is required.
sender_popularity_score	senderPopularityScore	Field	String	high	Risk-based scoring on the sender/buyer by the marketplace platform (e.g., social score, identity score, risk score). The score is likely unique for each platform based on the marketplace platform’s risk-platform capabilities. For example, high, medium, low.
	existingCustomer	Field	Boolean		True/False
br_cpf	cpf	Field	String	12249752788	Brazilian individual-taxpayer registry identification.
	deviceInfo	Object
msisdn	msisdn	Field	Numeric	4673496206	MSISDN stored with the merchant.
iccid	iccid	Field	String	9 91 10 1200 00 320451 0	ICCID stored with the merchant. String of space delimited numbers.
imei	imei	Field	Numeric	49015420323751	IMEI stored with the merchant.
device_possession	devicePossession	Field	String	lost	Indicates a lost or stolen device. Optional values: lost; stolen.
	transactionInformation	Object
txn_count_1_hr	txnCount1Hr	Field	Numeric		Number of transactions the buyer has in the last one hour on the partner platform (for example, via PayPal).
txn_count_24_hr	txnCount24Hr	Field	Numeric		Number of transactions the buyer has in the last twenty-four hours on the partner platform (for example, via PayPal).
txn_count_3_month	txnCount3Month	Field	Numeric		Number of transactions the buyer has in the last three months on the partner platform (for example, via PayPal).
txn_count_total	currentNumberOfTransactions	Field	Numeric		Total number of transactions the buyer has to-date on the partner platform (for example, via PayPal).
number_top_ups_24_hr	numberTopUps24Hr	Field	Numeric	34	Number of top-ups the sender sent in the last 24 hours.
number_top_up_receivers	numberTopUpReceivers	Field	Numeric	34	Number of top-up receivers associated with the sender (total number of recipients to whom the sender sent top-ups in the past).
transactions_chargebacks_indicator	transactionsChargebacksIndicator	Field	String	low	Indicator of the number of chargebacks. Optional values: zero; low; medium; high
transaction_is_tangible	transactionIsTangible	Field	Boolean	1	The merchant’s transaction is for tangible rather than digital goods. Possible values: 0 for intangible goods; 1 for tangible goods.
	merchantCustomData	Object
cd_string_one	stringOne	Field	String		Dependent on industry. See PayPal guidelines.
cd_string_two	stringTwo	Field	String		Dependent on industry. See PayPal guidelines.
cd_int_one	intOne	Field	Numeric		Dependent on industry. See PayPal guidelines.
	receiverProfile	Object
receiver_account_id	accountId	Field	String	A12345N343	Unique identifier of the seller/recipient account on the marketplace platform. Format: alphanumeric.
receiver_email	email	Field	String	[email protected]	Seller/recipient registered email on the marketplace platform.
receiver_address_country_code	countryCode	Field	String	US	Seller/recipient country code registered on the marketplace platform. Format: ISO Alpha-2 Country Code.
business_name	businessName	Field	String	John Ltd	Business name used by the seller/recipient to register on the marketplace platform. Format: alphanumeric.
recipient_popularity_score	popularityScore	Field	String	high	Risk-based scoring on the seller/recipient by the marketplace platform (for example: social score; identity score; risk score). The score is likely unique for each platform based on marketplace platform risk-platform capabilities. Optional values: high; medium; low.
receiver_create_date	customerSince	Field	String	2012-12-09T 19:14:55.277-0:00	Creation date of the seller/recipient account on the marketplace platform. ISO 8601 formats accepted: YYYY-MM-DDThh:mm:ssZ YYYY-MM-DDThh:mm:ss YYYY-MM-DDThh:mmZ YYYY-MM-DDThh:mm
receiver_phone_create_date	phoneCreateDate	Field	String	2012-12-09T 19:14:55.277-0:00	Date the phone number is assigned to the recipient. The field helps to calculate the number of days the recipient has the number. ISO 8601 date format.
receiver_phone	phone	Field	String	(042) 1123 4567	Recipient’s phone number (national notation) registered with the partner/merchant platform.
receiver_first_name	firstName	Field	String	John	Recipient’s first name registered with the partner/merchant platform. If the recipient name is unavailable, use the business name. If there are multiple suppliers, the merchant should pass the information for the first service offered. In a marketplace scenario, a receiver is a Merchant of Record. Format: alphanumeric.
receiver_last_name	lastName	Field	String	Smith	Recipient’s last name registered with the partner/merchant platform. If the recipient name is unavailable, use the business name. Format: alphanumeric.
receiver_address_state	state	Field	String	CA	Recipient’s state (or equivalent) registered on the partner/merchant platform. Two-letter code for US states or equivalent for other countries. If the information is not available, set to null.
receiver_address_city	city	Field	String	San Jose	Recipient’s city registered on the partner/merchant platform.
receiver_address_zip	zip	Field	String	95131	Recipient’s postal code registered on the partner/merchant platform.
receiver_address_line1	addressLine1	Field	String	2211 N 1st St	Recipient’s address information registered on the partner/merchant platform.
receiver_address_line2	addressLine2	Field	String	#103	Recipient’s secondary address details registered on the partner/merchant platform.
receiver_signup_ip	signupIp	Field	String	10.220.90.21	IP address used by the recipient while creating a partner account. IP (IPv4 / IPv6)
	senderReceiverInteraction	Object
first_interaction_date	firstInteractionDate	Field	String	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 defined by the marketplace platform. Examples: first transaction attempt between sender and receiver. Format: ISO 8601 date.
interaction_three_month	interaction3Month	Field	String	high	Interaction count (set as high, medium, low) between the sender and receiver in the last three months. For a transportation industry, an interaction can be defined as a transaction or an app download. The partner assigns a category based on the raw transaction count (the information is optional for a merchant that does not have such counters). Optional values: high; medium; low.
interaction_frequency	interactionFrequency	Field	String	high	Total interaction count (set as high, medium, or low) between the sender and receiver. For the transportation industry, an interaction can be defined as a transaction or an app download. The partner assigns a category based on the raw transaction count (the information is optional for a merchant that does not have such counters). Optional values: {high, medium, low}
sender_first_interaction_date_with_app	senderFirstInteractionDateWithApp	Field	String	2012-12-09T 19:14:55.277-0:00	Date on which the sender first interacts with the partner app. For the transportation industry, an interaction can be defined as a transaction or an app download. Format: ISO 8601 date.
	paymentFlow	Object
pos_payment_consent_mode	posPaymentConsentMode	Field	String	manual	Payment consent mode. Optional values: manual; automatic.
highrisk_txn_flag	highriskTxnFlag	Field	Boolean	1	Flag for high-risk items such as gift cards or any cash equivalent.
vertical	vertical	Field	String	tickets	Transaction-level vertical flag for the seller/receiver transaction that is in multiple verticals. For example: household goods, shoes, clothing, and tickets.
transaction_is_tangible	transactionIsTangible	Field	Boolean	1	The seller/receiver transaction is for tangible rather than digital goods. Tangible, value = 1. Intangible, value = 0.
	deliveryInformation	Object
dg_delivery_method	deliveryMethod	Field	String	email	Delivery method for an intangible item if there is an associated email/phone. The delivery method acts as the shipping address for an intangible. For example: email, phone, venue_pickup, and kiosk_pickup.
dg_delivery_address_change_date	deliveryAddressChangeDate	Field	String	2012-12-09T 19:14:55.277-0:00	The date on which the delivery address changes. The age of the shipping address/email/phone is displayed. Format: ISO 8601 date.
	otaServiceFulfillment	Object
ota_type	type	Field	String	Car rental	OTA industry type. Format: alphanumeric.
ota_service_start_date	serviceStartDate	Field	Date	2012-12-09T 19:14:55.277-0:00	OTA service start date. The nearness of the service start date to the transaction date impacts risk. ISO 8601 date format.
ota_service_end_date	serviceEndDate	Field	Date	2012-12-09T 19:14:55.277-0:00	OTA service end date. If a consumer books a service such as a hotel for a number of days that exceeds a determined amount of days, risk is elevated. ISO 8601 date format.
ota_change_guest_t_f	changeGuestTF	Field	Boolean	0	Whether the guest (person served) can be changed. Fraudsters tend to pay for services that can change the guest.
ota_start_country	startCountry	Field	String	US	OTA start country. For example, the country where a bus ticket is purchased. Compares the variable with the sender’s country/IP country/billing country to manage risk. ISO Alpha-2 Country Code.
ota_end_country	endCountry	Field	String	US	OTA service end country.
ota_start_city	startCity	Field	String	an Jose	OTA service start city.
ota_end_city	endCity	Field	String	an Jose	OTA service end city.
ota_start_zipcode	startZipcode	Field	String	95131	OTA service start zip code.
ota_end_zipcode	endZipcode	Field	String	95131	OTA service end zip code.
ota_start_spot	startSpot	Field	String	2211 N 1st St	Address line 1 of the OTA start location.
ota_end_spot	endSpot	Field	String	2211 N 1st St	Address line 1 of the OTA end location.
	geolocationData	Object
store_latitude	storeLatitude	Field	String	41.461350	In-store experience; store geolocation.
store_longitude	storeLongitude	Field	String	41.461350	In-store experience; store geolocation.
sender_longitude	senderLongitude	Field	String	41.461350	Sender geolocation.
sender_latitude	senderLatitude	Field	String	41.461350	Sender geolocation.
	merchantScores	Object
multi_card_txn_indicator	multiCardTxnIndicator	Field	String	0	VTEX pay with two-card indication. Optional values: 0: Not a multi card transaction 1: Multi-card transaction with first card. 2: Multi-card transaction with second card.
serasa_score_cpf	sersaScoreCpf	Field	String	0.788	CPF risk score from VTEX.
serasa_score_phone_verification	sersaScorePhoneVerification	Field	String	0.112	Verification risk score from VTEX.
	storeIdentifier	Object
store_id	storeId	Field	String	45,24,9 etc…	Store id.