checkout_sdk 2.7.1 → 2.8.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 (54) hide show
  1. checksums.yaml +4 -4
  2. data/lib/checkout_sdk/api_client.rb +3 -2
  3. data/lib/checkout_sdk/common/account_holder.rb +78 -1
  4. data/lib/checkout_sdk/common/account_holder_identification.rb +21 -0
  5. data/lib/checkout_sdk/common/common.rb +1 -0
  6. data/lib/checkout_sdk/common/customer_retry.rb +14 -2
  7. data/lib/checkout_sdk/common/residential_status_type.rb +11 -0
  8. data/lib/checkout_sdk/issuing/card_update_headers.rb +11 -12
  9. data/lib/checkout_sdk/issuing/issuing_client.rb +20 -11
  10. data/lib/checkout_sdk/payments/card_payout_item.rb +24 -0
  11. data/lib/checkout_sdk/payments/card_payout_processing.rb +39 -0
  12. data/lib/checkout_sdk/payments/destination/bank_account_destination.rb +29 -0
  13. data/lib/checkout_sdk/payments/destination/card_destination.rb +20 -0
  14. data/lib/checkout_sdk/payments/destination/destination.rb +5 -0
  15. data/lib/checkout_sdk/payments/destination/destination_type.rb +7 -0
  16. data/lib/checkout_sdk/payments/destination/id_destination.rb +16 -0
  17. data/lib/checkout_sdk/payments/destination/network_token_destination.rb +63 -0
  18. data/lib/checkout_sdk/payments/destination/token_destination.rb +15 -0
  19. data/lib/checkout_sdk/payments/downtime_retry_request.rb +14 -0
  20. data/lib/checkout_sdk/payments/dunning_retry_request.rb +22 -0
  21. data/lib/checkout_sdk/payments/hosted/hosted_payment_instruction.rb +9 -0
  22. data/lib/checkout_sdk/payments/hosted/hosted_payments_session.rb +42 -31
  23. data/lib/checkout_sdk/payments/instruction_remittance.rb +17 -0
  24. data/lib/checkout_sdk/payments/instruction_scheme.rb +5 -0
  25. data/lib/checkout_sdk/payments/links/payment_link.rb +50 -29
  26. data/lib/checkout_sdk/payments/payment_instruction.rb +48 -1
  27. data/lib/checkout_sdk/payments/payment_request.rb +1 -1
  28. data/lib/checkout_sdk/payments/payment_retry_request.rb +9 -7
  29. data/lib/checkout_sdk/payments/payment_segment.rb +11 -0
  30. data/lib/checkout_sdk/payments/payment_type.rb +4 -1
  31. data/lib/checkout_sdk/payments/payments.rb +10 -0
  32. data/lib/checkout_sdk/payments/payments_client.rb +10 -0
  33. data/lib/checkout_sdk/payments/payout_billing_descriptor.rb +10 -0
  34. data/lib/checkout_sdk/payments/payout_request.rb +59 -1
  35. data/lib/checkout_sdk/payments/sender/corporate_sender.rb +19 -0
  36. data/lib/checkout_sdk/payments/sender/government_sender.rb +21 -0
  37. data/lib/checkout_sdk/payments/sender/individual_sender.rb +46 -0
  38. data/lib/checkout_sdk/payments/sender/instrument_sender.rb +3 -0
  39. data/lib/checkout_sdk/payments/sender/sender.rb +16 -0
  40. data/lib/checkout_sdk/payments/sessions/payment_sessions_request.rb +55 -32
  41. data/lib/checkout_sdk/payments/setups/account_funding_transaction_identification.rb +10 -1
  42. data/lib/checkout_sdk/payments/setups/account_funding_transaction_identification_type.rb +5 -4
  43. data/lib/checkout_sdk/payments/setups/account_funding_transaction_recipient.rb +29 -1
  44. data/lib/checkout_sdk/payments/setups/account_funding_transaction_sender.rb +34 -1
  45. data/lib/checkout_sdk/payments/setups/bacs_payment_method.rb +70 -34
  46. data/lib/checkout_sdk/payments/setups/cash_app_payment_method.rb +3 -3
  47. data/lib/checkout_sdk/payments/setups/payment_setup_payment_type.rb +19 -0
  48. data/lib/checkout_sdk/payments/setups/payment_setups_client.rb +10 -0
  49. data/lib/checkout_sdk/payments/source/currency_account_source.rb +8 -0
  50. data/lib/checkout_sdk/payments/source/entity_source.rb +5 -0
  51. data/lib/checkout_sdk/payments/source/payout_source.rb +12 -1
  52. data/lib/checkout_sdk/payments/unreferenced_refund_request.rb +89 -0
  53. data/lib/checkout_sdk/version.rb +1 -1
  54. metadata +11 -2
@@ -2,6 +2,14 @@
2
2
 
3
3
  module CheckoutSdk
