Atualizar recebedor

Atualize os dados do recebedor.

Método

Node.js

import { Malga } from 'malga'

const malga = new Malga({
  apiKey: '17a64c8f-a387-4682-bdd8-d280493715e0',
  clientId: 'd1d2b51a-0446-432a-b055-034518c2660e',
})

await malga.sellers.update(
  'c1015d17-f123-499f-aaad-32e7f7812132',
  {
    merchantId: '8cfef0d1-73af-4bdb-b6c4-09ad3fbfc7f1',
    mcc: 3030,
    owner: {
      name: 'João da Silva',
      email: 'joao.silva@test.com',
      phoneNumber: '99999999999',
      birthdate: '2000-12-31',
      document: {
        number: '99999999999',
        type: 'cpf',
        country: 'BR'
      },
      address: {
        city: 'Rio de Janeiro',
        complement: 'Sala 214',
        country: 'BR',
        district: 'São Conrado',
        state: 'RJ',
        street: 'Estrada da Gávea',
        streetNumber: '696',
        zipCode: '22610002'
      }
    },
    bankAccount: {
      holderName: 'João da Silva'
      holderDocument: '99999999999',
      bank: '077'
      branchNumber: '492',
      accountNumber: '4929',
      type: 'conta_corrente'
    },
    transferPolicy: {
      transferDay: '5'
      transferEnabled: true
      transferInterval: 'monthly'
    }
  }
)

Response

{
  id: 'c1015d17-f123-499f-aaad-32e7f7812132',
  clientId: 'd1d2b51a-0446-432a-b055-034518c2660e',
  status: 'pending',
  merchantId: '8cfef0d1-73af-4bdb-b6c4-09ad3fbfc7f1',
  mcc: 3030,
  owner: {
    name: 'João da Silva',
    email: 'joao.silva@test.com',
    phoneNumber: '99999999999',
    birthdate: '2000-12-31'
    document: {
      number: '99999999999',
      type: 'cpf',
      country: 'BR'
    },
    address: {
      city: 'Rio de Janeiro',
      complement: 'Sala 214',
      country: 'BR',
      district: 'São Conrado',
      state: 'RJ',
      street: 'Estrada da Gávea',
      streetNumber: '696',
      zipCode: '22610002'
    }
  },
  bankAccount: {
    holderName: 'João da Silva'
    holderDocument: '99999999999',
    bank: '077'
    branchNumber: '492',
    accountNumber: '4929',
    type: 'conta_corrente'
  },
  transferPolicy: {
    transferDay: '5'
    transferEnabled: true
    transferInterval: 'monthly'
  },
  providers: [{
    providerType: 'SANDBOX',
    externalId: '1103976',
    externalStatus: 'active',
    externalStatusReason: 'ok',
    status: 'active',
    createdAt: '2023-12-31T16:08:39.536Z',
    updatedAt: '2023-12-31T16:08:39.536Z'
  }]
}

Parâmetros

Lista de todos os parâmetros suportados pelo método.

uuid

required

ID do Recebedor

payload

object

required

Segundo parâmetro

Show Parâmetros do payload

merchantId

uuid

required

ID do Merchant que será vinculado o recebedor

mcc

number

required

Código de segmento do lojista no adquirente

owner

object

Dados do recebedor

Show Parâmetros do owner

name

string

required

Nome do recebedor

string

required

E-mail do recebedor

phoneNumber

string

required

Telefone do recebedor

birthdate

string

required

Data de nascimento do recebedor

document

object

required

Dados do documento do recebedor

Show Parâmetros do document

type

string

required

Tipo do documento

number

string

required

Número do documento

country

string

País do documento

address

object

required

Dados de endereço do recebedor

Show Parâmetros do address

city

string

required

Cidade

country

string

required

País

district

string

required

Bairro

state

string

required

Estado

street

string

required

Nome da rua, avenida ou travessa

streetNumber

string

required

Número da rua

zipCode

string

required

Código postal

complement

string

Complemento onde se localiza o endereço, caso exista

business

object

Dados do estabelecimento do recebedor

Show Parâmetros do business

name

string

required

Nome do estabelecimento do recebedor

string

required

E-mail do estabelecimento do recebedor

phoneNumber

string

required

Telefone do estabelecimento do recebedor

openingDate

string

required

Data de abertura do estabelecimento do recebedor

description

string

required

Descrição do estabelecimento do recebedor

website

string

Site do estabelecimento do recebedor

twitter

string

Twitter do estabelecimento do recebedor

facebook

string

Facebook do estabelecimento do recebedor

document

object

required

Dados do documento do estabelecimento do recebedor

Show Parâmetros do document

type

string

required

Tipo do documento

number

string

required

Número do documento

country

string

País do documento

address

object

required

Dados de endereço do estabelecimento do recebedor

Show Parâmetros do address

city

string

required

Cidade

country

string

required

País

district

string

required

Bairro

state

string

required

Estado

street

string

required

Nome da rua, avenida ou travessa

streetNumber

string

required

Número da rua

zipCode

string

required

Código postal

complement

string

Complemento onde se localiza o endereço, caso exista

bankAccount

object

required

Dados da conta bancária

Show Parâmetros do bankAccount

holderName

string

required

Nome do portador da conta bancária

holderType

string

Identificador de pessoa física ou jurídica

Os tipos aceitos são: individual ou company

holderDocument

string

required

Documento do portador da conta bancária

bank

string

required

Código do banco

branchNumber

string

required

Número da agência bancária

branchCheckDigit

string

Código verificador da agência bancária

accountNumber

string

required

Número da conta bancária

accountCheckDigit

string

Número verificador da conta bancária

type

string

required

Tipo da conta

Os tipos aceitos são: conta_corrente, conta_poupanca, conta_corrente_conjunta ou conta_poupanca_conjunta

transferPolicy

object

required

Dados da política de transferência

Show Parâmetros do transferPolicy

transferDay

string

required

Dia em que o parceiro será pago

transferEnabled

boolean

required

Determina se as transferências estão autorizadas a acontecer

transferInterval

boolean

required

Intervalo entre as transferências

Os tipos aceitos são: daily, weekly ou monthly

automaticAnticipationEnabled

boolean

Determina se o recebedor receberá antecipações automaticamente

anticipatableVolumePercentage

string

Indica a porcentagem do volume passível de ser antecipado para o recebedor

automaticAnticipationType

string

Indica o tipo de antecipação automática que será configurado para a conta do recebedor

automaticAnticipationDays

string

Indica a quantidade de dias de antecipação automática

automaticAnticipation1025Delay

string

Indica a quantidade de dias que serão desconsiderados na contabilização do valor passível de ser antecipado. A contagem de dias é realizada a partir do dia da antecipação para trás

metadata

object

Informações adicionais passadas com chave e valor

​Método

​Parâmetros

Método

Parâmetros