Criação de um novo 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"
}Body
Número da conta bancária
Código do banco
Número da agência bancária
Documento do portador da conta bancária
Nome de identificador do portador da conta bancária
Tipo de conta
conta_corrente, conta_poupanca, conta_corrente_conjunta, conta_poupanca_conjunta Número verificador da conta bancária
Código verificador da agência bancária
identifica se é pessoa física ou jurídica. aceita os valores 'individual' ou 'company'
individual, company código de segmento do lojista no adquirente, solicite ao seu provedor caso não saiba qual o seu Merchant Category Code.
identificação do merchant id a ser utilizado
Cidade onde se localiza o endereço
Pais onde se localiza o endereço - Padrão ISO 3166-1 alpha-2
AL, AD, AR, AT, AU, BA, BZ, BE, BG, BR, BY, CA, CU, CY, CZ, CH, CL, CN, CO, CR, DE, DK, DO, EC, EE, SV, GT, FI, FR, GB, GR, HR, HK, HU, IS, ID, IE, IN, IL, IT, LI, LT, LU, LV, MK, MC, MD, MT, MU, JP, KR, MX, ME, MY, NL, NZ, NO, PY, PE, PK, PL, PT, RU, RO, SM, RS, SE, SG, TH, TW, TR, SI, SK, ES, UY, UA, US, VE, VN, ZA Bairro onde se localiza o endereço
Estado onde se localiza o endereço
Nome da rua/avenida/travessa
Número onde se localiza o endereço
Codigo postal CEP
Complemento onde se localiza o endereço, caso exista
Ponto de referência do endereço
Data de nascimento do recebedor em ISO-Date, ex 1996-01-31
Número do documento formato conforme tipo selecionado
Tipo de documento, consultar tabela de tipos suportados
Pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados
AL, AD, AR, AT, AU, BA, BZ, BE, BG, BR, BY, CA, CU, CY, CZ, CH, CL, CN, CO, CR, DE, DK, DO, EC, EE, SV, GT, FI, FR, GB, GR, HR, HK, HU, IS, ID, IE, IN, IL, IT, LI, LT, LU, LV, MK, MC, MD, MT, MU, JP, KR, MX, ME, MY, NL, NZ, NO, PY, PE, PK, PL, PT, RU, RO, SM, RS, SE, SG, TH, TW, TR, SI, SK, ES, UY, UA, US, VE, VN, ZA E-mail do recebedor
Nome do recebedor
Telefone de contato do recebedor
Indica se recebedor é representante legal do negócio
Receita mensal do recebedor
Ocupação profissional do recebedor
Cidade onde se localiza o endereço
Pais onde se localiza o endereço - Padrão ISO 3166-1 alpha-2
AL, AD, AR, AT, AU, BA, BZ, BE, BG, BR, BY, CA, CU, CY, CZ, CH, CL, CN, CO, CR, DE, DK, DO, EC, EE, SV, GT, FI, FR, GB, GR, HR, HK, HU, IS, ID, IE, IN, IL, IT, LI, LT, LU, LV, MK, MC, MD, MT, MU, JP, KR, MX, ME, MY, NL, NZ, NO, PY, PE, PK, PL, PT, RU, RO, SM, RS, SE, SG, TH, TW, TR, SI, SK, ES, UY, UA, US, VE, VN, ZA Bairro onde se localiza o endereço
Estado onde se localiza o endereço
Nome da rua/avenida/travessa
Número onde se localiza o endereço
Codigo postal CEP
Complemento onde se localiza o endereço, caso exista
Ponto de referência do endereço
Descrição do estabelecimento do recebedor
Número do documento formato conforme tipo selecionado
Tipo de documento, consultar tabela de tipos suportados
Pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados
AL, AD, AR, AT, AU, BA, BZ, BE, BG, BR, BY, CA, CU, CY, CZ, CH, CL, CN, CO, CR, DE, DK, DO, EC, EE, SV, GT, FI, FR, GB, GR, HR, HK, HU, IS, ID, IE, IN, IL, IT, LI, LT, LU, LV, MK, MC, MD, MT, MU, JP, KR, MX, ME, MY, NL, NZ, NO, PY, PE, PK, PL, PT, RU, RO, SM, RS, SE, SG, TH, TW, TR, SI, SK, ES, UY, UA, US, VE, VN, ZA E-mail do estabelecimento do recebedor
Nome do estabelecimento do recebedor
Data de abertura do estabelecimento do recebedor em ISO-Date, ex 2017-01-31
Telefone de contato do estabelecimento do recebedor
Receita anual do negócio
Facebook do estabelecimento do recebedor
Twitter do estabelecimento do recebedor
Site do estabelecimento do recebedor
Acordo de taxas para cadastro de seller no provedor Braspag. O envio desse nó é opcional durante a criação do recebedor.
Taxa fixa por transação. Valor em centavos. Ex => R$ 1,00 => Fee = 100
Número final do intervalo de parcelas da taxa de desconto do seller. O número de parcelas deverá ser maior do que 0 e menor ou igual a 12.
Número inicial do intervalo de parcelas da taxa de desconto do seller. O número de parcelas deverá ser maior do que 0 e menor ou igual a 12.
Bandeira do arranjo de pagamento da taxa de desconto do seller. As bandeiras válidas são Visa, Master, Amex, Elo, Diners e Hipercard.
Visa, Master, Amex, Elo, Diners, Hipercard Produto do arranjo de pagamento da taxa de desconto do seller.
CreditCard, DebitCard Porcentagem da taxa de desconto do seller. Valor com até duas casas decimais.
Porcentagem da taxa de desconto única (MDR único) para acordo do tipo GlobalRate. Valor com até duas casas decimais. Só deve ser enviado em caso de cadastro de seller com Taxa global.
Cenários de acordo de taxas
GlobalRate, FeePaymentMethod Indica a porcentagem do volume passível de ser antecipado para o recebedor
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
Indica a quantidade de dias de antecipação automática
Indica se o recebedor receberá antecipações automaticamente
Indica o tipo de antecipação automática que será configurado para a conta do recebedor
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.
daily, weekly, monthly Response
Número verificador da conta bancária
Número da conta bancária
Código do banco
Código verificador da agência bancária
Número da agência bancária
Data de criação da conta bancária
Documento do portador da conta bancária
Nome de identificação do portador da conta bancária
Identificação da conta bancária
Tipo de conta
conta_corrente, conta_poupanca, conta_corrente_conjunta, conta_poupanca_conjunta Data de alteração da conta bancária
Cidade onde se localiza o endereço
Complemento onde se localiza o endereço, caso exista
Pais onde se localiza o endereço
AL, AD, AR, AT, AU, BA, BZ, BE, BG, BR, BY, CA, CU, CY, CZ, CH, CL, CN, CO, CR, DE, DK, DO, EC, EE, SV, GT, FI, FR, GB, GR, HR, HK, HU, IS, ID, IE, IN, IL, IT, LI, LT, LU, LV, MK, MC, MD, MT, MU, JP, KR, MX, ME, MY, NL, NZ, NO, PY, PE, PK, PL, PT, RU, RO, SM, RS, SE, SG, TH, TW, TR, SI, SK, ES, UY, UA, US, VE, VN, ZA Data de criação do endereço
Bairro onde se localiza o endereço
Identificador do endereço
Estado onde se localiza o endereço
Nome da rua/avenida/travessa
Número onde se localiza o endereço
Data de alteração do endereço
Codigo postal CEP
Data de criação do estabelecimento do recebedor
Descrição do estabelecimento do recebedor
Pais de emissão do documento
AL, AD, AR, AT, AU, BA, BZ, BE, BG, BR, BY, CA, CU, CY, CZ, CH, CL, CN, CO, CR, DE, DK, DO, EC, EE, SV, GT, FI, FR, GB, GR, HR, HK, HU, IS, ID, IE, IN, IL, IT, LI, LT, LU, LV, MK, MC, MD, MT, MU, JP, KR, MX, ME, MY, NL, NZ, NO, PY, PE, PK, PL, PT, RU, RO, SM, RS, SE, SG, TH, TW, TR, SI, SK, ES, UY, UA, US, VE, VN, ZA Data de criação do documento
Identificador do documento
Número do documento
Tipo de documento
Data de alteração do documento
E-mail do estabelecimento do recebedor
Facebook do estabelecimento do recebedor
Identificador do estabelecimento do recebedor
Nome do estabelecimento do recebedor
Data de abertura do estabelecimento do recebedor em ISO-Date, ex 2017-01-31
Telefone de contato do estabelecimento do recebedor
Twitter do estabelecimento do recebedor
Data de alteração do estabelecimento do recebedor
Site do estabelecimento do recebedor
Identificador do cliente
Identificador do seller
Código de segmento do lojista no adquirente
Identificador do merchant
Campos adicionais da transação enviados na criação da mesma
Cidade onde se localiza o endereço
Complemento onde se localiza o endereço, caso exista
Pais onde se localiza o endereço
AL, AD, AR, AT, AU, BA, BZ, BE, BG, BR, BY, CA, CU, CY, CZ, CH, CL, CN, CO, CR, DE, DK, DO, EC, EE, SV, GT, FI, FR, GB, GR, HR, HK, HU, IS, ID, IE, IN, IL, IT, LI, LT, LU, LV, MK, MC, MD, MT, MU, JP, KR, MX, ME, MY, NL, NZ, NO, PY, PE, PK, PL, PT, RU, RO, SM, RS, SE, SG, TH, TW, TR, SI, SK, ES, UY, UA, US, VE, VN, ZA Data de criação do endereço
Bairro onde se localiza o endereço
Identificador do endereço
Estado onde se localiza o endereço
Nome da rua/avenida/travessa
Número onde se localiza o endereço
Data de alteração do endereço
Codigo postal CEP
Data de nascimento do recebedor em ISO-Date, ex 1996-01-31
Data de criação do recebedor
Pais de emissão do documento
AL, AD, AR, AT, AU, BA, BZ, BE, BG, BR, BY, CA, CU, CY, CZ, CH, CL, CN, CO, CR, DE, DK, DO, EC, EE, SV, GT, FI, FR, GB, GR, HR, HK, HU, IS, ID, IE, IN, IL, IT, LI, LT, LU, LV, MK, MC, MD, MT, MU, JP, KR, MX, ME, MY, NL, NZ, NO, PY, PE, PK, PL, PT, RU, RO, SM, RS, SE, SG, TH, TW, TR, SI, SK, ES, UY, UA, US, VE, VN, ZA Data de criação do documento
Identificador do documento
Número do documento
Tipo de documento
Data de alteração do documento
E-mail do recebedor
Identificador do recebedor
Nome do recebedor
Telefone de contato do recebedor
Data de alteração do recebedor
Data de criação
Identificação externa
Status externo
Razão do status externo
Nome do provedor
SANDBOX Status do recebedor
Data de alteração
Status do seller
Data de criação da transferência
Identificação da transferência
Indica a porcentagem do volume passível de ser antecipado para o recebedor
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
Indica a quantidade de dias de antecipação automática
Indica se o recebedor receberá antecipações automaticamente
Indica o tipo de antecipação automática que será configurado para a conta do recebedor
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.
daily, weekly, monthly Data de alteração da transferência
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"
}