Adyen · Schema

UPI Collect

PaymentsFinancial ServicesFintech

Properties

Name Type Description
billingSequenceNumber string 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.
checkoutAttemptId string The checkout attempt identifier.
recurringDetailReference string This is the `recurringDetailReference` returned in the response when you created the token.
shopperNotificationReference string The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used for recurring payment only.
storedPaymentMethodId string This is the `recurringDetailReference` returned in the response when you created the token.
type string **upi_collect**
virtualPaymentAddress string The virtual payment address for UPI.
View JSON Schema on GitHub

JSON Schema

adyen-upicollectdetails-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpiCollectDetails",
  "title": "UPI Collect",
  "additionalProperties": false,
  "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"
  ],
  "type": "object"
}