com.stripe.model.issuing.Settlement Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of stripe-java Show documentation
Stripe Java Bindings
There is a newer version: 28.2.0
// File generated from our OpenAPI spec
package com.stripe.model.issuing;

import com.google.gson.annotations.SerializedName;
import com.stripe.model.HasId;
import com.stripe.model.StripeObject;
import java.util.Map;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.Setter;

/**
 * When a non-stripe BIN is used, any use of an issued
 * card must be settled directly with the card network. The net amount owed is represented by an
 * Issuing {@code Settlement} object.
 */
@Getter
@Setter
@EqualsAndHashCode(callSuper = false)
public class Settlement extends StripeObject implements HasId {
  /** The Bank Identification Number reflecting this settlement record. */
  @SerializedName("bin")
  String bin;

  /** The date that the transactions are cleared and posted to user's accounts. */
  @SerializedName("clearing_date")
  Long clearingDate;

  /** 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;

  /** Unique identifier for the object. */
  @Getter(onMethod_ = {@Override})
  @SerializedName("id")
  String id;

  /** The total interchange received as reimbursement for the transactions. */
  @SerializedName("interchange_fees")
  Long interchangeFees;

  /**
   * Has the value {@code true} if the object exists in live mode or the value {@code false} if the
   * object exists in test mode.
   */
  @SerializedName("livemode")
  Boolean livemode;

  /**
   * 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.
   */
  @SerializedName("metadata")
  Map metadata;

  /** The total net amount required to settle with the network. */
  @SerializedName("net_total")
  Long netTotal;

  /** The card network for this settlement report. One of ["visa", "maestro"] */
  @SerializedName("network")
  String network;

  /** The total amount of fees owed to the network. */
  @SerializedName("network_fees")
  Long networkFees;

  /** The Settlement Identification Number assigned by the network. */
  @SerializedName("network_settlement_identifier")
  String networkSettlementIdentifier;

  /**
   * String representing the object's type. Objects of the same type share the same value.
   *
   * Equal to {@code issuing.settlement}.
   */
  @SerializedName("object")
  String object;

  /** One of {@code international} or {@code uk_national_net}. */
  @SerializedName("settlement_service")
  String settlementService;

  /**
   * The current processing status of this settlement.
   *
   * One of {@code complete}, or {@code pending}.
   */
  @SerializedName("status")
  String status;

  /** The total number of transactions reflected in this settlement. */
  @SerializedName("transaction_count")
  Long transactionCount;

  /** The total transaction amount reflected in this settlement. */
  @SerializedName("transaction_volume")
  Long transactionVolume;
}