TRtrusspayments
Integration: Inbound Payment Intents
Inbound Payment Intents

Update inbound payment intent

Update a user's inbound payment intent

Required Scopes:

payment_intent.inbound:write transactions:read

patch/v1/payment-intents/inbound/{uid}/

Request

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

Path parameters

uidstring uuid required

The uid of the payment intent

Request body

totalstring 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.

addendastring

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.

notestring nullable

A note to the payee/customer. This field cannot be updated on fully paid or canceled payment intents.

memostring nullable

A private memo for internal use.

due_datestring 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.

resend_emailboolean

If true, the customer will receive an email notification letting them know the payment intent has been updated and is available to pay with a payment portal link. Email notifications cannot be resent on fully paid or canceled payment intents.

Response

uidstring uuid required
totalstring decimal required
addendastring required
direction0 | 1 required

0: Inbound, 1: Outbound

notestring nullable required
memostring nullable required
due_datestring date nullable required
wallet_uidstring 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.

statusstring required
balance_paidstring decimal required
checkout_urlstring 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_atstring date-time required
pending_atstring date-time nullable required
paid_atstring date-time nullable required
canceled_atstring date-time nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.