Events
API Reference
API reference for events
MERCHANT_OPENED
Triggered when a merchant is opened.
Request example
{
"event": "MERCHANT_OPENED",
"session_id": "fb5aa994-ed1c-4c3e-b29a-b2a53222e584",
"merchant": {
"id": 11,
"name": "Uber"
},
"timestamp": "2022-08-15 13:47:15"
}
CREDENTIALS_REQUIRED
Triggered when a merchant is asking for credentials.
Request example
{
"event": "CREDENTIALS_REQUIRED",
"session_id": "fb5aa994-ed1c-4c3e-b29a-b2a53222e584",
"task_id": 25605,
"external_user_id": "3dcbb19a-b2f1-4a7b-8792-d76027b627b3",
"merchant": {
"id": 11,
"name": "Uber"
},
"data": {
"card_id": "123456789"
},
"timestamp": "2022-08-15 13:47:15"
}
CREDENTIALS_SUCCESS
Triggered when the credentials in the merchant are correct.
Request example
{
"event": "CREDENTIALS_SUCCESS",
"session_id": "fb5aa994-ed1c-4c3e-b29a-b2a53222e584",
"task_id": 25605,
"external_user_id": "3dcbb19a-b2f1-4a7b-8792-d76027b627b3",
"merchant": {
"id": 11,
"name": "Uber"
},
"data": {
"card_id": "123456789"
},
"timestamp": "2022-08-15 13:47:15"
}
CREDENTIALS_FAILED
Triggered when the credentials in the merchant are incorrect.
Request example
{
"event": "CREDENTIALS_FAILED",
"session_id": "fb5aa994-ed1c-4c3e-b29a-b2a53222e584",
"task_id": 25605,
"external_user_id": "3dcbb19a-b2f1-4a7b-8792-d76027b627b3",
"merchant": {
"id": 11,
"name": "Uber"
},
"data": {
"card_id": "123456789"
},
"timestamp": "2022-08-15 13:47:15"
}
OTP_REQUIRED
Triggered when a merchant is asking for OTP.
Request example
{
"event": "OTP_REQUIRED",
"session_id": "fb5aa994-ed1c-4c3e-b29a-b2a53222e584",
"task_id": 25605,
"external_user_id": "3dcbb19a-b2f1-4a7b-8792-d76027b627b3",
"merchant": {
"id": 11,
"name": "Uber"
},
"data": {
"card_id": "123456789"
},
"timestamp": "2022-08-15 13:47:15"
}
OTP_FAILED
Triggered when the OTP in the merchant is incorrect.
Request example
{
"event": "OTP_FAILED",
"session_id": "fb5aa994-ed1c-4c3e-b29a-b2a53222e584",
"task_id": 25605,
"external_user_id": "3dcbb19a-b2f1-4a7b-8792-d76027b627b3",
"merchant": {
"id": 11,
"name": "Uber"
},
"data": {
"card_id": "123456789"
},
"timestamp": "2022-08-15 13:47:15"
}
LOGIN_APPROVAL
Triggered when we need the user to approve the login attempt on the merchant.
Request example
{
"event": "LOGIN_APPROVAL",
"session_id": "fb5aa994-ed1c-4c3e-b29a-b2a53222e584",
"task_id": 25605,
"external_user_id": "3dcbb19a-b2f1-4a7b-8792-d76027b627b3",
"merchant": {
"id": 11,
"name": "Uber"
},
"data": {
"card_id": "123456789"
},
"timestamp": "2022-08-15 13:47:15"
}
QUESTIONS_REQUIRED
Triggered when a merchant is asking security questions.
Request example
{
"event": "QUESTIONS_REQUIRED",
"session_id": "fb5aa994-ed1c-4c3e-b29a-b2a53222e584",
"task_id": 25605,
"external_user_id": "3dcbb19a-b2f1-4a7b-8792-d76027b627b3",
"merchant": {
"id": 11,
"name": "Uber"
},
"data": {
"card_id": "123456789"
},
"timestamp": "2022-08-15 13:47:15"
}
QUESTIONS_FAILED
Triggered when the answers for questions in the merchant are incorrect.
Request example
{
"event": "QUESTIONS_FAILED",
"session_id": "fb5aa994-ed1c-4c3e-b29a-b2a53222e584",
"task_id": 25605,
"external_user_id": "3dcbb19a-b2f1-4a7b-8792-d76027b627b3",
"merchant": {
"id": 11,
"name": "Uber"
},
"data": {
"card_id": "123456789"
},
"timestamp": "2022-08-15 13:47:15"
}
AUTHENTICATED
Triggered when the authentication is successful in a merchant. You should call send card after getting this event.
Request example
{
"event": "AUTHENTICATED",
"session_id": "fb5aa994-ed1c-4c3e-b29a-b2a53222e584",
"task_id": 25605,
"external_user_id": "3dcbb19a-b2f1-4a7b-8792-d76027b627b3",
"merchant": {
"id": 11,
"name": "Uber"
},
"data": {
"card_id": "123456789"
},
"timestamp": "2022-08-15 13:47:15"
}
CARD_UPDATING
Triggered when we are going to update a card in a merchant.
Request example
{
"event": "CARD_UPDATING",
"session_id": "fb5aa994-ed1c-4c3e-b29a-b2a53222e584",
"task_id": 25605,
"external_user_id": "3dcbb19a-b2f1-4a7b-8792-d76027b627b3",
"merchant": {
"id": 11,
"name": "Uber"
},
"data": {
"card_id": "123456789"
},
"timestamp": "2022-08-15 13:47:15"
}
CARD_UPDATED
Triggered when a card is successfully updated in a merchant.
Request example
{
"event": "CARD_UPDATED",
"session_id": "fb5aa994-ed1c-4c3e-b29a-b2a53222e584",
"task_id": 25605,
"external_user_id": "3dcbb19a-b2f1-4a7b-8792-d76027b627b3",
"merchant": {
"id": 11,
"name": "Uber"
},
"data": {
"card_id": "123456789"
},
"timestamp": "2022-08-15 13:47:15"
}
CARD_UPDATE_PENDING
Triggered when we are pending to update in a merchant.
Request example
{
"event": "CARD_UPDATE_PENDING",
"session_id": "fb5aa994-ed1c-4c3e-b29a-b2a53222e584",
"task_id": 25605,
"external_user_id": "3dcbb19a-b2f1-4a7b-8792-d76027b627b3",
"merchant": {
"id": 11,
"name": "Uber"
},
"data": {
"card_id": "123456789"
},
"timestamp": "2022-08-15 13:47:15"
}
CARD_FAILED
Triggered when a card couldn’t be updated in a merchant.
Request example
{
"event": "CARD_FAILED",
"session_id": "fb5aa994-ed1c-4c3e-b29a-b2a53222e584",
"task_id": 25605,
"external_user_id": "3dcbb19a-b2f1-4a7b-8792-d76027b627b3",
"merchant": {
"id": 11,
"name": "Uber"
},
"data": {
"card_id": "123456789",
"reason": "account"
},
"timestamp": "2022-08-15 13:47:15"
}
Updated 4 months ago