Push to Card

Get started with push to card payments

Before getting started

This guide will assume you've already created and authenticated a user. If you haven't done that then please first read our User Connect guide.

Overview

There are a number of steps that need to be carried out in order to make a push-to-card payment. At a high level, these are:

  1. Create a partner payer
  2. Verify that partner payer
  3. Fund your account
  4. Create a user payer
  5. Make a payment request with a credit card ID

Follow along with the steps below to help you through the process or get started with our Payments API Reference.

Creating and verifying a partner payer

To initiate a bill payment on the Spinwheel platform, the first step is to create a partner payer. By doing so, an entity will be created that can be utilized to finance all payments. You have the freedom to add numerous partner payers to your organization.

Please note that there is a verification process necessary to finalize the creation of a partner payer. This involves a micro-deposit flow, which requires you to verify two recent bank account transactions and send an API call to confirm these transactions. This step is crucial in ensuring that the correct bank account has been connected.

Funding your account

After successfully creating your partner payer, the next step is to fund your account by making a payment to platform. By doing so, you can ensure that there are sufficient funds available in your account to cover any payments that need to be made.

We will emit a PLATFORM_PAYMENT_STATUS webhook to notify you of the payment status after this step.

Creating a user payer

If you have successfully funded your account then it's time to create a user payer. Once this has been completed, you can create one-time or recurring payment requests on behalf of that user.

Creating a payment request with a creditCardId

There is some nuance here. If it's your first time calling this API with a credit, you will first need to register your card by using our secure proxy endpoint: https://secure-api.spinwheel.io/v1/payments/requests.

πŸ“˜

Best practice

This step can occasionally fail in which case a best practice is to fallback to our bill pay solution.

Once this step has been completed, all subsequent payment requests to this card can be carried out using our standard payment requests endpoint.

To learn more about our debt APIs and 1-click solutions, visit spinwheel.io.