Get Sandbox Access

Paybase Developer Centre

OverviewAPI GuidesGetting StartedRecipesGig Economy PlatformsSharing Economy PlatformsMarketplacesBlockchain BusinessesEscrowSandboxRolesRulesDue DiligenceCustomersAccountsBank AccountsCardsTransactionsIntroductionInboundGetting money into the systemTransaction ReferenceAccount ReferenceInternalOutboundEscrowSplit PaymentsRefundsStrong Customer Authentication3D Secure AuthenticationIntroductionCreate a cardCreate a transactionDocument UploadStatementsWebhooksErrorsPQLAPI ReferenceAccountCreate an accountRetrieve an accountTransition account statusList all accountsAnnotate an accountDelete annotation from an accountTag an accountDelete tag from an accountBank AccountCreate a bank accountRetrieve a bank accountUpdate a bank accountTransition bank account statusList all bank accountsAnnotate a bank accountDelete annotation from a bank accountTag a bank accountDelete tag from a bank accountCardCreate a cardRetrieve a cardUpdate a cardTransition card statusList all cardsAnnotate a cardDelete annotation from a cardTag a cardDelete tag from a cardCardholderCreate a cardholderRetrieve a cardholderUpdate a cardholderTransition cardholder statusList all cardholdersAnnotate a cardholderDelete annotation from a cardholderTag a cardholderDelete tag from a cardholderCreate an authentication tokenCheckCreate a checkCustomerIndividual CustomerCreate a customerRetrieve a customerUpdate a customerSole TraderCreate a customerRetrieve a customerUpdate a customerOrganisationCreate a CustomerRetrieve a CustomerUpdate a CustomerIncorporated BusinessCreate a customerRetrieve a customerUpdate a customerBusiness PersonAdd a business personRetrieve a business personUpdate a business personDelete a business personRetrieve a customerTransition state of a customerList all customersAnnotate a customerDelete annotation from a customerTag a customerRemove tag from a customerCreate an authentication tokenTouch a customerDocumentCreate a documentRetrieve a documentList Document TypesReferenceRetrieve a referenceStatementRetrieve a statementStatusRetrieve API statusTransactionCreate inbound transactionCreate internal transactionCreate outbound transactionRetrieve a transactionTransition transaction statusList all transactionsAnnotate a transactionDelete annotation from a transactionTag a transactionDelete 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.).