The Split API supports making payments from your bank or float account to any Australian bank account via BSB and Account number.

Example use cases include:

  • Lender disbursement of funds
  • Marketplace payouts
  • Insurance claim payouts
  • Fintech Apps

Making a payment is a two-step process:

1. Create a Contact

Create contact via the API
You can use the Add an Anyone Contact API Endpoint to create your contact using BSB and account number.

POST /contacts/anyone
{
  "name": "Hunter Thompson",
  "email": "hunter@batcountry.com",
  "branch_code": "123456",
  "account_number": "13048322",
  ... other parameters available, see API docs
}

Invite your customer to get paid
As an alternative, you can invite your customer to get paid by sending them a special shareable link. When your customer clicks the link they are invited to enter their personal and banking details. This creates a contact within your Split account that you can make payment to.

2. Make a Payment

Use the Payment API Endpoint to make a payment to your contact. The endpoint supports making payments in a batch, allowing you to pay multiple contacts in one API call.

POST /payments

{
  "description": "The SuperPackage",
  "matures_at": "2016-09-13T00:00:00Z",
"your_bank_account_id": "...",
  "payouts": [
    {
      "amount": 30000,
      "description": "Payment to customer A",
      "recipient_contact_id": "...",
    },
    {
      "amount": 40000,
      "description": "Payment to customer B ",
      "recipient_contact_id": "..."
    }
  ],
  ... other parameters available, see API docs
}

Webhooks:

You'll have the option to enable webhooks that will update your system on the status of payments in real-time as we are notified of the success of your transactions.

https://docs.split.cash/#webhooks

Developer Pro-tips: For more information on how to implement our webhooks please refer to the following article: 

https://help.split.cash/en/articles/3303626-webhooks

Collateral:

Documentation: https://docs.split.cash

Sandbox account: https://go.sandbox.split.cash/sign_in

Test credentials: https://docs.split.cash/#sandbox-testing-details

Help guides: https://help.split.cash/en/

OAuth2 Guide: https://help.split.cash/en/articles/3649396-using-oauth-to-act-on-behalf-of-other-split-accounts

Support

Need a helping hand? From technical questions to integration strategy and support we are here for you 9 to 5, Monday to Friday. We’re also happy to schedule a call to help you plan your integration.

The easiest way to get in touch with us is via in-app messaging. When you log in to your sandbox or production account, click on the chat bubble on the bottom-right side of the screen. Alternatively, you can send us an email at support@splitpayments.com.au and we’ll get right back to you.

Did this answer your question?