Skip to main content

InstrumentUpdateEvent

Event for tracking instrument update operations. The sensitive data is obfuscated.

idstringrequired

Event id.

timestampstring<date-time>required

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
instrument objectrequired

Represents a payment instrument, used for Deposit or Withdrawal. Here are the valid instrumentType values:

idstring

The instrument id

customerIdstring

The customer to which this instrument belongs.

Example: 5435323362
instrumentTypeInstrumentType (string)required

Represents the type of the instrument.

ValueDescription
SEPA_BANK_ACCOUNTSEPA Bank account
UK_BANK_ACCOUNTUK Bank account
US_BANK_ACCOUNTUS Bank account
CCI_BANK_ACCOUNTCCI Bank account
BR_BANK_ACCOUNTBR Bank account
PH_BANK_ACCOUNTPH Bank account
CLABE_BANK_ACCOUNTCLABE Bank account
CARDCard
EMAILEmail
QR_CODEQR Code

Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT, CCI_BANK_ACCOUNT, BR_BANK_ACCOUNT, PH_BANK_ACCOUNT, CLABE_BANK_ACCOUNT, CARD, EMAIL, QR_CODE]

Example: CARD
externallyVerifiedboolean

Is the instrument externally verified.

Default value: false
statusstring

The instrument status.

Possible values: [VERIFIED, UNVERIFIED, VERIFICATION_REQUIRED, REJECTED]

creationTimestring<date-time>

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z
InstrumentUpdateEvent
{
  "id": "string",
  "timestamp": "2021-07-15T17:54:12Z",
  "operationType": "Update",
  "instrument": {
    "id": "string",
    "customerId": "5435323362",
    "instrumentType": "CARD",
    "externallyVerified": false,
    "status": "VERIFIED",
    "creationTime": "2021-07-15T17:54:12Z"
  }
}