adyen-ruby-api-library 6.2.0 → 7.0.0

data/spec/management_spec.rb

@@ -0,0 +1,68 @@
+require "spec_helper"
+require "json"
+
+# rubocop:disable Metrics/BlockLength
+
+RSpec.describe Adyen::Management, service: "Management" do
+  before(:all) do
+    @shared_values = {
+      client: create_client(:api_key),
+      service: "Management",
+    }
+  end
+
+  # must be created manually because every field in the response is an array
+  it "makes a companies GET call" do
+    response_body = json_from_file("mocks/responses/Management/get_companies.json")
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "companies", @shared_values[:client].management.version)
+    WebMock.stub_request(:get, url).
+      with(
+        headers: {
+          "x-api-key" => @shared_values[:client].api_key
+        }
+      ).
+      to_return(
+        body: response_body
+      )
+
+    result = @shared_values[:client].management.account_company_level_api.list_company_accounts()
+    response_hash = result.response
+
+    expect(result.status).
+      to eq(200)
+    expect(response_hash).
+      to eq(JSON.parse(response_body))
+    expect(response_hash).
+      to be_a Adyen::HashWithAccessors
+    expect(response_hash).
+      to be_a_kind_of Hash
+  end
+
+  it "makes a create_store POST call" do
+    request_body = JSON.parse(json_from_file("mocks/responses/LegalEntityManagement/create_business_line.json"))
+
+    response_body = json_from_file("mocks/responses/LegalEntityManagement/create_business_line.json")
+
+    url = @shared_values[:client].service_url(@shared_values[:service], "merchants/merchantID/stores", @shared_values[:client].management.version)
+    WebMock.stub_request(:post, url).
+      with(
+        body: request_body,
+        headers: {
+          "x-api-key" => @shared_values[:client].api_key
+        }
+      ).
+      to_return(
+        body: response_body
+      )
+
+    result = @shared_values[:client].management.account_store_level_api.create_store_by_merchant_id(request_body, 'merchantID')
+    response_hash = result.response
+
+      expect(result.status).
+      to eq(200)
+  end
+
+
+end
+

data/spec/mocks/requests/BalanceControl/balance_transfer.json

@@ -0,0 +1,10 @@
+{
+    "amount": {
+      "value": 50000,
+      "currency": "EUR"
+    },
+    "description": "Your description for the transfer",
+    "fromMerchant": "MerchantAccount_NL",
+    "toMerchant": "MerchantAccount_DE",
+    "type": "debit"
+  }

data/spec/mocks/requests/BalancePlatform/create_account_holder.json

@@ -0,0 +1,5 @@
+{
+    "description": "Liable account holder used for international payments and payouts",
+    "reference": "S.Eller-001",
+    "legalEntityId": "LE322JV223222D5GG42KN6869"
+  }

data/spec/mocks/requests/BalancePlatform/update_account_holder.json

@@ -0,0 +1,10 @@
+{
+    "description": "Liable account holder used for international payments and payouts",
+    "reference": "S.Eller-001",
+    "legalEntityId": "LE322JV223222D5GG42KN6869",
+    "capabilities": {
+      "receivePayments": {
+        "requested": true
+      }
+    }
+  }

data/spec/mocks/requests/LegalEntityManagement/create_business_line.json

@@ -0,0 +1,15 @@
+{
+    "service": "banking",
+    "industryCode": "4531",
+    "webData": [
+      {
+        "webAddress": "https://www.adyen.com"
+      }
+    ],
+    "legalEntityId": "YOUR_LEGAL_ENTITY",
+    "sourceOfFunds": {
+      "type": "business",
+      "adyenProcessedFunds": false,
+      "description": "Funds from my flower shop business"
+    }
+  }

data/spec/mocks/requests/Management/create_store.json

