Check parameters
To pay down loan proceeds, you can send a physical check to a biller (merchant or business). This is useful when you have to pay billers that don't accept payments via Mastercard RPPS.
You can add an optional Base64 encoded attachment to accompany the check, and it will be mailed as a PDF.
Formatting text
To format the field Remittance_advice so that it reads correctly, format it as follows:
- Quotation marks (" ") creates a vertical row
- Comma (,) delimits the text and formats it on the check page
For example:
"Dear customer xyz,"
"Enclosed is a check for 1000.00 to be applied as a payment toward account number: 123456789. If you have any questions or need additional information, contact us at (888) 555-xxxx. Our business hours are Mon-Fri 8:00am-5:00pm Eastern Time.",
"Sincerely,",
Your lender
Check delivery
After a check is issued, it takes about 5 - 7 business days for receipt (CRB uses USPS first class mail). If a check isn't cashed after 15 calendar days, it is canceled.
You can contact MPL Ops to stop payment on a check, and for any questions regarding check delivery or receipt.
Webhooks are reported when a check is processed, mailed, cashed or expired. For more information on webhooks, see View webhook events available.
Important
When you add a date field in a request, the format must be: yyyy-mm-dd, such as 1970-12-05.
Request parameters
{
{
"FundingInfoUpdate": {
"Rails": [
{
"CheckFields": {
"PhysicalAddressOfRecipient": {
"Line_1": "Anita Loan",
"Line_2": "Strawberry Fields Lane",
"City": "Paradise City",
"State": "NY",
"Zip": "11252",
"Country": "USA"
},
"Name": "Anita",
"Attachment": "{Encoded64 text here}",
"Description": "Loan from Cross River",
"Remittance_advice": "",
"IsPrintedandMailed": "0",
"CheckEmail": "[email protected]"
},
"RailType":"CHECK",
"Priority":1,
"Amount":200.0
}
]
}
},
Request parameters
Attribute | Description |
---|---|
Rails array | Rail selected, in this case Check. |
Line_1 string | Check delivery address, line 1. Required |
Line_2 string | Check delivery address, line 2. Optional |
City string | City of business for check delivery. Required |
State string | State of business for check delivery. 2 letters Required |
Zip string | Zip code of business for check delivery. Required |
Country string | Recipient's country. Always US 2-letter country code. Optional |
Name string | Name of the borrower. Optional |
Description string | The name of the loan being paid. This is printed on the check and looks best if under 100 chars. Optional |
Attachment string | Base64 encoded 1 page PDF. It must be encoded and inserted here as text. Optional |
Remittance_advice array | Base64 encoded text. Up to 700 chars before encoding. Appears on the top third of the page. The check is located on the bottom third of the page. Optional |
IsPrintedandMailed boolean | Whether the the check is being printed and mailed. True if check is being printed and mailed, otherwise, false. Required |
CheckEmail string | Recipient's email. Optional |
Priority integer | Rail priority. Required |
Amount integer | Amount being funded. Required |
Updated 4 months ago