Paybase Developer Centre

OverviewAPI GuidesGetting StartedRecipesGig Economy Platforms Sharing Economy Platforms Marketplaces Blockchain Businesses Escrow Sandbox Roles Rules Due Diligence Customers Accounts Bank Accounts CardsTransactionsIntroductionInboundGetting money into the system Transaction Reference Account Reference Internal Outbound Escrow Split Payments Refunds Strong Customer Authentication3D Secure AuthenticationIntroduction Create a card Create a transaction Document Upload Statements Webhooks Errors PQLAPI ReferenceAccountCreate an account Retrieve an account Transition account status List all accounts Annotate an account Delete annotation from an account Tag an account Delete tag from an accountBank AccountCreate a bank account Retrieve a bank account Update a bank account Transition bank account status List all bank accounts Annotate a bank account Delete annotation from a bank account Tag a bank account Delete tag from a bank accountCardCreate a card Retrieve a card Update a card Transition card status List all cards Annotate a card Delete annotation from a card Tag a card Delete tag from a cardCardholderCreate a cardholder Retrieve a cardholder Update a cardholder Transition cardholder status List all cardholders Annotate a cardholder Delete annotation from a cardholder Tag a cardholder Delete tag from a cardholder Create an authentication tokenCheckCreate a checkCustomerIndividual CustomerCreate a customer Retrieve a customer Update a customerSole TraderCreate a customer Retrieve a customer Update a customerOrganisationCreate a Customer Retrieve a Customer Update a CustomerIncorporated BusinessCreate a customer Retrieve a customer Update a customerBusiness PersonAdd a business person Retrieve a business person Update a business person Delete a business person Retrieve a customer Transition state of a customer List all customers Annotate a customer Delete annotation from a customer Tag a customer Remove tag from a customer Create an authentication token Touch a customerDocumentCreate a document Retrieve a document List Document TypesReferenceRetrieve a referenceStatementRetrieve a statementStatusRetrieve API statusTransactionCreate inbound transaction Create internal transaction Create outbound transaction Retrieve a transaction Transition transaction status List all transactions Annotate a transaction Delete annotation from a transaction Tag a transaction Delete tag from a transaction

API version: ba085a6

Overview

The Paybase platform is a powerful and flexible end-to-end platform for payments, compliance and risk management.

Our API provides an extensive interface for accepting card and bank payments, safely on-boarding and verifying customers, holding funds, splitting payments and making payouts. With the Paybase API, you can customise your integration to achieve a payment flow in line with your business model and design the best solution for your customers. Some of the things you can do include:

Accept card payments and inbound bank transfers
Split funds between multiple accounts and collect fees
Hold funds in escrow
Make instant payouts in real-time
Create e-money accounts for your customers
Automate flows using custom Paybase Rules

Paybase use cases

The flexibility of the Paybase platform can be leveraged to support a wide array of business models and use cases including:

Gig Economy - with real-time payments to reduce network leakage
Sharing Economy - verify your community and add trusted escrow payments
Marketplaces - both consumer and B2B
Blockchain - fiat interoperability for exchanges and wallets
Escrow - fully compliant escrow flows via API

Before you start

Before you start integrating with the API, you should consider the following as this will determine the endpoints which you will use. Not planning in advance might result in you implementing payment flows that are not optimised for your business model and having to do extra development work.

Determine the participants on your platform that will be involved in the flow of funds and whether these will be individuals, sole traders or companies (e.g. if you operate a platform for booking temporary workers, the participants will be customers, workers and you, the platform).
Think about how funds will flow between the various participants and whether you want funds to move automatically or manually (e.g. customers will make a payment to hire workers, you will receive a fee from the payment, workers will receive the balance payment).
Decide if you want to accept card payments, inbound bank transfers or both on your platform.
Decide whether you want to make payouts automatically or manually.
Think about how and when you want to collect fees (e.g. fixed fee, percentage, upon receipt of incoming funds, on a payout etc.).