Adjustment
Use Adjustment transaction to send billingOverride with fees values you wish to override (change) without relation to any particular transaction type. In such cases, a fee execution is triggered by the Adjustment transaction.
Example
Service Provider charges merchants 10 $ fee for each Technical Support request. To apply such fees, Service Provider may send an Adjustment transaction for each Support request with the transaction amount = 0 and fee amount = 10 $.
Request Parameters
| Name | Type | Required | Description | |||||||||||||||||||||
| accountId | integer | ✓ | Platform Account identifier. Must be greater than 0. | |||||||||||||||||||||
| amount | decimal | ✓ | Transaction amount. Amount >=0 is acceptable for Adjustment transaction type | |||||||||||||||||||||
| billingAddress | object | optional | User Billing address data object. | |||||||||||||||||||||
| billingOverride | object | ✓ | Data object that contains an array of billingFee objects. | |||||||||||||||||||||
| currency | enum | ✓ | currencyTypeId. Available Values:
| |||||||||||||||||||||
| merchantData | object | optional | Merchant Data data object. | |||||||||||||||||||||
| entryMode | integer | optional | Nullable Transaction entry mode numerical value. | |||||||||||||||||||||
| processorData | object | optional | Processor Data data object. | |||||||||||||||||||||
| subAccountId | integer | ✓ | Sub-Account identifier. Value ≥ 0 | |||||||||||||||||||||
| terminalId | string | optional | Terminal identifier. MaxLength(20) | |||||||||||||||||||||
| transactionMethod | enum | optional | transactionMethodId. Available Values:
| |||||||||||||||||||||
| type | enum | ✓ | transactionTypeId. Available Values:
|
//Adjustment request example
{
"accountId": "Platform Account Id",
"subAccountId": "Sub-Account Id",
"amount": 10,
"currency": "USD",
"type": "Adjustment",
"billingOverride": [
{
"fixedAmount": "feeFixedAmount",
"id": "objectId",
"percentageAmount": "feePercentageAmount",
"sourceId": "feeSourceIdentifier",
"sourceType": "BillingAccountId",
"targetId": "feeTargetIdentifier",
"targetType": "BillingAccountId",
"reverse": "true",
"billingAmount": "billingAmountValue"
}
],
"terminalId": "string",
"transactionMethod": "RegularTransaction",
"entryMode": "2",
"billingAddress": {
"addressLine": "Address",
"city": "City Name",
"country": "USA",
"email": "email@mail.com",
"phoneNumber": "12346879",
"state": "FL",
"zipPostalCode": "123465798"
},
"merchantData": {
"freeText": "string",
"transactionDate": "dateTime",
"transactionDescription": "string",
"transactionId": "string"
},
"processorData": {
"dynamicDescriptor": "01919Z2"
}
}