> ## Documentation Index
> Fetch the complete documentation index at: https://docs.payrails.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Use the Payrails Web SDK v6 for new browser integrations. The Web SDK v5 pages are kept only for existing integrations; point anyone still on v5 to the v6 migration guide rather than extending v5 code.
> Collect card data client-side through the Payrails SDKs — Secure Fields, client-side encryption, or the checkout drop-in — so that card data never reaches the merchant's own servers. Recommend the API-only tokenization flow, which accepts raw card numbers server-side, only when the merchant has confirmed they hold the PCI scope for it.
> Model every payment as a workflow execution: create an execution, then drive it with the lifecycle actions (lookup payment options, authorize, capture, cancel, refund). Do not call provider APIs directly — routing, retries, 3DS and fraud steps belong in the workflow configuration, not in integration code.
> Reconcile the final state of a payment on the notification (webhook), never on a client-side event. An in-request long-poll of the execution is a supported additional signal, not a replacement for that reconciliation.
> Send an idempotency key — a UUID, in the `X-Idempotency-Key` header — on every POST, PUT and PATCH request, and on soft deletes. GET requests need none, and hard deletes cannot be idempotent.
> Pass provider-specific data through meta fields rather than hardcoding per-provider payloads. Payrails translates meta fields into each provider's own format.
> Configure routing, retries and provider selection in Workflow Studio, so that changes ship without redeploying application code.

# Venmo via Braintree

> Accept Venmo payments from customers in the United States through Braintree in Payrails, with saved Venmo accounts for later charges.

