Skip to content

Commit e29429c

Browse files
author
Adyen Automation
committed
spec release
1 parent b7b5624 commit e29429c

8 files changed

+347
-210
lines changed

json/BalancePlatformConfigurationNotification-v1.json

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -929,13 +929,13 @@
929929
"additionalProperties" : false,
930930
"properties" : {
931931
"currency" : {
932-
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes).",
932+
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount.",
933933
"maxLength" : 3,
934934
"minLength" : 3,
935935
"type" : "string"
936936
},
937937
"value" : {
938-
"description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).",
938+
"description" : "The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).",
939939
"format" : "int64",
940940
"type" : "integer"
941941
}
@@ -1416,7 +1416,7 @@
14161416
"type" : "string"
14171417
},
14181418
"configuration" : {
1419-
"description" : "Settings required when creating a physical or a virtual card. \n\nReach out to your Adyen contact to get the values that you can send in this object.",
1419+
"description" : "Contains information about the configuration profile for your cards. The configuration profile consists of settings required when creating a physical or a virtual card. You identify a configuration profile with its `configurationProfileId`.\n\nWhen you provide this field in a request, you can override the settings of an existing configuration profile.\n\nReach out to your Adyen contact to get the values that you can send in this object.",
14201420
"$ref" : "#/components/schemas/CardConfiguration"
14211421
},
14221422
"cvc" : {
@@ -1461,16 +1461,15 @@
14611461
"formFactor",
14621462
"cardholderName",
14631463
"brand",
1464-
"brandVariant",
1465-
"number"
1464+
"brandVariant"
14661465
],
14671466
"type" : "object"
14681467
},
14691468
"CardConfiguration" : {
14701469
"additionalProperties" : false,
14711470
"properties" : {
14721471
"activation" : {
1473-
"description" : "Overrides the activation label design ID defined in the `configurationProfileId`. The activation label is attached to the card and contains the activation instructions.",
1472+
"description" : "The activation label attached to the card that contains the activation instructions.\n\nThis field overrides the activation label design ID defined in the card configuration profile.",
14741473
"type" : "string"
14751474
},
14761475
"activationUrl" : {
@@ -1479,51 +1478,51 @@
14791478
"type" : "string"
14801479
},
14811480
"bulkAddress" : {
1482-
"description" : "Overrides the shipment bulk address defined in the `configurationProfileId`.",
1481+
"description" : "Overrides the shipment bulk address defined in the card configuration profile.",
14831482
"$ref" : "#/components/schemas/BulkAddress"
14841483
},
14851484
"cardImageId" : {
1486-
"description" : "The ID of the card image. This is the image that will be printed on the full front of the card.",
1485+
"description" : "The unique identifier of the card image. This image is printed on the full front of the card.",
14871486
"type" : "string"
14881487
},
14891488
"carrier" : {
1490-
"description" : "Overrides the carrier design ID defined in the `configurationProfileId`. The carrier is the letter or packaging to which the card is attached.",
1489+
"description" : "The letter or packaging to which the card is attached.\n\nThis field overrides the carrier design ID defined in the card configuration profile. ",
14911490
"type" : "string"
14921491
},
14931492
"carrierImageId" : {
1494-
"description" : "The ID of the carrier image. This is the image that will printed on the letter to which the card is attached.",
1493+
"description" : "The unique identifier of the carrier image. This image is printed on the letter to which the card is attached.",
14951494
"type" : "string"
14961495
},
14971496
"configurationProfileId" : {
1498-
"description" : "The ID of the card configuration profile that contains the settings of the card. For example, the envelope and PIN mailer designs or the logistics company handling the shipment. All the settings in the profile are applied to the card, unless you provide other fields to override them.\n\nFor example, send the `shipmentMethod` to override the logistics company defined in the card configuration profile.",
1497+
"description" : "The unique identifier of the card configuration profile that contains the settings that are applied to the card. For example, the envelope and PIN mailer designs or the logistics company handling the shipment.\n\nYou can override some of the existing settings in the configuration profile by providing the corresponding fields in the `configuration` object. For example, send the `shipmentMethod` to override the logistics company defined in the card configuration profile.",
14991498
"type" : "string"
15001499
},
15011500
"currency" : {
1502-
"description" : "The three-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the card. For example, **EUR**.",
1501+
"description" : "The three-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the card. For example, **EUR**.\n\nThis field overrides the existing currency setting on the card configuration profile.",
15031502
"type" : "string"
15041503
},
15051504
"envelope" : {
1506-
"description" : "Overrides the envelope design ID defined in the `configurationProfileId`. ",
1505+
"description" : "Overrides the envelope design ID defined in the card configuration profile. ",
15071506
"type" : "string"
15081507
},
15091508
"insert" : {
1510-
"description" : "Overrides the insert design ID defined in the `configurationProfileId`. An insert is any additional material, such as marketing materials, that are shipped together with the card.",
1509+
"description" : "Any additional material, such as marketing material, that is shipped together with the card.\n\nThis field overrides the insert design ID defined in the card configuration profile.",
15111510
"type" : "string"
15121511
},
15131512
"language" : {
15141513
"description" : "The two-letter [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code of the card. For example, **en**.",
15151514
"type" : "string"
15161515
},
15171516
"logoImageId" : {
1518-
"description" : "The ID of the logo image. This is the image that will be printed on the partial front of the card, such as a logo on the upper right corner.",
1517+
"description" : "The unique identifier of the logo image. This image is printed on the partial front of the card, for example, a logo on the upper right corner.",
15191518
"type" : "string"
15201519
},
15211520
"pinMailer" : {
1522-
"description" : "Overrides the PIN mailer design ID defined in the `configurationProfileId`. The PIN mailer is the letter on which the PIN is printed.",
1521+
"description" : "The letter on which the PIN of the card is printed.\n\nThis field overrides the PIN mailer design ID defined in the card configuration profile.",
15231522
"type" : "string"
15241523
},
15251524
"shipmentMethod" : {
1526-
"description" : "Overrides the logistics company defined in the `configurationProfileId`.",
1525+
"description" : "The logistics company that ships the card.\n\nThis field overrides the logistics company defined in the card configuration profile.",
15271526
"type" : "string"
15281527
}
15291528
},
@@ -1810,7 +1809,7 @@
18101809
"type" : "array"
18111810
},
18121811
"wallet" : {
1813-
"description" : "Contains information about the wallet for which the network token is provisioned.",
1812+
"description" : "Contains information about the wallet for which the network token is provisioned.\n\nReturned only when `type` is **wallet**.",
18141813
"$ref" : "#/components/schemas/Wallet"
18151814
}
18161815
},
@@ -2255,6 +2254,7 @@
22552254
"refusedByCustomer",
22562255
"routeNotFound",
22572256
"scaFailed",
2257+
"schemeAdvice",
22582258
"transferInstrumentDoesNotExist",
22592259
"unknown"
22602260
],

0 commit comments

Comments
 (0)