Adyen · JSON Structure

Checkout Upi Collect Details Structure

UpiCollectDetails schema from Adyen API

Type: object Properties: 7 Required: 2
PaymentsFinancial ServicesFintech

UpiCollectDetails is a JSON Structure definition published by Adyen, describing 7 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

billingSequenceNumber checkoutAttemptId recurringDetailReference shopperNotificationReference storedPaymentMethodId type virtualPaymentAddress

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/checkout-upi-collect-details-structure.json",
  "description": "UpiCollectDetails schema from Adyen API",
  "type": "object",
  "properties": {
    "billingSequenceNumber": {
      "description": "The sequence number for the debit. For example, send **2** if this is the second debit for the subscription. The sequence number is included in the notification sent to the shopper.",
      "type": "string"
    },
    "checkoutAttemptId": {
      "x-addedInVersion": "68",
      "description": "The checkout attempt identifier.",
      "type": "string"
    },
    "recurringDetailReference": {
      "deprecated": true,
      "x-deprecatedInVersion": "49",
      "x-deprecatedMessage": "Use `storedPaymentMethodId` instead.",
      "description": "This is the `recurringDetailReference` returned in the response when you created the token.",
      "type": "string"
    },
    "shopperNotificationReference": {
      "description": "The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used for recurring payment only.",
      "type": "string"
    },
    "storedPaymentMethodId": {
      "x-addedInVersion": "49",
      "description": "This is the `recurringDetailReference` returned in the response when you created the token.",
      "maxLength": 64,
      "type": "string"
    },
    "type": {
      "default": "upi_collect",
      "description": "**upi_collect**",
      "enum": [
        "upi_collect"
      ],
      "type": "string"
    },
    "virtualPaymentAddress": {
      "description": "The virtual payment address for UPI.",
      "type": "string"
    }
  },
  "required": [
    "type",
    "billingSequenceNumber"
  ],
  "additionalProperties": false,
  "name": "UpiCollectDetails"
}