Updated on May 17, 2023

Authorization

Authorization

Authorization is not an actual charge; it is only a reservation of a certain amount. Authorizations help reduce the risk of fraudulent transactions and credit card misuse.
 

Authorization transaction confirms that the Buyer has provided valid payment information and reserves sufficient funding to perform the transaction. 

Following a successful Authorization transaction, you will receive a confirmation with the transaction identifier number
TransactionID":"1010000000139894". Use this identifier as a parent transaction identifier (OriginalTransactionId) for all subsequent transactions that derive from the current transaction.

Authorizations may also serve to reserve an amount of money on a credit card balance for security and verification purposes until the actual Deposit transaction is executed.

Authorization transaction may be followed by:

Void (Cancel Authorization) transaction. In this type of transaction, the amount reserved by the Authorization transaction is being released back to the credit card balance.

Released funds are previously reserved funds that now have become available.

Partial Void (Partial Cancel Authorization) transaction. This transaction involves the partial release of the amount reserved by the parent Authorization transaction.

Capture transaction. Capture transaction transfers the previously reserved amount from the buyer’s bank account to the acquirer bank account.

Request Parameters

 NameTypeRequiredDescription
 accountIdinteger✓

platform account identifier.

must be greater than 0.
 amountdecimal✓

transaction amount.

value ≥ 0 (2 decimal places)
 billingAddressobjectoptionaluser billing address data object.
 billingOverrideobjectoptionaldata object that contains an array of billingfee objects.
 creditCardobjectconditional

credit card data object.

required if payment method = creditcard;
 achobjectconditional

ach data object.

required if payment method = ach.
 currencyenum✓

currencyTypeId.

Available Values:
 
  • CAD
  • USD
  • EUR
  • GBP
  • AUD
  • SGD
  • JPY
  • NZD
 merchantDataobjectoptionalmerchant data data object.
 entryModeintegeroptional

nullable

transaction entry mode numerical value.
 paymentMethodenum✓

paymentMethodTypeId.

creditcard – 0 credit card payments

ach – 1 ach payments
 processorDataobjectoptionalprocessor data data object.
 subAccountIdinteger✓
sub-account identifier.value ≥ 0
 terminalIdstringoptional

terminal identifier.

maxlength(20)
 transactionMethodenumoptional

transactionmethodid.

Available Values:
 
  • regulartransaction – 0
  • mailortelephoneorder – 1
  • internettransaction – 2
  • 3dsecuretransaction – 3
  • pointofsaletransaction – 4
  • billpaytransaction – 5
  • recurringtransaction – 6
 typeenum✓
transactiontypeid.authorization
 threeDSecureobjectoptional
3D-Secure data object..authorization
				
					Request example
{
  "accountId": "Platform Account Id",
  "amount": 13,
  "billingAddress": {
    "addressLine": "Address",
    "city": "City Name",
    "country": "USA",
    "email": "email@mail.com",
    "phoneNumber": "12346879",
    "state": "FL",
    "zipPostalCode": "123465798"
  },
  "billingOverride": [
    {
      "fixedAmount": "feeFixedAmount",
      "id": "objectId",
      "percentageAmount": "feePercentageAmount",
      "sourceId": "feeSourceIdentifier",
      "sourceType": "BillingAccountId",
      "targetId": "feeTargetIdentifier",
      "targetType": "BillingAccountId",
      "reverse": "true",
      "billingAmount": "billingAmountValue"
    }
  ],
  "creditCard": {
    "bin": "411111",
    "expirationDate": "1220",
    "last4": "1111",
    "nameOnCard": "Eleanor Johansson",
    "type": "Visa"
  },
  "currency": "USD",
  "merchantData": {
    "freeText": "string",
    "transactionDate": "dateTime",
    "transactionDescription": "string",
    "transactionId": "string"
  },
  "entryMode": "2",
  "paymentMethod": "CreditCard",
  "processorData": {
    "authorizationNumber": "01919Z",
    "errorCode": "",
    "errorCodeDescription": "",
    "transactionId": "1234567891"
  },
  "status": "Processed",
  "subAccountId": "Sub-Account Id",
  "terminalId": "string",
  "transactionMethod": "RegularTransaction",
  "type": "Authorization"
}
"threeDSecure": {
    "eci": "7",
    "xid": "857e2347c329eec31c75",
    "cavv": "645sd54ad5a5sd65",
    "token": "8e86aef68037e8849980"
  }