Notifications

When you work with the BridgerPay system—create sessions, request to execute payment transactions, and so on—the information flows contain the statuses of your operations; they are generated by BridgerPay or received from PSPs. We notify you of changes to some of these statuses: the respective messages in JSON format are sent via a predefined webhook.
Six types of notifications exist. You can find their content on the respective tabs later.
"cashier.session.init" and "cashier.session.close" are generated when a Cashier session has been created (initiated) and closed (or expired), respectively.
"approved" and "declined" are generated when a payment transaction has finally been approved by any PSP or declined by all available PSPs. Note that these notifications are applicable to both "deposit" and "payout" transaction types. But their content varies depending on this type and the payment method used (e.g. "credit_card" or "apm"); thus, mind the comments next to each line.
"partly_refunded" and "refunded" are generated when a request to partially or fully refund a shopper's deposit has been satisfied by the PSP.
Important: You needs to handle multiple notifications for the same OrderId. You should expect 3 notifications for each session (1.init, 2.approved/declined and 3.close). You can chose to only process the relevant notification and ignore the others.
cashier.session.init
approved
declined
cashier.session.close
refunds
void
1
{
2
  "webhook": {
3
    "type": "cashier.session.init"            //Event name
4
  },
5
  "data": {
6
    "charge": {
7
      "type": "cashier.session.init",         //Event name
8
      "attributes": {
9
        "status": "cashier.session.init",     //Event name
10
        "amount": 2000.0,                     //Transaction amount
11
        "live_mode": true,                    
12
        "currency": "USD",                    //Transaction currency
13
        "created_at": 1609147030,             //UTC timestamp of when the session was initialised
14
        "source": {
15
          "email": "[email protected]",         //Shopper's email address; if it was not specified during the Cashier session initialization, the value is "null"
16
          "ip_address": "127.0.0.1",          //Shopper's IP address
17
          "name": " "                         //Shopper's first and last names if they were specified during the Cashier session initialization
18
        }
19
       }
20
     },
21
     "order_id": "4e50a...2ff"
22
  },
23
   "meta": {
24
        "server_time": 1541160272,            //Server's UTC timestamp of when the event was registered in the Bridger
25
        "server_timezone": "UTC",             //Time zone of the PSP's server
26
        "api_version": "1",                   //API version the PSP used
27
        "payload": "null",                    //Payload value
28
        "cashier_session_id": "62290...e40",  //Identifier of the Cashier session used
29
        "platform_id": null                   //Merchant's platform ID
30
    }
31
}
Copied!
1
{
2
  "webhook": {
3
    "type": "approved"                             //Transaction status
4
  },
5
  "data": {
6
    "order_id": "640790367",                       //Transaction ID within the merchant's system
7
    "psp_name": "psp_name",                        //PSP's code name
8
    "charge": {
9
      "type": "approved",                          //Transaction status
10
      "id": "8ac7a...d8f",                         //Transaction ID within the PSP's system
11
      "psp_order_id": "b4a0a...a58",               //Transaction group ID within the PSP's system
12
      "attributes": {
13
        "is3_d": true,                             //3D Secure dialog box requiring the payment confirmation if available; applicable to the "credit_card" payment method of the "deposit" operation type
14
        "live_mode": true,                         //Cashier widget is available; applicable if the operation type is "deposit"
15
        "amount": 22.96,                           //Transaction amount
16
        "status": "approved",                      //Transaction status
17
        "card_number": "1881",                     //Last four numbers appearing on the shopper's debit or credit card; applicable to the "credit_card" payment method
18
        "currency": "EUR",                         //Transaction currency
19
        "payment_method": "credit_card",           //Method the shopper used to pay, e.g. "credit_card" or "apm"; applicable to the "deposit" operation type
20
        "description": "BGPj173aa01",              //Comment associated with the transaction; applicable to the "deposit" operation type
21
        "decline_code": null,                      //Declination reason code
22
        "decline_reason": null,                    //Reason of why the transaction was declined
23
        "reference_id": null,
24
        "created_at": 1581071423,                  //UTC timestamp of when the transaction was registered in the PSP's system
25
        "updated_at": 0,                           //UTC timestamp of when information on the transaction was modified in the PSP's system
26
        "source": {
27
          "email": "[email protected]",             //Shopper's email address
28
          "ip_address": "127.0.0.1",               //Shopper's IP address
29
          "name": "John Smith"                     //Shopper's first and last name
30
        },
31
        /* the following four parameters are applicable to the "credit_card" payment method */
32
        "card_masked_number": "401288******1881",  //Half-hidden card number
33
        "card_expiration": "122",                  //Expiration month and year of the card (e.g. "122" implies January 2022)
34
        "card_brand": "VISA",                      //Organization serving the card
35
        "card_holder_name": "John Smith",          //Holder name of the shopper's debit or credit card
36
        "customer": {
37
          "full_name": null,
38
          "address": "Bethnal Green Road, 12",     //Shopper's address
39
          "country": "BE",                         //Shopper's country
40
          "zip_code": "9900"                       //Shopper's ZIP code
41
          "extra_data":{
42
          
43
          }
44
        },
45
        "credit_card_token": "0bee8...",           //Credit card token
46
        "mid_alias": "XYZ"                         //Mid name identifier
47
      },
48
      "is_refundable": true,                       //Parameter defining whether the transaction was refundable; always 'false' for the "payout" operation type
49
      "refund_id": "629bc...948",                  //Transaction ID within the BridgerPay system; shown here if the PSP supports refunds
50
      "operation_type": "deposit",                 //Operation (transaction) type: "deposit" or "payout"
51
      "deposit_source": "cashier"                  //The deposit source can be cashier or Mpi
52
    }
53
  },
54
  "meta": {
55
    "server_time": 1581071423,                     //Server's UTC timestamp of when the transaction was registered in the PSP's system
56
    "server_timezone": "UTC",                      //Time zone of the PSP's server
57
    "api_version": "1",                            //API version the PSP used
58
    /* the following three parameters are applicable to the "deposit" operation type */
59
    "payload": "746...5f921",                      //Payload value
60
    "cashier_session_id": "62290...e40",           //Identifier of the Cashier session used
61
    "platform_id": "CU1234"                        //Merchant's platform ID
62
  }
63
}
Copied!
1
/* "declined" and "approved" are very similar; thus, see the comments explaining
2
   the purpose of each line (parameter) on the preceding tab */
