Pular para o conteúdo principal
Documentation Powered by ReDoc

Documentação Malga API (0.5)

Download OpenAPI specification:Download

Authentication

Os serviços de API da Malga são protegidos através de chaves de acesso. Você pode gerenciar suas chaves de acesso através do seu dashboard.

É importante armazenar suas chaves de maneira privada e segura uma vez que elas possuem privilégios de alteração na sua conta. Não compartilhe suas chaves, não deixe elas fixadas no seu código e nem armazene elas no seu servidor de controle de versão. Recomendamos utilizar variáveis de ambiente secretas para deixar a chave disponível para sua aplicação.

A Autenticação para todos os chamadas da API é feita através de headers HTTP, sendo necessário informar seu identificador de cliente na Malga e a chave secreta de acesso.

X-Client-ID

Identificador única da sua conta na Malga. Deve ser enviado no header obrigatóriamente em todas as requisições feitas a API.

Security Scheme Type API Key
Header parameter name X-Client-ID

X-Api-Key

Sua chave de acesso a API. Funciona em par com o client-id devendo ser enviado no header obrigatóriamente em todas as requisições feitas a API.

Security Scheme Type API Key
Header parameter name X-Api-Key

Exemplo de requisicão autenticada

  curl --location --request GET 'https://api.malga.io/v1/' \
    --header 'X-Client-Id: <YOUR_CLIENT_ID>' \
    --header 'X-Api-Key: <YOUR_SECRET_KEY>'

Client-token

É possível criar chaves públicas de acesso temporária a API com escopo e tempo de expiração limitados.

Recomendamos o uso deste tipo de chave quando você tiver que expor a chave em uma aplicação client side.

Detalhe dos parâmetros da chamada de criação da chave pública:

scope
string
Enum: "customers" "cards" "tokens" "charges" "webhooks" "sessions" "auth" "reports" "flows" "sellers"

determina o escopo de endpoints que a chave terá acesso

expires
number
Default: 0

prazo de validade da chave em segundos a partir da criação, zero para não expirar

{
}

Retorno da chamada de criação da chave pública:

scope
string
Enum: "customers" "cards" "tokens" "charges" "webhooks" "sessions" "auth" "reports" "flows" "sellers"

determina o escopo de endpoints que a chave terá acesso

expires
number

prazo de validade da chave em segundos a partir da criação, zero para não expirar

clientId
string <uuid>

identificador do cliente na Malga

publicKey
string <uuid>

chave pública criada

{
}

Criar nova chave pública para uso no client-side

Authorizations:
X-Client-IDX-Api-Key
Request Body schema: application/json

Creat authentication token

scope
string
Enum: "customers" "cards" "tokens" "charges" "webhooks" "sessions" "auth" "reports" "flows" "sellers"

determina o escopo de endpoints que a chave terá acesso

expires
number
Default: 0

prazo de validade da chave em segundos a partir da criação, zero para não expirar

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Tokens

Dados básicos de uma requisição de criação de card token

TokenCard (object) or TokenCvv (object)

Pode ser tokenizado o cartão e/ou cvv de acordo com a passagem dos atributos

One of
cardHolderName
required
string

Nome do portador do cartão

cardNumber
required
string

Número do cartão (Sem espaços)

cardCvv
required
string

Código de verificação

cardExpirationDate
required
string

Mês e ano de validade no formato MM/YYYY

null

Criar um novo token

Authorizations:
X-Client-IDX-Api-Key
Request Body schema: application/json

Tokenizar

TokenCard (object) or TokenCvv (object)

Pode ser tokenizado o cartão e/ou cvv de acordo com a passagem dos atributos

One of
cardHolderName
required
string

Nome do portador do cartão

cardNumber
required
string

Número do cartão (Sem espaços)

cardCvv
required
string

Código de verificação

cardExpirationDate
required
string

Mês e ano de validade no formato MM/YYYY

Responses

Request samples

Content type
application/json
Example
Exemplo de tokenização de cartão
Exemplo de tokenização de cartão
Exemplo de tokenização do cvv
{
}

Response samples

Content type
application/json
{
}

Cards

Dados básicos de um objeto cartão

id
string

ID do cartão

expirationMonth
string

Data de expiração MM

expirationYear
string

Data de expiração YYYY

brand
string
Enum: "American Express" "Mastercard" "Visa" "Elo" "Discover" "JCB" "Diners"

Bandeira

cvvChecked
boolean

Identifica se o CVV foi verificado

fingerprint
string

Hash de identificação única do cartão com base nos dados sensíveis

first6digits
string

Primeiros 6 digitos do cartão

last4digits
string

Últimos 4 digitos do cartão

status
string
Enum: "failed" "active" "pending"

Status de validação dos dados cartões, failed (cartão inválido para uso), active (cartão válido para uso), pending (validação do cartão pendente, uso autorizado temporariamente)

statusReason
string

Contém uma string com um breve descritivo informando o motivo do status do cartão. Em alguns casos uma string vazia é retornada.

createdAt
string

Data de criação do cartão

updatedAt
string

Data de atualização do cartão

object
id
string

identificador do customer

createdAt
string

data de criação

clientId
string <uuid>

identificador do client

name
string

nome do usuario

email
string

email do usuario

phoneNumber
string

telefones de contato do usuario

object
type
required
string

Tipo de documento, consultar tabela de tipos suportados

number
required
string

Número do documento formato conforme tipo selecionado

country
string
Default: "BR"
Enum: "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"

Pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados

object
street
required
string

Nome da rua/avenida/travessa

streetNumber
required
string

Número onde se localiza o endereço

complement
string

Complemento onde se localiza o endereço, caso exista

zipCode
required
string

Codigo postal CEP

country
required
string
Default: "BR"
Enum: "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"

Pais onde se localiza o endereço - Padrão ISO 3166-1 alpha-2

state
required
string

Estado onde se localiza o endereço

city
required
string

Cidade onde se localiza o endereço

district
required
string

Bairro onde se localiza o endereço

{
}

Criar novo cartão a partir de token

Authorizations:
X-Client-IDX-Api-Key
Request Body schema: application/json

Create credit card

tokenId
required
string <uuid>

Identificador do token gerado

merchantId
string <uuid>

Caso queria validar o cartão via zero dollar, informe o merchantId que possui pelo menos 1 provedor com suporte a validação zero dollar.

cvvCheck
boolean

Mesmo informando o merchantId, é possível desabilitar a validação do cvv (zero dollar). Informe true para validar ou false para pular a validação. Caso você informe false, a verificação será pulada e o cartão será criado como pending necessitando validar via uma transação.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Listar cartões

Authorizations:
X-Client-IDX-Api-Key
query Parameters
page
number

número da página

limit
number

quantidade de itens por página

Responses

Response Schema: application/json
object
itemCount
integer

quantidade de itens na página

totalItems
integer

quantidade total de itens na consulta

itemsPerPage
integer

quantidade de itens por página

totalPages
integer

quantidade total de páginas

currentPage
integer

página atual

items
array

Response samples

Content type
application/json
{
}

Recuperar detalhes de cartão

Authorizations:
X-Client-IDX-Api-Key
path Parameters
id
required
string <uuid>

ID do cartão

Responses

Response Schema: application/json
id
string

ID do cartão

expirationMonth
string

Data de expiração MM

expirationYear
string

Data de expiração YYYY

brand
string
Enum: "American Express" "Mastercard" "Visa" "Elo" "Discover" "JCB" "Diners"

Bandeira

cvvChecked
boolean

Identifica se o CVV foi verificado

fingerprint
string

Hash de identificação única do cartão com base nos dados sensíveis

first6digits
string

Primeiros 6 digitos do cartão

last4digits
string

Últimos 4 digitos do cartão

status
string
Enum: "failed" "active" "pending"

Status de validação dos dados cartões, failed (cartão inválido para uso), active (cartão válido para uso), pending (validação do cartão pendente, uso autorizado temporariamente)

statusReason
string

