gocardless_pro 4.22.0 → 4.23.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (61) hide show
  1. checksums.yaml +4 -4
  2. data/lib/gocardless_pro/client.rb +1 -1
  3. data/lib/gocardless_pro/resources/billing_request.rb +7 -1
  4. data/lib/gocardless_pro/resources/billing_request_with_action.rb +1 -1
  5. data/lib/gocardless_pro/resources/creditor.rb +1 -2
  6. data/lib/gocardless_pro/resources/creditor_bank_account.rb +3 -4
  7. data/lib/gocardless_pro/resources/customer.rb +2 -2
  8. data/lib/gocardless_pro/resources/customer_bank_account.rb +6 -6
  9. data/lib/gocardless_pro/resources/event.rb +2 -2
  10. data/lib/gocardless_pro/resources/institution.rb +2 -2
  11. data/lib/gocardless_pro/resources/logo.rb +1 -1
  12. data/lib/gocardless_pro/resources/mandate.rb +3 -3
  13. data/lib/gocardless_pro/resources/mandate_import.rb +7 -7
  14. data/lib/gocardless_pro/resources/mandate_import_entry.rb +3 -3
  15. data/lib/gocardless_pro/resources/mandate_pdf.rb +1 -1
  16. data/lib/gocardless_pro/resources/outbound_payment.rb +4 -4
  17. data/lib/gocardless_pro/resources/payer_authorisation.rb +3 -4
  18. data/lib/gocardless_pro/resources/payment.rb +6 -7
  19. data/lib/gocardless_pro/resources/payment_account.rb +1 -1
  20. data/lib/gocardless_pro/resources/payment_account_transaction.rb +1 -1
  21. data/lib/gocardless_pro/resources/payout.rb +5 -6
  22. data/lib/gocardless_pro/resources/redirect_flow.rb +12 -15
  23. data/lib/gocardless_pro/resources/refund.rb +5 -6
  24. data/lib/gocardless_pro/resources/subscription.rb +3 -4
  25. data/lib/gocardless_pro/resources/tax_rate.rb +1 -1
  26. data/lib/gocardless_pro/services/balances_service.rb +1 -1
  27. data/lib/gocardless_pro/services/bank_account_details_service.rb +1 -1
  28. data/lib/gocardless_pro/services/bank_details_lookups_service.rb +3 -3
  29. data/lib/gocardless_pro/services/billing_request_templates_service.rb +1 -1
  30. data/lib/gocardless_pro/services/billing_requests_service.rb +2 -2
  31. data/lib/gocardless_pro/services/blocks_service.rb +1 -1
  32. data/lib/gocardless_pro/services/creditor_bank_accounts_service.rb +1 -1
  33. data/lib/gocardless_pro/services/creditors_service.rb +1 -1
  34. data/lib/gocardless_pro/services/currency_exchange_rates_service.rb +1 -1
  35. data/lib/gocardless_pro/services/customer_bank_accounts_service.rb +4 -4
  36. data/lib/gocardless_pro/services/customers_service.rb +1 -1
  37. data/lib/gocardless_pro/services/events_service.rb +1 -1
  38. data/lib/gocardless_pro/services/instalment_schedules_service.rb +3 -3
  39. data/lib/gocardless_pro/services/logos_service.rb +1 -1
  40. data/lib/gocardless_pro/services/mandate_import_entries_service.rb +2 -2
  41. data/lib/gocardless_pro/services/mandate_imports_service.rb +1 -1
  42. data/lib/gocardless_pro/services/mandate_pdfs_service.rb +1 -1
  43. data/lib/gocardless_pro/services/mandates_service.rb +1 -1
  44. data/lib/gocardless_pro/services/negative_balance_limits_service.rb +1 -1
  45. data/lib/gocardless_pro/services/outbound_payment_import_entries_service.rb +1 -1
  46. data/lib/gocardless_pro/services/outbound_payment_imports_service.rb +1 -1
  47. data/lib/gocardless_pro/services/outbound_payments_service.rb +1 -1
  48. data/lib/gocardless_pro/services/payer_authorisations_service.rb +5 -5
  49. data/lib/gocardless_pro/services/payment_account_transactions_service.rb +3 -3
  50. data/lib/gocardless_pro/services/payment_accounts_service.rb +1 -1
  51. data/lib/gocardless_pro/services/payments_service.rb +4 -5
  52. data/lib/gocardless_pro/services/payout_items_service.rb +1 -1
  53. data/lib/gocardless_pro/services/payouts_service.rb +2 -2
  54. data/lib/gocardless_pro/services/redirect_flows_service.rb +8 -10
  55. data/lib/gocardless_pro/services/refunds_service.rb +1 -1
  56. data/lib/gocardless_pro/services/scheme_identifiers_service.rb +1 -1
  57. data/lib/gocardless_pro/services/subscriptions_service.rb +2 -2
  58. data/lib/gocardless_pro/services/tax_rates_service.rb +1 -1
  59. data/lib/gocardless_pro/services/webhooks_service.rb +1 -1
  60. data/lib/gocardless_pro/version.rb +1 -1
  61. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2fbb2b1d839a297b95fac3863d7f281e872bf53ddb887c1a4cbc0623c7b5fff9
4
- data.tar.gz: eec20a669e42a995af7c9f1074a41e80a4a53e6e416e5683e90cec45cd028b9b
3
+ metadata.gz: bac6cbcfd87f1ef9f62fe317348710faee079dd9026eb23f7a2148cfecfe1855
4
+ data.tar.gz: 7c6da5165b9e83f86d95824389b7d208d39ff815471eab754ea7e2978cd690db
5
5
  SHA512:
6
- metadata.gz: afc747c751aa25ba8d70c868b3863a81e8724dc51a711dd02d947552d06f38737a65a0e4f10d269c0a5f22df94718bc81c8b4a2c96cb2697d4996356a7514ebf
7
- data.tar.gz: a6ba0ad4f44baaf68c7a7b2a0ac80b846bc69e945cb22bf1dcd0ec9b7f2d14fdac6e9696ea372d9823019bd1293b265db857c08f60dd1e691c54e7d312682113
6
+ metadata.gz: b5c7327b2853e1effa1149ec44d445cee1e78c720308e5620a755ee7bb31671b3121b771685a5793e91eba6458030562d32ec7a38739a93bcef452f2288e53f1
7
+ data.tar.gz: ca796ae4c0be1c050d223323bfd89d34eca2826f5d287700c6ad1304d16f34cedca3504975c12f007caecdcf519504d3e5907f6356630283058b9343b8b648f5
@@ -283,7 +283,7 @@ module GoCardlessPro
283
283
  'User-Agent' => "#{user_agent}",
284
284
  'Content-Type' => 'application/json',
285
285
  'GoCardless-Client-Library' => 'gocardless-pro-ruby',
286
- 'GoCardless-Client-Version' => '4.22.0',
286
+ 'GoCardless-Client-Version' => '4.23.0',
287
287
  },
288
288
  }
289
289
  end
@@ -16,11 +16,12 @@ module GoCardlessPro
16
16
  # payment using their mobile banking app.
