API Reference

Supported Operations

Generate embed URL for recipient linking
Withdraw (send payout to recipient)
Manage recipients on file (retrieve, set default, delete)
Transaction status lookup

PayPal Endpoints

Generate Embed URL

POST /api/v2/paypal/generate-embed-url

Generates a URL for the hosted PayPal recipient link iframe.

No additional parameters required beyond authentication.

Add Recipient

POST /api/v2/paypal/add

Adds a PayPal recipient directly without the embed flow.

Request Parameters

Parameter	Type	Required	Description
EmailAddress	string	Yes	Recipient's PayPal email address

Withdraw

POST /api/v2/paypal/withdraw

Sends a payout to a linked PayPal recipient.

Request Parameters

Parameter	Type	Required	Description
Amount	decimal	Yes	Payout amount
Token	string	Conditional	PayPal recipient token. Required if no default recipient is set
ClientAccountID	string	Optional	Link transaction to a sub-account
ClientReferenceNumber	string	Optional	Your internal reference number
IdempotencyKey	string	Optional	Unique key to prevent duplicate payouts
Notes	string	Optional	Internal notes

Get Withdraw Transaction

GET /api/v2/paypal/withdraw/transaction

Returns details of a single PayPal withdraw transaction.

Request Parameters

Parameter	Type	Required	Description
TransactionID	string	Yes	The transaction ID returned from `/paypal/withdraw`

Get Recipients

GET /api/v2/paypal/recipients

Returns all PayPal recipients linked to the account.

No additional parameters required.

Set Default Recipient

POST /api/v2/paypal/set-my-recipient

Sets a linked PayPal recipient as the default for the account.

Request Parameters

Parameter	Type	Required	Description
Token	string	Yes	The PayPal recipient token to set as default

Get Default Recipient

GET /api/v2/paypal/default-recipient

Returns the default PayPal recipient configured for the account.

No additional parameters required.

Delete Recipient

POST /api/v2/paypal/delete

Removes a linked PayPal recipient from the account.

Request Parameters

Parameter	Type	Required	Description
Token	string	Yes	The PayPal recipient token to delete

Venmo Endpoints

Generate Embed URL

POST /api/v2/venmo/generate-embed-url

Generates a URL for the hosted Venmo recipient link iframe.

No additional parameters required beyond authentication.

Add Recipient

POST /api/v2/venmo/add

Adds a Venmo recipient directly without the embed flow.

Request Parameters

Parameter	Type	Required	Description
EmailAddress	string	Yes	Recipient's Venmo-linked email or phone handle

Withdraw

POST /api/v2/venmo/withdraw

Sends a payout to a linked Venmo recipient.

Request Parameters

Parameter	Type	Required	Description
Amount	decimal	Yes	Payout amount
Token	string	Conditional	Venmo recipient token. Required if no default recipient is set
ClientAccountID	string	Optional	Link transaction to a sub-account
ClientReferenceNumber	string	Optional	Your internal reference number
IdempotencyKey	string	Optional	Unique key to prevent duplicate payouts
Notes	string	Optional	Internal notes

Get Withdraw Transaction

GET /api/v2/venmo/withdraw/transaction

Returns details of a single Venmo withdraw transaction.

Request Parameters

Parameter	Type	Required	Description
TransactionID	string	Yes	The transaction ID returned from `/venmo/withdraw`

Get Recipients

GET /api/v2/venmo/recipients

Returns all Venmo recipients linked to the account.

No additional parameters required.

Set Default Recipient

POST /api/v2/venmo/set-my-recipient

Sets a linked Venmo recipient as the default for the account.

Request Parameters

Parameter	Type	Required	Description
Token	string	Yes	The Venmo recipient token to set as default

Get Default Recipient

GET /api/v2/venmo/default-recipient

Returns the default Venmo recipient configured for the account.

No additional parameters required.

Delete Recipient

POST /api/v2/venmo/delete

Removes a linked Venmo recipient from the account.

Request Parameters

Parameter	Type	Required	Description
Token	string	Yes	The Venmo recipient token to delete