@@ -0,0 +1,15 @@
+{
+    "description": "City centre store",
+    "shopperStatement": "Springfield Shop",
+    "phoneNumber": "1813702551707653",
+    "reference": "Spring_store_2",
+    "address": {
+      "country": "US",
+      "line1": "200 Main Street",
+      "line2": "Building 5A",
+      "line3": "Suite 3",
+      "city": "Springfield",
+      "stateOrProvince": "NY",
+      "postalCode": "20250"
+    }
+  }

data/spec/mocks/requests/Recurring/create_permit.json

@@ -0,0 +1,6 @@
+{
+    "permits": "object",
+    "merchantAccount": "TestMerchant",
+    "shopperReference": "shopperReference",
+    "recurringDetailsReference": "object"
+  }

data/spec/mocks/requests/StoredValue/issue_giftcard.json

@@ -0,0 +1,12 @@
+{
+    "merchantAccount": "YOUR_MERCHANT_ACCOUNT",
+    "store": "YOUR_STORE_ID",
+    "paymentMethod": {
+        "type": "givex"
+    },
+    "amount": {
+        "currency": "EUR",
+        "value": 1000
+    },
+    "reference": "YOUR_REFERENCE"
+}

data/spec/mocks/requests/Transfers/get_transactions.json

@@ -0,0 +1,82 @@
+{
+    "data": [
+      {
+        "accountHolderId": "AHA1B2C3D4E5F6G7H8I9J0",
+        "amount": {
+          "currency": "EUR",
+          "value": -9
+        },
+        "balanceAccountId": "BAB8B2C3D4E5F6G7H8D9J6GD4",
+        "balancePlatform": "YOUR_BALANCE_PLATFORM",
+        "bookingDate": "2022-03-11T11:21:24+01:00",
+        "category": "internal",
+        "counterparty": {
+          "balanceAccountId": "BA00000000000000000000001"
+        },
+        "createdAt": "2022-03-11T11:21:24+01:00",
+        "id": "1VVF0D5U66PIUIVP",
+        "instructedAmount": {
+          "currency": "EUR",
+          "value": -9
+        },
+        "reference": "REFERENCE_46e8c40e",
+        "status": "booked",
+        "transferId": "1VVF0D5U66PIUIVP",
+        "type": "fee",
+        "valueDate": "2022-03-11T11:21:24+01:00"
+      },
+      {
+        "accountHolderId": "AHA1B2C3D4E5F6G7H8I9J0",
+        "amount": {
+          "currency": "EUR",
+          "value": -46
+        },
+        "balanceAccountId": "BAB8B2C3D4E5F6G7H8D9J6GD4",
+        "balancePlatform": "YOUR_BALANCE_PLATFORM",
+        "bookingDate": "2022-03-12T14:22:52+01:00",
+        "category": "internal",
+        "counterparty": {
+          "balanceAccountId": "BA00000000000000000000001"
+        },
+        "createdAt": "2022-03-12T14:22:52+01:00",
+        "id": "1WEPGD5U6MS1CFK3",
+        "instructedAmount": {
+          "currency": "EUR",
+          "value": -46
+        },
+        "reference": "YOUR_REFERENCE",
+        "status": "booked",
+        "transferId": "1WEPGD5U6MS1CFK3",
+        "type": "fee",
+        "valueDate": "2022-03-12T14:22:52+01:00"
+      },
+      {
+        "accountHolderId": "AHA1B2C3D4E5F6G7H8I9J0",
+        "amount": {
+          "currency": "EUR",
+          "value": -8
+        },
+        "balanceAccountId": "BAB8B2C3D4E5F6G7H8D9J6GD4",
+        "balancePlatform": "YOUR_BALANCE_PLATFORM",
+        "bookingDate": "2022-03-14T21:00:48+01:00",
+        "createdAt": "2022-03-14T15:00:00+01:00",
+        "description": "YOUR_DESCRIPTION_2",
+        "id": "2QP32A5U7IWC5WKG",
+        "counterparty": {
+          "balanceAccountId": "BA00000000000000000000001"
+        },
+        "reference": "REFERENCE_46e8c40e",
+        "instructedAmount": {
+          "currency": "EUR",
+          "value": -8
+        },
+        "status": "booked",
+        "valueDate": "2022-03-14T21:00:48+01:00"
+      }
+    ],
+    "_links": {
+      "next": {
+        "href": "https://balanceplatform-api-test.adyen.com/btl/v2/transactions?balancePlatform=Bastronaut&createdUntil=2022-03-21T00%3A00%3A00Z&createdSince=2022-03-11T00%3A00%3A00Z&limit=3&cursor=S2B-TSAjOkIrYlIlbjdqe0RreHRyM32lKRSxubXBHRkhHL2E32XitQQz5SfzpucD5HbHwpM1p6NDR1eXVQLFF6MmY33J32sobDxQYT90MHIud1hwLnd6JitcX32xJ"
+      }
+    }
+  }

