POST v1/api/CreditCardEnrollment?caseId={caseId}&await={await}
Credit Card Enrollment to create an Enrollment, Billing Account and Funding Account on our PCI enabled system for 103 processing
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| caseId |
(optional - but recommended) a unique identifier to both group calls, and to tie a Case to an Agency. |
string |
None. |
| await |
(optional) do not wait for service to execute |
string |
None. |
Body Parameters
CreditCardEnrollmentDto
CreditCardEnrollmentDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Profile | CreditCardProfile |
None. |
|
| AccountInfo | CreditCardAccountInfo |
None. |
Request Formats
application/json
Sample:
REQUEST
{
"Profile": {
"CaseId103": "123498123",
"Name": "Harry Tester",
"Email": "htester@me.com",
"Address1": "1 Main St",
"City": "Boston",
"State": "AZ",
"PostalCode": "01899",
"Country": "US"
},
"AccountInfo": {
"CardType": "MSTR",
"CardNumber": "5588595259541256",
"ExpirationYear": "2024",
"ExpirationMonth": "11",
"securityCode": "256"
}
}
Response Information
Resource Description
ServiceResponse containing resulting status and CreditCardEnrollmentResponseDto
ServiceResponseOfCreditCardEnrollmentDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | CreditCardEnrollmentDto |
None. |
|
| IsSuccess | boolean |
None. |
|
| ErrorCode | string |
None. |
|
| FriendlyException | string |
None. |
|
| DetailException | string |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| IsShutdown | boolean |
None. |
Response Formats
application/json
Sample:
RESPONSE
{
"TokenId":"12220480|db56f70f4db303a24a2a6941f5c756d59c4ced80a4b4d3dc952490dc44903e70",
"CreditCardEnrollment":{
"Profile":{
"CaseId103":"123498123",
"Email":"htester@me.com",
"State":"Arizona",
"Country":"United States of America",
"Name":"Harry Tester",
"Address1":"1 Main St",
"City":"Boston",
"PostalCode":"01899"
},
"AccountInfo":{
"CardType":"MSTR",
"CardNumber":"5588595259541256",
"ExpirationYear":"2024",
"ExpirationMonth":"11",
"SecurityCode":"256"
}
}
}