• Register

Status Change

This webhook will be used to notify the FI that block code change was done either for account or card, or both.

Request Parameters:

Field Name Type Description Max Remarks
id String Unique Id for each Request 36 Mandatory
type String Static: StatusChange 15 Mandatory
timestamp String Eg: 2022-11-09T11:00:03Z 30 Mandatory
  details status account id value String AccountNumber 64 Conditional. Either account or card number will be sent.
  type String Static: accountNumber 20
card id value String EXID value: 99984200171137900000 32  Conditional. Either account or card number will be sent.
  type String   20
Static: externalCardId
type     String BCC-ACC1-% 30 Optional. Will be available in case CMS is Way4.
BCC-ACC2-%
BCC-CARD-%
oldValue     String Previous Block Code 40 Optional. Will be available in case CMS is Way4.
newValue     String New Block Code 40 Mandatory
Sample Account Block
{
    "id": "b876d568-8411-4638-bdef-a1a188a4773b ",
    "type": "StatusChange",
    "timestamp": "2022-11-09T11:00:03Z",
    "details": {
        "status": {
            "account": {
                "id": {
                    "value": "123456789",
                    "type": "accountNumber"
                }
            },
            "type": "BCC-ACC2-982",
            "oldValue": "",
            "newValue": "TEMPORARY_BLOCK_SERVICE"
        }
    }
}
Sample Card Block
{
    "id": "b876d568-8411-4638-bdef-a1a188a4773b",
    "type": "StatusChange",
    "timestamp": "2022-11-09T11:00:03Z",
    "details": {
        "status": {
            "card": {
                "id": {
                    "value": "99984200171137900000",
                    "type": "externalCardId"
                }
            },
            "type": "BCC-CARD-982",
            "oldValue": "",
            "newValue": "TEMPORARY_BLOCK_SERVICE"
        }
    }
}

 

Response Parameters:

Filed Name Type Max Remarks
id String 36 Mandatory
type String 15 Mandatory
timestamp String 30 Mandatory
response status code String 5 Mandatory
description String 30 Mandatory
Response Json
{
    "id": "b876d568-8411-4638-bdef-a1a188a4773b ",
    "type": "StatusChange",
    "timestamp": "2022-11-09T11:00:03Z",
    "response": {
        "status": {
            "code": "00",
            "description": "successful"
        }
    }
}

Docs Navigation