--- title: Create a payment initiation slug: payment/create-a-payment-initiation description: Learn how to create a payment initiation using the Klavi payment API with this example Curl command. Includes endpoint, authorization requirements, request payload parameters, and details about the response. Keep an eye out for a possible response code 40 docTags: createdAt: 2023-05-18T20:27:00.000Z --- :::ApiMethodV2 ```json { "name": "payments", "method": "POST", "url": "https://api-sandbox.klavi.ai/payment/customer/v1/instant/payments", "description": "Create a payment initiation", "tab": "examples", "examples": { "languages": [ { "id": "YyGLj0BdYInraKp4CPGbq", "language": "curl", "code": "curl --location 'https://api-sandbox.klavi.ai/payment/customer/v1/instant/payments' \\\n--header 'Accept: application/json' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"clientRequestId\": \"String\",\n \"institutionId\": \"String\",\n \"initType\": \"String\",\n \"customer\": {\n \"identifierType\": \"String\",\n \"identifier\": \"String\",\n \"name\": \"String\",\n \"phone\": \"String\",\n \"email\": \"String\"\n },\n \"amount\": \"String\",\n \"currency\": \"String\",\n \"redirectURL\": \"String\",\n \"debtorAccount\": {\n \"ispb\": \"String\",\n \"issuer\": \"String\",\n \"number\": \"String\",\n \"accountType\": \"String\"\n },\n \"creditorAccount\": {\n \"ispb\": \"String\",\n \"issuer\": \"String\",\n \"number\": \"String\",\n \"accountType\": \"String\",\n \"holder\": {\n \"identifierType\": \"String\",\n \"identifier\": \"String\",\n \"name\": \"String\"\n }\n },\n \"clientMetadata\": {\n \"platform\": \"String\",\n \"os\": \"String\",\n \"osVersion\": \"String\"\n }\n}'", "customLabel": "" }, { "id": "kV7kCRUzWdDGfdAuYw8w9", "language": "nodejs", "code": "var request = require('request');\nvar options = {\n 'method': 'POST',\n 'url': 'https://api-sandbox.klavi.ai/payment/customer/v1/instant/payments',\n 'headers': {\n 'Accept': 'application/json',\n 'Content-Type': 'application/json'\n },\n body: JSON.stringify({\n \"clientRequestId\": \"String\",\n \"institutionId\": \"String\",\n \"initType\": \"String\",\n \"customer\": {\n \"identifierType\": \"String\",\n \"identifier\": \"String\",\n \"name\": \"String\",\n \"phone\": \"String\",\n \"email\": \"String\"\n },\n \"amount\": \"String\",\n \"currency\": \"String\",\n \"redirectURL\": \"String\",\n \"debtorAccount\": {\n \"ispb\": \"String\",\n \"issuer\": \"String\",\n \"number\": \"String\",\n \"accountType\": \"String\"\n },\n \"creditorAccount\": {\n \"ispb\": \"String\",\n \"issuer\": \"String\",\n \"number\": \"String\",\n \"accountType\": \"String\",\n \"holder\": {\n \"identifierType\": \"String\",\n \"identifier\": \"String\",\n \"name\": \"String\"\n }\n },\n \"clientMetadata\": {\n \"platform\": \"String\",\n \"os\": \"String\",\n \"osVersion\": \"String\"\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": "Gv1wTWuveEbM-miAYUEx0", "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 \"institutionId\": \"String\",\n \"initType\": \"String\",\n \"customer\": {\n \"identifierType\": \"String\",\n \"identifier\": \"String\",\n \"name\": \"String\",\n \"phone\": \"String\",\n \"email\": \"String\"\n },\n \"amount\": \"String\",\n \"currency\": \"String\",\n \"redirectURL\": \"String\",\n \"debtorAccount\": {\n \"ispb\": \"String\",\n \"issuer\": \"String\",\n \"number\": \"String\",\n \"accountType\": \"String\"\n },\n \"creditorAccount\": {\n \"ispb\": \"String\",\n \"issuer\": \"String\",\n \"number\": \"String\",\n \"accountType\": \"String\",\n \"holder\": {\n \"identifierType\": \"String\",\n \"identifier\": \"String\",\n \"name\": \"String\"\n }\n },\n \"clientMetadata\": {\n \"platform\": \"String\",\n \"os\": \"String\",\n \"osVersion\": \"String\"\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/instant/payments\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));", "customLabel": "" }, { "id": "E8qzaIYc3B6-F_IeHp_m_", "language": "python", "code": "import requests\nimport json\n\nurl = \"https://api-sandbox.klavi.ai/payment/customer/v1/instant/payments\"\n\npayload = json.dumps({\n \"clientRequestId\": \"String\",\n \"institutionId\": \"String\",\n \"initType\": \"String\",\n \"customer\": {\n \"identifierType\": \"String\",\n \"identifier\": \"String\",\n \"name\": \"String\",\n \"phone\": \"String\",\n \"email\": \"String\"\n },\n \"amount\": \"String\",\n \"currency\": \"String\",\n \"redirectURL\": \"String\",\n \"debtorAccount\": {\n \"ispb\": \"String\",\n \"issuer\": \"String\",\n \"number\": \"String\",\n \"accountType\": \"String\"\n },\n \"creditorAccount\": {\n \"ispb\": \"String\",\n \"issuer\": \"String\",\n \"number\": \"String\",\n \"accountType\": \"String\",\n \"holder\": {\n \"identifierType\": \"String\",\n \"identifier\": \"String\",\n \"name\": \"String\"\n }\n },\n \"clientMetadata\": {\n \"platform\": \"String\",\n \"os\": \"String\",\n \"osVersion\": \"String\"\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": "iWqj3mx_iQL_g6Sxe8nzS", "language": "ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api-sandbox.klavi.ai/payment/customer/v1/instant/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 \"institutionId\": \"String\",\n \"initType\": \"String\",\n \"customer\": {\n \"identifierType\": \"String\",\n \"identifier\": \"String\",\n \"name\": \"String\",\n \"phone\": \"String\",\n \"email\": \"String\"\n },\n \"amount\": \"String\",\n \"currency\": \"String\",\n \"redirectURL\": \"String\",\n \"debtorAccount\": {\n \"ispb\": \"String\",\n \"issuer\": \"String\",\n \"number\": \"String\",\n \"accountType\": \"String\"\n },\n \"creditorAccount\": {\n \"ispb\": \"String\",\n \"issuer\": \"String\",\n \"number\": \"String\",\n \"accountType\": \"String\",\n \"holder\": {\n \"identifierType\": \"String\",\n \"identifier\": \"String\",\n \"name\": \"String\"\n }\n },\n \"clientMetadata\": {\n \"platform\": \"String\",\n \"os\": \"String\",\n \"osVersion\": \"String\"\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n", "customLabel": "" } ], "selectedLanguageId": "YyGLj0BdYInraKp4CPGbq" }, "results": { "languages": [ { "id": "bp2s0qrgoz5gy3JinE6cL", "language": "200", "code": "{\n \"id\": \"fcb72e3a-b346-4f71-b044-971dc23232c9\",\n \"clientRequestId\": \"fcb72e3a-b346-4f71-b044-dsndsnmnkdsmk\",\n \"amount\": \"1333.04\", \n \"currency\": \"BRL\", \n \"status\": \"CONSENT_AWAITING_AUTHORIZATION\",\n \"statusReason\": {\n \"code\": \"NAO_INFORMADO\", \n \"message\": \"Erro não informado na iniciadora ou detentora de conta.\" \n }, \n \"consentRedirectURL\": \"https://server.example.com/cb\"\n}", "customLabel": "" } ], "selectedLanguageId": "bp2s0qrgoz5gy3JinE6cL" }, "request": { "pathParameters": [], "queryParameters": [], "headerParameters": [ { "name": "Authorization", "kind": "required", "type": "string", "description": "JWT bearer token", "children": [] } ], "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", "": "clientRequestId" }, { "name": "institutionId", "kind": "required", "type": "string", "description": "Id from the bank chosen by the user", "": "institutionId" }, { "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.\nPIX_DICT - The pixKey field represents creditor information.\nPIX_QRCODE - The qrCode field represents creditor information.", "": "Payment initiation type:\nPIX_INIC - Pre registration of payee's account\nPIX_MANU - The creditor object must be sent with all payee information.\nPIX_DICT - The pixKey field represents creditor information.\nPIX_QRCODE - The qrCode field represents creditor information." }, { "name": "customer", "kind": "required", "type": "Object", "description": "User (natural person) who is logged in to the payment initiator institution", "": "User (natural person) who is logged in to the payment initiator institution", "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": "optional", "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" } ], "schema": [ { "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": "optional", "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.\nmaxLength: 11\nexample: 11111111111\npattern: ^\\d{11}$\n[Restriction] Required if customer.identifierType is CNPJ", "": "User (natural person) who is logged in to the Payment Initiator institution.\nmaxLength: 11\nexample: 11111111111\npattern: ^\\d{11}$\n[Restriction] Required if customer.identifierType is CNPJ" }, { "name": "ibgeTownCode", "kind": "optional", "type": "string", "description": "ibge town code\nminLength: 7\nmaxLength: 7\npattern: ^\\d{7}$\nexample: 5300108", "": "ibgeTownCode" }, { "name": "proxy", "kind": "optional", "type": "string", "description": "Pix key\nmaxLength: 77\npattern: [\\w\\W\\s]*\nexample: 12345678901\nThe types of keys can be: phone, e-mail, CPF/CNPJ or random key.\nIn the case of a mobile phone, it must be informed in the E.1641 standard. \nIn the case of e-mail, it must have the format xxxxxxxx@xxxxxxx.xxx(.xx) and a maximum of 77 characters. \nIn the case of CPF, it must be informed with 11 numbers, without dots or dashes. In the case of CNPJ, it must be informed with 14 numbers, without dots or dashes. \n[Restriction] If initType is PIX_MANU, the proxy field should not be filled in. If initType is PIX_INIC, PIX_DICT, PIX_QRCODE, the proxy field should always be filled with the Pix key.", "": "Pix key\nmaxLength: 77\npattern: [\\w\\W\\s]*\nexample: 12345678901\nThe types of keys can be: phone, e-mail, CPF/CNPJ or random key.\nIn the case of a mobile phone, it must be informed in the E.1641 standard. \nIn the case of e-mail, it must have the format xxxxxxxx@xxxxxxx.xxx(.xx) and a maximum of 77 characters. \nIn the case of CPF, it must be informed with 11 numbers, without dots or dashes. In the case of CNPJ, it must be informed with 14 numbers, without dots or dashes. \n[Restriction] If initType is PIX_MANU, the proxy field should not be filled in. If initType is PIX_INIC, PIX_DICT, PIX_QRCODE, the proxy field should always be filled with the Pix key." }, { "name": "qrCode", "kind": "optional", "type": "string", "description": "QR code\nmaxLength: 512\npattern: [\\w\\W\\s]*\nexample: 00020104141234567890123426660014BR.GOV.BCB.PIX014466756C616E6F32303139406578616D706C652E636F6D27300012 BR.COM.OUTRO011001234567895204000053039865406123.455802BR5915NOMEDORECEBEDOR6008BRASILIA61087007490062 530515RP12345678-201950300017BR.GOV.BCB.BRCODE01051.0.080450014BR.GOV.BCB.PIX0123PADRAO.URL.PIX/0123AB CD81390012BR.COM.OUTRO01190123.ABCD.3456.WXYZ6304EB76\nThis field should be in UTF-8 format. \n[Restriction] Required for PIX_QRCODE payments, with a maximum size of 512 bytes.", "": "QR code\nmaxLength: 512\npattern: [\\w\\W\\s]*\nexample: 00020104141234567890123426660014BR.GOV.BCB.PIX014466756C616E6F32303139406578616D706C652E636F6D27300012 BR.COM.OUTRO011001234567895204000053039865406123.455802BR5915NOMEDORECEBEDOR6008BRASILIA61087007490062 530515RP12345678-201950300017BR.GOV.BCB.BRCODE01051.0.080450014BR.GOV.BCB.PIX0123PADRAO.URL.PIX/0123AB CD81390012BR.COM.OUTRO01190123.ABCD.3456.WXYZ6304EB76\nThis field should be in UTF-8 format. \n[Restriction] Required for PIX_QRCODE payments, with a maximum size of 512 bytes." }, { "name": "amount", "kind": "required", "type": "string", "description": "Amount that will be paid by the user\nminLength: 4\nmaxLength: 19\npattern: ^((\\d{1,16}\\.\\d{2}))$\nexample: 100000.12\n[Restriction] The value with 2 decimal places. ", "": "Amount that will be paid by the user\nminLength: 4\nmaxLength: 19\npattern: ^((\\d{1,16}\\.\\d{2}))$\nexample: 100000.12\n[Restriction] The 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": "redirectURL", "kind": "required", "type": "string", "description": "The URL redirected after completing user authentication and consent in an institutional environment.", "": "required" }, { "name": "remittanceInformation", "kind": "optional", "type": "string", "description": "Payment description\nmaxLength: 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.", "": "Payment description\nmaxLength: 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": "debtorAccount", "kind": "optional", "type": "Object", "description": "Payer's origin account information", "": "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" } ], "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": "creditorAccount", "kind": "optional", "type": "Object", "description": "Required if mthod = PIX_MANU", "": "Required if mthod = PIX_MANU", "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": "Required if initType is PIX_MANU", "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" } ] } ], "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": "Required if initType is PIX_MANU", "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": "externalInfo", "kind": "optional", "type": "Object", "description": "Metadata, user customizable", "": "externalInfo", "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" } ], "schema": [ { "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": "clientMetadata", "kind": "required", "type": "Object", "description": "Client metadata", "": "Client metadata", "children": [ { "name": "platform", "kind": "required", "type": "string", "description": "Client type, Enum: [ BROWSER, APP]" }, { "name": "os", "kind": "required", "type": "string", "description": "OS type, Enum: [ LINUX, MACOS, UNIX, WINDOWS, IOS, ANDROID, OTHER ]" }, { "name": "osVersion", "kind": "required", "type": "string", "description": "OS version" } ], "schema": [ { "name": "platform", "kind": "required", "type": "string", "description": "Client type, Enum: [ BROWSER, APP]" }, { "name": "os", "kind": "required", "type": "string", "description": "OS type, Enum: [ LINUX, MACOS, UNIX, WINDOWS, IOS, ANDROID, OTHER ]" }, { "name": "osVersion", "kind": "required", "type": "string", "description": "OS version" } ] } ], "formDataParameters": [] }, "currentNewParameter": { "label": "Body Parameter", "value": "bodyDataParameters" }, "response": [ { "name": "id", "kind": "optional", "type": "string", "description": "ID of payment order" }, { "name": "clientRequestId", "kind": "optional", "type": "string", "description": "Partner internal ID. ", "children": [] }, { "name": "amount", "kind": "optional", "type": "string", "description": "Amount that will be paid by the user", "children": [] }, { "name": "currency", "kind": "optional", "type": "string", "description": "Currency", "children": [] }, { "name": "status", "kind": "optional", "type": "string", "description": "Payment status", "children": [] }, { "name": "statusReason", "kind": "optional", "type": "object", "description": "", "children": [ { "name": "code", "kind": "optional", "type": "string", "description": "" }, { "name": "message", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "consentRedirectURL", "kind": "optional", "type": "string", "description": "When status is CONSENT_AWAITING_AUTHORIZATION", "children": [] } ], "hasTryItOut": false, "autoGeneratedAnchorSlug": "payments", "legacyHash": "9_5zkaPiF7Zy4WkZwHnMk" } ``` ::: [​](https://docs.klavipay.ai/docs/api-reference/customer/payments/create-payment#code-409)