{ "openapi" : "3.1.0", "info" : { "title" : "Adyen Stored Value API", "description" : "A set of API endpoints to manage stored value products.", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", "url" : "https://github.com/Adyen/adyen-openapi" }, "version" : "46", "x-publicVersion" : true }, "servers" : [ { "url" : "https://pal-test.adyen.com/pal/servlet/StoredValue/v46" } ], "tags" : [ { "name" : "General" } ], "paths" : { "/changeStatus" : { "post" : { "tags" : [ "General" ], "summary" : "Changes the status of the payment method.", "description" : "Changes the status of the provided payment method to the specified status.", "operationId" : "post-changeStatus", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StoredValueStatusChangeRequest" } } } }, "responses" : { "200" : { "description" : "OK - the request has succeeded.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StoredValueStatusChangeResponse" } } } }, "400" : { "description" : "Bad Request - a problem reading or understanding the request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceError" } } } }, "401" : { "description" : "Unauthorized - authentication required.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceError" } } } }, "403" : { "description" : "Forbidden - insufficient permissions to process the request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceError" } } } }, "500" : { "description" : "Internal Server Error - the server could not process the request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceError" } } } } }, "security" : [ { "BasicAuth" : [ ] }, { "ApiKeyAuth" : [ ] } ], "x-sortIndex" : 0, "x-methodName" : "changeStatus" } }, "/checkBalance" : { "post" : { "tags" : [ "General" ], "summary" : "Checks the balance.", "description" : "Checks the balance of the provided payment method.", "operationId" : "post-checkBalance", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StoredValueBalanceCheckRequest" } } } }, "responses" : { "200" : { "description" : "OK - the request has succeeded.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StoredValueBalanceCheckResponse" } } } }, "400" : { "description" : "Bad Request - a problem reading or understanding the request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceError" } } } }, "401" : { "description" : "Unauthorized - authentication required.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceError" } } } }, "403" : { "description" : "Forbidden - insufficient permissions to process the request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceError" } } } }, "500" : { "description" : "Internal Server Error - the server could not process the request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceError" } } } } }, "security" : [ { "BasicAuth" : [ ] }, { "ApiKeyAuth" : [ ] } ], "x-sortIndex" : 0, "x-methodName" : "checkBalance" } }, "/issue" : { "post" : { "tags" : [ "General" ], "summary" : "Issues a new card.", "description" : "Issues a new card of the given payment method.", "operationId" : "post-issue", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StoredValueIssueRequest" } } } }, "responses" : { "200" : { "description" : "OK - the request has succeeded.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StoredValueIssueResponse" } } } }, "400" : { "description" : "Bad Request - a problem reading or understanding the request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceError" } } } }, "401" : { "description" : "Unauthorized - authentication required.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceError" } } } }, "403" : { "description" : "Forbidden - insufficient permissions to process the request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceError" } } } }, "500" : { "description" : "Internal Server Error - the server could not process the request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceError" } } } } }, "security" : [ { "BasicAuth" : [ ] }, { "ApiKeyAuth" : [ ] } ], "x-sortIndex" : 0, "x-methodName" : "issue" } }, "/load" : { "post" : { "tags" : [ "General" ], "summary" : "Loads the payment method.", "description" : "Loads the payment method with the specified funds.", "operationId" : "post-load", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StoredValueLoadRequest" } } } }, "responses" : { "200" : { "description" : "OK - the request has succeeded.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StoredValueLoadResponse" } } } }, "400" : { "description" : "Bad Request - a problem reading or understanding the request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceError" } } } }, "401" : { "description" : "Unauthorized - authentication required.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceError" } } } }, "403" : { "description" : "Forbidden - insufficient permissions to process the request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceError" } } } }, "500" : { "description" : "Internal Server Error - the server could not process the request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceError" } } } } }, "security" : [ { "BasicAuth" : [ ] }, { "ApiKeyAuth" : [ ] } ], "x-sortIndex" : 0, "x-methodName" : "load" } }, "/mergeBalance" : { "post" : { "tags" : [ "General" ], "summary" : "Merge the balance of two cards.", "description" : "Increases the balance of the paymentmethod by the full amount left on the source paymentmethod", "operationId" : "post-mergeBalance", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StoredValueBalanceMergeRequest" } } } }, "responses" : { "200" : { "description" : "OK - the request has succeeded.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StoredValueBalanceMergeResponse" } } } }, "400" : { "description" : "Bad Request - a problem reading or understanding the request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceError" } } } }, "401" : { "description" : "Unauthorized - authentication required.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceError" } } } }, "403" : { "description" : "Forbidden - insufficient permissions to process the request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceError" } } } }, "500" : { "description" : "Internal Server Error - the server could not process the request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceError" } } } } }, "security" : [ { "BasicAuth" : [ ] }, { "ApiKeyAuth" : [ ] } ], "x-sortIndex" : 0, "x-methodName" : "mergeBalance" } }, "/voidTransaction" : { "post" : { "tags" : [ "General" ], "summary" : "Voids a transaction.", "description" : "Voids the referenced stored value transaction.", "operationId" : "post-voidTransaction", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StoredValueVoidRequest" } } } }, "responses" : { "200" : { "description" : "OK - the request has succeeded.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StoredValueVoidResponse" } } } }, "400" : { "description" : "Bad Request - a problem reading or understanding the request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceError" } } } }, "401" : { "description" : "Unauthorized - authentication required.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceError" } } } }, "403" : { "description" : "Forbidden - insufficient permissions to process the request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceError" } } } }, "500" : { "description" : "Internal Server Error - the server could not process the request.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ServiceError" } } } } }, "security" : [ { "BasicAuth" : [ ] }, { "ApiKeyAuth" : [ ] } ], "x-sortIndex" : 0, "x-methodName" : "voidTransaction" } } }, "components" : { "schemas" : { "Amount" : { "type" : "object", "additionalProperties" : false, "properties" : { "currency" : { "type" : "string", "description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount.", "maxLength" : 3, "minLength" : 3 }, "value" : { "type" : "integer", "format" : "int64", "description" : "The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units)." } }, "required" : [ "currency", "value" ] }, "ServiceError" : { "type" : "object", "additionalProperties" : false, "properties" : { "additionalData" : { "type" : "object", "additionalProperties" : { "type" : "string" }, "description" : "Contains additional information about the payment. Some data fields are included only if you select them first. Go to **Customer Area** > **Developers** > **Additional data**.", "x-addedInVersion" : "46" }, "errorCode" : { "type" : "string", "description" : "The error code mapped to the error message." }, "errorType" : { "type" : "string", "description" : "The category of the error." }, "message" : { "type" : "string", "description" : "A short explanation of the issue." }, "pspReference" : { "type" : "string", "description" : "The PSP reference of the payment." }, "status" : { "type" : "integer", "format" : "int32", "description" : "The HTTP response status." } } }, "StoredValueBalanceCheckRequest" : { "type" : "object", "additionalProperties" : false, "properties" : { "amount" : { "$ref" : "#/components/schemas/Amount", "description" : "The amount information for the transaction." }, "merchantAccount" : { "type" : "string", "description" : "The merchant account identifier, with which you want to process the transaction." }, "paymentMethod" : { "type" : "object", "additionalProperties" : { "type" : "string" }, "description" : "The collection that contains the type of the payment method and its specific information if available" }, "recurringDetailReference" : { "type" : "string" }, "reference" : { "type" : "string", "description" : "The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.\nIf you need to provide multiple references for a transaction, separate them with hyphens (\"-\").\nMaximum length: 80 characters." }, "shopperInteraction" : { "type" : "string", "description" : "Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.\nFor the web service API, Adyen assumes Ecommerce shopper interaction by default.\n\nThis field has the following possible values:\n* `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request.\n* `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment).\n* `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone.\n* `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.", "enum" : [ "Ecommerce", "ContAuth", "Moto", "POS" ] }, "shopperReference" : { "type" : "string" }, "store" : { "type" : "string", "description" : "The physical store, for which this payment is processed.", "maxLength" : 16, "minLength" : 1 } }, "required" : [ "merchantAccount", "paymentMethod", "reference" ] }, "StoredValueBalanceCheckResponse" : { "type" : "object", "additionalProperties" : false, "properties" : { "currentBalance" : { "$ref" : "#/components/schemas/Amount", "description" : "The balance currently on the payment method." }, "pspReference" : { "type" : "string", "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request." }, "refusalReason" : { "type" : "string", "description" : "If the transaction is refused or an error occurs, this field holds Adyen's mapped reason for the refusal or a description of the error.\n\nWhen a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values." }, "resultCode" : { "type" : "string", "description" : "The result of the payment. Possible values:\n\n* **Success** – The operation has been completed successfully. \n* **Refused** – The operation was refused. The reason is given in the `refusalReason` field. \n* **Error** – There was an error when the operation was processed. The reason is given in the `refusalReason` field. \n* **NotEnoughBalance** – The amount on the payment method is lower than the amount given in the request. Only applicable to balance checks. \n", "enum" : [ "Success", "Refused", "Error", "NotEnoughBalance" ] }, "thirdPartyRefusalReason" : { "type" : "string", "description" : "Raw refusal reason received from the third party, where available" } } }, "StoredValueBalanceMergeRequest" : { "type" : "object", "additionalProperties" : false, "properties" : { "amount" : { "$ref" : "#/components/schemas/Amount", "description" : "The amount information for the transaction." }, "merchantAccount" : { "type" : "string", "description" : "The merchant account identifier, with which you want to process the transaction." }, "paymentMethod" : { "type" : "object", "additionalProperties" : { "type" : "string" }, "description" : "The collection that contains the type of the payment method and its specific information if available" }, "recurringDetailReference" : { "type" : "string" }, "reference" : { "type" : "string", "description" : "The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.\nIf you need to provide multiple references for a transaction, separate them with hyphens (\"-\").\nMaximum length: 80 characters." }, "shopperInteraction" : { "type" : "string", "description" : "Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.\nFor the web service API, Adyen assumes Ecommerce shopper interaction by default.\n\nThis field has the following possible values:\n* `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request.\n* `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment).\n* `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone.\n* `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.", "enum" : [ "Ecommerce", "ContAuth", "Moto", "POS" ] }, "shopperReference" : { "type" : "string" }, "sourcePaymentMethod" : { "type" : "object", "additionalProperties" : { "type" : "string" }, "description" : "The collection that contains the source payment method and its specific information if available. Note that type should not be included since it is inferred from the (target) payment method" }, "store" : { "type" : "string", "description" : "The physical store, for which this payment is processed.", "maxLength" : 16, "minLength" : 1 } }, "required" : [ "merchantAccount", "paymentMethod", "reference", "sourcePaymentMethod" ] }, "StoredValueBalanceMergeResponse" : { "type" : "object", "additionalProperties" : false, "properties" : { "authCode" : { "type" : "string", "description" : "Authorisation code:\n* When the payment is authorised, this field holds the authorisation code for the payment.\n* When the payment is not authorised, this field is empty." }, "currentBalance" : { "$ref" : "#/components/schemas/Amount", "description" : "The balance currently on the payment method." }, "pspReference" : { "type" : "string", "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request." }, "refusalReason" : { "type" : "string", "description" : "If the transaction is refused or an error occurs, this field holds Adyen's mapped reason for the refusal or a description of the error.\n\nWhen a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values." }, "resultCode" : { "type" : "string", "description" : "The result of the payment. Possible values:\n\n* **Success** – The operation has been completed successfully. \n* **Refused** – The operation was refused. The reason is given in the `refusalReason` field. \n* **Error** – There was an error when the operation was processed. The reason is given in the `refusalReason` field. \n* **NotEnoughBalance** – The amount on the payment method is lower than the amount given in the request. Only applicable to balance checks. \n", "enum" : [ "Success", "Refused", "Error", "NotEnoughBalance" ] }, "thirdPartyRefusalReason" : { "type" : "string", "description" : "Raw refusal reason received from the third party, where available" } } }, "StoredValueIssueRequest" : { "type" : "object", "additionalProperties" : false, "properties" : { "amount" : { "$ref" : "#/components/schemas/Amount", "description" : "The amount information for the transaction." }, "merchantAccount" : { "type" : "string", "description" : "The merchant account identifier, with which you want to process the transaction." }, "paymentMethod" : { "type" : "object", "additionalProperties" : { "type" : "string" }, "description" : "The collection that contains the type of the payment method and its specific information if available" }, "recurringDetailReference" : { "type" : "string" }, "reference" : { "type" : "string", "description" : "The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.\nIf you need to provide multiple references for a transaction, separate them with hyphens (\"-\").\nMaximum length: 80 characters." }, "shopperInteraction" : { "type" : "string", "description" : "Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.\nFor the web service API, Adyen assumes Ecommerce shopper interaction by default.\n\nThis field has the following possible values:\n* `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request.\n* `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment).\n* `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone.\n* `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.", "enum" : [ "Ecommerce", "ContAuth", "Moto", "POS" ] }, "shopperReference" : { "type" : "string" }, "store" : { "type" : "string", "description" : "The physical store, for which this payment is processed.", "maxLength" : 16, "minLength" : 1 } }, "required" : [ "merchantAccount", "paymentMethod", "reference" ] }, "StoredValueIssueResponse" : { "type" : "object", "additionalProperties" : false, "properties" : { "authCode" : { "type" : "string", "description" : "Authorisation code:\n* When the payment is authorised, this field holds the authorisation code for the payment.\n* When the payment is not authorised, this field is empty." }, "currentBalance" : { "$ref" : "#/components/schemas/Amount", "description" : "The balance currently on the payment method." }, "paymentMethod" : { "type" : "object", "additionalProperties" : { "type" : "string" }, "description" : "The collection that contains the type of the payment method and its specific information if available" }, "pspReference" : { "type" : "string", "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request." }, "refusalReason" : { "type" : "string", "description" : "If the transaction is refused or an error occurs, this field holds Adyen's mapped reason for the refusal or a description of the error.\n\nWhen a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values." }, "resultCode" : { "type" : "string", "description" : "The result of the payment. Possible values:\n\n* **Success** – The operation has been completed successfully. \n* **Refused** – The operation was refused. The reason is given in the `refusalReason` field. \n* **Error** – There was an error when the operation was processed. The reason is given in the `refusalReason` field. \n* **NotEnoughBalance** – The amount on the payment method is lower than the amount given in the request. Only applicable to balance checks. \n", "enum" : [ "Success", "Refused", "Error", "NotEnoughBalance" ] }, "thirdPartyRefusalReason" : { "type" : "string", "description" : "Raw refusal reason received from the third party, where available" } } }, "StoredValueLoadRequest" : { "type" : "object", "additionalProperties" : false, "properties" : { "amount" : { "$ref" : "#/components/schemas/Amount", "description" : "The amount information for the transaction." }, "loadType" : { "type" : "string", "description" : "The type of load you are trying to do, when absent we default to 'load'", "enum" : [ "merchandiseReturn", "load" ] }, "merchantAccount" : { "type" : "string", "description" : "The merchant account identifier, with which you want to process the transaction." }, "paymentMethod" : { "type" : "object", "additionalProperties" : { "type" : "string" }, "description" : "The collection that contains the type of the payment method and its specific information if available" }, "recurringDetailReference" : { "type" : "string" }, "reference" : { "type" : "string", "description" : "The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.\nIf you need to provide multiple references for a transaction, separate them with hyphens (\"-\").\nMaximum length: 80 characters." }, "shopperInteraction" : { "type" : "string", "description" : "Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.\nFor the web service API, Adyen assumes Ecommerce shopper interaction by default.\n\nThis field has the following possible values:\n* `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request.\n* `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment).\n* `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone.\n* `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.", "enum" : [ "Ecommerce", "ContAuth", "Moto", "POS" ] }, "shopperReference" : { "type" : "string" }, "store" : { "type" : "string", "description" : "The physical store, for which this payment is processed.", "maxLength" : 16, "minLength" : 1 } }, "required" : [ "amount", "merchantAccount", "paymentMethod", "reference" ] }, "StoredValueLoadResponse" : { "type" : "object", "additionalProperties" : false, "properties" : { "authCode" : { "type" : "string", "description" : "Authorisation code:\n* When the payment is authorised, this field holds the authorisation code for the payment.\n* When the payment is not authorised, this field is empty." }, "currentBalance" : { "$ref" : "#/components/schemas/Amount", "description" : "The balance currently on the payment method." }, "pspReference" : { "type" : "string", "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request." }, "refusalReason" : { "type" : "string", "description" : "If the transaction is refused or an error occurs, this field holds Adyen's mapped reason for the refusal or a description of the error.\n\nWhen a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values." }, "resultCode" : { "type" : "string", "description" : "The result of the payment. Possible values:\n\n* **Success** – The operation has been completed successfully. \n* **Refused** – The operation was refused. The reason is given in the `refusalReason` field. \n* **Error** – There was an error when the operation was processed. The reason is given in the `refusalReason` field. \n* **NotEnoughBalance** – The amount on the payment method is lower than the amount given in the request. Only applicable to balance checks. \n", "enum" : [ "Success", "Refused", "Error", "NotEnoughBalance" ] }, "thirdPartyRefusalReason" : { "type" : "string", "description" : "Raw refusal reason received from the third party, where available" } } }, "StoredValueStatusChangeRequest" : { "type" : "object", "additionalProperties" : false, "properties" : { "amount" : { "$ref" : "#/components/schemas/Amount", "description" : "The amount information for the transaction." }, "merchantAccount" : { "type" : "string", "description" : "The merchant account identifier, with which you want to process the transaction." }, "paymentMethod" : { "type" : "object", "additionalProperties" : { "type" : "string" }, "description" : "The collection that contains the type of the payment method and its specific information if available" }, "recurringDetailReference" : { "type" : "string" }, "reference" : { "type" : "string", "description" : "The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.\nIf you need to provide multiple references for a transaction, separate them with hyphens (\"-\").\nMaximum length: 80 characters." }, "shopperInteraction" : { "type" : "string", "description" : "Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.\nFor the web service API, Adyen assumes Ecommerce shopper interaction by default.\n\nThis field has the following possible values:\n* `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request.\n* `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment).\n* `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone.\n* `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.", "enum" : [ "Ecommerce", "ContAuth", "Moto", "POS" ] }, "shopperReference" : { "type" : "string" }, "status" : { "type" : "string", "description" : "The status you want to change to", "enum" : [ "active", "inactive" ] }, "store" : { "type" : "string", "description" : "The physical store, for which this payment is processed.", "maxLength" : 16, "minLength" : 1 } }, "required" : [ "merchantAccount", "paymentMethod", "reference", "status" ] }, "StoredValueStatusChangeResponse" : { "type" : "object", "additionalProperties" : false, "properties" : { "authCode" : { "type" : "string", "description" : "Authorisation code:\n* When the payment is authorised, this field holds the authorisation code for the payment.\n* When the payment is not authorised, this field is empty." }, "currentBalance" : { "$ref" : "#/components/schemas/Amount", "description" : "The balance currently on the payment method." }, "pspReference" : { "type" : "string", "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request." }, "refusalReason" : { "type" : "string", "description" : "If the transaction is refused or an error occurs, this field holds Adyen's mapped reason for the refusal or a description of the error.\n\nWhen a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values." }, "resultCode" : { "type" : "string", "description" : "The result of the payment. Possible values:\n\n* **Success** – The operation has been completed successfully. \n* **Refused** – The operation was refused. The reason is given in the `refusalReason` field. \n* **Error** – There was an error when the operation was processed. The reason is given in the `refusalReason` field. \n* **NotEnoughBalance** – The amount on the payment method is lower than the amount given in the request. Only applicable to balance checks. \n", "enum" : [ "Success", "Refused", "Error", "NotEnoughBalance" ] }, "thirdPartyRefusalReason" : { "type" : "string", "description" : "Raw refusal reason received from the third party, where available" } } }, "StoredValueVoidRequest" : { "type" : "object", "additionalProperties" : false, "properties" : { "merchantAccount" : { "type" : "string", "description" : "The merchant account identifier, with which you want to process the transaction." }, "originalReference" : { "type" : "string", "description" : "The original pspReference of the payment to modify." }, "reference" : { "type" : "string", "description" : "Your reference for the payment modification. This reference is visible in Customer Area and in reports.\nMaximum length: 80 characters." }, "store" : { "type" : "string", "description" : "The physical store, for which this payment is processed.", "maxLength" : 16, "minLength" : 1 }, "tenderReference" : { "type" : "string", "description" : "The reference of the tender." }, "uniqueTerminalId" : { "type" : "string", "description" : "The unique ID of a POS terminal." } }, "required" : [ "merchantAccount", "originalReference" ] }, "StoredValueVoidResponse" : { "type" : "object", "additionalProperties" : false, "properties" : { "currentBalance" : { "$ref" : "#/components/schemas/Amount", "description" : "The balance currently on the payment method." }, "pspReference" : { "type" : "string", "description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request." }, "refusalReason" : { "type" : "string", "description" : "If the transaction is refused or an error occurs, this field holds Adyen's mapped reason for the refusal or a description of the error.\n\nWhen a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values." }, "resultCode" : { "type" : "string", "description" : "The result of the payment. Possible values:\n\n* **Success** – The operation has been completed successfully. \n* **Refused** – The operation was refused. The reason is given in the `refusalReason` field. \n* **Error** – There was an error when the operation was processed. The reason is given in the `refusalReason` field. \n* **NotEnoughBalance** – The amount on the payment method is lower than the amount given in the request. Only applicable to balance checks. \n", "enum" : [ "Success", "Refused", "Error", "NotEnoughBalance" ] }, "thirdPartyRefusalReason" : { "type" : "string", "description" : "Raw refusal reason received from the third party, where available" } } } }, "examples" : { }, "securitySchemes" : { "ApiKeyAuth" : { "type" : "apiKey", "name" : "X-API-Key", "in" : "header" }, "BasicAuth" : { "type" : "http", "scheme" : "basic" } } } }