com.stripe.model.TransferReversal Maven / Gradle / Ivy
// File generated from our OpenAPI spec
package com.stripe.model;
import com.google.gson.annotations.SerializedName;
import com.stripe.exception.StripeException;
import com.stripe.net.ApiMode;
import com.stripe.net.ApiRequest;
import com.stripe.net.ApiRequestParams;
import com.stripe.net.ApiResource;
import com.stripe.net.BaseAddress;
import com.stripe.net.RequestOptions;
import com.stripe.net.StripeResponseGetter;
import com.stripe.param.TransferReversalUpdateParams;
import java.util.Map;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.Setter;
/**
* Stripe Connect platforms can reverse transfers made
* to a connected account, either entirely or partially, and can also specify whether to refund any
* related application fees. Transfer reversals add to the platform's balance and subtract from the
* destination account's balance.
*
* Reversing a transfer that was made for a destination charge is allowed only
* up to the amount of the charge. It is possible to reverse a transfer_group
* transfer only if the destination account has enough balance to cover the reversal.
*
*
Related guide: Reverse
* transfers
*/
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public class TransferReversal extends ApiResource
implements MetadataStore, BalanceTransactionSource {
/** Amount, in cents (or local equivalent). */
@SerializedName("amount")
Long amount;
/** Balance transaction that describes the impact on your account balance. */
@SerializedName("balance_transaction")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField balanceTransaction;
/** Time at which the object was created. Measured in seconds since the Unix epoch. */
@SerializedName("created")
Long created;
/**
* Three-letter ISO currency code,
* in lowercase. Must be a supported currency.
*/
@SerializedName("currency")
String currency;
/** Linked payment refund for the transfer reversal. */
@SerializedName("destination_payment_refund")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField destinationPaymentRefund;
/** Unique identifier for the object. */
@Getter(onMethod_ = {@Override})
@SerializedName("id")
String id;
/**
* Set of key-value pairs that you can attach
* to an object. This can be useful for storing additional information about the object in a
* structured format.
*/
@Getter(onMethod_ = {@Override})
@SerializedName("metadata")
Map metadata;
/**
* String representing the object's type. Objects of the same type share the same value.
*
* Equal to {@code transfer_reversal}.
*/
@SerializedName("object")
String object;
/** ID of the refund responsible for the transfer reversal. */
@SerializedName("source_refund")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField sourceRefund;
/** ID of the transfer that was reversed. */
@SerializedName("transfer")
@Getter(lombok.AccessLevel.NONE)
@Setter(lombok.AccessLevel.NONE)
ExpandableField transfer;
/** Get ID of expandable {@code balanceTransaction} object. */
public String getBalanceTransaction() {
return (this.balanceTransaction != null) ? this.balanceTransaction.getId() : null;
}
public void setBalanceTransaction(String id) {
this.balanceTransaction = ApiResource.setExpandableFieldId(id, this.balanceTransaction);
}
/** Get expanded {@code balanceTransaction}. */
public BalanceTransaction getBalanceTransactionObject() {
return (this.balanceTransaction != null) ? this.balanceTransaction.getExpanded() : null;
}
public void setBalanceTransactionObject(BalanceTransaction expandableObject) {
this.balanceTransaction =
new ExpandableField(expandableObject.getId(), expandableObject);
}
/** Get ID of expandable {@code destinationPaymentRefund} object. */
public String getDestinationPaymentRefund() {
return (this.destinationPaymentRefund != null) ? this.destinationPaymentRefund.getId() : null;
}
public void setDestinationPaymentRefund(String id) {
this.destinationPaymentRefund =
ApiResource.setExpandableFieldId(id, this.destinationPaymentRefund);
}
/** Get expanded {@code destinationPaymentRefund}. */
public Refund getDestinationPaymentRefundObject() {
return (this.destinationPaymentRefund != null)
? this.destinationPaymentRefund.getExpanded()
: null;
}
public void setDestinationPaymentRefundObject(Refund expandableObject) {
this.destinationPaymentRefund =
new ExpandableField(expandableObject.getId(), expandableObject);
}
/** Get ID of expandable {@code sourceRefund} object. */
public String getSourceRefund() {
return (this.sourceRefund != null) ? this.sourceRefund.getId() : null;
}
public void setSourceRefund(String id) {
this.sourceRefund = ApiResource.setExpandableFieldId(id, this.sourceRefund);
}
/** Get expanded {@code sourceRefund}. */
public Refund getSourceRefundObject() {
return (this.sourceRefund != null) ? this.sourceRefund.getExpanded() : null;
}
public void setSourceRefundObject(Refund expandableObject) {
this.sourceRefund = new ExpandableField(expandableObject.getId(), expandableObject);
}
/** Get ID of expandable {@code transfer} object. */
public String getTransfer() {
return (this.transfer != null) ? this.transfer.getId() : null;
}
public void setTransfer(String id) {
this.transfer = ApiResource.setExpandableFieldId(id, this.transfer);
}
/** Get expanded {@code transfer}. */
public Transfer getTransferObject() {
return (this.transfer != null) ? this.transfer.getExpanded() : null;
}
public void setTransferObject(Transfer expandableObject) {
this.transfer = new ExpandableField(expandableObject.getId(), expandableObject);
}
/**
* Updates the specified reversal by setting the values of the parameters passed. Any parameters
* not provided will be left unchanged.
*
* This request only accepts metadata and description as arguments.
*/
@Override
public TransferReversal update(Map params) throws StripeException {
return update(params, (RequestOptions) null);
}
/**
* Updates the specified reversal by setting the values of the parameters passed. Any parameters
* not provided will be left unchanged.
*
* This request only accepts metadata and description as arguments.
*/
@Override
public TransferReversal update(Map params, RequestOptions options)
throws StripeException {
String path =
String.format(
"/v1/transfers/%s/reversals/%s",
ApiResource.urlEncodeId(this.getTransfer()), ApiResource.urlEncodeId(this.getId()));
ApiRequest request =
new ApiRequest(
BaseAddress.API, ApiResource.RequestMethod.POST, path, params, options, ApiMode.V1);
return getResponseGetter().request(request, TransferReversal.class);
}
/**
* Updates the specified reversal by setting the values of the parameters passed. Any parameters
* not provided will be left unchanged.
*
* This request only accepts metadata and description as arguments.
*/
public TransferReversal update(TransferReversalUpdateParams params) throws StripeException {
return update(params, (RequestOptions) null);
}
/**
* Updates the specified reversal by setting the values of the parameters passed. Any parameters
* not provided will be left unchanged.
*
*
This request only accepts metadata and description as arguments.
*/
public TransferReversal update(TransferReversalUpdateParams params, RequestOptions options)
throws StripeException {
String path =
String.format(
"/v1/transfers/%s/reversals/%s",
ApiResource.urlEncodeId(this.getTransfer()), ApiResource.urlEncodeId(this.getId()));
ApiResource.checkNullTypedParams(path, params);
ApiRequest request =
new ApiRequest(
BaseAddress.API,
ApiResource.RequestMethod.POST,
path,
ApiRequestParams.paramsToMap(params),
options,
ApiMode.V1);
return getResponseGetter().request(request, TransferReversal.class);
}
@Override
public void setResponseGetter(StripeResponseGetter responseGetter) {
super.setResponseGetter(responseGetter);
trySetResponseGetter(balanceTransaction, responseGetter);
trySetResponseGetter(destinationPaymentRefund, responseGetter);
trySetResponseGetter(sourceRefund, responseGetter);
trySetResponseGetter(transfer, responseGetter);
}
}