Package io.trippay.sdk.payment.model

Class Payout

java.lang.Object

io.trippay.sdk.payment.model.Payout

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-06-04T22:21:19.072173344+07:00[Asia/Bangkok]")
public class Payout
extends Object

Payout keeps track of all outgoing funds for a certain account.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Payout.StatusEnum	Status of withdrawal.
static enum	Payout.TypeEnum	Type of withdrawal.
static enum	Payout.VendorEnum	Name of integration vendor

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_BENEFICIARY_IDENTIFIER
static final String	JSON_PROPERTY_CREATED
static final String	JSON_PROPERTY_DESCRIPTION
static final String	JSON_PROPERTY_ENTRY
static final String	JSON_PROPERTY_EXTERNAL_PAYEE_IDENTIFIER
static final String	JSON_PROPERTY_FEES
static final String	JSON_PROPERTY_IDENTIFIER
static final String	JSON_PROPERTY_PAYOUT_ID
static final String	JSON_PROPERTY_REFERENCE_CODE
static final String	JSON_PROPERTY_REFERENCE_CODE_DATE
static final String	JSON_PROPERTY_STATUS
static final String	JSON_PROPERTY_TYPE
static final String	JSON_PROPERTY_VENDOR
static final String	JSON_PROPERTY_VENDOR_IDENTIFIER
static final String	JSON_PROPERTY_VENDOR_NAME
static final String	JSON_PROPERTY_VENDOR_TOKEN_KEY

Constructor Summary

Constructors

Constructor	Description
Payout()

Method Summary

Modifier and Type	Method	Description
Payout	addFeesItem(PayoutFee feesItem)
Payout	beneficiaryIdentifier(UUID beneficiaryIdentifier)
Payout	created(LocalDateTime created)
Payout	description(String description)
Payout	entry(CustomMonetaryAmount entry)
boolean	equals(Object o)
Payout	externalPayeeIdentifier(String externalPayeeIdentifier)
Payout	fees(List<PayoutFee> fees)
@NotNull @Valid UUID	getBeneficiaryIdentifier()	Beneficiary ID.
LocalDateTime	getCreated()	When the payout record was created.
String	getDescription()	Textual response from provider
@NotNull @Valid CustomMonetaryAmount	getEntry()	Get entry
@NotNull String	getExternalPayeeIdentifier()	This would be the cardholder ID for VCCs.
@Valid List<PayoutFee>	getFees()	Fees incurred when making the withdrawal.
@NotNull @Valid UUID	getIdentifier()	Unique system ID.
String	getPayoutId()	The identifier that was generated when scheduling the payout.
String	getReferenceCode()	The transaction code that was generated when the funds move out of TripPay's account.
LocalDateTime	getReferenceCodeDate()	The time the funds were withdrawn
@NotNull Payout.StatusEnum	getStatus()	Status of withdrawal.
@NotNull Payout.TypeEnum	getType()	Type of withdrawal.
@NotNull Payout.VendorEnum	getVendor()	Name of integration vendor
@NotNull String	getVendorIdentifier()	Which acquirer account we return fund from.
@NotNull String	getVendorName()	Name of regional acquirer account.
@NotNull String	getVendorTokenKey()	Key to help load Stripe for the correct region.
int	hashCode()
Payout	identifier(UUID identifier)
Payout	payoutId(String payoutId)
Payout	referenceCode(String referenceCode)
Payout	referenceCodeDate(LocalDateTime referenceCodeDate)
void	setBeneficiaryIdentifier(UUID beneficiaryIdentifier)
void	setCreated(LocalDateTime created)
void	setDescription(String description)
void	setEntry(CustomMonetaryAmount entry)
void	setExternalPayeeIdentifier(String externalPayeeIdentifier)
void	setFees(List<PayoutFee> fees)
void	setIdentifier(UUID identifier)
void	setPayoutId(String payoutId)
void	setReferenceCode(String referenceCode)
void	setReferenceCodeDate(LocalDateTime referenceCodeDate)
void	setStatus(Payout.StatusEnum status)
void	setType(Payout.TypeEnum type)
void	setVendor(Payout.VendorEnum vendor)
void	setVendorIdentifier(String vendorIdentifier)
void	setVendorName(String vendorName)
void	setVendorTokenKey(String vendorTokenKey)
Payout	status(Payout.StatusEnum status)
String	toString()
Payout	type(Payout.TypeEnum type)
Payout	vendor(Payout.VendorEnum vendor)
Payout	vendorIdentifier(String vendorIdentifier)
Payout	vendorName(String vendorName)
Payout	vendorTokenKey(String vendorTokenKey)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_VENDOR

public static final String JSON_PROPERTY_VENDOR

See Also:

• Constant Field Values

JSON_PROPERTY_VENDOR_IDENTIFIER

public static final String JSON_PROPERTY_VENDOR_IDENTIFIER

See Also:

• Constant Field Values

JSON_PROPERTY_VENDOR_NAME

public static final String JSON_PROPERTY_VENDOR_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_VENDOR_TOKEN_KEY

public static final String JSON_PROPERTY_VENDOR_TOKEN_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_IDENTIFIER

public static final String JSON_PROPERTY_IDENTIFIER

See Also:

• Constant Field Values

JSON_PROPERTY_BENEFICIARY_IDENTIFIER

public static final String JSON_PROPERTY_BENEFICIARY_IDENTIFIER

See Also:

• Constant Field Values

JSON_PROPERTY_EXTERNAL_PAYEE_IDENTIFIER

public static final String JSON_PROPERTY_EXTERNAL_PAYEE_IDENTIFIER

See Also:

• Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_ENTRY

public static final String JSON_PROPERTY_ENTRY

See Also:

• Constant Field Values

JSON_PROPERTY_FEES

public static final String JSON_PROPERTY_FEES

See Also:

• Constant Field Values

JSON_PROPERTY_CREATED

public static final String JSON_PROPERTY_CREATED

See Also:

• Constant Field Values

JSON_PROPERTY_DESCRIPTION

public static final String JSON_PROPERTY_DESCRIPTION

See Also:

• Constant Field Values

JSON_PROPERTY_PAYOUT_ID

public static final String JSON_PROPERTY_PAYOUT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_REFERENCE_CODE

public static final String JSON_PROPERTY_REFERENCE_CODE

See Also:

• Constant Field Values

JSON_PROPERTY_REFERENCE_CODE_DATE

public static final String JSON_PROPERTY_REFERENCE_CODE_DATE

See Also:

• Constant Field Values

JSON_PROPERTY_STATUS

public static final String JSON_PROPERTY_STATUS

See Also:

• Constant Field Values

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)

vendorTokenKey

public Payout vendorTokenKey(String vendorTokenKey)

getVendorTokenKey

@Nonnull
@NotNull
public @NotNull String getVendorTokenKey()

Key to help load Stripe for the correct region. Could be helpful for other vendors as well.

Returns:

vendorTokenKey

setVendorTokenKey

public void setVendorTokenKey(String vendorTokenKey)

identifier

public Payout identifier(UUID identifier)

getIdentifier

@Nonnull
@NotNull
@Valid
public @NotNull @Valid UUID getIdentifier()

Unique system ID.

Returns:

identifier

setIdentifier

public void setIdentifier(UUID identifier)

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 cardholder ID for VCCs.

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)

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 identifier 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