Send mass pending payments

📘

API Refs

• Production: Send mass pending payments
• Staging: Send mass pending payments

Request body

Name	Type	Format
file	form-data	csv

File structure

Column name	Type	Description	Required
Email	string	Insured’s email address	yes
Amount	number	The amount you’re sending this Insured	yes
Memo	string	Describe your payment with an optional message. Your recipient will see this memo	no
Recipient's Mailing Address	string	Insured’s Mailing Address	no

Example

1. Get list of self payments Request;

2. Get list of self payments Response:

   JSON

   [
     {
       "id": 1,
       "transactionId": "a444aa44-aaa4-4a4a-aaaa-a44a44444a44",
       "amount": 10.23,
       "createdAt": "2023-08-09T15:42:26.683Z",
       "customerId": 2,
       "customerName": "John Smith",
       "merchantName": "Jake Merchant",
       "fee": "0.00",
       "feeDeductFrom": null,
       "status": "Awaiting-cash-out",
       "type": "--",
       "memo": ""
     }
   ]
   

3. Send mass pending payments Request file structure:

   Email	Amount	Memo	Recipient's Mailing Address
   [email protected]	20.23	Payment for Claim #1337	456 Example St.

4. Get list of self payments Request;

5. Get list of self payments Response:

   JSON

   [
     {
       "id": 1,
       "transactionId": "a444aa44-aaa4-4a4a-aaaa-a44a44444a44",
       "amount": 10.23,
       "createdAt": "2023-08-09T15:42:26.683Z",
       "customerId": 2,
       "customerName": "John Smith",
       "merchantName": "Jake Merchant",
       "fee": "0.00",
       "feeDeductFrom": null,
       "status": "Awaiting-cash-out",
       "type": "--",
       "memo": ""
     },
     {
       "id": 2,
       "transactionId": "a555aa55-aaa5-5a5a-aaaa-a55a55555a55",
       "amount": 10.23,
       "createdAt": "2023-08-10T12:03:26.683Z",
       "customerId": 2,
       "customerName": "John Smith",
       "merchantName": "Jake Merchant",
       "fee": "0.00",
       "feeDeductFrom": null,
       "status": "Awaiting-cash-out",
       "type": "--",
       "memo": "Payment for Claim #1337"
     }
   ]
   

Description

❗️

The file must be of the required structure. Rows with invalid values are ignored.

You can submit multiple pending payments in a single request.
To do this, you need to upload a file with the required information.