Contém uma string com um breve descritivo informando o motivo do status do cartão. Em alguns casos uma string vazia é retornada.

createdAt
string

Data de criação do cartão

updatedAt
string

Data de atualização do cartão

object
id
string

identificador do customer

createdAt
string

data de criação

clientId
string <uuid>

identificador do client

name
string

nome do usuario

email
string

email do usuario

phoneNumber
string

telefones de contato do usuario

object
type
required
string

Tipo de documento, consultar tabela de tipos suportados

number
required
string

Número do documento formato conforme tipo selecionado

country
string
Default: "BR"
Enum: "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"

Pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados

object
street
required
string

Nome da rua/avenida/travessa

streetNumber
required
string

Número onde se localiza o endereço

complement
string

Complemento onde se localiza o endereço, caso exista

zipCode
required
string

Codigo postal CEP

country
required
string
Default: "BR"
Enum: "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"

Pais onde se localiza o endereço - Padrão ISO 3166-1 alpha-2

state
required
string

Estado onde se localiza o endereço

city
required
string

Cidade onde se localiza o endereço

district
required
string

Bairro onde se localiza o endereço

Response samples

Content type
application/json
{
}

Customers

Através da API de customers é possível realizar a criação, edição, listagem e exclusão de dados de compradores para uso nos serviços de tokenização de cartões, cobrança por PIX, Boleto, uso em análise de motores de antifraude e recorrência.

A fim de manter maior integridade dos dados, as informações de email e documento (CPF/CNJP) são únicos para customers na sua conta Malga, não podendo existir dois compradores iguais.

Consulte a tabela de tipos de paises e documentos suportados para criação de customer

Criação de novo customer para cobrança

Authorizations:
X-Client-IDX-Api-Key
Request Body schema: application/json
name
required
string

nome do usuario

email
required
string

email do usuario

phoneNumber
required
string

telefone de contato do usuario

required
object
type
required
string

Tipo de documento, consultar tabela de tipos suportados

number
required
string

Número do documento formato conforme tipo selecionado

country
string
Default: "BR"
Enum: "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"

Pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados

object
street
required
string

Nome da rua/avenida/travessa

streetNumber
required
string

Número onde se localiza o endereço

complement
string

Complemento onde se localiza o endereço, caso exista

zipCode
required
string

Codigo postal CEP

country
required
string
Default: "BR"
Enum: "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"

Pais onde se localiza o endereço - Padrão ISO 3166-1 alpha-2

state
required
string

Estado onde se localiza o endereço

city
required
string

Cidade onde se localiza o endereço

district
required
string

Bairro onde se localiza o endereço

Responses

Request samples

Content type
application/json
{
}

Listagem de customers cadastrados

Authorizations:
X-Client-IDX-Api-Key
query Parameters
page
number

número da página

limit
number

quantidade de itens por página

sort
string
Enum: "ASC" "DESC"

ordenação dos itens

id
string

identificador de um customer

document.type
string

tipo de documento

document.number
string

numero do documento

Responses

Response Schema: application/json
object
itemCount
integer

quantidade de itens na página

totalItems
integer

quantidade total de itens na consulta

itemsPerPage
integer

quantidade de itens por página

totalPages
integer

quantidade total de páginas

currentPage
integer

página atual

object
id
string

identificador do customer

createdAt
string

data de criação

clientId
string <uuid>

identificador do client

name
string

nome do usuario

email
string

email do usuario

phoneNumber
string

telefones de contato do usuario

object
type
required
string

Tipo de documento, consultar tabela de tipos suportados

number
required
string

Número do documento formato conforme tipo selecionado

country
string
Default: "BR"
Enum: "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"

Pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados

object
street
required
string

Nome da rua/avenida/travessa

streetNumber
required
string

Número onde se localiza o endereço

complement
string

Complemento onde se localiza o endereço, caso exista

zipCode
required
string

Codigo postal CEP

country
required
string
Default: "BR"
Enum: "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"

Pais onde se localiza o endereço - Padrão ISO 3166-1 alpha-2

state
required
string

Estado onde se localiza o endereço

city
required
string

Cidade onde se localiza o endereço

district
required
string

Bairro onde se localiza o endereço

Response samples

Content type
application/json
{
}

Recuperar detalhes de customer

Authorizations:
X-Client-IDX-Api-Key
path Parameters
id
required
string <uuid>

id do customers que deseja recuperar

Responses

Response Schema: application/json
id
string

identificador do customer

createdAt
string

data de criação

clientId
string <uuid>

identificador do client

name
string

nome do usuario

email
string

email do usuario

phoneNumber
string

telefones de contato do usuario

object
type
required
string

Tipo de documento, consultar tabela de tipos suportados

number
required
string

Número do documento formato conforme tipo selecionado

country
string
Default: "BR"
Enum: "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"

Pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados

object
street
required
string

Nome da rua/avenida/travessa

streetNumber
required
string

Número onde se localiza o endereço

complement
string

Complemento onde se localiza o endereço, caso exista

zipCode
required
string

Codigo postal CEP

country
required
string
Default: "BR"
Enum: "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"

Pais onde se localiza o endereço - Padrão ISO 3166-1 alpha-2

state
required
string

Estado onde se localiza o endereço

city
required
string

Cidade onde se localiza o endereço

district
required
string

Bairro onde se localiza o endereço

Response samples

Content type
application/json
{
}

Deletar customer pelo id

Authorizations:
X-Client-IDX-Api-Key
path Parameters
id
required
string <uuid>

id do customers que deseja deletar

Responses

Atualizar customer pelo id

Authorizations:
X-Client-IDX-Api-Key
path Parameters
id
required
string <uuid>

id do customers que deseja alterar

Request Body schema: application/json
name
string

nome do usuario

phoneNumber
string

telefone de contato do usuario

object
street
required
string

Nome da rua/avenida/travessa

streetNumber
required
string

Número onde se localiza o endereço

complement
string

Complemento onde se localiza o endereço, caso exista

zipCode
required
string

Codigo postal CEP

country
required
string
Default: "BR"
Enum: "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"

Pais onde se localiza o endereço - Padrão ISO 3166-1 alpha-2

state
required
string

Estado onde se localiza o endereço

city
required
string

Cidade onde se localiza o endereço

district
required
string

Bairro onde se localiza o endereço

Responses

Request samples

Content type
application/json
{
}

Adicionar cartão de crédito ao customer

Authorizations:
X-Client-IDX-Api-Key
path Parameters
customer_id
required
string <uuid>

id do customers que deseja alterar

Request Body schema: application/json
cardId
required
string

Identificador do cartão a ser associado

Responses

Request samples

Content type
application/json
{
}

Listagem dos cartões do customer

Authorizations:
X-Client-IDX-Api-Key
path Parameters
customer_id
required
string <uuid>

id do customers que deseja alterar

Responses

Response Schema: application/json
object
itemCount
integer

quantidade de itens na página

totalItems
integer

quantidade total de itens na consulta

itemsPerPage
integer

quantidade de itens por página

totalPages
integer

quantidade total de páginas

currentPage
integer

página atual

items
array

Response samples

Content type
application/json
{
}

Charges

Para realizar uma cobrança deve criar um objeto charge. É possível recuperar detalhes de transações individuais ou listar todas as cobranças realizadas em um determinado merchant. Os charges são identificados a partir de um id 'único'.

Dados básicos de um objeto do tipo charge

id
string

identificador da transação

clientId
string <uuid>

identificador do cliente na Malga

merchantId
string <uuid>

identificador do merchant id utilizado na transação

customerId
string <uuid>

identificador do customer id

description
string

Descrição da cobrança para consulta futura

amount
number

valor da transação em centavos, exemplo 100 para cobrar R$ 1,00

currency
string
Default: "BRL"

Identificador da moeda para processamento da cobrança, formato ISO 4217.

statementDescriptor
string

descrição a ser exibida na fatura do comprador

capture
boolean

determina se a transação deve ser capturada automaticamente

