Method Detail

• getAmount

  public java.lang.Integer getAmount()

  Amount in pence (GBP), cents (AUD/EUR), öre (SEK), or øre (DKK).

• getAmountRefunded

  public java.lang.Integer getAmountRefunded()

  Amount refunded in pence/cents/öre/øre.

• getChargeDate

  public java.lang.String getChargeDate()

  A future date on which the payment should be collected. If not specified, the payment will be collected as soon as possible. This must be on or after the mandate’s next_possible_charge_date, and will be rolled-forwards by GoCardless if it is not a working day.

• getCreatedAt

  public java.lang.String getCreatedAt()

  Fixed timestamp, recording when this resource was created.

• getCurrency

  public Payment.Currency getCurrency()

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

• getDescription

  public java.lang.String getDescription()

  A human-readable description of the payment. This will be included in the notification email GoCardless sends to your customer if your organisation does not send its own notifications (see compliance requirements).

• getId

  public java.lang.String getId()

  Unique identifier, beginning with “PM”.

• getLinks

  public Payment.Links getLinks()

• getMetadata

  public java.util.Map<java.lang.String,java.lang.String> getMetadata()

  Key-value store of custom data. Up to 3 keys are permitted, with key names up to 50 characters and values up to 500 characters.

• getReference

  public java.lang.String getReference()

  An optional payment reference that will appear on your customer’s bank statement. For Bacs payments this can be up to 10 characters, for SEPA payments the limit is 140 characters, for Betalingsservice or BECS payments the limit is 30 characters and for Autogiro payments the limit is 11 characters.

  Restricted: You can only specify a payment reference for Bacs payments (that is, when collecting from the UK) if you’re on the GoCardless Plus or Pro packages.

• getStatus

  public Payment.Status getStatus()

  One of:

  • pending_customer_approval: we’re waiting for the customer to approve this payment
  • pending_submission: the payment has been created, but not yet submitted to the banks
  • submitted: the payment has been submitted to the banks
  • confirmed: the payment has been confirmed as collected
  • paid_out: the payment has been included in a payout
  • cancelled: the payment has been cancelled
  • customer_approval_denied: the customer has denied approval for the payment. You should contact the customer directly
  • failed: the payment failed to be processed. Note that payments can fail after being confirmed if the failure message is sent late by the banks.
  • charged_back: the payment has been charged back