TRtrusspayments
Integration: Inbound Payment Intents
Inbound Payment Intents

Create inbound payment intent

Create an inbound payment intent (invoice)

Required Scopes:

payment_intent.inbound:write transactions:read

post/v1/payment-intents/inbound/

Request

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

Request body

totalstring decimal required

The total amount due for the payment intent. Must be greater or equal to 1.00.

addendastring required

Payment intent description, which will also be used as the addenda on any payments made on the payment intent.

notestring

A note to the payee/customer.

memostring

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.

send_emailboolean

If true, the customer will receive an email notification letting them know the payment intent is available to pay with a payment portal link.

send_smsboolean

If true, the customer will receive a sms notification letting them know the payment intent is available to pay with a payment portal link.

wallet_uidstring uuid

The uid of the company wallet that should receive the payment. Omit to use the company's primary wallet.

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.