addIncomingSettlementRequest

Adds a request for incoming settlement

POST api/addIncomingSettlementRequest

Payload

{
    "counterpartyId": 4,
    "currency": "USD",
    "amount": 10000000000,
    "comment": "Some text",
    "flags": 1,
    "cancelTimestamp": 1634406457410,
    "network": "SWIFT"
}

200 OK

{
    "requestId": 123456
}

400 Bad request

{
    "error": 2
}

Request parameters

Filed name	Type	Description
counterpartyId	Efx::ClientId	Counterparty id
currency	string	Currency name
amount	Efx::Size	Optional. The amount of funds that the specified counterparty is required to send. If zero or not specified, the full outstanding position is supposed to be settled.
comment	string	Optional. Any comment.
flags	unsigned int16	Optional 0 - no flags 1 - fee paid by recipient. Notify that network fee will be paid by you. The fee will be deducted from the requested amount, thus the amount you will receive to your wallet or custodian account will be smaller than the one you have requested.
cancelTimestamp	Efx::Timestamp	Optional. Timestamp in milliseconds when the request will be automatically deleted. Could not be more than 30 days from the current date. Default value is 24 hours ahead. If set to 0 the request doesn't have expiration time.
network	string	Optional. Network name.

Response description

Field name	Type	Description
requestId	unsigned int64	Id of the created request