Guides

Prerequisites & Onboarding

Overview

Before integration development or testing can begin, a set of configuration values and credentials must be provisioned by Green Dot. This is not a self-service process - all items below are delivered by your Green Dot integration contact.

Required Items

ItemDescriptionProvided By
Azure AD CredentialsclientId and clientSecret per environmentGreen Dot
EC Public KeyElliptic curve public key per environment, used to encrypt customer PII before sending it to the APIGreen Dot
Program Code{PROGRAM_CODE} - identifies your integration in all API pathsGreen Dot
Product Code{PRODUCT_CODE} - identifies the Green Dot productGreen Dot
Product Material Types{PRODUCT_MATERIAL_TYPE_VIRTUAL} and {PRODUCT_MATERIAL_TYPE_EMV} - used in Enrollment and Order Card requestsGreen Dot
Terms IdentifiersThe exact list of termsIdentifier values required for your product, and their required termsAcceptanceFlag valuesGreen Dot (confirmed during product setup)
APIM Audience IDPer-environment Azure AD audience ID - used in the token scopeGreen Dot
Base URLsPer-environment API base URLsGreen Dot
Outbound IP RangesPartner must provide their outbound IP ranges to Green Dot for firewall allowlistingPartner provides to Green Dot
Order Card TriggerPartner determines and implements the business condition (e.g., refund received) that triggers the Order Card API callPartner implements

Environment Base URLs

EnvironmentBase URLNotes
DEV{DEV_BASE_URL}
QA{QA_BASE_URL}
PIE (East US){PIE_EAST_BASE_URL}
PIE (West US3){PIE_WEST_BASE_URL}
PROD (East US){PROD_EAST_BASE_URL}Primary
PROD (West US3){PROD_WEST_BASE_URL}Secondary region

Full API path pattern:

{BASE_URL}/programs/{PROGRAM_CODE}/enrollment      ← Enrollment
{BASE_URL}/programs/{PROGRAM_CODE}/lifecycleEvent  ← Order Card
{BASE_URL}/healthcheck                             ← Health Check

Azure AD Tenant & Audience IDs

The tenant ID is the same across all environments. The audience ID is per-environment and is used to construct the OAuth 2.0 token scope.

EnvironmentTenant IDAudience ID
DEV{TENANT_ID}{DEV_AUDIENCE_ID}
QA{TENANT_ID}{QA_AUDIENCE_ID}
PIE{TENANT_ID}{PIE_AUDIENCE_ID}
PROD{TENANT_ID}{PROD_AUDIENCE_ID}

Onboarding Checklist

Use this checklist to confirm you are ready to begin integration development.

Received from Green Dot:

  • clientId and clientSecret for DEV / QA environments
  • EC public key for DEV / QA environments
  • programCode confirmed
  • productCode confirmed
  • productMaterialType values confirmed (virtual and EMV)
  • Required termsIdentifier list and expected flag values confirmed
  • APIM Audience IDs confirmed
  • Base URLs confirmed for target environments

Provided to Green Dot:

  • Outbound IP ranges submitted for firewall allowlisting

Partner implementation ready:

  • OAuth 2.0 token acquisition implemented with caching and auto-refresh
  • EC_v1 PII encryption implemented using GD's EC public key
  • Order Card business trigger logic defined and implemented
  • HTTP client timeout set to at least 35 seconds
  • Connectivity verified using the /healthcheck endpoint

Getting Help

Contact your Green Dot integration contact for:

  • Credential provisioning
  • Terms identifier confirmation
  • IP allowlisting
  • Questions about product setup or go-live readiness

Next Steps

  • Authentication - how to obtain and use Azure AD Bearer tokens

  • API Reference - endpoint specifications, field rules, and error catalogs

Updated 6 days ago

Did this page help you?