---
updatedAt: 2026-05-28T11:38:46.000Z
agentTools:
  projectIndex: https://developer.sivo.com/llms.txt
---

# Search for transactions

Search for transactions

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Banking",
    "description": "SIVO public Api REST",
    "version": "0.0.1"
  },
  "x-amazon-apigateway-api-key-source": "AUTHORIZER",
  "servers": [
    {
      "url": "https://dev.sivo.com/v1",
      "description": "Sandbox server (user test data)"
    }
  ],
  "paths": {
    "/banking/transactions": {
      "get": {
        "summary": "Search for transactions",
        "description": "Search for transactions",
        "operationId": "getBankingTransaction",
        "tags": [
          "Transactions"
        ],
        "parameters": [
          {
            "name": "type",
            "in": "query",
            "description": "Whether the transaction debits or credits the account balance [debit, credit]",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "description": "Transaction status [completed, pending, deleted]",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "reason",
            "in": "query",
            "description": "User-generated reason for payment - freeform text",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "beneficiaryId",
            "in": "query",
            "description": "Beneficiary UUID",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "currency",
            "in": "query",
            "description": "Three-letter ISO currency code",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/paymentTransaction"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid input supplied"
          },
          "404": {
            "description": "Transaction not found"
          }
        },
        "security": [
          {
            "prod-sandbox-sivo-api-authorizer": [
              "aws.cognito.signin.user.admin"
            ]
          }
        ],
        "x-amazon-apigateway-integration": {
          "httpMethod": "POST",
          "type": "AWS_PROXY",
          "uri": "arn:aws:apigateway:us-east-2:lambda:path/2015-03-31/functions/${Token[TOKEN.2318]}:Alias/invocations"
        }
      }
    }
  },
  "components": {
    "schemas": {
      "transactionType": {
        "type": "string",
        "enum": [
          "credit",
          "debit"
        ]
      },
      "transactionActionType": {
        "type": "string",
        "enum": [
          "conversion",
          "conversion_deposit",
          "deposit_refund",
          "funding",
          "manual_intervention",
          "manual_transaction",
          "payment",
          "payment_failure",
          "payment_fee",
          "top_up_fee",
          "transfer"
        ]
      },
      "transactionRelatedEntityType": {
        "type": "string",
        "enum": [
          "conversion",
          "inbound_funds",
          "payment",
          "balance_transfer"
        ]
      },
      "transactionStatusType": {
        "type": "string",
        "enum": [
          "completed",
          "deleted",
          "pending",
          "processing"
        ]
      },
      "paymentTransaction": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "accountId": {
            "$ref": "#/components/schemas/uuid"
          },
          "balanceId": {
            "$ref": "#/components/schemas/uuid"
          },
          "balanceAmount": {
            "$ref": "#/components/schemas/moneyAmount"
          },
          "completedAt": {
            "$ref": "#/components/schemas/dateTimeIso8601"
          },
          "settlesAt": {
            "$ref": "#/components/schemas/dateTimeIso8601"
          },
          "action": {
            "$ref": "#/components/schemas/transactionActionType"
          },
          "amount": {
            "$ref": "#/components/schemas/moneyAmount"
          },
          "beneficiaryId": {
            "$ref": "#/components/schemas/uuid"
          },
          "currency": {
            "$ref": "#/components/schemas/currencyIso4217"
          },
          "currencyPair": {
            "$ref": "#/components/schemas/text"
          },
          "reason": {
            "$ref": "#/components/schemas/text"
          },
          "relatedEntityType": {
            "$ref": "#/components/schemas/transactionRelatedEntityType"
          },
          "relatedEntityId": {
            "$ref": "#/components/schemas/uuid"
          },
          "relatedEntityShortReference": {
            "$ref": "#/components/schemas/text"
          },
          "status": {
            "$ref": "#/components/schemas/transactionStatusType"
          },
          "type": {
            "$ref": "#/components/schemas/transactionType"
          }
        },
        "required": [
          "accountId",
          "action",
          "balanceId",
          "currency",
          "relatedEntityId",
          "relatedEntityShortReference",
          "relatedEntityType",
          "status",
          "type"
        ]
      },
      "moneyAmount": {
        "type": "integer",
        "description": "See [Money](https://developer.sivo.com/reference/money) for details"
      },
      "uuid": {
        "type": "string",
        "description": "A universal identifier (all lowercase)",
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
      },
      "currencyIso4217": {
        "type": "string",
        "description": "A currency identifier in ISO-4217 format",
        "pattern": "^[A-Z]{3}$"
      },
      "text": {
        "type": "string",
        "minLength": 1
      },
      "dateTimeIso8601": {
        "type": "string",
        "description": "See [Dates and Times](https://developer.sivo.com/reference/dates-and-times) for details",
        "format": "date-time"
      }
    },
    "securitySchemes": {
      "prod-sandbox-sivo-api-authorizer": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "x-amazon-apigateway-authtype": "cognito_user_pools",
        "x-amazon-apigateway-authorizer": {
          "type": "cognito_user_pools",
          "providerARNs": [
            "${Token[TOKEN.1762]}"
          ]
        }
      }
    }
  },
  "x-amazon-apigateway-minimum-compression-size": 0
}
```