Verify — PayPal / Venmo - Ingo Payments Developer Hub

Authorizations

Authorization

string

header

required

HMAC-SHA512 signed Authorization header. See the Authentication page for the complete signing guide.

Body

application/json

Provide either customer_account_token or the full set of raw account fields (account, receiver_type, recipient_first_name, recipient_last_name, recipient_address1, recipient_city, recipient_state, recipient_zip) — never both.

participant_id

integer

required

Unique participant identifier assigned by Ingo.

Example:

12345

account_type

enum<string>

required

Indicates the type of transaction. PU = PayPal unverified account payout transaction, VE = Venmo payout transaction.

Available options:

PU,

VE

Minimum string length: 1

Example:

"PU"

participant_unique_id1

string

required

Participant assigned ID for the disbursement. Should be carried forward to the process request for tracking purposes. Must not contain NPI data.

Required string length: 1 - 254

Example:

"5ced00c4-116d-4786-b1cd-016f7f23dc54"

timestamp

integer<int64>

required

Unix timestamp of the request.

Example:

1598505599

version

integer

required

API version of the request. Current version is 11.

Example:

11

receiver_type

enum<integer>

Required when customer_account_token is not provided. Determines how the account value is interpreted. 1 = EMAIL, 2 = PHONE, 3 = PAYPAL_ID (PayPal PU only), 4 = USER_HANDLE (Venmo VE only).

Available options:

1,

2,

3,

4

Example:

1

customer_account_token

string | null

Alternative to raw account data when the account was previously tokenized. If provided, receiver_type and all raw account fields (account, recipient_first_name, recipient_last_name, recipient_address1, recipient_city, recipient_state, recipient_zip) are not required and should be omitted.

Required string length: 1 - 254

Example:

"a3650c4f-60e3-4f80-ba4b-b79055e20007"

account

string

Value used to identify the receiving account. Required unless customer_account_token is provided. Interpretation depends on receiver_type: EMAIL address, phone number, PayPal ID, or Venmo user handle.

Required string length: 1 - 254

Example:

"jane.doe@example.com"

recipient_first_name

string

Recipient first name. Required unless customer_account_token is provided.

Required string length: 1 - 254

Example:

"Jane"

recipient_last_name

string

Recipient last name. Required unless customer_account_token is provided.

Required string length: 1 - 254

Example:

"Doe"

recipient_address1

string

Recipient address line 1. Required unless customer_account_token is provided.

Required string length: 1 - 254

Example:

"123 Main St"

recipient_city

string

Recipient city. Required unless customer_account_token is provided.

Required string length: 1 - 254

Example:

"Atlanta"

recipient_state

string

Recipient state (standard US postal abbreviation). Required unless customer_account_token is provided.

Required string length: 2

Pattern:

^(?:A[LKSZRAEP]|C[AOT]|D[EC]|F[LM]|G[AU]|HI|I[ADLN]|K[SY]|LA|M[ADEHINOPST]|N[CDEHJMVY]|O[HKR]|P[ARW]|RI|S[CD]|T[NX]|UT|V[AIT]|W[AIVY])$

Example:

"GA"

recipient_zip

string | null

Recipient zip code. 5-digit zip or zip+4 in xxxxx-xxxx format. Required unless customer_account_token is provided.

Maximum string length: 10

Pattern: ^[0-9]{5}(?:-[0-9]{4})?$

Example:

"30313"

recipient_address2

string | null

Optional recipient address line 2.

Maximum string length: 254

Example:

"Apt 2"

recipient_business_name

string | null

Optional recipient business name.

Maximum string length: 150

Example:

"Doe Enterprises"

recipient_phone

string | null

Optional 10-digit recipient phone number.

Maximum string length: 10

Example:

"5551234567"

recipient_email

string | null

Optional recipient email address.

Maximum string length: 254

Example:

"jane.doe@example.com"

amount

number<float> | null

Dollar amount of disbursement.

Required range: x >= 0.01

Example:

50.01

participant_unique_id2

string | null

Optional second participant assigned ID for the disbursement. This value should be the same on all activity pertaining to a disbursement attempt.

Maximum string length: 254

Example:

"4259cf7e-ffd2-414a-9c82-cca8a4613e69"

store_id

string | null

Client assigned store ID. Required for Retail client participants.

Maximum string length: 254

Example:

"STORE-001"

terminal_id

string | null

Client assigned terminal ID. Required for Retail client participants.

Maximum string length: 254

Example:

"TERM-042"

clerk_id

string | null

Client assigned clerk ID. Required for Retail client participants.

Maximum string length: 254

Example:

"CLK-007"

Response

Verification successful — token returned

status

integer

Numeric code describing the status of the API request. 100 = Success.

Example:

100

client_message

string

Text description associated with the status code.

Example:

"Success"

recipient_message

string

Text description associated with the status code for the recipient.

Example:

"Success"

data

object

Show child attributes

time

string

Time in seconds to complete the request.

Example:

"2.4577"

validation_errors

string | null

Provides additional detail on validation type errors when applicable.

Example:

null