isDispute
boolean

determina se a transação está em disputa

status
string
Enum: "pending" "pre_authorized" "authorized" "failed" "canceled" "voided" "refund_pending" "charged_back"

status da transação na Malga

orderId
string

Identificador único da cobrança do lado do cliente para conciliação futura

PaymentMethodCardObject (object) or PaymentMethodPixObject (object) or PaymentMethodBoletoObject (object) or PaymentMethodNuPayObject (object) or PaymentMethodDripObject (object) or PaymentMethodVoucherObject (object)
One of
paymentType
required
string
Enum: "credit" "debit"

método da cobrança via Cartão Crédito/Débito

installments
number

quantidade de parcelas para cobrança do tipo credito

SourceTypeCardObject (object) or SourceTypeTokenObject (object) or SourceTypeCustomerObject (object)
One of
sourceType
required
string
Value: "card"

tipo da origem da cobrança

cardId
required
string <uuid>

Identificador do cartão quando source tipo card

createdAt
string

Data de criação do cartão

updatedAt
string

Data de atualização do cartão

object

Parâmetros adicionais para analise de fraude

sla
number

Valor em Minutos de SLA máximo de Análise do Pedido, se houver

object

Dados do comprador

name
string

Nome do usuario

email
string

E-mail do usuario

phone
string

Telefone de contato do usuario

identityType
string

Tipo de documento, consultar tabela de tipos suportados

identity
string

Número do documento formato conforme tipo selecionado

registrationDate
string

Data de registro do cliente

object

Endereço de entrega

object

Endereço de cobrança

object

Detalhe do carrinho de produtos

Array of objects[ items ]
Array
name
string

nome do item/evento

quantity
integer

quantidade de itens do pedido

sku
string

identificador único do item na loja

unitPrice
integer

valor unitário do item/evento em centavos

risk
string
Enum: "High" "Low"

definição do indice de risco do item

description
string

Descrição do item/evento

categoryId
string

Categoria a qual o item/evento pertence

locality
string

Definição de local, em caso de evento

date
string

Definição de data, em caso de evento

type
number

Definição de tipo, em caso de evento

genre
string

Definição do gênero, em caso de evento

object

Informações relacionadas aos ingressos, em caso de evento

object

Definição de endereço, em caso de evento

object

Campos adicionais para uso em condicionais dos fluxos inteligentes

metadata
required
object

Campos adicionais da transação enviados na criação da mesma

Array of objects (TransactionRequest) [ items ]
Array
id
string

identificador único do request feito ao provedor

providerId
string <uuid>

identificador do provider que processou a requisiçao, consulte a lista de providers configurados na sua conta

providerType
string

código que identifica o provedor, consultar tabela de provedores suportados pela Malga

idempotencyKey
string

chave única de referência gerada pela Malga para cada requisição, utilizada para garantir idempotência e evitar duplicidade no provedor, pode ser também consultada na API ou dashboard do provedor como orderId ou referenceKey no provedor.

authorizationNsu
string
Deprecated

identificador único da transação retornado pelo provider

transactionId
string

identificador único da transação retornado pelo provider, txId, pode ser usado para recuperar a transação nas APIs ou dashboard do provedor

requestType
string
Enum: "pending" "authorization" "pre_authorization" "void" "capture" "probe" "charge_back" "zero_dollar" "anti_fraud"

identifica o tipo da requisição feita para o provider

requestStatus
string
Enum: "running" "failed" "success" "timeout" "internal_error" "processing"

status do processamento da requisição no provider

amount
number

valor da transação enviada para processamento do provider, em casos de estorno ou captura parcial o valor pode ser diferente do amount original da transação

responseTs
string

tempo de duração do processamento da requisição no provider

object

detalhes do erro em caso de falha no processamento da transação

object

dados adicionais do retorno da autorização do provider no processamento da transação

createdAt
string

Data de criação do request feito ao provedor

updatedAt
string

Data de atualização do request feito ao provedor

object (3DSecure2Response)
redirectURL
string

URL para redirecionamento de autenticação

requestorURL
string

URL de origem da requisição

object

Informações sobre o navegador do usuário

acceptHeader
string

O Accept do cabeçalho de requisição HTTP

colorDepth
number

A profundidade de cores da tela

javaEnabled
boolean

Se Java está habilitado

javaScriptEnabled
boolean

Se javaScript está habilitado

language
string

A linguagem utilizada pelo sistema do usuário

screenHeight
number

Altura da tela

screenWidth
number

Largura da tela

timeZoneOffset
string

Diferença em minutos do deslocamento de fuso horário entre o UTC e a localidade atual

userAgent
string

O User-Agent do cabeçalho de requisição HTTP

ip
string

Endereço de ip do usuário

object

Endereço de cobrança

city
string

Cidade

country
string

Padrão ISO 3166-1 alpha-2

streetNumber
string

Número da rua

zipCode
string

Codigo postal CEP

state
string

Estado

street
string

Rua

object

Endereço para envio

city
string

Cidade

country
string

Padrão ISO 3166-1 alpha-2

streetNumber
string

Número da rua

zipCode
string

Codigo postal CEP

state
string

Estado

street
string

Rua

object

Endereço para envio

email
string

Email

mobilePhone
string

Telefone celular

object

Dados de autenticação do provedor

action
string
Value: "REDIRECT"

Tipo de ação exigida pelo provedor

providerType
string
Value: "ADYEN"

Nome do provedor

responseType
string
Enum: "AUTHENTICATION" "AUTHORIZATION"

Identifica a etapa do desafio

response
object

O object retornado do provedor com dados para autenticação ou autorização

object

Informações sobre a rastreabilidade da cobrança

object

Informações sobre produto das transações (checkout-sdk, vtex, magento, etc..)

integrator
string

Nome do parceiro que implementou a integração

name
required
string

Nome do produto

version
required
string

Versão do produto

object

Informações sobre o dispositivo (ios, android, windows, linux)

name
required
string

Nome do sistema operacional

version
required
string

Versão do sistema operacional

object

Informações sobre o sistema proprietário de captura do merchant

name
required
string

Nome da empresa e/ou plataforma

version
required
string

Versão do software da plataforma

{
}

Realizar nova cobrança

Authorizations:
X-Client-IDX-Api-Key
Request Body schema: application/json
merchantId
required
string <uuid>

Identificação do merchant id a ser utilizado

amount
required
number

Valor da transação em centavos, exemplo 100 para cobrar R$ 1,00

currency
string
Default: "BRL"

Identificador da moeda para processamento da cobrança, formato ISO 4217.

statementDescriptor
string

Descrição a ser exibida fatura do comprador

capture
boolean
Default: false

Determina se a transação deve ser capturada automaticamente

orderId
string

Identificador único da cobrança do lado do cliente para conciliação futura

description
string

Descrição da cobrança para consulta futura

customerId
string <uuid>

Identificador de comprador para consulta futura

required
PaymentMethodCard (object) or PaymentMethodPix (object) or PaymentMethodBoleto (object) or PaymentMethodNuPay (object) or PaymentMethodDrip (object) or PaymentMethodVoucher (object)

Define o método de cobrança

One of
paymentType
required
string
Enum: "credit" "debit" "voucher"

Método da cobrança via Cartão Crédito/Débito/Voucher

installments
number

Quantidade de parcelas para cobrança do tipo credito

required
SourceTypeCard (object) or SourceTypeCardOneShot (object) or SourceTypeToken (object) or SourceTypeCustomer (object) or SourceTypeCustomerOneShot (object) or SourceTypeCardCvv (object)
One of
sourceType
required
string
Value: "card"

Tipo da origem da cobrança, usar card para cobrança em cartão tokenizado

cardId
required
string <uuid>

Identificador do cartão quando source tipo card

cardCvv
string

Código de verificação cobrança sem tokenização, deve ser enviado sempre que o comprador estiver presente no momento da compra (opcional)

object

Parâmetros adicionais para analise de fraude, obrigatório quando anti-fraude ligado.

