jlengrand/adyen-openapi
1
0
Fork 0
mirror of https://github.com/gcatanese/adyen-openapi.git synced 2026-03-10 08:01:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

spec release

Browse Source
This commit is contained in:
Adyen Automation
2022-09-02 13:07:12 +00:00
parent 6c7b210953
commit 367e80eb50
6 changed files with 4027 additions and 864 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1341
json/BalancePlatformNotificationService-v1.json
View File

File diff suppressed because it is too large Load Diff

858
json/BalancePlatformService-v1.json
View File

File diff suppressed because it is too large Load Diff

328
json/BalancePlatformService-v2.json
View File

@@ -8,9 +8,9 @@
"info" : {
"version" : "2",
"x-publicVersion" : true,
"title" : "Balance Platform Configuration API",
"description" : "The Balance Platform Configuration API enables you to create a platform where you can onboard users as account holders and create balance accounts, cards, and bank accounts.\n\nFor information about use cases, refer to [Adyen Issuing](https://docs.adyen.com/issuing).\n\n ## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-U \"ws@BalancePlatform.YOUR_BALANCE_PLATFORM\":\"YOUR_WS_PASSWORD\" \\\n...\n```\n## Versioning\nThe Balance Platform Configuration API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://balanceplatform-api-test.adyen.com/bcl/v1\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the API key or the username and password to send requests to `https://balanceplatform-api-live.adyen.com/bcl/v1`.\n\nFor more information, refer to our [Going live documentation](https://docs.adyen.com/issuing/integration-checklist#going-live).",
"x-timestamp" : "2022-05-06T17:19:23Z",
"title" : "Configuration API",
"description" : "The Configuration API enables you to create a platform where you can onboard your users as account holders and create balance accounts, cards, and business accounts.\n\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-U \"ws@BalancePlatform.YOUR_BALANCE_PLATFORM\":\"YOUR_WS_PASSWORD\" \\\n...\n```\n## Versioning\nThe Configuration API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://balanceplatform-api-test.adyen.com/bcl/v1\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the API key or the username and password to send requests to `https://balanceplatform-api-live.adyen.com/bcl/v1`.\n\n",
"x-timestamp" : "2022-07-28T15:32:11Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -53,7 +53,7 @@
"Account holders"
],
"summary" : "Create an account holder",
"description" : "Creates an account holder that represents your user's entity within the balance platform.\n\nFor more information, refer to [Create accounts](https://docs.adyen.com/issuing/create-accounts).",
"description" : "Creates an account holder linked to a [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities).\n\n",
"x-addedInVersion" : "1",
"operationId" : "post-accountHolders",
"x-groupName" : "Account holders",
@@ -306,7 +306,7 @@
"Account holders"
],
"summary" : "Update an account holder",
"description" : "Updates an account holder. When updating an account holder resource, note that:\n\n* If a parameter is not provided in the request, the parameter is left unchanged.\n\n* When updating any parameter in the `contactDetails` object, you must send all other existing `contactDetails` parameters.",
"description" : "Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged.",
"x-addedInVersion" : "1",
"operationId" : "patch-accountHolders-id",
"x-groupName" : "Account holders",
@@ -351,8 +351,8 @@
"content" : {
"application/json" : {
"examples" : {
"success" : {
"$ref" : "#/components/examples/patch-accountHolders-id-success-200"
"updateAccountHolderStatus" : {
"$ref" : "#/components/examples/patch-accountHolders-id-updateAccountHolderStatus-200"
}
},
"schema" : {
@@ -446,7 +446,7 @@
"Account holders"
],
"summary" : "Get all balance accounts of an account holder",
"description" : "Returns a paginated list of balance accounts associated with an account holder. To fetch multiple pages, use the query parameters. \n\nFor example, to limit the page to 5 balance accounts and skip the first 10, use `/accountHolders/{id}/balanceAccounts?limit=5&offset=10`.",
"description" : "Returns a paginated list of the balance accounts associated with an account holder. To fetch multiple pages, use the query parameters. \n\nFor example, to limit the page to 5 balance accounts and skip the first 10, use `/accountHolders/{id}/balanceAccounts?limit=5&offset=10`.",
"x-addedInVersion" : "1",
"operationId" : "get-accountHolders-id-balanceAccounts",
"x-groupName" : "Account holders",
@@ -592,7 +592,7 @@
"Balance accounts"
],
"summary" : "Create a balance account",
"description" : "Creates a balance account that holds the funds of the associated account holder. \n\nFor more information, refer to [Create accounts](https://docs.adyen.com/issuing/create-accounts).",
"description" : "Creates a balance account that holds the funds of the associated account holder. \n\n",
"x-addedInVersion" : "1",
"operationId" : "post-balanceAccounts",
"x-groupName" : "Balance accounts",
@@ -2120,8 +2120,8 @@
"content" : {
"application/json" : {
"examples" : {
"success" : {
"$ref" : "#/components/examples/post-paymentInstrumentGroups-success-200"
"createPaymentInstrumentGroups" : {
"$ref" : "#/components/examples/post-paymentInstrumentGroups-createPaymentInstrumentGroups-200"
}
},
"schema" : {
@@ -2215,7 +2215,7 @@
"Payment instrument groups"
],
"summary" : "Get a payment instrument group",
"description" : "Returns a payment instrument group.",
"description" : "Returns the details of a payment instrument group.",
"x-addedInVersion" : "1",
"operationId" : "get-paymentInstrumentGroups-id",
"x-groupName" : "Payment instrument groups",
@@ -2467,7 +2467,7 @@
"Payment instruments"
],
"summary" : "Create a payment instrument",
"description" : "Creates a payment instrument to issue either a physical or a virtual card to your user.\n\n For more information, refer to [Create cards](https://docs.adyen.com/issuing/create-cards).",
"description" : "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user.\n\n For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts).",
"x-addedInVersion" : "1",
"operationId" : "post-paymentInstruments",
"x-groupName" : "Payment instruments",
@@ -2486,6 +2486,9 @@
"content" : {
"application/json" : {
"examples" : {
"createBusinessAccount" : {
"$ref" : "#/components/examples/post-paymentInstruments-createBusinessAccount"
},
"createPhysicalCard" : {
"$ref" : "#/components/examples/post-paymentInstruments-createPhysicalCard"
},
@@ -2504,8 +2507,14 @@
"content" : {
"application/json" : {
"examples" : {
"success" : {
"$ref" : "#/components/examples/post-paymentInstruments-success-200"
"createBusinessAccount" : {
"$ref" : "#/components/examples/post-paymentInstruments-createBusinessAccount-200"
},
"createPhysicalCard" : {
"$ref" : "#/components/examples/post-paymentInstruments-createPhysicalCard-200"
},
"createVirtualCard" : {
"$ref" : "#/components/examples/post-paymentInstruments-createVirtualCard-200"
}
},
"schema" : {
@@ -2599,7 +2608,7 @@
"Payment instruments"
],
"summary" : "Get a payment instrument",
"description" : "Returns a payment instrument.",
"description" : "Returns the details of a payment instrument.",
"x-addedInVersion" : "1",
"operationId" : "get-paymentInstruments-id",
"x-groupName" : "Payment instruments",
@@ -3266,7 +3275,7 @@
"Transaction rules"
],
"summary" : "Get a transaction rule",
"description" : "Returns a transaction rule.",
"description" : "Returns the details of a transaction rule.",
"x-addedInVersion" : "1",
"operationId" : "get-transactionRules-transactionRuleId",
"x-groupName" : "Transaction rules",
@@ -3435,8 +3444,8 @@
"content" : {
"application/json" : {
"examples" : {
"success" : {
"$ref" : "#/components/examples/patch-transactionRules-transactionRuleId-success-200"
"updateTransactionRuleStatus" : {
"$ref" : "#/components/examples/patch-transactionRules-transactionRuleId-updateTransactionRuleStatus-200"
}
},
"schema" : {
@@ -3555,7 +3564,7 @@
"type" : "string"
},
"legalEntityId" : {
"description" : "The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/legalEntities__resParam_id) associated with the account holder. Adyen performs a verification process against the legal entity of the account holder.\n\nFor more information on how to create a legal entity, refer to [Onboard and verify account holders](https://docs.adyen.com/issuing/kyc-verification).",
"description" : "The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/legalEntities__resParam_id) associated with the account holder. Adyen performs a verification process against the legal entity of the account holder.\n\n",
"type" : "string"
},
"primaryBalanceAccount" : {
@@ -3568,7 +3577,7 @@
"type" : "string"
},
"status" : {
"description" : "The status of the account holder.\n\nPossible values: \n\n * **Active**: The account holder is active. This is the default status when creating an account holder. \n\n * **Suspended**: The account holder is temporarily suspended. You can set the account back to active or close it permanently. \n\n* **Closed**: The account holder is permanently deactivated. This action cannot be undone.",
"description" : "The status of the account holder.\n\nPossible values: \n\n * **Active**: The account holder is active. This is the default status when creating an account holder. \n\n * **Inactive**: The account holder is temporarily inactive. You can set the account back to active or close it permanently. \n\n * **Suspended**: The account holder is permanently suspended by Adyen. This action cannot be undone. \n\n* **Closed**: The account holder is permanently deactivated. This action cannot be undone.",
"enum" : [
"active",
"closed",
@@ -3677,7 +3686,7 @@
"type" : "string"
},
"legalEntityId" : {
"description" : "The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/legalEntities__resParam_id) associated with the account holder. Adyen performs a verification process against the legal entity of the account holder.\n\nFor more information on how to create a legal entity, refer to [Onboard and verify account holders](https://docs.adyen.com/issuing/kyc-verification).",
"description" : "The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/legalEntities__resParam_id) associated with the account holder. Adyen performs a verification process against the legal entity of the account holder.\n\n",
"type" : "string"
},
"reference" : {
@@ -3748,7 +3757,7 @@
"country"
]
},
"Address2" : {
"Address-2" : {
"properties" : {
"city" : {
"description" : "The name of the city.",
@@ -4009,6 +4018,17 @@
"hasNext"
]
},
"BankAccount" : {
"properties" : {
"iban" : {
"description" : "The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number) (IBAN).",
"type" : "string"
}
},
"required" : [
"iban"
]
},
"BrandVariantsRestriction" : {
"properties" : {
"operation" : {
@@ -4144,7 +4164,7 @@
"type" : "string"
},
"cardholderName" : {
"description" : "The name of the card holder.\n Maximum length: 26 characters.",
"description" : "The name of the cardholder.\n Maximum length: 26 characters.",
"maxLength" : 26,
"type" : "string"
},
@@ -4271,7 +4291,7 @@
"type" : "string"
},
"cardholderName" : {
"description" : "The name of the card holder.\n Maximum length: 26 characters.",
"description" : "The name of the cardholder.\n Maximum length: 26 characters.",
"maxLength" : 26,
"type" : "string"
},
@@ -4344,11 +4364,34 @@
"operation"
]
},
"CronSweepSchedule" : {
"additionalProperties" : false,
"properties" : {
"cronExpression" : {
"description" : "A [cron expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that is used to set the sweep schedule. The schedule uses the time zone of the balance account. For example, **30 17 * * MON** schedules a sweep every Monday at 17:30.\n\nThe expression must have five values separated by a single space in the following order:\n\n* Minute: **0-59**\n\n* Hour: **0-23**\n\n* Day of the month: **1-31**\n\n* Month: **1-12** or **JAN-DEC**\n\n* Day of the week: **0-7** (0 and 7 are Sunday) or **MON-SUN**.\n\nThe following non-standard characters are supported: *****, **L**, **#**, **W** and **/**. See [crontab guru](https://crontab.guru/) for more examples.",
"type" : "string"
},
"type" : {
"description" : "The schedule type.\n\nPossible values:\n\n* **cron**: push out funds based on a cron expression.\n\n* **daily**: push out funds daily at 07:00 AM CET.\n\n* **weekly**: push out funds every Monday at 07:00 AM CET.\n\n* **monthly**: push out funds every first of the month at 07:00 AM CET.\n\n* **balance**: pull in funds instantly if the balance is less than or equal to the `triggerAmount`. You can only use this for sweeps of `type` **pull** and when the source is a `merchantAccount` or `transferInstrument`.",
"enum" : [
"daily",
"weekly",
"monthly",
"balance",
"cron"
],
"type" : "string"
}
},
"required" : [
"cronExpression"
]
},
"DeliveryContact" : {
"properties" : {
"address" : {
"description" : "The address of the contact.",
"$ref" : "#/components/schemas/Address2"
"$ref" : "#/components/schemas/Address-2"
},
"email" : {
"description" : "The email address of the contact.",
@@ -4370,7 +4413,11 @@
"description" : "The URL of the contact's website.",
"type" : "string"
}
}
},
"required" : [
"name",
"address"
]
},
"DifferentCurrenciesRestriction" : {
"properties" : {
@@ -4414,7 +4461,7 @@
"type" : "string"
},
"value" : {
"description" : "List of point-of-sale entry modes.\n\nPossible values: **manual**, **chip**, **magstripe**, **contactless**, **cof**, **token**, **server**, **barcode**, **ocr**.\n\n",
"description" : "List of point-of-sale entry modes.\n\nPossible values: **barcode**, **chip**, **cof**, **contactless**, **magstripe**, **manual**, **ocr**, **server**.\n\n",
"items" : {
"enum" : [
"barcode",
@@ -4425,7 +4472,6 @@
"manual",
"ocr",
"server",
"token",
"unknown"
],
"type" : "string"
@@ -4666,8 +4712,12 @@
"description" : "The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/balanceAccounts__resParam_id) associated with the payment instrument.",
"type" : "string"
},
"bankAccount" : {
"description" : "Contains the business account details. Returned when you create a payment instrument with `type` **bankAccount**.",
"$ref" : "#/components/schemas/BankAccount"
},
"card" : {
"description" : "Contains information about the card payment instrument.",
"description" : "Contains information about the card payment instrument. Returned when you create a payment instrument with `type` **card**.",
"$ref" : "#/components/schemas/Card"
},
"description" : {
@@ -4736,8 +4786,9 @@
"type" : "string"
},
"type" : {
"description" : "Type of payment instrument.\n\nPossible value: **card**. ",
"description" : "Type of payment instrument.\n\nPossible value: **card**, **bankAccount**. ",
"enum" : [
"bankAccount",
"card"
],
"type" : "string"
@@ -4892,8 +4943,9 @@
"type" : "string"
},
"type" : {
"description" : "Type of payment instrument.\n\nPossible value: **card**. ",
"description" : "Type of payment instrument.\n\nPossible value: **card**, **bankAccount**. ",
"enum" : [
"bankAccount",
"card"
],
"type" : "string"
@@ -5017,7 +5069,7 @@
"type" : "string"
},
"value" : {
"description" : "List of processing types.\n\nPossible values: **atmWithdraw**, **pos**, **ecommerce**, **moto**, **recurring**, **balanceInquiry**.\n\n",
"description" : "List of processing types.\n\nPossible values: **atmWithdraw**, **balanceInquiry**, **ecommerce**, **moto**, **pos**, **recurring**, **token**.\n\n",
"items" : {
"enum" : [
"atmWithdraw",
@@ -5025,7 +5077,6 @@
"ecommerce",
"moto",
"pos",
"purchaseWithCashback",
"recurring",
"token",
"unknown"
@@ -5061,10 +5112,6 @@
"description" : "A code that identifies the problem type.",
"type" : "string"
},
"errorType" : {
"description" : "A URI that identifies the problem type, pointing to human-readable documentation on this problem type.",
"type" : "string"
},
"instance" : {
"description" : "A unique URI that identifies the specific occurrence of the problem.",
"type" : "string"
@@ -5092,10 +5139,14 @@
"title" : {
"description" : "A short, human-readable summary of the problem type.",
"type" : "string"
},
"type" : {
"description" : "A URI that identifies the problem type, pointing to human-readable documentation on this problem type.",
"type" : "string"
}
},
"required" : [
"errorType",
"type",
"errorCode",
"title",
"detail",
@@ -5112,6 +5163,10 @@
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) in uppercase. For example, **EUR**.\n\nThe sweep currency must match any of the [balances currencies](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__resParam_balances).",
"type" : "string"
},
"description" : {
"description" : "The message that will be used in the sweep transfer's description body with a maximum length of 140 characters.\n\nIf the message is longer after replacing placeholders, the message will be cut off at 140 characters.",
"type" : "string"
},
"id" : {
"description" : "The unique identifier of the sweep.",
"readOnly" : true,
@@ -5119,7 +5174,14 @@
},
"schedule" : {
"description" : "The schedule when the `triggerAmount` is evaluated. If the balance meets the threshold, funds are pushed out of or pulled in to the balance account.",
"$ref" : "#/components/schemas/SweepSchedule"
"oneOf" : [
{
"$ref" : "#/components/schemas/CronSweepSchedule"
},
{
"$ref" : "#/components/schemas/SweepSchedule"
}
]
},
"status" : {
"x-enum" : [
@@ -5185,14 +5247,16 @@
}
},
"SweepSchedule" : {
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "The schedule type.\n\nPossible values:\n\n* **daily**: push out funds daily at 07:00 AM CET.\n\n* **weekly**: push out funds every Monday at 07:00 AM CET.\n\n* **monthly**: push out funds every first of the month at 07:00 AM CET.\n\n* **balance**: pull in funds instantly if the balance is less than or equal to the `triggerAmount`. You can only use this for sweeps of `type` **pull** and when the source is a `merchantAccount` or `transferInstrument`.",
"description" : "The schedule type.\n\nPossible values:\n\n* **cron**: push out funds based on a cron expression.\n\n* **daily**: push out funds daily at 07:00 AM CET.\n\n* **weekly**: push out funds every Monday at 07:00 AM CET.\n\n* **monthly**: push out funds every first of the month at 07:00 AM CET.\n\n* **balance**: pull in funds instantly if the balance is less than or equal to the `triggerAmount`. You can only use this for sweeps of `type` **pull** and when the source is a `merchantAccount` or `transferInstrument`.",
"enum" : [
"daily",
"weekly",
"monthly",
"balance"
"balance",
"cron"
],
"type" : "string"
}
@@ -5645,6 +5709,9 @@
},
"required" : [
]
},
"void" : {
}
},
"securitySchemes" : {
@@ -5660,7 +5727,7 @@
},
"examples" : {
"delete-transactionRules-transactionRuleId-success-200" : {
"summary" : "Response code - 200 OK",
"summary" : "Transaction rule deleted",
"description" : "Example response for successfully deleting a transaction rule",
"value" : {
"amount" : {
@@ -5750,7 +5817,7 @@
}
},
"get-accountHolders-id-balanceAccounts-success-200" : {
"summary" : "Response code - 200 OK",
"summary" : "List of balance accounts retrieved",
"description" : "Example response when retrieving a list of balance accounts under an account holder",
"value" : {
"balanceAccounts" : [
@@ -5778,7 +5845,7 @@
}
},
"get-accountHolders-id-success-200" : {
"summary" : "Response code - 200 OK",
"summary" : "Account holder retrieved",
"description" : "Example response when retrieving an account holder",
"value" : {
"balancePlatform" : "YOUR_BALANCE_PLATFORM",
@@ -5856,7 +5923,7 @@
}
},
"get-balanceAccounts-id-paymentInstruments-success-200" : {
"summary" : "Response code - 200 OK",
"summary" : "List of payment instruments retrieved",
"description" : "Example response when retrieving a list of payment instruments under a balance account",
"value" : {
"hasNext" : "true",
@@ -5922,7 +5989,7 @@
}
},
"get-balancePlatforms-id-accountHolders-success-200" : {
"summary" : "Response code - 200 OK",
"summary" : "List of account holders retrieved",
"description" : "Example response when retrieving a list of account holders under a balance platform",
"value" : {
"accountHolders" : [
@@ -5960,7 +6027,7 @@
}
},
"get-balancePlatforms-id-success-200" : {
"summary" : "Response code - 200 OK",
"summary" : "Balance platform retrieved",
"description" : "Example response when retrieving a balance platform",
"value" : {
"id" : "YOUR_BALANCE_PLATFORM",
@@ -5968,7 +6035,7 @@
}
},
"get-paymentInstrumentGroups-id-success-200" : {
"summary" : "Response code - 200 OK",
"summary" : "Payment instrument group retrieved",
"description" : "Example response when retrieving a payment instrument group",
"value" : {
"balancePlatform" : "YOUR_BALANCE_PLATFORM",
@@ -5977,7 +6044,7 @@
}
},
"get-paymentInstrumentGroups-id-transactionRules-success-200" : {
"summary" : "Response code - 200 OK",
"summary" : "Transaction rules for a payment instrument group retrieved",
"description" : "Example response when retrieving a list of transaction rules applied to a payment instrument group",
"value" : {
"transactionRules" : [
@@ -6039,7 +6106,7 @@
}
},
"get-paymentInstruments-id-transactionRules-success-200" : {
"summary" : "Response code - 200 OK",
"summary" : "Transaction rules for a payment instrument retrieved",
"description" : "Example response when retrieving a list of transaction rules applied to a payment instrument",
"value" : {
"transactionRules" : [
@@ -6076,7 +6143,7 @@
}
},
"get-transactionRules-transactionRuleId-success-200" : {
"summary" : "Response code - 200 OK",
"summary" : "Transaction rules retrieved",
"description" : "Example response when retrieving a transaction rule",
"value" : {
"transactionRule" : {
@@ -6094,8 +6161,15 @@
}
}
},
"patch-accountHolders-id-success-200" : {
"summary" : "Response code - 200 OK",
"patch-accountHolders-id-updateAccountHolderStatus" : {
"summary" : "Update the status of an account holder",
"description" : "Example request for updating the status of an account holder",
"value" : {
"status" : "Suspended"
}
},
"patch-accountHolders-id-updateAccountHolderStatus-200" : {
"summary" : "Account holder status updated",
"description" : "Example response for successfully updating the status of an account holder",
"value" : {
"balancePlatform" : "YOUR_BALANCE_PLATFORM",
@@ -6118,13 +6192,6 @@
"status" : "Suspended"
}
},
"patch-accountHolders-id-updateAccountHolderStatus" : {
"summary" : "Update the status of an account holder.",
"description" : "Example request for updating the status of an account holder",
"value" : {
"status" : "Suspended"
}
},
"patch-balanceAccounts-balanceAccountId-sweeps-sweepId-updateSweep-status" : {
"summary" : "Update the status of a sweep",
"description" : "Example request for updating a sweep",
@@ -6216,8 +6283,15 @@
"id" : "PI3227C223222B5CMD278FKGS"
}
},
"patch-transactionRules-transactionRuleId-success-200" : {
"summary" : "Response code - 200 OK",
"patch-transactionRules-transactionRuleId-updateTransactionRuleStatus" : {
"summary" : "Update the status of transaction rule",
"description" : "Example request for updating the status of a transaction rule",
"value" : {
"status" : "inactive"
}
},
"patch-transactionRules-transactionRuleId-updateTransactionRuleStatus-200" : {
"summary" : "Transaction rule status updated",
"description" : "Example response for successfully updating the status of a transaction rule",
"value" : {
"description" : "Allow 5 transactions per month",
@@ -6233,13 +6307,6 @@
"id" : "TR3227C223222B5B85CDV4DRS"
}
},
"patch-transactionRules-transactionRuleId-updateTransactionRuleStatus" : {
"summary" : "Update the status of transaction rule.",
"description" : "Example request for updating the status of a transaction rule",
"value" : {
"status" : "inactive"
}
},
"post-accountHolders-createAccountHolder" : {
"summary" : "Create an account holder",
"description" : "Example request for creating an account holder",
@@ -6393,15 +6460,15 @@
}
},
"post-paymentInstrumentGroups-createPaymentInstrumentGroups" : {
"summary" : "Create a payment instrument group.",
"summary" : "Create a payment instrument group",
"description" : "Example request for creating a payment instrument group",
"value" : {
"balancePlatform" : "YOUR_BALANCE_PLATFORM",
"txVariant" : "mc"
}
},
"post-paymentInstrumentGroups-success-200" : {
"summary" : "Response code - 200 OK",
"post-paymentInstrumentGroups-createPaymentInstrumentGroups-200" : {
"summary" : "Payment instrument group created",
"description" : "Example response for successfully creating a payment instrument group",
"value" : {
"balancePlatform" : "YOUR_BALANCE_PLATFORM",
@@ -6409,13 +6476,38 @@
"id" : "PG3227C223222B5CMD3FJFKGZ"
}
},
"post-paymentInstruments-createBusinessAccount" : {
"summary" : "Create a business account",
"description" : "Example request for creating a business account",
"value" : {
"type" : "bankAccount",
"description" : "YOUR_DESCRIPTION",
"balanceAccountId" : "BA3227C223222B5CTBLR8BWJB",
"issuingCountryCode" : "NL"
}
},
"post-paymentInstruments-createBusinessAccount-200" : {
"summary" : "Business account created",
"description" : "Example response for creating a business account",
"value" : {
"balanceAccountId" : "BA3227C223222B5CTBLR8BWJB",
"issuingCountryCode" : "NL",
"status" : "Active",
"type" : "bankAccount",
"bankAccount" : {
"iban" : "NL20ADYB2017000035"
},
"id" : "PI322LJ223222B5DJS7CD9LWL"
}
},
"post-paymentInstruments-createPhysicalCard" : {
"summary" : "Create a physical card",
"description" : "Example request for creating a physical card",
"value" : {
"type" : "card",
"issuingCountryCode" : "NL",
"balanceAccountId" : "BALANCE_ACCOUNT_ID",
"balanceAccountId" : "BA32272223222B59CZ3T52DKZ",
"description" : "S.Hopper - Main card",
"status" : "Inactive",
"card" : {
"formFactor" : "physical",
@@ -6427,9 +6519,9 @@
"city" : "Amsterdam",
"country" : "NL",
"stateOrProvince" : "NH",
"street" : "Simon Carmiggeltstraat",
"houseNumberOrName" : "6-50",
"postalCode" : "1011DJ"
"street" : "Brannan Street",
"houseNumberOrName" : "274",
"postalCode" : "1020CD"
},
"name" : {
"firstName" : "Sam",
@@ -6437,55 +6529,99 @@
}
},
"configuration" : {
"configurationProfileId" : "YOUR_CONFIGURATION_PROFILE_ID"
"configurationProfileId" : "CP123AB45678C91ABCD2ABCDE"
}
}
}
},
"post-paymentInstruments-createPhysicalCard-200" : {
"summary" : "Physical card created",
"description" : "Example response for creating a physical card",
"value" : {
"balanceAccountId" : "BA32272223222B59CZ3T52DKZ",
"description" : "S. Hopper - Main card",
"issuingCountryCode" : "NL",
"status" : "Inactive",
"type" : "card",
"card" : {
"brand" : "mc",
"brandVariant" : "mcdebit",
"cardholderName" : "Sam Hopper",
"formFactor" : "physical",
"bin" : "555544",
"expiration" : {
"month" : "08",
"year" : "2024"
},
"expiry" : {
"month" : 8,
"year" : 2024
"lastFour" : "2765",
"authentication" : {
"password" : "******",
"phone" : {
"number" : "+123456789",
"type" : "mobile"
}
},
"deliveryContact" : {
"address" : {
"city" : "Amsterdam",
"country" : "NL",
"stateOrProvince" : "NH",
"street" : "Brannan Street",
"houseNumberOrName" : "274",
"postalCode" : "1020CD"
},
"name" : {
"firstName" : "Sam",
"lastName" : "Hopper"
}
},
"configuration" : {
"configurationProfileId" : "CP123AB45678C91ABCD2ABCDE"
}
},
"description" : "S.Hopper - Main card"
"id" : "PI3227C223222B5BPCMFXD2XG"
}
},
"post-paymentInstruments-createVirtualCard" : {
"summary" : "Create a virtual card.",
"summary" : "Create a virtual card",
"description" : "Example request for creating a virtual card",
"value" : {
"type" : "card",
"description" : "S. Hopper - Main card",
"balanceAccountId" : "BA32272223222B59CZ3T52DKZ",
"issuingCountryCode" : "GB",
"issuingCountryCode" : "NL",
"card" : {
"cardholderName" : "Simon Hopper",
"cardholderName" : "Sam Hopper",
"brand" : "mc",
"brandVariant" : "mcdebit",
"formFactor" : "virtual"
}
}
},
"post-paymentInstruments-success-200" : {
"summary" : "Response code - 200 OK",
"description" : "Example response for successfully creating a virtual card",
"post-paymentInstruments-createVirtualCard-200" : {
"summary" : "Virtual card created",
"description" : "Example response for creating a virtual card",
"value" : {
"balanceAccountId" : "BA32272223222B59CZ3T52DKZ",
"description" : "S. Hopper - Main card",
"issuingCountryCode" : "GB",
"description" : "S.Hopper - Virtual card",
"issuingCountryCode" : "NL",
"status" : "Active",
"type" : "card",
"card" : {
"brand" : "mc",
"brandVariant" : "mcdebit",
"cardholderName" : "Simon Hopper",
"cardholderName" : "Sam Hopper",
"formFactor" : "virtual",
"bin" : "555544",
"cvc" : "873",
"cvc" : "613",
"expiration" : {
"month" : "01",
"year" : "2024"
"month" : "03",
"year" : "2025"
},
"lastFour" : "3548"
"lastFour" : "9883",
"number" : "5555444411209883"
},
"id" : "PI32272223222B5CMD3MQ3HXX"
"id" : "PI32272223222B5FR7Z5CFDW4"
}
},
"post-transactionRules-createTransactionRuleAllowPos" : {

1015
yaml/BalancePlatformNotificationService-v1.yaml
View File

File diff suppressed because it is too large Load Diff

958
yaml/BalancePlatformService-v1.yaml
View File

File diff suppressed because it is too large Load Diff

391
yaml/BalancePlatformService-v2.yaml
View File

@@ -4,26 +4,24 @@ servers:
info:
version: '2'
x-publicVersion: true
title: Balance Platform Configuration API
description: "The Balance Platform Configuration API enables you to create a platform\
\ where you can onboard users as account holders and create balance accounts,\
\ cards, and bank accounts.\n\nFor information about use cases, refer to [Adyen\
\ Issuing](https://docs.adyen.com/issuing).\n\n ## Authentication\nYour Adyen\
\ contact will provide your API credential and an API key. To connect to the API,\
\ add an `X-API-Key` header with the API key as the value, for example:\n\n ```\n\
curl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\"\
\ \\\n...\n```\n\nAlternatively, you can use the username and password to connect\
\ to the API using basic authentication. For example:\n\n```\ncurl\n-H \"Content-Type:\
\ application/json\" \\\n-U \"ws@BalancePlatform.YOUR_BALANCE_PLATFORM\":\"YOUR_WS_PASSWORD\"\
\ \\\n...\n```\n## Versioning\nThe Balance Platform Configuration API supports\
title: Configuration API
description: "The Configuration API enables you to create a platform where you can\
\ onboard your users as account holders and create balance accounts, cards, and\
\ business accounts.\n\n## Authentication\nYour Adyen contact will provide your\
\ API credential and an API key. To connect to the API, add an `X-API-Key` header\
\ with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type:\
\ application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively,\
\ you can use the username and password to connect to the API using basic authentication.\
\ For example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-U \"ws@BalancePlatform.YOUR_BALANCE_PLATFORM\"\
:\"YOUR_WS_PASSWORD\" \\\n...\n```\n## Versioning\nThe Configuration API supports\
\ [versioning](https://docs.adyen.com/development-resources/versioning) using\
\ a version suffix in the endpoint URL. This suffix has the following format:\
\ \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://balanceplatform-api-test.adyen.com/bcl/v1\n\
```\n## Going live\nWhen going live, your Adyen contact will provide your API\
\ credential for the live environment. You can then use the API key or the username\
\ and password to send requests to `https://balanceplatform-api-live.adyen.com/bcl/v1`.\n\
\nFor more information, refer to our [Going live documentation](https://docs.adyen.com/issuing/integration-checklist#going-live)."
x-timestamp: '2022-05-06T17:19:23Z'
\n"
x-timestamp: '2022-07-28T15:32:11Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -49,11 +47,10 @@ paths:
tags:
- Account holders
summary: Create an account holder
description: 'Creates an account holder that represents your user''s entity
within the balance platform.
description: 'Creates an account holder linked to a [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities).
For more information, refer to [Create accounts](https://docs.adyen.com/issuing/create-accounts).'
'
x-addedInVersion: '1'
operationId: post-accountHolders
x-groupName: Account holders
@@ -203,15 +200,8 @@ paths:
tags:
- Account holders
summary: Update an account holder
description: 'Updates an account holder. When updating an account holder resource,
note that:
* If a parameter is not provided in the request, the parameter is left unchanged.
* When updating any parameter in the `contactDetails` object, you must send
all other existing `contactDetails` parameters.'
description: Updates an account holder. When updating an account holder resource,
if a parameter is not provided in the request, it is left unchanged.
x-addedInVersion: '1'
operationId: patch-accountHolders-id
x-groupName: Account holders
@@ -239,8 +229,8 @@ paths:
content:
application/json:
examples:
success:
$ref: '#/components/examples/patch-accountHolders-id-success-200'
updateAccountHolderStatus:
$ref: '#/components/examples/patch-accountHolders-id-updateAccountHolderStatus-200'
schema:
$ref: '#/components/schemas/AccountHolder'
description: OK - the request has succeeded.
@@ -294,10 +284,10 @@ paths:
tags:
- Account holders
summary: Get all balance accounts of an account holder
description: "Returns a paginated list of balance accounts associated with an\
\ account holder. To fetch multiple pages, use the query parameters. \n\n\
For example, to limit the page to 5 balance accounts and skip the first 10,\
\ use `/accountHolders/{id}/balanceAccounts?limit=5&offset=10`."
description: "Returns a paginated list of the balance accounts associated with\
\ an account holder. To fetch multiple pages, use the query parameters. \n\
\nFor example, to limit the page to 5 balance accounts and skip the first\
\ 10, use `/accountHolders/{id}/balanceAccounts?limit=5&offset=10`."
x-addedInVersion: '1'
operationId: get-accountHolders-id-balanceAccounts
x-groupName: Account holders
@@ -388,7 +378,7 @@ paths:
- Balance accounts
summary: Create a balance account
description: "Creates a balance account that holds the funds of the associated\
\ account holder. \n\nFor more information, refer to [Create accounts](https://docs.adyen.com/issuing/create-accounts)."
\ account holder. \n\n"
x-addedInVersion: '1'
operationId: post-balanceAccounts
x-groupName: Balance accounts
@@ -1328,8 +1318,8 @@ paths:
content:
application/json:
examples:
success:
$ref: '#/components/examples/post-paymentInstrumentGroups-success-200'
createPaymentInstrumentGroups:
$ref: '#/components/examples/post-paymentInstrumentGroups-createPaymentInstrumentGroups-200'
schema:
$ref: '#/components/schemas/PaymentInstrumentGroup'
description: OK - the request has succeeded.
@@ -1383,7 +1373,7 @@ paths:
tags:
- Payment instrument groups
summary: Get a payment instrument group
description: Returns a payment instrument group.
description: Returns the details of a payment instrument group.
x-addedInVersion: '1'
operationId: get-paymentInstrumentGroups-id
x-groupName: Payment instrument groups
@@ -1534,8 +1524,10 @@ paths:
tags:
- Payment instruments
summary: Create a payment instrument
description: "Creates a payment instrument to issue either a physical or a virtual\
\ card to your user.\n\n For more information, refer to [Create cards](https://docs.adyen.com/issuing/create-cards)."
description: "Creates a payment instrument to issue a physical card, a virtual\
\ card, or a business account to your user.\n\n For more information, refer\
\ to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue\
\ business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)."
x-addedInVersion: '1'
operationId: post-paymentInstruments
x-groupName: Payment instruments
@@ -1547,6 +1539,8 @@ paths:
content:
application/json:
examples:
createBusinessAccount:
$ref: '#/components/examples/post-paymentInstruments-createBusinessAccount'
createPhysicalCard:
$ref: '#/components/examples/post-paymentInstruments-createPhysicalCard'
createVirtualCard:
@@ -1558,8 +1552,12 @@ paths:
content:
application/json:
examples:
success:
$ref: '#/components/examples/post-paymentInstruments-success-200'
createBusinessAccount:
$ref: '#/components/examples/post-paymentInstruments-createBusinessAccount-200'
createPhysicalCard:
$ref: '#/components/examples/post-paymentInstruments-createPhysicalCard-200'
createVirtualCard:
$ref: '#/components/examples/post-paymentInstruments-createVirtualCard-200'
schema:
$ref: '#/components/schemas/PaymentInstrument'
description: OK - the request has succeeded.
@@ -1613,7 +1611,7 @@ paths:
tags:
- Payment instruments
summary: Get a payment instrument
description: Returns a payment instrument.
description: Returns the details of a payment instrument.
x-addedInVersion: '1'
operationId: get-paymentInstruments-id
x-groupName: Payment instruments
@@ -2020,7 +2018,7 @@ paths:
tags:
- Transaction rules
summary: Get a transaction rule
description: Returns a transaction rule.
description: Returns the details of a transaction rule.
x-addedInVersion: '1'
operationId: get-transactionRules-transactionRuleId
x-groupName: Transaction rules
@@ -2126,8 +2124,8 @@ paths:
content:
application/json:
examples:
success:
$ref: '#/components/examples/patch-transactionRules-transactionRuleId-success-200'
updateTransactionRuleStatus:
$ref: '#/components/examples/patch-transactionRules-transactionRuleId-updateTransactionRuleStatus-200'
schema:
$ref: '#/components/schemas/TransactionRule'
description: OK - the request has succeeded.
@@ -2210,8 +2208,7 @@ components:
against the legal entity of the account holder.
For more information on how to create a legal entity, refer to [Onboard
and verify account holders](https://docs.adyen.com/issuing/kyc-verification).'
'
type: string
primaryBalanceAccount:
description: The ID of the account holder's primary balance account. By
@@ -2226,10 +2223,12 @@ components:
status:
description: "The status of the account holder.\n\nPossible values: \n\n\
\ * **Active**: The account holder is active. This is the default status\
\ when creating an account holder. \n\n * **Suspended**: The account holder\
\ is temporarily suspended. You can set the account back to active or\
\ close it permanently. \n\n* **Closed**: The account holder is permanently\
\ deactivated. This action cannot be undone."
\ when creating an account holder. \n\n * **Inactive**: The account holder\
\ is temporarily inactive. You can set the account back to active or close\
\ it permanently. \n\n * **Suspended**: The account holder is permanently\
\ suspended by Adyen. This action cannot be undone. \n\n* **Closed**:\
\ The account holder is permanently deactivated. This action cannot be\
\ undone."
enum:
- active
- closed
@@ -2362,8 +2361,7 @@ components:
against the legal entity of the account holder.
For more information on how to create a legal entity, refer to [Onboard
and verify account holders](https://docs.adyen.com/issuing/kyc-verification).'
'
type: string
reference:
description: Your reference for the account holder, maximum 150 characters.
@@ -2429,7 +2427,7 @@ components:
- city
- postalCode
- country
Address2:
Address-2:
properties:
city:
description: The name of the city.
@@ -2692,6 +2690,14 @@ components:
- sweeps
- hasPrevious
- hasNext
BankAccount:
properties:
iban:
description: The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number)
(IBAN).
type: string
required:
- iban
BrandVariantsRestriction:
properties:
operation:
@@ -2820,7 +2826,7 @@ components:
relevant to your integration. Examples: **visadebit**, **mcprepaid**.'
type: string
cardholderName:
description: "The name of the card holder.\n Maximum length: 26 characters."
description: "The name of the cardholder.\n Maximum length: 26 characters."
maxLength: 26
type: string
configuration:
@@ -2957,7 +2963,7 @@ components:
relevant to your integration. Examples: **visadebit**, **mcprepaid**.'
type: string
cardholderName:
description: "The name of the card holder.\n Maximum length: 26 characters."
description: "The name of the cardholder.\n Maximum length: 26 characters."
maxLength: 26
type: string
configuration:
@@ -3014,11 +3020,75 @@ components:
type: array
required:
- operation
CronSweepSchedule:
additionalProperties: false
properties:
cronExpression:
description: 'A [cron expression](https://en.wikipedia.org/wiki/Cron#CRON_expression)
that is used to set the sweep schedule. The schedule uses the time zone
of the balance account. For example, **30 17 * * MON** schedules a sweep
every Monday at 17:30.
The expression must have five values separated by a single space in the
following order:
* Minute: **0-59**
* Hour: **0-23**
* Day of the month: **1-31**
* Month: **1-12** or **JAN-DEC**
* Day of the week: **0-7** (0 and 7 are Sunday) or **MON-SUN**.
The following non-standard characters are supported: *****, **L**,
**#**, **W** and **/**. See [crontab guru](https://crontab.guru/) for
more examples.'
type: string
type:
description: 'The schedule type.
Possible values:
* **cron**: push out funds based on a cron expression.
* **daily**: push out funds daily at 07:00 AM CET.
* **weekly**: push out funds every Monday at 07:00 AM CET.
* **monthly**: push out funds every first of the month at 07:00 AM CET.
* **balance**: pull in funds instantly if the balance is less than or
equal to the `triggerAmount`. You can only use this for sweeps of `type`
**pull** and when the source is a `merchantAccount` or `transferInstrument`.'
enum:
- daily
- weekly
- monthly
- balance
- cron
type: string
required:
- cronExpression
DeliveryContact:
properties:
address:
description: The address of the contact.
$ref: '#/components/schemas/Address2'
$ref: '#/components/schemas/Address-2'
email:
description: The email address of the contact.
type: string
@@ -3037,6 +3107,9 @@ components:
webAddress:
description: The URL of the contact's website.
type: string
required:
- name
- address
DifferentCurrenciesRestriction:
properties:
operation:
@@ -3093,8 +3166,8 @@ components:
description: 'List of point-of-sale entry modes.
Possible values: **manual**, **chip**, **magstripe**, **contactless**,
**cof**, **token**, **server**, **barcode**, **ocr**.
Possible values: **barcode**, **chip**, **cof**, **contactless**, **magstripe**,
**manual**, **ocr**, **server**.
'
@@ -3108,7 +3181,6 @@ components:
- manual
- ocr
- server
- token
- unknown
type: string
type: array
@@ -3285,8 +3357,13 @@ components:
description: The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/balanceAccounts__resParam_id)
associated with the payment instrument.
type: string
bankAccount:
description: Contains the business account details. Returned when you create
a payment instrument with `type` **bankAccount**.
$ref: '#/components/schemas/BankAccount'
card:
description: Contains information about the card payment instrument.
description: Contains information about the card payment instrument. Returned
when you create a payment instrument with `type` **card**.
$ref: '#/components/schemas/Card'
description:
description: Your description for the payment instrument, maximum 300 characters.
@@ -3363,8 +3440,9 @@ components:
description: 'Type of payment instrument.
Possible value: **card**. '
Possible value: **card**, **bankAccount**. '
enum:
- bankAccount
- card
type: string
required:
@@ -3511,8 +3589,9 @@ components:
description: 'Type of payment instrument.
Possible value: **card**. '
Possible value: **card**, **bankAccount**. '
enum:
- bankAccount
- card
type: string
required:
@@ -3639,8 +3718,8 @@ components:
description: 'List of processing types.
Possible values: **atmWithdraw**, **pos**, **ecommerce**, **moto**, **recurring**,
**balanceInquiry**.
Possible values: **atmWithdraw**, **balanceInquiry**, **ecommerce**, **moto**,
**pos**, **recurring**, **token**.
'
@@ -3651,7 +3730,6 @@ components:
- ecommerce
- moto
- pos
- purchaseWithCashback
- recurring
- token
- unknown
@@ -3676,10 +3754,6 @@ components:
errorCode:
description: A code that identifies the problem type.
type: string
errorType:
description: A URI that identifies the problem type, pointing to human-readable
documentation on this problem type.
type: string
instance:
description: A unique URI that identifies the specific occurrence of the
problem.
@@ -3703,8 +3777,12 @@ components:
title:
description: A short, human-readable summary of the problem type.
type: string
type:
description: A URI that identifies the problem type, pointing to human-readable
documentation on this problem type.
type: string
required:
- errorType
- type
- errorCode
- title
- detail
@@ -3726,6 +3804,14 @@ components:
The sweep currency must match any of the [balances currencies](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__resParam_balances).'
type: string
description:
description: 'The message that will be used in the sweep transfer''s description
body with a maximum length of 140 characters.
If the message is longer after replacing placeholders, the message will
be cut off at 140 characters.'
type: string
id:
description: The unique identifier of the sweep.
readOnly: true
@@ -3734,7 +3820,9 @@ components:
description: The schedule when the `triggerAmount` is evaluated. If the
balance meets the threshold, funds are pushed out of or pulled in to the
balance account.
$ref: '#/components/schemas/SweepSchedule'
oneOf:
- $ref: '#/components/schemas/CronSweepSchedule'
- $ref: '#/components/schemas/SweepSchedule'
status:
x-enum:
- description: The sweep is enabled and funds will be pulled in or pushed
@@ -3813,6 +3901,7 @@ components:
To use this feature, reach out to your Adyen contact.'
type: string
SweepSchedule:
additionalProperties: false
properties:
type:
description: 'The schedule type.
@@ -3821,6 +3910,9 @@ components:
Possible values:
* **cron**: push out funds based on a cron expression.
* **daily**: push out funds daily at 07:00 AM CET.
@@ -3838,6 +3930,7 @@ components:
- weekly
- monthly
- balance
- cron
type: string
TimeOfDay:
properties:
@@ -4341,6 +4434,7 @@ components:
$ref: '#/components/schemas/RemediatingAction'
type: array
required: []
void: {}
securitySchemes:
ApiKeyAuth:
in: header
@@ -4351,7 +4445,7 @@ components:
type: http
examples:
delete-transactionRules-transactionRuleId-success-200:
summary: Response code - 200 OK
summary: Transaction rule deleted
description: Example response for successfully deleting a transaction rule
value:
amount:
@@ -4424,7 +4518,7 @@ components:
requestId: 1W1UHY5O2CONU4R7
errorCode: '99_500'
get-accountHolders-id-balanceAccounts-success-200:
summary: Response code - 200 OK
summary: List of balance accounts retrieved
description: Example response when retrieving a list of balance accounts under
an account holder
value:
@@ -4444,7 +4538,7 @@ components:
hasNext: true
hasPrevious: false
get-accountHolders-id-success-200:
summary: Response code - 200 OK
summary: Account holder retrieved
description: Example response when retrieving an account holder
value:
balancePlatform: YOUR_BALANCE_PLATFORM
@@ -4502,7 +4596,7 @@ components:
balanceAccountId: BA32272223222B5FTD2KR6TJD
currency: EUR
get-balanceAccounts-id-paymentInstruments-success-200:
summary: Response code - 200 OK
summary: List of payment instruments retrieved
description: Example response when retrieving a list of payment instruments
under a balance account
value:
@@ -4553,7 +4647,7 @@ components:
id: BA3227C223222B5BLP6JQC3FD
status: Active
get-balancePlatforms-id-accountHolders-success-200:
summary: Response code - 200 OK
summary: List of account holders retrieved
description: Example response when retrieving a list of account holders under
a balance platform
value:
@@ -4581,20 +4675,20 @@ components:
hasNext: 'true'
hasPrevious: 'false'
get-balancePlatforms-id-success-200:
summary: Response code - 200 OK
summary: Balance platform retrieved
description: Example response when retrieving a balance platform
value:
id: YOUR_BALANCE_PLATFORM
status: Active
get-paymentInstrumentGroups-id-success-200:
summary: Response code - 200 OK
summary: Payment instrument group retrieved
description: Example response when retrieving a payment instrument group
value:
balancePlatform: YOUR_BALANCE_PLATFORM
txVariant: mc
id: PG3227C223222B5CMD3FJFKGZ
get-paymentInstrumentGroups-id-transactionRules-success-200:
summary: Response code - 200 OK
summary: Transaction rules for a payment instrument group retrieved
description: Example response when retrieving a list of transaction rules applied
to a payment instrument group
value:
@@ -4644,7 +4738,7 @@ components:
number: '************3548'
id: PI32272223222B5CMD3MQ3HXX
get-paymentInstruments-id-transactionRules-success-200:
summary: Response code - 200 OK
summary: Transaction rules for a payment instrument retrieved
description: Example response when retrieving a list of transaction rules applied
to a payment instrument
value:
@@ -4672,7 +4766,7 @@ components:
type: velocity
id: TR32272223222B5CMDGT89F4F
get-transactionRules-transactionRuleId-success-200:
summary: Response code - 200 OK
summary: Transaction rules retrieved
description: Example response when retrieving a transaction rule
value:
transactionRule:
@@ -4686,8 +4780,13 @@ components:
status: active
type: velocity
id: TR32272223222B5CMD3V73HXG
patch-accountHolders-id-success-200:
summary: Response code - 200 OK
patch-accountHolders-id-updateAccountHolderStatus:
summary: Update the status of an account holder
description: Example request for updating the status of an account holder
value:
status: Suspended
patch-accountHolders-id-updateAccountHolderStatus-200:
summary: Account holder status updated
description: Example response for successfully updating the status of an account
holder
value:
@@ -4706,11 +4805,6 @@ components:
description: S.Hopper - Staff 123
id: AH32272223222B5CM4MWJ892H
status: Suspended
patch-accountHolders-id-updateAccountHolderStatus:
summary: Update the status of an account holder.
description: Example request for updating the status of an account holder
value:
status: Suspended
patch-balanceAccounts-balanceAccountId-sweeps-sweepId-updateSweep-status:
summary: Update the status of a sweep
description: Example request for updating a sweep
@@ -4784,8 +4878,13 @@ components:
lastFour: '5785'
number: '************5785'
id: PI3227C223222B5CMD278FKGS
patch-transactionRules-transactionRuleId-success-200:
summary: Response code - 200 OK
patch-transactionRules-transactionRuleId-updateTransactionRuleStatus:
summary: Update the status of transaction rule
description: Example request for updating the status of a transaction rule
value:
status: inactive
patch-transactionRules-transactionRuleId-updateTransactionRuleStatus-200:
summary: Transaction rule status updated
description: Example response for successfully updating the status of a transaction
rule
value:
@@ -4799,11 +4898,6 @@ components:
status: inactive
type: velocity
id: TR3227C223222B5B85CDV4DRS
patch-transactionRules-transactionRuleId-updateTransactionRuleStatus:
summary: Update the status of transaction rule.
description: Example request for updating the status of a transaction rule
value:
status: inactive
post-accountHolders-createAccountHolder:
summary: Create an account holder
description: Example request for creating an account holder
@@ -4920,26 +5014,46 @@ components:
id: BA32272223222B59CZ3T52DKZ
status: active
post-paymentInstrumentGroups-createPaymentInstrumentGroups:
summary: Create a payment instrument group.
summary: Create a payment instrument group
description: Example request for creating a payment instrument group
value:
balancePlatform: YOUR_BALANCE_PLATFORM
txVariant: mc
post-paymentInstrumentGroups-success-200:
summary: Response code - 200 OK
post-paymentInstrumentGroups-createPaymentInstrumentGroups-200:
summary: Payment instrument group created
description: Example response for successfully creating a payment instrument
group
value:
balancePlatform: YOUR_BALANCE_PLATFORM
txVariant: mc
id: PG3227C223222B5CMD3FJFKGZ
post-paymentInstruments-createBusinessAccount:
summary: Create a business account
description: Example request for creating a business account
value:
type: bankAccount
description: YOUR_DESCRIPTION
balanceAccountId: BA3227C223222B5CTBLR8BWJB
issuingCountryCode: NL
post-paymentInstruments-createBusinessAccount-200:
summary: Business account created
description: Example response for creating a business account
value:
balanceAccountId: BA3227C223222B5CTBLR8BWJB
issuingCountryCode: NL
status: Active
type: bankAccount
bankAccount:
iban: NL20ADYB2017000035
id: PI322LJ223222B5DJS7CD9LWL
post-paymentInstruments-createPhysicalCard:
summary: Create a physical card
description: Example request for creating a physical card
value:
type: card
issuingCountryCode: NL
balanceAccountId: BALANCE_ACCOUNT_ID
balanceAccountId: BA32272223222B59CZ3T52DKZ
description: S.Hopper - Main card
status: Inactive
card:
formFactor: physical
@@ -4951,52 +5065,87 @@ components:
city: Amsterdam
country: NL
stateOrProvince: NH
street: Simon Carmiggeltstraat
houseNumberOrName: 6-50
postalCode: 1011DJ
street: Brannan Street
houseNumberOrName: '274'
postalCode: 1020CD
name:
firstName: Sam
lastName: Hopper
configuration:
configurationProfileId: YOUR_CONFIGURATION_PROFILE_ID
expiry:
month: 8
year: 2024
description: S.Hopper - Main card
configurationProfileId: CP123AB45678C91ABCD2ABCDE
post-paymentInstruments-createPhysicalCard-200:
summary: Physical card created
description: Example response for creating a physical card
value:
balanceAccountId: BA32272223222B59CZ3T52DKZ
description: S. Hopper - Main card
issuingCountryCode: NL
status: Inactive
type: card
card:
brand: mc
brandVariant: mcdebit
cardholderName: Sam Hopper
formFactor: physical
bin: '555544'
expiration:
month: 08
year: '2024'
lastFour: '2765'
authentication:
password: '******'
phone:
number: '+123456789'
type: mobile
deliveryContact:
address:
city: Amsterdam
country: NL
stateOrProvince: NH
street: Brannan Street
houseNumberOrName: '274'
postalCode: 1020CD
name:
firstName: Sam
lastName: Hopper
configuration:
configurationProfileId: CP123AB45678C91ABCD2ABCDE
id: PI3227C223222B5BPCMFXD2XG
post-paymentInstruments-createVirtualCard:
summary: Create a virtual card.
summary: Create a virtual card
description: Example request for creating a virtual card
value:
type: card
description: S. Hopper - Main card
balanceAccountId: BA32272223222B59CZ3T52DKZ
issuingCountryCode: GB
issuingCountryCode: NL
card:
cardholderName: Simon Hopper
cardholderName: Sam Hopper
brand: mc
brandVariant: mcdebit
formFactor: virtual
post-paymentInstruments-success-200:
summary: Response code - 200 OK
description: Example response for successfully creating a virtual card
post-paymentInstruments-createVirtualCard-200:
summary: Virtual card created
description: Example response for creating a virtual card
value:
balanceAccountId: BA32272223222B59CZ3T52DKZ
description: S. Hopper - Main card
issuingCountryCode: GB
description: S.Hopper - Virtual card
issuingCountryCode: NL
status: Active
type: card
card:
brand: mc
brandVariant: mcdebit
cardholderName: Simon Hopper
cardholderName: Sam Hopper
formFactor: virtual
bin: '555544'
cvc: '873'
cvc: '613'
expiration:
month: '01'
year: '2024'
lastFour: '3548'
id: PI32272223222B5CMD3MQ3HXX
month: '03'
year: '2025'
lastFour: '9883'
number: '5555444411209883'
id: PI32272223222B5FR7Z5CFDW4
post-transactionRules-createTransactionRuleAllowPos:
summary: Allow only point-of-sale transactions
description: Example request to allow only point-of-sale transactions