Fipto - OpenAPI 3.0
1.2.2

This is a REST API specifications based on OpenAPI 3.0 for Fipto solution.

This is the documentation for version 1.2.2 of the API. Last update on Aug 30, 2023.

Base URL 
https://api.fipto.app

Initiate payout

POST /companies/{company_id}/wallets/{wallet_id}/payouts

Initiate a payment from your wallet to a specified beneficiary. We will process the payment and send it to the beneficiary.

Path parameters

  • company_id string Required

    The Company ID given by Fipto.

    Format should match the following pattern: [0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}.

  • wallet_id string Required

    The Wallet ID given by Fipto.

    Format should match the following pattern: [0-9a-zA-Z]{22}.

application/json

Body

  • data object Required

    Fields required on all objects.

    Hide data attributes Show data attributes
    • type string Required

      Value is payout.

    • attributes object Required
      Hide attributes attributes Show attributes attributes
      • beneficiary_id string Required

        Unique identifier generated by the server.

        Format should match the following pattern: [0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}.

      • amount string Required

        Strictly positive amount expressed in the currency of the transaction.

        Format should match the following pattern: ^(0*[1-9]\d*(\.\d+)?|0*\.\d*[1-9]\d*)$.

Responses

  • • 202

    Payout Accepted

    Hide response attributes Show response attributes object
    • meta object Required
      Hide meta attributes Show meta attributes
      • request_id string Required

        Unique identifier generated by the server.

        Format should match the following pattern: [0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}.

      • query_parameters object

        Information about the parameters in the request. All query string parameters provided (or implicit/with default value) will be returned

    • data object

      Fields required on all objects.

      Hide data attributes Show data attributes
      • type string Required

        Value is payout.

      • attributes object Required
        Hide attributes attributes Show attributes attributes
        • wallet object

          Wallet information in a transaction

          Hide wallet attributes Show wallet attributes
          • wallet_id string Required

            Unique identifier generated by Fipto product on base62 format.

            Format should match the following pattern: [0-9a-zA-Z]{22}.

          • wallet_name string Required

            The name of the wallet.

        • beneficiary object

          Information of beneficiary into a transaction

          Hide beneficiary attributes Show beneficiary attributes
          • beneficiary_id string Required

            Unique identifier generated by the server.

            Format should match the following pattern: [0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}.

          • beneficiary_description string

            The description given to the beneficiary.

        • amount string

          Strictly positive amount expressed in the currency of the transaction.

          Format should match the following pattern: ^(0*[1-9]\d*(\.\d+)?|0*\.\d*[1-9]\d*)$.

        • status string

          Status of the payout.

          Values are pending, rejected, completed, awaiting co-signer, insufficient funds, in process, or submitted.

        • valuations array[object]

          Valuation of an asset

          Hide valuations attributes Show valuations attributes
          • asset string

            The quote asset of the provided valuation.

            Values are EUR or USD.

          • value string

            The estimated value of the asset (based on the quote asset).

        • transaction_id string

          Unique identifier generated by Fipto product on base62 format.

          Format should match the following pattern: [0-9a-zA-Z]{22}.

        • created_at string(date-time)

          The specific date on which the transaction has been created.

        • asset_code string

          The symbol/ticker of the crypto asset.

          Format should match the following pattern: ([A-Z_]){3,}.

        • created_by string

          The id of the user that initiated the payout.

          Format should match the following pattern: [0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}.

        • signature object

          Data of signature

          Hide signature attributes Show signature attributes
          • quorum integer

            The required number of signatories.

          • mfa array[string]

            Value is totp.

          • signatories array[object]
            Hide signatories attribute Show signatories attribute
            • user_id string

              Unique identifier generated by the server.

              Format should match the following pattern: [0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}.

        • blockchain_data object

          Data from the blockchain

          Hide blockchain_data attributes Show blockchain_data attributes
      • id string

        Unique identifier generated by Fipto product on base62 format.

        Format should match the following pattern: [0-9a-zA-Z]{22}.
POST /companies/{company_id}/wallets/{wallet_id}/payouts 
curl \
 -X POST https://api.fipto.app/companies/9de0691c-bc8d-409b-8f40-75d4f45db2f3/wallets/3Qv67yjXEwB9SjmvkuG6Cp/payouts \
 -H "Content-Type: application/json" \
 -d '{"data":{"type":"payout","attributes":{"beneficiary_id":"string","amount":"1000"}}}'
Request example 
{
  "data": {
    "type": "payout",
    "attributes": {
      "beneficiary_id": "string",
      "amount": "1000"
    }
  }
}
Response examples (202) 
{
  "meta": {
    "request_id": "string",
    "query_parameters": {}
  },
  "data": {
    "type": "payout",
    "attributes": {
      "wallet": {
        "wallet_id": "string",
        "wallet_name": "My wallet"
      },
      "beneficiary": {
        "beneficiary_id": "string",
        "beneficiary_description": "My beneficiary"
      },
      "amount": "1000",
      "status": "pending",
      "valuations": [
        {
          "asset": "EUR",
          "value": "10.05"
        },
        {
          "asset": "USD",
          "value": "12.97"
        }
      ],
      "transaction_id": "string",
      "created_at": "2023-05-04T09:42:00+00:00",
      "asset_code": "BTC",
      "created_by": "string",
      "signature": {
        "quorum": 42,
        "mfa": [
          "totp"
        ],
        "signatories": [
          {
            "user_id": "string"
          }
        ]
      },
      "blockchain_data": {
        "transaction_hash": "string",
        "block_explorer_link": "string"
      }
    },
    "id": "string"
  }
}