Skip to main content

TransactionEvent

Transaction change events.

idstringrequired

Change identifier.

timestampdate-timerequired

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z
operationTypeOperationType (string)required

Type of the notification event:

  • Insert - Denotes insert operation.
  • Update - Denotes update operation. The entity should contain only updated fields.
  • Delete - Denotes delete operation.

Possible values: [Update, Create, Delete]

Example: Update
transaction objectrequired

Transaction update information.

idstringrequired

Transaction id

Example: 5040057608
slipIdstringrequired

Transaction Slip Id.

Example: 5009964049
customerIdstringrequired

Wallet customer id.

Example: 500014306996
accountIdstringrequired

Account Id associated with this transaction.

Example: 5014567344
typeTransactionType (string)required

Represents the type of the transaction.

Possible values: [DEPOSIT, WITHDRAWAL, PAYOUT, CHARGEBACK_REVERSAL, RETURNED_WITHDRAWAL, CHARGEBACK, MERCHANT_FEE, TRANSACTION_FEE, DAILY_TRANSACTIONS_FEE, TRANSFER_IN, TRANSFER_OUT, TRANSFER_RETURN, REFUND, CURRENCY_EXCHANGE, PAYSAFE_FEE, PREPAID_CARD, PREPAID_CARD_AUTHORIZATION, APPLICATION_FEE, SET_UP_FEE, MONTHLY_MAINTENANCE_FEE]

Example: DEPOSIT
amountint64required

Transaction amount in minor units.

Example: 1000
currencyCodeCurrency (string)required

Currency alphabetic code as specified by ISO 4217

Possible values: >= 3 characters and <= 3 characters

Example: EUR
creationTimedate-timerequired

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z
directionstringrequired

Transaction direction.

Possible values: [CREDIT, DEBIT]

paymentTypePaymentType (string)

Type of instrument. Used as discriminator for different Payment types.

  • CARD
  • BANK_TRANSFER
  • RAPID_TRANSFER
  • TRANSFER

Possible values: [CARD, BANK_TRANSFER, RAPID_TRANSFER, TRANSFER]

instrumentIdstring
instrumentTypeInstrumentType (string)

Represents the type of the instrument.

| Value | Description| |---|---| | SEPA_BANK_ACCOUNT| SEPA Bank account | | UK_BANK_ACCOUNT | UK Bank account | | US_BANK_ACCOUNT | US Bank account | | CCI_BANK_ACCOUNT | CCI Bank account | | CARD | Card |

Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT, CCI_BANK_ACCOUNT, CARD]

Example: CARD
statusTransactionStatus (string)required

Represents the status of a transaction.

  • PENDING - Transaction is created and further action is required by the customer.
  • PROCESSING - Transaction is scheduled for processing by the payment provider.
  • COMPLETED - Transaction is completed. Note that some transactions might be completed from Embedded Wallet point of view, but not from customer point of view, since money movement might take some time outside of the Embedded Wallet network.
  • FAILED - Transaction is failed. Check STATUS_REASON property for details.
  • CANCELLED - Transaction have been cancelled
  • REFUNDED - Valid only for deposit transactions.
  • DECLINED - transaction is declined.

Possible values: [PENDING, PROCESSING, COMPLETED, FAILED, CANCELLED, REFUNDED, DECLINED]

Example: COMPLETED
statusReasonstring

Status reason for FAILED transactions. See TransactionStatusReason for available values.

merchantRefNumstring

Merchant reference number associated witht the transaction.

Example: 5040452805
recipientReferencestring

Additional reference information for the recipient passed by the sender of the transaction. This information is not valid or present for all transaction types:

  • For TRANSFER_OUT contains the transfer recipient customer id.
  • For PAYOUT contains the third party withdrawal recipient id.
TransactionEvent
{
  "id": "string",
  "timestamp": "2021-07-15T17:54:12Z",
  "operationType": "Update",
  "transaction": {
    "id": "5040057608",
    "slipId": "5009964049",
    "customerId": "500014306996",
    "accountId": "5014567344",
    "type": "DEPOSIT",
    "amount": 1000,
    "currencyCode": "EUR",
    "creationTime": "2021-07-15T17:54:12Z",
    "direction": "CREDIT",
    "paymentType": "CARD",
    "instrumentId": "string",
    "instrumentType": "CARD",
    "status": "COMPLETED",
    "statusReason": "string",
    "merchantRefNum": "5040452805",
    "recipientReference": "string"
  }
}