post https://example.com/programs//enrollments
Creates a new enrollment for a user, including account and card creation. Supports instant issue scenarios and account upgrades (for example, from GPG to DDA if the "upgradeFlag" parameter is true). This endpoint is also used for the card-in-hand use case to support instant issue enrollment.
Key operations performed:
- Create new user
- Create account
- Create payment instrument
- Support instant issue enrollment
- Support account upgrade
Note: If POST /enrollments is called with a valid request and enrollment fails during processing, the request will be automatically completed if the customer clears OFAC.
| Name | Comment |
|---|---|
| 200 | Success |
| 400 | Bad request, such as unsupported operation |
| 401 | Unauthorized |
| Group | Property | Required | Constraint/Scenario | HttpStatus | Code | Sub Code | Description |
|---|---|---|---|---|---|---|---|
| PACKAGE_LOOKUP_EXCEPTION | 400 | 5020 | 5021 | Connection issue looking up package info | |||
| PACKAGE_NOT_FOUND | 400 | 5020 | 5022 | No package is associated with the provided identifier | |||
| PACKAGEID_IN_USE | 400 | 5020 | 5023 | The package associated with the identifier is already being used | |||
| INSTANT_ISSUE_NOT_SUPPORTED | 400 | 5030 | 5031 | Product does not support instant issue enrollment | |||
| INSTANT_ISSUE_REQUEST_PHYSICAL_CARD_NOT_SUPPORTED | 400 | 5030 | 5032 | Product does not support requesting a physical card during instant issue enrollment | |||
| instantIssue | type | Y ONLY if enrollment is instantIssue | INSTANT_ISSUE_TYPE | 400 | 600 | Required: 6181, Invalid: 6182 | If instantIssue object is provided, then type must be provided. Must be CBS |
| instantIssue | mappingIdentifier | Y ONLY if enrollment is instantIssue | INSTANT_ISSUE_MAPPING_IDENTIFIER | 400 | 600 | Required: 6183, Invalid: 6184 | If instantIssue object is provided, then mappingIdentifier must be provided |
| accountIdentifier | N | missing/invalid accountIdentifier | 400 | 350 | 0 | accountIdentifier is invalid | |
| change user profile | 400 | 4502 | 0 | User profile cannot be changed | |||
| account status not normal | 400 | 4503 | 0 | Account status is not healthy | |||
| target product code same as current product code | 400 | 4504 | 0 | Account already upgraded successfully | |||
| same requestId, accountIdentifier is different | 400 | 4505 | 0 | Account not matched | |||
| target product code not allowed for upgrade | 400 | 4506 | 0 | Account already upgraded successfully | |||
| account not found | 400 | 10 | 0 | Account, account holder, or user not found | |||
| [CPM] upgrade service returned error | 400 | 5030 | 0 | A downstream provider did not return success for Upgrade Account |