sla
number

Valor em Minutos de SLA máximo de Análise do Pedido, se houver

object

Dados do comprador

name
string

nome do usuario

email
string

email do usuario

phone
string

telefone de contato do usuario

identityType
string

Tipo de documento, consultar tabela de tipos suportados

identity
string

Número do documento formato conforme tipo selecionado

registrationDate
string

Data de registro do cliente

object

Endereço de entrega

object

Endereço de cobrança

object

Informações sobre o navegador do usuário

object

Detalhe do carrinho de produtos

Array of objects[ items ]
Array
name
string

nome do item/evento

quantity
integer

quantidade de itens do pedido

sku
string

identificador único do item na loja

unitPrice
integer

valor unitário do item/evento em centavos

risk
string
Enum: "High" "Low"

definição do indice de risco do item

description
string

Descrição do item/evento

categoryId
string

Categoria a qual o item/evento pertence

locality
string

Definição de local, em caso de evento

date
string

Definição de data, em caso de evento

type
number

Definição de tipo, em caso de evento

genre
string

Definição de gênero, em caso de evento

object

Informações relacionadas aos ingressos, em caso de evento

object

Definição de endereço, em caso de evento

object

Detalhes do aparelho do consumidor

object
model
string

modelo do aparelho

ramCapacity
integer

capacidade da memória RAM do aparelho

diskCapacity
integer

capacidade de armazenamento do aparelho

freeDiskSpace
integer

quantidade de memória livre

resolution
integer

resolução do aparelho

Array of objects[ items ]
object

atributos do aparelho fornecidos pelo fornecedor

Array of objects (SplitRules) [ items ]

Parâmetros adicionais para transacionar com Split

Array
sellerId
string <uuid>

identificador do recebedor já cadastrado na API de sellers

percentage
number

porcentagem do valor da transação que será enviada ao recebedor

amount
number

valor que será enviada ao recebedor

processingFee
boolean

indica se o recebedor vinculado à regra será cobrado pelas taxas da transação

liable
boolean

indica se o recebedor atrelado assumirá os riscos de chargeback da transação

object (SplitRulesFaresSchema)

Informações sobre as taxas que serão cobradas do recebedor - Apenas para sellers com provedor Braspag

object

Campos adicionais para uso em condicionais dos fluxos inteligentes

metadata
required
object

Campos adicionais da transação enviados na criação da mesma

object

Parâmetros adicionais para transacionar com 3D Secure 2

redirectURL
required
string

URL para redirecionamento de autenticação

requestorURL
required
string

URL de origem da requisição

required
object

Informações sobre o navegador do usuário

acceptHeader
required
string

O Accept do cabeçalho de requisição HTTP

colorDepth
required
number

A profundidade de cores da tela

javaEnabled
required
boolean

Se Java está habilitado

javaScriptEnabled
boolean

Se javaScript está habilitado

language
required
string

A linguagem utilizada pelo sistema do usuário

screenHeight
required
number

Altura da tela

screenWidth
required
number

Largura da tela

timeZoneOffset
required
string

Diferença em minutos do deslocamento de fuso horário entre o UTC e a localidade atual

userAgent
required
string

O User-Agent do cabeçalho de requisição HTTP

ip
required
string

Endereço de ip do usuário

object

Endereço de cobrança

city
required
string

Cidade

country
required
string

Padrão ISO 3166-1 alpha-2

streetNumber
required
string

Número da rua

zipCode
required
string

Codigo postal CEP

state
required
string

Estado

street
required
string

Rua

object

Endereço para envio

city
required
string

Cidade

country
required
string

Padrão ISO 3166-1 alpha-2

streetNumber
required
string

Número da rua

zipCode
required
string

Codigo postal CEP

state
required
string

Estado

street
required
string

Rua

object

Endereço para envio

email
required
string

Email

mobilePhone
string

Telefone celular

object

Informações sobre a rastreabilidade da cobrança

object

Informações sobre produto das transações (checkout-sdk, vtex, magento, etc..)

integrator
string

Nome do parceiro que implementou a integração

name
required
string

Nome do produto

version
required
string

Versão do produto

object

Informações sobre o dispositivo (ios, android, windows, linux)

name
required
string

Nome do sistema operacional

version
required
string

Versão do sistema operacional

object

Informações sobre o sistema proprietário de captura do merchant

name
required
string

Nome da empresa e/ou plataforma

version
required
string

Versão do software da plataforma

Responses

Request samples

Content type
application/json
Example
Exemplo cobrança Cartão
Exemplo cobrança Cartão
Exemplo cobrança PIX
Exemplo cobrança Boleto
Exemplo cobrança Cartão e Split
Exemplo cobrança Cartão e 3D Secure 2
Exemplo cobrança Nupay
Exemplo cobrança Drip
{
}

Response samples

Content type
application/json
Example
Exemplo resposta cobrança por cartão
Exemplo resposta cobrança por cartão
Exemplo resposta cobrança PIX
Exemplo resposta cobrança Boleto
Exemplo resposta cobrança Cartão e Split
Exemplo resposta cobrança por cartão 3D Secure 2
Exemplo resposta cobrança nupay
Exemplo resposta cobrança Drip
{
}

Listar cobranças

Authorizations:
X-Client-IDX-Api-Key
query Parameters
page
number

numero da pagina ativa

limit
number

quantidade de registros por página 1-100

sort
string
Enum: "ASC" "DESC"

tipo de ordenação decrescente ou crescente

merchantId
string <uuid>

id do merchant processado na cobrança

id
string <uuid>

id da cobrança

originalAmount
number

valor em centavos da cobrança

status
string
Enum: "pending" "pre_authorized" "authorized" "voided" "refund_pending" "canceled" "charged_back"

status da cobrança

paymentType
string
Enum: "credit" "pix" "boleto"

tipo de pagamento

orderId
string

id da cobrança gerado pelo cliente

created
string
Example: created=2022-03-12T12:43:53

registros criados em uma data específica

created.gt
string
Example: created.gt=2022-03-12T12:43:53

registros com data maior que

created.lt
string
Example: created.lt=2022-03-12T12:43:53

registros com data menor que

Responses

Response Schema: application/json
object
itemCount
integer

quantidade de itens na página

totalItems
integer

quantidade total de itens na consulta

itemsPerPage
integer

quantidade de itens por página

totalPages
integer

quantidade total de páginas

currentPage
integer

página atual

items
array

Response samples

Content type
application/json
{
}

Recuperar detalhes de cobrança

Authorizations:
X-Client-IDX-Api-Key
path Parameters
id
required
string <uuid>

id da cobrança que deseja recuperar

Responses

Response Schema: application/json
object
itemCount
integer

quantidade de itens na página

totalItems
integer

quantidade total de itens na consulta

itemsPerPage
integer

quantidade de itens por página

totalPages
integer

quantidade total de páginas

currentPage
integer

página atual

items
array

Response samples

Content type
application/json
{
}

Alterar o status de uma cobrança no ambiente de sandbox

Authorizations:
X-Client-IDX-Api-Key
path Parameters
id
required
string <uuid>

id da cobrança que deseja alterar no sandbox

Request Body schema: application/json
status
string
Enum: "pending" "pre_authorized" "authorized" "failed" "canceled" "voided" "charged_back" "created" "processed" "capture_pending" "refund_pending"

status da transação

Responses

Response Schema: application/json
id
string

identificador da transação

clientId
string <uuid>

identificador do cliente na Malga

merchantId
string <uuid>

identificador do merchant id utilizado na transação

customerId
string <uuid>

identificador do customer id

description
string

Descrição da cobrança para consulta futura

amount
number

valor da transação em centavos, exemplo 100 para cobrar R$ 1,00

currency
string
Default: "BRL"

Identificador da moeda para processamento da cobrança, formato ISO 4217.

statementDescriptor
string

descrição a ser exibida na fatura do comprador

capture
boolean

determina se a transação deve ser capturada automaticamente

