public class Creditor
extends java.lang.Object
Represents a creditor resource returned from the API.
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 |
Creditor.Links |
static class |
Creditor.SchemeIdentifier |
static class |
Creditor.VerificationStatus |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getAddressLine1()
The first line of the creditor’s address.
|
java.lang.String |
getAddressLine2()
The second line of the creditor’s address.
|
java.lang.String |
getAddressLine3()
The third line of the creditor’s address.
|
java.lang.Boolean |
getCanCreateRefunds()
Boolean indicating whether the creditor is permitted to create refunds
|
java.lang.String |
getCity()
The city of the creditor’s address.
|
java.lang.String |
getCountryCode()
ISO 3166-1 alpha-2 code.
|
java.lang.String |
getCreatedAt()
Fixed timestamp, recording when this resource was created.
|
java.lang.String |
getId()
Unique identifier, beginning with “CR”.
|
Creditor.Links |
getLinks() |
java.lang.String |
getLogoUrl()
URL for the creditor’s logo, which may be shown on their payment pages.
|
java.lang.String |
getName()
The creditor’s name.
|
java.lang.String |
getPostalCode()
The creditor’s postal code.
|
java.lang.String |
getRegion()
The creditor’s address region, county or department.
|
java.util.List<Creditor.SchemeIdentifier> |
getSchemeIdentifiers()
An array of the scheme identifiers this creditor can create mandates against.
|
Creditor.VerificationStatus |
getVerificationStatus()
The creditor’s verification status, indicating whether they can yet receive payouts.
|
public java.lang.String getAddressLine1()
The first line of the creditor’s address.
public java.lang.String getAddressLine2()
The second line of the creditor’s address.
public java.lang.String getAddressLine3()
The third line of the creditor’s address.
public java.lang.Boolean getCanCreateRefunds()
Boolean indicating whether the creditor is permitted to create refunds
public java.lang.String getCity()
The city of the creditor’s address.
public java.lang.String getCountryCode()
ISO 3166-1 alpha-2 code.
public java.lang.String getCreatedAt()
Fixed timestamp, recording when this resource was created.
public java.lang.String getId()
Unique identifier, beginning with “CR”.
public Creditor.Links getLinks()
public java.lang.String getLogoUrl()
URL for the creditor’s logo, which may be shown on their payment pages.
public java.lang.String getName()
The creditor’s name.
public java.lang.String getPostalCode()
The creditor’s postal code.
public java.lang.String getRegion()
The creditor’s address region, county or department.
public java.util.List<Creditor.SchemeIdentifier> getSchemeIdentifiers()
An array of the scheme identifiers this creditor can create mandates against.
The support address, phone_number and email fields are for customers to contact the merchant for support purposes. They must be displayed on the payment page, please see our compliance requirements for more details.
public Creditor.VerificationStatus getVerificationStatus()
The creditor’s verification status, indicating whether they can yet receive payouts. For more details on handling verification as a partner, see our “Helping your users get verified” guide. One of:
successful: The creditor’s account is fully verified, and they can receive payouts. Once a creditor has been successfully verified, they may in the future require further verification - for example, if they change their payout bank account, we will have to check that they own the new bank account before they can receive payouts again.in_review: The creditor has provided all of the information currently requested, and it is awaiting review by GoCardless before they can be verified and receive payouts.action_required: The creditor needs to provide further information to verify their account so they can receive payouts, and should visit the verification flow.