4
4
  module Payments
5
+ # A currency account source, with type currency_account.
6
+ # Used by card payouts, bank payouts and unreferenced refunds.
7
+ #
8
+ # id: the ID of the currency account that will fund the payout or the unreferenced refund. For bank
9
+ # payouts, its holding currency must match the payout's currency.
10
+ # [Required]
11
+ # ^(ca)_(\w{26})$
12
+ # 29 characters
5
13
  class CurrencyAccountSource < PayoutSource
6
14
  def initialize
7
15
  super(PayoutSourceType::CURRENCY_ACCOUNT)
@@ -2,6 +2,11 @@
2
2
 
3
3
  module CheckoutSdk
4
4
  module Payments
5
+ # An entity source, with type entity. Bank payouts only.
6
+ #
7
+ # id: the entity or sub-entity's identifier, only applies to Platform Clients.
8
+ # [Required]
9
+ # ^(ent)_(\w{26})$
5
10
  class EntitySource < PayoutSource
6
11
  def initialize
7
12
  super(PayoutSourceType::ENTITY)
@@ -2,12 +2,23 @@
2
2
 
3
3
  module CheckoutSdk
4
4
  module Payments
5
+ # The source of a card payout, bank payout or unreferenced refund.
6
+ #
5
7
  # @!attribute type
8
+ # The payout source type. Set by each subclass.
9
+ # [Required]
6
10
  # @return [String] {PayoutSourceType}
7
11
  # @!attribute id
12
+ # The identifier of the source. See {CurrencyAccountSource} and {EntitySource} for the format.
13
+ # [Required]
8
14
  # @return [String]
9
15
  # @!attribute amount
10
- # @return [String]
16
+ # The amount of the source.
17
+ # [Optional]
18
+ # @deprecated Not in the request schema of any payout or unreferenced refund source; still returned in
19
+ # PayoutDetails (source.amount). Retained for backwards compatibility and will be removed in the next
20
+ # major version. There is no replacement.
21
+ # @return [Integer]
11
22
  class PayoutSource
12
23
  attr_reader :type
13
24
  attr_accessor :id,
@@ -0,0 +1,89 @@
1
+ # frozen_string_literal: true
2
+
3
+ module CheckoutSdk
4
+ module Payments
5
+ # An unreferenced refund request, sent to POST /payments.
6
+ # The payment_type is set to UnreferencedRefund by the constructor.
7
+ #
8
+ # @!attribute source
9
+ # The source of the unreferenced refund.
10
+ # Only type and id are part of this position; amount is not used.
11
+ # [Required]
12
+ # @return [CurrencyAccountSource]
13
+ # @!attribute destination
14
+ # The destination of the unreferenced refund.
15
+ # Takes {CardDestination}, {NetworkTokenDestination}, {IdDestination} or {TokenDestination}.
16
+ # [Required]
17
+ # @return [Destination]
18
+ # @!attribute instruction
19
+ # Additional details about the unreferenced refund instruction.
20
+ # Only funds_transfer_type and purpose are part of this position.
21
+ # [Optional]
22
+ # @return [PaymentInstruction]
23
+ # @!attribute amount
24
+ # The amount in minor currency.
25
+ # [Required]
26
+ # Format: int64
27
+ # min 1
28
+ # max 9999999999
29
+ # @return [Integer]
30
+ # @!attribute currency
31
+ # The three-letter ISO currency code of the payment.
32
+ # [Required]
33
+ # 3 characters
34
+ # @return [String] {CheckoutSdk::Common::Currency}
35
+ # @!attribute payment_type
36
+ # The type of the payment. Set to UnreferencedRefund by the constructor.
37
+ # [Required]
38
+ # Enum: "UnreferencedRefund"
39
+ # @return [String]
40
+ # @!attribute processing_channel_id
41
+ # The processing channel identifier.
42
+ # [Required]
43
+ # ^(pc)_(\w{26})$
44
+ # @return [String]
45
+ # @!attribute reference
46
+ # An internal reference you can later use to identify this payment.
47
+ # [Optional]
48
+ # @return [String]
49
+ # @!attribute metadata
50
+ # A set of key-value pairs that you can attach to the refund request. It can be useful for storing
51
+ # additional information in a structured format. Note: this object only allows one level of depth,
52
+ # so cannot accept non-primitive data types such as objects or arrays.
53
+ # [Optional]
54
+ # @return [Hash{String => Object}]
55
+ # @!attribute previous_payment_id
56
+ # The previous related payment identifier. This could be the ID of the payment that you want to refund.
57
+ # [Optional]
58
+ # @return [String]
59
+ # @!attribute segment
60
+ # The dimension details about business segment for payment request. At least one dimension required.
61
+ # [Optional]
62
+ # @return [PaymentSegment]
63
+ # @!attribute processing
64
+ # Returns information related to the processing of the payment.
65
+ # Only processing_speed is part of this position.
66
+ # [Optional]
67
+ # @return [CardPayoutProcessing]
68
+ class UnreferencedRefundRequest
69
+ PAYMENT_TYPE = 'UnreferencedRefund'
70
+
71
+ attr_reader :payment_type
72
+ attr_accessor :source,
73
+ :destination,
74
+ :instruction,
75
+ :amount,
76
+ :currency,
77
+ :processing_channel_id,
78
+ :reference,
79
+ :metadata,
80
+ :previous_payment_id,
81
+ :segment,
82
+ :processing
83
+
84
+ def initialize
85
+ @payment_type = PAYMENT_TYPE
86
+ end
87
+ end
88
+ end
89
+ end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module CheckoutSdk
4
- VERSION = '2.7.1'
4
+ VERSION = '2.8.0'
5
5
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: checkout_sdk
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.7.1
4
+ version: 2.8.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Checkout
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2026-10-20 00:00:00.000000000 Z
11
+ date: 2026-11-02 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rake
@@ -297,6 +297,7 @@ files:
297
297
  - lib/checkout_sdk/common/payment_source_type.rb
