Create an XLM path payment strict receive request

POST

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

POST

/api/rest/v1/requests/outgoing/xlm/path_payment_receive

curl -X POST https://your-protect-instance.example.com/api/rest/v1/requests/outgoing/xlm/path_payment_receive \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "amount": "string",
  "fromAddressId": "string"
}'

{
  "result": {
    "id": "442",
    "tenantId": "1",
    "currency": "BTC",
    "envelope": "CgM0NDIQmfGjk6Ops/oVGAEqmgUSrAEKPwoPbS80NCcvMCcvMCcvMC8wGiAeyruP7CoNYcGISzRo8iZmuVnV6M9gLiZuShy7aDtKKiABKNHEFDD/////DxIoCiIxQ3Zoeml0ZFZMUGhOVGZ3NU5rUm9YWHZveldacGZhWXQ2EJ/nBRoVCg9tLzQ0Jy8wJy8wJy8wLzAYsbcOMig0NDI6NDY5ZTMxOGUtYjcxZC00MGUwLTg0ZjctNzVlOGQwOWE3Yzg2IhMKCnJlcXVlc3RfaWQQARoDNDQyIhIKCXJ1bGVzX2tleRABGgNCVEMiEQoIY3VycmVuY3kQARoDQlRDIlsKBnNvdXJjZRAEGkcIARJDCAESIjFKTUJZTU1pOWlqSlJlVFlxdEZUU2RlVkJ6azhOSGRzVHUaCm5vc3RybyBCVEMiD20vNDQnLzAnLzAnLzAvMCIGc291cmNlImIKC2Rlc3RpbmF0aW9uEAUaRBJCCMwBEiIxQ3Zoeml0ZFZMUGhOVGZ3NU5rUm9YWHZveldacGZhWXQ2GghteSBsYWJlbCIPbS80NCcvMCcvMCcvMC84IgtkZXN0aW5hdGlvbiKeAQoGYW1vdW50EAoaiQEKAwGGoBIHMTAuMDQzMBoKMTAwNDIuOTcwMCAIKgNCVEMyA0NIRjphCh12YWxpZGF0b3ItY29yZUB0YXVydXNncm91cC5jaBJAffe4nBGVSajYYQxxzEZbQuj0snr8WOC1P506eXRn2EUsDrAnkWvNW9wfU+pwUoBVUaXl/veYW/6m/DJsEKijLCIGYW1vdW50Ih4KEXRvdGFsX2ZpYXRfYW1vdW50EAEaBzEwLjA0MzAiCwoDZmVlEAIaAhMBIh4KFGZlZV9wYWlkX2J5X3JlY2VpdmVyEAEaBHRydWU=",
    "status": "CREATED",
    "trails": [
      {
        "userId": "11",
        "externalUserId": "team1@bank.com",
        "action": "created",
        "comment": "Ich bin eine flying Roasted Butternut Squash Boodles",
        "requestStatus": "CREATED"
      },
      {
        "userId": "1",
        "externalUserId": "validator-core@taurusgroup.ch",
        "action": "approvers_assigned",
        "comment": "rule = [source: any, destination: any, amount: 10.0000], approvals = ['team1': 1 sig, 'team2': 1 sig]",
        "requestStatus": "CREATED"
      }
    ],
    "rule": "rule = [source: any, destination: any, amount: 10.0000], approvals = ['team1': 1 sig, 'team2': 1 sig]",
    "approvers": {
      "parallel": [
        {
          "sequential": [
            {
              "externalGroupID": "team1",
              "minimumSignatures": 1
            },
            {
              "externalGroupID": "team2",
              "minimumSignatures": 1
            }
          ]
        }
      ]
    }
  }
}

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

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

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

amountstringRequired

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)

fromAddressIdstringRequiredformat: "uint64"

maxSenderAmountstringOptional

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)

feeLimitstringOptional

toAddressIdstringOptionalformat: "uint64"

A destination should be specified. Either toAddressId or toWhitelistedAddressId.

toWhitelistedAddressIdstringOptionalformat: "uint64"

A destination should be specified. Either toAddressId or toWhitelistedAddressId.

destinationAssetIDstringOptional

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

destinationAssetIssuerstringOptional

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

commentstringOptional

externalRequestIdstringOptional

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

destinationAddressMemostringOptional

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

feePayerIdstringOptionalformat: "uint64"

If set, the id of an XLM fee payer that will wrap this operation in a CAP-15 fee-bump. Inner tx fee is set to 0.

Response

A successful response.

resultobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error