Skip to main content

Authorizationhold

The authorization hold corresponding to a card token

accountKeystring

The key of the account linked with the authorization hold.

advicebooleanrequired

Whether the given request should be accepted without balance validations.

amountnumberrequired

The amount of money to be held as a result of the authorization hold request.

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.

creationDatestring<date-time>

The organization time when the authorization hold was created

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

Indicates whether the authorization hold amount is credited or debited

Possible values: [DBIT, CRDT]

currencyCodestring

The ISO currency code in which the hold was created. The amounts are stored in the base currency, but the user could have enter it in a foreign currency.

customExpirationPeriodinteger<int32>

The custom expiration period for the hold which overwrites mcc and default expiration periods

exchangeRatenumber

The exchange rate for the original currency.

externalReferenceIdstringrequired

The external reference ID to be used to reference the account hold in subsequent requests.

originalAmountnumber

The original amount of money to be held as a result of the authorization hold request.

originalCurrencystring

The original currency in which the hold was created.

partialboolean

Indicates whether the authorization is partial or not

referenceDateForExpirationstring<date-time>

The date to consider as start date when calculating the number of days passed until expiration

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

Indicates the source of the authorization hold

Possible values: [CARD, ACCOUNT]

statusstring

The enumeration containing the statuses of an authorization hold.

Possible values: [PENDING, REVERSED, SETTLED, EXPIRED]

userTransactionTimestring

The formatted time at which the user made this authorization hold.

Authorizationhold
{
  "accountKey": "string",
  "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",
  "creationDate": "2016-09-06T13:37:50+03:00",
  "creditDebitIndicator": "DBIT",
  "currencyCode": "string",
  "customExpirationPeriod": 0,
  "exchangeRate": 0,
  "externalReferenceId": "string",
  "originalAmount": 0,
  "originalCurrency": "string",
  "partial": true,
  "referenceDateForExpiration": "2016-09-06T13:37:50+03:00",
  "source": "CARD",
  "status": "PENDING",
  "userTransactionTime": "string"
}