298
298
  - lib/checkout_sdk/common/phone.rb
299
299
  - lib/checkout_sdk/common/product.rb
300
+ - lib/checkout_sdk/common/residential_status_type.rb
300
301
  - lib/checkout_sdk/common/shipping_info.rb
301
302
  - lib/checkout_sdk/common/update_customer_request.rb
302
303
  - lib/checkout_sdk/compliance_requests/compliance_request_responded_field.rb
@@ -476,6 +477,8 @@ files:
476
477
  - lib/checkout_sdk/payments/capture_request.rb
477
478
  - lib/checkout_sdk/payments/capture_type.rb
478
479
  - lib/checkout_sdk/payments/card.rb
480
+ - lib/checkout_sdk/payments/card_payout_item.rb
481
+ - lib/checkout_sdk/payments/card_payout_processing.rb
479
482
  - lib/checkout_sdk/payments/charge_bearer.rb
480
483
  - lib/checkout_sdk/payments/contexts/payment_contexts_client.rb
481
484
  - lib/checkout_sdk/payments/d_local_installments.rb
@@ -485,7 +488,10 @@ files:
485
488
  - lib/checkout_sdk/payments/destination/destination.rb
486
489
  - lib/checkout_sdk/payments/destination/destination_type.rb
487
490
  - lib/checkout_sdk/payments/destination/id_destination.rb
491
+ - lib/checkout_sdk/payments/destination/network_token_destination.rb
488
492
  - lib/checkout_sdk/payments/destination/token_destination.rb
493
+ - lib/checkout_sdk/payments/downtime_retry_request.rb
494
+ - lib/checkout_sdk/payments/dunning_retry_request.rb
489
495
  - lib/checkout_sdk/payments/exemption.rb
490
496
  - lib/checkout_sdk/payments/flight_leg_details.rb
491
497
  - lib/checkout_sdk/payments/flow/flow_client.rb
@@ -497,6 +503,7 @@ files:
497
503
  - lib/checkout_sdk/payments/hosted/hosted_payments_client.rb
498
504
  - lib/checkout_sdk/payments/hosted/hosted_payments_session.rb
499
505
  - lib/checkout_sdk/payments/hosted/payment_purpose_type.rb
506
+ - lib/checkout_sdk/payments/instruction_remittance.rb
500
507
  - lib/checkout_sdk/payments/instruction_scheme.rb
501
508
  - lib/checkout_sdk/payments/links/payment_link.rb
502
509
  - lib/checkout_sdk/payments/links/payments_links_client.rb
@@ -612,6 +619,7 @@ files:
612
619
  - lib/checkout_sdk/payments/setups/payment_setup_industry.rb
613
620
  - lib/checkout_sdk/payments/setups/payment_setup_payment_method_initialization.rb
614
621
  - lib/checkout_sdk/payments/setups/payment_setup_payment_method_status.rb
622
+ - lib/checkout_sdk/payments/setups/payment_setup_payment_type.rb
615
623
  - lib/checkout_sdk/payments/setups/payment_setup_presentment_details.rb
616
624
  - lib/checkout_sdk/payments/setups/payment_setup_risk.rb
617
625
  - lib/checkout_sdk/payments/setups/payment_setup_terminal.rb
@@ -686,6 +694,7 @@ files:
686
694
  - lib/checkout_sdk/payments/three_ds_flow_type.rb
687
695
  - lib/checkout_sdk/payments/three_ds_request.rb
688
696
  - lib/checkout_sdk/payments/ticket.rb
697
+ - lib/checkout_sdk/payments/unreferenced_refund_request.rb
689
698
  - lib/checkout_sdk/payments/user_action.rb
690
699
  - lib/checkout_sdk/payments/void_request.rb
691
700
  - lib/checkout_sdk/platform_type.rb