Online Payments API

Our simple, straightforward API gets you up and running quickly.

Payments API Reference

The following are links to all our resources in our online payments API. Each section of our API includes detailed information about methods & parameters as well as example code.

Authorization

An instance of a credit/debit card authorization, with a payment expected to be captured later.

Learn more

CardToken

One time use token representing card details that can be used to create a payment.

Learn more

Chargeback

An instance of a credit/debit card payment that is in dispute.

Learn more

Coupon

Coupons can be applied to subscriptions.

Learn more

Customer

Customers can be assigned subscriptions for recurring payments.

Learn more

Deposit

Deposits represent transfers of funds to your bank account.

Learn more

FraudCheck

BETA. Test Mode only.

Learn more

Invoice

An invoice contains items to charge a customer.

Learn more

InvoiceItem

Line items for invoices.

Learn more

Payment

An instance of a credit/debit card payment.

Learn more

Plan

Recurring payment plans that are used to create subscriptions.

Learn more

Refund

A refund of a previous payment (full or partial).

Learn more

Subscription

Subscriptions to recurring plans for a particular customer.

Learn more

Tax

Tax rates to be applied to an invoice.

Learn more

TransactionReview

An instance of a review for a given payment or authorization.

Learn more

Webhook

Objects representing HTTP endpoints that will receive callbacks after various events.

Learn more

API Keys

After logging into your account, your API keys can be located at: Settings ⟶ API Keys

There will be two private keys – one for Sandbox mode and one for Live mode. If you have not yet registered for Live mode, then there will only be a Sandbox key. To make them easy to distinguish, sandbox keys are prefixed with sbpb_ and live keys with lvpb_.

Note

These are private keys, so keep them safe. Anyone who obtains your private API key can make API requests on your behalf!

Sandbox vs. Live modes

The Simplify Commerce API can be accessed in Sandbox or Live modes. In Sandbox mode, all payments are simulated. In Live mode, payments are real. The API key specified in API requests determines which mode is accessed. When logged into the Simplify Commerce web portal, you can switch between viewing Sandbox and Live data using the toggle switch in the header.