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:
| Name | Type | Description |
|---|---|---|
| id Required | string | Identifier of the Realtime Payment resource. |
| type Required | string | Type of the payment resource. The value is always realtimePayment. |
| attributes Required | JSON object | Data describing the Realtime Payment. |
| relationships Required | JSON:API Relationships | Relationships between the payment and its originating account and customer. |
Attributes
| Name | Type | Description |
|---|---|---|
| createdAt Required | RFC3339 date string | Date and time when the resource was created. |
| status Required | string | Current payment status. A newly created Realtime Payment has a Pending status. |
| counterparty Required | Realtime Counterparty | Party receiving the Realtime Payment. |
| description Required | string | Payment description, up to 50 characters. This appears on the counterparty's statement. |
| direction Required | string | Direction in which the funds move. The value is always Credit. |
| amount Required | integer | Payment amount in cents. |
| tags Required | object | See Tags. Tags are inherited by transactions created by the payment. |
Relationships
| Name | Type | Description |
|---|---|---|
| account Required | JSON:API Relationship | Deposit Account originating the payment. |
| customer Required | JSON:API Relationship | Customer 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.
| Name | Type | Description |
|---|---|---|
| routingNumber Required | string | Nine-digit ABA routing number of the receiving bank. The bank must be able to receive payments through the RTP network. |
| accountNumber Required | string | Bank account number of the receiving party. |
| accountType Required | string | Type of the receiving account, such as Checking. |
| name Required | string | Name 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.