data/spec/mocks/requests/Transfers/make_transfer.json

@@ -0,0 +1,32 @@
+{
+    "amount": {
+      "value": 110000,
+      "currency": "EUR"
+    },
+    "balanceAccountId": "BAB8B2C3D4E5F6G7H8D9J6GD4",
+    "category": "bank",
+    "counterparty": {
+      "bankAccount": {
+        "accountHolder": {
+          "fullName": "A. Klaassen",
+          "address": {
+            "city": "San Francisco",
+            "country": "US",
+            "postalCode": "94678",
+            "stateOrProvince": "CA",
+            "street": "Brannan Street",
+            "street2": "274"
+          }
+        },
+        "accountIdentification": {
+          "type": "numberAndBic",
+          "accountNumber": "123456789",
+          "bic": "BOFAUS3NXXX"
+        }
+      }
+    },
+    "priority": "crossBorder",
+    "referenceForBeneficiary": "Your-reference-sent-to-the-beneficiary",
+    "reference": "Your internal reference for the transfer",
+    "description": "Your description for the transfer"
+  }

data/spec/mocks/responses/BalanceControl/balance_transfer.json

@@ -0,0 +1,14 @@
+{
+    "amount": {
+      "value": 50000,
+      "currency": "EUR"
+    },
+    "createdAt": "2022-01-24T14:59:11+01:00",
+    "description": "Your description for the transfer",
+    "fromMerchant": "MerchantAccount_NL",
+    "toMerchant": "MerchantAccount_DE",
+    "type": "debit",
+    "reference": "Unique reference for the transfer",
+    "pspReference": "8816080397613514",
+    "status": "transferred"
+  }

data/spec/mocks/responses/BalancePlatform/create_account_holder.json

@@ -0,0 +1,41 @@
+{
+    "balancePlatform": "YOUR_BALANCE_PLATFORM",
+    "description": "Liable account holder used for international payments and payouts",
+    "legalEntityId": "LE322JV223222D5GG42KN6869",
+    "reference": "S.Eller-001",
+    "capabilities": {
+      "receiveFromPlatformPayments": {
+        "enabled": true,
+        "requested": true,
+        "allowed": false,
+        "verificationStatus": "pending"
+      },
+      "receiveFromBalanceAccount": {
+        "enabled": true,
+        "requested": true,
+        "allowed": false,
+        "verificationStatus": "pending"
+      },
+      "sendToBalanceAccount": {
+        "enabled": true,
+        "requested": true,
+        "allowed": false,
+        "verificationStatus": "pending"
+      },
+      "sendToTransferInstrument": {
+        "enabled": true,
+        "requested": true,
+        "allowed": false,
+        "requestedSettings": {
+          "interval": "daily",
+          "maxAmount": {
+            "currency": "EUR",
+            "value": 0
+          }
+        },
+        "verificationStatus": "pending"
+      }
+    },
+    "id": "AH32272223222G5HNCR9S3M5Z",
+    "status": "active"
+  }

