Execute payout quote

Execute a persisted quote the account authorized with a signature over the executionContract that submit returned. Which channel settles it follows from the quote itself.

POST /api/v1/balance/payout/quote/execute

Execute payout quote

cURL

curl --request POST \
  --url https://api.example.com/api/v1/balance/payout/quote/execute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "quoteId": "<string>",
  "signature": {
    "signature": "<string>",
    "scheme": "eip1271",
    "txHash": "<string>"
  }
}
'

200

{
  "status": "<string>",
  "executionContract": {
    "mode": "deposit_address",
    "requiresExecution": true,
    "depositAddress": "<string>",
    "depositMemo": "<string>",
    "depositAmount": "<string>",
    "depositToken": "<string>",
    "approval": {
      "token": "<string>",
      "spender": "<string>",
      "amount": "<string>",
      "transaction": {
        "chainId": 123,
        "to": "<string>",
        "data": "<string>",
        "value": "0x0",
        "gasLimit": "<string>"
      }
    },
    "transaction": {
      "chainId": 123,
      "to": "<string>",
      "data": "<string>",
      "value": "0x0",
      "gasLimit": "<string>"
    },
    "typedData": {
      "domain": {},
      "types": {},
      "primaryType": "<string>",
      "message": {},
      "digest": "<string>",
      "signingScheme": "eip1271"
    },
    "hashAlgorithm": "sha256",
    "canonicalization": "sorted-json-v1",
    "hashArguments": {
      "amount": "<string>",
      "recipient": {
        "rail": "us",
        "type": "individual",
        "bankAddress": {
          "addressLine1": "<string>",
          "city": "<string>",
          "country": "<string>",
          "addressLine2": "<string>",
          "state": "<string>",
          "postalCode": "<string>"
        },
        "postalAddress": {
          "addressLine1": "<string>",
          "city": "<string>",
          "country": "<string>",
          "addressLine2": "<string>",
          "state": "<string>",
          "postalCode": "<string>"
        },
        "accountNumber": "<string>",
        "routingNumber": "<string>",
        "accountType": "checking",
        "iban": "<string>",
        "bic": "<string>",
        "bankName": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "legalName": "<string>",
        "phone": "<string>"
      },
      "idempotencyKey": "<string>",
      "paymentReference": "<string>",
      "documentIds": [
        "<string>"
      ]
    },
    "canonicalPayload": {
      "routes": [
        {
          "from": "<string>",
          "to": "<string>",
          "stable": true,
          "factory": "<string>"
        }
      ],
      "amount_in": "<string>",
      "amount_out_min": "<string>",
      "recipient": "<string>",
      "token": "<string>",
      "chain_id": 123,
      "tick_spacing": 123
    }
  }
}

Authorizations

Authorization · string · header · required

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

Headers

x-api-key · string | null

Body

application/json

Execute a persisted the banking provider fiat payout quote.

Authorized by the smart wallet's ERC-1271 signature over the quote's executionContract.typedData.

quoteId · string · required

The quoteId the quote was issued under — the same one submit was called with, since submit answers with no id of its own — or the SHA-256 of the quote amount, recipient and idempotency key that the signed typed data names. Both address the same quote. Every id we issue is a bare one of ours: no channel prefix and no provider marker, whichever rail priced it.

Required string length: 32 - 64

Pattern: ^([0-9a-f]{32}|[0-9a-f]{64}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

signature · ClientSignature · object · required

Base smart wallet signature over the payout typed data (scheme: eip1271). The backend rebuilds the digest from the stored quote and asks the wallet's isValidSignature about it.

Show child attributes

Response

200

application/json

Successful Response

status · string · required

executionContract · ExecutionContract · object | null

Everything the client needs to execute one quote.

One format for every channel: crypto routes carry deposit / transaction / order instructions, the banking provider fiat payouts carry the typed data to sign and the arguments that reproduce the quote hash. canonical_payload pins what was quoted — the provider payload persisted with a crypto route (/submit relays from it, never from client input), or the canonical JSON a the banking provider quote id is hashed from.

Show child attributes