Simulator

Publish a mock MT564 message

post

/corporate-actions/swift-mock/publishMT564

Publishes a mock MT564 message with configurable fields. All fields used by the MT564 parser can be set. The message will be constructed and published as if it came from the real EFIS API. Available only on TEST environment.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Body

messageReferencestringRequired

Message reference.

Example: REF123456

corporateActionMessageReferencestringRequired

Reference to the corporate action.

Example: 1660513186

senderBICstring · min: 8 · max: 11Required

Sender's BIC (BIC8 + branch code).

Example: EFISDEFFXXXPattern: ^[A-Z0-9]{8}([A-Z0-9]{3})?$

receiverBICstring · min: 8 · max: 11Required

Receiver's BIC (BIC8 + branch code).

Example: BANKDEFFXXXPattern: ^[A-Z0-9]{8}([A-Z0-9]{3})?$

messageDirectionstring · enumRequired

Message direction: 'I' = input to SWIFT, 'O' = output from SWIFT.

Example: OPossible values:

actionTypestring · enumRequired

Corporate action event type

Possible values:

isinstringRequired

ISIN code. Required.

Example: DE0005140008Pattern: ^[A-Z]{2}[A-Z0-9]{9}\d$

exDatestring · dateRequired

Ex-date. Required.

Example: 2024-01-15

paymentDatestring · dateRequired

Payment date. Required.

Example: 2024-01-20

recordDatestring · dateOptional

Record date. Optional.

Example: 2024-01-14

automaticApprovebooleanOptional

Determines if Corporate action should be approved automatically.

Example: true

grossAmountnumber · decimalOptional

Gross amount. Optional.

Example: 1000.5

ratioFromnumber · decimalOptional

Ratio From. Optional.

Example: 10

ratioTonumber · decimalOptional

Ratio To. Optional.

Example: 10

responseDeadlinestring · dateOptional

Response deadline. Optional

Example: 2024-01-14

additionalTextstringOptional

Narrative. Optional.

Example: Shareholders must submit a physical tax form by Friday

postedCashnumber · decimalOptional

Posted cash e.g cash in lieu of fractional shares.

Example: 1000.5

postedSharesnumber · numberOptional

Posted shares.

Example: 1000

Responses

200

MT564 message published successfully

application/json

messagestringRequired

Success message

uetrstring · uuidRequired

The UETR of the published message

400

Bad request (e.g., missing required fields)

application/json

500

Server error while processing the message

application/json

post

/corporate-actions/swift-mock/publishMT564

POST /corporate-actions/swift-mock/publishMT564 HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 691

{
  "messageReference": "REF123456",
  "corporateActionMessageReference": 1660513186,
  "senderBIC": "EFISDEFFXXX",
  "receiverBIC": "BANKDEFFXXX",
  "messageDirection": "O",
  "actionType": "DVCA",
  "isin": "DE0005140008",
  "exDate": "2024-01-15",
  "paymentDate": "2024-01-20",
  "recordDate": "2024-01-14",
  "automaticApprove": true,
  "grossAmount": 1000.5,
  "ratioFrom": 10,
  "ratioTo": 10,
  "responseDeadline": "2024-01-14",
  "additionalText": "Shareholders must submit a physical tax form by Friday",
  "tenderOptions": [
    {
      "tenderOption": "NONE",
      "isDefaultAction": true,
      "offeredPricePerShare": 10,
      "maximumCashAmount": 1500,
      "maximumQuantitySharesAccepted": 10,
      "creditedIsin": "DE0005140008",
      "exchangeRatio": 1.5
    }
  ],
  "postedCash": 1000.5,
  "postedShares": 1000
}

{
  "message": "text",
  "uetr": "123e4567-e89b-12d3-a456-426614174000"
}

Publish a mock MT566 message

post

/corporate-actions/swift-mock/publishMT566

Publishes a mock MT566 message with configurable fields. All fields used by the MT566 parser can be set. The message will be constructed and published as if it came from the real EFIS API. Available only on TEST environment.

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Body

messageReferencestringRequired

Message reference.

Example: REF123456

corporateActionMessageReferencestringRequired

Reference to the corporate action.

Example: 1660513186

senderBICstring · min: 8 · max: 11Required

Sender's BIC (BIC8 + branch code).

Example: EFISDEFFXXXPattern: ^[A-Z0-9]{8}([A-Z0-9]{3})?$

receiverBICstring · min: 8 · max: 11Required

Receiver's BIC (BIC8 + branch code).

Example: BANKDEFFXXXPattern: ^[A-Z0-9]{8}([A-Z0-9]{3})?$

messageDirectionstring · enumRequired

Message direction: 'I' = input to SWIFT, 'O' = output from SWIFT.

Example: OPossible values:

actionTypestring · enumRequired

Corporate action event type

Possible values:

isinstringRequired

ISIN code. Required.

Example: DE0005140008Pattern: ^[A-Z]{2}[A-Z0-9]{9}\d$

exDatestring · dateRequired

Ex-date. Required.

Example: 2024-01-15

paymentDatestring · dateRequired

Payment date. Required.

Example: 2024-01-20

recordDatestring · dateOptional

Record date. Optional.

Example: 2024-01-14

grossAmountnumber · decimalOptional

Gross amount. Optional.

Example: 1000.5

ratioFromnumber · decimalOptional

Ratio From. Optional.

Example: 10

ratioTonumber · decimalOptional

Ratio To. Optional.

Example: 10

quantitySuccessfullyTenderednumber · decimalOptional

Quantity of Shares Successfully Tendered. Optional.

tenderedCashAmountnumber · decimalOptional

Tendered Cash Amount. Optional

postedCashnumber · decimalOptional

Posted cash e.g cash in lieu of fractional shares.

Example: 1000.5

postedSharesnumber · numberOptional

Posted shares.

Example: 100

additionalTextstringOptional

Narrative. Optional.

Example: Shareholders must submit a physical tax form by Friday

Responses

200

MT566 message published successfully

application/json

messagestringRequired

Success message

uetrstring · uuidRequired

The UETR of the published message

400

Bad request (e.g., missing required fields)

application/json

500

Server error while processing the message

application/json

post

/corporate-actions/swift-mock/publishMT566

POST /corporate-actions/swift-mock/publishMT566 HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 489

{
  "messageReference": "REF123456",
  "corporateActionMessageReference": 1660513186,
  "senderBIC": "EFISDEFFXXX",
  "receiverBIC": "BANKDEFFXXX",
  "messageDirection": "O",
  "actionType": "DVCA",
  "isin": "DE0005140008",
  "exDate": "2024-01-15",
  "paymentDate": "2024-01-20",
  "recordDate": "2024-01-14",
  "grossAmount": 1000.5,
  "ratioFrom": 10,
  "ratioTo": 10,
  "quantitySuccessfullyTendered": 1,
  "tenderedCashAmount": 1,
  "postedCash": 1000.5,
  "postedShares": 100,
  "additionalText": "Shareholders must submit a physical tax form by Friday"
}

{
  "message": "text",
  "uetr": "123e4567-e89b-12d3-a456-426614174000"
}

Last updated 1 month ago