17
17
  #
18
18
  # See Billing Requests: Overview
19
- # (https://developer.gocardless.com/getting-started/billing-requests/overview/)
19
+ # (https://docs.gocardless.com/docs/collect-payments/setting-up-mandates)
20
20
  # for how-to's, explanations and tutorials. Important: All properties
21
21
  # associated with `subscription_request` and `instalment_schedule_request`
22
22
  # are only supported for ACH and PAD schemes.
23
23
  class BillingRequest
24
+ attr_reader :account_information_request
24
25
  attr_reader :actions
25
26
  attr_reader :created_at
26
27
  attr_reader :fallback_enabled
@@ -42,6 +43,7 @@ module GoCardlessPro
42
43
  def initialize(object, response = nil)
43
44
  @object = object
44
45
 
46
+ @account_information_request = object['account_information_request']
45
47
  @actions = object['actions']
46
48
  @created_at = object['created_at']
47
49
  @fallback_enabled = object['fallback_enabled']
@@ -80,6 +82,10 @@ module GoCardlessPro
80
82
  @links = links || {}
81
83
  end
82
84
 
85
+ def account_information_request
86
+ @links['account_information_request']
87
+ end
88
+
83
89
  def bank_authorisation
84
90
  @links['bank_authorisation']
85
91
  end
@@ -16,7 +16,7 @@ module GoCardlessPro
16
16
  # payment using their mobile banking app.
17
17
  #
18
18
  # See Billing Requests: Overview
19
- # (https://developer.gocardless.com/getting-started/billing-requests/overview/)
19
+ # (https://docs.gocardless.com/docs/collect-payments/setting-up-mandates)
20
20
  # for how-to's, explanations and tutorials.
21
21
  class BillingRequestWithAction
22
22
  attr_reader :bank_authorisations
@@ -10,8 +10,7 @@ module GoCardlessPro
10
10
  module Resources
11
11
  # Represents an instance of a creditor resource returned from the API
12
12
 
13
- # Each payment
14
- # (https://developer.gocardless.com/api-reference/#core-endpoints-payments)
13
+ # Each payment (https://docs.gocardless.com/docs/api-reference/payment)
15
14
  # taken through the API is linked to a "creditor", to whom the payment is
16
15
  # then paid out. In most cases your organisation will have a single
17
16
  # "creditor", but the API also supports collecting payments on behalf of
@@ -11,10 +11,9 @@ module GoCardlessPro
11
11
  # Represents an instance of a creditor_bank_account resource returned from the API
12
12
 
13
13
  # Creditor Bank Accounts hold the bank details of a creditor
14
- # (https://developer.gocardless.com/api-reference/#core-endpoints-creditors).
15
- # These are the bank accounts which your payouts
16
- # (https://developer.gocardless.com/api-reference/#core-endpoints-payouts)
17
- # will be sent to.
14
+ # (https://docs.gocardless.com/docs/api-reference/creditor). These are the
15
+ # bank accounts which your payouts
16
+ # (https://docs.gocardless.com/docs/api-reference/payout) will be sent to.
18
17
  #
19
18
  # Note that creditor bank accounts must be unique, and so you will encounter
20
19
  # a `bank_account_exists` error if you try to create a duplicate bank
@@ -12,9 +12,9 @@ module GoCardlessPro
12
12
 
13
13
  # Customer objects hold the contact details for a customer. A customer can
14
14
  # have several customer bank accounts
15
- # (https://developer.gocardless.com/api-reference/#core-endpoints-customer-bank-accounts),
15
+ # (https://docs.gocardless.com/docs/api-reference/customer-bank-account),
16
16
  # which in turn can have several Direct Debit mandates
17
- # (https://developer.gocardless.com/api-reference/#core-endpoints-mandates).
17
+ # (https://docs.gocardless.com/docs/api-reference/mandate).
18
18
  class Customer
19
19
  attr_reader :address_line1
20
20
  attr_reader :address_line2
@@ -11,11 +11,11 @@ module GoCardlessPro
11
11
  # Represents an instance of a customer_bank_account resource returned from the API
12
12
 
13
13
  # Customer Bank Accounts hold the bank details of a customer
14
- # (https://developer.gocardless.com/api-reference/#core-endpoints-customers).
15
- # They always belong to a customer
16
- # (https://developer.gocardless.com/api-reference/#core-endpoints-customers),
17
- # and may be linked to several Direct Debit mandates
18
- # (https://developer.gocardless.com/api-reference/#core-endpoints-mandates).
14
+ # (https://docs.gocardless.com/docs/api-reference/customer). They always
15
+ # belong to a customer
16
+ # (https://docs.gocardless.com/docs/api-reference/customer), and may be
17
+ # linked to several Direct Debit mandates
18
+ # (https://docs.gocardless.com/docs/api-reference/mandate).
19
19
  #
20
20
  # Note that customer bank accounts must be unique, and so you will encounter
21
21
  # a `bank_account_exists` error if you try to create a duplicate bank
@@ -26,7 +26,7 @@ module GoCardlessPro
26
26
  # Note: To ensure the customer's bank accounts are valid, verify them first
27
27
  # using
28
28
  # bank_details_lookups
29
- # (https://developer.gocardless.com/api-reference/#bank-details-lookups-perform-a-bank-details-lookup),
29
+ # (https://docs.gocardless.com/docs/api-reference/bank-details-lookup#perform-a-bank-details-lookup),
30
30
  # before proceeding with creating the accounts
31
31
  class CustomerBankAccount
32
32
  attr_reader :account_holder_name
@@ -15,8 +15,8 @@ module GoCardlessPro
15
15
  # mandate which has been transferred. Event creation is an asynchronous
16
16
  # process, so it can take some time between an action occurring and its
17
17
  # corresponding event getting included in API responses. See here
18
- # (https://developer.gocardless.com/api-reference/#event-types) for a
19
- # complete list of event types.
18
+ # (https://docs.gocardless.com/docs/api-reference/events) for a complete
19
+ # list of event types.
20
20
  #
21
21
  # Important: Events older than 18 months will be archived and no longer
22
22
  # accessible via the API or exports. Archival will begin no sooner than 1
@@ -11,8 +11,8 @@ module GoCardlessPro
11
11
  # Represents an instance of a institution resource returned from the API
12
12
 
13
13
  # Institutions that are supported when creating Bank Authorisations
14
- # (https://developer.gocardless.com/api-reference/#billing-requests-bank-authorisations)
15
- # for a particular country or purpose.
14
+ # (https://docs.gocardless.com/docs/api-reference/bank-authorisation) for a
15
+ # particular country or purpose.
16
16
  #
17
17
  # Not all institutions support both Payment Initiation (PIS) and Account
18
18
  # Information (AIS) services.
@@ -12,7 +12,7 @@ module GoCardlessPro
12
12
 
13
13
  # Logos are image uploads that, when associated with a creditor, are shown
14
14
  # on the billing request flow
15
- # (https://developer.gocardless.com/api-reference/#billing-requests-billing-request-flows)
15
+ # (https://docs.gocardless.com/docs/api-reference/billing-request-flow)
16
16
  # payment pages.