isDispute
boolean

determina se a transação está em disputa

status
string
Enum: "pending" "pre_authorized" "authorized" "failed" "canceled" "voided" "refund_pending" "charged_back"

status da transação na Malga

orderId
string

Identificador único da cobrança do lado do cliente para conciliação futura

PaymentMethodCardObject (object) or PaymentMethodPixObject (object) or PaymentMethodBoletoObject (object) or PaymentMethodNuPayObject (object) or PaymentMethodDripObject (object) or PaymentMethodVoucherObject (object)
One of
paymentType
required
string
Enum: "credit" "debit"

método da cobrança via Cartão Crédito/Débito

installments
number

quantidade de parcelas para cobrança do tipo credito

SourceTypeCardObject (object) or SourceTypeTokenObject (object) or SourceTypeCustomerObject (object)
One of
sourceType
required
string
Value: "card"

tipo da origem da cobrança

cardId
required
string <uuid>

Identificador do cartão quando source tipo card

createdAt
string

Data de criação do cartão

updatedAt
string

Data de atualização do cartão

object

Parâmetros adicionais para analise de fraude

sla
number

Valor em Minutos de SLA máximo de Análise do Pedido, se houver

object

Dados do comprador

name
string

Nome do usuario

email
string

E-mail do usuario

phone
string

Telefone de contato do usuario

identityType
string

Tipo de documento, consultar tabela de tipos suportados

identity
string

Número do documento formato conforme tipo selecionado

registrationDate
string

Data de registro do cliente

object

Endereço de entrega

object

Endereço de cobrança

object

Detalhe do carrinho de produtos

Array of objects[ items ]
Array
name
string

nome do item/evento

quantity
integer

quantidade de itens do pedido

sku
string

identificador único do item na loja

unitPrice
integer

valor unitário do item/evento em centavos

risk
string
Enum: "High" "Low"

definição do indice de risco do item

description
string

Descrição do item/evento

categoryId
string

Categoria a qual o item/evento pertence

locality
string

Definição de local, em caso de evento

date
string

Definição de data, em caso de evento

type
number

Definição de tipo, em caso de evento

genre
string

Definição do gênero, em caso de evento

object

Informações relacionadas aos ingressos, em caso de evento

object

Definição de endereço, em caso de evento

object

Campos adicionais para uso em condicionais dos fluxos inteligentes

metadata
required
object

Campos adicionais da transação enviados na criação da mesma

Array of objects (TransactionRequest) [ items ]
Array
id
string

identificador único do request feito ao provedor

providerId
string <uuid>

identificador do provider que processou a requisiçao, consulte a lista de providers configurados na sua conta

providerType
string

código que identifica o provedor, consultar tabela de provedores suportados pela Malga

idempotencyKey
string

chave única de referência gerada pela Malga para cada requisição, utilizada para garantir idempotência e evitar duplicidade no provedor, pode ser também consultada na API ou dashboard do provedor como orderId ou referenceKey no provedor.

authorizationNsu
string
Deprecated

identificador único da transação retornado pelo provider

transactionId
string

identificador único da transação retornado pelo provider, txId, pode ser usado para recuperar a transação nas APIs ou dashboard do provedor

requestType
string
Enum: "pending" "authorization" "pre_authorization" "void" "capture" "probe" "charge_back" "zero_dollar" "anti_fraud"

identifica o tipo da requisição feita para o provider

requestStatus
string
Enum: "running" "failed" "success" "timeout" "internal_error" "processing"

status do processamento da requisição no provider

amount
number

valor da transação enviada para processamento do provider, em casos de estorno ou captura parcial o valor pode ser diferente do amount original da transação

responseTs
string

tempo de duração do processamento da requisição no provider

object

detalhes do erro em caso de falha no processamento da transação

object

dados adicionais do retorno da autorização do provider no processamento da transação

createdAt
string

Data de criação do request feito ao provedor

updatedAt
string

Data de atualização do request feito ao provedor

object (3DSecure2Response)
redirectURL
string

URL para redirecionamento de autenticação

requestorURL
string

URL de origem da requisição

object

Informações sobre o navegador do usuário

acceptHeader
string

O Accept do cabeçalho de requisição HTTP

colorDepth
number

A profundidade de cores da tela

javaEnabled
boolean

Se Java está habilitado

javaScriptEnabled
boolean

Se javaScript está habilitado

language
string

A linguagem utilizada pelo sistema do usuário

screenHeight
number

Altura da tela

screenWidth
number

Largura da tela

timeZoneOffset
string

Diferença em minutos do deslocamento de fuso horário entre o UTC e a localidade atual

userAgent
string

O User-Agent do cabeçalho de requisição HTTP

ip
string

Endereço de ip do usuário

object

Endereço de cobrança

city
string

Cidade

country
string

Padrão ISO 3166-1 alpha-2

streetNumber
string

Número da rua

zipCode
string

Codigo postal CEP

state
string

Estado

street
string

Rua

object

Endereço para envio

city
string

Cidade

country
string

Padrão ISO 3166-1 alpha-2

streetNumber
string

Número da rua

zipCode
string

Codigo postal CEP

state
string

Estado

street
string

Rua

object

Endereço para envio

email
string

Email

mobilePhone
string

Telefone celular

object

Dados de autenticação do provedor

action
string
Value: "REDIRECT"

Tipo de ação exigida pelo provedor

providerType
string
Value: "ADYEN"

Nome do provedor

responseType
string
Enum: "AUTHENTICATION" "AUTHORIZATION"

Identifica a etapa do desafio

response
object

O object retornado do provedor com dados para autenticação ou autorização

object

Informações sobre a rastreabilidade da cobrança

object

Informações sobre produto das transações (checkout-sdk, vtex, magento, etc..)

integrator
string

Nome do parceiro que implementou a integração

name
required
string

Nome do produto

version
required
string

Versão do produto

object

Informações sobre o dispositivo (ios, android, windows, linux)

name
required
string

Nome do sistema operacional

version
required
string

Versão do sistema operacional

object

Informações sobre o sistema proprietário de captura do merchant

name
required
string

Nome da empresa e/ou plataforma

version
required
string

Versão do software da plataforma

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Alterar o status do antifraude no ambiente de sandbox

Authorizations:
X-Client-IDX-Api-Key
path Parameters
id
required
string <uuid>

id da cobrança que deseja alterar no sandbox

Request Body schema: application/json
status
string
Enum: "approved" "reproved" "failed"

status do antifraude

Responses

Response Schema: application/json
id
string

identificador da transação

clientId
string <uuid>

identificador do cliente na Malga

merchantId
string <uuid>

identificador do merchant id utilizado na transação

customerId
string <uuid>

identificador do customer id

description
string

Descrição da cobrança para consulta futura

amount
number

valor da transação em centavos, exemplo 100 para cobrar R$ 1,00

currency
string
Default: "BRL"

Identificador da moeda para processamento da cobrança, formato ISO 4217.

statementDescriptor
string

descrição a ser exibida na fatura do comprador

capture
boolean

determina se a transação deve ser capturada automaticamente

isDispute
boolean

determina se a transação está em disputa

status
string
Enum: "pending" "pre_authorized" "authorized" "failed" "canceled" "voided" "refund_pending" "charged_back"

status da transação na Malga

orderId
string

Identificador único da cobrança do lado do cliente para conciliação futura

PaymentMethodCardObject (object) or PaymentMethodPixObject (object) or PaymentMethodBoletoObject (object) or PaymentMethodNuPayObject (object) or PaymentMethodDripObject (object) or PaymentMethodVoucherObject (object)
One of
paymentType
required
string
Enum: "credit" "debit"

método da cobrança via Cartão Crédito/Débito

installments
number

quantidade de parcelas para cobrança do tipo credito

SourceTypeCardObject (object) or SourceTypeTokenObject (object) or SourceTypeCustomerObject (object)
One of
sourceType
required
string
Value: "card"

tipo da origem da cobrança

