Skip to main content
Integration Process

From requirement to production

Every CA API integration runs through the same eight stages. Two of them are checkpoints: we agree the scope in writing before you build, and we review your Sandbox integration before you go live. Everything else is you building, with our Developer Support team alongside you.

Open the requirements formBrowse the guides

The eight stages

The chip on each stage shows who drives it.

  1. 1

    Raise your integration requirement

    You + CA

    Tell CA you want to integrate. Your Account Manager owns everything commercial — pricing, agreements, invoicing. A dedicated Developer Support team owns the technical side from here on.

    What you get: An Account Manager for the commercials, and a Support team for the build.

  2. 2

    Read the documentation

    You

    Read the guides for your API surface before writing any code, so you can map your requirements onto what the platform already does.

    Keep a list of the questions that come up — they become the kickoff agenda.

    Client API guides · Program Manager API guides

    What you get: A clear view of which capabilities match your requirements.

  3. 3

    Complete the requirements sheet

    You

    Most of the API is part of every integration, so the sheet is short:

    • Your account structure — for Client integrations, whether you need Sub Accounts and which on-behalf-of flows.
    • The Sandbox Portal user — first name, last name, and email address.
    • The developer email that will receive your API credentials.
    • Any questions you want covered at the kickoff meeting.
    Open the requirements form

    What you get: An agreed scope of work, in writing.

  4. 4

    API integration kickoff meeting

    You + CA

    Ask for the kickoff once you have read the docs and sent your requirements sheet — you decide when you are ready. We walk through your scope and answer your questions.

    The kickoff and your Sandbox are independent: whichever comes first is fine.

    What you get: Scope confirmed.

  5. 5

    Sandbox provisioning

    CA

    Please note: An integration fee applies to all Sandbox requests and must be settled in full before we can open your Sandbox. Your Account Manager will coordinate this with you, and if you require Sandbox access urgently, we’re happy to work with you to find a suitable arrangement.

    CA then opens your Sandbox — before or after the kickoff, whichever suits you. Portal access goes to the named user, credentials to the developer email. Sandbox is a full copy of the platform where no real money moves.

    Quick Start: your first API call

    What you get: Sandbox Portal access, plus your Sandbox apiUser and apiKey.

  6. 6

    Build and test your integration

    You

    Build against the agreed scope and run your own testing in Sandbox. Developer Support is there throughout for anything the documentation does not answer.

    What you get: An integration that passes your internal testing.

  7. 7

    CA Sandbox review

    CA

    Tell us when your testing is done. We review your Sandbox integration against the requirements sheet — checking the flows you scoped have actually been exercised and the build is ready for production.

    It either passes or comes back with changes to make, followed by another review — leave room for that round in your go-live plan.

    What you get: Sandbox sign-off from CA.

  8. 8

    Production credentials and go-live

    You + CA

    Once the review is signed off, contact your Account Manager to request your production credentials. The apiUser and apiKey are issued to your Company Admin.

    Only the base URL changes between environments — your Sandbox integration works unchanged against production.

    What you get: Production credentials, issued to your Company Admin.

Where your credentials are sent

Sandbox and production credentials deliberately go to different people. Plan for the handover before you reach go-live.

Sandbox

To your developer email

The developer email you name on the requirements sheet receives the Sandbox apiUser and apiKey. Use a shared team inbox rather than one person’s address — it saves a round trip if that person moves on mid-integration.

Production

To your Company Admin

Production credentials are issued only to the Company Admin who requested through your Account Manager and issued only to your Company Admin. They are never sent to the developer email.

Your engineering team will not receive the production credentials directly. The Company Admin passes them on under your own internal key-handling process — decide who does that, and how, before go-live.

Ready to scope your integration?

Once you have read the guides for your API surface, record what you need on the requirements sheet and send it to your Account Manager.

Open the requirements form