# PaymentFlagsInterface | xrpl
Documentation for xrpl

# Interface PaymentFlagsInterface

Map of flags to boolean values representing Payment transaction flags.

#### Example

    const partialPayment: Payment = {
     TransactionType: 'Payment',
     Account: 'rM9WCfJU6udpFkvKThRaFHDMsp7L8rpgN',
     Amount: {
       currency: 'FOO',
       value: '4000',
       issuer: 'rPzwM2JfCSDjhbesdTCqFjWWdK7eFtTwZz',
     },
     Destination: 'rPzwM2JfCSDjhbesdTCqFjWWdK7eFtTwZz',
     Flags: {
       tfPartialPayment: true
     }
    }

    // Autofill the tx to see how flags actually look compared to the interface usage.
    const autofilledTx = await client.autofill(partialPayment)
    console.log(autofilledTx)
    // {
    //  TransactionType: 'Payment',
    //  Account: 'rM9WCfJU6udpFkvKThRaFHDMsp7L8rpgN',
    //  Amount: {
    //   currency: 'FOO',
    //   value: '4000',
    //   issuer: 'rPzwM2JfCSDjhbesdTCqFjWWdK7eFtTwZz'
    //  },
    //  Destination: 'rPzwM2JfCSDjhbesdTCqFjWWdK7eFtTwZz',
    //  Flags: 131072,
    //  Sequence: 21970996,
    //  Fee: '12',
    //  LastLedgerSequence: 21971016
    // }

#### Hierarchy

- GlobalFlags
  - PaymentFlagsInterface

- Defined in packages/xrpl/src/models/transactions/payment.ts:84

#####
Index

### Properties

tfLimitQuality?
tfNoDirectRipple?
tfPartialPayment?

## Properties

### `Optional` tfLimitQuality

tfLimitQuality?: boolean

Only take paths where all the conversions have an input:output ratio that is equal or better than the ratio of Amount:SendMax. See Limit Quality for details.

- Defined in packages/xrpl/src/models/transactions/payment.ts:102

### `Optional` tfNoDirectRipple

tfNoDirectRipple?: boolean

Do not use the default path; only use paths included in the Paths field. This is intended to force the transaction to take arbitrage opportunities. Most clients do not need this.

- Defined in packages/xrpl/src/models/transactions/payment.ts:90

### `Optional` tfPartialPayment

tfPartialPayment?: boolean

If the specified Amount cannot be sent without spending more than SendMax, reduce the received amount instead of failing outright. See Partial. Payments for more details.

- Defined in packages/xrpl/src/models/transactions/payment.ts:96

Generated using TypeDoc