Onboarding Flow
Before you can start initiating calls to the Account Management API you need to have the following:
- A Platform Partner account – To get your Platform Partner account for the Test environment, please contact integrations@paysafe.com.
- Authentication credentials – To receive your Platform Partner authentication credentials, please contact integrations@paysafe.com.
Here is a brief overview of the work flow you might follow to board a merchant.
Number | Type of API Call | Purpose |
---|---|---|
1 | Create a Merchant | This call creates a Merchant with Paysafe. |
2 | Create a Merchant Account | This call creates a merchant account associated with the Merchant. The merchant will use this account to process transactions.You must create a different merchant account for each payment method/currency combination you want to support (e.g., USD credit card, CAD Direct Debit, etc.). You should pause for five seconds after calling the last service that creates a merchant account in case you are creating multiple accounts (such as creating Credit Cards and Direct Debits) before calling the next service (such as Creating Users, Business Owner, etc.). |
3 | Create a User | This call creates a user associated with the merchant account. Users can sign in to the Paysafe Merchant Back Office toYou should pause for five seconds after calling the last service that creates a merchant accounts (such as credit card and direct debit accounts), a pause of 5 seconds should be set up after the last service that creates the merchant account (Create Users, Create Business Owner, etc.) view transactions processed through that account.Once you have created a user for a merchant account, you can associate that user to additional merchant accounts you create. |
4 | Create a Merchant Address | This call adds an address that is associated with the merchant account. |
5 | Create a Business Owner | This call adds a business owner of the merchant account. Consult these tables to see requirements for adding a business owner to a merchant account. |
6 | Create Business Owner Addresses | This call adds a current address for the business owner. In some jurisdictions, if the business owner has lived at the current address for fewer than 3 years, you must also add a previous address. |
7 | Create a Business Owner Identity Document | This call adds an identity document for the business owner, e.g., a driving license or passport. The identity document required varies by jurisdiction. |
8 | Create a Merchant Bank Account | This call creates a bank account for the merchant. This is the account into which their processed funds will be settled. |
9 | Get Terms and Conditions | This call retrieves the Terms and Conditions in HTML format for you to read. |
10 | Accept Terms and Conditions | The Platform Partner must display the Paysafe Terms and Conditions (T&Cs) to their merchant applicant. By accepting the T&Cs, the merchant acknowledges that they have read and accepted them for the services that are provided. Platform Partners are able to request the T&Cs for each product they offer through the Account Management API. |
11 | Activate Merchant Account | This call submits the merchant application for activation by Paysafe. After the application has been received it will be reviewed by our Risk and Compliance teams. |
12 | Account Status Notification | You can enable webhooks in the Paysafe Merchant Back Office in order to receive account status updates. This is not an API call. |
13 | Validate the Merchant Bank Account | This validates the applicant's bank account information. For some jurisdictions this is done by verifying the amount of a microdeposit made by Paysafe into that bank account. |
The Onboarding Flow graphic helps to illustrate this work flow.