adyen-ruby-api-library 11.2.0 → 12.0.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 (214) hide show
  1. checksums.yaml +4 -4
  2. data/.github/CODEOWNERS +1 -1
  3. data/.github/workflows/codeql.yml +4 -4
  4. data/.github/workflows/release.yml +1 -1
  5. data/.github/workflows/ruby.yml +3 -3
  6. data/.github/workflows/rubygems_release.yml +1 -1
  7. data/.github/workflows/stale.yml +1 -1
  8. data/Gemfile +2 -2
  9. data/README.md +30 -7
  10. data/VERSION +1 -1
  11. data/adyen-ruby-api-library.gemspec +1 -1
  12. data/lib/adyen/client.rb +10 -16
  13. data/lib/adyen/deprecation.rb +34 -0
  14. data/lib/adyen/services/balanceControl/balance_control_api.rb +3 -3
  15. data/lib/adyen/services/balancePlatform/account_holders_api.rb +14 -18
  16. data/lib/adyen/services/balancePlatform/authorized_card_users_api.rb +4 -12
  17. data/lib/adyen/services/balancePlatform/balance_accounts_api.rb +5 -65
  18. data/lib/adyen/services/balancePlatform/balances_api.rb +5 -15
  19. data/lib/adyen/services/balancePlatform/bank_account_validation_api.rb +1 -3
  20. data/lib/adyen/services/balancePlatform/card_orders_api.rb +2 -6
  21. data/lib/adyen/services/balancePlatform/custom_payout_schedules_sweeps_api.rb +56 -0
  22. data/lib/adyen/services/balancePlatform/direct_debit_mandates_api.rb +48 -0
  23. data/lib/adyen/services/balancePlatform/grant_accounts_api.rb +3 -3
  24. data/lib/adyen/services/balancePlatform/grant_offers_api.rb +6 -6
  25. data/lib/adyen/services/balancePlatform/manage_card_pin_api.rb +3 -9
  26. data/lib/adyen/services/balancePlatform/manage_sca_devices_api.rb +6 -18
  27. data/lib/adyen/services/balancePlatform/managed_payout_schedules_api.rb +80 -0
  28. data/lib/adyen/services/balancePlatform/network_tokens_api.rb +2 -6
  29. data/lib/adyen/services/balancePlatform/payment_instrument_groups_api.rb +3 -9
  30. data/lib/adyen/services/balancePlatform/payment_instruments_api.rb +9 -27
  31. data/lib/adyen/services/balancePlatform/platform_api.rb +3 -9
  32. data/lib/adyen/services/balancePlatform/recurring_top_ups_api.rb +48 -0
  33. data/lib/adyen/services/balancePlatform/sca_association_management_api.rb +3 -9
  34. data/lib/adyen/services/balancePlatform/sca_device_management_api.rb +11 -9
  35. data/lib/adyen/services/balancePlatform/transaction_rules_api.rb +4 -12
  36. data/lib/adyen/services/balancePlatform/transfer_limits_balance_account_level_api.rb +6 -18
  37. data/lib/adyen/services/balancePlatform/transfer_limits_balance_platform_level_api.rb +4 -12
  38. data/lib/adyen/services/balancePlatform/transfer_routes_api.rb +1 -3
  39. data/lib/adyen/services/balancePlatform.rb +20 -0
  40. data/lib/adyen/services/binLookup/bin_lookup_api.rb +2 -6
  41. data/lib/adyen/services/capital/dynamic_offers_api.rb +40 -0
  42. data/lib/adyen/services/capital/grant_accounts_api.rb +1 -3
  43. data/lib/adyen/services/capital/grant_offers_api.rb +4 -8
  44. data/lib/adyen/services/capital/grants_api.rb +6 -18
  45. data/lib/adyen/services/capital.rb +5 -0
  46. data/lib/adyen/services/checkout/donations_api.rb +2 -6
  47. data/lib/adyen/services/checkout/modifications_api.rb +6 -18
  48. data/lib/adyen/services/checkout/orders_api.rb +3 -9
  49. data/lib/adyen/services/checkout/payment_links_api.rb +3 -9
  50. data/lib/adyen/services/checkout/payments_api.rb +14 -18
  51. data/lib/adyen/services/checkout/recurring_api.rb +4 -12
  52. data/lib/adyen/services/checkout/utility_api.rb +6 -12
  53. data/lib/adyen/services/checkout.rb +1 -1
  54. data/lib/adyen/services/dataProtection/data_protection_api.rb +1 -3
  55. data/lib/adyen/services/disputes/disputes_api.rb +5 -15
  56. data/lib/adyen/services/legalEntityManagement/business_lines_api.rb +4 -12
  57. data/lib/adyen/services/legalEntityManagement/documents_api.rb +4 -12
  58. data/lib/adyen/services/legalEntityManagement/hosted_onboarding_api.rb +3 -9
  59. data/lib/adyen/services/legalEntityManagement/legal_entities_api.rb +7 -21
  60. data/lib/adyen/services/legalEntityManagement/pci_questionnaires_api.rb +5 -15
  61. data/lib/adyen/services/legalEntityManagement/tax_e_delivery_consent_api.rb +2 -6
  62. data/lib/adyen/services/legalEntityManagement/terms_of_service_api.rb +5 -15
  63. data/lib/adyen/services/legalEntityManagement/transfer_instruments_api.rb +4 -12
  64. data/lib/adyen/services/management/account_company_level_api.rb +3 -9
  65. data/lib/adyen/services/management/account_merchant_level_api.rb +4 -12
  66. data/lib/adyen/services/management/account_store_level_api.rb +8 -24
  67. data/lib/adyen/services/management/allowed_origins_company_level_api.rb +4 -12
  68. data/lib/adyen/services/management/allowed_origins_merchant_level_api.rb +4 -12
  69. data/lib/adyen/services/management/android_files_company_level_api.rb +6 -18
  70. data/lib/adyen/services/management/api_credentials_company_level_api.rb +4 -12
  71. data/lib/adyen/services/management/api_credentials_merchant_level_api.rb +4 -12
  72. data/lib/adyen/services/management/api_key_company_level_api.rb +1 -3
  73. data/lib/adyen/services/management/api_key_merchant_level_api.rb +1 -3
  74. data/lib/adyen/services/management/client_key_company_level_api.rb +1 -3
  75. data/lib/adyen/services/management/client_key_merchant_level_api.rb +1 -3
  76. data/lib/adyen/services/management/donation_campaigns_api.rb +64 -0
  77. data/lib/adyen/services/management/my_api_credential_api.rb +6 -18
  78. data/lib/adyen/services/management/payment_methods_merchant_level_api.rb +6 -18
  79. data/lib/adyen/services/management/payout_settings_merchant_level_api.rb +5 -15
  80. data/lib/adyen/services/management/split_configuration_merchant_level_api.rb +9 -27
  81. data/lib/adyen/services/management/terminal_actions_company_level_api.rb +2 -6
  82. data/lib/adyen/services/management/terminal_actions_terminal_level_api.rb +1 -3
  83. data/lib/adyen/services/management/terminal_orders_company_level_api.rb +10 -30
  84. data/lib/adyen/services/management/terminal_orders_merchant_level_api.rb +10 -30
  85. data/lib/adyen/services/management/terminal_settings_company_level_api.rb +4 -12
  86. data/lib/adyen/services/management/terminal_settings_merchant_level_api.rb +4 -12
  87. data/lib/adyen/services/management/terminal_settings_store_level_api.rb +8 -24
  88. data/lib/adyen/services/management/terminal_settings_terminal_level_api.rb +4 -12
  89. data/lib/adyen/services/management/terminals_terminal_level_api.rb +2 -6
  90. data/lib/adyen/services/management/users_company_level_api.rb +4 -12
  91. data/lib/adyen/services/management/users_merchant_level_api.rb +4 -12
  92. data/lib/adyen/services/management/webhooks_company_level_api.rb +7 -21
  93. data/lib/adyen/services/management/webhooks_merchant_level_api.rb +7 -21
  94. data/lib/adyen/services/management.rb +5 -0
  95. data/lib/adyen/services/payment/modifications_api.rb +10 -24
  96. data/lib/adyen/services/payment/payments_api.rb +5 -15
  97. data/lib/adyen/services/paymentsApp/payments_app_api.rb +5 -15
  98. data/lib/adyen/services/payout/initialization_api.rb +3 -9
  99. data/lib/adyen/services/payout/instant_payouts_api.rb +1 -3
  100. data/lib/adyen/services/payout/reviewing_api.rb +2 -6
  101. data/lib/adyen/services/posMobile/pos_mobile_api.rb +6 -3
  102. data/lib/adyen/services/posTerminalManagement.rb +10 -0
  103. data/lib/adyen/services/recurring/recurring_api.rb +10 -18
  104. data/lib/adyen/services/service.rb +12 -2
  105. data/lib/adyen/services/sessionAuthentication/session_authentication_api.rb +1 -3
  106. data/lib/adyen/services/storedValue/stored_value_api.rb +6 -18
  107. data/lib/adyen/services/transfers/capital_api.rb +9 -9
  108. data/lib/adyen/services/transfers/cash_out_api.rb +24 -0
  109. data/lib/adyen/services/transfers/transactions_api.rb +2 -6
  110. data/lib/adyen/services/transfers/transfers_api.rb +6 -18
  111. data/lib/adyen/services/transfers.rb +5 -0
  112. data/lib/adyen/utils/hmac_validator.rb +15 -18
  113. data/lib/adyen/version.rb +1 -1
  114. data/sdk-generation-log/balancecontrol.json +8 -0
  115. data/sdk-generation-log/balanceplatform.json +8 -0
  116. data/sdk-generation-log/binlookup.json +8 -0
  117. data/sdk-generation-log/capital.json +8 -0
  118. data/sdk-generation-log/checkout.json +8 -0
  119. data/sdk-generation-log/dataprotection.json +8 -0
  120. data/sdk-generation-log/disputes.json +8 -0
  121. data/sdk-generation-log/legalentitymanagement.json +8 -0
  122. data/sdk-generation-log/management.json +8 -0
  123. data/sdk-generation-log/payment.json +8 -0
  124. data/sdk-generation-log/paymentsapp.json +8 -0
  125. data/sdk-generation-log/payout.json +8 -0
  126. data/sdk-generation-log/posmobile.json +8 -0
  127. data/sdk-generation-log/recurring.json +8 -0
  128. data/sdk-generation-log/sessionauthentication.json +8 -0
  129. data/sdk-generation-log/storedvalue.json +8 -0
  130. data/sdk-generation-log/transfers.json +8 -0
  131. data/spec/balance_control_spec.rb +41 -0
  132. data/spec/balance_platform_spec.rb +609 -4
  133. data/spec/capital_spec.rb +82 -0
  134. data/spec/checkout-oauth_spec.rb +220 -10
  135. data/spec/checkout_spec.rb +245 -10
  136. data/spec/client_spec.rb +23 -5
  137. data/spec/deprecation_spec.rb +112 -0
  138. data/spec/management_spec.rb +184 -0
  139. data/spec/mocks/requests/BalancePlatform/apply_managed_schedule.json +14 -0
  140. data/spec/mocks/requests/BalancePlatform/begin_sca_device_registration.json +4 -0
  141. data/spec/mocks/requests/BalancePlatform/create_recurring_top_up.json +21 -0
  142. data/spec/mocks/requests/BalancePlatform/create_sweep.json +10 -0
  143. data/spec/mocks/requests/BalancePlatform/finish_sca_device_registration.json +3 -0
  144. data/spec/mocks/requests/BalancePlatform/submit_sca_association.json +8 -0
  145. data/spec/mocks/requests/BalancePlatform/update_balance_account_managed_schedule.json +5 -0
  146. data/spec/mocks/requests/BalancePlatform/update_mandate.json +14 -0
  147. data/spec/mocks/requests/BalancePlatform/update_recurring_top_ups.json +3 -0
  148. data/spec/mocks/requests/BalancePlatform/update_sweep.json +6 -0
  149. data/spec/mocks/requests/Checkout/amount_updates.json +1 -1
  150. data/spec/mocks/requests/Checkout/card_details.json +3 -0
  151. data/spec/mocks/requests/Checkout/create_stored_payment_method.json +10 -0
  152. data/spec/mocks/requests/Checkout/donation_campaigns.json +4 -0
  153. data/spec/mocks/requests/Checkout/donations.json +9 -0
  154. data/spec/mocks/requests/Checkout/orders.json +5 -3
  155. data/spec/mocks/requests/Checkout/payment-details.json +2 -14
  156. data/spec/mocks/requests/Checkout/payment_methods_balance.json +5 -2
  157. data/spec/mocks/requests/Checkout/payments.json +9 -10
  158. data/spec/mocks/requests/Checkout/paypal_update_order.json +5 -0
  159. data/spec/mocks/requests/Checkout/reversals.json +3 -0
  160. data/spec/mocks/requests/Checkout/update_session.json +7 -0
  161. data/spec/mocks/requests/Management/create_donation_campaign.json +7 -0
  162. data/spec/mocks/requests/Management/list_nonprofits.json +5 -0
  163. data/spec/mocks/requests/Management/update_donation_campaign.json +6 -0
  164. data/spec/mocks/requests/Transfers/initiate_cashout.json +12 -0
  165. data/spec/mocks/responses/BalancePlatform/apply_managed_schedule.json +17 -0
  166. data/spec/mocks/responses/BalancePlatform/begin_sca_device_registration.json +8 -0
  167. data/spec/mocks/responses/BalancePlatform/create_recurring_top_up.json +23 -0
  168. data/spec/mocks/responses/BalancePlatform/create_sweep.json +12 -0
  169. data/spec/mocks/responses/BalancePlatform/finish_sca_device_registration.json +7 -0
  170. data/spec/mocks/responses/BalancePlatform/get_all_sweeps_for_balance_account.json +31 -0
  171. data/spec/mocks/responses/BalancePlatform/get_balance_account_managed_schedule_by_id.json +17 -0
  172. data/spec/mocks/responses/BalancePlatform/get_balance_account_managed_schedules.json +26 -0
  173. data/spec/mocks/responses/BalancePlatform/get_balance_platform_managed_schedule_by_id.json +27 -0
  174. data/spec/mocks/responses/BalancePlatform/get_balance_platform_managed_schedules.json +31 -0
  175. data/spec/mocks/responses/BalancePlatform/get_list_of_mandates.json +19 -0
  176. data/spec/mocks/responses/BalancePlatform/get_mandate_by_id.json +14 -0
  177. data/spec/mocks/responses/BalancePlatform/get_payout_schedule_executions.json +21 -0
  178. data/spec/mocks/responses/BalancePlatform/get_recurring_top_ups.json +35 -0
  179. data/spec/mocks/responses/BalancePlatform/get_sweep.json +12 -0
  180. data/spec/mocks/responses/BalancePlatform/get_tax_form_summary.json +17 -0
  181. data/spec/mocks/responses/BalancePlatform/submit_sca_association.json +10 -0
  182. data/spec/mocks/responses/BalancePlatform/update_balance_account_managed_schedule.json +18 -0
  183. data/spec/mocks/responses/BalancePlatform/update_recurring_top_ups.json +23 -0
  184. data/spec/mocks/responses/BalancePlatform/update_sweep.json +12 -0
  185. data/spec/mocks/responses/Capital/calculate-preliminary-offer-from-dynamic-offer.json +16 -0
  186. data/spec/mocks/responses/Capital/create-static-offer-from-dynamic-offer.json +9 -0
  187. data/spec/mocks/responses/Capital/get-all-dynamic-offers.json +18 -0
  188. data/spec/mocks/responses/Checkout/amount_updates.json +1 -1
  189. data/spec/mocks/responses/Checkout/card_details.json +5 -0
  190. data/spec/mocks/responses/Checkout/create_stored_payment_method.json +5 -0
  191. data/spec/mocks/responses/Checkout/donation_campaigns.json +1 -0
  192. data/spec/mocks/responses/Checkout/donations.json +5 -0
  193. data/spec/mocks/responses/Checkout/orders.json +6 -1
  194. data/spec/mocks/responses/Checkout/orders_cancel.json +1 -1
  195. data/spec/mocks/responses/Checkout/payment-details.json +2 -13
  196. data/spec/mocks/responses/Checkout/payment_links.json +3 -0
  197. data/spec/mocks/responses/Checkout/payment_methods.json +2 -2
  198. data/spec/mocks/responses/Checkout/payment_methods_balance.json +5 -1
  199. data/spec/mocks/responses/Checkout/payments.json +4 -94
  200. data/spec/mocks/responses/Checkout/paypal_update_order.json +4 -0
  201. data/spec/mocks/responses/Checkout/reversals.json +6 -0
  202. data/spec/mocks/responses/Checkout/update_session.json +3 -0
  203. data/spec/mocks/responses/Management/donation_campaign.json +13 -0
  204. data/spec/mocks/responses/Management/list_donation_campaigns.json +19 -0
  205. data/spec/mocks/responses/Management/list_nonprofits.json +34 -0
  206. data/spec/mocks/responses/Transfers/initiate_cashout.json +31 -0
  207. data/spec/service_spec.rb +40 -0
  208. data/spec/spec_helper.rb +2 -2
  209. data/spec/transfers_spec.rb +28 -0
  210. data/spec/utils/consumer_smoke.rb +23 -0
  211. data/spec/utils/hmac_validator_spec.rb +55 -0
  212. data/templates/api-small.mustache +4 -4
  213. data/templates/api.mustache +4 -4
  214. metadata +84 -2
