snail-api-wrapper v1.0.4

snail-api-wrapper

A wrapper for the Snail API

Authenticating

const { Snail } = require("snail-api-wrapper");

const snail = new Snail("your api key");

Error Handling

All functions return promises, so handling errors is done through a .catch

Verifying Payments

To use this endpoint, acquire an order verification code from your user and call this function

const verified = await snail.verifyPayment("user code");

console.log(verified); // payment object or false

Creating Payment Links

If you want your product to have an image, you have to encode an image as base64

const paymentLink = await snail.createPaymentLink({
  image: "base64 encoded image",
  name: "product name",
  price: 5, // amount of usd to charge
});

Creating Subscription Links

If you want your product to have an image, you have to encode an image as base64

const paymentLink = await snail.createSubscriptionLink({
  image: "base64 encoded image",
  name: "product name",
  price: 5, // amount of usd to charge per month
});

List Payments

const payments = await snail.listPayments();

List Subscriptions

const subscriptions = await snail.listSubscriptions();

List Payment Links

const paymentLinks = await snail.listPaymentLinks();

List Subscription Links

const subscriptionLinks = await snail.listPaymentLinks();

List Payouts

const payouts = await snail.listPayouts();

Create a Payout

await snail.newPayout(5);

Refund a Payment

await snail.refundPayment(["payment id 1", "payment id 2"]);