Skip to main content

Resources Coming Soon

Early preview

Realtime Payments are coming soon. This resource model reflects the current API preview and may evolve before launch.

Realtime Payment

RealtimePayment is a JSON:API resource with the following top-level fields:

NameTypeDescription
id RequiredstringIdentifier of the Realtime Payment resource.
type RequiredstringType of the payment resource. The value is always realtimePayment.
attributes RequiredJSON objectData describing the Realtime Payment.
relationships RequiredJSON:API RelationshipsRelationships between the payment and its originating account and customer.

Attributes

NameTypeDescription
createdAt RequiredRFC3339 date stringDate and time when the resource was created.
status RequiredstringCurrent payment status. A newly created Realtime Payment has a Pending status.
counterparty RequiredRealtime CounterpartyParty receiving the Realtime Payment.
description RequiredstringPayment description, up to 50 characters. This appears on the counterparty's statement.
direction RequiredstringDirection in which the funds move. The value is always Credit.
amount RequiredintegerPayment amount in cents.
tags RequiredobjectSee Tags. Tags are inherited by transactions created by the payment.

Relationships

NameTypeDescription
account RequiredJSON:API RelationshipDeposit Account originating the payment.
customer RequiredJSON:API RelationshipCustomer that owns the originating account.
Example RealtimePayment resource:
{
"data": {
"type": "realtimePayment",
"id": "50",
"attributes": {
"createdAt": "2026-01-13T16:01:19.346Z",
"status": "Pending",
"counterparty": {
"routingNumber": "812345673",
"accountNumber": "12345569",
"accountType": "Checking",
"name": "Acme Corporation"
},
"description": "Realtime Payment",
"direction": "Credit",
"amount": 500000,
"tags": {
"purpose": "internal"
}
},
"relationships": {
"account": {
"data": {
"type": "depositAccount",
"id": "555"
}
},
"customer": {
"data": {
"type": "businessCustomer",
"id": "99823"
}
}
}
}
}

Realtime Counterparty

The counterparty attribute identifies the party receiving the Realtime Payment.

NameTypeDescription
routingNumber RequiredstringNine-digit ABA routing number of the receiving bank. The bank must be able to receive payments through the RTP network.
accountNumber RequiredstringBank account number of the receiving party.
accountType RequiredstringType of the receiving account, such as Checking.
name RequiredstringName of the receiving party.

Realtime Payment Transaction

When a Realtime Payment is sent, Unit creates a Realtime Payment Transaction representing the movement of funds from the originating Deposit Account.

Tags on the Realtime Payment are copied to the transaction. See Tag Inheritance. Transaction details are available through Unit's Transactions API.