public class PayoutItem
extends java.lang.Object
Represents a payout item resource returned from the API.
When we collect a payment on your behalf, we add the money you’ve collected to your GoCardless balance, minus any fees paid. Periodically (usually every working day), we take any positive balance in your GoCardless account, and pay it out to your nominated bank account.
Other actions in your GoCardless account can also affect your balance. For example, if a customer charges back a payment, we’ll deduct the payment’s amount from your balance, but add any fees you paid for that payment back to your balance.
The Payout Items API allows you to view, on a per-payout basis, the credit and debit items that make up that payout’s amount.
| Modifier and Type | Class and Description |
|---|---|
static class |
PayoutItem.Links |
static class |
PayoutItem.Type |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getAmount()
The positive (credit) or negative (debit) value of the item, in fractional currency; either pence (GBP), cents (AUD/EUR), or öre (SEK), to one decimal place.
|
PayoutItem.Links |
getLinks() |
PayoutItem.Type |
getType()
The type of the credit (positive) or debit (negative) item in the payout.
|
public java.lang.String getAmount()
The positive (credit) or negative (debit) value of the item, in fractional currency; either pence (GBP), cents (AUD/EUR), or öre (SEK), to one decimal place.
For accuracy, we store some of our fees to greater precision than we can actually pay out (for example, a GoCardless fee we record might come to 0.5 pence, but it is not possible to send a payout via bank transfer including a half penny).
To calculate the final amount of the payout, we sum all of the items and then round to the nearest currency unit.
public PayoutItem.Links getLinks()
public PayoutItem.Type getType()
The type of the credit (positive) or debit (negative) item in the payout. One of:
payment_paid_out (credit)payment_failed (debit): The payment failed to be processed.payment_charged_back (debit): The payment has been charged back.payment_refunded (debit): The payment has been refunded to the customer.refund (debit): private beta A refund sent to a customer, not linked to a payment.gocardless_fee (credit/debit): The fees that GoCardless charged for a payment. In the case of a payment failure or chargeback, these will appear as credits.app_fee (credit/debit): The optional fees that a partner may have taken for a payment. In the case of a payment failure or chargeback, these will appear as credits.revenue_share (credit/debit): A share of the fees that GoCardless collected which some partner integrations receive when their users take payments. Only shown in partner payouts. In the case of a payment failure or chargeback, these will appear as credits.