3
{
4
  "webhook": {
5
    "type": "declined"
6
  },
7
  "data": {
8
    "order_id": "2106605328",
9
    "psp_name": "psp_name",
10
    "charge": {
11
      "type": "declined",
12
      "id": "8ac7a...85e",
13
      "psp_order_id": "fd7ff...85e",
14
      "attributes": {
15
        "is3_d": true,
16
        "live_mode": true,
17
        "amount": 22.99,
18
        "status": "declined",
19
        "card_number": "1111",
20
        "currency": "EUR",
21
        "payment_method": "credit_card",
22
        "description": "BGPj173aa01",
23
        "decline_code": -4,                              //Declination reason code
24
        "decline_reason": "User Authentication Failed",  //Reason of why the transaction was declined
25
        "reference_id": null,
26
        "created_at": 1581071423,
27
        "updated_at": 0,
28
        "source": {
29
          "email": "[email protected]",
30
          "ip_address": "127.0.0.1",
31
          "name": "John Smith"
32
        },
33
        "card_masked_number": "411111******1111",
34
        "card_expiration": "521",
35
        "card_brand": "VISA",
36
        "card_holder_name": "John Smith",
37
        "customer": {
38
          "full_name": null,
39
          "address": "Bethnal Green Road, 12",
40
          "country": "BE",
41
          "zip_code": "9900",
42
          "extra_data":{}
43
        },
44
        "credit_card_token": null,
45
        "mid_alias":"XYZ"
46
      },
47
      "is_refundable": false,
48
      "refund_id": "",
49
      "operation_type": "deposit",
50
      "deposit_source": "cashier"
51
    }
52
  },
53
  "meta": {
54
    "server_time": 1581071423,
55
    "server_timezone": "UTC",
56
    "api_version": "1",
57
    "payload": "746...5f921",
58
    "cashier_session_id": "62290...e40",
59
    "platform_id": "CU1234"
60
  }
61
}
Copied!
1
/* "cashier.session.close" and "cashier.session.init" are very similar; thus, see
2
   the comments explaining the purpose of each line (parameter) on the preceding tab */
