Initiates a request for payment (RfP)
Allows the recipient to authorize and trigger an instant payment credit transfer. RfPs can be initiated from:
- Master account
- Deposit account (DDA)
- Associated subledger

Endpoint: /rtp/v1/payments/payment-request

accountNumber

Requested payment amount in positive integeral cents. For example, represent $1.00 as 100.

amount

Internal CR field used to include a short description or purpose for the payment request. The RDFI does not see this field. 50 characters maximum.

purpose

Date when the payment request needs to be processed by the Debtor. Formatted as yyyy-mm-ddThh:mm:ss[.mmm].

requestedExecutionDate

Expiration date and time of the RfP. If no time is specified, it expires at 12:00 AM on the given date. If a time is provided, it expires within one hour after the specified time on the same date. Formatted as yyyy-mm-ddThh:mm:ss[.mmm].

expiryDate

Use this attribute to add your own unique identifying string to a payment call or COS record. This attribute is useful for idempotency purposes. 50 characters maximum.

clientIdentifier

A description of the payment request, meaning, the remittance advice. Use this field for any remittance information that doesn't have its own field. 140 characters maximum.

remittanceData

remittanceLocation

Debtor Business/Individual Information. The recipient of the RfP who will initiate the credit transfer upon authorization. Depending on the configuration, this information may be populated automatically.

debtor

Ultimate Debtor Business/Individual Information. The final party receiving the RfP and responsible for initiating the credit transfer upon authorization. 

ultimateDebtor

Creditor Business/Individual Information. The recipient of the payment, typically the party at CRB initiating the RfP. Depending on the configuration, this information may be populated automatically.

creditor

Ultimate Creditor Business/Individual Information. The final recipient of the payment. Depending on the configuration, this information may be populated automatically.

ultimateCreditor

Use one of the following values for the useCase field:

-BusinessToBusiness
-ConsumerBillPay
-AccountToAccount
-DownPaymentOrFinalPayment
-ConsumerToGovernment

useCase

Use one of the following values for the industryCategory field (optional when useCase is BusinessToBusiness or ConsumerToGovernment):

-HomeUtilities
-TelecomUtilities
-Mortgage
-Rent
-InsurancePremiums
-AutoLoans
-PersonalLoans
-CreditCardPayment
-MediaSubscriptions
-Memberships
-FinancialInstitution
-BrokerOrDealer
-Medical
-OnlineGaming
-RealEstate
-Government

industryCategory

Use the senderId field (optional when useCase is BusinessToBusiness or ConsumerToGovernment), provided by Cross River and generated by The Clearing House (TCH).

Valid senderID's for Sandbox Testing:
-100000000001
-100000000002
-100000000003
-100000000004
-100000000005

senderID

The payment ID. This first appears in the initial response to the originate a payment request. This ID is in GUID format.