data/spec/mocks/responses/BalancePlatform/get_balance_account.json

@@ -0,0 +1,15 @@
+{
+    "accountHolderId": "AH32272223222B59K6RTQBFNZ",
+    "defaultCurrencyCode": "EUR",
+    "timeZone": "Europe/Amsterdam",
+    "balances": [
+      {
+        "available": 0,
+        "balance": 0,
+        "currency": "EUR",
+        "reserved": 0
+      }
+    ],
+    "id": "BA3227C223222B5BLP6JQC3FD",
+    "status": "active"
+  }

data/spec/mocks/responses/BalancePlatform/update_account_holder.json

@@ -0,0 +1,16 @@
+{
+    "balancePlatform": "YOUR_BALANCE_PLATFORM",
+    "description": "Liable account holder used for international payments and payouts",
+    "legalEntityId": "LE322JV223222F5GKQZZ9DS99",
+    "reference": "S.Eller-001",
+    "capabilities": {
+      "receivePayments": {
+        "enabled": false,
+        "requested": true,
+        "allowed": false,
+        "verificationStatus": "pending"
+      }
+    },
+    "id": "AH3227C223222C5GKR23686TF",
+    "status": "active"
+  }

data/spec/mocks/responses/Checkout/stored_payment_methods.json

@@ -0,0 +1 @@
+{"merchantAccount":"TestMerchantAccount", "shopperReference":"test-1234"}

data/spec/mocks/responses/LegalEntityManagement/create_business_line.json

@@ -0,0 +1,17 @@
+{
+    "industryCode": "4531",
+    "legalEntityId": "YOUR_LEGAL_ENTITY",
+    "service": "banking",
+    "sourceOfFunds": {
+      "adyenProcessedFunds": false,
+      "description": "Funds from my flower shop business",
+      "type": "business"
+    },
+    "webData": [
+      {
+        "webAddress": "https://www.adyen.com",
+        "webAddressId": "SE322KH223222N5HN4HP54PZC"
+      }
+    ],
+    "id": "SE322KH223222N5HN4HP54PXD"
+  }

data/spec/mocks/responses/Management/create_store.json

@@ -0,0 +1,23 @@
+{
+    "id": "YOUR_STORE_ID",
+    "address": {
+      "country": "US",
+      "line1": "200 Main Street",
+      "line2": "Building 5A",
+      "line3": "Suite 3",
+      "city": "Springfield",
+      "stateOrProvince": "NY",
+      "postalCode": "20250"
+    },
+    "description": "City centre store",
+    "merchantId": "YOUR_MERCHANT_ACCOUNT_ID",
+    "shopperStatement": "Springfield Shop",
+    "phoneNumber": "1813702551707653",
+    "reference": "Spring_store_2",
+    "status": "active",
+    "_links": {
+      "self": {
+        "href": "https://management-test.adyen.com/v1/stores/YOUR_STORE_ID"
+      }
+    }
+  }

data/spec/mocks/responses/Management/get_companies.json

@@ -0,0 +1,42 @@
+{
+    "_links": {
+      "first": {
+        "href": "https://management-test.adyen.com/v1/companies?pageNumber=1&pageSize=10"
+      },
+      "last": {
+        "href": "https://management-test.adyen.com/v1/companies?pageNumber=1&pageSize=10"
+      },
+      "self": {
+        "href": "https://management-test.adyen.com/v1/companies?pageNumber=1&pageSize=10"
+      }
+    },
+    "itemsTotal": 1,
+    "pagesTotal": 1,
+    "data": [
+      {
+        "id": "YOUR_COMPANY_ACCOUNT",
+        "name": "YOUR_COMPANY_NAME",
+        "status": "Active",
+        "dataCenters": [
+          {
+            "name": "default",
+            "livePrefix": ""
+          }
+        ],
+        "_links": {
+          "self": {
+            "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"
+          },
+          "apiCredentials": {
+            "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/apiCredentials"
+          },
+          "users": {
+            "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/users"
+          },
+          "webhooks": {
+            "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks"
+          }
+        }
+      }
+    ]
+  }

