POST Integration/GetMaxiCashCard
Request Information
URI Parameters
None.
Body Parameters
MaxiCashCardInputRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| RequestData | MaxiCashCardData |
None. |
|
| UserToken | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"RequestData": {
"Amount": "sample string 1",
"Reference": "sample string 2",
"MaxiCashCardID": "sample string 3",
"currency": "sample string 4",
"TelephoneNo": "sample string 5",
"Last4Digits": "sample string 6",
"Address1": "sample string 7",
"Address2": "sample string 8",
"Address3": "sample string 9",
"BirthDate": "sample string 10",
"City": "sample string 11",
"CountryCode": "sample string 12",
"Country": "sample string 13",
"EmailAddress": "sample string 14",
"FirstName": "sample string 15",
"IDValue": "sample string 16",
"LastName": "sample string 17",
"IdType": "sample string 18",
"IDdocument": "sample string 19",
"bvn": "sample string 20",
"selfie_image": "sample string 21",
"PostalCode": "sample string 22",
"StateRegion": "sample string 23",
"AgentName": "sample string 24",
"AgentEmail": "sample string 25",
"AgentMaxiCashID": "sample string 26",
"AgentReferralCode": "sample string 27",
"OTPKey": "sample string 28",
"OTPReference": "sample string 29",
"CardID": "sample string 30",
"CardHolderID": "sample string 31",
"card_type": "sample string 32",
"card_brand": "sample string 33",
"card_currency": "sample string 34",
"AgentCardOrderID": 35,
"IDissuedate": "sample string 36",
"intials": "sample string 37",
"title": "sample string 38",
"gender": "sample string 39",
"expiryDate": "sample string 40",
"FromDate": "2026-02-18T12:59:28.9759855+02:00",
"ToDate": "2026-02-18T12:59:28.9759855+02:00",
"FicaType": "sample string 43",
"SecondDocNumber": "sample string 44",
"SecondDocIssuedDate": "sample string 45",
"SecondDocExpiryDate": "sample string 46",
"SecondDocFile": "sample string 47",
"ProofOfAddressDoc": "sample string 48",
"SecondDocType": "sample string 49",
"ProviderName": "sample string 50"
},
"UserToken": "sample string 1"
}
application/xml, text/xml
Sample:
<MaxiCashCardInputRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MaxiCashWebApi.Models">
<RequestData>
<Address1>sample string 7</Address1>
<Address2>sample string 8</Address2>
<Address3>sample string 9</Address3>
<AgentCardOrderID>35</AgentCardOrderID>
<AgentEmail>sample string 25</AgentEmail>
<AgentMaxiCashID>sample string 26</AgentMaxiCashID>
<AgentName>sample string 24</AgentName>
<AgentReferralCode>sample string 27</AgentReferralCode>
<Amount>sample string 1</Amount>
<BirthDate>sample string 10</BirthDate>
<CardHolderID>sample string 31</CardHolderID>
<CardID>sample string 30</CardID>
<City>sample string 11</City>
<Country>sample string 13</Country>
<CountryCode>sample string 12</CountryCode>
<EmailAddress>sample string 14</EmailAddress>
<FicaType>sample string 43</FicaType>
<FirstName>sample string 15</FirstName>
<FromDate>2026-02-18T12:59:28.9759855+02:00</FromDate>
<IDValue>sample string 16</IDValue>
<IDdocument>sample string 19</IDdocument>
<IDissuedate>sample string 36</IDissuedate>
<IdType>sample string 18</IdType>
<Last4Digits>sample string 6</Last4Digits>
<LastName>sample string 17</LastName>
<MaxiCashCardID>sample string 3</MaxiCashCardID>
<OTPKey>sample string 28</OTPKey>
<OTPReference>sample string 29</OTPReference>
<PostalCode>sample string 22</PostalCode>
<ProofOfAddressDoc>sample string 48</ProofOfAddressDoc>
<ProviderName>sample string 50</ProviderName>
<Reference>sample string 2</Reference>
<SecondDocExpiryDate>sample string 46</SecondDocExpiryDate>
<SecondDocFile>sample string 47</SecondDocFile>
<SecondDocIssuedDate>sample string 45</SecondDocIssuedDate>
<SecondDocNumber>sample string 44</SecondDocNumber>
<SecondDocType>sample string 49</SecondDocType>
<StateRegion>sample string 23</StateRegion>
<TelephoneNo>sample string 5</TelephoneNo>
<ToDate>2026-02-18T12:59:28.9759855+02:00</ToDate>
<bvn>sample string 20</bvn>
<card_brand>sample string 33</card_brand>
<card_currency>sample string 34</card_currency>
<card_type>sample string 32</card_type>
<currency>sample string 4</currency>
<expiryDate>sample string 40</expiryDate>
<gender>sample string 39</gender>
<intials>sample string 37</intials>
<selfie_image>sample string 21</selfie_image>
<title>sample string 38</title>
</RequestData>
<UserToken>sample string 1</UserToken>
</MaxiCashCardInputRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
ServiceResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| SessionToken | string |
None. |
|
| ResponseStatus | string |
None. |
|
| ResponseError | string |
None. |
|
| ResponseData | string |
None. |
|
| ResponseDesc | string |
None. |
|
| TransactionID | string |
None. |
|
| Reference | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"SessionToken": "sample string 1",
"ResponseStatus": "sample string 2",
"ResponseError": "sample string 3",
"ResponseData": "sample string 4",
"ResponseDesc": "sample string 5",
"TransactionID": "sample string 6",
"Reference": "sample string 7"
}
application/xml, text/xml
Sample:
<ServiceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MaxiCashWebApi.Models"> <Reference>sample string 7</Reference> <ResponseData>sample string 4</ResponseData> <ResponseDesc>sample string 5</ResponseDesc> <ResponseError>sample string 3</ResponseError> <ResponseStatus>sample string 2</ResponseStatus> <SessionToken>sample string 1</SessionToken> <TransactionID>sample string 6</TransactionID> </ServiceResponse>