Environments

We provide two environments:

• Production
• Staging

To use one of them, you need to register in the corresponding one using the following links:

• Production - Register
• Staging - Register

Once you've registered via the appropriate environment's dashboard, feel free to use one of our Postman collections to start sending requests quickly.

📘

Postman Collections 💻

• To import a collection:

  • Open Postman and click 'Import'
  • 
  • Paste either the production or staging url below into the form field
  • 

• Production Postman collection: https://app.agentsnap.io/api/swagger/public-json

• Staging Postman collection: https://agent-staging.snaprefund.io/api/swagger/public-json

API Workflows

📘

Good to know

Before we walk through these flows, let's make sure we're on the same page about the words you're going to see below. They're defined as:

• Policyholder - The individual or business you are collecting payments from.
• Carrier - The insurance company you work with.
• Invoice - A request for payment for a policy.
• Refund - A payment sent back to a policyholder.

Carrier Management Flow

This flow describes how to create and manage carriers. You can associate carriers with invoices.

1. If you need to add a new insurance carrier, create a carrier. You will receive a carrierId in the response.
2. You can see all your existing carriers by listing your carriers.

Full Invoice and Payment Flow

This flow describes creating a new policyholder and a new invoice, then collecting payment.

1. Create a policyholder. You will receive a policyholderId in the response.
2. Create an invoice for the policyholder using the policyholderId from step 1. You can also associate a carrierId.
3. The response from creating an invoice will contain a payment link. Provide this link to your policyholder to collect payment via ACH, credit card, or other supported methods.

Refund Flow

This flow describes how to issue a refund to an existing policyholder.

1. You need the policyholderId of the policyholder you want to refund. If you don't have it, list your policyholders to find the correct one.
2. Create a refund for the policyholder using their policyholderId.

Payment Flows

The AgentSnap API supports several ways to send payments. You can either send a flexible payment link and let the recipient choose how to cash out, or send a direct payment where you specify the payment method.

Pending Payment Flow (Recipient Chooses)

This is the most flexible option. You send a payment to an email address, and the recipient is sent a link to choose how they'd like to receive the funds.

1. Send a pending payment with the recipientEmail and amount.

Direct Payment Flows (You Choose)

These flows are used when you want to specify exactly how the payment is sent. This requires that you have already collected the necessary details from the policyholder.

To a Bank Account (ACH, RTP, Same-Day ACH)

1. Get the policyholder's bankId by listing their banks.
2. Call the appropriate endpoint for the desired speed:
   • Send ACH Payment
   • Send Same-Day ACH Payment
   • Send RTP (Instant) Payment

By Paper Check

1. Get the policyholder's address alias by listing their addresses.
2. Send a Paper Check with the address alias and mailType.

Mass Payments via CSV

1. Prepare a CSV file with columns for Email, Amount, and Memo.
2. Send mass pending payments by uploading the file.