Adyen · Schema

StoredValueBalanceMergeResponse

PaymentsFinancial ServicesFintech

Properties

Name Type Description
authCode string Authorisation code: * When the payment is authorised, this field holds the authorisation code for the payment. * When the payment is not authorised, this field is empty.
currentBalance object The balance currently on the payment method.
pspReference string 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 string 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. When a transaction fails, the authorisation response includes `r
resultCode string The result of the payment. Possible values: * **Success** – The operation has been completed successfully. * **Refused** – The operation was refused. The reason is given in the `refusalReason` field.
thirdPartyRefusalReason string Raw refusal reason received from the third party, where available
View JSON Schema on GitHub

JSON Schema

adyen-storedvaluebalancemergeresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/StoredValueBalanceMergeResponse",
  "title": "StoredValueBalanceMergeResponse",
  "properties": {
    "authCode": {
      "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.",
      "type": "string"
    },
    "currentBalance": {
      "description": "The balance currently on the payment method.",
      "$ref": "#/components/schemas/Amount"
    },
    "pspReference": {
      "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.",
      "type": "string"
    },
    "refusalReason": {
      "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.",
      "type": "string"
    },
    "resultCode": {
      "description": "The result of the payment. Possible values:\n\n* **Success** \u2013 The operation has been completed successfully. \n* **Refused** \u2013 The operation was refused. The reason is given in the `refusalReason` field. \n* **Error** \u2013 There was an error when the operation was processed. The reason is given in the `refusalReason` field. \n* **NotEnoughBalance** \u2013 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"
      ],
      "type": "string"
    },
    "thirdPartyRefusalReason": {
      "description": "Raw refusal reason received from the third party, where available",
      "type": "string"
    }
  },
  "type": "object"
}