POST
/
payouts
curl --request POST \
  --url https://api.sandbox.sardine.ai/v1/payouts \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "referenceId": "<string>",
  "orderId": "<string>",
  "fiatValue": {
    "fiatAmount": 123,
    "fiatCurrency": "<string>"
  },
  "payoutConfiguration": {
    "recipients": [
      {
        "percentageOfTotal": 123,
        "payoutType": "<any>",
        "walletData": {
          "network": "<string>",
          "assetSymbol": "<string>",
          "walletAddress": "<string>"
        }
      }
    ]
  }
}'
{
  "orderId": "a9a54943-468a-4e0c-9d3d-84b7dbc663f0",
  "orderValue": 20,
  "payouts": [
    {
      "id": "7fea91c2-a491-49fb-9312-d372f4334ce1",
      "orderId": "a9......",
      "status": "FUNDED",
      "payoutType": "CRYPTO",
      "receipt": {
        "walletAddress": "0x...",
        "assetSymbol": "USDC",
        "assetAmount": 15,
        "network": "polygon",
        "txHash": "null // Will be null immediately after POST request"
      }
    },
    {
      "id": "887d8f92-f129-4ecb-b909-0e12aff70e74",
      "status": "FUNDED",
      "payoutType": "CRYPTO",
      "receipt": {
        "walletAddress": "0x...",
        "assetSymbol": "USDC",
        "assetAmount": 5,
        "network": "polygon",
        "txHash": null
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
referenceId
string

Optional unique ID that can be passed to refer to the Payout. Must be unique for every Payout

​
orderId
string

Order ID generated by Sardine for the fiat part of the transaction. Must be passed if Sardine has done the fiat processing.

​
fiatValue
object

Only to be passed if an associated OrderId is not present

​
payoutConfiguration
object

Response

200 - application/json
OK
​
orderId
string

Order ID if present in request

​
orderValue
integer

Sum of the payouts amount

​
payouts
object[]
Fetch Payout InformationUpdate NFT Status