Resources Coming Soon

Early preview

Real-Time Payments are coming soon. This preview gives you an early look at the expected experience so you can begin planning your integration.

Realtime Received Payment

RealtimeReceivedPayment is a JSON:API resource, top-level fields:

Name	Type	Description
id Required	string	Identifier of the received payment resource.
type Required	string	Type of the received payment resource. The value is always realtimeReceivedPayment.
attributes Required	JSON Object	JSON object representing the received payment data.
relationships Required	JSON:API Relationships	Describes relationships between the received payment resource and other resources (account, customer, transaction).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the received payment was created. Common to all receive payment types.
status Required	string	The status of the Received Payment. One of Pending, Completed, Returned, Rejected, or TimedOut. See Received Payment Statuses.
amount Required	integer	The amount (cents) of the RTP received payment.
description Required	string	Payment description / remittance information.
counterparty Required	Counterparty	The party on the other end of the transaction. For RTP received payments, this is always the originator (in ISO20022 terminology this is referred to as the Debtor).
returnReason Optional	string	Present when status is Returned. See RTP return reasons.
rejectReason Optional	string	Present when status is Rejected. See RTP reject reasons.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	Optional, JSON:API Relationship	The Customer the deposit account belongs to, business or individual.
receivePaymentTransaction Required	Optional, JSON:API Relationship	The Received Realtime Payment Transaction created when the RTP is completed.

Example RealtimeReceivedPayment resource:

{
  "type": "realtimeReceivedPayment",
  "id": "30176752",
  "attributes": {
    "createdAt": "2026-07-10T22:43:34.385Z",
    "status": "Completed",
    "amount": 6911520,
    "description": "Invoice 4821",
    "counterparty": {
      "name": "WFG NATL TITLE CO OF",
      "routingNumber": "121000248",
      "accountNumber": "9876543210"
    },
    "tags": {}
  },
  "relationships": {
    "account": {
      "data": {
        "type": "account",
        "id": "2150353"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "1802611"
      }
    },
    "receivePaymentTransaction": {
      "data": {
        "type": "transaction",
        "id": "9547"
      }
    }
  }
}

Received Realtime Payment Transaction

ReceivedRealtimePaymentTransaction is a JSON:API resource, top-level fields:

Name	Type	Description
id Required	string	Identifier of the transaction resource.
type Required	string	Type of the transaction resource. The value is always receivedRealtimePaymentTransaction.
attributes Required	JSON Object	JSON object representing the transaction data.
relationships Required	JSON:API Relationships	Describes relationships between the transaction resource and other resources (account, customer, received payment).

Attributes

Name	Type	Description
createdAt Required	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction Required	string	The direction in which the funds flow. Common to all transaction types.
amount Required	integer	The amount (cents) of the transaction. Common to all transaction types.
balance Required	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary Required	string	Summary of the transaction. Formatted as RTP from {counterparty.name}.
description Required	string	Payment description / remittance information.
counterparty Required	Counterparty	The party on the other end of the transaction. For RTP received payments, this is always the originator.
tags Required	object	See Tags.

Relationships

Name	Type	Description
account Required	JSON:API Relationship	The Deposit Account of the customer.
customer Required	Optional, JSON:API Relationship	The Customer the deposit account belongs to. This relationship is only available if the account belongs to a single customer, business or individual.
customers Required	Optional, Array of JSON:API Relationship	The list of Customers the deposit account belongs to. This relationship is only available if the account belongs to multiple individual customers.
receivedPayment Required	JSON:API Relationship	The Realtime Received Payment the transaction belongs to.

Example ReceivedRealtimePaymentTransaction resource:

{
  "type": "receivedRealtimePaymentTransaction",
  "id": "9547",
  "attributes": {
    "createdAt": "2026-07-10T22:43:34.385Z",
    "direction": "Credit",
    "amount": 6911520,
    "balance": 6911520,
    "summary": "RTP from WFG NATL TITLE CO OF",
    "description": "Invoice 4821",
    "counterparty": {
      "name": "WFG NATL TITLE CO OF",
      "routingNumber": "121000248",
      "accountNumber": "9876543210"
    },
    "tags": {}
  },
  "relationships": {
    "account": {
      "data": {
        "type": "depositAccount",
        "id": "2150353"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "1802611"
      }
    },
    "receivedPayment": {
      "data": {
        "type": "receivedPayment",
        "id": "30176752"
      }
    }
  }
}