Create a consent-links

1 min

/consent-links

Create a consent-links(For whitelabel)

POST

https://api-sandbox.klavi.ai/payment/customer/v1/automatic/consent-links

Body Parameters

accessKeystringrequired
Description
Pre-generated by Klavi for partner
secretKeystringrequired
Description
Pre-generated by Klavi for partner
consentobjectrequired
Description
Consent object
- clientRequestIdstringrequired
  Description
  Your internal orderId. Only can be used for once
- institutionIdstring
  Description
  Id from the bank chosen by the user
- customerobject
  - identifierTypestringrequired
    Description
    Type of the user identification document: CNPJ or CPF If value is CPF: maxLength: 3 example: CPF pattern: ^[A-Z]{3}$ If value is CNPJ maxLength: 4 example: CNPJ pattern: ^[A-Z]{4}$
  - identifierstringrequired
    Description
    The number of the user identification document If identifierType value is CPF: maxLength: 11 example: 11111111111 pattern: ^\d{11}$ If identifierType value is CNPJ: maxLength: 14 example: 11111111111111 pattern: ^[0-9A-Z]{12}[0-9]{2}$
  - namestringrequired
    Description
    Username
  - phonestring
    Description
    User's phone number
  - emailstring
    Description
    User's email
- loggedUserCpfstring
  Description
  User (natural person) who is logged in to the Payment Initiator institution. required if customer.identifierType = CNPJ
- redirectURLstring
  Description
  Return rediect url after user checkout in Klavi env
- additionalInformationstring
  Description
  Must be filled in whenever the paying user enters some additional information in the consent example: Minha recorrência pattern: [\w\W\s]* maxLength: 140
- debtorAccountobject
  Description
  Payer's origin account information
  - ispbstringrequired
    Description
    minLength: 8 maxLength: 8 pattern: ^[0-9]{8}$ example: 12345678 It must be filled in with the ISPB (Brazilian Payment System Identifier) of the SPI participant (Instant Payment System) with numbers only.
  - issuerstring
    Description
    minLength: 1 maxLength: 4 pattern: ^[0-9]{1,4}$ example: 1774 Code of the Agency issuing the account without digit. [Restriction] Mandatory for the following account types: CACC (CONTA_DEPOSITO_A_VISTA) and SVGS (CONTA_POUPANCA).
  - numberstringrequired
    Description
    minLength: 1 maxLength: 20 pattern: ^[0-9]{1,20}$ example: 1234567890 It must be filled in with the paying user's transactional account number, with verification digit (if any), If there is an alphanumeric value, it should be converted to 0.
  - accountTypestringrequired
    Description
    Types of accounts used for payment. example: CACC Enum: [ CACC, SVGS, TRAN] CACC - Current - Current Account SVGS - Savings - Saving Account TRAN - TransactingAccount - Prepaid Payment Account
- creditorAccountobject
  Description
  Object containing the data of the recipient (creditor).
  - ispbstringrequired
    Description
    minLength: 8 maxLength: 8 pattern: ^[0-9]{8}$ example: 12345678 It must be filled in with the ISPB (Brazilian Payment System Identifier) of the SPI participant (Instant Payment System) with numbers only.
  - issuerstring
    Description
    minLength: 1 maxLength: 4 pattern: ^[0-9]{1,4}$ example: 1774 Code of the Agency issuing the account without digit. [Restriction] Mandatory for the following account types: CACC (CONTA_DEPOSITO_A_VISTA) and SVGS (CONTA_POUPANCA).
  - numberstringrequired
    Description
    minLength: 1 maxLength: 20 pattern: ^[0-9]{1,20}$ example: 1234567890 It must be filled in with the paying user's transactional account number, with verification digit (if any), If there is an alphanumeric value, it should be converted to 0.
  - accountTypestringrequired
    Description
    Types of accounts used for payment. example: CACC Enum: [ CACC, SVGS, TRAN] CACC - Current - Current Account SVGS - Savings - Saving Account TRAN - TransactingAccount - Prepaid Payment Account
  - holderobject
    Description
    Holder object
    - identifierstringrequired
      Description
      The number of the user identification document If identifierType value is CPF: maxLength: 11 example: 11111111111 pattern: ^\d{11}$ If identifierType value is CNPJ: maxLength: 14 example: 11111111111111 pattern: ^[0-9A-Z]{12}[0-9]{2}$
    - namestringrequired
      Description
      Username
    - identifierTypestringrequired
      Description
      Type of the user identification document: CNPJ or CPF If value is CPF: maxLength: 3 example: CPF pattern: ^[A-Z]{3}$ If value is CNPJ maxLength: 4 example: CNPJ pattern: ^[A-Z]{4}$
