Skip to main content

Bulkcardauthorizationholdsinput

Represents the request payload for creating a bulk card authorization holds.

accountKeystring

The key of the account linked with the authorization hold.

advicebooleanrequired

Whether the given request should be accepted without balance validations.

cardTokenstring

The reference token of the card.

creditDebitIndicatorstring

Indicates whether the authorization hold amount is credited or debited

Possible values: [DBIT, CRDT]

holds object[]

The list of authorization holds

  • Array [
  • amountnumberrequired

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

    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.

    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.

    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
    userTransactionTimestring

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

  • ]
  • partialboolean

    Indicates whether the authorization is partial or not

    sourcestring

    Indicates the source of the authorization hold

    Possible values: [CARD, ACCOUNT]

    Bulkcardauthorizationholdsinput
    {
    "accountKey": "string",
    "advice": true,
    "cardToken": "string",
    "creditDebitIndicator": "DBIT",
    "holds": [
    {
    "amount": 0,
    "cardAcceptor": {
    "city": "string",
    "country": "string",
    "mcc": 0,
    "name": "string",
    "state": "string",
    "street": "string",
    "zip": "string"
    },
    "customExpirationPeriod": 0,
    "exchangeRate": 0,
    "externalReferenceId": "string",
    "originalAmount": 0,
    "originalCurrency": "string",
    "referenceDateForExpiration": "2016-09-06T13:37:50+03:00",
    "userTransactionTime": "string"
    }
    ],
    "partial": true,
    "source": "CARD"
    }