public class PayoutItemService
extends java.lang.Object
Service class for working with payout item resources.
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 |
PayoutItemService.PayoutItemListRequest<S>
Request class for
list(). |
| Constructor and Description |
|---|
PayoutItemService(HttpClient httpClient)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
PayoutItemService.PayoutItemListRequest<java.lang.Iterable<PayoutItem>> |
all() |
PayoutItemService.PayoutItemListRequest<ListResponse<PayoutItem>> |
list()
Returns a cursor-paginated list of items in the payout.
|
public PayoutItemService(HttpClient httpClient)
Constructor. Users of this library should have no need to call this - an instance of this class can be obtained by calling GoCardlessClient.payoutItems().
public PayoutItemService.PayoutItemListRequest<ListResponse<PayoutItem>> list()
Returns a cursor-paginated list of items in the payout.
public PayoutItemService.PayoutItemListRequest<java.lang.Iterable<PayoutItem>> all()