Mayson Monorepo Documentation
    Preparing search index...
    interface Receiver {
        address: string;
        amount_charged: number;
        amount_received: number;
        amount_returned: number;
        refund_attributes_method: string;
        refund_attributes_status: string;
    }
    Index

    Properties

    address: string

    The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.

    amount_charged: number

    The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency.

    amount_received: number

    The total amount received by the receiver source. amount_received = amount_returned + amount_charged should be true for consumed sources unless customers deposit excess funds. The amount received is expressed in the source's currency.

    amount_returned: number

    The total amount that was returned to the customer. The amount returned is expressed in the source's currency.

    refund_attributes_method: string

    Type of refund attribute method, one of email, manual, or none.

    refund_attributes_status: string

    Type of refund attribute status, one of missing, requested, or available.