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
2024-02-22 14:01:48 +01:00
parent 97b3ebd962
commit a5a6623a28
4 changed files with 906 additions and 359 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
json/BalancePlatformConfigurationNotification-v1.json
View File

@@ -64,14 +64,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"balancePlatform-accountHolder-created" : {
"$ref" : "#/components/examples/WebhookAck"
},
"balancePlatform-accountHolder-created-lem-v3" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/BalancePlatformNotificationResponse"
}
@@ -119,14 +111,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"balancePlatform-accountHolder-updated" : {
"$ref" : "#/components/examples/WebhookAck"
},
"balancePlatform-accountHolder-updated-lem-v3" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/BalancePlatformNotificationResponse"
}
@@ -171,11 +155,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"balancePlatform-balanceAccount-created" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/BalancePlatformNotificationResponse"
}
@@ -220,11 +199,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"balancePlatform-balanceAccount-updated" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/BalancePlatformNotificationResponse"
}
@@ -269,11 +243,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"balancePlatform-sweep-created" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/BalancePlatformNotificationResponse"
}
@@ -318,11 +287,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"balancePlatform-sweep-deleted" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/BalancePlatformNotificationResponse"
}
@@ -367,11 +331,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"balancePlatform-sweep-updated" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/BalancePlatformNotificationResponse"
}
@@ -494,11 +453,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"balancePlatform-paymentInstrument-created" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/BalancePlatformNotificationResponse"
}
@@ -543,11 +497,6 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"balancePlatform-paymentInstrument-updated" : {
"$ref" : "#/components/examples/WebhookAck"
}
},
"schema" : {
"$ref" : "#/components/schemas/BalancePlatformNotificationResponse"
}
@@ -1491,6 +1440,12 @@
"IbanAccountIdentification" : {
"additionalProperties" : false,
"properties" : {
"formFactor" : {
"default" : "physical",
"description" : "The form factor of bank account.",
"nullable" : true,
"type" : "string"
},
"iban" : {
"description" : "The international bank account number as defined in the [ISO-13616](https://www.iso.org/standard/81090.html) standard.",
"type" : "string"
@@ -1514,10 +1469,12 @@
"properties" : {
"firstName" : {
"description" : "The first name.",
"maxLength" : 80,
"type" : "string"
},
"lastName" : {
"description" : "The last name.",
"maxLength" : 80,
"type" : "string"
}
},
@@ -1946,6 +1903,12 @@
],
"type" : "string"
},
"formFactor" : {
"default" : "physical",
"description" : "The form factor of bank account.",
"nullable" : true,
"type" : "string"
},
"routingNumber" : {
"description" : "The 9-digit [routing number](https://en.wikipedia.org/wiki/ABA_routing_transit_number), without separators or whitespace.",
"maxLength" : 9,
@@ -2241,12 +2204,6 @@
}
},
"examples" : {
"WebhookAck" : {
"summary" : "Acknowledge Webhook",
"value" : {
"notificationResponse" : "[accepted]"
}
},
"post-balancePlatform.accountHolder.created-balancePlatform-accountHolder-created" : {
"summary" : "Account holder created with LEM API v1, v2",
"description" : "Example webhook when an account holder was created with LEM API v1, v2",

652
json/BalancePlatformService-v2.json
View File

@@ -48,10 +48,10 @@
"name" : "Grant offers"
},
{
"name" : "PIN functionality"
"name" : "Card orders"
},
{
"name" : "Card orders"
"name" : "Manage card PIN"
},
{
"name" : "Transfer routes"
@@ -3686,7 +3686,7 @@
"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-sortIndex" : 11,
"x-sortIndex" : 1,
"x-methodName" : "createPaymentInstrument",
"security" : [
{
@@ -3828,6 +3828,129 @@
}
}
},
"/paymentInstruments/reveal" : {
"post" : {
"tags" : [
"Payment instruments"
],
"summary" : "Reveal the data of a payment instrument",
"description" : "Returns the encrypted data of a specified payment instrument. These data include:\n\n- The primary account number (PAN)\n- The card verification code (CVC)\n- The expiry date\n\nYou can decrypt the data to reveal it in your user interface.\n\nTo make this request, your API credential must have the following role:\n* Bank Issuing PAN Reveal Webservice role",
"x-addedInVersion" : "1",
"operationId" : "post-paymentInstruments-reveal",
"x-sortIndex" : 4,
"x-methodName" : "revealDataOfPaymentInstrument",
"security" : [
{
"clientKey" : [
]
},
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaymentInstrumentRevealRequest"
}
}
}
},
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaymentInstrumentRevealResponse"
}
}
},
"description" : "OK - the request has succeeded."
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic" : {
"$ref" : "#/components/examples/generic-400"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"examples" : {
"generic" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/paymentInstruments/{id}" : {
"get" : {
"tags" : [
@@ -3837,7 +3960,7 @@
"description" : "Returns the details of a payment instrument.",
"x-addedInVersion" : "1",
"operationId" : "get-paymentInstruments-id",
"x-sortIndex" : 13,
"x-sortIndex" : 3,
"x-methodName" : "getPaymentInstrument",
"security" : [
{
@@ -3965,7 +4088,7 @@
"description" : "Updates a payment instrument. Once a payment instrument is already active, you can only update its status. However, for cards created with **inactive** status, you can still update the balance account associated with the card.",
"x-addedInVersion" : "1",
"operationId" : "patch-paymentInstruments-id",
"x-sortIndex" : 12,
"x-sortIndex" : 2,
"x-methodName" : "updatePaymentInstrument",
"security" : [
{
@@ -4115,7 +4238,7 @@
"description" : "List the network tokens connected to a payment instrument.",
"x-addedInVersion" : "1",
"operationId" : "get-paymentInstruments-id-networkTokens",
"x-sortIndex" : 15,
"x-sortIndex" : 6,
"x-methodName" : "listNetworkTokens",
"security" : [
{
@@ -4240,7 +4363,7 @@
"description" : "Returns the primary account number (PAN) of a payment instrument.\n\nTo make this request, your API credential must have the following [role](https://docs.adyen.com/issuing/manage-access/api-credentials-web-service#api-permissions):\n\n* Balance Platform BCL PCI role",
"x-addedInVersion" : "1",
"operationId" : "get-paymentInstruments-id-reveal",
"x-sortIndex" : 14,
"x-sortIndex" : 5,
"x-methodName" : "getPanOfPaymentInstrument",
"security" : [
{
@@ -4370,7 +4493,7 @@
"description" : "Returns a list of transaction rules associated with a payment instrument.",
"x-addedInVersion" : "1",
"operationId" : "get-paymentInstruments-id-transactionRules",
"x-sortIndex" : 14,
"x-sortIndex" : 7,
"x-methodName" : "getAllTransactionRulesForPaymentInstrument",
"security" : [
{
@@ -4494,14 +4617,14 @@
"/pins/change" : {
"post" : {
"tags" : [
"PIN functionality"
"Manage card PIN"
],
"summary" : "Change Pin",
"description" : "Change Pin",
"summary" : "Change a card PIN",
"description" : "Changes the personal identification number (PIN) of a specified card.\n\nTo make this request, your API credential must have the following role:\n* Bank Issuing PIN Change Webservice role",
"x-addedInVersion" : "1",
"operationId" : "post-pins-change",
"x-sortIndex" : 2,
"x-methodName" : "changePin",
"x-methodName" : "changeCardPin",
"security" : [
{
"clientKey" : [
@@ -4519,6 +4642,11 @@
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"requestPinChange" : {
"$ref" : "#/components/examples/post-pins-change-requestPinChange"
}
},
"schema" : {
"$ref" : "#/components/schemas/PinChangeRequest"
}
@@ -4529,6 +4657,11 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"requestPinChange" : {
"$ref" : "#/components/examples/post-pins-change-requestPinChange-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/PinChangeResponse"
}
@@ -4599,136 +4732,17 @@
}
}
},
"/pins/publicKey" : {
"get" : {
"tags" : [
"PIN functionality"
],
"summary" : "Get RSA publicKey",
"description" : "Get RSA publicKey",
"x-addedInVersion" : "1",
"operationId" : "get-pins-publicKey",
"x-sortIndex" : 1,
"x-methodName" : "getRsaPublickey",
"security" : [
{
"clientKey" : [
]
},
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "Purpose of publicKey.",
"name" : "purpose",
"in" : "query",
"required" : false,
"schema" : {
"type" : "string"
}
},
{
"description" : "Format of publicKey.",
"name" : "format",
"in" : "query",
"required" : false,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PublicKeyResponse"
}
}
},
"description" : "OK - the request has succeeded."
},
"401" : {
"content" : {
"application/json" : {
"examples" : {
"generic" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/pins/reveal" : {
"post" : {
"tags" : [
"PIN functionality"
"Manage card PIN"
],
"summary" : "Reveal Pin",
"description" : "Reveal Pin",
"summary" : "Reveal a card PIN",
"description" : "Returns an encrypted PIN block that contains the PIN of a specified card. You can use the decrypted data to reveal the PIN in your user interface.\n\nTo make this request, your API credential must have the following role:\n* Bank Issuing PIN Reveal Webservice role",
"x-addedInVersion" : "1",
"operationId" : "post-pins-reveal",
"x-sortIndex" : 2,
"x-methodName" : "revealPin",
"x-methodName" : "revealCardPin",
"security" : [
{
"clientKey" : [
@@ -4746,6 +4760,11 @@
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"requestPinBlock" : {
"$ref" : "#/components/examples/post-pins-reveal-requestPinBlock"
}
},
"schema" : {
"$ref" : "#/components/schemas/RevealPinRequest"
}
@@ -4756,6 +4775,11 @@
"200" : {
"content" : {
"application/json" : {
"examples" : {
"requestPinBlock" : {
"$ref" : "#/components/examples/post-pins-reveal-requestPinBlock-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/RevealPinResponse"
}
@@ -4826,6 +4850,130 @@
}
}
},
"/publicKey" : {
"get" : {
"tags" : [
"Manage card PIN"
],
"summary" : "Get an RSA public key",
"description" : "Get an [RSA](https://en.wikipedia.org/wiki/RSA_(cryptosystem)) public key to encrypt or decrypt card data.\n\n You need the RSA public key to generate the `encryptedKey` required to:\n- [Change a PIN](https://docs.adyen.com/api-explorer/balanceplatform/2/post/pins/change).\n- [Reveal a PIN](https://docs.adyen.com/api-explorer/balanceplatform/2/post/pins/reveal).\n- [Reveal a PAN](https://docs.adyen.com/api-explorer/balanceplatform/2/post/paymentInstruments/reveal).",
"x-addedInVersion" : "1",
"operationId" : "get-publicKey",
"x-sortIndex" : 3,
"x-methodName" : "publicKey",
"security" : [
{
"clientKey" : [
]
},
{
"BasicAuth" : [
]
},
{
"ApiKeyAuth" : [
]
}
],
"parameters" : [
{
"description" : "The purpose of the public key.\n\nPossible values: **pinChange**, **pinReveal**, **panReveal**.\n\nDefault value: **pinReveal**.",
"name" : "purpose",
"in" : "query",
"required" : false,
"schema" : {
"type" : "string"
}
},
{
"description" : "The encoding format of public key.\n\nPossible values: **jwk**, **pem**.\n\nDefault value: **pem**.",
"name" : "format",
"in" : "query",
"required" : false,
"schema" : {
"type" : "string"
}
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"success" : {
"$ref" : "#/components/examples/get-publicKey-success-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/PublicKeyResponse"
}
}
},
"description" : "OK - the request has succeeded."
},
"401" : {
"content" : {
"application/json" : {
"examples" : {
"generic" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error."
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/RestServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/transactionRules" : {
"post" : {
"tags" : [
@@ -5628,6 +5776,12 @@
"minLength" : 6,
"type" : "string"
},
"formFactor" : {
"default" : "physical",
"description" : "The form factor of bank account.",
"nullable" : true,
"type" : "string"
},
"type" : {
"default" : "auLocal",
"description" : "**auLocal**",
@@ -6179,6 +6333,12 @@
"minLength" : 1,
"type" : "string"
},
"formFactor" : {
"default" : "physical",
"description" : "The form factor of bank account.",
"nullable" : true,
"type" : "string"
},
"type" : {
"default" : "brLocal",
"description" : "**brLocal**",
@@ -6682,12 +6842,15 @@
"BankIdentification" : {
"properties" : {
"country" : {
"description" : "Two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code.",
"type" : "string"
},
"identification" : {
"description" : "The bank identification code.",
"type" : "string"
},
"identificationType" : {
"description" : "The type of the identification.\n\nPossible values: **iban**, **routingNumber**.",
"enum" : [
"iban",
"routingNumber"
@@ -6778,6 +6941,12 @@
],
"type" : "string"
},
"formFactor" : {
"default" : "physical",
"description" : "The form factor of bank account.",
"nullable" : true,
"type" : "string"
},
"institutionNumber" : {
"description" : "The 3-digit institution number, without separators or whitespace.",
"maxLength" : 3,
@@ -6822,6 +6991,12 @@
"minLength" : 4,
"type" : "string"
},
"formFactor" : {
"default" : "physical",
"description" : "The form factor of bank account.",
"nullable" : true,
"type" : "string"
},
"type" : {
"default" : "czLocal",
"description" : "**czLocal**",
@@ -7502,6 +7677,12 @@
"minLength" : 4,
"type" : "string"
},
"formFactor" : {
"default" : "physical",
"description" : "The form factor of bank account.",
"nullable" : true,
"type" : "string"
},
"type" : {
"default" : "dkLocal",
"description" : "**dkLocal**",
@@ -7876,6 +8057,12 @@
"minLength" : 3,
"type" : "string"
},
"formFactor" : {
"default" : "physical",
"description" : "The form factor of bank account.",
"nullable" : true,
"type" : "string"
},
"type" : {
"default" : "hkLocal",
"description" : "**hkLocal**",
@@ -7901,6 +8088,12 @@
"minLength" : 24,
"type" : "string"
},
"formFactor" : {
"default" : "physical",
"description" : "The form factor of bank account.",
"nullable" : true,
"type" : "string"
},
"type" : {
"default" : "huLocal",
"description" : "**huLocal**",
@@ -7919,6 +8112,12 @@
"IbanAccountIdentification" : {
"additionalProperties" : false,
"properties" : {
"formFactor" : {
"default" : "physical",
"description" : "The form factor of bank account.",
"nullable" : true,
"type" : "string"
},
"iban" : {
"description" : "The international bank account number as defined in the [ISO-13616](https://www.iso.org/standard/81090.html) standard.",
"type" : "string"
@@ -8086,6 +8285,12 @@
"minLength" : 11,
"type" : "string"
},
"formFactor" : {
"default" : "physical",
"description" : "The form factor of bank account.",
"nullable" : true,
"type" : "string"
},
"type" : {
"default" : "noLocal",
"description" : "**noLocal**",
@@ -8110,6 +8315,12 @@
"minLength" : 15,
"type" : "string"
},
"formFactor" : {
"default" : "physical",
"description" : "The form factor of bank account.",
"nullable" : true,
"type" : "string"
},
"type" : {
"default" : "nzLocal",
"description" : "**nzLocal**",
@@ -8129,10 +8340,12 @@
"properties" : {
"firstName" : {
"description" : "The first name.",
"maxLength" : 80,
"type" : "string"
},
"lastName" : {
"description" : "The last name.",
"maxLength" : 80,
"type" : "string"
}
},
@@ -8204,6 +8417,12 @@
"minLength" : 8,
"type" : "string"
},
"formFactor" : {
"default" : "physical",
"description" : "The form factor of bank account.",
"nullable" : true,
"type" : "string"
},
"type" : {
"default" : "numberAndBic",
"description" : "**numberAndBic**",
@@ -8229,6 +8448,12 @@
"minLength" : 26,
"type" : "string"
},
"formFactor" : {
"default" : "physical",
"description" : "The form factor of bank account.",
"nullable" : true,
"type" : "string"
},
"type" : {
"default" : "plLocal",
"description" : "**plLocal**",
@@ -8611,6 +8836,13 @@
"description" : "The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the payment instrument is issued. For example, **NL** or **US**.",
"type" : "string"
},
"issuingCountryCodes" : {
"description" : "The two-character ISO-3166-1 alpha-2 country code list for payment instruments.",
"items" : {
"type" : "string"
},
"type" : "array"
},
"onlyForCrossBalancePlatform" : {
"description" : "Specifies if the requirement only applies to transfers to another balance platform.",
"type" : "boolean"
@@ -8659,6 +8891,35 @@
],
"type" : "object"
},
"PaymentInstrumentRevealRequest" : {
"properties" : {
"encryptedKey" : {
"description" : "The symmetric session key that you encrypted with the [public key](https://docs.adyen.com/api-explorer/balanceplatform/2/get/publicKey) that you received from Adyen.",
"type" : "string"
},
"paymentInstrumentId" : {
"description" : "The unique identifier of the payment instrument, which is the card for which you are managing the PIN.",
"type" : "string"
}
},
"required" : [
"paymentInstrumentId",
"encryptedKey"
],
"type" : "object"
},
"PaymentInstrumentRevealResponse" : {
"properties" : {
"encryptedData" : {
"description" : "The data encrypted using the `encryptedKey`.",
"type" : "string"
}
},
"required" : [
"encryptedData"
],
"type" : "object"
},
"PaymentInstrumentUpdateRequest" : {
"properties" : {
"balanceAccountId" : {
@@ -8749,19 +9010,19 @@
"PinChangeRequest" : {
"properties" : {
"encryptedKey" : {
"description" : "Symmetric session key encrypted under the public key.",
"description" : "The symmetric session key that you encrypted with the [public key](https://docs.adyen.com/api-explorer/balanceplatform/2/get/publicKey) that you received from Adyen.",
"type" : "string"
},
"encryptedPinBlock" : {
"description" : "The encrypted PIN block",
"description" : "The encrypted [PIN block](https://www.pcisecuritystandards.org/glossary/pin-block).",
"type" : "string"
},
"paymentInstrumentId" : {
"description" : "The unique identifier of the payment instrument.",
"description" : "The unique identifier of the payment instrument, which is the card for which you are managing the PIN.",
"type" : "string"
},
"token" : {
"description" : "The token which is used to construct the pinblock.",
"description" : "The 16-digit token that you used to generate the `encryptedPinBlock`.",
"type" : "string"
}
},
@@ -8776,7 +9037,7 @@
"PinChangeResponse" : {
"properties" : {
"status" : {
"description" : "The pin change status.",
"description" : "The status of the request for PIN change.\n\nPossible values: **completed**, **pending**, **unavailable**.",
"enum" : [
"completed",
"pending",
@@ -8837,7 +9098,7 @@
"PublicKeyResponse" : {
"properties" : {
"publicKey" : {
"description" : "The public key to be used for encrypting the symmetric session key.",
"description" : "The public key you need for encrypting a symmetric session key.",
"type" : "string"
},
"publicKeyExpiryDate" : {
@@ -8958,11 +9219,11 @@
"RevealPinRequest" : {
"properties" : {
"encryptedKey" : {
"description" : "Symmetric session key encrypted under the public key.",
"description" : "The symmetric session key that you encrypted with the [public key](https://docs.adyen.com/api-explorer/balanceplatform/2/get/publicKey) that you received from Adyen.",
"type" : "string"
},
"paymentInstrumentId" : {
"description" : "The unique identifier of the payment instrument.",
"description" : "The unique identifier of the payment instrument, which is the card for which you are managing the PIN.",
"type" : "string"
}
},
@@ -8975,11 +9236,11 @@
"RevealPinResponse" : {
"properties" : {
"encryptedPinBlock" : {
"description" : "The encrypted PIN block.",
"description" : "The encrypted [PIN block](https://www.pcisecuritystandards.org/glossary/pin-block).",
"type" : "string"
},
"token" : {
"description" : "The encrypted PIN block extraction token.",
"description" : "The 16-digit token that you need to extract the `encryptedPinBlock`.",
"type" : "string"
}
},
@@ -9004,6 +9265,12 @@
"minLength" : 4,
"type" : "string"
},
"formFactor" : {
"default" : "physical",
"description" : "The form factor of bank account.",
"nullable" : true,
"type" : "string"
},
"type" : {
"default" : "seLocal",
"description" : "**seLocal**",
@@ -9035,6 +9302,12 @@
"minLength" : 8,
"type" : "string"
},
"formFactor" : {
"default" : "physical",
"description" : "The form factor of bank account.",
"nullable" : true,
"type" : "string"
},
"type" : {
"default" : "sgLocal",
"description" : "**sgLocal**",
@@ -9701,20 +9974,23 @@
},
"requirements" : {
"description" : "A set of rules defined by clearing houses and banking partners. Your transfer request must adhere to these rules to ensure successful initiation of transfer. Based on the priority, one or more requirements may be returned. Each requirement is defined with a `type` and `description`.",
"oneOf" : [
{
"$ref" : "#/components/schemas/AddressRequirement"
},
{
"$ref" : "#/components/schemas/AmountMinMaxRequirement"
},
{
"$ref" : "#/components/schemas/BankAccountIdentificationTypeRequirement"
},
{
"$ref" : "#/components/schemas/PaymentInstrumentRequirement"
}
]
"items" : {
"oneOf" : [
{
"$ref" : "#/components/schemas/AddressRequirement"
},
{
"$ref" : "#/components/schemas/AmountMinMaxRequirement"
},
{
"$ref" : "#/components/schemas/BankAccountIdentificationTypeRequirement"
},
{
"$ref" : "#/components/schemas/PaymentInstrumentRequirement"
}
]
},
"type" : "array"
}
},
"type" : "object"
@@ -9792,6 +10068,12 @@
"minLength" : 8,
"type" : "string"
},
"formFactor" : {
"default" : "physical",
"description" : "The form factor of bank account.",
"nullable" : true,
"type" : "string"
},
"sortCode" : {
"description" : "The 6-digit [sort code](https://en.wikipedia.org/wiki/Sort_code), without separators or whitespace.",
"maxLength" : 6,
@@ -9832,6 +10114,12 @@
],
"type" : "string"
},
"formFactor" : {
"default" : "physical",
"description" : "The form factor of bank account.",
"nullable" : true,
"type" : "string"
},
"routingNumber" : {
"description" : "The 9-digit [routing number](https://en.wikipedia.org/wiki/ABA_routing_transit_number), without separators or whitespace.",
"maxLength" : 9,
@@ -10924,6 +11212,13 @@
]
}
},
"get-publicKey-success-200" : {
"summary" : "Response with public key",
"value" : {
"publicKey" : "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMII...",
"publicKeyExpiryDate" : "2023-12-12"
}
},
"get-transactionRules-transactionRuleId-success-200" : {
"summary" : "Transaction rules retrieved",
"description" : "Example response when retrieving a transaction rule",
@@ -11591,6 +11886,35 @@
"id" : "PI32272223222C5GXTDWH3TTN"
}
},
"post-pins-change-requestPinChange" : {
"summary" : "Request a PIN change",
"value" : {
"paymentInstrumentId" : "PI6789678967896789",
"encryptedKey" : "75989E8881284D10153ABACF022EEA09F5...",
"encryptedPinBlock" : "63E5060591EF65F48DD1D4FECD0FECD5",
"token" : "5555341244441115"
}
},
"post-pins-change-requestPinChange-200" : {
"summary" : "Request completed",
"value" : {
"status" : "completed"
}
},
"post-pins-reveal-requestPinBlock" : {
"summary" : "Request a PIN block",
"value" : {
"paymentInstrumentId" : "PI3227C223222B5BPCMFXD2XG",
"encryptedKey" : "75989E8881284D10153ABACF022EEA09F5..."
}
},
"post-pins-reveal-requestPinBlock-200" : {
"summary" : "Response with encrypted PIN block",
"value" : {
"encryptedPinBlock" : "63E5060591EF65F48DD1D4FECD0FECD5",
"token" : "5555341244441115"
}
},
"post-transactionRules-createTransactionRuleAllowPos" : {
"summary" : "Allow only point-of-sale transactions",
"description" : "Example request to allow only point-of-sale transactions",
@@ -11883,8 +12207,9 @@
{
"description" : "Country, street and city is required.",
"requiredAddressFields" : [
"STREET",
"CITY"
"line1",
"city",
"country"
],
"type" : "addressRequirement"
},
@@ -11917,8 +12242,9 @@
{
"description" : "Country, street and city is required.",
"requiredAddressFields" : [
"STREET",
"CITY"
"line1",
"city",
"country"
],
"type" : "addressRequirement"
},

47
yaml/BalancePlatformConfigurationNotification-v1.yaml
View File

@@ -47,11 +47,6 @@ webhooks:
'200':
content:
application/json:
examples:
balancePlatform-accountHolder-created:
$ref: '#/components/examples/WebhookAck'
balancePlatform-accountHolder-created-lem-v3:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/BalancePlatformNotificationResponse'
description: OK - the request has succeeded.
@@ -81,11 +76,6 @@ webhooks:
'200':
content:
application/json:
examples:
balancePlatform-accountHolder-updated:
$ref: '#/components/examples/WebhookAck'
balancePlatform-accountHolder-updated-lem-v3:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/BalancePlatformNotificationResponse'
description: OK - the request has succeeded.
@@ -113,9 +103,6 @@ webhooks:
'200':
content:
application/json:
examples:
balancePlatform-balanceAccount-created:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/BalancePlatformNotificationResponse'
description: OK - the request has succeeded.
@@ -143,9 +130,6 @@ webhooks:
'200':
content:
application/json:
examples:
balancePlatform-balanceAccount-updated:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/BalancePlatformNotificationResponse'
description: OK - the request has succeeded.
@@ -172,9 +156,6 @@ webhooks:
'200':
content:
application/json:
examples:
balancePlatform-sweep-created:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/BalancePlatformNotificationResponse'
description: OK - the request has succeeded.
@@ -201,9 +182,6 @@ webhooks:
'200':
content:
application/json:
examples:
balancePlatform-sweep-deleted:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/BalancePlatformNotificationResponse'
description: OK - the request has succeeded.
@@ -230,9 +208,6 @@ webhooks:
'200':
content:
application/json:
examples:
balancePlatform-sweep-updated:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/BalancePlatformNotificationResponse'
description: OK - the request has succeeded.
@@ -312,9 +287,6 @@ webhooks:
'200':
content:
application/json:
examples:
balancePlatform-paymentInstrument-created:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/BalancePlatformNotificationResponse'
description: OK - the request has succeeded.
@@ -342,9 +314,6 @@ webhooks:
'200':
content:
application/json:
examples:
balancePlatform-paymentInstrument-updated:
$ref: '#/components/examples/WebhookAck'
schema:
$ref: '#/components/schemas/BalancePlatformNotificationResponse'
description: OK - the request has succeeded.
@@ -1275,6 +1244,11 @@ components:
IbanAccountIdentification:
additionalProperties: false
properties:
formFactor:
default: physical
description: The form factor of bank account.
nullable: true
type: string
iban:
description: The international bank account number as defined in the [ISO-13616](https://www.iso.org/standard/81090.html)
standard.
@@ -1293,9 +1267,11 @@ components:
properties:
firstName:
description: The first name.
maxLength: 80
type: string
lastName:
description: The last name.
maxLength: 80
type: string
required:
- firstName
@@ -1769,6 +1745,11 @@ components:
- checking
- savings
type: string
formFactor:
default: physical
description: The form factor of bank account.
nullable: true
type: string
routingNumber:
description: The 9-digit [routing number](https://en.wikipedia.org/wiki/ABA_routing_transit_number),
without separators or whitespace.
@@ -2030,10 +2011,6 @@ components:
scheme: basic
type: http
examples:
WebhookAck:
summary: Acknowledge Webhook
value:
notificationResponse: '[accepted]'
post-balancePlatform.accountHolder.created-balancePlatform-accountHolder-created:
summary: Account holder created with LEM API v1, v2
description: Example webhook when an account holder was created with LEM API

495
yaml/BalancePlatformService-v2.yaml
View File

@@ -35,8 +35,8 @@ tags:
- name: Network tokens
- name: Grant accounts
- name: Grant offers
- name: PIN functionality
- name: Card orders
- name: Manage card PIN
- name: Transfer routes
paths:
/accountHolders:
@@ -2248,7 +2248,7 @@ paths:
\ business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)."
x-addedInVersion: '1'
operationId: post-paymentInstruments
x-sortIndex: 11
x-sortIndex: 1
x-methodName: createPaymentInstrument
security:
- clientKey: []
@@ -2329,6 +2329,93 @@ paths:
schema:
$ref: '#/components/schemas/RestServiceError'
description: Internal Server Error - the server could not process the request.
/paymentInstruments/reveal:
post:
tags:
- Payment instruments
summary: Reveal the data of a payment instrument
description: 'Returns the encrypted data of a specified payment instrument.
These data include:
- The primary account number (PAN)
- The card verification code (CVC)
- The expiry date
You can decrypt the data to reveal it in your user interface.
To make this request, your API credential must have the following role:
* Bank Issuing PAN Reveal Webservice role'
x-addedInVersion: '1'
operationId: post-paymentInstruments-reveal
x-sortIndex: 4
x-methodName: revealDataOfPaymentInstrument
security:
- clientKey: []
- BasicAuth: []
- ApiKeyAuth: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentInstrumentRevealRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentInstrumentRevealResponse'
description: OK - the request has succeeded.
'400':
content:
application/json:
examples:
generic:
$ref: '#/components/examples/generic-400'
schema:
$ref: '#/components/schemas/RestServiceError'
description: Bad Request - a problem reading or understanding the request.
'401':
content:
application/json:
examples:
generic:
$ref: '#/components/examples/generic-401'
schema:
$ref: '#/components/schemas/RestServiceError'
description: Unauthorized - authentication required.
'403':
content:
application/json:
examples:
generic:
$ref: '#/components/examples/generic-403'
schema:
$ref: '#/components/schemas/RestServiceError'
description: Forbidden - insufficient permissions to process the request.
'422':
content:
application/json:
examples:
generic:
$ref: '#/components/examples/generic-422'
schema:
$ref: '#/components/schemas/RestServiceError'
description: Unprocessable Entity - a request validation error.
'500':
content:
application/json:
examples:
generic:
$ref: '#/components/examples/generic-500'
schema:
$ref: '#/components/schemas/RestServiceError'
description: Internal Server Error - the server could not process the request.
/paymentInstruments/{id}:
get:
tags:
@@ -2337,7 +2424,7 @@ paths:
description: Returns the details of a payment instrument.
x-addedInVersion: '1'
operationId: get-paymentInstruments-id
x-sortIndex: 13
x-sortIndex: 3
x-methodName: getPaymentInstrument
security:
- clientKey: []
@@ -2414,7 +2501,7 @@ paths:
status, you can still update the balance account associated with the card.
x-addedInVersion: '1'
operationId: patch-paymentInstruments-id
x-sortIndex: 12
x-sortIndex: 2
x-methodName: updatePaymentInstrument
security:
- clientKey: []
@@ -2502,7 +2589,7 @@ paths:
description: List the network tokens connected to a payment instrument.
x-addedInVersion: '1'
operationId: get-paymentInstruments-id-networkTokens
x-sortIndex: 15
x-sortIndex: 6
x-methodName: listNetworkTokens
security:
- clientKey: []
@@ -2581,7 +2668,7 @@ paths:
* Balance Platform BCL PCI role'
x-addedInVersion: '1'
operationId: get-paymentInstruments-id-reveal
x-sortIndex: 14
x-sortIndex: 5
x-methodName: getPanOfPaymentInstrument
security:
- clientKey: []
@@ -2657,7 +2744,7 @@ paths:
description: Returns a list of transaction rules associated with a payment instrument.
x-addedInVersion: '1'
operationId: get-paymentInstruments-id-transactionRules
x-sortIndex: 14
x-sortIndex: 7
x-methodName: getAllTransactionRulesForPaymentInstrument
security:
- clientKey: []
@@ -2728,13 +2815,19 @@ paths:
/pins/change:
post:
tags:
- PIN functionality
summary: Change Pin
description: Change Pin
- Manage card PIN
summary: Change a card PIN
description: 'Changes the personal identification number (PIN) of a specified
card.
To make this request, your API credential must have the following role:
* Bank Issuing PIN Change Webservice role'
x-addedInVersion: '1'
operationId: post-pins-change
x-sortIndex: 2
x-methodName: changePin
x-methodName: changeCardPin
security:
- clientKey: []
- BasicAuth: []
@@ -2742,12 +2835,18 @@ paths:
requestBody:
content:
application/json:
examples:
requestPinChange:
$ref: '#/components/examples/post-pins-change-requestPinChange'
schema:
$ref: '#/components/schemas/PinChangeRequest'
responses:
'200':
content:
application/json:
examples:
requestPinChange:
$ref: '#/components/examples/post-pins-change-requestPinChange-200'
schema:
$ref: '#/components/schemas/PinChangeResponse'
description: OK - the request has succeeded.
@@ -2787,86 +2886,22 @@ paths:
schema:
$ref: '#/components/schemas/RestServiceError'
description: Internal Server Error - the server could not process the request.
/pins/publicKey:
get:
tags:
- PIN functionality
summary: Get RSA publicKey
description: Get RSA publicKey
x-addedInVersion: '1'
operationId: get-pins-publicKey
x-sortIndex: 1
x-methodName: getRsaPublickey
security:
- clientKey: []
- BasicAuth: []
- ApiKeyAuth: []
parameters:
- description: Purpose of publicKey.
name: purpose
in: query
required: false
schema:
type: string
- description: Format of publicKey.
name: format
in: query
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PublicKeyResponse'
description: OK - the request has succeeded.
'401':
content:
application/json:
examples:
generic:
$ref: '#/components/examples/generic-401'
schema:
$ref: '#/components/schemas/RestServiceError'
description: Unauthorized - authentication required.
'403':
content:
application/json:
examples:
generic:
$ref: '#/components/examples/generic-403'
schema:
$ref: '#/components/schemas/RestServiceError'
description: Forbidden - insufficient permissions to process the request.
'422':
content:
application/json:
examples:
generic:
$ref: '#/components/examples/generic-422'
schema:
$ref: '#/components/schemas/RestServiceError'
description: Unprocessable Entity - a request validation error.
'500':
content:
application/json:
examples:
generic:
$ref: '#/components/examples/generic-500'
schema:
$ref: '#/components/schemas/RestServiceError'
description: Internal Server Error - the server could not process the request.
/pins/reveal:
post:
tags:
- PIN functionality
summary: Reveal Pin
description: Reveal Pin
- Manage card PIN
summary: Reveal a card PIN
description: 'Returns an encrypted PIN block that contains the PIN of a specified
card. You can use the decrypted data to reveal the PIN in your user interface.
To make this request, your API credential must have the following role:
* Bank Issuing PIN Reveal Webservice role'
x-addedInVersion: '1'
operationId: post-pins-reveal
x-sortIndex: 2
x-methodName: revealPin
x-methodName: revealCardPin
security:
- clientKey: []
- BasicAuth: []
@@ -2874,12 +2909,18 @@ paths:
requestBody:
content:
application/json:
examples:
requestPinBlock:
$ref: '#/components/examples/post-pins-reveal-requestPinBlock'
schema:
$ref: '#/components/schemas/RevealPinRequest'
responses:
'200':
content:
application/json:
examples:
requestPinBlock:
$ref: '#/components/examples/post-pins-reveal-requestPinBlock-200'
schema:
$ref: '#/components/schemas/RevealPinResponse'
description: OK - the request has succeeded.
@@ -2919,6 +2960,95 @@ paths:
schema:
$ref: '#/components/schemas/RestServiceError'
description: Internal Server Error - the server could not process the request.
/publicKey:
get:
tags:
- Manage card PIN
summary: Get an RSA public key
description: "Get an [RSA](https://en.wikipedia.org/wiki/RSA_(cryptosystem))\
\ public key to encrypt or decrypt card data.\n\n You need the RSA public\
\ key to generate the `encryptedKey` required to:\n- [Change a PIN](https://docs.adyen.com/api-explorer/balanceplatform/2/post/pins/change).\n\
- [Reveal a PIN](https://docs.adyen.com/api-explorer/balanceplatform/2/post/pins/reveal).\n\
- [Reveal a PAN](https://docs.adyen.com/api-explorer/balanceplatform/2/post/paymentInstruments/reveal)."
x-addedInVersion: '1'
operationId: get-publicKey
x-sortIndex: 3
x-methodName: publicKey
security:
- clientKey: []
- BasicAuth: []
- ApiKeyAuth: []
parameters:
- description: 'The purpose of the public key.
Possible values: **pinChange**, **pinReveal**, **panReveal**.
Default value: **pinReveal**.'
name: purpose
in: query
required: false
schema:
type: string
- description: 'The encoding format of public key.
Possible values: **jwk**, **pem**.
Default value: **pem**.'
name: format
in: query
required: false
schema:
type: string
responses:
'200':
content:
application/json:
examples:
success:
$ref: '#/components/examples/get-publicKey-success-200'
schema:
$ref: '#/components/schemas/PublicKeyResponse'
description: OK - the request has succeeded.
'401':
content:
application/json:
examples:
generic:
$ref: '#/components/examples/generic-401'
schema:
$ref: '#/components/schemas/RestServiceError'
description: Unauthorized - authentication required.
'403':
content:
application/json:
examples:
generic:
$ref: '#/components/examples/generic-403'
schema:
$ref: '#/components/schemas/RestServiceError'
description: Forbidden - insufficient permissions to process the request.
'422':
content:
application/json:
examples:
generic:
$ref: '#/components/examples/generic-422'
schema:
$ref: '#/components/schemas/RestServiceError'
description: Unprocessable Entity - a request validation error.
'500':
content:
application/json:
examples:
generic:
$ref: '#/components/examples/generic-500'
schema:
$ref: '#/components/schemas/RestServiceError'
description: Internal Server Error - the server could not process the request.
/transactionRules:
post:
tags:
@@ -3408,6 +3538,11 @@ components:
maxLength: 6
minLength: 6
type: string
formFactor:
default: physical
description: The form factor of bank account.
nullable: true
type: string
type:
default: auLocal
description: '**auLocal**'
@@ -4002,6 +4137,11 @@ components:
maxLength: 4
minLength: 1
type: string
formFactor:
default: physical
description: The form factor of bank account.
nullable: true
type: string
type:
default: brLocal
description: '**brLocal**'
@@ -4425,10 +4565,17 @@ components:
BankIdentification:
properties:
country:
description: Two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
country code.
type: string
identification:
description: The bank identification code.
type: string
identificationType:
description: 'The type of the identification.
Possible values: **iban**, **routingNumber**.'
enum:
- iban
- routingNumber
@@ -4518,6 +4665,11 @@ components:
- checking
- savings
type: string
formFactor:
default: physical
description: The form factor of bank account.
nullable: true
type: string
institutionNumber:
description: The 3-digit institution number, without separators or whitespace.
maxLength: 3
@@ -4560,6 +4712,11 @@ components:
maxLength: 4
minLength: 4
type: string
formFactor:
default: physical
description: The form factor of bank account.
nullable: true
type: string
type:
default: czLocal
description: '**czLocal**'
@@ -5226,6 +5383,11 @@ components:
maxLength: 4
minLength: 4
type: string
formFactor:
default: physical
description: The form factor of bank account.
nullable: true
type: string
type:
default: dkLocal
description: '**dkLocal**'
@@ -5564,6 +5726,11 @@ components:
maxLength: 3
minLength: 3
type: string
formFactor:
default: physical
description: The form factor of bank account.
nullable: true
type: string
type:
default: hkLocal
description: '**hkLocal**'
@@ -5583,6 +5750,11 @@ components:
maxLength: 24
minLength: 24
type: string
formFactor:
default: physical
description: The form factor of bank account.
nullable: true
type: string
type:
default: huLocal
description: '**huLocal**'
@@ -5596,6 +5768,11 @@ components:
IbanAccountIdentification:
additionalProperties: false
properties:
formFactor:
default: physical
description: The form factor of bank account.
nullable: true
type: string
iban:
description: The international bank account number as defined in the [ISO-13616](https://www.iso.org/standard/81090.html)
standard.
@@ -5727,6 +5904,11 @@ components:
maxLength: 11
minLength: 11
type: string
formFactor:
default: physical
description: The form factor of bank account.
nullable: true
type: string
type:
default: noLocal
description: '**noLocal**'
@@ -5747,6 +5929,11 @@ components:
maxLength: 16
minLength: 15
type: string
formFactor:
default: physical
description: The form factor of bank account.
nullable: true
type: string
type:
default: nzLocal
description: '**nzLocal**'
@@ -5761,9 +5948,11 @@ components:
properties:
firstName:
description: The first name.
maxLength: 80
type: string
lastName:
description: The last name.
maxLength: 80
type: string
required:
- firstName
@@ -5824,6 +6013,11 @@ components:
maxLength: 11
minLength: 8
type: string
formFactor:
default: physical
description: The form factor of bank account.
nullable: true
type: string
type:
default: numberAndBic
description: '**numberAndBic**'
@@ -5844,6 +6038,11 @@ components:
maxLength: 26
minLength: 26
type: string
formFactor:
default: physical
description: The form factor of bank account.
nullable: true
type: string
type:
default: plLocal
description: '**plLocal**'
@@ -6187,6 +6386,12 @@ components:
country code where the payment instrument is issued. For example, **NL**
or **US**.
type: string
issuingCountryCodes:
description: The two-character ISO-3166-1 alpha-2 country code list for
payment instruments.
items:
type: string
type: array
onlyForCrossBalancePlatform:
description: Specifies if the requirement only applies to transfers to another
balance platform.
@@ -6223,6 +6428,29 @@ components:
- expiration
- cvc
type: object
PaymentInstrumentRevealRequest:
properties:
encryptedKey:
description: The symmetric session key that you encrypted with the [public
key](https://docs.adyen.com/api-explorer/balanceplatform/2/get/publicKey)
that you received from Adyen.
type: string
paymentInstrumentId:
description: The unique identifier of the payment instrument, which is the
card for which you are managing the PIN.
type: string
required:
- paymentInstrumentId
- encryptedKey
type: object
PaymentInstrumentRevealResponse:
properties:
encryptedData:
description: The data encrypted using the `encryptedKey`.
type: string
required:
- encryptedData
type: object
PaymentInstrumentUpdateRequest:
properties:
balanceAccountId:
@@ -6325,16 +6553,19 @@ components:
PinChangeRequest:
properties:
encryptedKey:
description: Symmetric session key encrypted under the public key.
description: The symmetric session key that you encrypted with the [public
key](https://docs.adyen.com/api-explorer/balanceplatform/2/get/publicKey)
that you received from Adyen.
type: string
encryptedPinBlock:
description: The encrypted PIN block
description: The encrypted [PIN block](https://www.pcisecuritystandards.org/glossary/pin-block).
type: string
paymentInstrumentId:
description: The unique identifier of the payment instrument.
description: The unique identifier of the payment instrument, which is the
card for which you are managing the PIN.
type: string
token:
description: The token which is used to construct the pinblock.
description: The 16-digit token that you used to generate the `encryptedPinBlock`.
type: string
required:
- paymentInstrumentId
@@ -6345,7 +6576,10 @@ components:
PinChangeResponse:
properties:
status:
description: The pin change status.
description: 'The status of the request for PIN change.
Possible values: **completed**, **pending**, **unavailable**.'
enum:
- completed
- pending
@@ -6417,7 +6651,7 @@ components:
PublicKeyResponse:
properties:
publicKey:
description: The public key to be used for encrypting the symmetric session
description: The public key you need for encrypting a symmetric session
key.
type: string
publicKeyExpiryDate:
@@ -6513,10 +6747,13 @@ components:
RevealPinRequest:
properties:
encryptedKey:
description: Symmetric session key encrypted under the public key.
description: The symmetric session key that you encrypted with the [public
key](https://docs.adyen.com/api-explorer/balanceplatform/2/get/publicKey)
that you received from Adyen.
type: string
paymentInstrumentId:
description: The unique identifier of the payment instrument.
description: The unique identifier of the payment instrument, which is the
card for which you are managing the PIN.
type: string
required:
- paymentInstrumentId
@@ -6525,10 +6762,10 @@ components:
RevealPinResponse:
properties:
encryptedPinBlock:
description: The encrypted PIN block.
description: The encrypted [PIN block](https://www.pcisecuritystandards.org/glossary/pin-block).
type: string
token:
description: The encrypted PIN block extraction token.
description: The 16-digit token that you need to extract the `encryptedPinBlock`.
type: string
required:
- encryptedPinBlock
@@ -6549,6 +6786,11 @@ components:
maxLength: 5
minLength: 4
type: string
formFactor:
default: physical
description: The form factor of bank account.
nullable: true
type: string
type:
default: seLocal
description: '**seLocal**'
@@ -6574,6 +6816,11 @@ components:
maxLength: 11
minLength: 8
type: string
formFactor:
default: physical
description: The form factor of bank account.
nullable: true
type: string
type:
default: sgLocal
description: '**sgLocal**'
@@ -7450,11 +7697,13 @@ components:
Your transfer request must adhere to these rules to ensure successful
initiation of transfer. Based on the priority, one or more requirements
may be returned. Each requirement is defined with a `type` and `description`.
oneOf:
- $ref: '#/components/schemas/AddressRequirement'
- $ref: '#/components/schemas/AmountMinMaxRequirement'
- $ref: '#/components/schemas/BankAccountIdentificationTypeRequirement'
- $ref: '#/components/schemas/PaymentInstrumentRequirement'
items:
oneOf:
- $ref: '#/components/schemas/AddressRequirement'
- $ref: '#/components/schemas/AmountMinMaxRequirement'
- $ref: '#/components/schemas/BankAccountIdentificationTypeRequirement'
- $ref: '#/components/schemas/PaymentInstrumentRequirement'
type: array
type: object
TransferRouteRequest:
properties:
@@ -7546,6 +7795,11 @@ components:
maxLength: 8
minLength: 8
type: string
formFactor:
default: physical
description: The form factor of bank account.
nullable: true
type: string
sortCode:
description: The 6-digit [sort code](https://en.wikipedia.org/wiki/Sort_code),
without separators or whitespace.
@@ -7581,6 +7835,11 @@ components:
- checking
- savings
type: string
formFactor:
default: physical
description: The form factor of bank account.
nullable: true
type: string
routingNumber:
description: The 9-digit [routing number](https://en.wikipedia.org/wiki/ABA_routing_transit_number),
without separators or whitespace.
@@ -8561,6 +8820,11 @@ components:
status: active
type: blockList
id: TR32272223222C5GQJ93L7J8Z
get-publicKey-success-200:
summary: Response with public key
value:
publicKey: MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMII...
publicKeyExpiryDate: '2023-12-12'
get-transactionRules-transactionRuleId-success-200:
summary: Transaction rules retrieved
description: Example response when retrieving a transaction rule
@@ -9083,6 +9347,27 @@ components:
lastFour: '3703'
number: '5555444411213703'
id: PI32272223222C5GXTDWH3TTN
post-pins-change-requestPinChange:
summary: Request a PIN change
value:
paymentInstrumentId: PI6789678967896789
encryptedKey: 75989E8881284D10153ABACF022EEA09F5...
encryptedPinBlock: 63E5060591EF65F48DD1D4FECD0FECD5
token: '5555341244441115'
post-pins-change-requestPinChange-200:
summary: Request completed
value:
status: completed
post-pins-reveal-requestPinBlock:
summary: Request a PIN block
value:
paymentInstrumentId: PI3227C223222B5BPCMFXD2XG
encryptedKey: 75989E8881284D10153ABACF022EEA09F5...
post-pins-reveal-requestPinBlock-200:
summary: Response with encrypted PIN block
value:
encryptedPinBlock: 63E5060591EF65F48DD1D4FECD0FECD5
token: '5555341244441115'
post-transactionRules-createTransactionRuleAllowPos:
summary: Allow only point-of-sale transactions
description: Example request to allow only point-of-sale transactions
@@ -9305,8 +9590,9 @@ components:
type: amountMinMaxRequirement
- description: Country, street and city is required.
requiredAddressFields:
- STREET
- CITY
- line1
- city
- country
type: addressRequirement
- description: Bank account identification type must be iban or numberAndBic
bankAccountIdentificationTypes:
@@ -9327,8 +9613,9 @@ components:
type: amountMinMaxRequirement
- description: Country, street and city is required.
requiredAddressFields:
- STREET
- CITY
- line1
- city
- country
type: addressRequirement
- description: Bank account identification type must be iban or numberAndBic
bankAccountIdentificationTypes: