Complete Enrollment

post

https://api-{corename}.{env}.gpsrv.com/intserv/4.0/completeEnrollment

Use the Complete Enrollment endpoint to finalize an incomplete enrollment that was begun by Start Enrollment or Create Account. You must pass the same transactionId as the original Start Enrollment or Create Account request.

📘
Note
If this endpoint returns a status code that does not match a status code that is specific to this endpoint, it may be an enrollment status code. See Enrollment Statuses for more information.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Form Data

apiLogin

string

required

Web service username, as provided by Galileo.
Pattern: Max 50 characters
Example: "AbC123-9999"

apiTransKey

string

required

Web service password, as provided by Galileo.
Pattern: Max 15 characters
Example: "4sb62fh6w4h7w34g"

providerId

int32

required

Galileo-issued provider identifier.
Pattern: Max 10 digits
Example: 9999

transactionId

string

required

1 to 60

A unique provider-generated ID to identify this API call. A UUID is preferred.
Pattern: 60 characters or less
Example: "9845dk-39fdk3fj3-4483483478"

location

string | null

≤ 20

Unique location identifier (location) as returned by the Create Location endpoint. This value is also returned by the Get Locations endpoint depending on the value of locationType when the location was created:

0 or 2 — Returned in the location_id field
1 — Returned in the provider_specified_id field

Pattern: Integer if locationType: 0 or locationType: 2; max 15 characters if locationType: 1
Example: "a455-3483"

accountNo

string

^$|^([0-9]{12}|[0-9]{16})$

The PRN or PAN of the account.
Pattern: PRN or PAN
Example: "074103447228"

prodId

int32

required

0 to 100000000

Galileo-generated identifier for a product. If this ID is for a business product then businessName is required.
Pattern: Integer
Example: 501

locationType

int32 | null

enum

Type of ID in location:

0 — Galileo location ID
1 — Partner location ID
2 — Don't validate

Pattern: Integer
Example: 1

Allowed:

sharedBalance

int32 | null

enum

Specifies whether the secondary account will share the balance of the primary account. This parameter is required when primaryAccount is populated. Do not set this parameter to 1 when primaryAccount is not populated.

0 — Do not share the balance
1 — Share the balance

Pattern: Integer
Example: 1

Allowed:

offline

int32 | null

enum

Pass 1 for an offline transaction.
Pattern: Integer
Example: 1

Allowed:

primaryAccount

string | null

^$|^([0-9]{12}|[0-9]{16})$

PAN or PRN of the primary account to associate this account with. Populate this parameter only when creating a secondary account.
Pattern: PAN or PRN
Example: "123456789012"

externalAccountId

string | null

≤ 30

^[a-zA-Z0-9\-]*$

Identifier supplied by the provider, which is not related to the Galileo system. This ID is stored in the Galileo system in association with this account and can be provided in the RDFs.
Pattern: Max 30 alphanumeric characters. Lowercase only.
Example: "553b45sbs"

embossLine2

string | null

≤ 28

^[a-zA-Z0-9_\s\'"!\?]*$

Second line to emboss on the card.
Pattern: Supported characters
Example: "Scarlet Ibis Shipping"

fundingAccountNo

string | null

^$|^([0-9]{12})$

PRN of the RTF funding account. Required if prodId is an RTF spending product.
Pattern: 12-digit numeric string
Example: "143101204201"

Headers

response-content-type

string

enum

Defaults to json

Use this header instead of the standard accept header to specify the response format.

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/xml

default