Initiate OOB Authentication
Initiate Out-of-Band Authentication
This end point is to be implemented by BaaS Client. Nium will call this endpoint in order to initiate the process of OOB (Out Of Band) authentication.
POST https://<EComAuthCodeValidationBaseURL>/oob
NOTE
EComAuthCodeValidationBaseURLis the URL provided by client during setup which will be used further by NIUM as a base URL.
Headers
| Header | Parameter |
|---|---|
content-type | application/JSON |
x-request-id | UUID |
x-client-name | String |
Example Request
curl -X POST \
https://<EComAuthCodeValidationBaseURL>/oob \
-H 'content-type: application/json' \
-H 'x-request-id: 123e4567-e89b-12d3-a456-426655440000' \
-H 'x-client-name: Cards-Customer-Service' \
-d '{
"authTransactionId" : "e5610bdf-12b1-9807-4ccf-09b70bcff776",
"clientHashId" : "e2710bdf-25b1-4535-9ccf-09b70bcff684",
"cardHashId" : "e3008bdf-25b1-4535-9ccf-09b70bcff684",
"customerHashId" : "e2708eef-25b1-4535-9ccf-09b70bcff684",
"walletHashId" : "e2708bdf-25b1-4535-9ccf-09b70bcdd684",
"merchantName" : "Test Merchant",
"maskedCardNumber" : "4611-35xx-xxxx-1234",
"transactionAmount" : "1.10",
"transactionCurrency" : "EUR"
}'
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n \"authTransactionId\" : \"e5610bdf-12b1-9807-4ccf-09b70bcff776\",\r\n \"clientHashId\" : \"e2710bdf-25b1-4535-9ccf-09b70bcff684\",\r\n \"cardHashId\" : \"e3008bdf-25b1-4535-9ccf-09b70bcff684\",\r\n \"customerHashId\" : \"e2708eef-25b1-4535-9ccf-09b70bcff684\",\r\n \"walletHashId\" : \"e2708bdf-25b1-4535-9ccf-09b70bcdd684\",\r\n \"merchantName\" : \"Test Merchant\",\r\n \"maskedCardNumber\" : \"4611-35xx-xxxx-1234\",\r\n \"transactionAmount\" : \"1.10\",\r\n \"transactionCurrency\" : \"EUR\"\r\n}");
Request request = new Request.Builder()
.url("https://<EComAuthCodeValidationBaseURL>/oob")
.post(body)
.addHeader("content-type", "application/json")
.addHeader("x-request-id", "123e4567-e89b-12d3-a456-426655440000")
.addHeader("x-client-name", "Cards-Customer-Service")
.build();
Response response = client.newCall(request).execute();
var settings = {
"https://<EComAuthCodeValidationBaseURL>/oob",
"method": "POST",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"x-request-id": "123e4567-e89b-12d3-a456-426655440000",
"x-client-name": "Cards-Customer-Service"
},
"data": JSON.stringify({
"authTransactionId": "e5610bdf-12b1-9807-4ccf-09b70bcff776",
"clientHashId": "e2710bdf-25b1-4535-9ccf-09b70bcff684",
"cardHashId": "e3008bdf-25b1-4535-9ccf-09b70bcff684",
"customerHashId": "e2708eef-25b1-4535-9ccf-09b70bcff684",
"walletHashId": "e2708bdf-25b1-4535-9ccf-09b70bcdd684",
"merchantName": "Test Merchant",
"maskedCardNumber": "4611-35xx-xxxx-1234",
"transactionAmount": "1.10",
"transactionCurrency": "EUR"
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
import requests
url = "https://<EComAuthCodeValidationBaseURL>/oob"
payload = json.dumps({
"authTransactionId": "e5610bdf-12b1-9807-4ccf-09b70bcff776",
"clientHashId": "e2710bdf-25b1-4535-9ccf-09b70bcff684",
"cardHashId": "e3008bdf-25b1-4535-9ccf-09b70bcff684",
"customerHashId": "e2708eef-25b1-4535-9ccf-09b70bcff684",
"walletHashId": "e2708bdf-25b1-4535-9ccf-09b70bcdd684",
"merchantName": "Test Merchant",
"maskedCardNumber": "4611-35xx-xxxx-1234",
"transactionAmount": "1.10",
"transactionCurrency": "EUR"
})
headers = {
'content-type': "application/json",
'x-request-id': "123e4567-e89b-12d3-a456-426655440000",
'x-client-name': "Cards-Customer-Service"
}
response = requests.request("POST", url, data=payload, headers=headers)
print(response.text)
Request Body
| Field | Description | Type | Required |
|---|---|---|---|
authTransactionId | Unique ID generated for a transaction. | UUID | Required |
clientHashId | Unique client identifier generated and shared before API handshake. | UUID | Required |
cardHashId | Unique card identifier generated while new/add-on card issuance. | UUID | Required |
customerHashId | Unique customer identifier generated on customer creation. | UUID | Required |
walletHashId | Unique wallet identifier generated during customer creation. | UUID | Required |
merchantName | This field accepts the merchant name. | String | Required |
maskedCardNumber | This field accepts the mask card number. | String | Required |
transactionAmount | This field accepts the transaction amount up to 2 decimals. | String | Required |
transactionCurrency | The 3-letter ISO currency code for the transaction. | String | Required |
Example Response
200 OK
Response Body
NIUM shall respond with HTTP response code 200.
Updated 4 days ago