Register or update a receiving account for the application

1 min

accounts

POST

https://api-sandbox.klavi.ai/payment/management/v1/merchants/{appId}/accounts

Path Parameters

appIdstringrequired
Description
The appId of merchant

Header Parameters

Authorizationstringrequired
Description
Bearer access token, it returned by the /auth

Body Parameters

ispbstringrequired
Description
It must be filled in with the ISPB (Brazilian Payment System Identifier) of the SPI participant (Instant Payment System) with numbers only. minLength: 8 maxLength: 8 pattern: ^[0-9]{8}$ example: 12345678
issuerstring
Description
Code of the Agency issuing the account without digit. (Agency is the dependency intended to serve customers, the general public and the members of credit cooperatives, in the exercise of activities of the institution, and may not be mobile or transitory). [Restriction] Mandatory for the following account types: CACC (CONTA_DEPOSITO_A_VISTA) and SVGS (CONTA_POUPANCA). minLength: 1 maxLength: 4 pattern: ^[0-9]{1,4}$ example: 1774
numberstringrequired
Description
It must be filled in with the account number of the receiving user, with verification digit (if any), if there is an alphanumeric value, it should be converted to 0. minLength: 1 maxLength: 20 pattern: ^[0-9]{1,20}$ example: 1234567890
accountTypestringrequired
Description
Types of accounts used for payment. Traditional arrangements provided for by Resolution 4.753, excluding linked accounts, overseas domiciled accounts, foreign currency accounts and corresponding electronic currency accounts. The following is a description of each ENUM value. CACC - Current Account. SVGS - Savings. TRAN - TransactingAccount - Prepaid Payment Account. Enum: [ CACC , SVGS , TRAN ] example: CACC
proxystringrequired
Description
Pix key
holderobjectrequired
- identifierstringrequired
- namestringrequired
- identifierTypestringrequired

curl

curl --location --globoff 'https://api-sandbox.klavi.ai/payment/management/v1/merchants/{appId}/accounts/{appId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "ispb": "String",
  "issuer": "String",
  "number": "String",
  "accountType": "String",
  "proxy": "String",
  "holder": {
    "identifier": "",
    "name": "",
    "identifierType": ""
  }
}'

nodejs

var request = require('request');
var options = {
   'method': 'POST',
   'url': 'https://api-sandbox.klavi.ai/payment/management/v1/merchants/{appId}/accounts/{appId}',
   'headers': {
      'Accept': 'application/json',
      'Content-Type': 'application/json'
   },
   body: JSON.stringify({
      "ispb": "String",
      "issuer": "String",
      "number": "String",
      "accountType": "String",
      "proxy": "String",
      "holder": {
         "identifier": "",
         "name": "",
         "identifierType": ""
      }
   })

};
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({
   "ispb": "String",
   "issuer": "String",
   "number": "String",
   "accountType": "String",
   "proxy": "String",
   "holder": {
      "identifier": "",
      "name": "",
      "identifierType": ""
   }
});

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

fetch("https://api-sandbox.klavi.ai/payment/management/v1/merchants/{appId}/accounts/{appId}", 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/management/v1/merchants/{appId}/accounts/{appId}"

payload = json.dumps({
   "ispb": "String",
   "issuer": "String",
   "number": "String",
   "accountType": "String",
   "proxy": "String",
   "holder": {
      "identifier": "",
      "name": "",
      "identifierType": ""
   }
})
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/management/v1/merchants/{appId}/accounts/{appId}")

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({
   "ispb": "String",
   "issuer": "String",
   "number": "String",
   "accountType": "String",
   "proxy": "String",
   "holder": {
      "identifier": "",
      "name": "",
      "identifierType": ""
   }
})

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

201