Visão Geral
Tokens
Charges
Sessions
Customers
Merchants
Vendors
Sellers
Webhooks
Reports
Criação de um novo recebedor
identificação do merchant id a ser utilizado
código de segmento do lojista no adquirente, solicite ao seu provedor caso não saiba qual o seu Merchant Category Code.
Nome do recebedor
E-mail do recebedor
Telefone de contato do recebedor
Data de nascimento do recebedor em ISO-Date, ex 1996-01-31
Tipo de documento, consultar tabela de tipos suportados
Número do documento formato conforme tipo selecionado
Pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados
Nome da rua/avenida/travessa
Número onde se localiza o endereço
Complemento onde se localiza o endereço, caso exista
Codigo postal CEP
Pais onde se localiza o endereço - Padrão ISO 3166-1 alpha-2
Estado onde se localiza o endereço
Cidade onde se localiza o endereço
Bairro onde se localiza o endereço
Ponto de referência do endereço
Receita mensal do recebedor
Ocupação profissional do recebedor
Indica se recebedor é representante legal do negócio
Nome do estabelecimento do recebedor
Telefone de contato do estabelecimento do recebedor
E-mail do estabelecimento do recebedor
Site do estabelecimento do recebedor
Descrição do estabelecimento do recebedor
Facebook do estabelecimento do recebedor
Twitter do estabelecimento do recebedor
Data de abertura do estabelecimento do recebedor em ISO-Date, ex 2017-01-31
Nome da rua/avenida/travessa
Número onde se localiza o endereço
Complemento onde se localiza o endereço, caso exista
Codigo postal CEP
Pais onde se localiza o endereço - Padrão ISO 3166-1 alpha-2
Estado onde se localiza o endereço
Cidade onde se localiza o endereço
Bairro onde se localiza o endereço
Ponto de referência do endereço
Tipo de documento, consultar tabela de tipos suportados
Número do documento formato conforme tipo selecionado
Pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados
Receita anual do negócio
Nome de identificador do portador da conta bancária
identifica se é pessoa física ou jurídica. aceita os valores 'individual' ou 'company'
Documento do portador da conta bancária
Código do banco
Número da agência bancária
Código verificador da agência bancária
Número da conta bancária
Número verificador da conta bancária
Tipo de conta
Dia em que o parceiro será pago. Depende do transfer_interval - se for daily, enviar 1. Se for weekly pode ser de 1 (segunda) a 5 (sexta). Se for monthly, pode ser de 1 a 31. Além disso, se for daily e o provedor for Pagarme, o valor é 0.
Determina se as transferências estão autorizadas a acontecer ou não.
Intervalo entre as transferências.
Indica se o recebedor receberá antecipações automaticamente
Indica a porcentagem do volume passível de ser antecipado para o recebedor
Indica o tipo de antecipação automática que será configurado para a conta do recebedor
Indica a quantidade de dias de antecipação automática
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
Acordo de taxas para cadastro de seller no provedor Braspag. O envio desse nó é opcional durante a criação do recebedor.
curl --request POST \
--url https://api.malga.io/v1/sellers \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--header 'X-Client-Id: <api-key>' \
--data '{
"merchantId": "b1612460-0fef-447d-9590-97825cf60cf6",
"owner": {
"name": "Seller test",
"email": "seller@gmail.com",
"phoneNumber": "21 98889999099",
"birthdate": "1995-01-27",
"document": {
"type": "cpf",
"number": "36243319067",
"country": "BR"
},
"address": {
"street": "Av Geraldo Cardoso",
"streetNumber": "205",
"complement": "Apto 203",
"zipCode": "25650011",
"country": "BR",
"state": "Rio de Janeiro",
"city": "Rio de Janeiro",
"district": "Leblon",
"referencePoint": "Proximo a praia"
}
},
"business": {
"name": "Seller business test",
"phoneNumber": "21 98889999099",
"email": "seller@gmail.com",
"website": "https://sellerbusiness.com.br",
"description": "Seller business",
"facebook": "facebook Seller business",
"twitter": "twitter Seller business",
"openingDate": "1995-01-27",
"annualRevenue": 2500000,
"address": {
"street": "Rua Nova Lua",
"streetNumber": "30",
"complement": "sala 100",
"zipCode": "61000-320",
"country": "BR",
"state": "CE",
"city": "Maracanaú",
"district": "AB"
},
"document": {
"type": "cnpj",
"number": "94938591000196",
"country": "BR"
}
},
"mcc": 4040,
"bankAccount": {
"holderName": "Seller Name",
"holderDocument": "94938591000196",
"bank": "077",
"branchNumber": "492",
"branchCheckDigit": "1",
"accountNumber": "4929",
"accountCheckDigit": "12",
"type": "conta_corrente"
},
"transferPolicy": {
"transferDay": 5,
"transferEnabled": true,
"transferInterval": "weekly",
"automaticAnticipationEnabled": false,
"anticipatableVolumePercentage": "",
"automaticAnticipationType": "",
"automaticAnticipationDays": "",
"automaticAnticipation1025Delay": ""
}
}'
{
"id": "19d05a45-0e92-478e-8366-955231bcf3d6",
"providers": {
"providerType": "SANDBOX",
"externalId": "1966811",
"externalStatus": "active",
"externalStatusReason": "ok",
"status": "pending",
"createdAt": "2022-12-21T23:10:13.498Z",
"updatedAt": "2022-12-21T20:10:13.951Z"
},
"merchantId": "5616b19e-4d99-4bd3-b415-4990e5cab4f4",
"clientid": "e234eeb3-483d-4df2-87eb-1e2be5cdaccd",
"metadata": null,
"owner": {
"id": "8231ba21-3758-4bd7-b664-5b5fdeda37a0",
"updatedAt": "2023-07-11T23:02:51.581Z",
"createdAt": "2023-07-11T23:02:51.581Z",
"name": "Seller",
"email": "seller@email.com",
"phoneNumber": "85988350264",
"birthdate": "1995-01-27T02:00:00.000Z",
"address": {
"country": "BR",
"id": "883631f0-fea0-4682-ae1a-f4ac6349e0d9",
"updatedAt": "2023-07-11T23:02:51.585Z",
"createdAt": "2023-07-11T23:02:51.585Z",
"street": "Rua Nova Lua",
"streetNumber": "30",
"complement": "casa 4",
"zipCode": "61000-320",
"state": "CE",
"city": "Maracanaú",
"district": "AB"
},
"document": {
"country": "BR",
"id": "32543bbe-42c1-4000-9b68-d01a2735708e",
"updatedAt": "2023-07-11T23:02:51.588Z",
"createdAt": "2023-07-11T23:02:51.588Z",
"type": "cpf",
"number": "36243319067"
}
},
"business": {
"id": "607bb56a-974a-4d1d-9f56-cda865dfafbd",
"updatedAt": "2023-07-11T23:02:51.571Z",
"createdAt": "2023-07-11T23:02:51.571Z",
"name": "Seller business",
"phoneNumber": "85988350264",
"email": "seller@email.com",
"website": "www.sellerbusiness.com.br",
"description": "Seller business",
"facebook": "facebook Seller business",
"twitter": "twitter Seller business",
"openingDate": "1995-01-27",
"address": {
"country": "BR",
"id": "b681dd2e-ebdb-4fad-8c8b-e703a17825ce",
"updatedAt": "2023-07-11T23:02:51.574Z",
"createdAt": "2023-07-11T23:02:51.574Z",
"street": "Rua Nova Lua",
"streetNumber": "30",
"complement": "sala 100",
"zipCode": "61000-320",
"state": "CE",
"city": "Maracanaú",
"district": "AB"
},
"document": {
"country": "BR",
"id": "b9380f2c-a657-4f47-a7da-21f3bf08182c",
"updatedAt": "2023-07-11T23:02:51.578Z",
"createdAt": "2023-07-11T23:02:51.578Z",
"type": "cnpj",
"number": "94938591000196"
}
},
"bankAccount": {
"id": "f7ac3221-8f69-4276-b88b-34ddbe5ec24a",
"updatedAt": "2023-07-11T23:02:51.563Z",
"createdAt": "2023-07-11T23:02:51.563Z",
"holderName": "Seller name",
"holderDocument": "36243319067",
"bank": "077",
"branchNumber": "492",
"branchCheckDigit": "1",
"accountNumber": "4929",
"accountCheckDigit": "22",
"type": "conta_corrente"
},
"transferPolicy": {
"id": "a04bca24-f7d1-4cb5-acce-41f12680e5bf",
"updatedAt": "2023-07-11T23:02:51.567Z",
"createdAt": "2023-07-11T23:02:51.567Z",
"transferDay": "5",
"transferEnabled": true,
"transferInterval": "weekly",
"automaticAnticipationEnabled": false,
"anticipatableVolumePercentage": "",
"automaticAnticipationType": "",
"automaticAnticipationDays": "",
"automaticAnticipation1025Delay": ""
},
"mcc": 4040,
"status": "active"
}
Authorizations
Body
identificação do merchant id a ser utilizado
código de segmento do lojista no adquirente, solicite ao seu provedor caso não saiba qual o seu Merchant Category Code.
Acordo de taxas para cadastro de seller no provedor Braspag. O envio desse nó é opcional durante a criação do recebedor.
Response
Identificador do seller
Identificador do merchant
Identificador do cliente
Campos adicionais da transação enviados na criação da mesma
Código de segmento do lojista no adquirente
Status do seller
Was this page helpful?
curl --request POST \
--url https://api.malga.io/v1/sellers \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--header 'X-Client-Id: <api-key>' \
--data '{
"merchantId": "b1612460-0fef-447d-9590-97825cf60cf6",
"owner": {
"name": "Seller test",
"email": "seller@gmail.com",
"phoneNumber": "21 98889999099",
"birthdate": "1995-01-27",
"document": {
"type": "cpf",
"number": "36243319067",
"country": "BR"
},
"address": {
"street": "Av Geraldo Cardoso",
"streetNumber": "205",
"complement": "Apto 203",
"zipCode": "25650011",
"country": "BR",
"state": "Rio de Janeiro",
"city": "Rio de Janeiro",
"district": "Leblon",
"referencePoint": "Proximo a praia"
}
},
"business": {
"name": "Seller business test",
"phoneNumber": "21 98889999099",
"email": "seller@gmail.com",
"website": "https://sellerbusiness.com.br",
"description": "Seller business",
"facebook": "facebook Seller business",
"twitter": "twitter Seller business",
"openingDate": "1995-01-27",
"annualRevenue": 2500000,
"address": {
"street": "Rua Nova Lua",
"streetNumber": "30",
"complement": "sala 100",
"zipCode": "61000-320",
"country": "BR",
"state": "CE",
"city": "Maracanaú",
"district": "AB"
},
"document": {
"type": "cnpj",
"number": "94938591000196",
"country": "BR"
}
},
"mcc": 4040,
"bankAccount": {
"holderName": "Seller Name",
"holderDocument": "94938591000196",
"bank": "077",
"branchNumber": "492",
"branchCheckDigit": "1",
"accountNumber": "4929",
"accountCheckDigit": "12",
"type": "conta_corrente"
},
"transferPolicy": {
"transferDay": 5,
"transferEnabled": true,
"transferInterval": "weekly",
"automaticAnticipationEnabled": false,
"anticipatableVolumePercentage": "",
"automaticAnticipationType": "",
"automaticAnticipationDays": "",
"automaticAnticipation1025Delay": ""
}
}'
{
"id": "19d05a45-0e92-478e-8366-955231bcf3d6",
"providers": {
"providerType": "SANDBOX",
"externalId": "1966811",
"externalStatus": "active",
"externalStatusReason": "ok",
"status": "pending",
"createdAt": "2022-12-21T23:10:13.498Z",
"updatedAt": "2022-12-21T20:10:13.951Z"
},
"merchantId": "5616b19e-4d99-4bd3-b415-4990e5cab4f4",
"clientid": "e234eeb3-483d-4df2-87eb-1e2be5cdaccd",
"metadata": null,
"owner": {
"id": "8231ba21-3758-4bd7-b664-5b5fdeda37a0",
"updatedAt": "2023-07-11T23:02:51.581Z",
"createdAt": "2023-07-11T23:02:51.581Z",
"name": "Seller",
"email": "seller@email.com",
"phoneNumber": "85988350264",
"birthdate": "1995-01-27T02:00:00.000Z",
"address": {
"country": "BR",
"id": "883631f0-fea0-4682-ae1a-f4ac6349e0d9",
"updatedAt": "2023-07-11T23:02:51.585Z",
"createdAt": "2023-07-11T23:02:51.585Z",
"street": "Rua Nova Lua",
"streetNumber": "30",
"complement": "casa 4",
"zipCode": "61000-320",
"state": "CE",
"city": "Maracanaú",
"district": "AB"
},
"document": {
"country": "BR",
"id": "32543bbe-42c1-4000-9b68-d01a2735708e",
"updatedAt": "2023-07-11T23:02:51.588Z",
"createdAt": "2023-07-11T23:02:51.588Z",
"type": "cpf",
"number": "36243319067"
}
},
"business": {
"id": "607bb56a-974a-4d1d-9f56-cda865dfafbd",
"updatedAt": "2023-07-11T23:02:51.571Z",
"createdAt": "2023-07-11T23:02:51.571Z",
"name": "Seller business",
"phoneNumber": "85988350264",
"email": "seller@email.com",
"website": "www.sellerbusiness.com.br",
"description": "Seller business",
"facebook": "facebook Seller business",
"twitter": "twitter Seller business",
"openingDate": "1995-01-27",
"address": {
"country": "BR",
"id": "b681dd2e-ebdb-4fad-8c8b-e703a17825ce",
"updatedAt": "2023-07-11T23:02:51.574Z",
"createdAt": "2023-07-11T23:02:51.574Z",
"street": "Rua Nova Lua",
"streetNumber": "30",
"complement": "sala 100",
"zipCode": "61000-320",
"state": "CE",
"city": "Maracanaú",
"district": "AB"
},
"document": {
"country": "BR",
"id": "b9380f2c-a657-4f47-a7da-21f3bf08182c",
"updatedAt": "2023-07-11T23:02:51.578Z",
"createdAt": "2023-07-11T23:02:51.578Z",
"type": "cnpj",
"number": "94938591000196"
}
},
"bankAccount": {
"id": "f7ac3221-8f69-4276-b88b-34ddbe5ec24a",
"updatedAt": "2023-07-11T23:02:51.563Z",
"createdAt": "2023-07-11T23:02:51.563Z",
"holderName": "Seller name",
"holderDocument": "36243319067",
"bank": "077",
"branchNumber": "492",
"branchCheckDigit": "1",
"accountNumber": "4929",
"accountCheckDigit": "22",
"type": "conta_corrente"
},
"transferPolicy": {
"id": "a04bca24-f7d1-4cb5-acce-41f12680e5bf",
"updatedAt": "2023-07-11T23:02:51.567Z",
"createdAt": "2023-07-11T23:02:51.567Z",
"transferDay": "5",
"transferEnabled": true,
"transferInterval": "weekly",
"automaticAnticipationEnabled": false,
"anticipatableVolumePercentage": "",
"automaticAnticipationType": "",
"automaticAnticipationDays": "",
"automaticAnticipation1025Delay": ""
},
"mcc": 4040,
"status": "active"
}