cardId
required
string <uuid>

Identificador do cartão quando source tipo card

createdAt
string

Data de criação do cartão

updatedAt
string

Data de atualização do cartão

object

Parâmetros adicionais para analise de fraude

sla
number

Valor em Minutos de SLA máximo de Análise do Pedido, se houver

object

Dados do comprador

name
string

Nome do usuario

email
string

E-mail do usuario

phone
string

Telefone de contato do usuario

identityType
string

Tipo de documento, consultar tabela de tipos suportados

identity
string

Número do documento formato conforme tipo selecionado

registrationDate
string

Data de registro do cliente

object

Endereço de entrega

object

Endereço de cobrança

object

Detalhe do carrinho de produtos

Array of objects[ items ]
Array
name
string

nome do item/evento

quantity
integer

quantidade de itens do pedido

sku
string

identificador único do item na loja

unitPrice
integer

valor unitário do item/evento em centavos

risk
string
Enum: "High" "Low"

definição do indice de risco do item

description
string

Descrição do item/evento

categoryId
string

Categoria a qual o item/evento pertence

locality
string

Definição de local, em caso de evento

date
string

Definição de data, em caso de evento

type
number

Definição de tipo, em caso de evento

genre
string

Definição do gênero, em caso de evento

object

Informações relacionadas aos ingressos, em caso de evento

object

Definição de endereço, em caso de evento

object

Campos adicionais para uso em condicionais dos fluxos inteligentes

metadata
required
object

Campos adicionais da transação enviados na criação da mesma

Array of objects (TransactionRequest) [ items ]
Array
id
string

identificador único do request feito ao provedor

providerId
string <uuid>

identificador do provider que processou a requisiçao, consulte a lista de providers configurados na sua conta

providerType
string

código que identifica o provedor, consultar tabela de provedores suportados pela Malga

idempotencyKey
string

chave única de referência gerada pela Malga para cada requisição, utilizada para garantir idempotência e evitar duplicidade no provedor, pode ser também consultada na API ou dashboard do provedor como orderId ou referenceKey no provedor.

authorizationNsu
string
Deprecated

identificador único da transação retornado pelo provider

transactionId
string

identificador único da transação retornado pelo provider, txId, pode ser usado para recuperar a transação nas APIs ou dashboard do provedor

requestType
string
Enum: "pending" "authorization" "pre_authorization" "void" "capture" "probe" "charge_back" "zero_dollar" "anti_fraud"

identifica o tipo da requisição feita para o provider

requestStatus
string
Enum: "running" "failed" "success" "timeout" "internal_error" "processing"

status do processamento da requisição no provider

amount
number

valor da transação enviada para processamento do provider, em casos de estorno ou captura parcial o valor pode ser diferente do amount original da transação

responseTs
string

tempo de duração do processamento da requisição no provider

object

detalhes do erro em caso de falha no processamento da transação

object

dados adicionais do retorno da autorização do provider no processamento da transação

createdAt
string

Data de criação do request feito ao provedor

updatedAt
string

Data de atualização do request feito ao provedor

object (3DSecure2Response)
redirectURL
string

URL para redirecionamento de autenticação

requestorURL
string

URL de origem da requisição

object

Informações sobre o navegador do usuário

acceptHeader
string

O Accept do cabeçalho de requisição HTTP

colorDepth
number

A profundidade de cores da tela

javaEnabled
boolean

Se Java está habilitado

javaScriptEnabled
boolean

Se javaScript está habilitado

language
string

A linguagem utilizada pelo sistema do usuário

screenHeight
number

Altura da tela

screenWidth
number

Largura da tela

timeZoneOffset
string

Diferença em minutos do deslocamento de fuso horário entre o UTC e a localidade atual

userAgent
string

O User-Agent do cabeçalho de requisição HTTP

ip
string

Endereço de ip do usuário

object

Endereço de cobrança

city
string

Cidade

country
string

Padrão ISO 3166-1 alpha-2

streetNumber
string

Número da rua

zipCode
string

Codigo postal CEP

state
string

Estado

street
string

Rua

object

Endereço para envio

city
string

Cidade

country
string

Padrão ISO 3166-1 alpha-2

streetNumber
string

Número da rua

zipCode
string

Codigo postal CEP

state
string

Estado

street
string

Rua

object

Endereço para envio

email
string

Email

mobilePhone
string

Telefone celular

object

Dados de autenticação do provedor

action
string
Value: "REDIRECT"

Tipo de ação exigida pelo provedor

providerType
string
Value: "ADYEN"

Nome do provedor

responseType
string
Enum: "AUTHENTICATION" "AUTHORIZATION"

Identifica a etapa do desafio

response
object

O object retornado do provedor com dados para autenticação ou autorização

object

Informações sobre a rastreabilidade da cobrança

object

Informações sobre produto das transações (checkout-sdk, vtex, magento, etc..)

integrator
string

Nome do parceiro que implementou a integração

name
required
string

Nome do produto

version
required
string

Versão do produto

object

Informações sobre o dispositivo (ios, android, windows, linux)

name
required
string

Nome do sistema operacional

version
required
string

Versão do sistema operacional

object

Informações sobre o sistema proprietário de captura do merchant

name
required
string

Nome da empresa e/ou plataforma

version
required
string

Versão do software da plataforma

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Capturar cobrança pre-autorizada

Authorizations:
X-Client-IDX-Api-Key
path Parameters
id
required
string <uuid>

id da cobrança que deseja capturar

Request Body schema: application/json
amount
number

valor da captura em centavos não podendo ser maior que o valor da transação, exemplo 100 para cobrar R$ 1,00

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Estornar cobrança aprovada

Authorizations:
X-Client-IDX-Api-Key
path Parameters
id
required
string <uuid>

id da cobrança que deseja estornar

Request Body schema: application/json
amount
number

valor do estorno em centavos não podendo ser maior que o valor da transação, exemplo 100 para cobrar R$ 1,00

delayToCompose
number

número de dias para compor o valor a ser estornado. Utilizado apenas pela NuPay.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Sessions

Através da API de sessões é possível criar um pedido, composto por itens, métodos de pagamento e outros atributos, que pode ser pago através de um endpoint ou integrado ao MalgaCheckout.

Fluxo de criação e de pagamento de uma sessão

  • Crie uma sessão informando os dados básicos necessários
  • Utilize a publicKey retornada na criação ou recuperada na rota de detalhes no X-Api-Key para autenticar o pagamento

Dados básicos de um objeto do tipo session

id
string

Identificação da sessão a ser utilizada

name
string

Nome que identifica a sessão

status
string
Enum: "created" "paid" "canceled" "voided"

Status da sessão

isActive
boolean

Determina se a sessão está ativa

clientId
string

Identificador do cliente na Malga

orderId
string

Identificador único da cobrança do lado do cliente para conciliação futura

amount
number

Valor da transação em centavos, exemplo 100 para cobrar R$ 1,00

currency
string

Identificador da moeda para processamento da cobrança, formato ISO 4217.

capture
boolean

Determina se a transação deve ser capturada automaticamente

merchantId
string

Identificação do merchant id a ser utilizado

dueDate
string

Data de expiração de uma sessão

description
string

Descrição da sessão

statementDescriptor
string

Descrição a ser exibida fatura do comprador

Array of objects (SessionItemObject) [ items ]

Itens do pedido

Array
name
string

Nome do item da sessão

description
string

Descrição do item da sessão

unitPrice
number

Preço unitário em centavos do item, exemplo 100 para cobrar R$ 1,00

quantity
number

Define a quantidade de itens

tangible
boolean

Determina se o item é tangível

paymentLink
string

Link para acessar o Link de Pagamento desta sessão

PaymentMethodCardObject (array) or PaymentMethodPixObject (array) or PaymentMethodBoletoObject (array) or PaymentMethodDripObjectRequest (array)

Métodos de pagamento disponíveis na sessão

One of
array
createdAt
string

Data de criação da sessão

