Create an XLM path payment strict receive request

post

https://your-protect-instance.example.com/api/rest/v1/requests/outgoing/xlm/path_payment_receive

This endpoint creates an XLM path payment strict receive request.
Required role: RequestCreator.
This API can be made idempotent by generating an ID for the Request beforehand and passing it as the externalRequestId attribute

Body Params

Creates an XLM Path Payment Strict Receive Request. Sending asset is the asset associated to the address identified by fromAddressId.

amount

string

required

Amount to destination asset be received, in the smallest currency unit, based on the currency decimals. For example, 1 corresponds to 1 'stroop' (one ten-millionth of XLM), and 1 XLM corresponds to 10000000 (7 decimals)

maxSenderAmount

string

Maximum Amount that the sender should be able to send. Amount in the smallest currency unit, based on the currency decimals. For example, 1 corresponds to 1 'stroop' (one ten-millionth of XLM), and 1 XLM corresponds to 10000000 (7 decimals)

feeLimit

string

fromAddressId

string

required

toAddressId

string

A destination should be specified. Either toAddressId or toWhitelistedAddressId.

toWhitelistedAddressId

string

A destination should be specified. Either toAddressId or toWhitelistedAddressId.

destinationAssetID

string

Specify asset to be received by destination. Can only be set with toWhitelistedAddressId. Leave empty for XLM native

destinationAssetIssuer

string

Specify asset to be received by destination. Can only be set with toWhitelistedAddressId. Leave Empty for XLM native

comment

string

externalRequestId

string

Identifier for the request in the user's system. This must be unique. Attempting to create a request with an existing externalRequestId will do nothing and return the originally created request

destinationAddressMemo

string

A memo can be specified if the destination is a whitelisted address on a blockchain supporting memos.

Responses

200A successful response.

400Bad Request: indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax, invalid request message framing, or deceptive request routing)

401Unauthorized: indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource

403Forbidden: indicates that the server understands the request but refuses to authorize it

404Not Found: indicates that the server cannot find the requested resource

500Internal Server Error: indicates that the server encountered an unexpected condition that prevented it from fulfilling the request

503Service Unavailable: indicates that the server is not ready to handle the request.

defaultAn unexpected error response.