/outgoing/rtp - POST

post

https://cubi-sandbox-api.customersbank.com/InstantPayments/v1/outgoing/rtp

Initiates a payment on the RTP rail. This method exists to allow for direct RTP initiation, however, in most cases it's prefferable to use the rail agonistic POST /outgoing api to allow for rail flexibity when sending to the receiver bank.

Body Params

amount

double

required

≥ 0.01

Amount of Payment, in dollars and cents

processDate

date-time | null

Optional date and time on which to process the payment, if not specified, it will be sent immediately. If specified, it must be today's date or a future date. If specified, then submission as a full datetime plus timezone offset is HIGHLY recommended over submission as a simple date string, as omission of time will default to midnight and omission of timezone offset will default to UTC. Format: yyyy-MM-ddTHH:mm:ss.ffZ

senderAccountNumber

string

required

length between 1 and 35

The account number from which to send the payment

receiverRoutingNumber

string

required

length ≥ 1

Routing number of the receiving bank. This must be a federal ABA number, must be exactly 9 digits.

receiverAccountNumber

string

required

length between 1 and 35

The account number of the receiver.

receiverName

string

required

length between 1 and 35

The name of the receiving party

receiverAddress1

string

required

length between 1 and 35

The primary address line of the receiving party

receiverAddress2

string | null

The secondary address line of the receiving party (optional). Maximum length is 35 characters.

receiverCity

string

required

length between 1 and 35

The city of the receiving party

receiverState

string

required

length between 1 and 35

The state or region of the receiving party

receiverZip

string

required

length between 1 and 35

The postal/zip code of the receiving party

receiverCountry

string

required

length between 2 and 2

The country code of the receiving party (ISO 3166-1 alpha-2 format)

description

string | null

Description to be passed in the payment. Maximum length is 140 characters.

Headers

x-idempotency-key

uuid

required

Unique request idenitfier for idempotency.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

202Accepted

400BadRequest

401Unauthorized

403Forbidden

404NotFound

500InternalServerError