Create a RTP RfP

Creates a new RTP request for payment

Log in to see full request history
Body Params

RTP request for payment body

boolean

If set to true, the request for payment receiver can approve a modified amount, if false, the approved amount must be the requested amount. The default value is false.

uuid
required

The unique ID (RFC-4122 UUID) of the bank account enrollment to use in conjunction with this request for payment. This enrollment can be any enrollment from the current account or from any descendant account provided the routing number matches a routing number from the rtp rfp presentment enrollment list.

string
length ≤ 250

Up to 250 chars of additional information about the transaction only visible to you.

string
length ≤ 35

Up to 35 chars representing an invoice number associated to the request for payment.

string
length ≤ 140

Memo modifier to be substituted into the request for payment presentment memo field. The memo modifier formatting code is %[0-14-]m, see rtp_rfp_presentment memo field for details.

uuid
required

The unique ID (RFC-4122 UUID) of the party that the request for payment message is being delivered to and funds will be transfered from.

string
length ≤ 35

Up to 35 chars of an arbitrary string defining the customer reference number, bill ID or invoice ID. Often useful for displaying to users. If this is left undefined, the network will populate this field.

int64
required
≥ 0

The amount requested.

requested_execution_date
object

The requested date to pay the RfP by.

uuid
required

The unique ID (RFC-4122 UUID) of the rtp_rfp_presentment that that is being displayed to the party. This presentment must be associated to the account that is calling this api, the account that the enrollment is associated to if a descendant enrollment is used, or if no descendant enrollment is used must be associated to a descendant account.

int64
required
≥ 0

Time to live in seconds.

uuid

The unique ID (RFC-4122 UUID) of the party that the request for payment message is ultimately being sent to. This field is informational and used by the receiver to account for the final destination of the request for payment message. This party must be associated with the account the party is associated with.

uuid

The unique ID (RFC-4122 UUID) of the party that the request for payment message is ultimately being sent from. This party must be associated with the account that the enrollment is associated with. This is only usable if the account has the intermediary_rtp_v_2_9 or intermediary_rtp_v_3_0 capability activated.

Headers
integer
0 to 30000

The amount of time in milliseconds to wait on a final status response. If this header is provided, the system will block until either the status is updated to a final response of rejected, failed, timed_out, waiting or the time value is exceeded. If the time value is matched or exceeded, then the X-TRICE-WAIT-FOR header will be included in the response with the time in milliseconds that elapsed on the system, otherwise the response header will be omitted. Note that this time may be longer than the initial header value because the system will always execute until the message is send to the network. If the time value submitted in the header is 0, then the system will block until there is a final response or the maximum system timeout of 30 seconds is reached.

uuid

A parent account can include this header as reference to the descendent account being operated on.

Responses

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json