List customer transactions

GET 
/Transactions/customer/:customerCode

List customer transactions

Request

Path Parameters

customerCode stringrequired

The customer code.

Responses

200

A paginated list of transactions.

application/json

Schema

Schema

page int32required

The current page number in the paginated result set.

count int32required

The number of items returned on this page.

hasNextPage booleanrequired

Indicates whether additional pages of results are available after the current page.

hasPreviousPage booleanrequired

Indicates whether pages of results exist before the current page.

totalCount int32required

The total number of items across all pages.

totalPages int32required

The total number of pages available.

items object[]nullable
The collection of items returned for the current page.
Array [
code stringnullablerequired
The unique code identifying this entity.
documentCode stringnullablerequired
The document code associated with the transaction.
typeCode stringnullablerequired
The code identifying the transaction type.
typeName stringnullablerequired
The display name of the transaction type.
branchCode stringnullablerequired
The unique code identifying the branch.
branchName stringnullablerequired
The display name of the branch.
creditAmount doublenullablerequired
The credit (incoming) amount.
debitAmount doublenullablerequired
The debit (outgoing) amount.
commission doublenullablerequired
The commission fee charged.
currencyCode stringnullablerequired
The ISO currency code (e.g., EUR, USD).
currencyTitle stringnullablerequired
The display title of the currency.
exchangeRate doublenullablerequired
The exchange rate applied.
date date-timenullablerequired
The date and time of the transaction.
valeurDate date-timenullablerequired
The value date when funds become available.
availableDate date-timenullablerequired
The date when funds become available for use.
channelCode stringnullablerequired
The unique code identifying the transaction channel.
reason stringnullablerequired
The stated reason or purpose.
originCountryCode stringnullablerequired
The ISO country code of the origin country.
sendingCountryCode stringnullablerequired
The ISO country code of the sending country.
username stringnullablerequired
The username of the operator who processed the transaction.
isCommited booleannullablerequired
Indicates whether the transaction has been committed (finalized).
isReversed booleannullablerequired
Indicates whether the transaction has been reversed.
amlTransactionId uuidnullablerequired
The unique AML transaction identifier (UUID).
hasCashMoney booleanrequired
Indicates whether the transaction involves physical cash.
beneficiary object
The beneficiary party details for this transaction.
customerCode stringnullablerequired
The unique code identifying the customer.
lastname stringnullablerequired
The customer's primary last name.
lastname2 stringnullablerequired
The customer's secondary or maiden last name.
middlename stringnullablerequired
The customer's middle name.
firstname stringnullablerequired
The customer's first name.
transactionScore doublenullablerequired
The AML transaction score computed for this party.
accountIban stringnullablerequired
The IBAN of the party's account.
accountCurrentBalance doublenullablerequired
The current balance of the party's account.
accountOverdraftAmount doublenullablerequired
The overdraft limit of the party's account.
accountLastTransactionDate date-timenullablerequired
The date of the last transaction on the party's account.
originator object
The originator party details for this transaction.
customerCode stringnullablerequired
The unique code identifying the customer.
lastname stringnullablerequired
The customer's primary last name.
lastname2 stringnullablerequired
The customer's secondary or maiden last name.
middlename stringnullablerequired
The customer's middle name.
firstname stringnullablerequired
The customer's first name.
transactionScore doublenullablerequired
The AML transaction score computed for this party.
accountIban stringnullablerequired
The IBAN of the party's account.
accountCurrentBalance doublenullablerequired
The current balance of the party's account.
accountOverdraftAmount doublenullablerequired
The overdraft limit of the party's account.
accountLastTransactionDate date-timenullablerequired
The date of the last transaction on the party's account.
carrier object
The carrier (physical cash transporter) details for this transaction.
customerCode stringnullablerequired
The unique code identifying the customer.
lastname stringnullablerequired
The customer's primary last name.
lastname2 stringnullablerequired
The customer's secondary or maiden last name.
middlename stringnullablerequired
The customer's middle name.
firstname stringnullablerequired
The customer's first name.
transactionScore doublenullablerequired
The AML transaction score computed for this party.
fatherName stringnullablerequired
The customer's father's name.
motherName stringnullablerequired
The customer's mother's name.
mobilePhone stringnullablerequired
The mobile phone.
idNumber stringnullablerequired
The identity document number.
idTypeCode stringnullablerequired
The code identifying the type of identity document.
taxCode stringnullablerequired
The customer's tax identification number.
home object
The home address details of the carrier.
address stringnullablerequired
The street address.
cityName stringnullablerequired
The name of the city.
provinceName stringnullablerequired
The name of the province or region.
countryCode stringnullablerequired
The unique country code.
phone stringnullablerequired
The telephone number.
]

