Push Notifications

Partners can choose to receive push notifications of certain application events, such as:

  • Application status
  • Signing status
  • Boarding status
    • Terminal ID
    • Converge credentials

Signing status notifications are only available in Guided or Managed Flow.

Push notifications are transmitted using the PAPI notificationStatusRequest object.

Authentication

In order to receive push notifications, authentication is required in both test and production environments. Use one of the following supported methods for authentication:

  • Token-based authentication: Partner provides Elavon with the token and URL endpoint.
  • OAuth2 authentication: Partner provides Elavon with the client ID, client Secret, username, password, authentication URL, and URL endpoint.
  • Basic authentication: Partner provides Elavon with the username, password, and URL endpoint.

Elavon will need your SSL Certificate in order to send push notifications.

Types of Push Notifications

Tell Elavon which push notifications you'd like to receive.

Notification

Flows

Description

EMAIL_SENT*

*Not applicable to Payment Facilitators

Guided

Transmitted when an email is sent to a customer:

  • At the time of account creation
  • On 7 days of no action
  • On 14 days of no action

REGISTRATION_ERROR*

*Not applicable to Payment Facilitators

Guided

Transmitted when the customer inputs an incorrect:

  • Date of birth
  • Phone number
  • Password

REGISTRATION_COMPLETED*

*Not applicable to Payment Facilitators

Guided

Transmitted when a customer successfully creates an account.

SIGNATURE_STATUS*

*Not applicable to Payment Facilitators

Guided

Stateful

Transmitted on change of an applicant’s signature status:

  • DRAFT
  • ACCEPTED
  • SIGNED
  • DECLINED
  • EXPIRED

APPLICATION_SUBMITTED

All

Transmitted when the application is received and boarded.

Terminal ID (TID) information is also included. The TID for POS terminals or Converge are generated within 5 minutes of an account being approved and is needed if partners are provisioning equipment instead of Elavon.

BOARDING_STATUS

All

Transmitted on change of application status:

  • COMPLETE
  • INPROGRESS
  • DECLINED
  • ERROR
  • TIMED_OUT
  • PEND

Terminal ID (TID) information is also included. The TID for POS terminals or Converge are generated within 5 minutes of an account being approved and is needed if partners are provisioning equipment instead of Elavon.