Initiates a request for payment (RfP)
Allows the recipient to authorize and trigger an instant payment credit transfer. RfPs can be initiated from:

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

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

accountNumber

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.

clientIdentifier

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

amount

The Instant Payments-related Cross River 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 the memo post was 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.

debtor

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.

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

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.

remittanceData

paymentInfoId

reqExecutionDate

expiryDate

paymentConditions

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

purpose

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 Cross River and identifies the Cross River account involved in the transfer.

productId

Your unique ID in the Cross River system. This ID is in GUID format.

partnerId

Internal Cross River value. Date and time the database entry was last modified. In this case, the date and time are in this format: 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

CrossRiver test page

CrossRiver test page 2

LIST

Paralelipiped

Spaces_variables

asdas

var1

test_var2

test_var

asdasdas

asdasd

What

New_reusable

dasdas555

aa112

test12

sdfdssdfsdfsdfsdfdsfsdf

edfsad

dsfsdfsdf

test

specific

var_miha

new_var_2

new_mih_var

mih_var

testheight

available

testulet

testvar

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

altscenario

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

scenario

exemplu

variabila

Archbee

text

refresh_token

YourBank

MyBank

variable_test_video

variable123

silviu

Bogdan_test

ferwhethgte

target1

google

support

product_name

insitutionAdress

productName1

companyLegalName

programName

customerName1

productName

Product_Name

Test

SEFAS

uptempo

customerName

testName

name1

customername

apilink1-getallmethod

variable_one

capitalize

company_name_adobe

jama_2

jama_1

domain

email

product

Glossary lets you define every tricky term, then gives them a sneak peek explanation on hover... Just like I'm doing with this text right here!

Glossary_feature

Google

aaaa

HIDDEN

DoNotPrint

FeatureFlag

ITSM

Info

Your documentation's source code where all files and their history are stored. The web editor connects to your documentation repository to access and modify content, or you can edit files locally in your preferred IDE.

repositoryyyyy

TestVASVariable

Are like departments for your users. You can create different groups (like Engineers, Marketing, or Management) and assign users to them. This helps you organize your users and give them different access levels to different parts of your organization

User_Groups

Connect multiple published Spaces for easy navigation between docs (e.g., User Guides, API docs). Add links in Space settings, label them, and publish. Changes to links automatically update across connected Spaces. 

Space_Links

Think of them as folders for your Spaces. You start with one called "Spaces." Make more folders if you need them. You can add, rename, or delete folders (but only if they're empty). To put a Space in a folder, just drag it there, use the move action,

Space_Group

Containers for documents organized by teams or projects. Each account has a personal space, and organizations can create custom ones with access control.

Spaces

Building blocks for your docs. Think of them as Legos for your content. You can use them to create headings, tables, images, code snippets, and more. There are basic, media, developer, and embedded blocks to choose from.

CrossRiver test page 2

API reference