📘 Name Type Description Required userId number insure id yes
Name Type Description Required id number Id of payment. Can be used for any payment operations. yes transactionId string Payment transaction Id. It can be seen in the application in the transaction history. yes amount number Payment amount without any fees. yes customerId number The Id of the insured who will receive the payment or has already received it. yes customerName string Name of the insured who will receive the payment or has already received it. yes merchantName string Name of the insurer who will send the payment or has already sent it. yes fee number Fee for the payment amount. It will only be different from zero when this payment is sent. yes feeDeductFrom string Which side of the transfer will pay the fee. yes status string Status of payment. Main statuses: Awaiting-cash-out, Canceled, Preparing to mail, In-transit, Settled yes type string Type of payment. Can be only of two types: ACH or paper check with delivery type. yes memo string A string with a maximum length of 280 characters. no createdAt Date Creation date yes
Get list of insured’s pending payments Request with userId = 1;Get list of insured’s pending payments Response:
JSON
[
{
"id": 1,
"transactionId": "a444aa44-aaa4-4a4a-aaaa-a44a44444a44",
"amount": 10.23,
"createdAt": "2023-08-09T15:42:26.683Z",
"customerId": 1,
"customerName": "John Smith",
"merchantName": "Jake Merchant",
"fee": "0.00",
"feeDeductFrom": null,
"status": "Awaiting-cash-out",
"type": "--",
"memo": ""
}
]
In addition to getting a list of your payments, you can find out what pending payments your insured has.
