---
updatedAt: 2026-09-10T13:20:47.000Z
agentTools:
projectIndex: https://docs.instantcashworldwide.com/llms.txt
---
# Get list of transactions
Returns a list of the transactions created or received by a agent.
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"info": {
"title": "Instant Cash API Sandbox",
"description": "Help your customers send and receive money efficiently, securely, and seamlessly to millions of global endpoints within Instant Cash.",
"version": "v1.0"
},
"servers": [
{
"url": "https://api.instantcashworldwide.ae/sandbox"
}
],
"paths": {
"/api/v1/transactions": {
"get": {
"tags": [
"Sender"
],
"summary": "Get list of transactions",
"description": "Returns a list of the transactions created or received by a agent.",
"operationId": "GetList_a0c95bc1-c479-45de-962f-312922f249f5",
"parameters": [
{
"name": "fromDate",
"in": "query",
"description": "Date from which to start searching.\r\n
Format: yyyy-MM-dd (ISO-8601)",
"schema": {
"type": "string",
"description": "Date from which to start searching.\r\n
Format: yyyy-MM-dd (ISO-8601)",
"format": "date-time",
"nullable": true,
"example": "2022-01-01"
},
"example": "2022-01-01"
},
{
"name": "toDate",
"in": "query",
"description": "Date until which to select transactions.\r\n
Format: yyyy-MM-dd (ISO-8601)",
"schema": {
"type": "string",
"description": "Date until which to select transactions.\r\n
Format: yyyy-MM-dd (ISO-8601)",
"format": "date-time",
"nullable": true,
"example": "2023-01-01"
},
"example": "2023-01-01"
},
{
"name": "pageNumber",
"in": "query",
"description": "The number of the next page.\r\n(Default is 1)",
"schema": {
"maximum": 2147483647,
"minimum": 1,
"type": "integer",
"description": "The number of the next page.\r\n(Default is 1)",
"format": "int32"
}
},
{
"name": "pageSize",
"in": "query",
"description": "This is the maximum number of records per page that can be returned to the client.\r\nMust be between 1 and 1000. (Default is 50)",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"description": "This is the maximum number of records per page that can be returned to the client.\r\nMust be between 1 and 1000. (Default is 50)",
"format": "int32"
}
},
{
"name": "x-fapi-financial-id",
"in": "header",
"description": "This is the agent correspondent id provided to the agent by the IC Operations department. It is used to facilitate API management and auditing.",
"required": true,
"schema": {
"title": "agent code",
"pattern": "^[A-Z]{2}[0-9A-Z]{4}$",
"type": "string"
},
"example": "AEXXXX"
},
{
"name": "x-correlation-id",
"in": "header",
"description": "This header is used to uniquely identify the HTTP request and to facilitate troubleshooting.",
"schema": {
"title": "uuid v4",
"pattern": "\\w{8}-\\w{4}-\\w{4}-\\w{4}-\\w{12}",
"type": "string"
},
"example": "351f7184-16e4-4aca-a678-f6e623f762e4"
},
{
"name": "x-idempotency-key",
"in": "header",
"description": "Unique request identifier to support idempotency. You may generate (UUID v4) value using the programming language.",
"schema": {
"title": "uuid v4",
"pattern": "\\w{8}-\\w{4}-\\w{4}-\\w{4}-\\w{12}",
"type": "string"
},
"example": "0053c524-c105-4441-aa60-38ef0261fd06"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransactionGetListResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceErrorResponse"
}
}
}
},
"500": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceErrorResponse"
}
}
}
},
"503": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceErrorResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"ServiceError": {
"type": "object",
"properties": {
"code": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"details": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceErrorDetail"
},
"nullable": true
}
},
"additionalProperties": false
},
"ServiceErrorDetail": {
"type": "object",
"properties": {
"target": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ServiceErrorResponse": {
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/ServiceError"
}
},
"additionalProperties": false
},
"TransactionGetListAgentModel": {
"required": [
"combinedCode",
"correspondentId",
"headOffice",
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the agent."
},
"correspondentId": {
"type": "string",
"description": "Agent correspondent ID."
},
"headOffice": {
"type": "string",
"description": "Agent head office code."
},
"combinedCode": {
"type": "string",
"description": "Agent combined code."
}
},
"additionalProperties": false
},
"TransactionGetListItemModel": {
"required": [
"charge",
"commissionAmount",
"deliveryMode",
"destinationCountry",
"exchangeRate",
"originatingCountry",
"partnerReference",
"payingAmount",
"payingCurrency",
"receivingAgent",
"reference",
"sendingAgent",
"sentAt",
"settlementAmount",
"settlementCurrency",
"status",
"statusDescription",
"totalSettlementAmount"
],
"type": "object",
"properties": {
"reference": {
"type": "string",
"description": "Transaction ID."
},
"partnerReference": {
"type": "string",
"description": "Unique number sent by Agent system for each transaction."
},
"status": {
"type": "string",
"description": "Actual transaction status.\r\nIf the value is blank then transaction generated without any violation."
},
"statusDescription": {
"type": "string",
"description": "The description of the transaction status."
},
"deliveryMode": {
"type": "string",
"description": "Defines the method of remittance to the recipient."
},
"exchangeRate": {
"type": "number",
"description": "The rate applied for the transaction.",
"format": "double"
},
"settlementAmount": {
"type": "number",
"description": "The amount that remitter is sent.",
"format": "double"
},
"settlementCurrency": {
"type": "string",
"description": "The currency code of the settlement amount as specified by ISO4217."
},
"commissionAmount": {
"type": "number",
"description": "The commission settlement amount.",
"format": "double"
},
"charge": {
"type": "number",
"description": "Customer fixed amount.",
"format": "double"
},
"totalSettlementAmount": {
"type": "number",
"description": "Total settlement amount.",
"format": "double"
},
"payingCurrency": {
"type": "string",
"description": "The currency code of the paying amount as specified by ISO4217."
},
"payingAmount": {
"type": "number",
"description": "The amount that recipient will receive.",
"format": "double"
},
"originatingCountry": {
"type": "string",
"description": "Originating country from where the remittance is sent.\r\nISO-3166 alpha-2 code."
},
"destinationCountry": {
"type": "string",
"description": "Remittance's destination country.\r\nISO-3166 alpha-2 code."
},
"sentAt": {
"type": "string",
"description": "Transaction send date. Format: ISO-8601",
"format": "date-time"
},
"sendingAgent": {
"$ref": "#/components/schemas/TransactionGetListAgentModel"
},
"receivingAgent": {
"$ref": "#/components/schemas/TransactionGetListAgentModel"
}
},
"additionalProperties": false
},
"TransactionGetListResponse": {
"type": "object",
"properties": {
"currentPage": {
"type": "integer",
"description": "Current page number.",
"format": "int32"
},
"pageSize": {
"type": "integer",
"description": "This is the maximum number of records per page that can be returned to the client.",
"format": "int32"
},
"total": {
"type": "integer",
"description": "The total number of records found in the Instant Cash database for your query.",
"format": "int32"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TransactionGetListItemModel"
},
"description": "A list of results.",
"nullable": true
}
},
"additionalProperties": false
}
},
"securitySchemes": {
"Bearer": {
"type": "apiKey",
"description": "Authorization header using the Bearer/Basic scheme. Example: \"Authorization: **{Scheme}** {token}\"",
"name": "Authorization",
"in": "header",
"x-default": "Basic dXNlcl9pZDpwYXNzd29yZA=="
}
}
},
"security": [
{
"Bearer": []
}
],
"x-readme": {
"explorer-enabled": false,
"proxy-enabled": false,
"metrics-enabled": false
}
}
```