Guides
  1. Get started

Integration checklist

This page will guide you on how to get started.

Before you begin

  1. Get your credentials. Obtain your API key and Merchant Portal login from your Account manager. You need both to proceed.
  2. Log in to the Merchant Portal. Sign in at merchantportal.centrobill.com.
  3. Whitelist Centrobill IP addresses. Configure your server to accept incoming requests from Centrobill's IP addresses so that IPN callbacks are not blocked. Retrieve the current list from GET /ips.
  4. Switch your account to testing mode. Ask your Account manager to enable the testing profile before you start integration.
📘

OpenAPI specification

Download the latest OpenAPI specification:

https://readme.centrobill.com/openapi/centrobill-payment-api.json

Set up your integration

  1. Choose an integration method. Select the method that fits your requirements and follow the corresponding guide:

    MethodWhen to use
    Server-to-serverFull control over the checkout UI; requires PCI DSS certification
    TokenizationCustom checkout UI with reduced PCI scope via client-side tokenization
    Hosted payment pageCentrobill hosts the payment form; lowest PCI scope
    Express checkout flowJS SDK renders a checkout button; no server-side integration needed

  2. Set up a plugin if needed. If you're integrating via a platform rather than the API directly, check the available plugins:

  1. Tell your Account manager your chosen method. They will configure your account to match your integration setup.
  2. Create a website and at least one SKU in the Merchant Portal. Payments are linked to a website (site ID) and a product (SKU). See Create a website to initiate payment.
  3. Verify your payment form complies with Visa and Mastercard requirements before going live. See Check external payment form requirements.

Test your integration

  1. Use the Test Data API to create synthetic payment credentials and simulate different payment outcomes without processing real charges.

  2. Test the full payment flow end-to-end, including IPN delivery to your server.

  3. Verify your IPN handler correctly processes callbacks and responds with 200, 201, or 202.

Go live

  1. Once testing is complete, notify your Account manager that you're ready to go live.
  2. Your Account manager will review your setup and confirm when your account is activated for production.