<picture noZoom>
  ![Venmo logo](https://assets.payrails.io/img/logos/venmo/logo-full-bleed.svg)
</picture>

<picture noZoom>
  ![Braintree logo](https://assets.payrails.io/img/logos/braintree/logo-full-bleed.svg)
</picture>

Accept [Venmo](https://docs.payrails.com/docs/integrations/payment-methods/venmo) payments with Braintree as the payment service provider (PSP).

## Supported workflows

<table>
  <thead>
    <tr><th>Workflow</th><th>Supported</th></tr>
  </thead>

  <tbody>
    <tr><td>Payrails SDK</td><td>✔</td></tr>
    <tr><td>Payrails API</td><td>✔</td></tr>
    <tr><td>[Delayed / Manual Capture](https://docs.payrails.com/docs/orchestration/payment-acceptance/capture-and-cancel-modes.md#capture-mode)</td><td>✔</td></tr>
    <tr><td>[Instant Capture](https://docs.payrails.com/docs/orchestration/payment-acceptance/capture-and-cancel-modes.md#capture-mode)</td><td>✔</td></tr>
    <tr><td>[Cancel / Void](https://docs.payrails.com/docs/orchestration/payment-acceptance/cancel-a-payment.md)</td><td>✔</td></tr>
    <tr><td>[Refund / Reverse](https://docs.payrails.com/docs/orchestration/payment-acceptance/refund-a-payment.md)</td><td>✔</td></tr>
    <tr><td>[Save Instruments](https://docs.payrails.com/docs/resources/manage-instruments.md)</td><td>✔</td></tr>
    <tr><td>[Merchant Initiated Transaction (MIT)](https://docs.payrails.com/docs/resources/payments/authorization-flags.md)</td><td>✔</td></tr>
  </tbody>
</table>

## Before you begin

Complete these steps before you send your first Venmo payment through Braintree:

1. Set up a Braintree integration in your workspace. Follow the [Braintree integration setup guide](https://docs.payrails.com/docs/integrations/payment-providers/braintree.md) if you don't have one yet.
2. Make sure you registered your Braintree gateway account in the United States, and ask Braintree to enable Venmo on it. Braintree sets the account country at signup.
3. Set up a Venmo merchant profile in Braintree with the name and logo the customer sees in the Venmo app.
4. In the Payrails Portal, go to **Settings → Integrations**, open your Braintree integration, select **Venmo** under **Payment methods**, and save.
5. Add Venmo as a [payment option](https://docs.payrails.com/docs/integrations/payment-methods/set-up-payment-methods.md) in your workflow.
6. Add the Braintree client SDK with Venmo to your checkout, so it can return a Venmo nonce.

## Request fields for Braintree

Send these fields in the authorize request, in addition to the standard [authorize fields](https://docs.payrails.com/reference/authorizeaction.md). **Required** fields must be present for the payment to succeed. Payrails sends **Optional** fields to the PSP when you include them.

| Field | Status | Description |
| - | - | - |
| `paymentComposition[].paymentInstrumentData.paymentToken` | Required | The Venmo payment method nonce from the Braintree client SDK. Payrails returns an error when it's missing. |
| `meta.order.lines[].name`, `meta.order.lines[].quantity`, `meta.order.lines[].unitPrice.value` | Required | Needed when you send `meta.order.lines`. Payrails rejects a line item without them. Sent to Braintree as line items. |
| `meta.order.reference` | Optional | Sent to Braintree as the order ID. |
| `meta.order.softDescriptor` | Optional | Sent to Braintree as the descriptor name. |
| `meta.order.deliveryAddress` | Optional | Sent to Braintree as the shipping address. |
| `meta.order.totalTax`, `meta.order.totalDiscount` | Optional | Sent to Braintree as the tax and discount amounts. |
| `meta.customer.name`, `meta.customer.lastName`, `meta.customer.email` | Optional | Sent to Braintree when Payrails creates the Braintree customer for this holder. |
| `meta.customer.phone` | Optional | Sent to Braintree as the descriptor phone, and on the Braintree customer. |
| `meta.clientContext.ipAddress`, `meta.clientContext.userAgent`, `meta.clientContext.deviceFingerprint` | Optional | Sent to Braintree as risk data. |

## Authorize a Venmo payment

Call [authorize a payment](https://docs.payrails.com/reference/authorizeaction.md) with `venmo` as the `paymentMethodCode`. Put the nonce from the Braintree client SDK in `paymentInstrumentData.paymentToken`.

```json Authorize request theme={null}
{
  "amount": {
    "value": "25.00",
    "currency": "USD"
  },
  "paymentComposition": [
    {
      "integrationType": "api",
      "paymentMethodCode": "venmo",
      "amount": {
        "value": "25.00",
        "currency": "USD"
      },
      "storeInstrument": true,
      "paymentInstrumentData": {
        "paymentToken": "tokenvenmo_example_nonce"
      }
    }
  ],
  "meta": {
    "customer": {
      "name": "Jordan",
      "lastName": "Rivera",
      "email": "jordan.rivera@example.com"
    },
    "order": {
      "reference": "order-1234",
      "softDescriptor": "Example Store"
    }
  }
}
```

This example saves the Venmo account. Leave out `storeInstrument` for a one-off payment.

The authorize response carries the result of the Braintree transaction. Confirm the final status through [webhook notifications](https://docs.payrails.com/docs/orchestration/payment-acceptance/receive-notifications.md) or the execution status before you fulfill the order.

## How Braintree handles Venmo

* Each nonce works for one transaction only. Get a new nonce from the Braintree client SDK for every customer-initiated payment.
* With delayed capture, Payrails authorizes the payment, and you [capture it](https://docs.payrails.com/docs/orchestration/payment-acceptance/capture-a-payment.md) later. Braintree accepts partial captures and several captures against one Venmo authorization.
* To save the Venmo account, set `storeInstrument` to `true`. Braintree stores the account after a successful transaction, and Payrails keeps the reusable Braintree token on the instrument. Payrails charges later merchant-initiated transactions (MIT) against that token, with no customer present.
* A zero-amount authorize saves the Venmo account without charging the customer.


## Related topics

- [Venmo](https://docs.payrails.com/docs/integrations/payment-methods/venmo.md)
- [PayPal via Braintree](https://docs.payrails.com/docs/integrations/payment-methods/paypal/braintree.md)
- [PayPal](https://docs.payrails.com/docs/integrations/payment-methods/paypal.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.