OOB Authentication Callback
Use this callback to notify Nium after successfully processing your out-of-band (OOB) authentication as part of the strong customer authentication (SCA) flow.
POST https://gateway.nium.com/api/v2/client/{clientHashId}/notifications/3ds/oob/callback
Headers
Header | Parameters |
---|---|
content-type | application/JSON |
x-request-id | UUID |
x-client-name | String |
Request example
curl --request POST \
--url https://gateway.nium.com/n1/api/v2/client/{clientHashId}/3ds/oob/callback \
--header 'x-api-key: 0mZpIhaLVM1qd8IJhCfgjeJjsY7b5zde10j' \
--header 'x-request-id: 123e4567-e89b-12d3-a456-426655440000' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"authTransactionId": "2096355c-57c3-43c6-9c4a-fb155a026e06",
"referenceNumber": "1b6865e4-5839-424a-8e73-965ef15c5d89",
"statuscode": "001",
"message": "Success"
}'
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/octet-stream");
RequestBody body = RequestBody.create(mediaType, "{\r\n \"authTransactionId\": \"2096355c-57c3-43c6-9c4a-fb155a026e06\",\r\n \"referenceNumber\": \"1b6865e4-5839-424a-8e73-965ef15c5d89\",\r\n \"status\": \"Success\",\r\n \"statusCode\": \"SSS000\"\r\n}");
Request request = new Request.Builder()
.url("https://apisandbox.spend.nium.com/api/v1/oob/callback")
.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 = {
"async": true,
"crossDomain": true,
"url": "https://apisandbox.spend.nium.com/api/v1/oob/callback",
"method": "POST",
"headers": {
"content-type": "application/json",
"x-client-name": "Cards-Customer-Service",
"x-request-id": "123e4567-e89b-12d3-a456-426655440000"
},
"data": JSON.stringify({
"authTransactionId": "2096355c-57c3-43c6-9c4a-fb155a026e06",
"referenceNumber": "1b6865e4-5839-424a-8e73-965ef15c5d89",
"status": "Success",
"statusCode": "SSS000"
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
import requests
url = "https://apisandbox.spend.nium.com/api/v1/oob/callback"
payload = json.dumps({
"authTransactionId": "2096355c-57c3-43c6-9c4a-fb155a026e06",
"referenceNumber": "1b6865e4-5839-424a-8e73-965ef15c5d89",
"status": "Success",
"statusCode": "SSS000"
})
headers = {
'content-type': 'application/json',
'x-client-name': 'Cards-Customer-Service',
'x-request-id': '123e4567-e89b-12d3-a456-426655440000'
}
response = requests.request("POST", url, data=payload, headers=headers)
print(response.text)
Request body
Field | Description | Type | Required |
---|---|---|---|
authTransactionId | An authorization transaction ID is the unique ID of the transaction received during the OOB authentication. | UUID | Required |
referenceNumber | A reference number is a unique ID associated with the OOB request from your system. | UUID | Required |
statusCode | The OOB authentication status code. It signifies whether the transaction is approved or declined. The possible values are: • SSS000 — OOB authentication approved. • VCU701 — OOB authentication declined. | String | Required |
message | The client will send this in case of Sucess/Failure responses to NIUM | Upto 500 Char | Optional |
Response example
{
"status" : "Success"
}
Response body
Field | Description | Type |
---|---|---|
status | The status of the request after processing at Nium. The possible values are: • Success — When the request is processed successfully. • Failed — When the request is not processed successfully. | String |
Updated 26 days ago