data/spec/mocks/responses/Recurring/create_permit.json

@@ -0,0 +1,4 @@
+{
+    "pspReference": "8815260599791117",
+    "permitResultList": [{"yadayada": "yadayada"}]
+}

data/spec/mocks/responses/StoredValue/issue_giftcard.json

@@ -0,0 +1,13 @@
+{
+    "currentBalance": {
+        "currency": "EUR",
+        "value": 1000
+    },
+    "pspReference": "851564651069192J",
+    "resultCode": "Success",
+    "paymentMethod": {
+        "number": "7219627091701347",
+        "securityCode": "0140",
+        "type": "givex"
+    }
+}

data/spec/mocks/responses/Transfers/get_transactions.json

@@ -0,0 +1,82 @@
+{
+    "data": [
+      {
+        "accountHolderId": "AHA1B2C3D4E5F6G7H8I9J0",
+        "amount": {
+          "currency": "EUR",
+          "value": -9
+        },
+        "balanceAccountId": "BAB8B2C3D4E5F6G7H8D9J6GD4",
+        "balancePlatform": "YOUR_BALANCE_PLATFORM",
+        "bookingDate": "2022-03-11T11:21:24+01:00",
+        "category": "internal",
+        "counterparty": {
+          "balanceAccountId": "BA00000000000000000000001"
+        },
+        "createdAt": "2022-03-11T11:21:24+01:00",
+        "id": "1VVF0D5U66PIUIVP",
+        "instructedAmount": {
+          "currency": "EUR",
+          "value": -9
+        },
+        "reference": "REFERENCE_46e8c40e",
+        "status": "booked",
+        "transferId": "1VVF0D5U66PIUIVP",
+        "type": "fee",
+        "valueDate": "2022-03-11T11:21:24+01:00"
+      },
+      {
+        "accountHolderId": "AHA1B2C3D4E5F6G7H8I9J0",
+        "amount": {
+          "currency": "EUR",
+          "value": -46
+        },
+        "balanceAccountId": "BAB8B2C3D4E5F6G7H8D9J6GD4",
+        "balancePlatform": "YOUR_BALANCE_PLATFORM",
+        "bookingDate": "2022-03-12T14:22:52+01:00",
+        "category": "internal",
+        "counterparty": {
+          "balanceAccountId": "BA00000000000000000000001"
+        },
+        "createdAt": "2022-03-12T14:22:52+01:00",
+        "id": "1WEPGD5U6MS1CFK3",
+        "instructedAmount": {
+          "currency": "EUR",
+          "value": -46
+        },
+        "reference": "YOUR_REFERENCE",
+        "status": "booked",
+        "transferId": "1WEPGD5U6MS1CFK3",
+        "type": "fee",
+        "valueDate": "2022-03-12T14:22:52+01:00"
+      },
+      {
+        "accountHolderId": "AHA1B2C3D4E5F6G7H8I9J0",
+        "amount": {
+          "currency": "EUR",
+          "value": -8
+        },
+        "balanceAccountId": "BAB8B2C3D4E5F6G7H8D9J6GD4",
+        "balancePlatform": "YOUR_BALANCE_PLATFORM",
+        "bookingDate": "2022-03-14T21:00:48+01:00",
+        "createdAt": "2022-03-14T15:00:00+01:00",
+        "description": "YOUR_DESCRIPTION_2",
+        "id": "2QP32A5U7IWC5WKG",
+        "counterparty": {
+          "balanceAccountId": "BA00000000000000000000001"
+        },
+        "reference": "REFERENCE_46e8c40e",
+        "instructedAmount": {
+          "currency": "EUR",
+          "value": -8
+        },
+        "status": "booked",
+        "valueDate": "2022-03-14T21:00:48+01:00"
+      }
+    ],
+    "_links": {
+      "next": {
+        "href": "https://balanceplatform-api-test.adyen.com/btl/v2/transactions?balancePlatform=Bastronaut&createdUntil=2022-03-21T00%3A00%3A00Z&createdSince=2022-03-11T00%3A00%3A00Z&limit=3&cursor=S2B-TSAjOkIrYlIlbjdqe0RreHRyM32lKRSxubXBHRkhHL2E32XitQQz5SfzpucD5HbHwpM1p6NDR1eXVQLFF6MmY33J32sobDxQYT90MHIud1hwLnd6JitcX32xJ"
+      }
+    }
+  }

