Creating Transactions

Create an Instant RTP Transaction

To create an Instant RTP transaction, use the following endpoint:

POST /api/v3/InstantRtpTransactions/companycode/{companyCode}

waitSeconds is an optional query string parameter that represents the amount of seconds you’re willing to wait for the transaction to be processed. The maximum value is 300 seconds.

The request parameters include:

name: Recipient’s full name or business name.
firstName and lastName: Optional name components. FLEX derives them from name when omitted.
routingNumber: Recipient’s bank routing number.
accountNumber: Recipient’s bank account number.
amount: Transaction amount.
yourReferenceNumber: Your identifier for tracking the transaction.

The response contains a transaction object with:

uniqueId: Unique identifier for the transaction.
yourReferenceNumber: Your identifier supplied in the request.
name: Recipient’s full name or business name.
firstName and lastName: Recipient’s name.
routingNumber: Recipient’s bank routing number.
accountNumber: Recipient’s masked bank account number.
amount: Transaction amount.
receivedDateTime: Date and time we received the transaction, in UTC.
completedDateTime: Date and time processing completed, in UTC; this will be null while pending.
status: Transaction outcome: Success, Pending, or Failed.
statusCode: Detailed result code.
statusDescription: Text description of the result.
endToEndIdentifier: Bank transfer identifier; it may be null if no transfer was initiated.
requestReturnReceivedDateTime, requestReturnCompletedDateTime, and requestReturnStatus: Return request information; normally null when the transaction is first created.
requestReturnStatusCode and requestReturnStatusDescription: Detailed return request result information.
requestReturnEndToEndIdentifier: Bank transfer identifier for a return request, if one is submitted.