17
17
  class Logo
18
18
  attr_reader :id
@@ -11,11 +11,11 @@ module GoCardlessPro
11
11
  # Represents an instance of a mandate resource returned from the API
12
12
 
13
13
  # Mandates represent the Direct Debit mandate with a customer
14
- # (https://developer.gocardless.com/api-reference/#core-endpoints-customers).
14
+ # (https://docs.gocardless.com/docs/api-reference/customer).
15
15
  #
16
16
  # GoCardless will notify you via a webhook
17
- # (https://developer.gocardless.com/api-reference/#appendix-webhooks)
18
- # whenever the status of a mandate changes.
17
+ # (https://docs.gocardless.com/docs/api-reference/webhooks) whenever the
18
+ # status of a mandate changes.
19
19
  class Mandate
20
20
  attr_reader :authorisation_source
21
21
  attr_reader :consent_parameters
@@ -17,17 +17,17 @@ module GoCardlessPro
17
17
  # The process is as follows:
18
18
  #
19
19
  # 1. Create a mandate import
20
- # (https://developer.gocardless.com/api-reference/#mandate-imports-create-a-new-mandate-import)
20
+ # (https://docs.gocardless.com/docs/api-reference/mandate-import#create-a-new-mandate-import)
21
21
  # 2. Add entries
22
- # (https://developer.gocardless.com/api-reference/#mandate-import-entries-add-a-mandate-import-entry)
22
+ # (https://docs.gocardless.com/docs/api-reference/mandate-import-entry#add-a-mandate-import-entry)
23
23
  # to the import
24
24
  # 3. Submit
25
- # (https://developer.gocardless.com/api-reference/#mandate-imports-submit-a-mandate-import)
25
+ # (https://docs.gocardless.com/docs/api-reference/mandate-import#submit-a-mandate-import)
26
26
  # the import
27
27
  # 4. Wait until a member of the GoCardless team approves the import, at
28
28
  # which point the mandates will be created
29
29
  # 5. Link up the mandates
30
- # (https://developer.gocardless.com/api-reference/#mandate-import-entries-list-all-mandate-import-entries)
30
+ # (https://docs.gocardless.com/docs/api-reference/mandate-import-entry#list-all-mandate-import-entries)
31
31
  # in your system
32
32
  #
33
33
  # When you add entries to your mandate import, they are not turned into
@@ -40,14 +40,14 @@ module GoCardlessPro
40
40
  # We will issue a `mandate_created` webhook for each entry, which will be
41
41
  # the same as the webhooks
42
42
  # triggered when creating a mandate
43
- # (https://developer.gocardless.com/api-reference/#mandates-create-a-mandate)
43
+ # (https://docs.gocardless.com/docs/api-reference/mandate#create-a-mandate)
44
44
  # using the mandates API. Once these
45
45
  # webhooks start arriving, any reconciliation can now be accomplished by
46
46
  # checking the current status
47
- # (https://developer.gocardless.com/api-reference/#mandate-imports-get-a-mandate-import)
47
+ # (https://docs.gocardless.com/docs/api-reference/mandate-import#get-a-mandate-import)
48
48
  # of the mandate import and
49
49
  # linking up the mandates to your system
50
- # (https://developer.gocardless.com/api-reference/#mandate-import-entries-list-all-mandate-import-entries).
50
+ # (https://docs.gocardless.com/docs/api-reference/mandate-import-entry#list-all-mandate-import-entries).
51
51
  #
52
52
  # Note that all Mandate Imports have an upper limit of 30,000 entries, so we
53
53
  # recommend you split your import into several smaller imports if you're
@@ -11,7 +11,7 @@ module GoCardlessPro
11
11
  # Represents an instance of a mandate_import_entry resource returned from the API
12
12
 
13
13
  # Mandate Import Entries are added to a Mandate Import
14
- # (https://developer.gocardless.com/api-reference/#core-endpoints-mandate-imports).
14
+ # (https://docs.gocardless.com/docs/api-reference/mandate-import).
15
15
  # Each entry corresponds to one mandate to be imported into GoCardless.
16
16
  #
17
17
  # To import a mandate you will need:
@@ -19,7 +19,7 @@ module GoCardlessPro
19
19
  # 1. Identifying information about the customer (name/company and address)
20
20
  # 2. Bank account details, consisting of an account holder name and
21
21
  # either an IBAN or local bank details
22
- # (https://developer.gocardless.com/api-reference/#appendix-local-bank-details)
22
+ # (https://docs.gocardless.com/docs/api-reference/local-bank-details)
23
23
  # 3. Amendment details (SEPA only)
24
24
  #
25
25
  # We suggest you provide a `record_identifier` (which is unique within the
@@ -28,7 +28,7 @@ module GoCardlessPro
28
28
  # created once the
29
29
  # import has been processed by GoCardless. You can
30
30
  # list the mandate import entries
31
- # (https://developer.gocardless.com/api-reference/#mandate-import-entries-list-all-mandate-import-entries),
31
+ # (https://docs.gocardless.com/docs/api-reference/mandate-import-entry#list-all-mandate-import-entries),
32
32
  # match them up in your system using the `record_identifier`, and look at
33
33
  # the `links`
34
34
  # fields to find the mandate, customer and customer bank account that have
@@ -11,7 +11,7 @@ module GoCardlessPro
11
11
  # Represents an instance of a mandate_pdf resource returned from the API
12
12
 
13
13
  # Mandate PDFs allow you to easily display scheme-rules compliant
14
- # (https://developer.gocardless.com/api-reference/#appendix-compliance-requirements)
14
+ # (https://docs.gocardless.com/docs/api-reference/compliance-requirements)
15
15
  # Direct Debit mandates to your customers.
16
16
  class MandatePdf
17
17
  attr_reader :expires_at
@@ -11,12 +11,12 @@ module GoCardlessPro
11
11
  # Represents an instance of a outbound_payment resource returned from the API
12
12
 
13
13
  # Outbound Payments represent payments sent from creditors
14
- # (https://developer.gocardless.com/api-reference/#core-endpoints-creditors).
14
+ # (https://docs.gocardless.com/docs/api-reference/creditor).
15
15
  #
16
16
  # GoCardless will notify you via a webhook
17
- # (https://developer.gocardless.com/api-reference/#appendix-webhooks) when
18
- # the status of the outbound payment changes
19
- # (https://developer.gocardless.com/api-reference/#event-types-outbound-payment).
17
+ # (https://docs.gocardless.com/docs/api-reference/webhooks) when the status
18
+ # of the outbound payment changes
19
+ # (https://docs.gocardless.com/docs/api-reference/events/outbound-payment).
20
20
  #
21
21
  # Rate limiting
22
22
  #
@@ -15,7 +15,7 @@ module GoCardlessPro
15
15
  # It is deprecated in favour of
16
16
  #
17
17
  # Billing Requests
18
- # (https://developer.gocardless.com/getting-started/billing-requests/overview/).
18
+ # (https://docs.gocardless.com/docs/collect-payments/setting-up-mandates).
19
19
  # Use Billing Requests to build any future integrations.
