transferLedgerBalance
Transfer value from a source ledger to a destination ledger. This decreases the balance of the source ledger by the given amount and increases the balance of the destination ledger by the same amount. If the amount is negative, the effect is reversed (the source ledger's balance increases and the destination ledger's balance decreases).
This field requires the Authorization header to be set.
Arguments
Input fields for processing an account balance transfer.
Returns
TransferLedgerBalanceTransfer value from a source ledger to a destination ledger. This decreases the balance of the source ledger by the given amount and increases the balance of the destination ledger by the same amount. If the amount is negative, the effect is reversed (the source ledger's balance increases and the destination ledger's balance decreases).
This field requires the Authorization header to be set.
Possible Errors
- KT-CT-1113: Disabled GraphQL field requested.
- KT-CT-3820: Received both ledger ID and number.
- KT-CT-3821: Received neither ledger ID nor ledger number.
- KT-CT-3822: Unauthorized.
- KT-CT-3823: Unauthorized.
- KT-CT-7899: An internal error occurred.
- KT-CT-9701: Balance transfer to same account is not allowed.
- KT-CT-9702: Balance transfer is not support for debit account with Zero balance.
- KT-CT-9703: Balance transfer is not supported for debit account.
- KT-CT-9704: Balance transfer amount should be non-zero.
Allowed Viewers
Customer
Partner User
Third party
Required Permissions
Can perform balance transfers Can perform payments operationsQuery Complexity
1Examples
mutation TransferLedgerBalance($input: TransferLedgerBalanceInputType!) {
transferLedgerBalance(input: $input) {
balanceTransfer {
...AccountBalanceTransferTypeFragment
}
}
}
Variables
{
"input": TransferLedgerBalanceInputType
}
Response
{
"data": {
"transferLedgerBalance": {
"balanceTransfer": AccountBalanceTransferType
}
}
}