---
title: "Update outbound payment intent"
method: PATCH
path: "/v1/payment-intents/outbound/{uid}/"
tags: ["Integration: Outbound Payment Intents", "Outbound Payment Intents"]
---

# Update outbound payment intent

`PATCH /v1/payment-intents/outbound/{uid}/`

## Request

- Base URL: `https://api.foundation.dev.trusspayments.com`
- URL: `https://api.foundation.dev.trusspayments.com/v1/payment-intents/outbound/{uid}/`
- Auth: HTTP bearer

Update a user's outbound payment intent

###### Required Scopes: ######
------
`payment_intent.outbound:write` `transactions:read`

## Path parameters

- `uid` string, uuid, required

## Request body

- UpdateOutboundPaymentIntentRequest
  - `total` string, decimal: The total amount due for the payment intent. If updated, the remaining balance due (total - sum of existing payments) must be greater or equal to 1.00. This field cannot be updated on fully paid or canceled payment intents.
  - `addenda` string: Payment intent description, which will also be used as the addenda on any payments made on the payment intent. This field cannot be updated on fully paid or canceled payment intents.
  - `note` string, nullable: A note to the payee/vendor. This field cannot be updated on fully paid or canceled payment intents.
  - `memo` string, nullable: A private memo for internal use.
  - `due_date` string, date, nullable: The due date for payment of payment intent. Must be a string with format YYYY-MM-DD representing a date in the future.

## Response `200`

- PaymentIntent
  - `uid` string, uuid, required
  - `total` string, decimal, required
  - `addenda` string, required
  - `direction` 0 | 1, required: `0`: Inbound, `1`: Outbound
  - `note` string, nullable, required
  - `memo` string, nullable, required
  - `due_date` string, date, nullable, required
  - `contact` Contact, required
    - `uid` string, uuid, required
    - `name` string, required
    - `email` string, email, nullable, required
    - `secondary_email` string, email, nullable, required
    - `phone` string, nullable, required
    - `oauth_connection_id` string, uuid
  - `wallet_uid` string, uuid, nullable, required: The uid of the company wallet this payment intent is booked to: the funding wallet for an outbound bill, or the receiving wallet for an inbound invoice.
  - `status` string, required
  - `balance_paid` string, decimal, required
  - `checkout_url` string, nullable, required: Guest checkout URL for contactless payment intents only (contact is null). Omitted on list and webhook payloads. Invoices with a contact use the authenticated partner checkout path instead.
  - `created_at` string, date-time, required
  - `pending_at` string, date-time, nullable, required
  - `paid_at` string, date-time, nullable, required
  - `canceled_at` string, date-time, nullable, required
  - `transactions` PaymentIntentTransaction[], required: List of transactions associated with this payment intent. Only populated on retrieve, not on list or webhook payloads.
    - `uid` string, uuid, required
    - `amount` string, decimal, required
    - `addenda` string, nullable
    - `type` 'transaction' | 'draft' | 'external', required: * `transaction` - Transaction * `draft` - Draft * `external` - External
    - `payment_method` 'ach' | 'book' | 'credit_card' | 'check_deposit' | 'card_repayment' | 'uncontrolled' | 'card_payment_intent' | 'push_to_card' | 'astra_account_to_card' | 'check_payment' | 'interest' | 'legacy' | 'email' | 'direct_deposit' | 'instant_payment' | 'check' | 'cash' | 'bank_transfer' | 'discount' | 'other', required: * `ach` - Ach * `book` - Book * `credit_card` - Credit Card * `check_deposit` - Check Deposit * `card_repayment` - Card Repayment * `uncontrolled` - Uncontrolled * `card_payment_intent` - Card Payment Intent * `push_to_card` - Push To Card * `astra_account_to_card` - Astra Account To Card * `check_payment` - Check Payment * `interest` - Interest * `legacy` - Legacy * `email` - Email * `direct_deposit` - Direct Deposit * `instant_payment` - Instant Payment * `check` - Check * `cash` - Cash * `bank_transfer` - Bank Transfer * `discount` - Discount * `other` - Other
    - `date` string, date-time, required
    - `preprocessed_at` string, date-time
    - `processed_at` string, date-time
    - `posted_at` string, date-time
    - `settled_at` string, date-time
    - `returned_at` string, date-time
    - `status` 'ReturnedTransaction' | 'RefundedTransaction' | 'CanceledTransaction' | 'ReturnTransaction' | 'RefundTransaction' | 'PendingCredit' | 'AcceptedCredit' | 'ProcessedCredit' | 'PaidDebit' | 'ProcessedDebit' | 'SettledDebit' | 'OnHold' | 'Error' | 'DraftCredit' | 'ExternalCredit', required: * `ReturnedTransaction` - Returned Transaction * `RefundedTransaction` - Refunded Transaction * `CanceledTransaction` - Canceled Transaction * `ReturnTransaction` - Return Transaction * `RefundTransaction` - Refund Transaction * `PendingCredit` - Pending Credit * `AcceptedCredit` - Accepted Credit * `ProcessedCredit` - Processed Credit * `PaidDebit` - Paid Debit * `ProcessedDebit` - Processed Debit * `SettledDebit` - Settled Debit * `OnHold` - On Hold * `Error` - Error * `DraftCredit` - Draft Credit * `ExternalCredit` - External Credit
    - `direction` 0 | 1, required: `0`: Inbound, `1`: Outbound

## Other responses

- `404`
- `422`

---

[API](https://skmtc.dev/trusspayments/apis/truss-api.md) - [All operations](https://skmtc.dev/trusspayments/apis/truss-api/llms.txt) - [OpenAPI document](https://skmtc.dev/trusspayments/apis/truss-api/revisions/370e29ce37ac?raw)