Subscribe to Transaction events

PUT 
/transaction-events/subscriptions/:eventSubscriptionId

Subscribe to Transaction events

Request

Path Parameters

eventSubscriptionId stringrequired

The unique id of this subscription, which can be used for unsubscribing later on.

application/json

Body

required

id uuidrequired

Unique id of the subscription

callbackUrl urirequired

callback url that will be called by server for every subscribed event

eventTypes TransactionEventType (string)[]required

Possible values: [TransactionDeclined, TransactionCancelled, TransactionCompleted], >= 1

the list of event types to which subscriber would like to listen for

Responses

201

Subscription created

application/json

Schema

Schema

id uuidrequired

Unique id of the subscription

callbackUrl urirequired

callback url that will be called by server for every subscribed event

eventTypes TransactionEventType (string)[]

Possible values: [TransactionDeclined, TransactionCancelled, TransactionCompleted]

Example (from schema)

{
  "id": "6d245f63-fdfc-4a6b-a351-bc0b03260dcd",
  "callbackUrl": "https://myserver.com/send/callback/here",
  "eventTypes": [
    "TransactionDeclined"
  ]
}

400

Validation failed

application/json

Schema

Schema

code stringrequired

Possible values: [Validation]

The type of error

message stringrequired

A short text describing the error

moreInfo string

A link to the online documentation describing the error in detail

correlationId string

Identifies the conversation within which the error got generated

details

object

Contains additional details of the error

validationErrorReasons

object[]

A collection of Validation error details

Array [

fieldName string

name of filed that failed validation

errorMessage stringrequired

error message

]

Example (from schema)

{
  "code": "Validation",
  "message": "string",
  "moreInfo": "https://developer.example.com/ExampleService/v1.0/errors/validation",
  "correlationId": "ce8056cd-ae4d-4f2d-87de-7562c92f92cc",
  "details": {
    "validationErrorReasons": [
      {
        "fieldName": "customerId",
        "errorMessage": "Value must not be empty"
      }
    ]
  }
}

500

Unexpected technical error

application/json

Schema

Schema

code stringrequired

Possible values: [GeneralErrorOccurred]

The type of error

message stringrequired

A short text describing the error

moreInfo string

A link to the online documentation describing the error in detail

correlationId string

Identifies the conversation within which the error got generated

details

object

Contains additional details of the error

validationErrorReasons

object[]

A collection of Validation error details

Array [

fieldName string

name of filed that failed validation

errorMessage stringrequired

error message

]

Example (from schema)

{
  "code": "GeneralErrorOccurred",
  "message": "string",
  "moreInfo": "https://developer.example.com/ExampleService/v1.0/errors/validation",
  "correlationId": "ce8056cd-ae4d-4f2d-87de-7562c92f92cc",
  "details": {
    "validationErrorReasons": [
      {
        "fieldName": "customerId",
        "errorMessage": "Value must not be empty"
      }
    ]
  }
}

Loading...