- paymentMethodConfigobjectrequired
  Description
  Field intended for the configuration of the different recurring payment products.
  - contractIdstringrequired
    Description
    pattern: ^[a-zA-Z0-9]{1,35}$ minLength: 1 maxLength: 35 example: XE00038166201907261559y6j6 Transaction contract identifier
  - fixedAmountnumber
    Description
    pattern: ^((\d{1,16}\.\d{2}))$ minLength: 4 maxLength: 19 example: 100000.12 Fixed charge amount, if filled in, represents a consent for payments of fixed amounts, or not subject to change during the validity of the consent.
  - minimumVariableAmountnumber
    Description
    pattern: ^((\d{1,16}\.\d{2}))$ minLength: 4 maxLength: 19 example: 1000000.12 Value 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.
  - maximumVariableAmountnumber
    Description
    pattern: ^((\d{1,16}\.\d{2}))$ minLength: 4 maxLength: 19 example: 1000000.12 Maximum allowed value per charge, if filled in, represents consent to payments of variable amounts.
  - currencystringrequired
    Description
    maxLength: 3 pattern: ^([A-Z]{3})$ example: BRL
  - intervalstringrequired
    Description
    example: MONTHLY Enum: [ WEEKLY,MONTHLY,YEARLY,SEMIANNUAL,QUARTERLY ] Defines the allowed periodicity for transaction execution
  - referenceStartDatestringrequired
    Description
    pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$ example: 2023-05-21 Represents 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.
  - contractDebtorobjectrequired
    Description
    Information about the customer who owes the contract.
    - identifierTypestringrequired
      Description
      Enum: [ CPF, CNPJ ] Type of the user identification document: CNPJ or CPF
    - identifierstringrequired
      Description
      maxLength: 14 example: 11111111111111 pattern: ^([0-9]{11})$|^([0-9A-Z]{12}[0-9]{2})$ The number of the user identification document
    - namestringrequired
      Description
      pattern: ^([A-Za-zÀ-ÖØ-öø-ÿ,.@:&*+_<>()!?/\\$%\d' -]+)$ maxLength: 120 example: Policarpo Quaresma
  - isRetryAcceptedbooleanrequired
    Description
    example: false Indicates whether the receiving customer is allowed to make payment attempts (extradition), according to the rules set out in the Pix arrangement.
  - firstPaymentobject
    Description
    Definitions for the first payment. It is considered as the payment of membership to the service by the paying user.
    - remittanceInformationstring
      Description
      maxLength: 140 pattern: [\w\W\s]* example: Pagamento da nota RSTO035-002 It must be filled in whenever the paying user enters some additional information in a payment, to be sent to the recipient.
    - datestring
      Description
      maxLength: 10 pattern: ^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$ example: 2021-01-01 Defines the target date for payment settlement. The Brasília time zone should be used to create and streamline the data in this field.
    - amountstringrequired
      Description
      minLength: 4 maxLength: 19 pattern: ^((\d{1,16}\.\d{2}))$ example: 100000.12 The transaction value with 2 decimal places.
    - currencystringrequired
      Description
      maxLength: 3 pattern: ^([A-Z]{3})$ example: BRL National currency code according to ISO-4217, i.e., 'BRL'. All reported monetary values are represented with the current currency of Brazil.
- externalInfoobject
  Description
  Metadata, user customizable
  - appLinkstring
    Description
    Used to launch partner app, the format must follow the URL scheme
  - appRedirectURLKeystring
    Description
    Used to locate specific pages in the partner app Required if appLink != nil
- expirationDateTimestring
  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. example: 2021-05-21T08:30:00Z 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$ maxLength: 20
- linkOptionobject
  Description
  Used for customizing links
  - showLandingboolean
    Description
    Should the landing page be displayed
  - skipResultPageboolean
    Description
    Should skip the result page. If true, the parameter redirectURL is required.

Response

idstring
Description
Consent link ID
consentURLstring
Description
Consent link URL

curl

curl --location 'https://api-sandbox.klavi.ai/payment/customer/v1/automatic/consent-links' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"accessKey":"string","secretKey":"string","consent":{"customer":{},"debtorAccount":{},"creditorAccount":{"holder":{}},"paymentMethodConfig":{"contractDebtor":{},"firstPayment":{}},"externalInfo":{}}}'

nodejs

var request = require('request');
var options = {
   'method': 'POST',
   'url': 'https://api-sandbox.klavi.ai/payment/customer/v1/automatic/consent-links',
   'headers': {
      'Accept': 'application/json',
      'Content-Type': 'application/json'
   },
   body: JSON.stringify({
      "accessKey": "string",
      "secretKey": "string",
      "consent": {
         "customer": {},
         "debtorAccount": {},
         "creditorAccount": {
            "holder": {}
         },
         "paymentMethodConfig": {
            "contractDebtor": {},
            "firstPayment": {}
         },
         "externalInfo": {}
      }
   })

};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

javascript

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
   "accessKey": "string",
   "secretKey": "string",
   "consent": {
      "customer": {},
      "debtorAccount": {},
      "creditorAccount": {
         "holder": {}
      },
      "paymentMethodConfig": {
         "contractDebtor": {},
         "firstPayment": {}
      },
      "externalInfo": {}
   }
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api-sandbox.klavi.ai/payment/customer/v1/automatic/consent-links", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

python

import requests
import json

url = "https://api-sandbox.klavi.ai/payment/customer/v1/automatic/consent-links"

payload = json.dumps({
   "accessKey": "string",
   "secretKey": "string",
   "consent": {
      "customer": {},
      "debtorAccount": {},
      "creditorAccount": {
         "holder": {}
      },
      "paymentMethodConfig": {
         "contractDebtor": {},
         "firstPayment": {}
      },
      "externalInfo": {}
   }
})
headers = {
   'Accept': 'application/json',
   'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api-sandbox.klavi.ai/payment/customer/v1/automatic/consent-links")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request.body = JSON.dump({
   "accessKey": "string",
   "secretKey": "string",
   "consent": {
      "customer": {},
      "debtorAccount": {},
      "creditorAccount": {
         "holder": {}
      },
      "paymentMethodConfig": {
         "contractDebtor": {},
         "firstPayment": {}
      },
      "externalInfo": {}
   }
})

response = https.request(request)
puts response.read_body

201

{
    "id": "cfa45795-fe16-48e2-a372-130e30a72606", 
    "consentURL": "https://link.example.com?v=dmskdclckkclxkcox&c=xxxxyyyyzzz" 
}