Retrieve RTP RfPs

get https://api-sandbox.trice.co/hub/v1/rtp_rfps

Retrieves a collection of RTP request for payments

Query Params

limit

integer

≥ 0

A limit on the number of objects to be returned, between 1 and 100.

starting_after

integer

≥ 0

A cursor for use in pagination. offset is an index value that defines your place in the list. For instance, if you make a list request and receive 100 objects, your subsequent call can include starting_after=100 in order to fetch the next page of the list.

created_after

string

Formatted timestamp (YYYY-MM-DD[ HH:MM:SS]) with optional HH:MM:SS to filter results that were created after.

created_before

string

Formatted timestamp (YYYY-MM-DD[ HH:MM:SS]) with optional HH:MM:SS to filter results that were created before.

reference_number

string

length ≤ 200

String to filter results by. The filter is case insensitive and a wild card operator '%' can be used to match any string part.

internal_description

string

length ≤ 200

String to filter results by. The filter is case insensitive and a wild card operator '%' can be used to match any string part.

invoice_number

string

length ≤ 200

String to filter results by. The filter is case insensitive and a wild card operator '%' can be used to match any string part.

Headers

X-TRICE-ACCOUNT

uuid

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

Responses

Response body

object

has_more

boolean

Whether or not there are more elements available after this set. If false, this set comprises the end of the list.

object

string

A string describing the object type returned.

url

string

The URL for accessing this list.

data

array of objects

An array containing the actual response elements, paginated by any request parameters.

data

object

amount_modification_allowed

boolean | null

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.

approved

string | null

Formated timestamp (YYYY-MM-DD HH:MM:SS) determining when the real time payment rfp was approved.

canceled

string | null

Formated timestamp (YYYY-MM-DD HH:MM:SS) determining when the real time payment rfp was canceled.

created

string

Formated timestamp (YYYY-MM-DD HH:MM:SS) determining when the real time payment rfp was created.

declined

string | null

Formated timestamp (YYYY-MM-DD HH:MM:SS) determining when the real time payment rfp was declined.

enrollment

object | null

The bank account enrollment to use in conjunction with request for payment transfer.

expired

string | null

Formated timestamp (YYYY-MM-DD HH:MM:SS) determining when the real time payment rfp expired.

uuid

Unique real time payment transfer id (RFC-4122 UUID).

internal_description

string | null

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

invoice_number

string | null

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

memo_modifier

string | null

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.

paid

string | null

Formated timestamp (YYYY-MM-DD HH:MM:SS) determining when the real time payment rfp was paid.

party

object

The party that the request for payment message is being delivered to and funds will be transfered from.

payable_account

object | null

The account that the request for payment message would ultimately be paid to.

reference_number

string | null

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.

request_amount

int64

≥ 0

The amount requested.

request_fee

int64

≥ 0

The real time payment request for payment fee.

requested_execution_date

object | null

The requested date to pay the RfP by.

rtp_rfp_presentment

object | null

The RfP presentment data that is being presented to the party.

rtp_transfer

object | null

After approval, this is the associated real time payment transfer

sender

object | null

The account whos data will be used to send the rfp. If this is null the data of the account associated with this rfp will be used.

state_details

object | null

If present, contains the request for payment status data from the network.

status

string

Current status of the real time payment rfp: created, rejected, processing, failed, timed_out, waiting, approved declined, canceled, expired, or paid.

A request for payment is: created if pre-checks are passed. Pre-checks may determine the request for payment is rejected. When the request for payment is sent to the network it is then processing. If the request for payment fails network checks it will become failed. If the receiving participant failed to provide a response within the network SLA it will become timed_out. Otherwise it will then become waiting when the recipient is notified of the request for payment until it is responded to, canceled or or expires. If the sender canceled the request for payment, the status changes to canceled The status then changes to approved if the request for payment is approved by the party or to declined if declined by the party. The status is set to expired if the request for payment is not responded to prior to the expiration window. The status is set to paid if the request for payment is paid.

created rejected processing failed timed_out waiting approved declined canceled expired paid

ttl

int64

≥ 0

Time to live in seconds.

type

string

The type of request for payment: outbound or inbound. A request for payment is outbound when sent from the account to an external party. A request for payment is inbound when received by an account from an external party.

outbound inbound

ultimate_receiving_party

object | null

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.

ultimate_sending_party

object | null

Tthe party that the request for payment message is ultimately being sent from.

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api-sandbox.trice.co/hub/v1/rtp_rfps \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Get RTP request for payments OK

400Bad request

401Unauthorized

404Not found

502Bad gateway

defaultError