--- title: Create a consent-links slug: payment/create-a-consent-links docTags: createdAt: 2025-08-28T09:24:26.579Z --- :::ApiMethodV2 ```json { "name": "/consent-links", "method": "POST", "url": "https://api-sandbox.klavi.ai/payment/customer/v1/automatic/consent-links", "description": "Create a consent-links(For whitelabel)", "tab": "examples", "examples": { "languages": [ { "id": "3fRB-XxtlQB4wcNZwAxv5", "language": "curl", "code": "curl --location 'https://api-sandbox.klavi.ai/payment/customer/v1/automatic/consent-links' \\\n--header 'Accept: application/json' \\\n--header 'Content-Type: application/json' \\\n--data '{\"accessKey\":\"string\",\"secretKey\":\"string\",\"consent\":{\"customer\":{},\"debtorAccount\":{},\"creditorAccount\":{\"holder\":{}},\"paymentMethodConfig\":{\"contractDebtor\":{},\"firstPayment\":{}},\"externalInfo\":{}}}'", "customLabel": "" }, { "id": "OwSOmhgTPU4v6M0JdvobW", "language": "nodejs", "code": "var request = require('request');\nvar options = {\n 'method': 'POST',\n 'url': 'https://api-sandbox.klavi.ai/payment/customer/v1/automatic/consent-links',\n 'headers': {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({\n \"accessKey\": \"string\",\n \"secretKey\": \"string\",\n \"consent\": {\n \"customer\": {},\n \"debtorAccount\": {},\n \"creditorAccount\": {\n \"holder\": {}\n },\n \"paymentMethodConfig\": {\n \"contractDebtor\": {},\n \"firstPayment\": {}\n },\n \"externalInfo\": {}\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": "nS6_NHkIGeTRyDH-jzerK", "language": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"Accept\", \"application/json\");\nmyHeaders.append(\"Content-Type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"accessKey\": \"string\",\n \"secretKey\": \"string\",\n \"consent\": {\n \"customer\": {},\n \"debtorAccount\": {},\n \"creditorAccount\": {\n \"holder\": {}\n },\n \"paymentMethodConfig\": {\n \"contractDebtor\": {},\n \"firstPayment\": {}\n },\n \"externalInfo\": {}\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/consent-links\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));", "customLabel": "" }, { "id": "z4wyf0DSlZLAyR1mxZbEL", "language": "python", "code": "import requests\nimport json\n\nurl = \"https://api-sandbox.klavi.ai/payment/customer/v1/automatic/consent-links\"\n\npayload = json.dumps({\n \"accessKey\": \"string\",\n \"secretKey\": \"string\",\n \"consent\": {\n \"customer\": {},\n \"debtorAccount\": {},\n \"creditorAccount\": {\n \"holder\": {}\n },\n \"paymentMethodConfig\": {\n \"contractDebtor\": {},\n \"firstPayment\": {}\n },\n \"externalInfo\": {}\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": "h-uEs-lQJcrNR_N8KfSse", "language": "ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api-sandbox.klavi.ai/payment/customer/v1/automatic/consent-links\")\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 \"accessKey\": \"string\",\n \"secretKey\": \"string\",\n \"consent\": {\n \"customer\": {},\n \"debtorAccount\": {},\n \"creditorAccount\": {\n \"holder\": {}\n },\n \"paymentMethodConfig\": {\n \"contractDebtor\": {},\n \"firstPayment\": {}\n },\n \"externalInfo\": {}\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n", "customLabel": "" } ], "selectedLanguageId": "3fRB-XxtlQB4wcNZwAxv5" }, "results": { "languages": [ { "id": "KPUOEyTms-pe5J7kFkSlQ", "language": "201", "code": "{\n \"id\": \"cfa45795-fe16-48e2-a372-130e30a72606\", \n \"consentURL\": \"https://link.example.com?v=dmskdclckkclxkcox&c=xxxxyyyyzzz\" \n}", "customLabel": "" } ], "selectedLanguageId": "KPUOEyTms-pe5J7kFkSlQ" }, "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [], "bodyDataParameters": [ { "name": "accessKey", "kind": "required", "type": "string", "description": "Pre-generated by Klavi for partner", "": "Pre-generated by Klavi for partner" }, { "name": "secretKey", "kind": "required", "type": "string", "description": "Pre-generated by Klavi for partner", "": "Pre-generated by Klavi for partner" }, { "name": "consent", "kind": "required", "type": "object", "description": "Consent object", "": "Consent object", "children": [ { "name": "clientRequestId", "kind": "required", "type": "string", "description": "Your internal orderId. Only can be used for once" }, { "name": "institutionId", "kind": "optional", "type": "string", "description": "Id from the bank chosen by the user" }, { "name": "customer", "kind": "optional", "type": "object", "description": "", "children": [ { "name": "identifierType", "kind": "required", "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": "identifier", "kind": "required", "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": "required", "type": "string", "description": "Username" }, { "name": "phone", "kind": "optional", "type": "string", "description": "User's phone number" }, { "name": "email", "kind": "optional", "type": "string", "description": "User's email" } ] }, { "name": "loggedUserCpf", "kind": "optional", "type": "string", "description": "User (natural person) who is logged in to the Payment Initiator institution.\nrequired if customer.identifierType = CNPJ" }, { "name": "redirectURL", "kind": "optional", "type": "string", "description": "Return rediect url after user checkout in Klavi env" }, { "name": "additionalInformation", "kind": "optional", "type": "string", "description": "Must be filled in whenever the paying user enters some additional information in the consent\nexample: Minha recorrência\npattern: [\\w\\W\\s]*\nmaxLength: 140" }, { "name": "debtorAccount", "kind": "optional", "type": "object", "description": "Payer's origin account information", "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": "creditorAccount", "kind": "optional", "type": "object", "description": "Object containing the data of the recipient (creditor).", "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": "Holder object", "children": [ { "name": "identifier", "kind": "required", "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": "required", "type": "string", "description": "Username" }, { "name": "identifierType", "kind": "required", "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": "paymentMethodConfig", "kind": "required", "type": "object", "description": "Field intended for the configuration of the different recurring payment products.", "children": [ { "name": "contractId", "kind": "required", "type": "string", "description": "pattern: ^[a-zA-Z0-9]{1,35}$\nminLength: 1\nmaxLength: 35\nexample: XE00038166201907261559y6j6\nTransaction contract identifier" }, { "name": "fixedAmount", "kind": "optional", "type": "number", "description": "pattern: ^((\\d{1,16}\\.\\d{2}))$\nminLength: 4\nmaxLength: 19\nexample: 100000.12\nFixed charge amount, if filled in, represents a consent for payments of fixed amounts, or not subject to change during the validity of the consent." }, { "name": "minimumVariableAmount", "kind": "optional", "type": "number", "description": "pattern: ^((\\d{1,16}\\.\\d{2}))$\nminLength: 4\nmaxLength: 19\nexample: 1000000.12\nValue defined by the receiving user. If the paying user assigns a maximum amount for payments of that authorization (field “maximumVariableAmount”), it cannot be lower than the floor set by the receiving user." }, { "name": "maximumVariableAmount", "kind": "optional", "type": "number", "description": "pattern: ^((\\d{1,16}\\.\\d{2}))$\nminLength: 4\nmaxLength: 19\nexample: 1000000.12\nMaximum allowed value per charge, if filled in, represents consent to payments of variable amounts." }, { "name": "currency", "kind": "required", "type": "string", "description": "maxLength: 3\npattern: ^([A-Z]{3})$\nexample: BRL" }, { "name": "interval", "kind": "required", "type": "string", "description": "example: MONTHLY\nEnum: [ WEEKLY,MONTHLY,YEARLY,SEMIANNUAL,QUARTERLY ]\nDefines the allowed periodicity for transaction execution" }, { "name": "referenceStartDate", "kind": "required", "type": "string", "description": "pattern: ^(\\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$\nexample: 2023-05-21\nRepresents the expected date for the start of the collection cycle for payments associated with recurrence. It is a string with date according to RFC-3339 specification, following Brasília time (UTC-3). The initial bulk payment, declared in the firstPayment object of the consent, is not subject to this date." }, { "name": "contractDebtor", "kind": "required", "type": "object", "description": "Information about the customer who owes the contract.", "children": [ { "name": "identifierType", "kind": "required", "type": "string", "description": "Enum: [ CPF, CNPJ ]\nType of the user identification document: CNPJ or CPF" }, { "name": "identifier", "kind": "required", "type": "string", "description": "maxLength: 14\nexample: 11111111111111\npattern: ^([0-9]{11})$|^([0-9A-Z]{12}[0-9]{2})$\nThe number of the user identification document" }, { "name": "name", "kind": "required", "type": "string", "description": "pattern: ^([A-Za-zÀ-ÖØ-öø-ÿ,.@:&*+_<>()!?/\\\\$%\\d' -]+)$\nmaxLength: 120\nexample: Policarpo Quaresma" } ] }, { "name": "isRetryAccepted", "kind": "required", "type": "boolean", "description": "example: false\nIndicates whether the receiving customer is allowed to make payment attempts (extradition), according to the rules set out in the Pix arrangement." }, { "name": "firstPayment", "kind": "optional", "type": "object", "description": "Definitions for the first payment. It is considered as the payment of membership to the service by the paying user.", "children": [ { "name": "remittanceInformation", "kind": "optional", "type": "string", "description": "maxLength: 140\npattern: [\\w\\W\\s]*\nexample: Pagamento da nota RSTO035-002\nIt must be filled in whenever the paying user enters some additional information in a payment, to be sent to the recipient." }, { "name": "date", "kind": "optional", "type": "string", "description": "maxLength: 10\npattern: ^(\\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$\nexample: 2021-01-01\nDefines the target date for payment settlement. The Brasília time zone should be used to create and streamline the data in this field." }, { "name": "amount", "kind": "required", "type": "string", "description": "minLength: 4\nmaxLength: 19\npattern: ^((\\d{1,16}\\.\\d{2}))$\nexample: 100000.12\nThe transaction 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." } ] } ] }, { "name": "externalInfo", "kind": "optional", "type": "object", "description": "Metadata, user customizable", "children": [ { "name": "appLink", "kind": "optional", "type": "string", "description": "Used to launch partner app, the format must follow the URL scheme" }, { "name": "appRedirectURLKey", "kind": "optional", "type": "string", "description": "Used to locate specific pages in the partner app\nRequired if appLink != nil" } ] }, { "name": "expirationDateTime", "kind": "optional", "type": "string", "description": "The date and time when the consent shall cease to be valid. A string with date and time as specified in RFC-3339, always using the UTC time format.\nexample: 2021-05-21T08:30:00Z\npattern: ^(\\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$\nmaxLength: 20" }, { "name": "linkOption", "kind": "optional", "type": "object", "description": "Used for customizing links", "children": [ { "name": "showLanding", "kind": "optional", "type": "boolean", "description": "Should the landing page be displayed" }, { "name": "skipResultPage", "kind": "optional", "type": "boolean", "description": "Should skip the result page. If true, the parameter redirectURL is required." } ] } ], "schema": [ { "name": "clientRequestId", "kind": "required", "type": "string", "description": "Your internal orderId. Only can be used for once" }, { "name": "institutionId", "kind": "optional", "type": "string", "description": "Id from the bank chosen by the user" }, { "name": "customer", "kind": "optional", "type": "object", "description": "", "children": [ { "name": "identifierType", "kind": "required", "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": "identifier", "kind": "required", "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": "required", "type": "string", "description": "Username" }, { "name": "phone", "kind": "optional", "type": "string", "description": "User's phone number" }, { "name": "email", "kind": "optional", "type": "string", "description": "User's email" } ] }, { "name": "loggedUserCpf", "kind": "optional", "type": "string", "description": "User (natural person) who is logged in to the Payment Initiator institution.\nrequired if customer.identifierType = CNPJ" }, { "name": "redirectURL", "kind": "optional", "type": "string", "description": "Return rediect url after user checkout in Klavi env" }, { "name": "additionalInformation", "kind": "optional", "type": "string", "description": "Must be filled in whenever the paying user enters some additional information in the consent\nexample: Minha recorrência\npattern: [\\w\\W\\s]*\nmaxLength: 140" }, { "name": "debtorAccount", "kind": "optional", "type": "object", "description": "Payer's origin account information", "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": "creditorAccount", "kind": "optional", "type": "object", "description": "Object containing the data of the recipient (creditor).", "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": "Holder object", "children": [ { "name": "identifier", "kind": "required", "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": "required", "type": "string", "description": "Username" }, { "name": "identifierType", "kind": "required", "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": "paymentMethodConfig", "kind": "required", "type": "object", "description": "Field intended for the configuration of the different recurring payment products.", "children": [ { "name": "contractId", "kind": "required", "type": "string", "description": "pattern: ^[a-zA-Z0-9]{1,35}$\nminLength: 1\nmaxLength: 35\nexample: XE00038166201907261559y6j6\nTransaction contract identifier" }, { "name": "fixedAmount", "kind": "optional", "type": "number", "description": "pattern: ^((\\d{1,16}\\.\\d{2}))$\nminLength: 4\nmaxLength: 19\nexample: 100000.12\nFixed charge amount, if filled in, represents a consent for payments of fixed amounts, or not subject to change during the validity of the consent." }, { "name": "minimumVariableAmount", "kind": "optional", "type": "number", "description": "pattern: ^((\\d{1,16}\\.\\d{2}))$\nminLength: 4\nmaxLength: 19\nexample: 1000000.12\nValue defined by the receiving user. If the paying user assigns a maximum amount for payments of that authorization (field “maximumVariableAmount”), it cannot be lower than the floor set by the receiving user." }, { "name": "maximumVariableAmount", "kind": "optional", "type": "number", "description": "pattern: ^((\\d{1,16}\\.\\d{2}))$\nminLength: 4\nmaxLength: 19\nexample: 1000000.12\nMaximum allowed value per charge, if filled in, represents consent to payments of variable amounts." }, { "name": "currency", "kind": "required", "type": "string", "description": "maxLength: 3\npattern: ^([A-Z]{3})$\nexample: BRL" }, { "name": "interval", "kind": "required", "type": "string", "description": "example: MONTHLY\nEnum: [ WEEKLY,MONTHLY,YEARLY,SEMIANNUAL,QUARTERLY ]\nDefines the allowed periodicity for transaction execution" }, { "name": "referenceStartDate", "kind": "required", "type": "string", "description": "pattern: ^(\\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$\nexample: 2023-05-21\nRepresents the expected date for the start of the collection cycle for payments associated with recurrence. It is a string with date according to RFC-3339 specification, following Brasília time (UTC-3). The initial bulk payment, declared in the firstPayment object of the consent, is not subject to this date." }, { "name": "contractDebtor", "kind": "required", "type": "object", "description": "Information about the customer who owes the contract.", "children": [ { "name": "identifierType", "kind": "required", "type": "string", "description": "Enum: [ CPF, CNPJ ]\nType of the user identification document: CNPJ or CPF" }, { "name": "identifier", "kind": "required", "type": "string", "description": "maxLength: 14\nexample: 11111111111111\npattern: ^([0-9]{11})$|^([0-9A-Z]{12}[0-9]{2})$\nThe number of the user identification document" }, { "name": "name", "kind": "required", "type": "string", "description": "pattern: ^([A-Za-zÀ-ÖØ-öø-ÿ,.@:&*+_<>()!?/\\\\$%\\d' -]+)$\nmaxLength: 120\nexample: Policarpo Quaresma" } ] }, { "name": "isRetryAccepted", "kind": "required", "type": "boolean", "description": "example: false\nIndicates whether the receiving customer is allowed to make payment attempts (extradition), according to the rules set out in the Pix arrangement." }, { "name": "firstPayment", "kind": "optional", "type": "object", "description": "Definitions for the first payment. It is considered as the payment of membership to the service by the paying user.", "children": [ { "name": "remittanceInformation", "kind": "optional", "type": "string", "description": "maxLength: 140\npattern: [\\w\\W\\s]*\nexample: Pagamento da nota RSTO035-002\nIt must be filled in whenever the paying user enters some additional information in a payment, to be sent to the recipient." }, { "name": "date", "kind": "optional", "type": "string", "description": "maxLength: 10\npattern: ^(\\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$\nexample: 2021-01-01\nDefines the target date for payment settlement. The Brasília time zone should be used to create and streamline the data in this field." }, { "name": "amount", "kind": "required", "type": "string", "description": "minLength: 4\nmaxLength: 19\npattern: ^((\\d{1,16}\\.\\d{2}))$\nexample: 100000.12\nThe transaction 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." } ] } ] }, { "name": "externalInfo", "kind": "optional", "type": "object", "description": "Metadata, user customizable", "children": [ { "name": "appLink", "kind": "optional", "type": "string", "description": "Used to launch partner app, the format must follow the URL scheme" }, { "name": "appRedirectURLKey", "kind": "optional", "type": "string", "description": "Used to locate specific pages in the partner app\nRequired if appLink != nil" } ] }, { "name": "expirationDateTime", "kind": "optional", "type": "string", "description": "The date and time when the consent shall cease to be valid. A string with date and time as specified in RFC-3339, always using the UTC time format.\nexample: 2021-05-21T08:30:00Z\npattern: ^(\\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$\nmaxLength: 20" }, { "name": "linkOption", "kind": "optional", "type": "object", "description": "Used for customizing links", "children": [ { "name": "showLanding", "kind": "optional", "type": "boolean", "description": "Should the landing page be displayed" }, { "name": "skipResultPage", "kind": "optional", "type": "boolean", "description": "Should skip the result page. If true, the parameter redirectURL is required." } ] } ] } ], "formDataParameters": [] }, "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "hasTryItOut": false, "response": [ { "name": "id", "kind": "optional", "type": "string", "description": "Consent link ID" }, { "name": "consentURL", "kind": "optional", "type": "string", "description": "Consent link URL", "children": [] } ], "autoGeneratedAnchorSlug": "consent-links", "legacyHash": "rCjngQUlFHOBhKM6YI_bS" } ``` :::