Integration: Inbound Payment Intents
Inbound Payment Intents

Cancel inbound payment intent

Cancel an inbound payment intent

Required Scopes:

payment_intent.inbound:write transactions:read

post/v1/payment-intents/inbound/{uid}/cancel/

Request

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

Path parameters

uidstring uuid required

The uid of the payment intent

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.