SumUp · Schema

Mandate Payload

Mandate details used when a checkout should create a reusable card token for future recurring or merchant-initiated payments.

PaymentsPOSPoint of SaleCard ReadersCheckoutFintechMobile PaymentsOnline Payments

Properties

Name Type Description
type string Type of mandate to create for the saved payment instrument.
user_agent string Browser or client user agent observed when consent was collected.
user_ip string IP address of the payer when the mandate was accepted.
View JSON Schema on GitHub

JSON Schema

mandatepayload.json Raw ↑ 
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Mandate Payload",
  "description": "Mandate details used when a checkout should create a reusable card token for future recurring or merchant-initiated payments.",
  "type": "object",
  "properties": {
    "type": {
      "description": "Type of mandate to create for the saved payment instrument.",
      "type": "string",
      "example": "recurrent",
      "enum": [
        "recurrent"
      ]
    },
    "user_agent": {
      "description": "Browser or client user agent observed when consent was collected.",
      "type": "string",
      "example": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.104 Safari/537.36"
    },
    "user_ip": {
      "description": "IP address of the payer when the mandate was accepted.",
      "type": "string",
      "example": "172.217.169.174"
    }
  },
  "example": {
    "type": "recurrent",
    "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.104 Safari/537.36",
    "user_ip": "172.217.169.174"
  },
  "required": [
    "type",
    "user_agent"
  ]
}