Class Payout

java.lang.Object
io.trippay.sdk.payment.model.Payout
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2025-03-04T20:44:38.105926479+07:00[Asia/Bangkok]") public class Payout extends Object
Payout keeps track of all outgoing funds for a certain account.

  • Field Details

  • Constructor Details

    • Payout

      public Payout()

  • Method Details

    • vendor

      public Payout vendor(Payout.VendorEnum vendor)

    • getVendor

      @Nonnull @NotNull public @NotNull Payout.VendorEnum getVendor()
      Name of integration vendor
      Returns:
      vendor

    • setVendor

      public void setVendor(Payout.VendorEnum vendor)

    • vendorIdentifier

      public Payout vendorIdentifier(String vendorIdentifier)

    • getVendorIdentifier

      @Nonnull @NotNull public @NotNull String getVendorIdentifier()
      Which acquirer account we return fund from.
      Returns:
      vendorIdentifier

    • setVendorIdentifier

      public void setVendorIdentifier(String vendorIdentifier)

    • vendorName

      public Payout vendorName(String vendorName)

    • getVendorName

      @Nonnull @NotNull public @NotNull String getVendorName()
      Name of regional acquirer account.
      Returns:
      vendorName

    • setVendorName

      public void setVendorName(String vendorName)

    • ledgerIdentifier

      public Payout ledgerIdentifier(UUID ledgerIdentifier)

    • getLedgerIdentifier

      @Nonnull @NotNull @Valid public @NotNull @Valid UUID getLedgerIdentifier()
      Unique system ID.
      Returns:
      ledgerIdentifier

    • setLedgerIdentifier

      public void setLedgerIdentifier(UUID ledgerIdentifier)

    • beneficiaryIdentifier

      public Payout beneficiaryIdentifier(UUID beneficiaryIdentifier)

    • getBeneficiaryIdentifier

      @Nonnull @NotNull @Valid public @NotNull @Valid UUID getBeneficiaryIdentifier()
      Beneficiary ID.
      Returns:
      beneficiaryIdentifier

    • setBeneficiaryIdentifier

      public void setBeneficiaryIdentifier(UUID beneficiaryIdentifier)

    • externalPayeeIdentifier

      public Payout externalPayeeIdentifier(String externalPayeeIdentifier)

    • getExternalPayeeIdentifier

      @Nonnull @NotNull public @NotNull String getExternalPayeeIdentifier()
      This would be the Wise recipient ID.
      Returns:
      externalPayeeIdentifier

    • setExternalPayeeIdentifier

      public void setExternalPayeeIdentifier(String externalPayeeIdentifier)

    • type

      public Payout type(Payout.TypeEnum type)

    • getType

      @Nonnull @NotNull public @NotNull Payout.TypeEnum getType()
      Type of withdrawal.
      Returns:
      type

    • setType

      public void setType(Payout.TypeEnum type)

    • entry

      public Payout entry(CustomMonetaryAmount entry)

    • getEntry

      @Nonnull @NotNull @Valid public @NotNull @Valid CustomMonetaryAmount getEntry()
      Get entry
      Returns:
      entry

    • setEntry

      public void setEntry(CustomMonetaryAmount entry)

    • fees

      public Payout fees(List<PayoutFee> fees)

    • addFeesItem

      public Payout addFeesItem(PayoutFee feesItem)

    • getFees

      @Nullable @Valid public @Valid List<PayoutFee> getFees()
      Fees incurred when making the withdrawal.
      Returns:
      fees

    • setFees

      public void setFees(List<PayoutFee> fees)

    • quote

      public Payout quote(Quote quote)

    • getQuote

      @Nullable @Valid public @Valid Quote getQuote()
      Get quote
      Returns:
      quote

    • setQuote

      public void setQuote(Quote quote)

    • created

      public Payout created(LocalDateTime created)

    • getCreated

      @Nonnull @NotNull @Valid public LocalDateTime getCreated()
      When the payout record was created.
      Returns:
      created

    • setCreated

      public void setCreated(LocalDateTime created)

    • description

      public Payout description(String description)

    • getDescription

      @Nullable public String getDescription()
      Textual response from provider
      Returns:
      description

    • setDescription

      public void setDescription(String description)

    • payoutId

      public Payout payoutId(String payoutId)

    • getPayoutId

      @Nullable public String getPayoutId()
      The ledgerIdentifier that was generated when scheduling the payout. This will come from the payout provider such as Stripe.
      Returns:
      payoutId

    • setPayoutId

      public void setPayoutId(String payoutId)

    • referenceCode

      public Payout referenceCode(String referenceCode)

    • getReferenceCode

      @Nullable public String getReferenceCode()
      The transaction code that was generated when the funds move out of TripPay's account. This will come from the payout provider such as Stripe. E.g. For VCCs, it will occur when an authorization takes place.
      Returns:
      referenceCode

    • setReferenceCode

      public void setReferenceCode(String referenceCode)

    • referenceCodeDate

      public Payout referenceCodeDate(LocalDateTime referenceCodeDate)

    • getReferenceCodeDate

      @Nullable @Valid public LocalDateTime getReferenceCodeDate()
      The time the funds were withdrawn
      Returns:
      referenceCodeDate

    • setReferenceCodeDate

      public void setReferenceCodeDate(LocalDateTime referenceCodeDate)

    • status

      public Payout status(Payout.StatusEnum status)

    • getStatus

      @Nonnull @NotNull public @NotNull Payout.StatusEnum getStatus()
      Status of withdrawal.
      Returns:
      status

    • setStatus

      public void setStatus(Payout.StatusEnum status)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object