Params

Param name Description
payment_reference
optional

payment_reference contains a hash with which you need to make a request to Everypay for additional information about the invoice’

Validations:

  • Must be a String

event_name
optional

event_name is sent for payment status, fraud and dispute updates as well as network token updates.

Possible values for event_names:

  • status_updated - payment status is updated. To check the status of that payment, please use GET /payments/:payment_reference

  • voided - payment is voided, cancellation of authorization.

  • refunded - payment is refunded, reimbursement of payment.

  • refund_failed - open banking payment refund fails. In this case payment status might change, please use GET /payments/:payment_reference to - check the final status of that payment.

  • chargebacked - payment is charged backed, the cardholder has disputed payment and the issuer bank has initiated a chargeback process.

  • marked_for_capture - payment is marked for capture.

  • abandoned - payment is abandoned, final status and means that payment is failed.

  • issuer_reported_fraudulent - Payment has been marked as fraudulent payment and reported by the issuer.

  • merchant_reported_fraudulent - Payment has been marked as fraudulent payment and reported by merchant.

  • dispute_opened - Dispute is opened.

  • dispute_updated - Dispute is updated.

  • dispute_reversed - Dispute is reversed

  • dispute_charged_back - Dispute is charged back.

  • dispute_reopened - Dispute is reopened.

Possible values for network token updates:

  • card_art_updated - Card art is received. Merchants can get the card art after this notification.

  • token_updated - Token status is updated by the issuer. Merchants can check the status of the token after getting this notification.

  • status_update - When payment acquiring is completed and funds received to the merchant’s account. Available only if the acquiring bank - supports this functionality.

Validations:

  • Must be a String