@@ -0,0 +1,4 @@
1
+ {
2
+ "name": "My Device",
3
+ "sdkOutput": "eyJjaGFsbGVuZ2UiOiJVWEZaTURONGNXWjZUVFExUlhWV2JuaEJPVzVzTm05cVVEUktUbFZtZGtrPSJ9"
4
+ }
@@ -0,0 +1,21 @@
1
+ {
2
+ "counterparty": {
3
+ "transferInstrumentId": "SE000000000000000000000001"
4
+ },
5
+ "description": "My description",
6
+ "topUpAmount": {
7
+ "fixed": {
8
+ "value": 1000,
9
+ "currency": "EUR"
10
+ }
11
+ },
12
+ "trigger": {
13
+ "schedule": {
14
+ "type": "weekdays"
15
+ },
16
+ "threshold": {
17
+ "value": 100,
18
+ "currency": "EUR"
19
+ }
20
+ }
21
+ }
@@ -0,0 +1,10 @@
1
+ {
2
+ "counterparty": {
3
+ "balanceAccountId": "BA3227C223222B5BLP6JQC3FD"
4
+ },
5
+ "currency": "EUR",
6
+ "schedule": {
7
+ "type": "daily"
8
+ },
9
+ "type": "push"
10
+ }
@@ -0,0 +1,3 @@
1
+ {
2
+ "sdkOutput": "eyJjaGFsbGVuZ2UiOiJVWEZaTURONGNXWjZUVFExUlhWV2JuaEJPVzVzTm05cVVEUktUbFZtZGtrPSJ9"
3
+ }
@@ -0,0 +1,8 @@
1
+ {
2
+ "entities": [
3
+ {
4
+ "type": "accountHolder",
5
+ "id": "AH00000000000000000000001"
6
+ }
7
+ ]
8
+ }
@@ -0,0 +1,5 @@
1
+ {
2
+ "description": "Updated payout description",
3
+ "enabled": false,
4
+ "retainedAmount": 20000
5
+ }
@@ -0,0 +1,14 @@
1
+ {
2
+ "id": "MNDT7QXPLKT9R333640TX334709E",
3
+ "type": "bacs",
4
+ "balanceAccountId": "BA43EKD334339T6N8X655DW77",
5
+ "paymentInstrumentId": "PI43EKK334339T6N8X65688CS",
6
+ "status": "approved",
7
+ "counterparty": {
8
+ "accountHolder": {
9
+ "fullName": "Example Merchant Ltd"
10
+ }
11
+ },
12
+ "createdAt": "2026-02-23T13:04:15.683Z",
13
+ "updatedAt": "2026-02-23T13:04:15.683Z"
14
+ }
@@ -0,0 +1,3 @@
1
+ {
2
+ "description": "new description"
3
+ }
@@ -0,0 +1,6 @@
1
+ {
2
+ "schedule": {
3
+ "type": "weekly"
4
+ },
5
+ "status": "inactive"
6
+ }
@@ -4,7 +4,7 @@
4
4
  "value": 0
