Create a RTP RfP presentment

post https://api-sandbox.trice.co/hub/v1/rtp_rfp_presentments

Creates a new request for payment presentment

Body Params

Request for payment presentments body

enrollments

array of strings

required

List of bank account enrollment ids to allow in conjunction with the request for payment.

enrollments*

industry_category_code

string

The Industry Category Codes used for Request for Payment:
1001 - Home Utilities - Electric, Gas, Sanitary, Water, Fuel Oil
1002 - Telecom Utilities - Phone, Internet, Cable, Satellite
1003 - Mortgage
1004 - Rent
1005 - Insurance Premiums
1006 - Auto Loans
1007 - Personal Loans
1008 - Credit Card Payment
1009 - Media Subscriptions - Music, Magazines, Newspapers, Gaming, etc.
1010 - Memberships - Gym, Lessons, Educational, Clubs, etc.
1011 - Financial Institution
1012 - Broker/Dealer
1013 - Medical
1014 - Online Gaming
1015 - Real Estate
1016 - Government

memo

string

required

length ≤ 140

Up to 140 chars of information about the request shared with the receiver. A memo_modifier set in the rtp_rfp can be used to customize this memo field with each request for payment. The modifier is substituted with the formatter %[0-140]m where the maximum length of the modifier to be substituted is determined in the numberical field. For example if you want to sub a maximum of 13 characters into the modider, then the formatter would be %13m. Any string in the memo_modifier field longer than 13 characters in this case will be truncated. Only one modifier can be used in the memo field.

phone

object

required

A publicly available phone number to call regarding billing issues.

use_case

string

required

The RTP use case for the presentment: business_to_business, account_to_account, bill_pay, down_payment, security_deposit, final_payment, or down_or_final_payment.

A business_to_business use case must must have a business purpose for both the RfP sender and RfP receiver. A business purpose is a purpose that is not related to any personal, family, or household matter. Hence, so long as an RFP is not related to any personal, family, or household matter for the RfP sender or RfP receiver, the RfP sender and/or RfP receiver can be an unincorporated business or sole proprietor. For the avoidance of doubt, the purchase of goods or services for a personal, family, or household purpose is not a business purpose even if the goods or services are sold by a business.

An account_to_account use case is where a payment sent in response to the RFP results in a transfer between asset accounts that are both owned by the same person.

A bill_pay use case is seeking payment for a recurring consumer service or financial obligation or seeking payment for a non-recurring consumer service that is performed and paid for at a consumer home, such as lawn care, house cleaning, or repairs. For purposes of interpretation recurring means that payment is owed on at least a quarterly basis and that the service or financial obligation is expected to continue on an ongoing and predetermined basis for at least a year.

A down_payment use case is an initial payment owed for a financial obligation that will involve multiple payments such as rent, an installment loan, or a mortgage.

A security_deposit use case is an initial deposit at the time of opening a new deposit account or a deposit amount owed for a financial obligation that will involve multiple payments such as rent, an installment loan, or a mortgage.

A final_payment use case is a payment that fully pays the outstanding balance or amount owed for a financial obligation that involved multiple payments such as rent, an installment loan, or a mortgage.

A down_or_final_payment use case is a payment that either an initial payment owed for a financial obligation that will involve multiple payments or fully pays the outstanding balance or amount owed for a financial obligation that involved multiple payments such as rent, an installment loan, or a mortgage.

use_case_description

string

required

length ≤ 8192

A detailed description of the intended use case.

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

approved

string | null

Formatted timestamp (YYYY-MM-DD HH:MM:SS) determining when the presentment was approved.

created

string

Formatted timestamp (YYYY-MM-DD HH:MM:SS) determining when the presentment was created.

denied_details

object | null

If present, the presentment was denied and cannot be used.

message

string | null

More details about the denial.

reason

string | null

The reason for the denial.

timestamp

string

Formated timestamp (YYYY-MM-DD HH:MM:SS) determining why the rfp was denied.

enrollments

array of objects

List of bank account enrollments to use in conjunction with the RfP transfer.

enrollments

object

bank_id

string

The bank id of bank associated with the routing number.

bank_name

string

Name of bank associated with the routing number.

capabilities

object

A hash containing the set of capabilities that were requested for this account and their associated states. Keys are names of capabilities. Values may be active, inactive, or pending.

created

string

Formatted timestamp (YYYY-MM-DD HH:MM:SS) determining when the enrollment was created.

fednow_support

object

Federal Reserve FedNow network support.

uuid

Unique enrollment id (RFC-4122 UUID).

routing_number

string

ABA compliant routing number for the enrollment bank account.

rtp_support

object

The Clearing House RTP network support.

updated

string | null

Formatted timestamp (YYYY-MM-DD HH:MM:SS) determining when the enrollment was last updated.

hold_details

object | null

If present, the presentment is on hold and cannot be used.

message

string | null

More details about the hold.

reason

string | null

The reason for the hold.

timestamp

string

Formatted timestamp (YYYY-MM-DD HH:MM:SS) determining when the hold was placed.

uuid

Unique rfp presentment id (RFC-4122 UUID).

industry_category_code

string | null

memo

string | null

phone

object

A publicly available phone number to call regarding billing issues.

country_code

string | null

Country code without the plus (+), for example, for the United States, it would be 1.

number

string

10 digit phone number without the country code and without the delimiters (-,.,etc.). For example, 865-604-6546 would be 8656046546.

reviewed

string | null

Formatted timestamp (YYYY-MM-DD HH:MM:SS) determining when review started on the presentment.

sender_name

string | null

Name of the sender of the request for payment. If not present, will fall back to the name used on the account.

status

string

Current status of the presentment: pending, reviewed, approved, denied, or on_hold. A presentment is pending until it is submitted to the review team, when it becomes reviewed. The status then changes to approved or denied if the presentment goes through (within 1 business day). Some on_hold presentments may initially show as approved but then change to on_hold.

pending reviewed approved denied on_hold

use_case

string

The RTP use case for the presentment: business_to_business, account_to_account, bill_pay, down_payment, security_deposit, final_payment, or down_or_final_payment.

An account_to_account use case is where a payment sent in response to the RFP results in a transfer between asset accounts that are both owned by the same person.

A down_payment use case is an initial payment owed for a financial obligation that will involve multiple payments such as rent, an installment loan, or a mortgage.

business_to_business account_to_account bill_pay down_payment security_deposit final_payment down_or_final_payment

use_case_description

string

length ≤ 8192

A detailed description of the intended use case.

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-sandbox.trice.co/hub/v1/rtp_rfp_presentments \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "use_case": "business_to_business"
8
}
9
'

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

application/json

201New request for payment presentments response

400Bad request

401Unauthorized

404Not found

502Bad gateway

defaultError