---
agentTools:
  projectIndex: https://chimoney.readme.io/llms.txt
---

# Get all transactions by account.

Retrieves a list of all transactions associated with the authenticated user, including details such as transaction IDs, amounts, statuses, and metadata.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Chimoney API Docs",
    "version": "0.2.4",
    "description": "This is the latest version of the Chimoney API. For deprecated version routes, please refer to /v0.2/api-docs."
  },
  "security": [
    {
      "apiKeyAuth": []
    }
  ],
  "servers": [
    {
      "url": "https://api.chimoney.io/",
      "description": "Prod Server"
    },
    {
      "url": "https://api-v2-sandbox.chimoney.io",
      "description": "Sandbox API v2 (v0.2.4)"
    }
  ],
  "paths": {
    "/v0.2.4/accounts/transactions": {
      "post": {
        "summary": "Get all transactions by account.",
        "tags": [
          "Account"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "subAccount": {
                    "type": "string",
                    "description": "Subaccount if any."
                  },
                  "limit": {
                    "type": "number",
                    "description": "Limit the number of transactions to return."
                  },
                  "page": {
                    "type": "number",
                    "description": "Page number to return."
                  },
                  "filters": {
                    "type": "object",
                    "description": "Filters to apply to the transactions.",
                    "properties": {
                      "currency": {
                        "type": "string",
                        "description": "Currency to filter by."
                      },
                      "debitCurrency": {
                        "type": "string",
                        "description": "Debit currency to filter by."
                      },
                      "status": {
                        "type": "string",
                        "description": "Status to filter by."
                      }
                    }
                  }
                }
              },
              "example": {
                "subAccount": "1234567",
                "limit": 10,
                "page": 1,
                "filters": {
                  "currency": "USD",
                  "debitCurrency": "USD",
                  "status": "paid",
                  "startDate": "2024-06-01",
                  "endDate": "2024-11-28"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Status of the request.",
                      "example": "success"
                    },
                    "message": {
                      "type": "string",
                      "description": "Success message.",
                      "example": "Transactions retrieved successfully"
                    },
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "example": "1W31C2JLyOcOdeOMzr45"
                          },
                          "issueDate": {
                            "type": "string",
                            "example": "2022-08-17T21:47:58.156Z"
                          },
                          "issueID": {
                            "type": "string",
                            "example": "XQTUvRBntIU3AHgQ3jFuN9ZcHIC31660772876526"
                          },
                          "chiRef": {
                            "type": "string",
                            "example": "2ea04d0e-73a2-41a1-ac5c-582d1870f768"
                          },
                          "status": {
                            "type": "string",
                            "example": "paid"
                          },
                          "initiatedBy": {
                            "type": "string",
                            "example": "XQTUvRBntIU3AHgQ3jFuN9ZcHIC3"
                          },
                          "issuer": {
                            "type": "string",
                            "example": "x2Zfuf0ZHBWOqlgzlpEK3Z3TVkw2"
                          },
                          "email": {
                            "type": "string",
                            "example": "mide@test.com"
                          },
                          "chimoney": {
                            "type": "number",
                            "example": 1000
                          },
                          "valueInUSD": {
                            "type": "number",
                            "example": 1
                          },
                          "productId": {
                            "type": "number",
                            "example": 1
                          },
                          "valueInLocalCurrency": {
                            "type": "number",
                            "example": 1
                          },
                          "twitter": {
                            "type": "string",
                            "example": ""
                          },
                          "countryCode": {
                            "type": "string",
                            "example": "US"
                          },
                          "type": {
                            "type": "string",
                            "example": "giftcard"
                          },
                          "redeemData": {
                            "type": "object"
                          },
                          "payout": {
                            "type": "object"
                          },
                          "integration": {
                            "type": "object"
                          },
                          "enabledToRedeem": {
                            "type": "array",
                            "items": {
                              "type": "string",
                              "example": [
                                "Wallet",
                                "Mobile and Internet",
                                "Bank",
                                "Digital Currencies",
                                "Products",
                                "Gift Cards"
                              ]
                            }
                          },
                          "pagination": {
                            "type": "object",
                            "description": "Pagination object.",
                            "properties": {
                              "page": {
                                "type": "number",
                                "example": 1
                              },
                              "limit": {
                                "type": "number",
                                "example": 10
                              },
                              "totalCount": {
                                "type": "number",
                                "example": 100
                              },
                              "totalPages": {
                                "type": "number",
                                "example": 10
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "500": {
            "$ref": "#/components/responses/ServerError"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "apiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-KEY"
      }
    },
    "responses": {
      "Forbidden": {
        "description": "Access to this resource is forbidden.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Forbidden"
            }
          }
        }
      },
      "Unauthorized": {
        "description": "Access to this resource is not available for unauthenticated users.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Unauthorized"
            }
          }
        }
      },
      "ServerError": {
        "description": "Indicates an internal server error.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ServerError"
            }
          }
        }
      }
    },
    "schemas": {
      "Forbidden": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "description": "Status of the response.",
            "example": "error"
          },
          "error": {
            "type": "string",
            "description": "Error message indicating forbidden access.",
            "example": "API Access not enabled for account Test. Email support@chimoney.io"
          }
        }
      },
      "Unauthorized": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "description": "Status of the response.",
            "example": "error"
          },
          "error": {
            "type": "string",
            "description": "Error message indicating unauthorized access.",
            "example": "API key is not defined. Generate a new one from the developer portal."
          }
        }
      },
      "ServerError": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "description": "Status of the error.",
            "example": "error"
          },
          "type": {
            "type": "string",
            "description": "Type of server error.",
            "example": "server error"
          },
          "code": {
            "type": "string",
            "description": "Specific error code for server issues.",
            "example": "INTERNAL_SERVER_ERROR"
          },
          "message": {
            "type": "string",
            "description": "Detailed message explaining the issue.",
            "example": "An internal server error occurred."
          }
        }
      }
    }
  },
  "tags": [
    {
      "name": "Account",
      "description": "All account related endpoints."
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 102,
      "1": 208,
      "2": 243,
      "3": 240,
      "4": 73,
      "5": 214,
      "6": 34,
      "7": 0,
      "8": 37,
      "9": 190,
      "10": 200,
      "11": 166
    }
  }
}
```