# List transaction status details (transaction banking)
Returns a list of transactions mapped to a tracking ID. For each transaction, the request returns the approval status (approved or declined), as well as details such as amount, currency, and metadata. Multiple transactions can be associated with a single tracking ID; for example in transfers where both debit and credit legs are present. Additionally, if there are multiple attempts using the same tracking ID, all failed (declined) attempts are also included in the response.
# OpenAPI definition
```json
{
"openapi": "3.0.0",
"info": {
"title": "Banking - Transaction banking",
"version": "0.9.0",
"description": "Transaction banking API",
"contact": {
"name": "API Support",
"url": "https://developers.pismo.io/support/"
},
"license": {
"name": "Copyright Pismo"
}
},
"servers": [
{
"url": "https://sandbox.pismolabs.io",
"description": "Sandbox API server for testing"
}
],
"security": [
{
"BearerAuth": []
}
],
"tags": [
{
"name": "Transactions",
"description": "Transaction endpoints"
}
],
"components": {
"parameters": {
"CursorQuery": {
"name": "cursor",
"in": "query",
"description": "Cursor to the next page of results. If no value is specified, it fetches the first page.",
"schema": {
"type": "string"
},
"example": "1234"
},
"LimitQuery4": {
"name": "limit",
"in": "query",
"description": "Maximum number of items per page. Defaults to `10`",
"schema": {
"type": "integer",
"format": "int32",
"default": 10
},
"example": 20
},
"TrackingIdPath": {
"name": "trackingId",
"in": "path",
"description": "Original tracking ID provided when the ID is created.",
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 43
},
"required": true,
"example": "0a50c88a-ade8-4bcc-a639-9a0b0f11e245"
}
},
"schemas": {
"AmountValue": {
"type": "number",
"format": "float",
"description": "Amount value",
"exclusiveMinimum": false,
"minimum": 0,
"maximum": 100000000000000000,
"example": 1000.52
},
"AuthorizationStatus": {
"type": "string",
"enum": [
"APPROVED",
"DECLINED"
],
"description": "Authorization status",
"example": "DECLINED"
},
"Currency": {
"type": "string",
"description": "3-letter code in ISO 4217-compliant format for the currency used in the transaction.",
"maxLength": 3,
"minLength": 3,
"example": "USD"
},
"Cursor": {
"type": "string",
"description": "Cursor pointing to the next page of results",
"example": "eyJJRCI6IjBjOGVhMTA4LWNhZTYtNDA2Mi1iMmQzLTFhMTZkNmJiNGIyOCIsIk9yZ0lEIjoiMDllYThhMDQtNWY5My0xMWVkLTliNmEtMDI0MmFjMTIwMDAyIn0="
},
"ErrorCode": {
"description": "Error code\n`minLength: 1`\n`maxLength: 12`\n",
"type": "string",
"minLength": 1,
"maxLength": 12,
"example": "WPMT0017"
},
"ErrorMessage": {
"description": "Error message\n`minLength: 1`\n`maxLength: 1000`\n",
"type": "string",
"minLength": 1,
"maxLength": 1000,
"example": "Invalid JSON payload received: Error unmarshalling request"
},
"ErrorResponse": {
"type": "object",
"properties": {
"code": {
"$ref": "#/components/schemas/ErrorCode"
},
"message": {
"$ref": "#/components/schemas/ErrorMessage"
}
}
},
"EventDate": {
"type": "string",
"format": "date-time",
"description": "Event date in format ISO 8601.",
"example": "2023-04-27T12:01:24Z"
},
"ListTransactionStatusResponse": {
"title": "ListTransactionStatusResponse",
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of transactions statuses",
"items": {
"$ref": "#/components/schemas/TransactionStatusResponse"
}
},
"pagination": {
"$ref": "#/components/schemas/Pagination"
}
}
},
"MaxItemsPerPage": {
"type": "integer",
"format": "int32",
"description": "Maximum number of items per page",
"example": 10
},
"Metadata": {
"type": "object",
"description": "Key-value pairs containing data intended for storage in the Pismo system.
\nNOTES:\n- The `metadata` field includes a `corporate_metadata` object with the following fields:\n - `credit_external_account_id`: Included in the `corporate_metadata` field when it's provided in the credit leg.\n - `debit_external_account_id`: Included in the `corporate_metadata` field when it's provided in the debit leg.\n - `earmark_id`: Included in the `corporate_metadata` field when it's provided in the debit leg.\n- The `corporate_metadata` attribute must be an object. A type mismatch results in an error as mapped in the responses section.\n",
"example": {
"my-id": 2932
}
},
"Pagination": {
"type": "object",
"description": "Data related to list pagination using a cursor.",
"properties": {
"limit": {
"$ref": "#/components/schemas/MaxItemsPerPage"
},
"cursor": {
"$ref": "#/components/schemas/Cursor"
}
}
},
"ProcessingCode": {
"type": "string",
"description": "Processing code used to create the underlying transaction. Each internal operation type uses a default processing code.
\n`minLength: 1`\n`maxLength: 6`\n",
"minLength": 1,
"maxLength": 6,
"example": "219248"
},
"TrackingID": {
"type": "string",
"description": "A unique payment tracking number provided by the client. If an existing `tracking_id` already exists in the system, the API returns a `409` error.\n\nThis field is:\n - Unique within the Organization.\n - Immutable — It can't be updated.\n - Not recyclable — You can't reuse a `tracking_id`.\n",
"minLength": 1,
"maxLength": 43,
"example": "0a50c88a-ade8-4bcc-a639-9a0b0f11e244"
},
"TransactionStatusResponse": {
"type": "object",
"properties": {
"authorizations_status": {
"$ref": "#/components/schemas/AuthorizationStatus"
},
"amount": {
"$ref": "#/components/schemas/AmountValue"
},
"currency": {
"$ref": "#/components/schemas/Currency"
},
"processing_code": {
"$ref": "#/components/schemas/ProcessingCode"
},
"tracking_id": {
"$ref": "#/components/schemas/TrackingID"
},
"metadata": {
"$ref": "#/components/schemas/Metadata"
},
"event_datetime": {
"$ref": "#/components/schemas/EventDate"
},
"error": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"responses": {
"500InternalServer": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"examples": {
"Generic internal error": {
"value": {
"code": "ECMN9999",
"message": "Internal error"
}
}
}
}
}
}
},
"securitySchemes": {
"BearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
}
},
"paths": {
"/corporate/v1/corporate-transactions/status/{trackingId}": {
"get": {
"summary": "List transaction status details (transaction banking)",
"description": "Returns a list of transactions mapped to a tracking ID. For each transaction, the request returns the approval status (approved or declined), as well as details such as amount, currency, and metadata. Multiple transactions can be associated with a single tracking ID; for example in transfers where both debit and credit legs are present. Additionally, if there are multiple attempts using the same tracking ID, all failed (declined) attempts are also included in the response.\n",
"operationId": "list-corporate-transaction-statuses",
"tags": [
"Transactions"
],
"parameters": [
{
"$ref": "#/components/parameters/TrackingIdPath"
},
{
"$ref": "#/components/parameters/CursorQuery"
},
{
"$ref": "#/components/parameters/LimitQuery4"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListTransactionStatusResponse"
},
"examples": {
"Example transactions list": {
"value": {
"items": [
{
"authorizations_status": "DECLINED",
"amount": 1000,
"currency": "USD",
"processing_code": "220035",
"tracking_id": "f216e914-7e72-4253-a386-d2215048af00",
"metadata": {
"invoice": 2938
},
"event_datetime": "2023-04-27T12:01:24Z",
"error": {
"code": "WPMT0010",
"message": "Insufficient funds"
}
},
{
"authorizations_status": "APPROVED",
"amount": 1000,
"currency": "USD",
"processing_code": "220035",
"tracking_id": "f216e914-7e72-4253-a386-d2215048af00",
"metadata": {
"invoice": 2938
},
"event_datetime": "2023-04-27T13:01:24Z"
}
],
"pagination": {
"cursor": "eyJvZmZzZXQiOiA0MDAwfQ==",
"limit": 10
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"examples": {
"Account not authorized": {
"value": {
"code": "WCAC0001",
"message": "Account not authorized"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"examples": {
"Forbidden request": {
"value": {
"message": "access denied"
}
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"examples": {
"Transaction not found": {
"value": {
"code": "WCTR0006",
"message": "Transaction not found"
}
}
}
}
}
},
"500": {
"$ref": "#/components/responses/500InternalServer"
}
}
}
}
}
}
```