data/spec/mocks/responses/Transfers/make_transfer.json

@@ -0,0 +1,36 @@
+{
+    "id": "1W1UG35U8A9J5ZLG",
+    "amount": {
+      "value": 110000,
+      "currency": "EUR"
+    },
+    "balanceAccountId": "BAB8B2C3D4E5F6G7H8D9J6GD4",
+    "category": "bank",
+    "counterparty": {
+      "bankAccount": {
+        "accountHolder": {
+          "fullName": "A. Klaassen",
+          "address": {
+            "city": "San Francisco",
+            "country": "US",
+            "postalCode": "94678",
+            "stateOrProvince": "CA",
+            "street": "Brannan Street",
+            "street2": "274"
+          }
+        },
+        "accountIdentification": {
+          "type": "numberAndBic",
+          "accountNumber": "123456789",
+          "bic": "BOFAUS3NXXX"
+        }
+      },
+      "priority": "crossBorder",
+      "referenceForBeneficiary": "Your-reference-sent-to-the-beneficiary",
+      "reference": "Your internal reference for the transfer",
+      "description": "Your description for the transfer",
+      "direction": "outgoing",
+      "reason": "approved",
+      "status": "authorised"
+    }
+  }

data/spec/mocks/responses/Webhooks/backslash_notification.json

@@ -0,0 +1,41 @@
+{
+  "additionalData": {
+    "acquirerCode": "TestPmmAcquirer",
+    "acquirerReference": "DZMKWLXW6N6",
+    "authCode": "076181",
+    "avsResult": "5 No AVS data provided",
+    "avsResultRaw": "5",
+    "cardSummary": "1111",
+    "checkout.cardAddedBrand": "visa",
+    "cvcResult": "1 Matches",
+    "cvcResultRaw": "M",
+    "expiryDate": "03/2030",
+    "hmacSignature": "nIgT81gaB5oJpn2jPXupDq68iRo2wUlBsuYjtYfwKqo=",
+    "paymentMethod": "visa",
+    "refusalReasonRaw": "AUTHORISED",
+    "retry.attempt1.acquirer": "TestPmmAcquirer",
+    "retry.attempt1.acquirerAccount": "TestPmmAcquirerAccount",
+    "retry.attempt1.avsResultRaw": "5",
+    "retry.attempt1.rawResponse": "AUTHORISED",
+    "retry.attempt1.responseCode": "Approved",
+    "retry.attempt1.scaExemptionRequested": "lowValue",
+    "scaExemptionRequested": "lowValue"
+  },
+  "amount": {
+    "currency": "EUR",
+    "value": 1000
+  },
+  "eventCode": "AUTHORISATION",
+  "eventDate": "2023-01-09T16:27:29+01:00",
+  "merchantAccountCode": "AntoniStroinski",
+  "merchantReference": "\\\\slashes are fun",
+  "operations": [
+    "CANCEL",
+    "CAPTURE",
+    "REFUND"
+  ],
+  "paymentMethod": "visa",
+  "pspReference": "T7FD4VM4D3RZNN82",
+  "reason": "076181:1111:03/2030",
+  "success": "true"
+}