notificationData Object Model

Information about the notification or report configuration.

ownerId

string | null

required

ID for the paypoint or organization that owns the notification.

Example:

"123"

ownerType

enum<integer>

required

Entity owner type. Accepted values:

0: Organization/partner
2: Paypoint

Available options:

0,

2

Example:

0

method

enum<string>

required

Method to use to send the notification to the target.

Available options:

email,

sms,

web,

report-email,

report-web

frequency

enum<string> | null

Frequency for notification. For notifications using the email ,sms, or web method, the allowed values are:

untilcancelled
one-time

For notifications using the report-email or report-web method, the allowed values are:

one-time
daily
weekly
biweekly
monthly
quarterly
semiannually
annually

Available options:

one-time,

daily,

weekly,

biweekly,

monthly,

quarterly,

semiannually,

annually,

untilcancelled

target

string | null

Specify the notification target.

For method=email the expected value is a list of email addresses separated by semicolon.

For method=sms the expected value is a list of phone numbers separated by semicolon.

For method=web. the expected value is a valid and complete URL. Webhooks support only standard HTTP ports: 80, 443, 8080, or 4443.

source

string | null

Custom identifier to indicate the transaction or request source.

Maximum length: 100

Example:

"api"

status

enum<integer> | null

Status of notification:

0: Inactive
1: Active

Available options:

0,

1

content

object

content.eventType

enum<string> | null

The notification's event name.

Available options:

ApprovedPayment,

AuthorizedPayment,

DeclinedPayment,

OriginatedPayment,

SettledPayment,

FundedPayment,

VoidedPayment,

RefundedPayment,

HoldTransaction,

ReleasedTransaction,

HoldBatch,

ReleasedBatch,

TransferDisabledCreditFund,

TransferDisabledDebitFund,

TransferNotAvailableBalance,

TransferReturn,

TransferSuccess,

TransferSuspended,

TransferError,

SendReceipt,

RecoveredTransaction,

CreatedApplication,

SubmittedApplication,

ActivatedMerchant,

ReceivedChargeBack,

ReceivedAchReturn,

HoldingApplication,

DeclinedApplication,

BoardingApplication,

FraudAlert,

InvoiceSent,

InvoicePaid,

InvoiceCreated,

BillPaid,

BillApproved,

BillDisApproved,

BillCanceled,

BillProcessing,

PayOutFunded,

PayOutProcessed,

PayOutCanceled,

PayOutPaid,

importFileReceived,

importFileProcessed,

importFileError,

exportFileSent,

exportFileError,

Report,

FailedEmailNotification,

FailedWebNotification,

FailedSMSNotification,

UserPasswordCloseExpire,

UserPasswordExpired

content.transactionId

string | null

default:0

Used internally to reference the entity or object generating the event.

content.fileFormat

enum<string> | null

Indicate the format of report file to be generated by the engine. Used for method = report-email and report-web.

Available options:

json,

csv,

xlsx

content.reportName

enum<string> | null

The kind report to generate. For automated reports only.

Available options:

Transaction,

Settlement,

Boarding,

Returned

content.timeZone

integer | null

default:0

Timezone, in UTC offset. For example, -5 is Eastern time.

Example:

-5

content.webHeaderParameters

object[] | null

Array of pairs key:value to insert in header of request to target in method = web or report-web.

content.internalData

object[] | null

Array of pairs key:value to insert in request body to target in method = web or report-web.

API Basics

Pay In Endpoints

Pay Out Endpoints

Pay Ops Endpoints

Object Models

notificationData Object Model