VirtualInstrumentRequestEvent

Event for Virtual Instrument lifecycle status change.

idstringrequired

Event identifier.

timestampstring<date-time>required

Represents RFC 3339, section 5.6 date-time.

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

eventTypestringrequired

Possible values: [VIRTUAL_INSTRUMENT_REQUEST_CREATED, VIRTUAL_INSTRUMENT_REQUEST_UPDATED]

Example: VIRTUAL_INSTRUMENT_REQUEST_UPDATED

owner object

Reference to customer object. Optionally can hold external id for easier cross reference of the customer representation in external system.

idstringrequired

Customer id.

Example: 12345

externalIdstring

External id of the customer.

Example: 55551111

links object[]required

Array [

relstringrequired

Resource reference semantic.

Possible values: [self, related, urn:x-skrill:payment-redirect]

hrefstring<uri>required

Resource link.

methodstring

HTTP Method of accessing the linked resource.

Possible values: [GET, POST]

Default value: GET

Example: GET

]

content objectrequired

Event for Virtual Instrument Request status update.

idstringrequired

Request id.

Possible values: <= 20 characters

Example: 5029090724

instrumentTypeVirtualInstrumentType (string)required

Virtual payment instrument type.

Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT]

Example: US_BANK_ACCOUNT

accountIdstringrequired

Id of balance account linked to the virtual instrument.

Example: 123234

statusstringrequired

Status of virtual payment instrument request.

Possible values: [ACCEPTED, PENDING, COMPLETED, REJECTED, FAILED]

Example: COMPLETED

statusReasonstring

Status of virtual payment instrument request.

Example: Request has been denied by the issuing bank.

virtualInstrumentIdstring

The virtual instrument id, for requests that have COMPLETED status.

Possible values: <= 36 characters

Example: acde070d-8c4c-4f0d-9d8a-162843c10335

VirtualInstrumentRequestEvent

{
  "id": "string",
  "timestamp": "2021-07-15T17:54:12Z",
  "eventType": "VIRTUAL_INSTRUMENT_REQUEST_UPDATED",
  "owner": {
    "id": "12345",
    "externalId": "55551111"
  },
  "links": [
    {
      "rel": "self",
      "href": "string",
      "method": "GET"
    }
  ],
  "content": {
    "id": "5029090724",
    "instrumentType": "US_BANK_ACCOUNT",
    "accountId": "123234",
    "status": "COMPLETED",
    "statusReason": "Request has been denied by the issuing bank.",
    "virtualInstrumentId": "acde070d-8c4c-4f0d-9d8a-162843c10335"
  }
}