Skip to main content
Paywint supports sending physical mailed checks as one of its payment methods.
Before a check can be issued, each user must have:
  • A valid check mailing address, and
  • Optional check configuration settings such as custom logo or signature.
This section provides the APIs needed to manage check-related details for your users.

​
What This API Covers

The Check Management API allows you to:
  • Create and maintain a user’s check mailing address
  • Update address details at any time
  • Configure check appearance (logo, signature)
  • Reset branding back to Paywint defaults
  • Support mailed-check payments created through the Payments API
These APIs do not send a check directly.
Checks are delivered through the Mail Check endpoint inside the Payments section.

​
Available APIs

Add Check Address

Create a new mailing address used for sending physical checks.

Update Check Address

Modify an existing check mailing address for the user.

Update Check Config

Configure check branding, including logo and signature image.

​
When Check Management Is Used

You should manage check settings when:
  • A user wants payments delivered as physical checks
  • The mailing address changes
  • A business wants custom branding (logo or signature) on mailed checks
  • You want to reset a user’s check branding back to the Paywint default
These settings ensure every mailed check contains accurate address information and optional branded elements.

​
Easily manage checks

1

1. Add the user's check mailing address

Call Add Check Address to store the recipient address used for mailing checks.
2

2. (Optional) Configure check branding

Use Update Check Config to include a logo or signature.
This step is optional—Paywint uses a default design if none is provided.
3

3. Update address or branding as needed

At any time, you may update the user’s details using the corresponding endpoints.
4

4. Create a mailed check payment

When sending a payment using the Payments API with the Mail Check method,
Paywint uses the stored address and configuration to issue the check.

​
Best Practices

  • Always keep the user’s check address up-to-date before issuing mailed checks
  • Use publicly accessible HTTPS URLs for logos and signatures
  • Allow users to preview their check branding inside your application
  • If branding is optional for your use case, rely on Paywint’s default settings