---
title: Create a payment
slug: payment/PC8_-create-a-payment
createdAt: 2025-08-28T10:39:39.817Z
---

:::ApiMethodV2
```json
{
  "name": "/consent/{consentId}/payments",
  "method": "POST",
  "url": "https://api-sandbox.klavi.ai/payment/customer/v1/smart/consents/{consentId}/payments",
  "description": "Create a payment",
  "tab": "examples",
  "examples": {
    "languages": [
      {
        "id": "A6FRIJTuZJNpmlp_0UbNr",
        "language": "curl",
        "code": "curl --location --globoff 'https://api-sandbox.klavi.ai/payment/customer/v1/smart/consents/{consentId}/payments' \\\n--header 'Accept: application/json' \\\n--header 'Content-Type: application/json' \\\n--data '{\"clientRequestId\":\"string\",\"amount\":0,\"creditorAccount\":{\"holder\":{}}}'",
        "customLabel": ""
      },
      {
        "id": "mLKXxNCtwlXBvwbjzf0Az",
        "language": "nodejs",
        "code": "var request = require('request');\nvar options = {\n   'method': 'POST',\n   'url': 'https://api-sandbox.klavi.ai/payment/customer/v1/automatic/consents/{consentId}/payments',\n   'headers': {\n      'Accept': 'application/json',\n      'Content-Type': 'application/json'\n   },\n   body: JSON.stringify({\n      \"clientRequestId\": \"string\",\n      \"date\": \"string\",\n      \"amount\": 0,\n      \"creditorAccount\": {\n         \"holder\": {}\n      }\n   })\n\n};\nrequest(options, function (error, response) {\n   if (error) throw new Error(error);\n   console.log(response.body);\n});\n",
        "customLabel": ""
      },
      {
        "id": "Ykq9Nmexe3bC_Ny_MFk07",
        "language": "javascript",
        "code": "var myHeaders = new Headers();\nmyHeaders.append(\"Accept\", \"application/json\");\nmyHeaders.append(\"Content-Type\", \"application/json\");\n\nvar raw = JSON.stringify({\n   \"clientRequestId\": \"string\",\n   \"date\": \"string\",\n   \"amount\": 0,\n   \"creditorAccount\": {\n      \"holder\": {}\n   }\n});\n\nvar requestOptions = {\n   method: 'POST',\n   headers: myHeaders,\n   body: raw,\n   redirect: 'follow'\n};\n\nfetch(\"https://api-sandbox.klavi.ai/payment/customer/v1/automatic/consents/{consentId}/payments\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));",
        "customLabel": ""
      },
      {
        "id": "D1YuPtXxe5P-aFnBAak3f",
        "language": "python",
        "code": "import requests\nimport json\n\nurl = \"https://api-sandbox.klavi.ai/payment/customer/v1/automatic/consents/{consentId}/payments\"\n\npayload = json.dumps({\n   \"clientRequestId\": \"string\",\n   \"date\": \"string\",\n   \"amount\": 0,\n   \"creditorAccount\": {\n      \"holder\": {}\n   }\n})\nheaders = {\n   'Accept': 'application/json',\n   'Content-Type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n",
        "customLabel": ""
      },
      {
        "id": "GgORjH99Nm2BCvdWFUuTw",
        "language": "ruby",
        "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api-sandbox.klavi.ai/payment/customer/v1/automatic/consents/{consentId}/payments\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"Accept\"] = \"application/json\"\nrequest[\"Content-Type\"] = \"application/json\"\nrequest.body = JSON.dump({\n   \"clientRequestId\": \"string\",\n   \"date\": \"string\",\n   \"amount\": 0,\n   \"creditorAccount\": {\n      \"holder\": {}\n   }\n})\n\nresponse = https.request(request)\nputs response.read_body\n",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "A6FRIJTuZJNpmlp_0UbNr"
  },
  "results": {
    "languages": [
      {
        "id": "4jcLbZenxcR9vzbLnE352",
        "language": "201",
        "code": "{\n    \"id\": \"fcb72e3a-b346-4f71-b044-971dc23232c9\", \n    \"clientRequestId\": \"fcb72e3a-b346-4f71-b044-dsndsnmnkdsmk\", \n    \"amount\": \"1333.04\", \n    \"currency\": \"BRL\", \n    \"status\": \"PAYMENT_PENDING\", \n    \"statusReason\": {\n        \"code\": \"NAO_INFORMADO\", \n        \"message\": \"Erro não informado na iniciadora ou detentora de conta.\" \n    } \n}",
        "customLabel": ""
      }
    ],
    "selectedLanguageId": "4jcLbZenxcR9vzbLnE352"
  },
  "request": {
    "pathParameters": [
      {
        "name": "consentId",
        "kind": "required",
        "type": "string",
        "description": "pattern: ^urn:[a-zA-Z0-9][a-zA-Z0-9\\-]{0,31}:[a-zA-Z0-9()+,\\-.:=@;$_!*'%\\/?#]+$\nmaxLength: 256\nConsent Id",
        "": "pattern: ^urn:[a-zA-Z0-9][a-zA-Z0-9\\-]{0,31}:[a-zA-Z0-9()+,\\-.:=@;$_!*'%\\/?#]+$\nmaxLength: 256\nConsent Id"
      }
    ],
    "queryParameters": [],
    "headerParameters": [
      {
        "name": "Authorization",
        "kind": "required",
        "type": "string",
        "description": "JWT bearer token",
        "": "JWT bearer token"
      }
    ],
    "bodyDataParameters": [
      {
        "name": "clientRequestId",
        "kind": "required",
        "type": "string",
        "description": "Your internal orderId. Only can be used for once. \nyou can use it to associate a payment and you can use UUID generation algorithm to generate it",
        "": "Your internal orderId. Only can be used for once. \nyou can use it to associate a payment and you can use UUID generation algorithm to generate it"
      },
      {
        "name": "amount",
        "kind": "required",
        "type": "string",
        "description": "minLength: 4\nmaxLength: 19\npattern: ^((\\d{1,16}\\.\\d{2}))$\nexample: 100000.12\nTransaction value with 2 decimal places",
        "": "minLength: 4\nmaxLength: 19\npattern: ^((\\d{1,16}\\.\\d{2}))$\nexample: 100000.12\nTransaction value with 2 decimal places"
      },
      {
        "name": "currency",
        "kind": "required",
        "type": "string",
        "description": "maxLength: 3\npattern: ^([A-Z]{3})$\nexample: BRL\nNational currency code according to ISO-4217, i.e., 'BRL'. All reported monetary values are represented with the current currency of Brazil",
        "": "maxLength: 3\npattern: ^([A-Z]{3})$\nexample: BRL\nNational currency code according to ISO-4217, i.e., 'BRL'. All reported monetary values are represented with the current currency of Brazil"
      },
      {
        "name": "creditorAccount",
        "kind": "optional",
        "type": "object",
        "description": "Object containing the data of the recipient (creditor).",
        "": "optional",
        "children": [
          {
            "name": "ispb",
            "kind": "required",
            "type": "string",
            "description": "minLength: 8\nmaxLength: 8\npattern: ^[0-9]{8}$\nexample: 12345678\nIt must be filled in with the ISPB (Brazilian Payment System Identifier) of the SPI participant (Instant Payment System) with numbers only."
          },
          {
            "name": "issuer",
            "kind": "optional",
            "type": "string",
            "description": "minLength: 1\nmaxLength: 4\npattern: ^[0-9]{1,4}$\nexample: 1774\nCode of the Agency issuing the account without digit.\n [Restriction] Mandatory for the following account types: CACC (CONTA_DEPOSITO_A_VISTA) and SVGS (CONTA_POUPANCA)."
          },
          {
            "name": "number",
            "kind": "required",
            "type": "string",
            "description": "minLength: 1\nmaxLength: 20\npattern: ^[0-9]{1,20}$\nexample: 1234567890\nIt must be filled in with the paying user's transactional account number, with verification digit (if any),\nIf there is an alphanumeric value, it should be converted to 0."
          },
          {
            "name": "accountType",
            "kind": "required",
            "type": "string",
            "description": "Types of accounts used for payment.\nexample: CACC\nEnum: [ CACC, SVGS, TRAN]\n    CACC - Current - Current Account\n    SVGS - Savings - Saving Account\n    TRAN - TransactingAccount - Prepaid Payment Account"
          },
          {
            "name": "holder",
            "kind": "optional",
            "type": "object",
            "description": "Holer object",
            "children": [
              {
                "name": "identifier",
                "kind": "optional",
                "type": "string",
                "description": "The number of the user identification document\nIf identifierType value is CPF:\nmaxLength: 11\nexample: 11111111111\npattern: ^\\d{11}$\n\nIf identifierType value is CNPJ:\nmaxLength: 14\nexample: 11111111111111\npattern: ^[0-9A-Z]{12}[0-9]{2}$"
              },
              {
                "name": "name",
                "kind": "optional",
                "type": "string",
                "description": "Username"
              },
              {
                "name": "identifierType",
                "kind": "optional",
                "type": "string",
                "description": "Type of the user identification document: CNPJ or CPF\nIf value is CPF:\nmaxLength: 3\nexample: CPF\npattern: ^[A-Z]{3}$\n\nIf value is CNPJ\nmaxLength: 4\nexample: CNPJ\npattern: ^[A-Z]{4}$"
              }
            ]
          }
        ],
        "schema": [
          {
            "name": "ispb",
            "kind": "required",
            "type": "string",
            "description": "minLength: 8\nmaxLength: 8\npattern: ^[0-9]{8}$\nexample: 12345678\nIt must be filled in with the ISPB (Brazilian Payment System Identifier) of the SPI participant (Instant Payment System) with numbers only."
          },
          {
            "name": "issuer",
            "kind": "optional",
            "type": "string",
            "description": "minLength: 1\nmaxLength: 4\npattern: ^[0-9]{1,4}$\nexample: 1774\nCode of the Agency issuing the account without digit.\n [Restriction] Mandatory for the following account types: CACC (CONTA_DEPOSITO_A_VISTA) and SVGS (CONTA_POUPANCA)."
          },
          {
            "name": "number",
            "kind": "required",
            "type": "string",
            "description": "minLength: 1\nmaxLength: 20\npattern: ^[0-9]{1,20}$\nexample: 1234567890\nIt must be filled in with the paying user's transactional account number, with verification digit (if any),\nIf there is an alphanumeric value, it should be converted to 0."
          },
          {
            "name": "accountType",
            "kind": "required",
            "type": "string",
            "description": "Types of accounts used for payment.\nexample: CACC\nEnum: [ CACC, SVGS, TRAN]\n    CACC - Current - Current Account\n    SVGS - Savings - Saving Account\n    TRAN - TransactingAccount - Prepaid Payment Account"
          },
          {
            "name": "holder",
            "kind": "optional",
            "type": "object",
            "description": "Holer object",
            "children": [
              {
                "name": "identifier",
                "kind": "optional",
                "type": "string",
                "description": "The number of the user identification document\nIf identifierType value is CPF:\nmaxLength: 11\nexample: 11111111111\npattern: ^\\d{11}$\n\nIf identifierType value is CNPJ:\nmaxLength: 14\nexample: 11111111111111\npattern: ^[0-9A-Z]{12}[0-9]{2}$"
              },
              {
                "name": "name",
                "kind": "optional",
                "type": "string",
                "description": "Username"
              },
              {
                "name": "identifierType",
                "kind": "optional",
                "type": "string",
                "description": "Type of the user identification document: CNPJ or CPF\nIf value is CPF:\nmaxLength: 3\nexample: CPF\npattern: ^[A-Z]{3}$\n\nIf value is CNPJ\nmaxLength: 4\nexample: CNPJ\npattern: ^[A-Z]{4}$"
              }
            ]
          }
        ]
      },
      {
        "name": "remittanceInformation",
        "kind": "optional",
        "type": "string",
        "description": "maxLength: 140\npattern: [\\w\\W\\s]*\nexample: Pagamento da nota XPTO035-002.\nIt must be filled in whenever the paying user enters some additional information in a payment, to be sent to the recipient.",
        "": "maxLength: 140\npattern: [\\w\\W\\s]*\nexample: Pagamento da nota XPTO035-002.\nIt must be filled in whenever the paying user enters some additional information in a payment, to be sent to the recipient."
      },
      {
        "name": "ibgeTownCode",
        "kind": "optional",
        "type": "string",
        "description": "minLength: 7\nmaxLength: 7\npattern: ^\\d{7}$\nexample: 5300108\nThe ibgeTownCode field in the Pix array has the same behavior as the codMun field described in item 1.6.6 of the Pix manual. If the municipality information is not sent, the recipient's PSP will assume that there are no state and municipal holidays in the period in question;",
        "": "minLength: 7\nmaxLength: 7\npattern: ^\\d{7}$\nexample: 5300108\nThe ibgeTownCode field in the Pix array has the same behavior as the codMun field described in item 1.6.6 of the Pix manual. If the municipality information is not sent, the recipient's PSP will assume that there are no state and municipal holidays in the period in question;"
      },
      {
        "name": "externalInfo",
        "kind": "optional",
        "type": "object",
        "description": "Metadata, user customizable\n",
        "": "Metadata, user customizable\n",
        "children": [
          {
            "name": "key",
            "kind": "optional",
            "type": "string",
            "description": ""
          }
        ],
        "schema": [
          {
            "name": "key",
            "kind": "optional",
            "type": "string",
            "description": ""
          }
        ]
      },
      {
        "name": "initType",
        "kind": "required",
        "type": "string",
        "description": "Payment initiation type:\nPIX_INIC - Pre registration of payee's account\nPIX_MANU - The creditor object must be sent with all payee information.\n[Restriction] Currently supports only PIX_MANU.\n",
        "": "Payment initiation type:\nPIX_INIC - Pre registration of payee's account\nPIX_MANU - The creditor object must be sent with all payee information.\n[Restriction] Currently supports only PIX_MANU.\n"
      },
      {
        "name": "paymentMethodConfig",
        "kind": "required",
        "type": "object",
        "description": "Specific Configurations for Smart Pix method",
        "": "Specific Configurations for Smart Pix method",
        "children": [
          {
            "name": "riskSignals",
            "kind": "required",
            "type": "object",
            "description": "Risk signals for initiation of automatic payments",
            "children": [
              {
                "name": "manual",
                "kind": "optional",
                "type": "object",
                "description": "Represents the collection of risk signals with the presence of the user\n[Restriction] Mandatory to be sent when the transaction occurs in the presence of the user",
                "children": [
                  {
                    "name": "deviceId",
                    "kind": "required",
                    "type": "string",
                    "description": "Unique device ID generated by the platform. The system property that identifies the combination of logged-in user, application signature key and device is used."
                  },
                  {
                    "name": "osVersion",
                    "kind": "required",
                    "type": "string",
                    "description": "Operating system version. "
                  },
                  {
                    "name": "userTimeZoneOffset",
                    "kind": "required",
                    "type": "string",
                    "description": "Indicates the time zone setting of the user's device, with the UTC offset format: ±hh[:mm]. The specified format allows the omission of the part corresponding to the minutes, if the latter has a zero value. Thus, both values '-03:00' and '-03' are valid and represent the same time zone."
                  },
                  {
                    "name": "language",
                    "kind": "required",
                    "type": "string",
                    "description": "Indicates the language of the device in ISO 639-1 format."
                  },
                  {
                    "name": "screenDimensions",
                    "kind": "required",
                    "type": "object",
                    "description": "Dimensions that the application occupies on the device screen.",
                    "children": [
                      {
                        "name": "height",
                        "kind": "required",
                        "type": "integer",
                        "description": "Screen height, in pixels."
                      },
                      {
                        "name": "width",
                        "kind": "required",
                        "type": "integer",
                        "description": "Screen width, in pixels."
                      }
                    ]
                  },
                  {
                    "name": "isRootedDevice",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Indicates whether the device currently has root permission.\n[Restriction] Mandatory submission field when the user uses a native application for Android or iOS."
                  },
                  {
                    "name": "screenBrightness",
                    "kind": "optional",
                    "type": "number",
                    "description": "Indicates the brightness level of the device's screen.\n[Android] The value is integer, typically between 0 and 255, and the range of values may vary according to the mobile phone manufacturer. \n[iOS] The value is floating point between \"0.0\" and \"1.0\". \n[Restriction] Mandatory submission field when the user uses a native application for Android or iOS."
                  },
                  {
                    "name": "elapsedTimeSinceBoot",
                    "kind": "optional",
                    "type": "integer",
                    "description": "Indicates how long (in milliseconds) the device is on.\n[Restriction] Mandatory submission field when the user uses a native application for Android or iOS."
                  },
                  {
                    "name": "geolocation",
                    "kind": "optional",
                    "type": "object",
                    "description": "",
                    "children": [
                      {
                        "name": "latitude",
                        "kind": "optional",
                        "type": "number",
                        "description": "Client's latitudial coordinate"
                      },
                      {
                        "name": "longitude",
                        "kind": "optional",
                        "type": "number",
                        "description": "Longitudinal customer coordinate"
                      },
                      {
                        "name": "type",
                        "kind": "optional",
                        "type": "string",
                        "description": "Type of mechanism used in geolocation generation\nEnum: [ COARSE, FINE, INFERRED]"
                      }
                    ]
                  },
                  {
                    "name": "integrity",
                    "kind": "optional",
                    "type": "object",
                    "description": "Informs the integrity of the device and app.",
                    "children": [
                      {
                        "name": "appRecognitionVerdict",
                        "kind": "optional",
                        "type": "string",
                        "description": "Informs the integrity of the app."
                      },
                      {
                        "name": "deviceRecognitionVerdict",
                        "kind": "optional",
                        "type": "string",
                        "description": "Informs the integrity of the device."
                      }
                    ]
                  },
                  {
                    "name": "isCallInProgress",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Indicates active call at the time of link or payment.\n[Restriction] If the risk signal is available (customer allowed it to be collected), it must be sent."
                  },
                  {
                    "name": "isDevModeEnabled",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Indicates if the device is in developer mode."
                  },
                  {
                    "name": "isMockGPS",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Indicates whether the device is using a fake GPS. It must be sent whenever there is a geolocation field with type COARSE or FINE."
                  },
                  {
                    "name": "isEmulated",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Indicates whether the device is emulated or real."
                  },
                  {
                    "name": "isMonkeyRunner",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Indicates the use of MonkeyRunner."
                  },
                  {
                    "name": "isCharging",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Indicates whether the device's battery is being charged."
                  },
                  {
                    "name": "isUsbConnected",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Indicates whether the device is connected to another device via USB."
                  },
                  {
                    "name": "antennaInformation",
                    "kind": "optional",
                    "type": "string",
                    "description": "Indicates which antenna the device is connected to."
                  }
                ]
              },
              {
                "name": "automatic",
                "kind": "optional",
                "type": "object",
                "description": "Represents the collection of risk signals without the presence of the user\n[Restriction] Mandatory to be sent when the transaction does not occur in the presence of the user",
                "children": [
                  {
                    "name": "lastLoginDateTime",
                    "kind": "required",
                    "type": "string",
                    "description": "Pattern: ^(\\d{4})-(1[0-2]|0?[ 1-9])-(3[01]|[12][0-9]|0?[ 1-9])T(?:[01]\\d|2[0123]):(?:[012345]\\d):(?:[012345]\\d)Z$\nThe time that the payer logged into the third your application must be sent."
                  },
                  {
                    "name": "pixKeyRegistrationDateTime",
                    "kind": "optional",
                    "type": "string",
                    "description": "Pattern: ^(\\d{4})-(1[0-2]|0?[ 1-9])-(3[01]|[12][0-9]|0?[ 1-9])T(?:[01]\\d|2[0123]):(?:[012345]\\d):(?:[012345]\\d)Z$\nDate and time of registration of the receiver's Pix key in the Klavi.\n[Restriction] Mandatory field to be sent if the value of the initType field is equal to PIX_DICT or PIX_INIC.\n"
                  }
                ]
              }
            ]
          }
        ],
        "schema": [
          {
            "name": "riskSignals",
            "kind": "required",
            "type": "object",
            "description": "Risk signals for initiation of automatic payments",
            "children": [
              {
                "name": "manual",
                "kind": "optional",
                "type": "object",
                "description": "Represents the collection of risk signals with the presence of the user\n[Restriction] Mandatory to be sent when the transaction occurs in the presence of the user",
                "children": [
                  {
                    "name": "deviceId",
                    "kind": "required",
                    "type": "string",
                    "description": "Unique device ID generated by the platform. The system property that identifies the combination of logged-in user, application signature key and device is used."
                  },
                  {
                    "name": "osVersion",
                    "kind": "required",
                    "type": "string",
                    "description": "Operating system version. "
                  },
                  {
                    "name": "userTimeZoneOffset",
                    "kind": "required",
                    "type": "string",
                    "description": "Indicates the time zone setting of the user's device, with the UTC offset format: ±hh[:mm]. The specified format allows the omission of the part corresponding to the minutes, if the latter has a zero value. Thus, both values '-03:00' and '-03' are valid and represent the same time zone."
                  },
                  {
                    "name": "language",
                    "kind": "required",
                    "type": "string",
                    "description": "Indicates the language of the device in ISO 639-1 format."
                  },
                  {
                    "name": "screenDimensions",
                    "kind": "required",
                    "type": "object",
                    "description": "Dimensions that the application occupies on the device screen.",
                    "children": [
                      {
                        "name": "height",
                        "kind": "required",
                        "type": "integer",
                        "description": "Screen height, in pixels."
                      },
                      {
                        "name": "width",
                        "kind": "required",
                        "type": "integer",
                        "description": "Screen width, in pixels."
                      }
                    ]
                  },
                  {
                    "name": "isRootedDevice",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Indicates whether the device currently has root permission.\n[Restriction] Mandatory submission field when the user uses a native application for Android or iOS."
                  },
                  {
                    "name": "screenBrightness",
                    "kind": "optional",
                    "type": "number",
                    "description": "Indicates the brightness level of the device's screen.\n[Android] The value is integer, typically between 0 and 255, and the range of values may vary according to the mobile phone manufacturer. \n[iOS] The value is floating point between \"0.0\" and \"1.0\". \n[Restriction] Mandatory submission field when the user uses a native application for Android or iOS."
                  },
                  {
                    "name": "elapsedTimeSinceBoot",
                    "kind": "optional",
                    "type": "integer",
                    "description": "Indicates how long (in milliseconds) the device is on.\n[Restriction] Mandatory submission field when the user uses a native application for Android or iOS."
                  },
                  {
                    "name": "geolocation",
                    "kind": "optional",
                    "type": "object",
                    "description": "",
                    "children": [
                      {
                        "name": "latitude",
                        "kind": "optional",
                        "type": "number",
                        "description": "Client's latitudial coordinate"
                      },
                      {
                        "name": "longitude",
                        "kind": "optional",
                        "type": "number",
                        "description": "Longitudinal customer coordinate"
                      },
                      {
                        "name": "type",
                        "kind": "optional",
                        "type": "string",
                        "description": "Type of mechanism used in geolocation generation\nEnum: [ COARSE, FINE, INFERRED]"
                      }
                    ]
                  },
                  {
                    "name": "integrity",
                    "kind": "optional",
                    "type": "object",
                    "description": "Informs the integrity of the device and app.",
                    "children": [
                      {
                        "name": "appRecognitionVerdict",
                        "kind": "optional",
                        "type": "string",
                        "description": "Informs the integrity of the app."
                      },
                      {
                        "name": "deviceRecognitionVerdict",
                        "kind": "optional",
                        "type": "string",
                        "description": "Informs the integrity of the device."
                      }
                    ]
                  },
                  {
                    "name": "isCallInProgress",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Indicates active call at the time of link or payment.\n[Restriction] If the risk signal is available (customer allowed it to be collected), it must be sent."
                  },
                  {
                    "name": "isDevModeEnabled",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Indicates if the device is in developer mode."
                  },
                  {
                    "name": "isMockGPS",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Indicates whether the device is using a fake GPS. It must be sent whenever there is a geolocation field with type COARSE or FINE."
                  },
                  {
                    "name": "isEmulated",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Indicates whether the device is emulated or real."
                  },
                  {
                    "name": "isMonkeyRunner",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Indicates the use of MonkeyRunner."
                  },
                  {
                    "name": "isCharging",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Indicates whether the device's battery is being charged."
                  },
                  {
                    "name": "isUsbConnected",
                    "kind": "optional",
                    "type": "boolean",
                    "description": "Indicates whether the device is connected to another device via USB."
                  },
                  {
                    "name": "antennaInformation",
                    "kind": "optional",
                    "type": "string",
                    "description": "Indicates which antenna the device is connected to."
                  }
                ]
              },
              {
                "name": "automatic",
                "kind": "optional",
                "type": "object",
                "description": "Represents the collection of risk signals without the presence of the user\n[Restriction] Mandatory to be sent when the transaction does not occur in the presence of the user",
                "children": [
                  {
                    "name": "lastLoginDateTime",
                    "kind": "required",
                    "type": "string",
                    "description": "Pattern: ^(\\d{4})-(1[0-2]|0?[ 1-9])-(3[01]|[12][0-9]|0?[ 1-9])T(?:[01]\\d|2[0123]):(?:[012345]\\d):(?:[012345]\\d)Z$\nThe time that the payer logged into the third your application must be sent."
                  },
                  {
                    "name": "pixKeyRegistrationDateTime",
                    "kind": "optional",
                    "type": "string",
                    "description": "Pattern: ^(\\d{4})-(1[0-2]|0?[ 1-9])-(3[01]|[12][0-9]|0?[ 1-9])T(?:[01]\\d|2[0123]):(?:[012345]\\d):(?:[012345]\\d)Z$\nDate and time of registration of the receiver's Pix key in the Klavi.\n[Restriction] Mandatory field to be sent if the value of the initType field is equal to PIX_DICT or PIX_INIC.\n"
                  }
                ]
              }
            ]
          }
        ]
      }
    ],
    "formDataParameters": []
  },
  "currentNewParameter": {
    "label": "Body Parameter",
    "value": "bodyDataParameters"
  },
  "hasTryItOut": false,
  "response": [
    {
      "name": "id",
      "kind": "optional",
      "type": "string",
      "description": "pattern: ^urn:[a-zA-Z0-9][a-zA-Z0-9\\-]{0,31}:[a-zA-Z0-9()+,\\-.:=@;$_!*'%\\/?#]+$\nmaxLength: 256\nPayment Id"
    },
    {
      "name": "clientRequestId",
      "kind": "optional",
      "type": "string",
      "description": "Your internal orderId. Only can be used for once. \nyou can use it to associate a payment and you can use UUID generation algorithm to generate it",
      "children": []
    },
    {
      "name": "amount",
      "kind": "optional",
      "type": "number",
      "description": "minLength: 4\nmaxLength: 19\npattern: ^((\\d{1,16}\\.\\d{2}))$\nexample: 100000.12\nTransaction value with 2 decimal places",
      "children": []
    },
    {
      "name": "currency",
      "kind": "optional",
      "type": "string",
      "description": "maxLength: 3\npattern: ^([A-Z]{3})$\nexample: BRL\nNational currency code according to ISO-4217, i.e., 'BRL'. All reported monetary values are represented with the current currency of Brazil",
      "children": []
    },
    {
      "name": "status",
      "kind": "optional",
      "type": "string",
      "description": "example: PAYMENT_PENDING\nEnum:\n[PAYMENT_PENDING,PAYMENT_READY_FOR_SETTLEMENT,PAYMENT_SCHEDULED,PAYMENT_SETTLEMENT_PROCESSING, PAYMENT_COMPLETED,PAYMENT_REJECTED]",
      "children": []
    },
    {
      "name": "statusReason",
      "kind": "optional",
      "type": "object",
      "description": "Status reason object",
      "children": [
        {
          "name": "code",
          "kind": "optional",
          "type": "string",
          "description": "example: CONSENT_AWAITING_AUTHORIZATION\nEnum:\n[NOT_INFORMED,INFRASTRUCTURE_FAILURE,AUTHORIZATION_EXPIRED_TIME, USER_REJECTED, ORIGIN_DESTINATION_ACCOUNTS_EQUAL, ACCOUNT_DOES_NOT_ALLOW_PAYMENT, DIVERGENT_AUTHENTICATION, NOT_INFORMED, REVOKED_USER, REVOKED_MERCHANT ]"
        },
        {
          "name": "message",
          "kind": "optional",
          "type": "string",
          "description": "pattern: [wWs]*\nLength: 2048\nexample: User refused consent\nStatus message"
        }
      ]
    }
  ],
  "autoGeneratedAnchorSlug": "consentconsentidpayments",
  "legacyHash": "MSr8XPlxmF-GEYLbTvgOg"
}
```
:::