20
20
  #
21
21
  # Payer Authorisation resource acts as a wrapper for creating customer, bank
@@ -43,10 +43,9 @@ module GoCardlessPro
43
43
  # the following:
44
44
  #
45
45
  # 1. Listen to payer_authorisation_completed webhook
46
- # (https://developer.gocardless.com/api-reference/#appendix-webhooks)
47
- # (recommended)
46
+ # (https://docs.gocardless.com/docs/api-reference/webhooks) (recommended)
48
47
  # 2. Poll the GET endpoint
49
- # (https://developer.gocardless.com/api-reference/#payer-authorisations-get-a-single-payer-authorisation)
48
+ # (https://docs.gocardless.com/docs/api-reference/payer-authorisation#get-a-single-payer-authorisation)
50
49
  # 3. Poll the GET events API
51
50
  # https://api.gocardless.com/events?payer_authorisation={id}&action=completed
52
51
  #
@@ -11,15 +11,14 @@ module GoCardlessPro
11
11
  # Represents an instance of a payment resource returned from the API
12
12
 
13
13
  # Payment objects represent payments from a customer
14
- # (https://developer.gocardless.com/api-reference/#core-endpoints-customers)
15
- # to a creditor
16
- # (https://developer.gocardless.com/api-reference/#core-endpoints-creditors),
17
- # taken against a Direct Debit mandate
18
- # (https://developer.gocardless.com/api-reference/#core-endpoints-mandates).
14
+ # (https://docs.gocardless.com/docs/api-reference/customer) to a creditor
15
+ # (https://docs.gocardless.com/docs/api-reference/creditor), taken against a
16
+ # Direct Debit mandate
17
+ # (https://docs.gocardless.com/docs/api-reference/mandate).
19
18
  #
20
19
  # GoCardless will notify you via a webhook
21
- # (https://developer.gocardless.com/api-reference/#appendix-webhooks)
22
- # whenever the state of a payment changes.
20
+ # (https://docs.gocardless.com/docs/api-reference/webhooks) whenever the
21
+ # state of a payment changes.
23
22
  class Payment
24
23
  attr_reader :amount
25
24
  attr_reader :amount_refunded
@@ -12,7 +12,7 @@ module GoCardlessPro
12
12
 
13
13
  # Access the details of bank accounts provided for you by GoCardless that
14
14
  # are used to fund Outbound Payments
15
- # (https://developer.gocardless.com/api-reference/#core-endpoints-outbound-payments).
15
+ # (https://docs.gocardless.com/docs/api-reference/outbound-payment).
16
16
  class PaymentAccount
17
17
  attr_reader :account_balance
18
18
  attr_reader :account_holder_name
@@ -13,7 +13,7 @@ module GoCardlessPro
13
13
  # Payment account transactions represent movements of funds on a given
14
14
  # payment account. The payment account is provisioned by GoCardless and is
15
15
  # used to fund outbound payments
16
- # (https://developer.gocardless.com/api-reference/#core-endpoints-outbound-payments).
16
+ # (https://docs.gocardless.com/docs/api-reference/outbound-payment).
17
17
  class PaymentAccountTransaction
18
18
  attr_reader :amount
19
19
  attr_reader :balance_after_transaction
@@ -11,12 +11,11 @@ module GoCardlessPro
11
11
  # Represents an instance of a payout resource returned from the API
12
12
 
13
13
  # Payouts represent transfers from GoCardless to a creditor
14
- # (https://developer.gocardless.com/api-reference/#core-endpoints-creditors).
15
- # Each payout contains the funds collected from one or many payments
16
- # (https://developer.gocardless.com/api-reference/#core-endpoints-payments).
17
- # All the payments in a payout will have been collected in the same
18
- # currency. Payouts are created automatically after a payment has been
19
- # successfully collected.
14
+ # (https://docs.gocardless.com/docs/api-reference/creditor). Each payout
15
+ # contains the funds collected from one or many payments
16
+ # (https://docs.gocardless.com/docs/api-reference/payment). All the payments
17
+ # in a payout will have been collected in the same currency. Payouts are
18
+ # created automatically after a payment has been successfully collected.
20
19
  class Payout
21
20
  attr_reader :amount
22
21
  attr_reader :arrival_date
@@ -13,8 +13,8 @@ module GoCardlessPro
13
13
  # Deprecated: Redirect Flows are legacy APIs and cannot be used by new
14
14
  # integrators.
15
15
  # The Billing Request flow
16
- # (https://developer.gocardless.com/api-reference/#billing-requests-billing-requests)
17
- # API should be used for your payment flows.
16
+ # (https://docs.gocardless.com/docs/api-reference/billing-request) API
17
+ # should be used for your payment flows.
18
18
  #
19
19
  # Redirect flows enable you to use GoCardless' hosted payment pages
20
20
  # (https://pay-sandbox.gocardless.com/AL000000AKFPFF) to set up mandates
@@ -26,7 +26,7 @@ module GoCardlessPro
26
26
  #
27
27
  # 1.
28
28
  # You create
29
- # (https://developer.gocardless.com/api-reference/#redirect-flows-create-a-redirect-flow)
29
+ # (https://docs.gocardless.com/docs/api-reference/redirect-flow#create-a-redirect-flow)
30
30
  # a redirect flow for your customer, and redirect them to the returned
31
31
  # redirect url, e.g. `https://pay.gocardless.com/flow/RE123`.
32
32
  # 2.
@@ -36,21 +36,18 @@ module GoCardlessPro
36
36
  # `redirect_flow_id=RE123` in the querystring.
37
37
  # 3.
38
38
  # You complete
39
- # (https://developer.gocardless.com/api-reference/#redirect-flows-complete-a-redirect-flow)
39
+ # (https://docs.gocardless.com/docs/api-reference/redirect-flow#complete-a-redirect-flow)
40
40
  # the redirect flow, which creates a customer
41
- # (https://developer.gocardless.com/api-reference/#core-endpoints-customers),
42
- # customer bank account
43
- # (https://developer.gocardless.com/api-reference/#core-endpoints-customer-bank-accounts),
44
- # and mandate
45
- # (https://developer.gocardless.com/api-reference/#core-endpoints-mandates),
46
- # and returns the ID of the mandate. You may wish to create a subscription
47
- # (https://developer.gocardless.com/api-reference/#core-endpoints-subscriptions)
48
- # or payment
49
- # (https://developer.gocardless.com/api-reference/#core-endpoints-payments)
50
- # at this point.
41
+ # (https://docs.gocardless.com/docs/api-reference/customer), customer bank
42
+ # account
43
+ # (https://docs.gocardless.com/docs/api-reference/customer-bank-account),
44
+ # and mandate (https://docs.gocardless.com/docs/api-reference/mandate), and
45
+ # returns the ID of the mandate. You may wish to create a subscription
46
+ # (https://docs.gocardless.com/docs/api-reference/subscription) or payment
47
+ # (https://docs.gocardless.com/docs/api-reference/payment) at this point.
51
48
  #
52
49
  # Once you have completed
