Accept pending payment as Paper Check
API Refs
- Production: Accept pending payment as Paper Check
- Staging: Accept pending payment as Paper Check
URI Parameters
Name | Type | Description | Required |
---|---|---|---|
paymentId | string | Pending payment id | yes |
Request body
Name | Type | Description | Required |
---|---|---|---|
alias | string | An alias for the client's address information. | yes |
mailType | string | Check shipping type. Available in four options only: FedEx, Mail, USPSFirst, USPSTrack. | yes |
Response body
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 |
Example
-
Get list of insuredās addresses Request with userId = 1;
-
Get list of insuredās addresses Response:
[ { "address1": "11 Birch Hill Street", "address2": "Apt. 123", "city": "Bronx", "postalCode": "10023", "state": "NY", "phone": "123-456-7890", "alias": "Home" } ]
-
Get list of self payments Request;
-
Get list of self payments Response:
[ { "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": "" } ]
-
Accept pending payment as Paper Check Request with paymentId = 1:
{ "alias": "Home", "mailType": "FedEx" }
-
Accept pending payment as Paper Check Response:
{ "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": "9.00", "feeDeductFrom": "sender", "status": "Preparing to mail", "type": "Paper Check: USPS First-Class (3-5 days)", "memo": "Test check" }
Description
Where to get address alias
You can get all existing addresses with their alias for any you insured. Go to Get list of insuredās addresses for more information about it.
When accepting a pending payment as a paper check, you must always indicate the alias of the address of the insured to whom the paper check will be sent.
If the transaction is successfully created, the pending payment status will change to Preparing to mail.
Such a payment has the following statuses:
- Preparing to mail;
- Mailing soon;
- Rejected;
- Resubmitted: Preparing to mail again;
- Canceled;
- Mailed.
Updated about 1 year ago