Example (from schema)

{
  "page": 0,
  "count": 0,
  "hasNextPage": true,
  "hasPreviousPage": true,
  "totalCount": 0,
  "totalPages": 0,
  "items": [
    {
      "code": "string",
      "documentCode": "string",
      "typeCode": "string",
      "typeName": "string",
      "branchCode": "string",
      "branchName": "string",
      "creditAmount": 0,
      "debitAmount": 0,
      "commission": 0,
      "currencyCode": "string",
      "currencyTitle": "string",
      "exchangeRate": 0,
      "date": "2024-07-29T15:51:28.071Z",
      "valeurDate": "2024-07-29T15:51:28.071Z",
      "availableDate": "2024-07-29T15:51:28.071Z",
      "channelCode": "string",
      "reason": "string",
      "originCountryCode": "string",
      "sendingCountryCode": "string",
      "username": "string",
      "isCommited": true,
      "isReversed": true,
      "amlTransactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "hasCashMoney": true,
      "beneficiary": {
        "customerCode": "string",
        "lastname": "string",
        "lastname2": "string",
        "middlename": "string",
        "firstname": "string",
        "transactionScore": 0,
        "accountIban": "string",
        "accountCurrentBalance": 0,
        "accountOverdraftAmount": 0,
        "accountLastTransactionDate": "2024-07-29T15:51:28.071Z"
      },
      "originator": {
        "customerCode": "string",
        "lastname": "string",
        "lastname2": "string",
        "middlename": "string",
        "firstname": "string",
        "transactionScore": 0,
        "accountIban": "string",
        "accountCurrentBalance": 0,
        "accountOverdraftAmount": 0,
        "accountLastTransactionDate": "2024-07-29T15:51:28.071Z"
      },
      "carrier": {
        "customerCode": "string",
        "lastname": "string",
        "lastname2": "string",
        "middlename": "string",
        "firstname": "string",
        "transactionScore": 0,
        "fatherName": "string",
        "motherName": "string",
        "mobilePhone": "string",
        "idNumber": "string",
        "idTypeCode": "string",
        "taxCode": "string",
        "home": {
          "address": "string",
          "cityName": "string",
          "provinceName": "string",
          "countryCode": "string",
          "phone": "string"
        }
      }
    }
  ]
}

400

The request is invalid.

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

404

A customer with the specified code could not be found.

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

500

Internal server error.

application/json

Schema

Schema

message stringnullablerequired

The error or validation message.

metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons object[]nullable
The list of underlying error reasons.
Array [
message stringnullablerequired
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
nullable required
reasons undefined[]nullablerequired
The list of underlying error reasons.
]
code int32required

The unique code identifying this entity.

errors object[]nullable
The list of validation errors.
Array [
field stringnullablerequired
The name of the field that failed validation.
message stringnullablerequired
The error or validation message.
]

Example (from schema)

{
  "message": "string",
  "metadata": {},
  "reasons": [
    {
      "message": "string",
      "metadata": {},
      "reasons": [
        null
      ]
    }
  ],
  "code": 0,
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

Loading...