Resources

Real-Time Received Payment

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

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

Attributes

Name	Type	Description
createdAt	RFC3339 Date string	The date the received payment was created. Common to all receive payment types.
status	string	The status of the Received Payment. One of Pending, Completed, Returned, Rejected, or TimedOut. See Received Payment Statuses.
amount	integer	The amount (cents) of the RTP received payment.
description	string	Payment description / remittance information.
counterparty	Real-Time 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).
endToEndId	string	The end-to-end Identification refers to the Identification between the Originator and Receiver that refers to the payment itself.
unstructuredRemittanceInformation	string	Free-text remittance information provided with the payment.
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	object	See Tags.

Relationships

Name	Type	Description
account	JSON:API Relationship	The Deposit Account of the customer.
customer	Optional, JSON:API Relationship	The Customer the deposit account belongs to, business or individual.
receivePaymentTransaction	Optional, JSON:API Relationship	The Real-Time 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"
    },
    "endToEndId": "E2E-INV-482173918420561749302846175",
    "unstructuredRemittanceInformation": "Invoice 4821",
    "tags": {}
  },
  "relationships": {
    "account": {
      "data": {
        "type": "account",
        "id": "2150353"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "1802611"
      }
    },
    "receivePaymentTransaction": {
      "data": {
        "type": "transaction",
        "id": "9547"
      }
    }
  }
}

Real-Time Payment Transaction

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

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

Attributes

Name	Type	Description
createdAt	RFC3339 Date string	The date the transaction was created. Common to all transaction types.
direction	string	The direction in which the funds flow. Common to all transaction types.
amount	integer	The amount (cents) of the transaction. Common to all transaction types.
balance	integer	The account balance (cents) after the transaction. Common to all transaction types.
summary	string	Summary of the transaction. Built from the counterparty name and the unstructured remittance information: {counterparty.name} | {unstructuredRemittanceInformation} when both are present, only the one that is present otherwise, and Incoming Real-Time Payment when neither is available.
endToEndId	Optional, string	The end-to-end identification assigned by the initiating party to uniquely identify the transaction. If the sender did not provide a reference, the value may be NOREF.
unstructuredRemittanceInformation	Optional, string	Unstructured remittance information supplied by the sender to help match the payment with the items it settles, such as commercial invoices.
tags	object	See Tags.

Relationships

Name	Type	Description
account	JSON:API Relationship	The Deposit Account of the customer.
customer	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	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	JSON:API Relationship	The Real-Time Received Payment the transaction belongs to.

Example RealtimePaymentTransaction resource:

{
  "type": "realTimePaymentTransaction",
  "id": "9547",
  "attributes": {
    "createdAt": "2026-07-10T22:43:34.385Z",
    "direction": "Credit",
    "amount": 6911520,
    "balance": 6911520,
    "summary": "WFG NATL TITLE CO OF | Invoice 4821",
    "endToEndId": "E2E-Ref001",
    "unstructuredRemittanceInformation": "Invoice 4821",
    "tags": {
      "discountCode": "VIP30"
    }
  },
  "relationships": {
    "account": {
      "data": {
        "type": "depositAccount",
        "id": "2150353"
      }
    },
    "customer": {
      "data": {
        "type": "customer",
        "id": "1802611"
      }
    },
    "receivedPayment": {
      "data": {
        "type": "receivedPayment",
        "id": "30176752"
      }
    }
  }
}