5
5
  },
6
6
  "merchantAccount": "TestMerchant",
7
- "reason": "delayedCharge",
7
+ "industryUsage": "delayedCharge",
8
8
  "reference": "123456789",
9
9
  "splits": [
10
10
  {
@@ -0,0 +1,3 @@
1
+ {
2
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
3
+ }
@@ -0,0 +1,10 @@
1
+ {
2
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
3
+ "paymentMethod": {
4
+ "brand": "mc",
5
+ "cvc": "mock-cvc",
6
+ "encryptedCard": "mock-encryptedCard"
7
+ },
8
+ "recurringProcessingModel": "CardOnFile",
9
+ "shopperReference": "shopper-001"
10
+ }
@@ -0,0 +1,4 @@
1
+ {
2
+ "currency": "EUR",
3
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
4
+ }
@@ -0,0 +1,9 @@
1
+ {
2
+ "amount": {
3
+ "currency": "EUR",
4
+ "value": 1
5
+ },
6
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
7
+ "reference": "YOUR_REFERENCE_0001",
8
+ "returnUrl": "https://your-company.example/checkout?orderRef=123"
9
+ }
@@ -1,6 +1,8 @@
1
1
  {
2
2
  "amount": {
3
- "currency":"USD",
4
- "value": "1000"
5
- }
3
+ "currency": "USD",
4
+ "value": 1000
5
+ },
6
+ "merchantAccount": "TestMerchant",
7
+ "reference": "Merchant Reference"
6
8
  }
@@ -1,18 +1,6 @@
1
1
  {
2
- "amount": {
3
- "currency": "USD",
4
- "value": 1000
5
- },
6
- "paymentMethod": {
7
- "type": "ideal",
8
- "idealIssuer": 1155
9
- },
10
2
  "paymentData": "Hee57361f99ddcf4!ZW5jcnlwdGVkPUJRQUJBZ0JvNGhIUnFUcUxwMVYxY0JJb0R2Sk5lWmQzVDZZckdGSTNRU2hrRnFkUGhzSiUyQmY3ZzJJd1hTa2hVYXZlUUFIT1ExZnNQbzRYVzV4YUFydnplRFdNYTQ5ZHhnbDNHbzNGM2RHTnAlMkJvSGhzM1hIQXZZNHc4UjhGMDVWdHNWR0hSek1qeW1TT291MGp6TnlqUU80cWpDeGNQQlF4bVVyUU1CeDhBVU9COXlWRlRhaFNwM1N5RlprZ3FOZkpjcTdxMVhycFJ3SENkamdZJTJCd1lWcmtMeEN3MmpuYmQ4N2JwazRicE45QjNJYXp0bkszY05USW5qWnZXQTc3MmdMTVRaTjJWTHgyNm4lMkI5ZDA3akdxSkpsUG5xSndBdkFEdzh2OXd4aHRyTXhXbGFYemxJejNuc2NWY05zR3JDNUFZVExtaXRTazB2eVRKUXNqRlNKTXltTG1IdmppcXFmR3JrY0glMkJzWWpiQ1M5dTB3TlN4OFQlMkJJRTN6a2VuMGZ3Ylo4RHE2M21NdGZ3WURkRDNGbjJMUnJvT0oxN3pTTWRXSmtoUjdLTVo1OXRERE1VWlBEajNWWHRMY29MNUF0dWtLTlFQTEFENWdBOEppdmZCc0h5YlBPY25ZOVpzc291TTJQVjBLcWtldk0xMUdHZlgwYiUyQmdHcjB6NHQxOE9LM25weHVIdXJoNzV0T3oyJTJGUHRTSnBkT2lKOGo2Z0F1Q1JQdFh4ZHZBT0NMaldwQ210Smg2Wmw5VGYwZXdFREhFelN6NnQ3N2pleWpnOTFMaVRZQkhHMDBvSkJyWk0lMkJvOVliJTJCM0JYcFFQVzNwVThKSGdKbWJJUVFEenpCNyUyQnFiMHBRQ1FDam1xelJkSUx1UDQzOW82ZHFNS1hyMFhjSEpkNkNxMmtRaUxNNk1xcmJUYjZkMmhDNUFlcE1ZSEs5NVFzJTJCS1dzNU1FajdBRXA3SW10bGVTSTZJa0ZHTUVGQlFURXdNME5CTlRNM1JVRkZSRGczUXpJMFJFUTFNemt3T1VJNE1FRTNPRUU1TWpORk16Z3lNMFEyT0VSQlEwTTVORUk1UmtZNE16QTFSRU1pZll0MWhDUUREenpiSiUyRkV6NGJXdHdSNEQ0VjZ5JTJCWVVuTHNVc1NsbGZsJTJGV1Fka2ZmU0t5d1E2Z0RKY2tJUlBuelpvREhZSHUwVDdPd2gycHk5VyUyQjBmMXRISTJRYnZvdnBNR0tQRHdndSUyQkUlMkZaM0JvTm9xYTlEMiUyRmNrcTdSZ0RXMmdqMFpiYXplbk5oQ2hMaTJ3YjBlampMYzR6cHJhJTJGellmUkVVM0ZCSUJmdzBKeEtWVzU1NENxUEJvSGlIU3c2Sml5MlE3cnhjSjJSc3FiJTJCR25zTnRIYjN4c3NyMiUyQjRMTjYyZXZ3ciUyQiUyQk5ITEVLejVHSWxKMERJdG1JT1VWR1U1YlA4a2M1a0ZGR1JQYzNNODh4MCUyRlpVVG54bVlscVR1MDg0Mm1MUlh3WnJPaUoySlVXY3QlMkIzdDNlb1p6UG1jV0VZdkhZRG1OJTJCd2J0WXVRcmhIdWFrTVpCeGdRWjczeGd4WUZoaUZUMnYyQmFDT2pSZyUyQjBiMGJhZ3BEU1R1dVJQRFg2b0txa3ZYb0h2MFhqcGRHWUR4VmMlMkZ5SWxtMXp0WmNVcmo3Z1FqTkVvNjE1b2F3UmhxZTJyOXlTdTdCZ2FLQXJ4UjEzSDBRZzVIQlJJT0g5Zk92MnV6Vk5zNFZGMEYzcDhmJTJGdnBsMXlBcnZaRzFkWm5VYkZ1c092bVdIM2hyRDgwQVdzczRlJTJGYW5HMUxOaXhYSEVlUyUyRmEyQUxIcXp6THVHakZsRHZXZ2prQjNrU2t5S3d4ZVlQb284dk03cHFhTEFKV010T2ZtbnZUd1pqUVJUTnp1V0NSbjBwbHU3QVF2Q3hPZXMzRFg5ZTR3WDZBd1FhaXhIUjRQbXM2TnJxMVFuRkZLNHNrMW5kRGZqRTdEaXhGdlVpWlhUOHklMkZGcEFFMENPR0VhRCUyQmpGR1ZDYVI0NkVuMEo2RmJkOGFyQVYxaGJSNGZ5cFlaMFFuNFF6dE1MTWtpWW4xR0NQeWZyTjJxZEJ1aExmNFBqeUtSeFRLa2x6JTJGTmVvSnM1Smc2dVJiNVA0eiUyQiUyQkhlMUZqWFlUMXBXRzBnaDZtSDNvakttQyUyRmdOSTV3cHFlWDRpY2ZIb2t3RVB0VXAyTDFKYWNjd2xlZkU5dGlMZGZlQXJEbVZGJTJGRGp6UjE2S0JPNW1VMUR4R2dnd09DRDMzRkVqSCUyRjVERDklMkZwSW5IU0lSZFpmZDlRN2E1b1VwYmFFbFdhV2dxZjBEQ3RwWmluU2ZCWUZMNFBKeTAlMkZEdWd0VWZuWHdCVFNJV045c1lVYmFxODRMZXhkbVBHeFBwWUUyVHFaUWluVmRMTmtLbEJhQUpjUDV0JTJGTWQ4Nk5HM0lLVDZzalozJTJCVWxkMXRyNWIxVW8xbThCaSZ2ZXJzaW9uPTI=",
11
3
  "details": {
12
- "key": "returnUrlQueryString",
13
- "type": "text"
14
- },
15
- "returnUrl": "",
16
- "reference": "Merchant Reference",
17
- "merchantAccount": "TestMerchant"
4
+ "returnUrlQueryString": "mock_return_url_query_string"
5
+ }
18
6
  }
