Skip to main content
Version: v2

BpsFee

sourceTokenAddressstringrequired

Address on the source chain of the token associated with this fee. Format depends on source chain family.

Example: 0x80ac24aa929eaf5013f6436cda2a7ba190f5cc0b
sourcePoolAddressstringrequired

Address on the source chain of the token pool associated with this fee.

Example: 0x20b79d39bd44deee4f89b1e9d0e3b945fde06491
amountstringrequired

BPS fee amount deducted from the transfer, in the token's smallest unit on the source chain.

Example: 5000
bpsintegerrequired

Basis points rate applied by the token pool (e.g., 50 = 0.50%).

Example: 50
deductedAtstringrequired

Which chain the fee was actually deducted on.

  • SOURCE: The fee was deducted on the source chain.
  • DESTINATION: The fee was deducted on the destination chain.

Possible values: [SOURCE, DESTINATION]

Example: SOURCE
JSON
BpsFee
{
"sourceTokenAddress": "0x80ac24aa929eaf5013f6436cda2a7ba190f5cc0b",
"sourcePoolAddress": "0x20b79d39bd44deee4f89b1e9d0e3b945fde06491",
"amount": "5000",
"bps": 50,
"deductedAt": "SOURCE"
}