> ## Documentation Index
> Fetch the complete documentation index at: https://docs.payments.sardine.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Payout

> Create a Payout where Sardine will send crypto to specified wallet(s) in specified cryptocurrencies. 

A Payout can be created associated with a corresponding fiat order (where Sardine has also done the fiat processing) or without one (where Sardine does not do the fiat component). 

To trigger Payouts without the fiat processing being done by Sardine, contact your Integration team.



## OpenAPI

````yaml /api_reference/nft.yaml post /payouts
openapi: 3.1.0
info:
  version: '1.0'
  title: NFT API
  summary: API to enable direct NFT purchasing
  description: Reference for Sardine Crypto API
servers:
  - url: https://api.sandbox.sardine.ai/v1
    description: Sandbox
  - url: https://api.sardine.ai/v1
    description: Prod Server
security:
  - {}
paths:
  /payouts:
    post:
      summary: Create Payout
      description: >-
        Create a Payout where Sardine will send crypto to specified wallet(s) in
        specified cryptocurrencies. 


        A Payout can be created associated with a corresponding fiat order
        (where Sardine has also done the fiat processing) or without one (where
        Sardine does not do the fiat component). 


        To trigger Payouts without the fiat processing being done by Sardine,
        contact your Integration team.
      operationId: post-payouts-payout_id
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              type: object
              properties:
                referenceId:
                  type: string
                  description: >-
                    Optional unique ID that can be passed to refer to the
                    Payout. Must be unique for every Payout
                orderId:
                  type: string
                  description: >-
                    Order ID generated by Sardine for the fiat part of the
                    transaction. Must be passed if Sardine has done the fiat
                    processing. 
                fiatValue:
                  type: object
                  description: Only to be passed if an associated `OrderId` is not present
                  properties:
                    fiatAmount:
                      type: number
                      description: Amount in fiat that needs to be paid out
                    fiatCurrency:
                      type: string
                      description: Fiat currency type
                payoutConfiguration:
                  type: object
                  properties:
                    recipients:
                      type: array
                      items:
                        type: object
                        properties:
                          percentageOfTotal:
                            type: number
                            description: >-
                              The percentage of the `fiatAmount` that should be
                              paid out to this recipient
                          payoutType:
                            const: crypto
                            description: Type of payout, currently restricted to `crypto`
                          walletData:
                            type: object
                            properties:
                              network:
                                type: string
                                description: Blockchain on which the payout should occur
                              assetSymbol:
                                type: string
                                description: >-
                                  Type of cryptocurrency on which the payout
                                  should occur
                              walletAddress:
                                type: string
                                description: >-
                                  Wallet address on the `network` that is
                                  receiving the payout. 
              x-examples:
                Example 1:
                  referenceId: 04ce75d2-fdce-4624-9566-a4783855324d
                  orderId: a9a54943-468a-4e0c-9d3d-84b7dbc663f0
                  fiatValue:
                    fiatAmount: 20
                    fiatCurrency: USD
                  payoutConfiguration:
                    recipients:
                      - percentageOfTotal: 75
                        payoutType: CRYPTO
                        walletData:
                          network: polygon
                          assetSymbol: USDC
                          walletAddress: 0x...
                      - percentageOfTotal: 25
                        payoutType: crypto
                        walletData:
                          network: polygon
                          assetSymbol: USDC
                          walletAddress: 0x...
            examples:
              Create Payout in USDC on Polygon with equal splits to two wallets: {}
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  orderId:
                    type: string
                    description: Order ID if present in request
                  orderValue:
                    type: integer
                    description: Sum of the payouts amount
                  payouts:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Unique Payout ID
                        orderId:
                          type: string
                          description: Order ID associated with this Payout
                        status:
                          type: string
                          enum:
                            - funded
                            - declined
                            - complete
                          description: Status of Payout
                        payoutType:
                          type: string
                          description: Type of payout, currently restricted to `crypto`
                        receipt:
                          type: object
                          properties:
                            walletAddress:
                              type: string
                              description: Wallet address receiving the payout
                            assetSymbol:
                              type: string
                              description: Type of cryptocurrency that Payout is made in
                            assetAmount:
                              type: integer
                              description: Amount in `assetSymbol` of the Payout
                            network:
                              type: string
                              description: Blockchain network on which the Payout occurs
                            txHash:
                              type:
                                - string
                                - 'null'
                              description: >-
                                Transaction hash once the Payout has settled on
                                chain, and funds have been delivered to the
                                `walletAddress`
                x-examples:
                  Example 1:
                    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: 50
                          network: polygon
                          txHash: null
                      - id: 887d8f92-f129-4ecb-b909-0e12aff70e74
                        status: FUNDED
                        payoutType: CRYPTO
                        receipt:
                          walletAddress: 0x...
                          assetSymbol: USDC
                          assetAmount: 50
                          network: polygon
                          txHash: null
              examples:
                Create Payout in USDC on Polygon to two wallets, split equally:
                  value:
                    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
      security:
        - ClientToken: []
      servers:
        - url: https://api.sandbox.sardine.ai/v1
          description: Sandbox
        - url: https://api.sardine.ai/v1
          description: Prod Server
components:
  securitySchemes:
    ClientToken:
      type: http
      scheme: basic

````