Weavr Transaction Activity API
Retrieve the consolidated transaction activity across instruments.
OpenAPI Specification
openapi: 3.1.0
info:
version: v3
title: Weavr Multi Product BackOffice Access Token Transaction Activity API
x-logo:
url: https://storage.googleapis.com/weavr-cdn/weavr_logo-new.png
backgroundColor: '#FFFFFF'
altText: Weavr
description: 'Weavr Multi Back Office API allows you, as an innovator, to perform various back office operations concerning
identities and their instruments, without requiring the users to be logged in.
A token is to be obtained through the `access_token` method, and this will allow relevant operations
to be performed on behalf of this same identity.
'
contact:
name: Weavr
url: https://weavr.io
servers:
- description: Weavr Sandbox Environment
url: https://sandbox.weavr.io/multi/backoffice
tags:
- name: Transaction Activity
description: Retrieve the consolidated transaction activity across instruments.
paths:
/transactions:
get:
tags:
- Transaction Activity
description: 'Returns all transactional activity across all managed accounts and managed cards.
This provides a single view of all transfers, sends, wire transfers, card payments, fees, and other
transaction types regardless of which wallet they belong to.
`creationTimestamp` is when the transaction was created in its owning service (the same value the
nested `transaction` object reports), and is the field the creation-window filter applies to.
Transactions that are committed but not yet executed (e.g. scheduled wire transfers) appear with
status `SUBMITTED`; such transactions never appear on statements until they execute.
A transfer between two of the caller''s own instruments (e.g. between a managed account and a
managed card belonging to the same identity) returns **two** entries — a `DEBIT` on the source
instrument and a `CREDIT` on the destination instrument — which share the same `id` and differ by
`instrument`. Treat `(id, instrument)` as the key when reconciling, and note that such a transfer
contributes 2 to the `count`. The per-instrument activity endpoints
(`/managed_accounts/{id}/transactions`, `/managed_cards/{id}/transactions`) are scoped to one
instrument and so still show the single relevant side.
'
summary: Get all transaction activity
operationId: transactionsGet
x-permissions:
- i:managed_accounts:statement
- i:managed_cards:statement
parameters:
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/transactionActivityType'
- $ref: '#/components/parameters/transactionActivityStatus'
- $ref: '#/components/parameters/transactionActivityDirection'
- $ref: '#/components/parameters/creationTimestampFrom'
- $ref: '#/components/parameters/creationTimestampTo'
- $ref: '#/components/parameters/lastUpdatedTimestampFrom'
- $ref: '#/components/parameters/lastUpdatedTimestampTo'
- $ref: '#/components/parameters/sortOrder'
- $ref: '#/components/parameters/transactionActivitySortBy'
responses:
'200':
$ref: '#/components/responses/TransactionActivityListResponse'
'400':
$ref: '#/components/responses/BadRequestError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
'503':
$ref: '#/components/responses/ServiceUnavailable'
default:
$ref: '#/components/responses/Error'
security:
- auth_token: []
api-key: []
components:
schemas:
OutgoingWireTransferRejectedInfo:
description: "Additional info when the outgoing wire transfer has been rejected, as follows:\n - SYSTEM: The wire transfer was rejected by the system.\n - USER: The wire transfer was rejected by the user.\n"
type: string
enum:
- SYSTEM
- USER
CardPaymentEventType:
type: string
description: Type of event recorded against a CardPayment. The `reversal` flag on each event distinguishes a reversal from the original action.
enum:
- AUTHORISATION
- SETTLEMENT
- REFUND
- ORIGINAL_CREDIT
FasterPaymentsBankDetailsOrBACSBankDetails:
required:
- accountNumber
- sortCode
type: object
description: Bank details used in case the wire transfer is executed over Faster Payments.
properties:
accountNumber:
type: string
pattern: ^[0-9]{8}$
description: Account number, required for wire transfer over Faster Payments.
sortCode:
type: string
pattern: ^[0-9]{6}$
description: Sort code, required for wire transfer over Faster Payments.
secondaryReference:
type: string
CorrespondentBankingOwtState:
description: "The state of the correspondent bank transfer transaction, as follows:\n - INVALID: The transfer has failed initial validation checks.\n - PENDING_CHALLENGE: The transfer requires the completion of a transaction confirmation challenge before it can be submitted.\n - SUBMITTED: The transfer has been submitted to the sending financial institution for processing.\n - REJECTED: The transfer that was submitted was rejected.\n - APPROVED: The transfer that was submitted has been approved and is being processed by the sending financial institution.\n - FAILED: There was an issue with the transfer, and the transaction has failed.\n - COMPLETED: The requested funds have been sent from the source instrument.\n - RETURNED: The transfer has been returned to the sender.\n - SCHEDULED: The transfer will be executed at the scheduled time.\n - CANCELLED: The scheduled transfer has been cancelled.\n - PENDING_CONFIRMATION: The transfer requires a manual confirmation by the user before proceeding.\n"
type: string
enum:
- INVALID
- PENDING_CHALLENGE
- SUBMITTED
- REJECTED
- APPROVED
- FAILED
- COMPLETED
- RETURNED
- SCHEDULED
- CANCELLED
- PENDING_CONFIRMATION
CorrespondentBankingExternalData:
type: object
description: External data key-value pair.
required:
- name
- value
properties:
name:
type: string
maxLength: 50
description: Name/key of the external data.
value:
type: string
maxLength: 255
description: Value of the external data.
ExternalAccountId:
type: object
description: The id of an external account, such as a Linked Account, registered with the Weavr Platform.
required:
- type
- id
properties:
type:
$ref: '#/components/schemas/ExternalAccountType'
id:
type: string
pattern: ^[0-9]+$
UKConfirmationOfPayeeResult:
type: object
required:
- match
properties:
match:
type: string
description: The result of matching performed by the UK Confirmation of Payee responder
enum:
- EXACT_MATCH
- CLOSE_MATCH
- NO_MATCH
- NOT_POSSIBLE
reasonCode:
type: string
description: "The reason why the matching failed at the UK Confirmation of Payee responder:\n\n - ANNM: The CoP responder confirms that the account `name` provided does not match;\n - MBAM: The CoP responder indicates that the account `name` provided closely matches the actual account in its records, the actual account name is returned in the `accountName` field;\n - BANM: The account `type` that the user specified is 'PERSONAL', but the CoP responder indicates that the actual account matching the `name` provided is actually BUSINESS;\n - PANM: The account `type` that the user specified is 'BUSINESS', but the CoP responder indicates that the actual account matching the `name` provided is actually PERSONAL;\n - BAMM: The account `type` that the user specified is 'PERSONAL', but the CoP responder indicates that an account closely matching the `name` provided is BUSINESS;\n - PAMM: The account `type` that the user specified is 'BUSINESS', but the CoP responder indicates that an account closely matching the `name` provided is PERSONAL;\n - AC01: The account does not exist in the CoP responders books, the `accountNumber` specified is likely incorrect; \n - IVCR: The CoP responder was unable to locate an account based on the `secondaryReference` field;\n - ACNS: The account is not supported for CoP by the CoP responder;\n - OPTO: The owner of the account has opted out of CoP service by the CoP responder;\n - CASS: The account has been switched using the Current Account Switch Service;\n - SCNS: The `sortCode` provided is not supported at endpoint;\n"
enum:
- ANNM
- MBAM
- BANM
- PANM
- BAMM
- PAMM
- AC01
- IVCR
- ACNS
- OPTO
- CASS
- SCNS
accountName:
type: string
description: 'CoP: Returned when the `match` is a `CLOSE_MATCH` and the `reasonCode` is MBAM, BAMM or PAMM
VoP: Returned when the `match` is a `CLOSE_MATCH`
'
CorrespondentBankingIndividualAddressAndBirthInfo:
required:
- dateOfBirth
- placeOfBirth
type: object
description: Birth information for an individual originator.
properties:
dateOfBirth:
type: string
format: date
description: Date of birth in YYYY-MM-DD format.
placeOfBirth:
type: string
maxLength: 140
description: Place of birth - city and country.
Transfer:
required:
- id
- profileId
- creationTimestamp
- destination
- destinationAmount
- source
- state
type: object
properties:
id:
type: string
pattern: ^[0-9]+$
description: The unique identifier of a Transfer transaction.
profileId:
$ref: '#/components/schemas/ProfileId'
tag:
$ref: '#/components/schemas/Tag'
source:
description: The source managed account or card from where the funds were transferred.
$ref: '#/components/schemas/InstrumentId'
destination:
description: The destination managed account or card to where the funds were transferred.
$ref: '#/components/schemas/InstrumentId'
destinationAmount:
description: The amount, in same currency as source and destination, that was transferred from the source to the destination instrument.
$ref: '#/components/schemas/CurrencyAmount'
description:
type: string
maxLength: 255
pattern: ^[a-zA-Z0-9\/\-?:().$_,'+\s#=!"%&*<>;\{@\r\n]*$
description: The description details that are included in the transaction as reference.
state:
$ref: '#/components/schemas/TransactionState'
creationTimestamp:
type: integer
format: int64
description: The time when the transaction was created, expressed in Epoch timestamp using millisecond precision.
scheduledTimestamp:
$ref: '#/components/schemas/ScheduledTimestamp'
executionTimestamp:
$ref: '#/components/schemas/ExecutionTimestamp'
cancellationReason:
$ref: '#/components/schemas/TransactionCancellationReason'
CorrespondentBankingIndividualAddressAndIdInfo:
required:
- documentType
- documentNumber
type: object
description: Personal identification for an individual originator.
properties:
documentType:
type: string
enum:
- NATIONAL_ID
- PASSPORT
- TAX_ID
- OTHER
description: Type of personal identification document.
documentNumber:
type: string
maxLength: 35
description: Personal identification document number.
DateOfBirth:
type: string
format: date
description: The date of birth in ISO 8601 format (YYYY-MM-DD).
SEPAVerificationOfPayeeResult:
type: object
required:
- match
properties:
match:
type: string
description: The result of the SEPA Verification of Payee check performed by the responding PSP.
enum:
- MATCH
- NO_MATCH
- CLOSE_MATCH
- NOT_POSSIBLE
accountName:
type: string
description: 'The name of the account holder as registered with the responding PSP.
Returned when the match result is CLOSE_MATCH to help the payer verify the payee.
'
FeeSummary:
type: object
required:
- id
- type
- amount
properties:
id:
description: Identifier of the fee — same value used as entryId on the corresponding fees-type entry, and as the fee transaction id in the Transaction Activity API.
type: string
pattern: ^[0-9]+$
type:
description: Always `fees`. Aligns with the top-level transaction type.
type: string
enum:
- fees
amount:
description: Fee amount in the instrument's currency.
$ref: '#/components/schemas/CurrencyAmount'
subtype:
description: Categorises the fee — derived from the parent transaction type.
$ref: '#/components/schemas/FeeSubtype'
Merchant:
type: object
description: Information about a merchant — used wherever a merchant appears in card-payment flows, statement entries, and transaction activity.
required:
- id
- name
properties:
id:
type: string
description: Merchant identifier (MID) — the acquirer-assigned code that identifies the merchant on card-scheme messages (ISO 8583 DE 42 Card Acceptor Identification Code).
name:
type: string
description: Merchant name (DBA name).
nameOther:
type: string
description: Alternative merchant name as supplied by the card network, when present.
networkId:
type: string
description: Identifier assigned by the acquirer or scheme to the merchant.
categoryCode:
type: string
description: ISO 18245 merchant category code (MCC).
description:
type: string
description: Free-text description of the merchant.
street:
type: string
description: Street address of the merchant terminal.
city:
type: string
description: City of the merchant terminal.
state:
type: string
description: Subdivision (state, province, region) of the merchant terminal.
postalCode:
type: string
description: Postal code of the merchant terminal.
country:
type: string
description: ISO 3166-1 alpha-2 country code of the merchant terminal.
telephone:
type: string
description: Merchant telephone.
url:
type: string
description: Merchant website.
contact:
type: string
description: Merchant contact (name or email of a representative, when present).
reference:
type: string
description: Merchant-supplied reference for the transaction (the merchant's own identifier for what they billed).
logoUrl:
type: string
description: Merchant logo URL, when available.
IncomingWireTransfer:
type: object
required:
- id
- state
- amount
- destinationInstrument
- createdAt
description: An incoming wire transfer received from an external bank account.
properties:
id:
type: string
pattern: ^[0-9]+$
description: The unique identifier of the incoming wire transfer.
profileId:
$ref: '#/components/schemas/ProfileId'
state:
$ref: '#/components/schemas/IncomingWireTransferMultiState'
amount:
description: The amount credited (or to be credited) to the destination instrument, in the instrument's currency.
$ref: '#/components/schemas/CurrencyAmount'
fee:
description: The fee charged on this incoming wire transfer. Omitted when no fee was charged.
$ref: '#/components/schemas/CurrencyAmount'
destinationInstrument:
description: The managed account (with IBAN) that received the funds.
$ref: '#/components/schemas/InstrumentId'
paymentNetwork:
type: string
enum:
- SEPA
- FASTER_PAYMENTS
- SWIFT
- RIX
- BACS
- CHAPS
- TARGET
description: The payment network over which the transfer was received.
senderName:
type: string
description: The name of the sender.
senderIban:
type: string
description: The IBAN of the sender.
senderReference:
type: string
description: The payment reference provided by the sender.
forex:
$ref: '#/components/schemas/TransactionForex'
isInstant:
type: boolean
description: Whether this was an instant payment.
createdAt:
type: integer
format: int64
description: When the IWT was received, expressed in Epoch timestamp using millisecond precision.
executedAt:
type: integer
format: int64
description: When the IWT was settled, expressed in Epoch timestamp using millisecond precision.
FasterPaymentsBeneficiary:
required:
- name
- type
- accountNumber
- sortCode
type: object
description: Beneficiary details for Faster Payments wire transfers.
properties:
name:
type: string
minLength: 1
maxLength: 140
pattern: ^[a-zA-Z0-9\/\-?:().,'+\s#=!"%&*<>;\{@\r\n]*$
description: 'The beneficiary''s full name. >= 1 character and <= 140 characters.
Note: the '' symbol is the unicode value U+2019 (right single quotation mark)
and not the unicode value U+0027 (apostrophe).
'
type:
type: string
description: The type of beneficiary account. Required for Faster Payments.
enum:
- PERSONAL
- BUSINESS
accountNumber:
type: string
pattern: ^[0-9]{8}$
description: Account number, required for wire transfer over Faster Payments.
sortCode:
type: string
pattern: ^[0-9]{6}$
description: Sort code, required for wire transfer over Faster Payments.
secondaryReference:
type: string
description: Optional secondary reference for accounts without unique sort codes.
address:
maxLength: 150
minLength: 1
type: string
description: The beneficiary's address.
bankName:
type: string
description: The beneficiary's bank name.
bankAddress:
maxLength: 150
minLength: 1
type: string
description: The beneficiary's bank address.
bankCountry:
type: string
description: The beneficiary's bank country in ISO 3166 alpha-2 format.
maxLength: 2
minLength: 2
pattern: ^[A-Z]{2}$
nationality:
$ref: '#/components/schemas/Nationality'
dateOfBirth:
$ref: '#/components/schemas/DateOfBirth'
OutgoingWireTransferType:
type: string
description: The wire transfer rails used, from SEPA, Faster Payments, SWIFT or RIX.
enum:
- SEPA
- FASTER_PAYMENTS
- SWIFT
- RIX
Tag:
type: string
description: The tag field is a custom field that can be used to search and filter.
maxLength: 50
pattern: ^[a-zA-Z0-9_-]+$
CurrencyAmount:
required:
- currency
- amount
type: object
properties:
currency:
$ref: '#/components/schemas/Currency'
amount:
type: integer
format: int64
description: 'The monetary amount, scaled to the lowest denomination of the currency.
Example, an amount of 1000 for a EUR currency is actually 1000 Euro cents or EUR 10.00.
'
description: The object representing a monetary amount in a particular currency.
FeeSubtype:
type: string
description: The category of fee — indicates the activity or instrument-lifecycle event the fee relates to.
enum:
- fee_reversals
- incoming_wire_fees
- withdrawal_fees
- purchase_fees
- refund_fees
- atm_withdrawal_fees
- chargeback_fees
- transfer_fees
- send_fees
- outgoing_wire_transfer_fees
- custom_fees
- other_fees
- instrument_delete_fees
- funds_redemption_fees
- system_transaction_fees
ScaledAmount:
type: object
properties:
value:
type: integer
format: int64
scale:
maximum: 127
minimum: -128
type: integer
format: int32
description: 'A floating point number, represented as a value and its scale. Its actual value can be obtained using the equation: value * pow(10, -scale).'
Send:
required:
- id
- profileId
- creationTimestamp
- source
- destinationAmount
- state
- transactionAmount
type: object
properties:
id:
type: string
pattern: ^[0-9]+$
description: The unique identifier of a send transaction.
profileId:
$ref: '#/components/schemas/ProfileId'
tag:
$ref: '#/components/schemas/Tag'
source:
description: The source managed account or card from where the funds were sent.
$ref: '#/components/schemas/InstrumentId'
sourceFee:
allOf:
- $ref: '#/components/schemas/CurrencyAmount'
- type: object
description: The fee applied to the source.
destination:
description: The destination managed account or card to where the funds were sent.
oneOf:
- $ref: '#/components/schemas/InstrumentId'
- $ref: '#/components/schemas/BeneficiaryId'
destinationAmount:
description: The amount, in same currency as source and destination, that was sent from the source to the destination instrument.
$ref: '#/components/schemas/CurrencyAmount'
destinationFee:
allOf:
- $ref: '#/components/schemas/CurrencyAmount'
- type: object
description: The fee applied to the destination.
transactionAmount:
allOf:
- $ref: '#/components/schemas/CurrencyAmount'
- type: object
description: The original transaction amount before any fees were deducted.
description:
type: string
description: The description details that are passed to the beneficiary.
maxLength: 255
pattern: ^[a-zA-Z0-9\/\-?:().$_,'+\s#=!"%&*<>;\{@\r\n]*$
state:
$ref: '#/components/schemas/SendState'
challengeExemptionReason:
$ref: '#/components/schemas/ChallengeExemptionReason'
creationTimestamp:
type: integer
format: int64
description: The time when the transaction was created, expressed in Epoch timestamp using millisecond precision.
scheduledTimestamp:
$ref: '#/components/schemas/ScheduledTimestamp'
executionTimestamp:
$ref: '#/components/schemas/ExecutionTimestamp'
cancellationReason:
$ref: '#/components/schemas/TransactionCancellationReason'
TransactionActivityList:
type: object
description: A paginated list of transaction activity entries.
properties:
transactions:
type: array
items:
$ref: '#/components/schemas/TransactionActivityItem'
count:
type: integer
format: int64
description: The total number of records matching the filter criteria.
responseCount:
type: integer
format: int64
BeneficiaryId:
required:
- beneficiaryId
type: object
properties:
beneficiaryId:
$ref: '#/components/schemas/Id'
ChallengeExemptionReason:
type: string
enum:
- LOW_VALUE
- TRUSTED_BENEFICIARY
description: The Reason the transaction was exempted from SCA verification
CardPaymentEvent:
type: object
description: "An event in a card payment's lifecycle, lean — used **nested** inside `CardPayment.events[]`. The parent card payment provides `cardPaymentId`, `card`, and `merchant`, so the lean variants don't repeat them. Each event carries its own `authCode`. Four variants discriminated by `type`:\n\n - `AUTHORISATION` → `CardPaymentAuthorisationEvent`\n - `SETTLEMENT` → `CardPaymentSettlementEvent`\n - `REFUND` → `CardPaymentRefundEvent`\n - `ORIGINAL_CREDIT` → `CardPaymentOriginalCreditEvent` (Visa OCT / Mastercard MoneySend)\n\nFor the **standalone** version returned by `GET /card_payment_events` — which carries `cardPaymentId`, `card`, and `merchant` so each row is self-contained — see `CardPaymentEventDetail`.\n"
required:
- type
properties:
type:
$ref: '#/components/schemas/CardPaymentEventType'
discriminator:
propertyName: type
mapping:
AUTHORISATION: '#/components/schemas/CardPaymentAuthorisationEvent'
SETTLEMENT: '#/components/schemas/CardPaymentSettlementEvent'
REFUND: '#/components/schemas/CardPaymentRefundEvent'
ORIGINAL_CREDIT: '#/components/schemas/CardPaymentOriginalCreditEvent'
InstrumentId:
required:
- id
- type
type: object
properties:
id:
$ref: '#/components/schemas/Id'
type:
$ref: '#/components/schemas/InstrumentType'
RIXBeneficiary:
required:
- name
- iban
type: object
description: Beneficiary details for RIX wire transfers.
properties:
name:
type: string
minLength: 1
maxLength: 150
description: 'The beneficiary''s full name. >= 1 character and <= 150 characters.
An extended character set is accepted to cater for all European languages.
If RIX does not support a particular character, it is automatically
converted to an acceptable alternative.
'
iban:
type: string
minLength: 15
maxLength: 34
pattern: ^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$
description: International Bank Account Number, required for wire transfer over RIX.
bankIdentifierCode:
type: string
minLength: 8
maxLength: 11
pattern: ^[a-zA-Z0-9]{4}[a-zA-Z]{2}[a-zA-Z0-9]{2}[a-zA-Z0-9]{0,3}$
description: BIC (Bank Identifier Code) for wire transfer over RIX.
address:
maxLength: 150
minLength: 1
type: string
description: 'The beneficiary''s address. An extended character set is accepted to cater
for all European languages. If RIX does not support a particular character,
it is automatically converted to an acceptable alternative.
'
bankName:
type: string
description: The beneficiary's bank name.
bankAddress:
maxLength: 150
minLength: 1
type: string
description: The beneficiary's bank address.
bankCountry:
type: string
description: The beneficiary's bank country in ISO 3166 alpha-2 format.
maxLength: 2
minLength: 2
pattern: ^[A-Z]{2}$
nationality:
$ref: '#/components/schemas/Nationality'
dateOfBirth:
$ref: '#/components/schemas/DateOfBirth'
Currency:
type: string
description: 'The currency expressed in ISO-4217 code. Example: GBP, EUR, USD.'
maxLength: 3
minLength: 3
pattern: ^[A-Z]*$
CorrespondentBankingIndividualOriginator:
required:
- name
- address
- country
- bankAccountDetails
type: object
description: 'An individual (natural person) originator of the transfer.
Travel Rule Requirements:
- Mandatory: Full name and account number (via bankAccountDetails)
- Mandatory: At least one supplementary information type (address + birth details, or address + official ID)
'
properties:
tag:
$ref: '#/components/schemas/Tag'
name:
type: string
maxLength: 140
description: Full name of the individual as documented on official ID.
address:
type: string
maxLength: 255
description: Full residential address of the individual.
country:
type: string
minLength: 2
maxLength: 2
pattern: ^[A-Z]{2}$
description: ISO 3166-1 alpha-2 country code.
bankAccountDetails:
$ref: '#/components/schemas/CorrespondentBankingBankAccountDetails'
description: Account and financial institution details of the originator (travel rule mandatory).
supplementaryInformation:
oneOf:
- $ref: '#/components/schemas/CorrespondentBankingIndividualAddressAndIdInfo'
- $ref: '#/components/schemas/CorrespondentBankingIndividualAddressAndBirthInfo'
SendState:
type: string
description: "The state of the send transaction, as follows:\n - INVALID: The send transaction has failed initial validation checks. \n - INITIALISED: The initial state of a send transaction when SCA is not required.\n - PENDING_CHALLENGE: The send transaction requires the completion of a transaction confirmation challenge before it can be submitted.\n - PENDING: The send transaction has exceeded the destination limit and is pending treasury approval.\n - APPROVED: The send transaction that was submitted has been approved.\n - COMPLETED: The requested funds have been sent from the source instrument.\n - REJECTED: The send transaction that was submitted was rejected.\n - FAILED: There was an issue with the send transaction, and the transaction has failed.\n - RETURNED: The send transaction has been returned to the sender.\n - SCHEDULED: The send transaction will be executed at the scheduled time.\n - CANCELLED: The scheduled send transaction has been cancelled.\n"
enum:
- INVALID
- INITIALISED
- COMPLETED
- REJECTED
- FAILED
- PENDING
- PENDING_CHALLENGE
- APPROVED
- RETURNED
- SCHEDULED
- CANCELLED
ExecutionTimestamp:
pattern: ^[0-9]+$
type: string
description: The epoch timestamp at which the transaction was executed, transitioning to a final state such as COMPLETED, REJECTED, or FAILED.
CardPaymentStatus:
type: string
description: 'Lifecycle status of a CardPayment.
- `SETTLEMENT_IN_PROGRESS` — authorised, not yet (or not fully) settled. The hold is still on the card.
- `SETTLED` — fully settled. The customer has been charged.
- `DECLINED` — the latest authorisation was declined; no money moved.
- `CANCELLED` — the authorisation was cancelled/reversed before settlement; no charge applied.
- `EXPIRED` — the authorisation timed out without settling.
'
enum:
- SETTLEMENT_IN_PROGRESS
- SETTLED
- DECLINED
- CANCELLED
- EXPIRED
TransactionActivityDirection:
type: string
description: Whether funds were credited to or debited from the instrument.
enum:
- CREDIT
- DEBI
# --- truncated at 32 KB (81 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/weavr/refs/heads/main/openapi/weavr-transaction-activity-api-openapi.yml