53
- # (https://developer.gocardless.com/api-reference/#redirect-flows-complete-a-redirect-flow)
50
+ # (https://docs.gocardless.com/docs/api-reference/redirect-flow#complete-a-redirect-flow)
54
51
  # the redirect flow via the API, you should display a confirmation page to
55
52
  # your customer, confirming that their Direct Debit has been set up. You can
56
53
  # build your own page, or redirect to the one we provide in the
@@ -11,14 +11,13 @@ module GoCardlessPro
11
11
  # Represents an instance of a refund resource returned from the API
12
12
 
13
13
  # Refund objects represent (partial) refunds of a payment
14
- # (https://developer.gocardless.com/api-reference/#core-endpoints-payments)
15
- # back to the customer
16
- # (https://developer.gocardless.com/api-reference/#core-endpoints-customers).
14
+ # (https://docs.gocardless.com/docs/api-reference/payment) back to the
15
+ # customer (https://docs.gocardless.com/docs/api-reference/customer).
17
16
  #
18
17
  # GoCardless will notify you via a webhook
19
- # (https://developer.gocardless.com/api-reference/#appendix-webhooks)
20
- # whenever a refund is created, and will update the `amount_refunded`
21
- # property of the payment.
18
+ # (https://docs.gocardless.com/docs/api-reference/webhooks) whenever a
19
+ # refund is created, and will update the `amount_refunded` property of the
20
+ # payment.
22
21
  class Refund
23
22
  attr_reader :amount
24
23
  attr_reader :created_at
@@ -11,16 +11,15 @@ module GoCardlessPro
11
11
  # Represents an instance of a subscription resource returned from the API
12
12
 
13
13
  # Subscriptions create payments
14
- # (https://developer.gocardless.com/api-reference/#core-endpoints-payments)
15
- # according to a schedule.
14
+ # (https://docs.gocardless.com/docs/api-reference/payment) according to a
15
+ # schedule.
16
16
  #
17
17
  # Recurrence Rules
18
18
  #
19
19
  # The following rules apply when specifying recurrence:
20
20
  #
21
21
  # - If `day_of_month` and `start_date` are not provided `start_date` will be
22
- # the mandate
23
- # (https://developer.gocardless.com/api-reference/#core-endpoints-mandates)'s
22
+ # the mandate (https://docs.gocardless.com/docs/api-reference/mandate)'s
24
23
  # `next_possible_charge_date` and the subscription will then recur based on
25
24
  # the `interval` & `interval_unit`
26
25
  # - If `month` or `day_of_month` are present the following validations
@@ -13,7 +13,7 @@ module GoCardlessPro
13
13
  # Tax rates from tax authority.
14
14
  #
15
15
  # We also maintain a static list of the tax rates for each jurisdiction
16
- # (https://developer.gocardless.com/api-reference/#appendix-tax-rates).
16
+ # (https://docs.gocardless.com/docs/api-reference/tax-rates).
17
17
  class TaxRate
18
18
  attr_reader :end_date
19
19
  attr_reader :id
@@ -11,7 +11,7 @@ module GoCardlessPro
11
11
  # Service for making requests to the Balance endpoints
12
12
  class BalancesService < BaseService
13
13
  # Returns a cursor-paginated
14
- # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
14
+ # (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
15
15
  # list of balances for a given creditor. This endpoint is rate limited to 60
16
16
  # requests per minute.
17
17
  # Example URL: /balances
@@ -15,7 +15,7 @@ module GoCardlessPro
15
15
  #
16
16
  # You must specify a `Gc-Key-Id` header when using this endpoint. See Public Key
17
17
  # Setup
18
- # (https://developer.gocardless.com/gc-embed/bank-details-access#public_key_setup)
18
+ # (https://docs.gocardless.com/docs/gc-embed/bank-details-access#public-key-setup)
19
19
  # for more details.
20
20
  # Example URL: /bank_account_details/:identity
21
21
  #
@@ -24,7 +24,7 @@ module GoCardlessPro
24
24
  # "Account holder name does not match bank account details provided".
25
25
  #
26
26
  # If your request returns an error
27
- # (https://developer.gocardless.com/api-reference/#api-usage-errors) or the
27
+ # (https://docs.gocardless.com/docs/api-reference/responses-and-errors) or the
28
28
  # `available_debit_schemes`
29
29
  # attribute is an empty array, you will not be able to collect payments from the
30
30
  # specified bank account. GoCardless may be able to collect payments from an
@@ -32,8 +32,8 @@ module GoCardlessPro
32
32
  # even if no `bic` is returned.
33
33
  #
34
34
  # Bank account details may be supplied using local details
35
- # (https://developer.gocardless.com/api-reference/#appendix-local-bank-details)
36
- # or an IBAN.
35
+ # (https://docs.gocardless.com/docs/api-reference/local-bank-details) or an
36
+ # IBAN.
37
37
  #
38
38
  # ACH scheme For compliance reasons, an extra validation step is done using
39
39
  # a third-party provider to make sure the customer's bank account can accept
@@ -11,7 +11,7 @@ module GoCardlessPro
11
11
  # Service for making requests to the BillingRequestTemplate endpoints
12
12
  class BillingRequestTemplatesService < BaseService
13
13
  # Returns a cursor-paginated
14
- # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
14
+ # (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
15
15
  # list of your Billing Request Templates.
16
16
  # Example URL: /billing_request_templates
17
17
  # @param options [Hash] parameters as a hash, under a params key.
@@ -120,7 +120,7 @@ module GoCardlessPro
120
120
  # return a 422 - validation error on account_holder_name:
121
121
  # "Account holder name does not match bank account details provided". Testing
122
122
  # instructions are here
123
- # (https://developer.gocardless.com/developer-tools/scenario-simulators/#payer_name_verification)
123
+ # (https://docs.gocardless.com/docs/developer-resources/scenario-simulators#payer-name-verification)
124
124
  # Example URL: /billing_requests/:identity/actions/collect_bank_account
125
125
  #
126
126
  # @param identity # Unique identifier, beginning with "BRQ".
@@ -281,7 +281,7 @@ module GoCardlessPro
281
281
  end
282
282
 
283
283
  # Returns a cursor-paginated
284
- # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
284
+ # (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
285
285
  # list of your billing requests.
286
286
  # Example URL: /billing_requests
287
287
  # @param options [Hash] parameters as a hash, under a params key.
@@ -65,7 +65,7 @@ module GoCardlessPro
65
65
  end
66
66
 
67
67
  # Returns a cursor-paginated
68
- # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
68
+ # (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
69
69
  # list of your blocks.
70
70
  # Example URL: /blocks
71
71
  # @param options [Hash] parameters as a hash, under a params key.
@@ -46,7 +46,7 @@ module GoCardlessPro
46
46
  end
47
47
 
48
48
  # Returns a cursor-paginated
49
- # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
49
+ # (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
50
50
  # list of your creditor bank accounts.
51
51
  # Example URL: /creditor_bank_accounts
52
52
  # @param options [Hash] parameters as a hash, under a params key.
@@ -46,7 +46,7 @@ module GoCardlessPro
46
46
  end
47
47
 
