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

Get a transaction

GET /companies/{company_id}/transactions/{transaction_id}

Retrieve a specific transaction by its unique identifier.

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}.

  • transaction_id string Required

    The Transaction ID given by Fipto.

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

Responses

  • • 200

    Retrieve a transaction

    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
      One of:
      payin_data object payout_data object
GET /companies/{company_id}/transactions/{transaction_id} 
curl \
 -X GET https://api.fipto.app/companies/9de0691c-bc8d-409b-8f40-75d4f45db2f3/transactions/3Qv67yjXEwB9SjmvkuG6Cp
Response examples (200) 
{
  "meta": {
    "request_id": "string",
    "query_parameters": {}
  },
  "data": {
    "type": "payin",
    "attributes": {
      "wallet": {
        "wallet_id": "string",
        "wallet_name": "My wallet"
      },
      "amount": "1000",
      "valuations": [
        {
          "asset": "EUR",
          "value": "10.05"
        },
        {
          "asset": "USD",
          "value": "12.97"
        }
      ],
      "booked_at": "2023-05-04T09:42:00+00:00",
      "valued_at": "2023-05-04T09:42:00+00:00",
      "created_at": "2023-05-04T09:42:00+00:00",
      "source": "string",
      "wallet_details": {
        "asset": "BTC",
        "address": "0x71C*",
        "name": "Acme - Payment Project X",
        "tag": "string"
      },
      "status": "returned",
      "transaction_id": "string",
      "blockchain_data": {
        "transaction_hash": "string",
        "block_explorer_link": "string"
      }
    },
    "id": "string"
  }
}