@@ -1,9 +1,12 @@
1
-
2
1
  {
3
2
  "paymentMethod": {
4
3
  "type": "givex",
5
4
  "number": "4126491073027401",
6
5
  "cvc": "737"
7
6
  },
8
- "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
7
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
8
+ "amount": {
9
+ "currency": "EUR",
10
+ "value": 1000
11
+ }
9
12
  }
@@ -1,17 +1,16 @@
1
1
  {
2
2
  "amount": {
3
- "currency": "USD",
3
+ "currency": "EUR",
4
4
  "value": 1000
5
5
  },
6
- "reference": "Mock payment",
6
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
7
7
  "paymentMethod": {
8
8
  "type": "scheme",
9
- "number": "4111111111111111",
10
- "expiryMonth": "08",
11
- "expiryYear": "2018",
12
- "holderName": "John Smith",
13
- "cvc": "737"
9
+ "encryptedCardNumber": "test_4111111111111111",
10
+ "encryptedExpiryMonth": "test_03",
11
+ "encryptedExpiryYear": "test_2030",
12
+ "encryptedSecurityCode": "test_737"
14
13
  },
15
- "returnUrl": "",
16
- "merchantAccount": "TestMerchant"
17
- }
14
+ "reference": "YOUR_REFERENCE_0001",
15
+ "returnUrl": "https://your-company.example/checkout?orderRef=123"
16
+ }
@@ -0,0 +1,5 @@
1
+ {
2
+ "paymentData": "mock-paymentData",
3
+ "pspReference": "8512345678901234",
4
+ "sessionId": "mock-sessionId"
5
+ }
@@ -0,0 +1,3 @@
1
+ {
2
+ "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
3
+ }
@@ -0,0 +1,7 @@
1
+ {
2
+ "amount": {
3
+ "currency": "EUR",
4
+ "value": 1000
5
+ },
6
+ "sessionData": "SESSION_DATA_BLOB"
7
+ }
@@ -0,0 +1,7 @@
1
+ {
2
+ "name": "Spring fundraiser",
3
+ "nonprofitCauseId": "CA3227C223222B5BLP6JQC3FD",
4
+ "accountHolderIds": [
5
+ "AH3227C223222B5BLP6JQC3FD"
6
+ ]
7
+ }
@@ -0,0 +1,5 @@
1
+ {
2
+ "accountHolderIds": [
3
+ "AH3227C223222B5BLP6JQC3FD"
4
+ ]
5
+ }
@@ -0,0 +1,6 @@
1
+ {
2
+ "name": "Spring fundraiser extended",
3
+ "accountHolderIds": [
4
+ "AH3227C223222B5BLP6JQC3FD"
5
+ ]
6
+ }
@@ -0,0 +1,12 @@
1
+ {
2
+ "amount": {
3
+ "value": 110000,
4
+ "currency": "EUR"
5
+ },
6
+ "instructingBalanceAccountId": "BAB8B2C3D4E5F6G7H8D9J6GD4",
7
+ "counterparty": {
8
+ "transferInstrumentId": "SE000JVZ7Q8D2ZJ4VZ0J"
9
+ },
10
+ "referenceForBeneficiary": "Your-reference-sent-to-the-beneficiary",
11
+ "description": "Your description for the cashout"
12
+ }
@@ -0,0 +1,17 @@
1
+ {
2
+ "id": "PSAC00000000000000000000000001",
3
+ "balancePlatformPayoutScheduleId": "PSPC00000000000000000000000001",
4
+ "balanceAccountId": "BA000000000000000000001",
5
+ "transferInstrumentId": "SE00000000000000000000001",
6
+ "currency": "EUR",
7
+ "reference": "Monthly payout",
8
+ "description": "Scheduled payout to merchant bank account",
9
+ "referenceForBeneficiary": "PAYOUT-REF-001",
10
+ "retainedAmount": 10000,
11
+ "minPayoutAmount": 1000,
12
+ "maxPayoutAmount": 100000000,
13
+ "createdAt": "2024-01-15T10:30:00Z",
14
+ "enabled": true,
15
+ "frequency": "monthly",
16
+ "frequencyValue": 1
17
+ }
@@ -0,0 +1,8 @@
1
+ {
2
+ "scaDevice": {
3
+ "id": "BSDR42XV3223223S5N6CDQDGH53M8H",
4
+ "name": "My Device",
5
+ "type": "ios"
6
+ },
7
+ "sdkInput": "eyJjaGFsbGVuZ2UiOiJVWEZaTURONGNXWjZUVFExUlhWV2JuaEJPVzVzTm05cVVEUktUbFZtZGtrPSJ9"
8
+ }
@@ -0,0 +1,23 @@
1
+ {
2
+ "id": "TUPC0000000000000000000001",
3
+ "counterparty": {
4
+ "transferInstrumentId": "SE000000000000000000000001"
5
+ },
6
+ "description": "My description",
7
+ "topUpAmount": {
8
+ "fixed": {
9
+ "value": 1000,
10
+ "currency": "EUR"
11
+ }
12
+ },
13
+ "trigger": {
14
+ "schedule": {
15
+ "type": "weekdays"
16
+ },
17
+ "threshold": {
18
+ "value": 100,
19
+ "currency": "EUR"
20
+ }
21
+ },
22
+ "status": "active"
23
+ }
@@ -0,0 +1,12 @@
1
+ {
2
+ "counterparty": {
3
+ "balanceAccountId": "BA3227C223222B5BLP6JQC3FD"
4
+ },
5
+ "currency": "EUR",
6
+ "id": "SWEP00000000000000000000000001",
7
+ "schedule": {
8
+ "type": "daily"
9
+ },
10
+ "status": "active",
11
+ "type": "push"
12
+ }
@@ -0,0 +1,7 @@
1
+ {
2
+ "scaDevice": {
3
+ "id": "BSDR42XV3223223S5N6CDQDGH53M8H",
4
+ "name": "Device",
5
+ "type": "ios"
6
+ }
7
+ }
@@ -0,0 +1,31 @@
1
+ {
2
+ "hasNext": false,
3
+ "hasPrevious": false,
4
+ "sweeps": [
5
+ {
6
+ "counterparty": {
7
+ "balanceAccountId": "BA3227C223222B5BLP6JQC3FD"
8
+ },
9
+ "currency": "EUR",
10
+ "id": "SWEP00000000000000000000000001",
11
+ "schedule": {
12
+ "type": "daily"
13
+ },
14
+ "status": "active",
15
+ "type": "push"
16
+ },
17
+ {
18
+ "counterparty": {
19
+ "transferInstrumentId": "SE322JV222224D5FJ7QTZ9HVM"
20
+ },
21
+ "currency": "EUR",
22
+ "id": "SWEP00000000000000000000000002",
23
+ "schedule": {
24
+ "type": "cron",
25
+ "cronExpression": "30 17 * * MON"
26
+ },
27
+ "status": "inactive",
28
+ "type": "pull"
29
+ }
30
+ ]
31
+ }
@@ -0,0 +1,17 @@
1
+ {
2
+ "id": "PSAC00000000000000000000000001",
3
+ "balancePlatformPayoutScheduleId": "PSPC00000000000000000000000001",
4
+ "balanceAccountId": "BA000000000000000000001",
5
+ "transferInstrumentId": "SE00000000000000000000001",
6
+ "currency": "EUR",
7
+ "reference": "Monthly payout",
8
+ "description": "Scheduled payout to merchant bank account",
9
+ "referenceForBeneficiary": "PAYOUT-REF-001",
10
+ "retainedAmount": 10000,
11
+ "minPayoutAmount": 1000,
12
+ "maxPayoutAmount": 100000000,
13
+ "createdAt": "2024-01-15T10:30:00Z",
14
+ "enabled": true,
15
+ "frequency": "monthly",
16
+ "frequencyValue": 1
17
+ }
@@ -0,0 +1,26 @@
1
+ {
2
+ "balanceAccountPayoutSchedules": [
3
+ {
4
+ "id": "PSAC00000000000000000000000001",
5
+ "balancePlatformPayoutScheduleId": "PSPC00000000000000000000000001",
6
+ "balanceAccountId": "BA000000000000000000001",
7
+ "transferInstrumentId": "SE00000000000000000000001",
8
+ "currency": "EUR",
9
+ "reference": "Monthly payout",
10
+ "description": "Scheduled payout to merchant bank account",
11
+ "referenceForBeneficiary": "PAYOUT-REF-001",
12
+ "retainedAmount": 10000,
13
+ "minPayoutAmount": 1000,
14
+ "maxPayoutAmount": 100000000,
15
+ "createdAt": "2024-01-15T10:30:00Z",
16
+ "enabled": true,
17
+ "frequency": "monthly",
18
+ "frequencyValue": 1
19
+ }
20
+ ],
21
+ "link": {
22
+ "self": {
23
+ "href": "https://balanceplatform-api-test.adyen.com/bcl/v2/balanceAccounts/BA000000000000000000001/payoutSchedules"
24
+ }
25
+ }
26
+ }
@@ -0,0 +1,27 @@
1
+ {
2
+ "id": "PSPC00000000000000000000000001",
3
+ "balancePlatformId": "YOUR_BALANCE_PLATFORM_ID",
4
+ "countryCode": "NL",
5
+ "currency": "EUR",
6
+ "defaultDescription": "Scheduled payout to merchant bank account",
7
+ "defaultFrequency": "monthly",
8
+ "defaultFrequencyValue": 1,
9
+ "defaultReference": "Monthly payout",
10
+ "defaultReferenceForBeneficiary": "PAYOUT-REF-001",
11
+ "automaticApplication": false,
12
+ "enabled": true,
13
+ "maxPayoutAmount": 100000000,
14
+ "minPayoutAmount": 1000,
15
+ "retainedAmount": 10000,
16
+ "payoutScheduleDescription": "Standard",
17
+ "userSettlementDelay": 2,
18
+ "userSettlementTime": {
19
+ "hour": 8,
20
+ "minute": 0,
21
+ "second": 0,
22
+ "nano": 0
23
+ },
24
+ "userSettlementTimeZone": "Europe/Amsterdam",
25
+ "createdAt": "2024-01-15T10:30:00Z",
26
+ "updatedAt": "2024-01-16T14:00:00Z"
27
+ }
@@ -0,0 +1,31 @@
1
+ {
2
+ "balancePlatformPayoutSchedules": [
3
+ {
4
+ "id": "PSPC00000000000000000000000001",
5
+ "balancePlatformId": "YOUR_BALANCE_PLATFORM_ID",
6
+ "countryCode": "NL",
7
+ "currency": "EUR",
8
+ "defaultDescription": "Scheduled payout to merchant bank account",
9
+ "defaultFrequency": "monthly",
10
+ "defaultFrequencyValue": 1,
11
+ "defaultReference": "Monthly payout",
12
+ "defaultReferenceForBeneficiary": "PAYOUT-REF-001",
13
+ "automaticApplication": false,
14
+ "enabled": true,
15
+ "maxPayoutAmount": 100000000,
16
+ "minPayoutAmount": 1000,
17
+ "retainedAmount": 10000,
18
+ "payoutScheduleDescription": "Standard",
19
+ "userSettlementDelay": 2,
20
+ "userSettlementTime": {
21
+ "hour": 8,
22
+ "minute": 0,
23
+ "second": 0,
24
+ "nano": 0
25
+ },
26
+ "userSettlementTimeZone": "Europe/Amsterdam",
27
+ "createdAt": "2024-01-15T10:30:00Z",
28
+ "updatedAt": "2024-01-16T14:00:00Z"
29
+ }
30
+ ]
31
+ }
@@ -0,0 +1,19 @@
1
+ {
2
+ "mandates": [
3
+ {
4
+ "id": "MNDT7QXPLKT9R333640TX334709E",
5
+ "type": "bacs",
6
+ "balanceAccountId": "BA43EKD334339T6N8X655DW77",
7
+ "paymentInstrumentId": "PI43EKK334339T6N8X65688CS",
8
+ "status": "approved",
9
+ "counterparty": {
10
+ "accountHolder": {
11
+ "fullName": "Example Merchant Ltd"
12
+ }
13
+ },
14
+ "createdAt": "2026-02-23T13:04:15.683Z",
15
+ "updatedAt": "2026-02-23T13:04:15.683Z"
16
+ }
17
+ ],
18
+ "itemsTotal": 1
19
+ }
@@ -0,0 +1,14 @@
1
+ {
2
+ "id": "MNDT7QXPLKT9R333640TX334709E",
3
+ "type": "bacs",
4
+ "balanceAccountId": "BA43EKD334339T6N8X655DW77",
5
+ "paymentInstrumentId": "PI43EKK334339T6N8X65688CS",
6
+ "status": "approved",
7
+ "counterparty": {
8
+ "accountHolder": {
9
+ "fullName": "Example Merchant Ltd"
10
+ }
11
+ },
12
+ "createdAt": "2026-02-23T13:04:15.683Z",
13
+ "updatedAt": "2026-02-23T13:04:15.683Z"
14
+ }
@@ -0,0 +1,21 @@
1
+ {
2
+ "payoutScheduleExecutions": [
3
+ {
4
+ "id": "PS0000000000001",
5
+ "result": "skipped",
6
+ "triggeredAt": "2026-03-11T08:00:00Z",
7
+ "resultDetails": {
8
+ "reasonCode": "noBalanceToPayOut",
9
+ "reason": "No balance to pay out"
10
+ }
11
+ },
12
+ {
13
+ "id": "PS0000000000002",
14
+ "result": "succeeded",
15
+ "triggeredAt": "2026-03-12T08:00:00Z",
16
+ "resultDetails": {
17
+ "transferId": "A0A0A0A0A0A0A0A0"
18
+ }
19
+ }
20
+ ]
21
+ }
@@ -0,0 +1,35 @@
1
+ {
2
+ "recurringTopUps": [
3
+ {
4
+ "id": "TUPC0000000000000000000001",
5
+ "counterparty": {
6
+ "transferInstrumentId": "SE000000000000000000000001"
7
+ },
8
+ "description": "My description",
9
+ "topUpAmount": {
10
+ "fixed": {
11
+ "value": 1000,
12
+ "currency": "EUR"
13
+ }
14
+ },
15
+ "trigger": {
16
+ "schedule": {
17
+ "type": "weekdays"
18
+ },
19
+ "threshold": {
20
+ "value": 100,
21
+ "currency": "EUR"
22
+ }
23
+ },
24
+ "status": "active"
25
+ }
26
+ ],
27
+ "link": {
28
+ "next": {
29
+ "href": "/balanceAccounts/balanceAccount1/recurringTopUps?limit=10&cursor=nextCursorToken"
30
+ },
31
+ "previous": {
32
+ "href": "/balanceAccounts/balanceAccount1/recurringTopUps?limit=10&cursor=previousCursorToken"
33
+ }
34
+ }
35
+ }
@@ -0,0 +1,12 @@
1
+ {
2
+ "counterparty": {
3
+ "balanceAccountId": "BA3227C223222B5BLP6JQC3FD"
4
+ },
5
+ "currency": "EUR",
6
+ "id": "SWEP00000000000000000000000001",
7
+ "schedule": {
8
+ "type": "daily"
9
+ },
10
+ "status": "active",
11
+ "type": "push"
12
+ }
@@ -0,0 +1,17 @@
1
+ {
2
+ "data": [
3
+ {
4
+ "legalEntityId": "LE123",
5
+ "taxYears": [
6
+ 2023
7
+ ]
8
+ },
9
+ {
10
+ "legalEntityId": "LE987",
11
+ "taxYears": [
12
+ 2024,
13
+ 2025
14
+ ]
15
+ }
16
+ ]
17
+ }
@@ -0,0 +1,10 @@
1
+ {
2
+ "scaAssociations": [
3
+ {
4
+ "scaDeviceId": "BSDR11111111111A1AAA1AAAAA1AA1",
5
+ "entityType": "accountHolder",
6
+ "entityId": "AH00000000000000000000001",
7
+ "status": "pendingApproval"
8
+ }
9
+ ]
10
+ }
@@ -0,0 +1,18 @@
1
+ {
2
+ "id": "PSAC00000000000000000000000001",
3
+ "balancePlatformPayoutScheduleId": "PSPC00000000000000000000000001",
4
+ "balanceAccountId": "BA000000000000000000001",
5
+ "transferInstrumentId": "SE00000000000000000000001",
6
+ "currency": "EUR",
7
+ "reference": "Monthly payout",
8
+ "description": "Updated payout description",
9
+ "referenceForBeneficiary": "PAYOUT-REF-001",
10
+ "retainedAmount": 20000,
11
+ "minPayoutAmount": 1000,
12
+ "maxPayoutAmount": 100000000,
13
+ "createdAt": "2024-01-15T10:30:00Z",
14
+ "updatedAt": "2024-01-16T14:00:00Z",
15
+ "enabled": false,
16
+ "frequency": "monthly",
17
+ "frequencyValue": 1
18
+ }