48
48
  # Returns a cursor-paginated
49
- # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
49
+ # (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
50
50
  # list of your creditors.
51
51
  # Example URL: /creditors
52
52
  # @param options [Hash] parameters as a hash, under a params key.
@@ -11,7 +11,7 @@ module GoCardlessPro
11
11
  # Service for making requests to the CurrencyExchangeRate endpoints
12
12
  class CurrencyExchangeRatesService < BaseService
13
13
  # Returns a cursor-paginated
14
- # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
14
+ # (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
15
15
  # list of all exchange rates.
16
16
  # Example URL: /currency_exchange_rates
17
17
  # @param options [Hash] parameters as a hash, under a params key.
@@ -16,16 +16,16 @@ module GoCardlessPro
16
16
  #
17
17
  # -
18
18
  # Local details
19
- # (https://developer.gocardless.com/api-reference/#appendix-local-bank-details)
19
+ # (https://docs.gocardless.com/docs/api-reference/local-bank-details)
20
20
  # -
21
21
  # IBAN
22
22
  # -
23
23
  # Customer Bank Account Tokens
24
- # (https://developer.gocardless.com/api-reference/#javascript-flow-create-a-customer-bank-account-token)
24
+ # (https://docs.gocardless.com/docs/collect-payments/integration-types/javascript-drop-in-flow)
25
25
  #
26
26
  # For more information on the different fields required in each country, see
27
27
  # local bank details
28
- # (https://developer.gocardless.com/api-reference/#appendix-local-bank-details).
28
+ # (https://docs.gocardless.com/docs/api-reference/local-bank-details).
29
29
  # Example URL: /customer_bank_accounts
30
30
  # @param options [Hash] parameters as a hash, under a params key.
31
31
  def create(options = {})
@@ -61,7 +61,7 @@ module GoCardlessPro
61
61
  end
62
62
 
63
63
  # Returns a cursor-paginated
64
- # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
64
+ # (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
65
65
  # list of your bank accounts.
66
66
  # Example URL: /customer_bank_accounts
67
67
  # @param options [Hash] parameters as a hash, under a params key.
@@ -46,7 +46,7 @@ module GoCardlessPro
46
46
  end
47
47
 
48
48
  # Returns a cursor-paginated
49
- # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
49
+ # (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
50
50
  # list of your customers.
51
51
  # Example URL: /customers
52
52
  # @param options [Hash] parameters as a hash, under a params key.
@@ -11,7 +11,7 @@ module GoCardlessPro
11
11
  # Service for making requests to the Event endpoints
12
12
  class EventsService < BaseService
13
13
  # Returns a cursor-paginated
14
- # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
14
+ # (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
15
15
  # list of your events.
16
16
  #
17
17
  # Important: This endpoint will no longer return events older than 18 months,
@@ -15,7 +15,7 @@ module GoCardlessPro
15
15
  # API is recommended if you know the specific dates you wish to charge.
16
16
  # Otherwise,
17
17
  # please check out the scheduling version
18
- # (https://developer.gocardless.com/api-reference/#instalment-schedules-create-with-schedule).
18
+ # (https://docs.gocardless.com/docs/api-reference/instalment-schedule#create-with-schedule).
19
19
  #
20
20
  # The `instalments` property is an array of payment properties (`amount` and
21
21
  # `charge_date`).
@@ -69,7 +69,7 @@ module GoCardlessPro
69
69
  # finer
70
70
  # control over the individual dates, please check out the alternative
71
71
  # version
72
- # (https://developer.gocardless.com/api-reference/#instalment-schedules-create-with-dates).
72
+ # (https://docs.gocardless.com/docs/api-reference/instalment-schedule#create-with-schedule).
73
73
  #
74
74
  # It can take quite a while to create the associated payments, so the API will
75
75
  # return
@@ -113,7 +113,7 @@ module GoCardlessPro
113
113
  end
114
114
 
115
115
  # Returns a cursor-paginated
116
- # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
116
+ # (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
117
117
  # list of your instalment schedules.
118
118
  # Example URL: /instalment_schedules
119
119
  # @param options [Hash] parameters as a hash, under a params key.
@@ -16,7 +16,7 @@ module GoCardlessPro
16
16
  # We support JPG and PNG formats. Your logo will be scaled to a maximum of 300px
17
17
  # by 40px. For more guidance on how to upload logos that will look
18
18
  # great across your customer payment page and notification emails see here
19
- # (https://developer.gocardless.com/gc-embed/setting-up-branding#tips_for_uploading_your_logo).
19
+ # (https://docs.gocardless.com/docs/gc-embed/setting-up-branding#tips-for-uploading-your-logo).
20
20
  # Example URL: /branding/logos
21
21
  # @param options [Hash] parameters as a hash, under a params key.
22
22
  def create_for_creditor(options = {})
@@ -11,8 +11,8 @@ module GoCardlessPro
11
11
  # Service for making requests to the MandateImportEntry endpoints
12
12
  class MandateImportEntriesService < BaseService
13
13
  # For an existing mandate import
14
- # (https://developer.gocardless.com/api-reference/#core-endpoints-mandate-imports),
15
- # this endpoint can
14
+ # (https://docs.gocardless.com/docs/api-reference/mandate-import), this endpoint
15
+ # can
16
16
  # be used to add individual mandates to be imported into GoCardless.
17
17
  #
18
18
  # You can add no more than 30,000 rows to a single mandate import.
@@ -15,7 +15,7 @@ module GoCardlessPro
15
15
  # finished
16
16
  # adding entries to an import, you should
17
17
  # submit
18
- # (https://developer.gocardless.com/api-reference/#mandate-imports-submit-a-mandate-import)
18
+ # (https://docs.gocardless.com/docs/api-reference/mandate-import#submit-a-mandate-import)
19
19
  # it.
20
20
  # Example URL: /mandate_imports
21
21
  # @param options [Hash] parameters as a hash, under a params key.
@@ -14,7 +14,7 @@ module GoCardlessPro
14
14
  #
15
15
  # Customer and bank account details can be left blank (for a blank mandate),
16
16
  # provided manually, or inferred from the ID of an existing mandate
17
- # (https://developer.gocardless.com/api-reference/#core-endpoints-mandates).
17
+ # (https://docs.gocardless.com/docs/api-reference/mandate).
18
18
  #
19
19
  # By default, we'll generate PDF mandates in English.
20
20
  #
@@ -46,7 +46,7 @@ module GoCardlessPro
46
46
  end
47
47
 
48
48
  # Returns a cursor-paginated
49
- # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
49
+ # (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
50
50
  # list of your mandates.
51
51
  # Example URL: /mandates
52
52
  # @param options [Hash] parameters as a hash, under a params key.
@@ -11,7 +11,7 @@ module GoCardlessPro
11
11
  # Service for making requests to the NegativeBalanceLimit endpoints
12
12
  class NegativeBalanceLimitsService < BaseService
13
13
  # Returns a cursor-paginated
14
- # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
14
+ # (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
15
15
  # list of negative balance limits.
16
16
  # Example URL: /negative_balance_limits
