POST GtCollection/ClientOnboarding
Request Information
URI Parameters
None.
Body Parameters
GtcOnboardingRequestName | Description | Type | Additional information |
---|---|---|---|
ServiceUsername | string |
Required |
|
ServicePassword | string |
Required |
|
EmailAddress | string |
Required |
|
Amount | decimal number |
Required |
|
ProductCode | string |
Required |
|
Surname | string |
Required |
|
FirstName | string |
Required |
|
MobileNumber | string |
Required |
|
DateOfBirth | date |
Required |
|
Bvn | string |
Required |
Request Formats
application/json, text/json
Sample:
{ "DateOfBirth": "2025-04-28T11:41:21.9926064Z", "Amount": 4, "Bvn": "sample string 10", "MobileNumber": "sample string 8", "FirstName": "sample string 7", "Surname": "sample string 6", "ProductCode": "sample string 5", "EmailAddress": "sample string 3", "ServicePassword": "sample string 2", "ServiceUsername": "sample string 1" }
application/xml, text/xml
Sample:
<GtcOnboardingRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <ServiceUsername>sample string 1</ServiceUsername> <ServicePassword>sample string 2</ServicePassword> <EmailAddress>sample string 3</EmailAddress> <Amount>4</Amount> <ProductCode>sample string 5</ProductCode> <Surname>sample string 6</Surname> <FirstName>sample string 7</FirstName> <MobileNumber>sample string 8</MobileNumber> <DateOfBirth>2025-04-28T12:41:21.9926064+01:00</DateOfBirth> <Bvn>sample string 10</Bvn> </GtcOnboardingRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
GtcOnboardingResponseName | Description | Type | Additional information |
---|---|---|---|
Status | integer |
None. |
|
StatusMessage | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Status": 1, "StatusMessage": "sample string 2" }
application/xml, text/xml
Sample:
<GtcOnboardingResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <Status>1</Status> <StatusMessage>sample string 2</StatusMessage> </GtcOnboardingResponse>