{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/PaymentResult",
"title": "PaymentResult",
"properties": {
"additionalData": {
"additionalProperties": {
"type": "string"
},
"x-anyOf": [
{
"$ref": "#/components/schemas/ResponseAdditionalData3DSecure"
},
{
"$ref": "#/components/schemas/ResponseAdditionalDataBillingAddress"
},
{
"$ref": "#/components/schemas/ResponseAdditionalDataCard"
},
{
"$ref": "#/components/schemas/ResponseAdditionalDataCommon"
},
{
"$ref": "#/components/schemas/ResponseAdditionalDataDomesticError"
},
{
"$ref": "#/components/schemas/ResponseAdditionalDataInstallments"
},
{
"$ref": "#/components/schemas/ResponseAdditionalDataNetworkTokens"
},
{
"$ref": "#/components/schemas/ResponseAdditionalDataOpi"
},
{
"$ref": "#/components/schemas/ResponseAdditionalDataSepa"
}
],
"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**.",
"type": "object"
},
"authCode": {
"description": "Authorisation code:\n* When the payment is authorised successfully, this field holds the authorisation code for the payment.\n* When the payment is not authorised, this field is empty.",
"type": "string"
},
"dccAmount": {
"description": "Includes the currency of the conversion and the value of the transaction.\n> This value only applies if you have implemented Dynamic Currency Conversion. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).",
"$ref": "#/components/schemas/Amount"
},
"dccSignature": {
"description": "Cryptographic signature used to verify `dccQuote`.\n> This value only applies if you have implemented Dynamic Currency Conversion. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).",
"type": "string"
},
"fraudResult": {
"description": "The fraud result properties of the payment.",
"$ref": "#/components/schemas/FraudResult"
},
"issuerUrl": {
"description": "The URL to direct the shopper to.\n> In case of SecurePlus, do not redirect a shopper to this URL.",
"type": "string"
},
"md": {
"description": "The payment session.",
"maxLength": 20000,
"type": "string"
},
"paRequest": {
"description": "The 3D request data for the issuer.\n\nIf the value is **CUPSecurePlus-CollectSMSVerificationCode**, collect an SMS code from the shopper and pass it in the `/authorise3D` request. For more information, see [3D Secure](https://docs.adyen.com/classic-integration/3d-secure).",
"type": "string"
},
"pspReference": {
"description": "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.",
"type": "string"
},
"refusalReason": {
"description": "If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values.\n\nFor more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).",
"type": "string"
},
"resultCode": {
"description": "The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired** \u2013 The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n* **Authorised** \u2013 The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.\n* **Cancelled** \u2013 Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.\n* **ChallengeShopper** \u2013 The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error** \u2013 There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state.\n* **IdentifyShopper** \u2013 The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **PartiallyAuthorised** \u2013 The payment has been authorised for a partial amount.\nThis happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds.\n* **Pending** \u2013 Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.\n* **PresentToShopper** \u2013 Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.\n* **Received** \u2013 Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.\n* **RedirectShopper** \u2013 Indicates the shopper should be redirected to an external web page or app to complete the authorisation.\n* **Refused** \u2013 Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.",
"enum": [
"AuthenticationFinished",
"AuthenticationNotRequired",
"Authorised",
"Cancelled",
"ChallengeShopper",
"Error",
"IdentifyShopper",
"PartiallyAuthorised",
"Pending",
"PresentToShopper",
"Received",
"RedirectShopper",
"Refused",
"Success"
],
"type": "string"
}
},
"type": "object"
}