@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Adyen Balance Control API
@base https://pal-test.adyen.com/pal/servlet/BalanceControl/v1
@version 1
@auth ApiKey X-API-Key in header | Bearer basic
@endpoints 1
@toc balanceTransfer(1)

@endpoint POST /balanceTransfer
@desc Start a balance transfer
@required {amount: map{currency!: str, value!: int(int64)}, fromMerchant: str # The unique identifier of the source merchant account from which funds are deducted., toMerchant: str # The unique identifier of the destination merchant account from which funds are transferred., type: str(tax/fee/terminalSale/credit/debit/adjustment) # The type of balance transfer. Possible values: **tax**, **fee**, **terminalSale**, **credit**, **debit**, and **adjustment**.}
@optional {description: str # A human-readable description for the transfer. You can use alphanumeric characters and hyphens. We recommend sending a maximum of 140 characters, otherwise the description may be truncated., reference: str # A reference for the balance transfer. If you don't provide this in the request, Adyen generates a unique reference. Maximum length: 80 characters.}
@returns(200) {amount: map{currency: str, value: int(int64)}, createdAt: str(date-time), description: str, fromMerchant: str, pspReference: str, reference: str, status: str, toMerchant: str, type: str} # OK - the request has succeeded.
@example_request {"amount":{"value":50000,"currency":"EUR"},"description":"Your description for the transfer","fromMerchant":"MerchantAccount_NL","toMerchant":"MerchantAccount_DE","type":"debit"}

@end