updatedAt
string

Data da atualização da sessão

publicKey
string

Chave de acesso com escopo restrito, usada para pagar a sessão

{
}

Criar nova sessão

Authorizations:
X-Client-IDX-Api-Key
Request Body schema: application/json
orderId
string

Identificador único da cobrança do lado do cliente para conciliação futura

amount
required
number

Valor da transação em centavos, exemplo 100 para cobrar R$ 1,00

currency
string
Default: "BRL"

Identificador da moeda para processamento da cobrança, formato ISO 4217.

isActive
boolean

Determina se a sessão está ativa

capture
boolean

Determina se a transação deve ser capturada automaticamente

merchantId
required
string

Identificação do merchant id a ser utilizado

dueDate
required
string

Data de expiração de uma sessão

name
required
string

Nome que identifica a sessão

description
string

Descrição da sessão

statementDescriptor
string

Descrição a ser exibida fatura do comprador

createLink
boolean

Determina se a sessão terá um Link de Pagamento

required
PaymentMethodCardObject (object) or PaymentMethodPixObjectRequest (object) or PaymentMethodBoletoObjectRequest (object) or PaymentMethodDripObjectRequest (object)

Métodos de pagamento disponíveis na sessão

Any of
paymentType
required
string
Enum: "credit" "debit"

método da cobrança via Cartão Crédito/Débito

installments
number

quantidade de parcelas para cobrança do tipo credito

required
Array of objects (SessionItemObject) [ items ]

Itens do pedido

Array
name
string

Nome do item da sessão

description
string

Descrição do item da sessão

unitPrice
number

Preço unitário em centavos do item, exemplo 100 para cobrar R$ 1,00

quantity
number

Define a quantidade de itens

tangible
boolean

Determina se o item é tangível

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Recuperar detalhes de uma sessão

Authorizations:
X-Client-IDX-Api-Key
path Parameters
id
required
string <uuid>

Identificação da sessão a ser recuperada

Responses

Response samples

Content type
application/json
{
}

Atualizar o status de uma sessão

Authorizations:
X-Client-IDX-Api-Key
path Parameters
id
required
string <uuid>

Identificação da sessão a ser alterada

Responses

Response samples

Content type
application/json
{
}

Pagar uma sessão

Authorizations:
X-Client-IDX-Api-Key
path Parameters
id
required
string <uuid>

Identificação da sessão a ser paga

Request Body schema: application/json
customerId
string <uuid>

Identificador de comprador para consulta futura

required
PaymentMethodCard (object) or PaymentMethodPix (object) or PaymentMethodBoleto (object) or PaySessionPaymentMethodDripObjectRequest (object)

Define o método de cobrança

One of
paymentType
required
string
Enum: "credit" "debit" "voucher"

Método da cobrança via Cartão Crédito/Débito/Voucher

installments
number

Quantidade de parcelas para cobrança do tipo credito

required
SourceTypeCard (object) or SourceTypeCardOneShot (object) or SourceTypeToken (object) or SourceTypeCustomer (object) or SourceTypeCustomerOneShot (object)
One of
sourceType
required
string
Value: "card"

Tipo da origem da cobrança, usar card para cobrança em cartão tokenizado

cardId
required
string <uuid>

Identificador do cartão quando source tipo card

cardCvv
string

Código de verificação cobrança sem tokenização, deve ser enviado sempre que o comprador estiver presente no momento da compra (opcional)

object

Parâmetros adicionais para analise de fraude, obrigatório quando anti-fraude ligado.

sla
number

Valor em Minutos de SLA máximo de Análise do Pedido, se houver

object

Dados do comprador

name
string

nome do usuario

email
string

email do usuario

phone
string

telefone de contato do usuario

identityType
string

Tipo de documento, consultar tabela de tipos suportados

identity
string

Número do documento formato conforme tipo selecionado

registrationDate
string

Data de registro do cliente

object

Endereço de entrega

object

Endereço de cobrança

object

Informações sobre o navegador do usuário

object

Detalhe do carrinho de produtos

Array of objects[ items ]
Array
name
string

nome do item/evento

quantity
integer

quantidade de itens do pedido

sku
string

identificador único do item na loja

unitPrice
integer

valor unitário do item/evento em centavos

risk
string
Enum: "High" "Low"

definição do indice de risco do item

description
string

Descrição do item/evento

categoryId
string

Categoria a qual o item/evento pertence

locality
string

Definição de local, em caso de evento

date
string

Definição de data, em caso de evento

type
number

Definição de tipo, em caso de evento

genre
string

Definição de gênero, em caso de evento

object

Informações relacionadas aos ingressos, em caso de evento

object

Definição de endereço, em caso de evento

object

Detalhes do aparelho do consumidor

object
model
string

modelo do aparelho

ramCapacity
integer

capacidade da memória RAM do aparelho

diskCapacity
integer

capacidade de armazenamento do aparelho

freeDiskSpace
integer

quantidade de memória livre

resolution
integer

resolução do aparelho

Array of objects[ items ]
object

atributos do aparelho fornecidos pelo fornecedor

Responses

Request samples

Content type
application/json
Example
Exemplo cobrança Cartão
Exemplo cobrança Cartão
Exemplo cobrança Pix
Exemplo cobrança Drip
Exemplo cobrança Boleto
4
{
}

Response samples

Content type
application/json
Example
Exemplo resposta cobrança por cartão
Exemplo resposta cobrança por cartão
Exemplo resposta cobrança PIX
Exemplo resposta cobrança Drip
Exemplo resposta cobrança Boleto
{
}

Cancelar uma sessão

Authorizations:
X-Client-IDX-Api-Key
path Parameters
id
required
string <uuid>

Identificação da sessão a ser cancelada

Responses

Response samples

Content type
application/json
{
}

Recuperar o histórico da sessão

Authorizations:
X-Client-IDX-Api-Key
path Parameters
id
required
string <uuid>

Identificação da sessão a ser recuperada

Responses

Response samples

Content type
application/json
[
]

Recupera sessão com os dados das configurações da empresa

Authorizations:
X-Client-IDX-Api-Key
path Parameters
id
required
string <uuid>

Identificação da sessão a ser recuperada

Responses

Response samples

Content type
application/json
{
}

Sellers

Para realizar uma cobrança com Split, antes é necessário criar um seller. Os sellers são identificados a partir de um id 'único'.

Através das APIs de sellers é possível realizar a criação e configuração de recebedores que serão beneficiados em um Split. Uma recebedor, ou um seller, é um cadastro de pessoa física ou jurídica para quem você tenha interesse em repassar automaticamente valores de uma determinada cobrança.

Observe que os campos owner e business são opcionais. Entretanto se o provider for Zoop e o campo business for enviado, o owner se torna obrigatório.

merchantId
required
string

identificação do merchant id a ser utilizado

mcc
required
number

código de segmento do lojista no adquirente, solicite ao seu provedor caso não saiba qual o seu Merchant Category Code.

object
name
required
string

Nome do estabelecimento do recebedor

phoneNumber
required
string

Telefone de contato do estabelecimento do recebedor

email
required
string

E-mail do estabelecimento do recebedor

website
string

Site do estabelecimento do recebedor

description
required
string

Descrição do estabelecimento do recebedor

facebook
string

Facebook do estabelecimento do recebedor

twitter
string

Twitter do estabelecimento do recebedor

openingDate
required
string

Data de abertura do estabelecimento do recebedor em ISO-Date, ex 2017-01-31

required
object
street
required
string

Nome da rua/avenida/travessa

streetNumber
required
string

Número onde se localiza o endereço

complement
string

Complemento onde se localiza o endereço, caso exista

zipCode
required
string

Codigo postal CEP

country
required
string
Default: "BR"
Enum: "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"

Pais onde se localiza o endereço - Padrão ISO 3166-1 alpha-2

state
required
string

Estado onde se localiza o endereço

city
required
string

Cidade onde se localiza o endereço

district
required
string

Bairro onde se localiza o endereço

