Method Detail

• getAmount

  public java.lang.Integer getAmount()

  Amount in pence or cents.

• getArrivalDate

  public java.lang.String getArrivalDate()

  Date the payout is due to arrive in the creditor’s bank account. One of:

  • yyyy-mm-dd: the payout has been paid and is due to arrive in the creditor’s bank account on this day
  • null: the payout hasn’t been paid yet

• getCreatedAt

  public java.lang.String getCreatedAt()

  Fixed timestamp, recording when this resource was created.

• getCurrency

  public Payout.Currency getCurrency()

  ISO 4217 currency code. Currently “AUD”, “DKK”, “EUR”, “GBP”, “NZD” and “SEK” are supported.

• getDeductedFees

  public java.lang.Integer getDeductedFees()

  Fees that have already been deducted from the payout amount in pence or cents.

  For each late_failure_settled or chargeback_settled action, we refund the transaction fees in a payout. This means that a payout can have a negative deducted_fees. This field is calculated as GoCardless fees + app fees - refunded fees

  If the merchant is invoiced for fees separately from the payout, then deducted_fees will be 0.

• getId

  public java.lang.String getId()

  Unique identifier, beginning with “PO”.

• getLinks

  public Payout.Links getLinks()

• getPayoutType

  public Payout.PayoutType getPayoutType()

  Whether a payout contains merchant revenue or partner fees.

• getReference

  public java.lang.String getReference()

  Reference which appears on the creditor’s bank statement.

• getStatus

  public Payout.Status getStatus()

  One of:

  • pending: the payout has been created, but not yet sent to the banks
  • paid: the payout has been sent to the banks