OOB Authentication Callback

BaaS Client is expected to use this callback to intimate NIUM after successfully processing OOB authentication as part of the Strong Customer Authentication (SCA) flow.

POST https://apisandbox.spend.nium.com/api/v1/oob/callback

Headers

HeaderParameters
Content-Typeapplication/JSON
x-request-idUUID
x-client-nameString

Example Request

curl -X POST \
  https://apisandbox.spend.nium.com/api/v1/oob/callback \
  -H 'content-type: application/json' \
  -H 'x-request-id: 123e4567-e89b-12d3-a456-426655440000' \
  -H 'x-client-name: Cards-Customer-Service' \
​
  -d '{
    "authTransactionId": "2096355c-57c3-43c6-9c4a-fb155a026e06",
    "referenceNumber": "1b6865e4-5839-424a-8e73-965ef15c5d89",
    "status": "Success",
    "statusCode": "SSS000"
}'
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

FieldDescriptionTypeRequired
authTransactionIdUnique ID for transaction received during OOB authentication.UUIDRequired
referenceNumberUnique ID associated with the OOB request from client system.UUIDRequired
statusStatus of OOB authentication processing. It signifies whether the client was able to process the authentication or not. Since the client will use this callback only after processing the OOB authentication, the expected value from the client is Success. Refer statusCode for the result of OOB authentication.StringOptional
statusCodeThe OOB authentication status code. It signifies whether the transaction was approved or declined. The possible values are:
SSS000 - OOB authentication approved.
VCU701 - OOB authentication declined.
StringRequired

Example Response

{
  "status" : "Success"
 }

Response Body

FieldDescriptionType
statusThe status of the request after processing at NIUM. Possible values are:
Success - When the request is processed successfully.
Failed - When the request is not processed successfully.
String