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


During your initial platform set-up, Paybase will configure a set of Roles for your account to denote the various participants on your platform. Every Customer created on the platform must be assigned one of these Roles. Each Role will also have a set of permissions associated with it that will dictate what a Customer with a given Role can do on Paybase. E.g. if you operate a ride hailing app, the Roles configured for you might be:

  • Rider - An Individual Customer type that can make Card Payments and deposit funds in their Rider wallet.
  • Driver - A Sole Trader Customer type that can Accept Card Payments in their Driver wallet, make Withdrawals from their wallet to their Bank Account.
  • Platform - You, the ride hailing platform that can Accept fees from Card Payments from Riders and Make Withdrawals from you Fee wallet to your Bank Account.

Note that the above is purely an example and the role configured for your account will depend on your platform’s operating model.

Each Role also has an associated Target Customer Due Diligence (CDD) Level between 1 and 5. The Target CDD Level is the minimum level of verification a Customer assigned to that role must achieve before they are allowed to transact on the platform.

You can view the details of the Roles set up on your account in the Integrations tab on the Console. Here, you will also find the roleId and roleSlug for each role which will be required in some API requests.

It is possible to update the role of a Customer to another existing role. Updating a role will retain the Current CDD Level of a customer. The customer will also be assigned a Target CDD Level of the new role if it is higher than the current CDD Level of the customer. e.g. if a customer's current CDD level is 2 (because the role has a Target CDD Level of 2), but the new role has a Target CDD level of 3, the customer's Target CDD Level will also be updated to 3. It's worth noting that you will not be able to retrieve transaction or account references for customers that have not achieved the Target CDD Level for their role. Therefore, updating a customer to a role with a higher CDD Level might result in them not being able to transact any more until additional information is provided.