17
17
  # @param options [Hash] parameters as a hash, under a params key.
@@ -11,7 +11,7 @@ module GoCardlessPro
11
11
  # Service for making requests to the OutboundPaymentImportEntry endpoints
12
12
  class OutboundPaymentImportEntriesService < BaseService
13
13
  # Returns a cursor-paginated
14
- # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
14
+ # (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
15
15
  # list of the entries for a given outbound payment import.
16
16
  # Example URL: /outbound_payment_import_entries
17
17
  # @param options [Hash] parameters as a hash, under a params key.
@@ -65,7 +65,7 @@ module GoCardlessPro
65
65
  end
66
66
 
67
67
  # Returns a cursor-paginated
68
- # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
68
+ # (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
69
69
  # list of your outbound payment imports.
70
70
  # Example URL: /outbound_payment_imports
71
71
  # @param options [Hash] parameters as a hash, under a params key.
@@ -183,7 +183,7 @@ module GoCardlessPro
183
183
  end
184
184
 
185
185
  # Returns a cursor-paginated
186
- # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
186
+ # (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
187
187
  # list of outbound payments.
188
188
  # Example URL: /outbound_payments
189
189
  # @param options [Hash] parameters as a hash, under a params key.
@@ -16,7 +16,7 @@ module GoCardlessPro
16
16
  #
17
17
  # @param identity # Unique identifier, beginning with "PA".
18
18
  # @param options [Hash] parameters as a hash, under a params key.
19
- # @deprecated Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for any new integrations.
19
+ # @deprecated Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://docs.gocardless.com/docs/api-reference/billing-request) API should be used for any new integrations.
20
20
  def get(identity, options = {})
