Skip to main content

Cardtransactionoutput

A card transaction output after a financial transaction was performed.

advicebooleanrequired

Whether the given request should be accepted without balance validations.

amountnumberrequired

The amount of money to be withdrawn in the financial transaction.

balances object

Account balances presented to inquirer such as card processor

accountIdstring

The unique account identifier

availableBalancenumber

The available balance of a deposit or credit account

cardTypestring

The card type either DEBIT or CREDIT

Possible values: [DEBIT, CREDIT]

creditLimitnumber

The overdraft limit of a deposit account or the loan amount in case of a credit account

currencyCodestring

Currency code used for the account

totalBalancenumber

The current balance of a deposit account or principal balance of a revolving credit

cardAcceptor object

The details of the card acceptor (merchant) in a transaction hold.

citystring

The city in which the card acceptor has the business.

countrystring

The country in which the card acceptor has the business.

mccinteger<int32>

The Merchant Category Code of the card acceptor.

namestring

The name of the card acceptor.

statestring

The state in which the card acceptor has the business.

streetstring

The street in which the card acceptor has the business.

zipstring

The ZIP code of the location in which the card acceptor has the business.

cardTokenstring

The reference token of the card.

creditDebitIndicatorstring

Indicates whether the authorization hold amount is credited or debited

Possible values: [DBIT, CRDT]

currencyCodestring

The ISO currency code in which the card reversal transaction is posted. The amounts are stored in the base currency, but the transaction can be created with a foreign currency.

encodedKeystring

The encoded key of the entity, generated, globally unique

externalAuthorizationReferenceIdstring

The external authorization hold reference ID, which relates this card transaction to a previous authorization hold.

externalReferenceIdstringrequired

The external reference ID to be used to reference the card transaction in subsequent requests.

firstRepaymentDatestring<date-time>

The date of the first repayment for the loan account (as Organization Time)

Example: 2016-09-06T13:37:50+03:00
increaseAmountIfNeededboolean

Increase available amount if needed

linkedTransaction object

The details of the linked financial transaction triggered by the card transaction.

linkedTransactionKeystring

The encodedKey of the linked financial transaction.

linkedTransactionTypestring

Represents the type of the account.

Possible values: [LOAN, DEPOSIT]

partialboolean

Whether the given request should be a partial clearing or not.

transactionChannelIdstringrequired

The ID of the channel through which the payment is done.

userTransactionTimestring

The formatted time at which the user made this card transaction.

Cardtransactionoutput
{
  "advice": true,
  "amount": 0,
  "balances": {
    "accountId": "string",
    "availableBalance": 0,
    "cardType": "DEBIT",
    "creditLimit": 0,
    "currencyCode": "string",
    "totalBalance": 0
  },
  "cardAcceptor": {
    "city": "string",
    "country": "string",
    "mcc": 0,
    "name": "string",
    "state": "string",
    "street": "string",
    "zip": "string"
  },
  "cardToken": "string",
  "creditDebitIndicator": "DBIT",
  "currencyCode": "string",
  "encodedKey": "string",
  "externalAuthorizationReferenceId": "string",
  "externalReferenceId": "string",
  "firstRepaymentDate": "2016-09-06T13:37:50+03:00",
  "increaseAmountIfNeeded": true,
  "linkedTransaction": {
    "linkedTransactionKey": "string",
    "linkedTransactionType": "LOAN"
  },
  "partial": true,
  "transactionChannelId": "string",
  "userTransactionTime": "string"
}