Payin

Payin Status specific events

These are the events created and triggered when the status of the payin changes.

Event	Description	Default (on/off)
payin.requires_payment_method	Triggers when the status is requires_payment_method	On
payin.requires_action	Triggers when the status is requires_action	On
payin.processing	Triggers when the status is processing	On
payin.succeeded	Triggers when the status is succeeded	On
payin.cancelled	Triggers when the payin is cancelled	Off

payin.requires_payment_method

{
  "type":"payin.requires_payment_method",
  "created_at" : "2023-12-25 21:59:59",
  "data":{
    "id":"pay_ahfafooi7fibakbfahoan",
    "object":"payin",
    "status":"requires_payment_method",
    "metadata":{},
    ......
    ...... //Entire payin object
    ........
  },
  "id":"evt_auigfiafaaaufaeoanfgohuehg",
  "object":"event"
}

payin.requires_action

{
  "type":"payin.requires_action",
  "created_at" : "2023-12-25 21:59:59",
  "data":{
    "id":"pay_ahfafooi7fibakbfahoan",
    "object":"payin",
    "status":"requires_action",
    "payment_method_details":{
      ....
      .....
    },
    "latest_payment_attempt_data":{
      ....
      ....
    },
    "metadata":{},
    ......
    ...... //Entire payin object
    ........
  },
  "id":"evt_auigfiafaaaufaeoanfgohuehg",
  "object":"event"
}

payin.processing

{
  "type":"payin.processing",
  "created_at" : "2023-12-25 21:59:59",
  "data":{
    "id":"pay_ahfafooi7fibakbfahoan",
    "object":"payin",
    "status":"processing",
    "payment_method_details":{
      ....
      .....
    },
    "latest_payment_attempt_data":{
      ....
      ....
    },
    "metadata":{},
    ......
    ...... //Entire payin object
    ........
  },
  "id":"evt_auigfiafaaaufaeoanfgohuehg",
  "object":"event"
}

payin.succeeded

{
  "type":"payin.succeeded",
  "created_at" : "2023-12-25 21:59:59",
  "data":{
    "id":"pay_ahfafooi7fibakbfahoan",
    "object":"payin",
    "status":"succeeded",
    "payment_method_details":{
      ....
      .....
    },
    "latest_payment_attempt_data":{
      ....
      ....
    },
    "metadata":{},
    ......
    ...... //Entire payin object
    ........
  },
  "id":"evt_auigfiafaaaufaeoanfgohuehg",
  "object":"event"
}

payin.cancelled

{
  "type":"payin.cancelled",
  "created_at" : "2023-12-25 21:59:59",
  "data":{
    "id":"pay_ahfafooi7fibakbfahoan",
    "object":"payin",
    "status":"cancelled",
    "metadata":{},
    ......
    ...... //Entire payin object
    ........
  },
  "id":"evt_auigfiafaaaufaeoanfgohuehg",
  "object":"event"
}

Payment_Attempt Specific Events:

These events are created and triggered when something of interest happens for a payment attempt.

Event	Description	Default (on/off)
payment_attempt.failed	When a payment_attempt fails	On
payment_attempt.succeeded	When the payment_attempt succeeds	Off

payment_attempt.failed

{
  "type":"payment_attempt.failed",
  "created_at":958793503,
  "data":{
    "id":"pat_ahfafooi7ibakbfahoan",
    "object":"payment_attempt",
    "payin":"pay_bfiuafuiafianifnao",
    "created_at":7942792,
    ....
    .... ///Entire payment_attempt object
    ....
  },
  "id":"evt_auigfianfoangohuehg",
  "object":"event"
}

payment_attempt.succeeded

{
  "type":"payment_attempt.succeeded",
  "created_at":958793503,
  "data":{
    "id":"pat_ahfafooi7ibakbfahoan",
    "object":"payment_attempt",
    "payin":"pay_bfiuafuiafianifnao",
    "created_at":7942792,
    ....
    .... ///Entire payment_attempt object
    ....
  },
  "id":"evt_auigfianfoangohuehg",
  "object":"event"
}

Other Events:

Event	Description	Default (on/off)
payin.created	A payin is created	Off

payin.created

{
  "type":"payin.created",
  "created_at" : "2023-12-25 21:59:59",
  "data":{
    "id":"pay_ahfafooi7fibakbfahoan",
    "object":"payin",
    "status":"requires_payment_method",
    "metadata":{},
    ......
    ...... //Entire payin object
    ........
  },
  "id":"evt_auigfiafaaaufaeoanfgohuehg",
  "object":"event"
}