Registers a new user at a payment provider or updates an existing user registration

post/userEnrollments

Request

Base URL
https://api.test.kalixa.com/api/v5
URL
https://api.test.kalixa.com/api/v5/userEnrollments
Auth
none declared

Request body

merchantIdstring required

MerchantID in Kalixa system

clientSystemUserEnrollmentIdstring required

UserEnrollmentID in the client system

typestring required

Type of the Enrollment.account.sightline

userIdstring required

External User ID

detailsobject

Additional details for the User Enrollment. Parameters for Sightline - ReturnUrl, MemberNumber

Example request

{
  "merchantId": "companyXY",
  "details": {
    "ReturnUrl": "SuccessPageUrl",
    "MemberNumber": 12345678,
    "MerchantName": "MerchantXYZ"
  },
  "clientSystemUserEnrollmentId": "enrollment123",
  "type": "account.sightline",
  "userId": 5678432
}

Response

Successful operation

idstring

The server generated ID of the user Enrollment

statestring

Name of the last state

detailsobject

Example response

{
  "id": "8296567f-2822-47a6-b938-f4f853f364a5",
  "state": "EnrollmentRedirectDataCreated",
  "details": {
    "MemberNumber": 12345678,
    "FirstName": "John",
    "LastName": "Doe",
    "PhoneNumber": 9898989898,
    "Email": "john.doe@gmail.com",
    "Address": "238 NW 4th Ave",
    "City": "Portland",
    "State": "OR",
    "Country": "US",
    "PostalCode": 97209,
    "IdentityToken": "SgBrADcAcgBWADMALwBDAHgARQBiAG8AZwBlAHoAZwBtAFgAYwBvAGgASQBPAGMAVgBvACsATgBvAEQAdwA1AG4AbgBhAHUAaABRAEIAVAB2AG0AWgB5AG4AawB2ADgAeABoADUANwBOACsAMABtAFQAdwA4AGQAbABOADgAYQAzAG8AVwBKAEkATQA3AHQA",
    "MerchantID": "CompanyXY",
    "MerchantApplication": "CXY01",
    "ClientSystemUserEnrollmentID": "enrollment123",
    "ReturnURL": null,
    "MerchantName": "CompanyXY",
    "ProviderSourceURL": "https://providerurl.com/HostedFunding"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.