Skip to main content

Integration checklist

This step-by-step checklist helps you configure integration with WhiteBoot services, test your setup, and start accepting payments from your customers.

Step 1. Get familiar with the merchant portal​

  1. Create an account​

    To connect to WhiteBoot and work with payments, register in the merchant portal
    Account registration guide.

  2. Add other team members​

    You can give your team access to the account right away. Access levels can be managed with the predefined roles available in the merchant portal Adding users.

  3. Review the test project and use its API keys​

    After registration, you immediately get access to a test project and its authentication credentials: API keys. Use them to configure and test payments before switching to a live project
    Test project.

Step 2. Configure the integration and run test payments​

Before accepting payments on your live project, make sure the settings and payment flows are configured correctly.

  1. Complete onboarding​

    Contact WhiteBoot support to complete data verification and define cooperation terms
    WhiteBoot support.

  2. Configure the integration​

    Choose the required integration method and configure it using the test project data Integration options.

  3. Run test payments​

    Use test payment data to check different card payment scenarios Test payments.

  4. Handle errors and failed payments​

    Make sure that API requests are formed correctly and that you receive correct responses for failed payments and errors that may occur while creating or processing payments.

  5. Test refunds and voids​

    Check how refunds and pre-authorization voids work if you use two-step payments. You can test these flows using payments created earlier.

  6. Configure payment card verification (optional)​

    This feature helps confirm that the payer's card is valid and that the card details are correct.

  7. Configure alternative payment methods (optional)​

    If you plan to work with payment methods other than cards, review their setup details Payment methods.

Step 3. Configure webhooks​

WhiteBoot uses webhooks to send information about different payment events, including payment statuses, successful 3DS verification, debits, holds, refunds, captures, and voids. To receive this data, configure webhook integration.

  1. Define the webhook structure​

    Review required and optional webhook parameters and decide which ones you need
    Webhooks.

  2. Open an endpoint for webhooks​

    Provide a publicly available URL so your endpoint can receive WhiteBoot webhooks.

  3. Receive and process notifications​

    Receive and process notifications with information about payments, individual operations, and their statuses.

Step 4. Work with reporting data​

  1. Get more payment information​

    Use receipts, transaction details, order details, and related data Payment information.

  2. Configure transaction report delivery (optional)​

    Automatically receive transaction reports via API or through the report scheduler in the merchant portal. You define the data scope, delivery date and time, and report format.

Step 5. Go live​

After testing the payment process with test data, connect your live project and complete a few additional settings for further work.

  1. Create a live project​

    Sign in to the merchant portal and create a live project. Replace the test project authentication credentials on your side with the live project credentials.

  2. Strengthen account security​

    • Configure two-factor authentication (recommended).
    • Define the allowed IP addresses for API interaction (optional).

  3. Configure the payment page or payment widget (optional)​

    To accept payments, you can use:

  4. Run end-to-end testing​

    The final integration step is to verify that all stages and scenarios of your payment cycle work correctly.