Send Paper Check Payment

📘

API Refs

Request body

NameTypeDescriptionRequired
recipientEmailstringInsured email.
If insured does not exist, create an invite
yes
amountnumberThe amount of money being transferred. Amounts should have either 0 or 2 decimal places. Max limit is based on most current agreements with SnapRefund. Minimum limit is $0.01.yes
memostringA string with a maximum length of 280 characters.no
aliasstringAn alias for the client's address information.yes
mailTypestringCheck shipping type. Available in four options only: FedEx, Mail, USPSFirst, USPSTrack.yes

Response body

NameTypeDescriptionRequired
idnumberId of payment. Can be used for any payment operations.yes
transactionIdstringPayment transaction Id. It can be seen in the application in the transaction history.yes
amountnumberPayment amount without any fees.yes
customerIdnumberThe Id of the insured who will receive the payment or has already received it.yes
customerNamestringName of the insured who will receive the payment or has already received it.yes
merchantNamestringName of the insurer who will send the payment or has already sent it.yes
feenumberFee for the payment amount. It will only be different from zero when this payment is sent.yes
feeDeductFromstringWhich side of the transfer will pay the fee.yes
statusstringStatus of payment. Main statuses: Awaiting-cash-out, Canceled, Preparing to mail, In-transit, Settledyes
typestringType of payment. Can be only of two types: ACH or paper check with delivery type.yes
memostringA string with a maximum length of 280 characters.no
createdAtDateCreation dateyes

Example

  1. Get list of insured’s addresses Request with userId = 1;
  2. 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"
      }
    ]
    
  3. Send Paper Check Transfer Request:
    {
      "recipientEmail": "[email protected]",
      "amount": 12.34,
      "memo": "Test memo",
      "alias": "Home",
      "mailType": "Mail"
    }
    
  4. Send Paper Check Transfer Response:
    {
      "id": 1,
      "transactionId": "a444aa44-aaa4-4a4a-aaaa-a44a44444a44",
      "amount": 12.34,
      "createdAt": "2023-08-09T15:00:00.000Z",
      "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 memo"
    }
    

Description

❗️

You can send Paper check transfers only for your insureds. If you want to send Paper check transfer for non insured, go to Send pending payment

📘

Where to get insured's email?

You can get list of all created insureds. Go to Get list of all insureds

📘

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.