Skip to main content

Login

info

This API checks whether the provided ssoCustomerId already exists inside the payment gateway system. If not, it automatically registers the user and logs them in.

Test environment: https://api-onramp.stg.eopay.io/login/sso-login

Production environment: https://api-onramp.eopay.io/login/sso-login

API Signature

Signature flow

Request Parameters

ParameterTypeDescription
saasUserCorporationIdstringChannel ID assigned by the payment gateway system
ssoCustomerIdstringUnique customer ID from the merchant system. Example: sso_customer_id = "abc0000001"
merchantIdnumberMerchant unique ID assigned by the payment gateway system
ssoHashstringHash generated with the payment gateway system-issued key. See login hash example
emailAddressstringEmail registered with the customer’s card-issuing bank
firstNamestringCustomer legal first name
lastNamestringCustomer legal last name
dobstringDate of birth, format YYYY-M-D, e.g., dob="2000-1-25"

Success Response

{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6NTg1MCwidHlwZSI6MCwiaWF0IjoxNzQ4OTU3Mzk5LCJleHAiOjE3NDg5NjQ1OTl9.V42ah7m76sBFtzZm40HyuAET_aObi9mbNgHCUi4zYw8",
"user": {
"id": 111,
"email": "aa2aa@sdsdd65.com",
"countryCode": null,
"phoneNumber": null,
"displayName": null,
"type": 0,
"avatar": null,
"mfaSetting": 0,
"kycId": 111,
"kycVeriffUuid": null,
"kycStatus": 1,
"role": 1,
"idRef": null,
"activated": 1,
"password": null,
"createdAt": "2025-06-03T13:29:15.000Z",
"customerId": 5751,
"firstName": "Tester",
"lastName": "Test",
"birthday": "1899-11-30T00:00:00.000Z",
"ssoKyc": 1,
"kycConfig": 0
},
"message": "Log In Success."
}

Signature Validation Failure Response

{ message: 'HashCode not correct' }

API Test Tool