Original payment ID (only relevant if a payment didn't go through for some reason).

originalPaymentId

This unique Cross River reference ID starts with the first letter of the payment rail. For Instant Payments, the ID begins with R to reflect the RTP API module.

referenceId

A unique identifier assigned to the payment call or COS record. This value reflects the identifier provided in the original request and helps ensure idempotency.

Dollar amount of payment request in positive integral cents. For example, write $1.00 as 100.

The Instant Payments-related CR system transaction ID

operatorCoreTransactionId

The ID of an authorization transaction created when Cross River receives an inbound credit transfer that refunds a previously sent outbound transfer. This authorization confirms that Cross River can post the transaction to the creditor’s (receiver’s) COS account (e.g., no restrictions or account closures) and allows Cross River to notify the real-time payment network of acceptance.

authorizationTransactionId

memoPostId

The date and time of the memo post have been removed


memoPostRemovedAt

Outbound for an outbound payment request or Inbound for an inbound payment request.

direction

Transaction status:

-Created
-Pending
-Processing
-Completed
-Rejected
-Canceled
-Hold
-TimedOut
-Finalizing
-Failed
-ResearchRequired
-Expired
-Authorized

status

Type of payment indicating how the transaction is funded:

-RequestForPayment

paymentType

source

Transaction account context:

-NotSubmitted
-Pending
-Processing
-Complete
-Reversal
-MemoPost
-TimedOut
-Canceled
-Rejected
-AuthOnly
-NotSet

transactionAccountContext

The payment status set by the receiving institution, applicable to Credit Transfers.

This value is only present for outbound payments. See available values here.

rtpTransactionStatus

Debtor business/individual information. – The recipient of the RfP who will initiate the credit transfer upon authorization. Depending on the configuration, this information may be populated automatically.

Ultimate debtor business/individual information. The final party responsible for initiating the credit transfer upon authorization. This information may be populated automatically based on the configuration.

Creditor business/individual information. The recipient of the payment, typically the party at CRB initiating the RfP. Depending on the configuration, this information may be populated automatically.


Ultimate creditor business/individual information. The final recipient of the payment. Depending on the configuration, this information may be populated automatically.

network

remittanceAdvice

transactionInfo

Indicates a pre-arranged service or service level agreed upon between the parties

serviceLevelCode

Specifies whether the Debtor is a business or consumer customer of the Debtor FI. This element also indicates if the Debtor is a domestic customer of the Debtor FI or a customer of a foreign branch or affiliate.

localInstrumentPropriety

Details from the initiating party regarding payment processing, based on predefined categories. Certain values may initiate special processing by various parties involved in the payment chain.

categoryPurpose

initiatingPartyName

currency

Indicates the party (or parties) responsible for bearing the charges related to processing the payment request.

chargeBearer

A unique identifier assigned by the initiating party to clearly distinguish the remittance information sent separately from the payment instruction, such as remittance advice.

remittanceIdentification

A description of the payment request, serving as the remittance advice. This field is used for any remittance information that does not have a designated field.

paymentInfoId

reqExecutionDate

paymentConditions

Internal CR field used to include a short description of the purpose of the payment. The RDFI does not see this field. 

Indicates whether the payment was refunded. True if refunded, otherwise False.

wasRefunded

Indicates whether the payment was received. True if received, otherwise False.

wasPaid

The date and time when the credit transfer was created, formatted as yyyy-mm-ddThh:mm:ss[.mmm]

createdAt

The GUID representing the ID of your specific product type associated with the account. This is provided by CR and identifies the CR account involved in the transfer.

productId

Your unique ID within the CR system, provided in GUID format

partnerId

An internal CR value indicating the date and time the database entry was last modified, formatted as yyyy-mm-ddThh:mm:ss[.mmm]

lastModifiedAt

The total count of attempts to send the payment request

sendAttemptCount

Discounts array specifies applicable discounts for the request.

discounts

Indicates whether a message response is pending. True if waiting, otherwise False.


awaitingResponse

The payment network platform used to process the payment. Possible values are: TCH (for RTP via The Clearing House)

networkPlatform

Credit transfer

Payment request

The automated lending platform from Cross River that includes services such as Preapproval, Oversight, Arix Origination and Funding, Selling, and Hooks.

Lending

Information that can be used to distinguish or trace an individual’s identity, either alone or when combined with other information that is linked or linkable to a specific individual. Also known as PII.

Personally_Identifiable_Information

These are contracts for monetary assets that can be purchased, traded, created, modified, or settled for. In terms of contracts, there is a contractual obligation between involved parties during a financial instrument transaction.

financial_instrument

Interest Rate Cards are pre-configured interest rate profiles that can be assigned to specific accounts on demand.

rate_card

A financial institution holding a principal license with a Card Network has the right to issue cards itself and sponsor other institutions (fintechs) to issue on its behalf (BIN sponsorship). Affiliate/Associate members cannot offer BIN sponsorship.

Principal_member

A 6 or 8 digit number assigned by the card networks for card issuing and functions as the first 6 or 8 digits on the card itself. The BIN identifies the bank that is responsible for issuing the program and handling daily settlement with the Network.

Card_BIN

A solution that allows partners to offer card solutions without requiring a direct relationship with the card networks. The bank acts as an intermediary while allowing partners to use its bank identification numbers (BIN). 

BIN_sponsorship

Politically Exposed Person is an individual who holds a prominent public position, or has done so in the recent past and is subject to a higher level of scrutiny due to an increased risk of involvement in bribery, corruption, and money laundering.

Office of Foreign Assets Control. Part of the US Department of the Treasury that administers and enforces economic and trade sanctions based on US foreign policy and national security goals.

OFAC

Move funds internally between accounts. The transfer requires both a debit and credit account and can be either a master account or sub-ledger, or any combination of the two.  Can be made via API calls or for non-API Partners on the COS Explorer.

book_transfer

This is where the financial institution verifies the member has the funds needed before they are transferred to the receiver.

Good_Funds_Model

An instant payment service developed and operated by the Federal Reserve for financial institutions in the United States, which allows individuals and businesses to send and receive money.

FedNow

A payment processing network used to send money electronically between banks in the US. Available year round, it transfers funds between 2 banks account instantaneously. Processes on bank holidays and weekend and after business hours.

A merchant category code (MCC) is a four-digit number used for retail financial services to classify a business by the types of goods or services it provides. Codes are specified by the ISO 18245 standard.

Card Acceptor ID. An internal identifier assigned to your business by your Acquirer when creating the merchant account used for financial processing.

CAID

Business Application Identifier, used by merchants in card payments

The automated loan validation and funding software from Cross River

Arix

Mobile Deposit Capture is the process of submitting a check electronically using a smartphone

Input Message Accountability Data. A unique number given to each FedWire payment when using the Federal Reserver Bank Service and can be used to investigate and track wire transfers.

IMAD

Notification of Change.  The purpose of an NOC is to identify and communicate incorrect information within an ACH entry, such as account numbers or transit and routing number. Sent by a RDFI to the ODFI and the Originator via their ACH Operator.

A global financial messaging standard for electronic payments. It enhances interoperability across financial systems, improves payment processing efficiency and supports compliance by providing detailed transaction information.

ISO20022

A SWIFT Code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. These codes are used when transferring money between banks, particularly for international wire transfers.

SWIFT

Receiving Depository Financial Institution. All ODFIs must also agree to act as an RDFI to receive ACH payments. An RDFI receives entries directly or indirectly from its ACH Operator for debit or credit to the accounts of its customers.

RDFI

Originating Depository Financial Institution. It has the authority to initiate ACH transactions on behalf of its customers. ODFIs ensure compliance with regulatory standards and securely transmit payment instructions to the ACH network

ODFI

 National Automated Clearing House Association. Nacha governs the ACH Network, the payment system that drives Direct Deposits and Direct Payments with the capability to reach all U.S. bank and credit union accounts

Nacha

International ACH Transaction. A Nacha SEC code.

A uniquely configured financial product you offer your customers. For example, a debit card or a savings account, configured according to your needs and specifications, are product types.

product_type

Bank Identification Number. A unique identifier used in payment card transactions.

COS_Explorer

relationshipmanager

Cross River guides provide details about our products

guide

var_miha

new_var_2

new_mih_var

mih_var

This is a plain text that will be inserted in an expandable heading for using this raw as an exampl

testheight

available

testulet

testvar

altscenario

This is a plain text that will be inserted in an expandable heading for using this raw as an example