21
21
  path = sub_url('/payer_authorisations/:identity', {
22
22
  'identity' => identity,
@@ -39,7 +39,7 @@ module GoCardlessPro
39
39
  # solution, such as a multi-step form.
40
40
  # Example URL: /payer_authorisations
41
41
  # @param options [Hash] parameters as a hash, under a params key.
42
- # @deprecated Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for any new integrations.
42
+ # @deprecated Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://docs.gocardless.com/docs/api-reference/billing-request) API should be used for any new integrations.
43
43
  def create(options = {})
44
44
  path = '/payer_authorisations'
45
45
 
@@ -84,7 +84,7 @@ module GoCardlessPro
84
84
  #
85
85
  # @param identity # Unique identifier, beginning with "PA".
86
86
  # @param options [Hash] parameters as a hash, under a params key.
87
- # @deprecated Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for any new integrations.
87
+ # @deprecated Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://docs.gocardless.com/docs/api-reference/billing-request) API should be used for any new integrations.
88
88
  def update(identity, options = {})
89
89
  path = sub_url('/payer_authorisations/:identity', {
90
90
  'identity' => identity,
@@ -111,7 +111,7 @@ module GoCardlessPro
111
111
  #
112
112
  # @param identity # Unique identifier, beginning with "PA".
113
113
  # @param options [Hash] parameters as a hash, under a params key.
114
- # @deprecated Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for any new integrations.
114
+ # @deprecated Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://docs.gocardless.com/docs/api-reference/billing-request) API should be used for any new integrations.
115
115
  def submit(identity, options = {})
116
116
  path = sub_url('/payer_authorisations/:identity/actions/submit', {
117
117
  'identity' => identity,
@@ -159,7 +159,7 @@ module GoCardlessPro
159
159
  #
160
160
  # @param identity # Unique identifier, beginning with "PA".
161
161
  # @param options [Hash] parameters as a hash, under a params key.
162
- # @deprecated Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for any new integrations.
162
+ # @deprecated Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://docs.gocardless.com/docs/api-reference/billing-request) API should be used for any new integrations.
163
163
  def confirm(identity, options = {})
164
164
  path = sub_url('/payer_authorisations/:identity/actions/confirm', {
165
165
  'identity' => identity,
@@ -14,7 +14,7 @@ module GoCardlessPro
14
14
  # Example URL: /payment_account_transactions/:identity
15
15
  #
16
16
  # @param identity # The unique ID of the bank account
17
- # (https://developer.gocardless.com/api-reference/#core-endpoints-creditor-bank-accounts)
17
+ # (https://docs.gocardless.com/docs/api-reference/creditor-bank-account)
18
18
  # which happens to be the payment account.
19
19
  # @param options [Hash] parameters as a hash, under a params key.
20
20
  def get(identity, options = {})
@@ -35,7 +35,7 @@ module GoCardlessPro
35
35
  # Example URL: /payment_accounts/:identity/transactions
36
36
  #
37
37
  # @param identity # The unique ID of the bank account
38
- # (https://developer.gocardless.com/api-reference/#core-endpoints-creditor-bank-accounts)
38
+ # (https://docs.gocardless.com/docs/api-reference/creditor-bank-account)
39
39
  # which happens to be the payment account.
40
40
  # @param options [Hash] parameters as a hash, under a params key.
41
41
  def list(identity, options = {})
@@ -57,7 +57,7 @@ module GoCardlessPro
57
57
  # Get a lazily enumerated list of all the items returned. This is similar to the `list` method but will paginate for you automatically.
58
58
  #
59
59
  # @param identity # The unique ID of the bank account
60
- # (https://developer.gocardless.com/api-reference/#core-endpoints-creditor-bank-accounts)
60
+ # (https://docs.gocardless.com/docs/api-reference/creditor-bank-account)
61
61
  # which happens to be the payment account.
62
62
  # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
63
63
  # Otherwise they will be the body of the request.
@@ -30,7 +30,7 @@ module GoCardlessPro
30
30
  end
31
31
 
32
32
  # Returns a cursor-paginated
33
- # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
33
+ # (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
34
34
  # list of your payment accounts.
35
35
  # Example URL: /payment_accounts
36
36
  # @param options [Hash] parameters as a hash, under a params key.
@@ -13,10 +13,9 @@ module GoCardlessPro
13
13
  # Creates a new payment object.
14
14
  #
15
15
  # This fails with a `mandate_is_inactive` error if the linked mandate
16
- # (https://developer.gocardless.com/api-reference/#core-endpoints-mandates) is
17
- # cancelled or has failed. Payments can be created against mandates with status
18
- # of: `pending_customer_approval`, `pending_submission`, `submitted`, and
19
- # `active`.
16
+ # (https://docs.gocardless.com/docs/api-reference/mandate) is cancelled or has
17
+ # failed. Payments can be created against mandates with status of:
18
+ # `pending_customer_approval`, `pending_submission`, `submitted`, and `active`.
20
19
  # Example URL: /payments
21
20
  # @param options [Hash] parameters as a hash, under a params key.
22
21
  def create(options = {})
@@ -52,7 +51,7 @@ module GoCardlessPro
52
51
  end
53
52
 
54
53
  # Returns a cursor-paginated
55
- # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
54
+ # (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
56
55
  # list of your payments.
57
56
  # Example URL: /payments
58
57
  # @param options [Hash] parameters as a hash, under a params key.
@@ -11,7 +11,7 @@ module GoCardlessPro
11
11
  # Service for making requests to the PayoutItem endpoints
12
12
  class PayoutItemsService < BaseService
13
13
  # Returns a cursor-paginated
14
- # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
14
+ # (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
15
15
  # list of items in the payout.
16
16
  #
17
17
  # This endpoint only serves requests for payouts created in the last 6 months.
@@ -11,7 +11,7 @@ module GoCardlessPro
11
11
  # Service for making requests to the Payout endpoints
12
12
  class PayoutsService < BaseService
13
13
  # Returns a cursor-paginated
14
- # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
14
+ # (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
15
15
  # list of your payouts.
16
16
  # Example URL: /payouts
17
17
  # @param options [Hash] parameters as a hash, under a params key.
@@ -42,7 +42,7 @@ module GoCardlessPro
42
42
 
43
43
  # Retrieves the details of a single payout. For an example of how to reconcile
44
44
  # the transactions in a payout, see this guide
45
- # (https://developer.gocardless.com/api-reference/#events-reconciling-payouts-with-events).
45
+ # (https://docs.gocardless.com/docs/collect-payments/managing-payments/reconciling-payouts).
46
46
  # Example URL: /payouts/:identity
47
47
  #
48
48
  # @param identity # Unique identifier, beginning with "PO".
@@ -14,7 +14,7 @@ module GoCardlessPro
14
14
  # customer to the GoCardless hosted payment pages.
15
15
  # Example URL: /redirect_flows
16
16
  # @param options [Hash] parameters as a hash, under a params key.
17
- # @deprecated Redirect Flows are legacy APIs and cannot be used by new integrators. The Billing Request flow (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for your payment flows.
17
+ # @deprecated Redirect Flows are legacy APIs and cannot be used by new integrators. The Billing Request flow (https://docs.gocardless.com/docs/api-reference/billing-request) API should be used for your payment flows.
18
18
  def create(options = {})
19
19
  path = '/redirect_flows'
20
20
 
@@ -52,7 +52,7 @@ module GoCardlessPro
52
52
  #
53
53
  # @param identity # Unique identifier, beginning with "RE".
54
54
  # @param options [Hash] parameters as a hash, under a params key.
55
- # @deprecated Redirect Flows are legacy APIs and cannot be used by new integrators. The Billing Request flow (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for your payment flows.
55
+ # @deprecated Redirect Flows are legacy APIs and cannot be used by new integrators. The Billing Request flow (https://docs.gocardless.com/docs/api-reference/billing-request) API should be used for your payment flows.
56
56
  def get(identity, options = {})
57
57
  path = sub_url('/redirect_flows/:identity', {
58
58
  'identity' => identity,
@@ -68,13 +68,11 @@ module GoCardlessPro
68
68
  end
69
69
 
70
70
  # This creates a customer
71
- # (https://developer.gocardless.com/api-reference/#core-endpoints-customers),
72
- # customer bank account
73
- # (https://developer.gocardless.com/api-reference/#core-endpoints-customer-bank-accounts),
74
- # and mandate
75
- # (https://developer.gocardless.com/api-reference/#core-endpoints-mandates)
76
- # using the details supplied by your customer and returns the ID of the created
77
- # mandate.
71
+ # (https://docs.gocardless.com/docs/api-reference/customer), customer bank
72
+ # account
73
+ # (https://docs.gocardless.com/docs/api-reference/customer-bank-account), and
74
+ # mandate (https://docs.gocardless.com/docs/api-reference/mandate) using the
75
+ # details supplied by your customer and returns the ID of the created mandate.
78
76
  #
79
77
  # This will return a `redirect_flow_incomplete` error if your customer has not
80
78
  # yet been redirected back to your site, and a `redirect_flow_already_completed`
@@ -85,7 +83,7 @@ module GoCardlessPro
85
83
  #
86
84
  # @param identity # Unique identifier, beginning with "RE".
87
85
  # @param options [Hash] parameters as a hash, under a params key.
88
- # @deprecated Redirect Flows are legacy APIs and cannot be used by new integrators. The Billing Request flow (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for your payment flows.
86
+ # @deprecated Redirect Flows are legacy APIs and cannot be used by new integrators. The Billing Request flow (https://docs.gocardless.com/docs/api-reference/billing-request) API should be used for your payment flows.
89
87
  def complete(identity, options = {})
90
88
  path = sub_url('/redirect_flows/:identity/actions/complete', {
91
89
  'identity' => identity,
@@ -57,7 +57,7 @@ module GoCardlessPro
57
57
  end
58
58
 
59
59
  # Returns a cursor-paginated
60
- # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
60
+ # (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
61
61
  # list of your refunds.
62
62
  # Example URL: /refunds
63
63
  # @param options [Hash] parameters as a hash, under a params key.
@@ -84,7 +84,7 @@ module GoCardlessPro
84
84
  end
85
85
 
86
86
  # Returns a cursor-paginated
87
- # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
87
+ # (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
88
88
  # list of your scheme identifiers.
89
89
  # Example URL: /scheme_identifiers
90
90
  # @param options [Hash] parameters as a hash, under a params key.
@@ -46,7 +46,7 @@ module GoCardlessPro
46
46
  end
47
47
 
48
48
  # Returns a cursor-paginated
49
- # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
49
+ # (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
50
50
  # list of your subscriptions. Please note if the subscriptions are related to
51
51
  # customers who have been removed, they will not be shown in the response.
52
52
  # Example URL: /subscriptions
@@ -151,7 +151,7 @@ module GoCardlessPro
151
151
  #
152
152
  # When `pause_cycles` is omitted the subscription is paused until the resume
153
153
  # endpoint
154
- # (https://developer.gocardless.com/api-reference/#subscriptions-resume-a-subscription)
154
+ # (https://docs.gocardless.com/docs/api-reference/subscription#resume-a-subscription)
155
155
  # is called.
156
156
  # If the subscription is collecting a fixed number of payments, `end_date` will
157
157
  # be set to `null`.
@@ -11,7 +11,7 @@ module GoCardlessPro
11
11
  # Service for making requests to the TaxRate endpoints
12
12
  class TaxRatesService < BaseService
13
13
  # Returns a cursor-paginated
14
- # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
14
+ # (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
15
15
  # list of all tax rates.
16
16
  # Example URL: /tax_rates
17
17
  # @param options [Hash] parameters as a hash, under a params key.
@@ -11,7 +11,7 @@ module GoCardlessPro
11
11
  # Service for making requests to the Webhook endpoints
12
12
  class WebhooksService < BaseService
13
13
  # Returns a cursor-paginated
14
- # (https://developer.gocardless.com/api-reference/#api-usage-cursor-pagination)
14
+ # (https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination)
15
15
  # list of your webhooks.
16
16
  # Example URL: /webhooks
17
17
  # @param options [Hash] parameters as a hash, under a params key.
@@ -3,5 +3,5 @@ end
3
3
 
4
4
  module GoCardlessPro
5
5
  # Current version of the GC gem
6
- VERSION = '4.22.0'
6
+ VERSION = '4.23.0'
7
7
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: gocardless_pro
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.22.0
4
+ version: 4.23.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - GoCardless