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
Transaction Packet
| Name | Type | Required | Description | |||||||||||||||||||||
| accountId | integer | ✓ | Platform Account identifier. | |||||||||||||||||||||
| amount | decimal | optional | Transaction amount. Acceptable values: Amount=null / Amount is absent / Amount = “” / Amount = 0. Request validation fails with the Amount value that is greater or lower than zero. | |||||||||||||||||||||
| billingAddress | object | optional | User Billing Address data object. | |||||||||||||||||||||
| billingOverride | object | ✓ | Data object that contains an array of billingFee objects. |
|||||||||||||||||||||
| currency | enum | ✓ | currencyTypeId
Available Values:
|
|||||||||||||||||||||
| status | enum | optional | Acceptable values: Status=null / Status is absent / Status = “”/ Status: Processed.
Available Values:
|
|||||||||||||||||||||
| subaccountid | integer | ✓ | Sub-Account identifier. | |||||||||||||||||||||
| terminalid | string | optional | Terminal identifier. | |||||||||||||||||||||
| transactionmethod | enum | optional | transactionMethodId
Available Values:
|
|||||||||||||||||||||
| type | enum | ✓ | transactionTypeId
Available Values:
|
{
"accountId": "Platform Account Id",
"amount": 0,
"billingAddress": {
"addressLine": "Address Line",
"city": "City Name",
"country": "Country Name",
"email": "email@mail.com",
"phoneNumber": "12346879",
"state": "State Name",
"zipPostalCode": "ZIP Code"
},
"billingOverride": [
{
"fixedAmount": 66.66,
"id": 5896,
"percentageAmount": 0,
"sourceId": 1000421511,
"sourceType": "billingAccountId",
"targetId": 1000397047,
"targetType": "billingAccountId",
"reverse": false
}
],
"currency": "USD",
"status": "Processed",
"subAccountId": "Sub-Account Id",
"terminalId": "",
"transactionMethod": "RegularTransaction",
"type": "Adjustment"
}