public class CreditorService
extends java.lang.Object
Service class for working with creditor resources.
Each payment taken through the API is linked to a “creditor”, to whom the payment is then paid out. In most cases your organisation will have a single “creditor”, but the API also supports collecting payments on behalf of others.
Please get in touch if you wish to use this endpoint. Currently, for Anti Money Laundering reasons, any creditors you add must be directly related to your organisation.
| Modifier and Type | Class and Description |
|---|---|
static class |
CreditorService.CreditorCreateRequest
Request class for
create(). |
static class |
CreditorService.CreditorGetRequest
Request class for
get(java.lang.String). |
static class |
CreditorService.CreditorListRequest<S>
Request class for
list(). |
static class |
CreditorService.CreditorUpdateRequest
Request class for
update(java.lang.String). |
| Constructor and Description |
|---|
CreditorService(HttpClient httpClient)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
CreditorService.CreditorListRequest<java.lang.Iterable<Creditor>> |
all() |
CreditorService.CreditorCreateRequest |
create()
Creates a new creditor.
|
CreditorService.CreditorGetRequest |
get(java.lang.String identity)
Retrieves the details of an existing creditor.
|
CreditorService.CreditorListRequest<ListResponse<Creditor>> |
list()
Returns a cursor-paginated list of your creditors.
|
CreditorService.CreditorUpdateRequest |
update(java.lang.String identity)
Updates a creditor object.
|
public CreditorService(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.creditors().
public CreditorService.CreditorCreateRequest create()
Creates a new creditor.
public CreditorService.CreditorListRequest<ListResponse<Creditor>> list()
Returns a cursor-paginated list of your creditors.
public CreditorService.CreditorListRequest<java.lang.Iterable<Creditor>> all()
public CreditorService.CreditorGetRequest get(java.lang.String identity)
Retrieves the details of an existing creditor.
public CreditorService.CreditorUpdateRequest update(java.lang.String identity)
Updates a creditor object. Supports all of the fields supported when creating a creditor.