PaymentEvent

Payment event structure linked to change in payment objects:

• Transfer
• Deposit
• Withdrawal
• Refund

Each event has common header structure and payment event specific content.

idstringrequired

Event identifier.

timestampdate-timerequired

Represents RFC 3339, section 5.6 date-time.

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

eventTypePaymentEventType (string)required

Enumerations holding the supported payment event types. Each specific event relates to specific payment type and a state change of the payment object.

Possible values: [TRANSFER_UPDATE, DEPOSIT_UPDATE, WITHDRAWAL_UPDATE]

Example: TRANSFER_UPDATE

paymentIdstringrequired

Payment identifier.

Example: urn:tfr:01JHQA6KBQM9S4X6P82FS7JQ3Z

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]

hrefurirequired

Resource link.

methodstring

HTTP Method of accessing the linked resource.

Possible values: [GET, POST]

Default value: GET

Example: GET

]

merchantRefNumstring

Merchant reference for the operation.

Example: 29389283

content PaymentContentrequired

Contains the change in Payment object. Here are the valid eventType values:

• TRANSFER_UPDATE - Changes of the updated transfer object.
• DEPOSIT_UPDATE - Changes of the updated deposit object.
• WITHDRAWAL_UPDATE - Changes of the updated withdrawal object.

eventTypePaymentEventType (string)required

Enumerations holding the supported payment event types. Each specific event relates to specific payment type and a state change of the payment object.

Possible values: [TRANSFER_UPDATE, DEPOSIT_UPDATE, WITHDRAWAL_UPDATE]

Example: TRANSFER_UPDATE

PaymentEvent

{
  "id": "string",
  "timestamp": "2021-07-15T17:54:12Z",
  "eventType": "TRANSFER_UPDATE",
  "paymentId": "urn:tfr:01JHQA6KBQM9S4X6P82FS7JQ3Z",
  "owner": {
    "id": "12345",
    "externalId": "55551111"
  },
  "links": [
    {
      "rel": "self",
      "href": "string",
      "method": "GET"
    }
  ],
  "merchantRefNum": "29389283",
  "content": {
    "eventType": "TRANSFER_UPDATE"
  }
}