3
{
4
  "webhook": {
5
    "type": "cashier.session.close"
6
  },
7
  "data": {
8
    "charge": {
9
      "type": "cashier.session.close",
10
      "order_id": "201995972",
11
      "psp_order_id": null,
12
      "attributes": {
13
        "status": "cashier.session.close",
14
        "created_at": 1609142858
15
      }
16
    }
17
  },
18
  "meta": {
19
    "server_time": 1609142858,
20
    "server_timezone": "UTC",
21
    "api_version": "1",
22
    "payload": null,
23
    "cashier_session_id": "009d6829-exx1-4ce4-ae39-123456789123",
24
    "platform_id": null
25
  }
26
}
Copied!
1
{
2
  "webhook": {
3
    "type": "approved"                             //Transaction status
4
  },
5
  "data": {
6
    "order_id": "2106605329",                      //Transaction ID within the merchant's system
7
    "psp_name": "psp_name",                        //PSP's code name
8
    "charge": {
9
      "type": "approved",                          //Transaction status
10
      "id": "8ac7a...d8f",                         //Transaction ID within the PSP's system
11
      "psp_order_id": "b4a0a...a58",               //Transaction group ID within the PSP's system
12
      "attributes": {
13
        "is3_d": true,                             //3D Secure dialog box requiring the payment confirmation
14
        "live_mode": true,                         //Cashier widget is available
15
        "amount": -5,                              //Transaction amount
16
        "status": "approved",                      //Transaction status
17
        "card_number": "1881",                     //Last four numbers appearing on the shopper's debit or credit card; used if applicable, otherwise it is 'null'
18
        "currency": "EUR",                         //Transaction currency
19
        "payment_method": "credit_card",           //Method the shopper used to make the deposit being refunded, e.g. "credit_card" or "apm"
20
        "description": "test refund",              //Comment associated with the transaction
21
        "created_at": 1581073874,                  //UTC timestamp of when the transaction was registered in the PSP's system
22
        "updated_at": 0,                           //UTC timestamp of when the information on the transaction was modified in the PSP's system
23
        "source": {
24
          "email": "[email protected]",             //Shopper's email address
25
          "ip_address": "127.0.0.1",               //Shopper's IP address
26
          "name": "John Smith"                     //Shopper's first and last name
27
        },
28
        /* the following four parameters are applicable to the "credit_card" payment method */
29
        "card_holder_name": "John Smith",          //Holder name of the shopper's debit or credit card
30
        "card_masked_number": "401288******1881",  //Half-hidden card number
31
        "card_expiration": "122",                  //Expiration month and year of the card (e.g. "122" implies January 2022)
32
        "card_brand": "VISA",                      //Organization serving the card
33
        "customer": {
34
          "address": "Bethnal Green Road, 12",     //Shopper's address
35
          "country": "BE",                         //Shopper's country
36
          "zip_code": "9900"                       //Shopper's ZIP code
37
        }
38
      },
39
      "is_refundable": true,                       //Parameter defining whether the corresponding payment transaction is refundable; always 'true' here
40
      "refund_id": "ed32e...810"                   //Transaction ID within the BridgerPay system
41
      "operation_type": "refund",                  //Operation Type
42
      "deposit_source": "cashier"                  //Deposit source
43
    }
44
  },
45
  "meta": {
46
    "server_time": 1581073874,                     //Server's UTC timestamp of when the transaction was registered in the PSP's system
47
    "server_timezone": "UTC",                      //Time zone of the PSP's server
48
    "api_version": "1",                            //API version the PSP used
49
    "cashier_session_id": "c7997...5af",           //Identifier of the Cashier session used
50
    "platform_id": "CU1234"                        //Merchant's platform ID
51
  }
52
}
Copied!
1
{
2
   "webhook": {
3
    "type": "voided"
4
  },
5
  "data": {
6
    "order_id": "94ee89a8e1102013b2b5a6e7649a1b04",
7
    "psp_name": "ncr",
8
    "charge": {
9
      "type": "voided",
10
      "id": "3bea75dc1ebbe913b0",
11
      "uuid": "1d42ced1-232c-40bf-b6e5-29504ff11948",
12
      "psp_order_id": "QnSiSlRkRiPhQhQiPnPmQkXo",
13
      "attributes": {
14
        "is3_d": false,
15
        "live_mode": true,
16
        "amount": 100,
17
        "status": "voided",
18
        "card_number": "0000",
19
        "currency": "USD",
20
        "payment_method": "credit_card",
21
        "description": "BGP94ee89a8e1102013b2b5a6e7649a1b04",
22
        "decline_code": null,
23
        "decline_reason": null,
24
        "reference_id": null,
25
        "created_at": 1647173135,
26
        "updated_at": 0,
27
        "source": {
28
          "email": "[email protected]",
29
          "ip_address": "3.9.20.123",
30
          "name": "John Doe"
31
        },
32
        "card_masked_number": "420000******0000",
33
        "card_expiration": "322",
34
        "card_brand": "VISA",
35
        "card_holder_name": "John Doe",
36
        "customer": {
37
          "first_name": "John",
38
          "last_name": "Doe",
39
          "address": "4721 Hillhaven Drive",
40
          "city": "California",
41
          "country": "US",
42
          "zip_code": "90017",
43
          "phone": "+311******566",
44
          "extra_data": {}
45
        },
46
        "credit_card_token": null,
47
        "mid_alias": "Preauth",
48
        "installment_details": {},
49
        "is_declined_due_to_funds": false
50
      },
51
      "is_refundable": false,
52
      "refund_id": "",
53
      "operation_type": "deposit",
54
      "deposit_source": "cashier"
55
    }
56
  },
57
  "meta": {
58
    "server_time": 1647173135,
59
    "server_timezone": "UTC",
60
    "api_version": "1",
61
    "payload": null,
62
    "cashier_session_id": "daf6a147-e595-4ba4-a4d0-40e493127f27",
63
    "platform_id": ""
64
  }
65
}
Copied!
Reporting - Previous
Statuses
Next - Reporting
Event capture
Last modified 2mo ago
Copy link