Send Paper Check

post

https://claims-staging.snaprefund.io/api/public/payments/send-check

Send a paper check via physical mail couriers. Paper checks aren't the newest or the fastest way to send money to someone, but when all else fails they present a time-honored method of sending a payment. Multiple mail speeds are supported and every option except standard mail (the Mail enum value) supports tracking info once the check is printed and shipped. Note; a phone number for the recipient must be provided if the chosen mailType is FedEx. This is used in case FedEx couriers need to contact the recipient to coordinate delivery.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

recipientEmail

string

required

The user's email address. This value will be used for all future notifications and web-app logins for this user, so choose carefully.

amount

number

required

≥ 0.01

The amount of money being transferred. Amounts should have either 0 or 2 decimal places. Max limit is based on most current agreement with SnapRefund. Minimum limit is $0.01.

memo

string

required

length between 1 and 280

A string with a maximum length of 280 characters.

alias

string

required

An alias for the client's address information. The alias value can be retrieved by the endpoint: /api/public/users/{userId}/addresses

mailType

string

enum

required

Check shipping type. Available in four options only: FedEx, Mail, USPSFirst, USPSTrack.

Allowed:

approversEmails

array of strings

Array of email addresses for payment approvers

approversEmails

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201