openapi: 3.1.0
info:
version: '6'
x-publicVersion: true
title: Adyen Account acceptDispute accountHolderTransactionList API
description: "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Account API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder\n```"
x-timestamp: '2023-05-30T15:27:20Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
url: https://github.com/Adyen/adyen-openapi
servers:
- url: https://cal-test.adyen.com/cal/services/Account/v6
tags:
- name: accountHolderTransactionList
paths:
/accountHolderTransactionList:
post:
tags:
- accountHolderTransactionList
summary: Adyen Get a List of Transactions
description: Returns a list of transactions for an account holder's accounts. You can specify the accounts and transaction statuses to be included on the list. The call returns a maximum of 50 transactions for each account. To retrieve all transactions, you must make another call with the 'page' value incremented. Transactions are listed in chronological order, with the most recent transaction first.
operationId: post-accountHolderTransactionList
x-groupName: General
x-sortIndex: 2
x-methodName: accountHolderTransactionList
security:
- BasicAuth: []
- ApiKeyAuth: []
requestBody:
content:
application/json:
examples:
basic:
$ref: '#/components/examples/post-accountHolderTransactionList-basic'
specific:
$ref: '#/components/examples/post-accountHolderTransactionList-specific'
schema:
$ref: '#/components/schemas/AccountHolderTransactionListRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AccountHolderTransactionListResponse'
examples:
post-accountHolderTransactionList200Example:
summary: Default post-accountHolderTransactionList 200 response
x-microcks-default: true
value:
accountTransactionLists:
- example_value
invalidFields:
- example_value
pspReference: REF-001
resultCode: CODE123
description: OK - the request has succeeded.
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/AccountHolderTransactionListResponse'
examples:
post-accountHolderTransactionList202Example:
summary: Default post-accountHolderTransactionList 202 response
x-microcks-default: true
value:
accountTransactionLists:
- example_value
invalidFields:
- example_value
pspReference: REF-001
resultCode: CODE123
description: Accepted - the request has been accepted for processing, but the processing has not been completed.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-accountHolderTransactionList400Example:
summary: Default post-accountHolderTransactionList 400 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Bad Request - a problem reading or understanding the request.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-accountHolderTransactionList401Example:
summary: Default post-accountHolderTransactionList 401 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Unauthorized - authentication required.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-accountHolderTransactionList403Example:
summary: Default post-accountHolderTransactionList 403 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Forbidden - insufficient permissions to process the request.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-accountHolderTransactionList422Example:
summary: Default post-accountHolderTransactionList 422 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Unprocessable Entity - a request validation error.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceError'
examples:
post-accountHolderTransactionList500Example:
summary: Default post-accountHolderTransactionList 500 response
x-microcks-default: true
value:
errorCode: CODE123
errorType: standard
message: example_value
pspReference: REF-001
status: 500
description: Internal Server Error - the server could not process the request.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
ErrorFieldType:
properties:
errorCode:
description: The validation error code.
format: int32
type: integer
errorDescription:
description: A description of the validation error.
type: string
fieldType:
description: The type of error field.
$ref: '#/components/schemas/FieldType'
type: object
AccountTransactionList:
properties:
accountCode:
description: The code of the account.
type: string
hasNextPage:
description: Indicates whether there is a next page of transactions available.
type: boolean
transactions:
description: The list of transactions.
items:
$ref: '#/components/schemas/Transaction'
type: array
type: object
Transaction:
properties:
amount:
description: The amount of the transaction.
$ref: '#/components/schemas/Amount'
bankAccountDetail:
description: The details of the bank account to where a payout was made.
$ref: '#/components/schemas/BankAccountDetail'
captureMerchantReference:
description: The merchant reference of a related capture.
type: string
capturePspReference:
description: The psp reference of a related capture.
type: string
creationDate:
description: The date on which the transaction was performed.
format: date-time
type: string
description:
description: A description of the transaction.
type: string
destinationAccountCode:
description: The code of the account to which funds were credited during an outgoing fund transfer.
type: string
disputePspReference:
description: The psp reference of the related dispute.
type: string
disputeReasonCode:
description: The reason code of a dispute.
type: string
merchantReference:
description: The merchant reference of a transaction.
type: string
paymentPspReference:
x-addedInVersion: '3'
description: The psp reference of the related authorisation or transfer.
type: string
payoutPspReference:
x-addedInVersion: '3'
description: The psp reference of the related payout.
type: string
pspReference:
description: The psp reference of a transaction.
type: string
sourceAccountCode:
description: The code of the account from which funds were debited during an incoming fund transfer.
type: string
transactionStatus:
description: 'The status of the transaction.
>Permitted values: `PendingCredit`, `CreditFailed`, `CreditClosed`, `CreditSuspended`, `Credited`, `Converted`, `PendingDebit`, `DebitFailed`, `Debited`, `DebitReversedReceived`, `DebitedReversed`, `ChargebackReceived`, `Chargeback`, `ChargebackReversedReceived`, `ChargebackReversed`, `Payout`, `PayoutReversed`, `FundTransfer`, `PendingFundTransfer`, `ManualCorrected`.'
enum:
- BalanceNotPaidOutTransfer
- BalancePlatformSweep
- BalancePlatformSweepReturned
- Chargeback
- ChargebackCorrection
- ChargebackCorrectionReceived
- ChargebackReceived
- ChargebackReversed
- ChargebackReversedCorrection
- ChargebackReversedCorrectionReceived
- ChargebackReversedReceived
- Converted
- CreditClosed
- CreditFailed
- CreditReversed
- CreditReversedReceived
- CreditSuspended
- Credited
- DebitFailed
- DebitReversedReceived
- Debited
- DebitedReversed
- DepositCorrectionCredited
- DepositCorrectionDebited
- Fee
- FundTransfer
- FundTransferReversed
- InvoiceDeductionCredited
- InvoiceDeductionDebited
- ManualCorrected
- ManualCorrectionCredited
- ManualCorrectionDebited
- MerchantPayin
- MerchantPayinReversed
- Payout
- PayoutReversed
- PendingCredit
- PendingDebit
- PendingFundTransfer
- ReCredited
- ReCreditedReceived
- SecondChargeback
- SecondChargebackCorrection
- SecondChargebackCorrectionReceived
- SecondChargebackReceived
type: string
transferCode:
description: The transfer code of the transaction.
type: string
type: object
FieldType:
properties:
field:
description: The full name of the property.
type: string
fieldName:
description: The type of the field.
enum:
- accountCode
- accountHolderCode
- accountHolderDetails
- accountNumber
- accountStateType
- accountStatus
- accountType
- address
- balanceAccount
- balanceAccountActive
- balanceAccountCode
- balanceAccountId
- bankAccount
- bankAccountCode
- bankAccountName
- bankAccountUUID
- bankBicSwift
- bankCity
- bankCode
- bankName
- bankStatement
- branchCode
- businessContact
- cardToken
- checkCode
- city
- companyRegistration
- constitutionalDocument
- controller
- country
- countryCode
- currency
- currencyCode
- dateOfBirth
- description
- destinationAccountCode
- document
- documentContent
- documentExpirationDate
- documentIssuerCountry
- documentIssuerState
- documentName
- documentNumber
- documentType
- doingBusinessAs
- drivingLicence
- drivingLicenceBack
- drivingLicenceFront
- drivingLicense
- email
- firstName
- formType
- fullPhoneNumber
- gender
- hopWebserviceUser
- houseNumberOrName
- iban
- idCard
- idCardBack
- idCardFront
- idNumber
- identityDocument
- individualDetails
- infix
- jobTitle
- lastName
- lastReviewDate
- legalArrangement
- legalArrangementCode
- legalArrangementEntity
- legalArrangementEntityCode
- legalArrangementLegalForm
- legalArrangementMember
- legalArrangementMembers
- legalArrangementName
- legalArrangementReference
- legalArrangementRegistrationNumber
- legalArrangementTaxNumber
- legalArrangementType
- legalBusinessName
- legalEntity
- legalEntityType
- logo
- merchantAccount
- merchantCategoryCode
- merchantHouseNumber
- merchantReference
- microDeposit
- name
- nationality
- originalReference
- ownerCity
- ownerCountryCode
- ownerDateOfBirth
- ownerHouseNumberOrName
- ownerName
- ownerPostalCode
- ownerState
- ownerStreet
- passport
- passportNumber
- payoutMethod
- payoutMethodCode
- payoutSchedule
- pciSelfAssessment
- personalData
- phoneCountryCode
- phoneNumber
- postalCode
- primaryCurrency
- reason
- registrationNumber
- returnUrl
- schedule
- shareholder
- shareholderCode
- shareholderCodeAndSignatoryCode
- shareholderCodeOrSignatoryCode
- shareholderType
- shareholderTypes
- shopperInteraction
- signatory
- signatoryCode
- socialSecurityNumber
- sourceAccountCode
- splitAccount
- splitConfigurationUUID
- splitCurrency
- splitValue
- splits
- stateOrProvince
- status
- stockExchange
- stockNumber
- stockTicker
- store
- storeDetail
- storeName
- storeReference
- street
- taxId
- tier
- tierNumber
- transferCode
- ultimateParentCompany
- ultimateParentCompanyAddressDetails
- ultimateParentCompanyAddressDetailsCountry
- ultimateParentCompanyBusinessDetails
- ultimateParentCompanyBusinessDetailsLegalBusinessName
- ultimateParentCompanyBusinessDetailsRegistrationNumber
- ultimateParentCompanyCode
- ultimateParentCompanyStockExchange
- ultimateParentCompanyStockNumber
- ultimateParentCompanyStockNumberOrStockTicker
- ultimateParentCompanyStockTicker
- unknown
- value
- verificationType
- virtualAccount
- visaNumber
- webAddress
- year
type: string
shareholderCode:
description: The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder.
type: string
type: object
TransactionListForAccount:
properties:
accountCode:
description: The account for which to retrieve the transactions.
type: string
page:
description: 'The page of transactions to retrieve.
Each page lists fifty (50) transactions. The most recent transactions are included on page 1.'
format: int32
type: integer
required:
- accountCode
- page
type: object
AccountHolderTransactionListRequest:
properties:
accountHolderCode:
description: The code of the account holder that owns the account(s) of which retrieve the transaction list.
type: string
transactionListsPerAccount:
description: A list of accounts to include in the transaction list. If left blank, the last fifty (50) transactions for all accounts of the account holder will be included.
items:
$ref: '#/components/schemas/TransactionListForAccount'
type: array
transactionStatuses:
description: 'A list of statuses to include in the transaction list. If left blank, all transactions will be included.
>Permitted values:
>* `PendingCredit` - a pending balance credit.
>* `CreditFailed` - a pending credit failure; the balance will not be credited.
>* `Credited` - a credited balance.
>* `PendingDebit` - a pending balance debit (e.g., a refund).
>* `CreditClosed` - a pending credit closed; the balance will not be credited.
>* `CreditSuspended` - a pending credit closed; the balance will not be credited.
>* `DebitFailed` - a pending debit failure; the balance will not be debited.
>* `Debited` - a debited balance (e.g., a refund).
>* `DebitReversedReceived` - a pending refund reversal.
>* `DebitedReversed` - a reversed refund.
>* `ChargebackReceived` - a received chargeback request.
>* `Chargeback` - a processed chargeback.
>* `ChargebackReversedReceived` - a pending chargeback reversal.
>* `ChargebackReversed` - a reversed chargeback.
>* `Converted` - converted.
>* `ManualCorrected` - manual booking/adjustment by Adyen.
>* `Payout` - a payout.
>* `PayoutReversed` - a reversed payout.
>* `PendingFundTransfer` - a pending transfer of funds from one account to another.
>* `FundTransfer` - a transfer of funds from one account to another.'
items:
enum:
- BalanceNotPaidOutTransfer
- BalancePlatformSweep
- BalancePlatformSweepReturned
- Chargeback
- ChargebackCorrection
- ChargebackCorrectionReceived
- ChargebackReceived
- ChargebackReversed
- ChargebackReversedCorrection
- ChargebackReversedCorrectionReceived
- ChargebackReversedReceived
- Converted
- CreditClosed
- CreditFailed
- CreditReversed
- CreditReversedReceived
- CreditSuspended
- Credited
- DebitFailed
- DebitReversedReceived
- Debited
- DebitedReversed
- DepositCorrectionCredited
- DepositCorrectionDebited
- Fee
- FundTransfer
- FundTransferReversed
- InvoiceDeductionCredited
- InvoiceDeductionDebited
- ManualCorrected
- ManualCorrectionCredited
- ManualCorrectionDebited
- MerchantPayin
- MerchantPayinReversed
- Payout
- PayoutReversed
- PendingCredit
- PendingDebit
- PendingFundTransfer
- ReCredited
- ReCreditedReceived
- SecondChargeback
- SecondChargebackCorrection
- SecondChargebackCorrectionReceived
- SecondChargebackReceived
type: string
type: array
required:
- accountHolderCode
type: object
Amount:
properties:
currency:
description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
maxLength: 3
minLength: 3
type: string
value:
description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
format: int64
type: integer
required:
- value
- currency
type: object
ServiceError:
properties:
errorCode:
description: The error code mapped to the error message.
type: string
errorType:
description: The category of the error.
type: string
message:
description: A short explanation of the issue.
type: string
pspReference:
description: The PSP reference of the payment.
type: string
status:
description: The HTTP response status.
format: int32
type: integer
type: object
BankAccountDetail:
properties:
accountNumber:
description: 'The bank account number (without separators).
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
type: string
accountType:
description: 'The type of bank account.
Only applicable to bank accounts held in the USA.
The permitted values are: `checking`, `savings`.
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
type: string
bankAccountName:
description: The name of the bank account.
type: string
bankAccountReference:
x-addedInVersion: '5'
description: Merchant reference to the bank account.
type: string
bankAccountUUID:
description: 'The unique identifier (UUID) of the Bank Account.
>If, during an account holder create or update request, this field is left blank (but other fields provided), a new Bank Account will be created with a procedurally-generated UUID.
>If, during an account holder create request, a UUID is provided, the creation of the Bank Account will fail while the creation of the account holder will continue.
>If, during an account holder update request, a UUID that is not correlated with an existing Bank Account is provided, the update of the account holder will fail.
>If, during an account holder update request, a UUID that is correlated with an existing Bank Account is provided, the existing Bank Account will be updated.
'
type: string
bankBicSwift:
description: 'The bank identifier code.
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
type: string
bankCity:
description: 'The city in which the bank branch is located.
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
type: string
bankCode:
description: 'The bank code of the banking institution with which the bank account is registered.
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
type: string
bankName:
description: 'The name of the banking institution with which the bank account is held.
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
type: string
branchCode:
description: 'The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account:
* United States - Routing number
* United Kingdom - Sort code
* Germany - Bankleitzahl
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
type: string
checkCode:
description: 'The check code of the bank account.
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
type: string
countryCode:
description: 'The two-letter country code in which the bank account is registered.
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
type: string
currencyCode:
description: 'The currency in which the bank account deals.
>The permitted currency codes are defined in ISO-4217 (e.g. ''EUR'').
'
type: string
iban:
description: 'The international bank account number.
>The IBAN standard is defined in ISO-13616.
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
type: string
ownerCity:
description: 'The city of residence of the bank account owner.
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
type: string
ownerCountryCode:
description: 'The country code of the country of residence of the bank account owner.
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
type: string
ownerDateOfBirth:
deprecated: true
description: 'The date of birth of the bank account owner.
The date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31).'
type: string
ownerHouseNumberOrName:
description: 'The house name or number of the residence of the bank account owner.
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
type: string
ownerName:
description: 'The name of the bank account owner.
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
type: string
ownerNationality:
description: 'The country code of the country of nationality of the bank account owner.
>The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
type: string
ownerPostalCode:
description: 'The postal code of the residence of the bank account owner.
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
type: string
ownerState:
description: 'The state of residence of the bank account owner.
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
type: string
ownerStreet:
description: 'The street name of the residence of the bank account owner.
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
type: string
primaryAccount:
description: If set to true, the bank account is a primary account.
type: boolean
taxId:
description: 'The tax ID number.
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
type: string
urlForVerification:
description: 'The URL to be used for bank account verification.
This may be generated on bank account creation.
>Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
type: string
type: object
AccountHolderTransactionListResponse:
properties:
accountTransactionLists:
description: A list of the transactions.
items:
$ref: '#/components/schemas/AccountTransactionList'
type: array
invalidFields:
x-addedInVersion: '5'
description: Contains field validation errors that would prevent requests from being processed.
items:
$ref: '#/components/schemas/ErrorFieldType'
type: array
pspReference:
description: The reference of a request. Can be used to uniquely identify the request.
type: string
resultCode:
description: The result code.
type: string
type: object
examples:
post-accountHolderTransactionList-basic:
summary: Retrieve transactions page by page
value:
accountHolderCode: CODE_OF_ACCOUNT_HOLDER
transactionListsPerAccount:
- accountCode: '195752115'
page: 1
pos
# --- truncated at 32 KB (32 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/openapi/adyen-accountholdertransactionlist-api-openapi.yml