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

Getting Started

We recommend that you first read the API documentation to familiarize yourself with various concepts and functionality offered by the API.

When you’re ready, you will need to contact us to get access to a Sandbox account where you can start exploring our API. The Sandbox environment acts exactly in the same way as Production but does not use real money. Once your account has been set up you will have access to the Paybase Console where you can view your API keys and account settings. Console is also the dashboard you will use on a day to day basis to manage your account, customers and transactions.

Generating your API Key

You can retrieve your API Token from the Console for both Sandbox and Production on the Integrations tab on the top right menu. If none have been generated, click the New Key button, give it a name and then generate the key. Generating a new key will not affect any existing keys.

Endpoint URLs

Please use the following URLs to connect to our API:

EnvironmentEndpoint URL
Sandboxhttps://api-json.sandbox.paybase.io
Productionhttps://api-json.paybase.io

Authenticating your requests

Authentication with the Paybase API is done by passing a token in the X-Token HTTP request header. This token is used to identify you, as well as authorise requests in the system.

If the token provided is invalid or does not authorise the request, the API will respond with a 403 response code. See the Error Codes section for more information.

Request headers

Beyond the X-Token header, there are a number of additional headers that may need to be passed.

HeaderPurpose
X-TokenThe API Token to authenticate and authorise requests to the Paybase API.
X-Originator-IPIn all cases where possible, you should pass the Customer's IP address with requests. Doing this allows us to better protect you against fraud and cyber crime.
X-Idempotency-KeyThis offers you the ability to protect against duplicate requests by providing an identifier with an optional TTL. The default TTL is 24 hours.
X-Idempotency-TTLProvide a custom TTL for your request identifier, this is expected in the format {digits}[s|m|h|d|w|M|y], where s is seconds, m is minutes, h is hours, d is days, w is weeks, M is months and y is years.

Postman Collection

Postman is an API client that can be used to easily interact with the Paybase API when getting started. It allows you to get up and running quickly and start making test API calls to our Sandbox environment to help you get familiar with our API.

Download the Postman collection for the Paybase API here