required
object
type
required
string

Tipo de documento, consultar tabela de tipos suportados

number
required
string

Número do documento formato conforme tipo selecionado

country
string
Default: "BR"
Enum: "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"

Pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados

object
name
required
string

Nome do recebedor

email
required
string

E-mail do recebedor

phoneNumber
required
string

Telefone de contato do recebedor

birthdate
required
string

Data de nascimento do recebedor em ISO-Date, ex 1996-01-31

required
object
type
required
string

Tipo de documento, consultar tabela de tipos suportados

number
required
string

Número do documento formato conforme tipo selecionado

country
string
Default: "BR"
Enum: "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"

Pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados

required
object
street
required
string

Nome da rua/avenida/travessa

streetNumber
required
string

Número onde se localiza o endereço

complement
string

Complemento onde se localiza o endereço, caso exista

zipCode
required
string

Codigo postal CEP

country
required
string
Default: "BR"
Enum: "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"

Pais onde se localiza o endereço - Padrão ISO 3166-1 alpha-2

state
required
string

Estado onde se localiza o endereço

city
required
string

Cidade onde se localiza o endereço

district
required
string

Bairro onde se localiza o endereço

required
object
holderName
required
string

Nome de identificador do portador da conta bancária

holdeType
string
Enum: "individual" "company"

identifica se é pessoa física ou jurídica. aceita os valores 'individual' ou 'company'

holderDocument
required
string

Documento do portador da conta bancária

bank
required
string

Código do banco

branchNumber
required
string

Número da agência bancária

branchCheckDigit
string

Código verificador da agência bancária

accountNumber
required
string

Número da conta bancária

accountCheckDigit
string

Número verificador da conta bancária

type
required
string
Enum: "conta_corrente" "conta_poupanca" "conta_corrente_conjunta" "conta_poupanca_conjunta"

Tipo de conta

required
object
transferDay
required
string

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.

transferEnabled
required
boolean

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

transferInterval
required
string
Enum: "daily" "weekly" "monthly"

Intervalo entre as transferências.

automaticAnticipationEnabled
boolean

Indica 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

{
}

Criação de um novo recebedor

Authorizations:
X-Client-IDX-Api-Key
Request Body schema: application/json
merchantId
string

Identificação do merchant

object
name
required
string

Nome do recebedor

email
required
string

E-mail do recebedor

phoneNumber
required
string

Telefone de contato do recebedor

birthdate
required
string

Data de nascimento do recebedor em ISO-Date, ex 1996-01-31

required
object
type
required
string

Tipo de documento, consultar tabela de tipos suportados

number
required
string

Número do documento formato conforme tipo selecionado

country
string
Default: "BR"
Enum: "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"

Pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados

required
object
street
required
string

Nome da rua/avenida/travessa

streetNumber
required
string

Número onde se localiza o endereço

complement
string

Complemento onde se localiza o endereço, caso exista

zipCode
required
string

Codigo postal CEP

country
required
string
Default: "BR"
Enum: "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"

Pais onde se localiza o endereço - Padrão ISO 3166-1 alpha-2

state
required
string

Estado onde se localiza o endereço

city
required
string

Cidade onde se localiza o endereço

district
required
string

Bairro onde se localiza o endereço

object
name
required
string

Nome do estabelecimento do recebedor

phoneNumber
required
string

Telefone de contato do estabelecimento do recebedor

email
required
string

E-mail do estabelecimento do recebedor

website
string

Site do estabelecimento do recebedor

description
required
string

Descrição do estabelecimento do recebedor

facebook
string

Facebook do estabelecimento do recebedor

twitter
string

Twitter do estabelecimento do recebedor

openingDate
required
string

Data de abertura do estabelecimento do recebedor em ISO-Date, ex 2017-01-31

required
object
street
required
string

Nome da rua/avenida/travessa

streetNumber
required
string

Número onde se localiza o endereço

complement
string

Complemento onde se localiza o endereço, caso exista

zipCode
required
string

Codigo postal CEP

country
required
string
Default: "BR"
Enum: "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"

Pais onde se localiza o endereço - Padrão ISO 3166-1 alpha-2

state
required
string

Estado onde se localiza o endereço

city
required
string

Cidade onde se localiza o endereço

district
required
string

Bairro onde se localiza o endereço

required
object
type
required
string

Tipo de documento, consultar tabela de tipos suportados

number
required
string

Número do documento formato conforme tipo selecionado

country
string
Default: "BR"
Enum: "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"

Pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados

mcc
string

Código de segmento do lojista no adquirente

object
holderName
required
string

Nome de identificador do portador da conta bancária

holdeType
string
Enum: "individual" "company"

identifica se é pessoa física ou jurídica. aceita os valores 'individual' ou 'company'

holderDocument
required
string

Documento do portador da conta bancária

bank
required
string

Código do banco

branchNumber
required
string

Número da agência bancária

branchCheckDigit
string

Código verificador da agência bancária

accountNumber
required
string

Número da conta bancária

accountCheckDigit
string

Número verificador da conta bancária

type
required
string
Enum: "conta_corrente" "conta_poupanca" "conta_corrente_conjunta" "conta_poupanca_conjunta"

Tipo de conta

object
key
string

Identificador da informação adicional

value
string

Descritivo da informação adicional

object
transferDay
required
string

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.

transferEnabled
required
boolean

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

transferInterval
required
string
Enum: "daily" "weekly" "monthly"

Intervalo entre as transferências.

automaticAnticipationEnabled
boolean

Indica 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

Responses

Request samples

Content type
application/json
Example
Exemplo de recebedor pessoa jurídica
Exemplo de recebedor pessoa jurídica
Exemplo de recebedor pessoa física
{
}

Response samples

Content type
application/json
Example
Exemplo resposta seller pessoa jurídica
Exemplo resposta seller pessoa jurídica
Exemplo resposta seller pessoa física
{
}

Consultar um recebedor pelo ID

Authorizations:
X-Client-IDX-Api-Key
path Parameters
id
required
string <uuid>

Identificador do seller

Responses

Response Schema: application/json
merchantId
string

Identificação do merchant

object
name
required
string

Nome do recebedor

email
required
string

E-mail do recebedor

phoneNumber
required
string

Telefone de contato do recebedor

birthdate
required
string

Data de nascimento do recebedor em ISO-Date, ex 1996-01-31

required
object
type
required
string

Tipo de documento, consultar tabela de tipos suportados

number
required
string

Número do documento formato conforme tipo selecionado

country
string
Default: "BR"
Enum: "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"

Pais de emissão do documento, Padrão ISO 3166-1 alpha-2, consultar tabela de tipos suportados

required
object
street
required
string

Nome da rua/avenida/travessa

streetNumber
required
string

Número onde se localiza o endereço

complement
string

Complemento onde se localiza o endereço, caso exista

zipCode
required
string

Codigo postal CEP

country
required
string
Default: "BR"
Enum: "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"

Pais onde se localiza o endereço - Padrão ISO 3166-1 alpha-2

state
required
string

Estado onde se localiza o endereço

city
required
string

Cidade onde se localiza o endereço

district
required
string

Bairro onde se localiza o endereço

object
name
required
string

Nome do estabelecimento do recebedor

phoneNumber
required
string

Telefone de contato do estabelecimento do recebedor

email
required
string

E-mail do estabelecimento do recebedor

website
string

Site do estabelecimento do recebedor

description
required
string

Descrição do estabelecimento do recebedor

facebook
string

Facebook do estabelecimento do recebedor

twitter
string

Twitter do estabelecimento do recebedor

openingDate
required
string

Data de abertura do estabelecimento do recebedor em ISO-Date, ex 2017-01-31

required
object
street
required
string

Nome da rua/avenida/travessa

streetNumber
required
string

Número onde se localiza o endereço

complement
string

Complemento onde se localiza o endereço, caso exista

zipCode
required
string

Codigo postal CEP

country
required
string
Default: "BR"
Enum: "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"