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

{"scope": "customers",
"expires": 0
}

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

{"scope": "customers",
"expires": 0,
"clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
"publicKey": "29f62ed2-b67a-44ba-84f5-217ecee94438"
}

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

Payload

Content type

application/json

{"scope": ["tokens"
],
"expires": 31104000
}

Response samples

Content type

application/json

{"clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
"publicKey": "<YOUR_PUBLIC_KEY>",
"scope": ["tokens"
],
"expires": 31104000,
"createdAt": "20200110 00:00:00"
}

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

{"cardHolderName": "JOSE DAS NEVES",
"cardNumber": "4019598346009339",
"cardCvv": "123",
"cardExpirationDate": "12/2026"
}

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

Payload
Python

Content type

application/json

Example

{"cardHolderName": "JOSE DAS NEVES",
"cardNumber": "4019598346009339",
"cardCvv": "123",
"cardExpirationDate": "12/2026"
}

Response samples

Content type

application/json

{"tokenId": "cc0b1e41-2936-45c5-947f-93995ffcdc00"
}

Cards

Dados básicos de um objeto cartão

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

string

identificador do customer

createdAt

string

data de criação

clientId

string <uuid>

identificador do client

name

string

nome do usuario

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

{"id": "string",
"expirationMonth": "string",
"expirationYear": "string",
"brand": "American Express",
"cvvChecked": true,
"fingerprint": "string",
"first6digits": "string",
"last4digits": "string",
"status": "failed",
"statusReason": "string",
"createdAt": "string",
"updatedAt": "string",
"customer": {"id": "string",
"createdAt": "string",
"clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
"name": "string",
"email": "string",
"phoneNumber": "string",
"document": {"type": "string",
"number": "string",
"country": "AL"
},
"address": {"street": "string",
"streetNumber": "string",
"complement": "string",
"zipCode": "string",
"country": "AL",
"state": "string",
"city": "string",
"district": "string"
}
}
}

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

Payload
Python

Content type

application/json

{"tokenId": "82aba896-9e37-45b6-aa90-d510c9050596",
"merchantId": "cc4945bc-85f4-495e-adc6-3b281c9d957a",
"cvvCheck": true
}

Response samples

Content type

application/json

{"id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
"status": "active",
"statusReason": null,
"createdAt": "2012-08-11T19:02:56.713Z",
"clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
"brand": "Visa",
"cardHolderName": "JOAO DA SILVA",
"cvvChecked": true,
"fingerprint": "cbd4a441-c63c-4dee-ac6b-bfa7fa1df818",
"first6digits": "401959",
"last4digits": "9339",
"customerId": "82aba896-9e37-45b6-aa90-d510c9050596",
"expirationMonth": "12",
"expirationYear": "2026",
"transactionRequests": [{"id": "edd0d86a-76d0-4c2c-b924-1528510a5a32",
"createdAt": "2023-09-25T18:09:59.001Z",
"providerId": "5ce68ed3-2213-423b-8eaf-9d8c4b40df2b",
"providerType": "SANDBOX",
"requestStatus": "success",
"requestType": "zero_dollar",
"responseTs": "32ms"
}
]
}

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

{"meta": {"itemCount": 10,
"totalItems": 20,
"itemsPerPage": 10,
"totalPages": 5,
"currentPage": 2
},
"items": [{"id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
"customerId": "82aba896-9e37-45b6-aa90-d510c9050596",
"clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
"expirationMonth": "12",
"expirationYear": "2026",
"brand": "Visa",
"cvvChecked": true,
"fingerprint": "cbd4a441-c63c-4dee-ac6b-bfa7fa1df818",
"first6digits": "401959",
"last4digits": "9339",
"createdAt": "2012-06-30 23:59:59 +0000",
"status": "active"
}
]
}

Recuperar detalhes de cartão

Authorizations:

X-Client-IDX-Api-Key

path Parameters

required

string <uuid>

ID do cartão

Responses

Response Schema: application/json

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

string

identificador do customer

createdAt

string

data de criação

clientId

string <uuid>

identificador do client

name

string

nome do usuario

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

{"id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
"status": "active",
"statusReason": null,
"createdAt": "2012-08-11T19:02:56.713Z",
"clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
"brand": "Visa",
"cardHolderName": "JOAO DA SILVA",
"cvvChecked": true,
"fingerprint": "cbd4a441-c63c-4dee-ac6b-bfa7fa1df818",
"first6digits": "401959",
"last4digits": "9339",
"customerId": "82aba896-9e37-45b6-aa90-d510c9050596",
"expirationMonth": "12",
"expirationYear": "2026",
"transactionRequests": [{"id": "edd0d86a-76d0-4c2c-b924-1528510a5a32",
"createdAt": "2023-09-25T18:09:59.001Z",
"providerId": "5ce68ed3-2213-423b-8eaf-9d8c4b40df2b",
"providerType": "SANDBOX",
"requestStatus": "success",
"requestType": "zero_dollar",
"responseTs": "32ms"
}
]
}

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

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

Payload

Content type

application/json

{"name": "Customer test",
"email": "jose2@gmail.com",
"phoneNumber": "21 98889999099",
"document": {"number": "97055503019",
"type": "cpf",
"country": "BR"
},
"address": {"country": "BR",
"state": "Rio de Janeiro",
"city": "Rio de Janeiro",
"district": "Leblon",
"zipCode": "25650011",
"street": "Av Geraldo Cardoso",
"streetNumber": "205",
"complement": "Apto 203"
}
}

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

string

identificador do customer

createdAt

string

data de criação

clientId

string <uuid>

identificador do client

name

string

nome do usuario

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

{"meta": {"itemCount": 10,
"totalItems": 20,
"itemsPerPage": 10,
"totalPages": 5,
"currentPage": 2
},
"items": [{"id": "82aba896-9e37-45b6-aa90-d510c9050596",
"clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
"createdAt": "2012-06-30 23:59:59 +0000",
"name": "Customer test",
"email": "jose2@gmail.com",
"phoneNumber": "21 98889999099",
"document": {"number": "97055503019",
"type": "cpf",
"country": "BR"
},
"address": {"country": "BR",
"state": "Rio de Janeiro",
"city": "Rio de Janeiro",
"district": "Leblon",
"zipCode": "25650011",
"street": "Av Geraldo Cardoso",
"streetNumber": "205",
"complement": "Apto 203"
}
}
]
}

Recuperar detalhes de customer

Authorizations:

X-Client-IDX-Api-Key

path Parameters

required

string <uuid>

id do customers que deseja recuperar

Responses

Response Schema: application/json

string

identificador do customer

createdAt

string

data de criação

clientId

string <uuid>

identificador do client

name

string

nome do usuario

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

{"id": "82aba896-9e37-45b6-aa90-d510c9050596",
"clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
"createdAt": "2012-06-30 23:59:59 +0000",
"name": "Customer test",
"email": "jose2@gmail.com",
"document": {"number": "97055503019",
"type": "cpf",
"country": "BR"
},
"phoneNumber": "21 98889999099",
"address": {"country": "BR",
"state": "Rio de Janeiro",
"city": "Rio de Janeiro",
"district": "Leblon",
"zipCode": "25650011",
"street": "Av Geraldo Cardoso",
"streetNumber": "205",
"complement": "Apto 203"
}
}

Deletar customer pelo id

Authorizations:

X-Client-IDX-Api-Key

path Parameters

required

string <uuid>

id do customers que deseja deletar

Responses

Atualizar customer pelo id

Authorizations:

X-Client-IDX-Api-Key

path Parameters

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

Payload

Content type

application/json

{"name": "string",
"phoneNumber": "string",
"address": {"street": "string",
"streetNumber": "string",
"complement": "string",
"zipCode": "string",
"country": "AL",
"state": "string",
"city": "string",
"district": "string"
}
}

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

Payload

Content type

application/json

{"cardId": "82aba896-9e37-45b6-aa90-d510c9050596"
}

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

{"meta": {"itemCount": 10,
"totalItems": 20,
"itemsPerPage": 10,
"totalPages": 5,
"currentPage": 2
},
"items": [{"id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
"customerId": "82aba896-9e37-45b6-aa90-d510c9050596",
"clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
"expirationMonth": "12",
"expirationYear": "2026",
"brand": "Visa",
"cvvChecked": true,
"fingerprint": "cbd4a441-c63c-4dee-ac6b-bfa7fa1df818",
"first6digits": "401959",
"last4digits": "9339",
"createdAt": "2012-06-30 23:59:59 +0000",
"status": "active"
}
]
}

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

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

{"id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
"clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
"createdAt": "2012-06-30 23:59:59 +0000",
"amount": 150,
"currency": "BRL",
"orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
"statementDescriptor": "LOJA JOAO",
"description": "Descrição longa da cobrança",
"capture": false,
"isDispute": false,
"status": "pre_authorized",
"paymentMethod": {"paymentType": "credit",
"installments": 1
},
"paymentSource": {"sourceType": "card",
"cardId": "148d5db0-f1c3-439f-902d-f1f268086e1d"
},
"transactionRequests": [{"id": "78601913-a176-4d71-b7e8-abb6fc49a340",
"idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
"providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
"providerType": "STRIPE",
"transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
"amount": 1500,
"authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
"requestStatus": "success",
"requestType": "authorization",
"responseTs": "2633ms",
"createdAt": "2021-08-12T16:08:39.536Z",
"updatedAt": "2021-08-12T16:08:42.212Z",
"providerAuthorization": {"networkAuthorizationCode": "00",
"networkResponseCode": ""
}
}
],
"appInfo": {"platform": {"integrator": "malga",
"name": "pluging-vtex-ppp",
"version": "1.12"
},
"device": {"name": "iOS",
"version": "10.12"
},
"system": {"name": "VTEX",
"version": "13.12"
}
}
}

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

Payload

Content type

application/json

Example

{"appInfo": {"platform": {"integrator": "malga",
"name": "pluging-vtex-ppp",
"version": "1.12"
},
"device": {"name": "iOS",
"version": "10.12"
},
"system": {"name": "VTEX",
"version": "13.12"
}
},
"merchantId": "7f8870a2-71c9-4ef0-a531-82000e00b7e1",
"amount": 150,
"currency": "BRL",
"statementDescriptor": "LOJA JOAO",
"description": "Descrição longa da cobrança",
"capture": false,
"orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
"paymentMethod": {"paymentType": "credit",
"installments": 1
},
"paymentSource": {"sourceType": "card",
"card": {"cardNumber": "5261424250184574",
"cardCvv": "321",
"cardExpirationDate": "06/2028",
"cardHolderName": "JOAO DA SILVA"
}
}
}

Response samples

Content type

application/json

Example

{"id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
"clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
"createdAt": "2012-06-30 23:59:59 +0000",
"amount": 150,
"currency": "BRL",
"orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
"statementDescriptor": "LOJA JOAO",
"description": "Descrição longa da cobrança",
"capture": false,
"isDispute": false,
"status": "pre_authorized",
"paymentMethod": {"paymentType": "credit",
"installments": 1
},
"paymentSource": {"sourceType": "card",
"cardId": "148d5db0-f1c3-439f-902d-f1f268086e1d"
},
"transactionRequests": [{"id": "78601913-a176-4d71-b7e8-abb6fc49a340",
"idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
"providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
"providerType": "STRIPE",
"transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
"amount": 1500,
"authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
"requestStatus": "success",
"requestType": "authorization",
"responseTs": "2633ms",
"createdAt": "2021-08-12T16:08:39.536Z",
"updatedAt": "2021-08-12T16:08:42.212Z",
"providerAuthorization": {"networkAuthorizationCode": "00",
"networkResponseCode": ""
}
}
],
"appInfo": {"platform": {"integrator": "malga",
"name": "pluging-vtex-ppp",
"version": "1.12"
},
"device": {"name": "iOS",
"version": "10.12"
},
"system": {"name": "VTEX",
"version": "13.12"
}
}
}

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 (esse valor é cacheado por 5 minutos para melhorar a performance da API)
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

{"meta": {"itemCount": 10,
"totalItems": 20,
"itemsPerPage": 10,
"totalPages": 5,
"currentPage": 2
},
"items": [{"id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
"customerId": "82aba896-9e37-45b6-aa90-d510c9050596",
"clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
"createdAt": "2012-06-30 23:59:59 +0000",
"amount": 150,
"currency": "BRL",
"statementDescriptor": "LOJA JOAO",
"description": "Descrição longa da cobrança",
"capture": false,
"isDispute": false,
"orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
"paymentMethod": {"paymentType": "credit",
"installments": 1
},
"paymentSource": {"sourceType": "card",
"cardId": "148d5db0-f1c3-439f-902d-f1f268086e1d"
},
"transactionRequests": [{"id": "78601913-a176-4d71-b7e8-abb6fc49a340",
"idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
"providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
"providerType": "STRIPE",
"transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
"amount": 1500,
"authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
"requestStatus": "success",
"requestType": "authorization",
"responseTs": "2633ms",
"createdAt": "2021-08-12T16:08:39.536Z",
"updatedAt": "2021-08-12T16:08:42.212Z",
"providerAuthorization": {"networkAuthorizationCode": "00",
"networkResponseCode": ""
}
}
],
"appInfo": {"platform": {"integrator": "malga",
"name": "pluging-vtex-ppp",
"version": "1.12"
},
"device": {"name": "iOS",
"version": "10.12"
},
"system": {"name": "VTEX",
"version": "13.12"
}
}
}
]
}

Recuperar detalhes de cobrança

Authorizations:

X-Client-IDX-Api-Key

path Parameters

required

string <uuid>

id da cobrança que deseja recuperar

Responses

Response Schema: application/json

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

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

Response samples

Content type

application/json

{"id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
"clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
"createdAt": "2012-06-30 23:59:59 +0000",
"amount": 150,
"currency": "BRL",
"orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
"statementDescriptor": "LOJA JOAO",
"description": "Descrição longa da cobrança",
"capture": false,
"isDispute": false,
"status": "pre_authorized",
"paymentMethod": {"paymentType": "credit",
"installments": 1
},
"paymentSource": {"sourceType": "card",
"cardId": "148d5db0-f1c3-439f-902d-f1f268086e1d"
},
"transactionRequests": [{"id": "78601913-a176-4d71-b7e8-abb6fc49a340",
"idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
"providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
"providerType": "STRIPE",
"transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
"amount": 1500,
"authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
"requestStatus": "success",
"requestType": "authorization",
"responseTs": "2633ms",
"createdAt": "2021-08-12T16:08:39.536Z",
"updatedAt": "2021-08-12T16:08:42.212Z",
"providerAuthorization": {"networkAuthorizationCode": "00",
"networkResponseCode": ""
}
}
],
"appInfo": {"platform": {"integrator": "malga",
"name": "pluging-vtex-ppp",
"version": "1.12"
},
"device": {"name": "iOS",
"version": "10.12"
},
"system": {"name": "VTEX",
"version": "13.12"
}
}
}

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

Authorizations:

X-Client-IDX-Api-Key

path Parameters

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

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

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

Payload

Content type

application/json

{"status": "charged_back"
}

Response samples

Content type

application/json

{"id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
"clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
"createdAt": "2012-06-30 23:59:59 +0000",
"amount": 150,
"currency": "BRL",
"orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
"statementDescriptor": "LOJA JOAO",
"description": "Descrição longa da cobrança",
"capture": false,
"isDispute": false,
"status": "pre_authorized",
"paymentMethod": {"paymentType": "credit",
"installments": 1
},
"paymentSource": {"sourceType": "card",
"cardId": "148d5db0-f1c3-439f-902d-f1f268086e1d"
},
"transactionRequests": [{"id": "78601913-a176-4d71-b7e8-abb6fc49a340",
"idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
"providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
"providerType": "STRIPE",
"transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
"amount": 1500,
"authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
"requestStatus": "success",
"requestType": "authorization",
"responseTs": "2633ms",
"createdAt": "2021-08-12T16:08:39.536Z",
"updatedAt": "2021-08-12T16:08:42.212Z",
"providerAuthorization": {"networkAuthorizationCode": "00",
"networkResponseCode": ""
}
}
],
"appInfo": {"platform": {"integrator": "malga",
"name": "pluging-vtex-ppp",
"version": "1.12"
},
"device": {"name": "iOS",
"version": "10.12"
},
"system": {"name": "VTEX",
"version": "13.12"
}
}
}

Alterar o status do antifraude no ambiente de sandbox

Authorizations:

X-Client-IDX-Api-Key

path Parameters

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

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

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

Payload

Content type

application/json

{"status": "approved"
}

Response samples

Content type

application/json

{"id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
"clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
"createdAt": "2012-06-30 23:59:59 +0000",
"amount": 150,
"currency": "BRL",
"orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
"statementDescriptor": "LOJA JOAO",
"description": "Descrição longa da cobrança",
"capture": false,
"isDispute": false,
"status": "pre_authorized",
"paymentMethod": {"paymentType": "credit",
"installments": 1
},
"paymentSource": {"sourceType": "card",
"cardId": "148d5db0-f1c3-439f-902d-f1f268086e1d"
},
"transactionRequests": [{"id": "78601913-a176-4d71-b7e8-abb6fc49a340",
"idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
"providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
"providerType": "STRIPE",
"transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
"amount": 1500,
"authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
"requestStatus": "success",
"requestType": "authorization",
"responseTs": "2633ms",
"createdAt": "2021-08-12T16:08:39.536Z",
"updatedAt": "2021-08-12T16:08:42.212Z",
"providerAuthorization": {"networkAuthorizationCode": "00",
"networkResponseCode": ""
}
}
],
"appInfo": {"platform": {"integrator": "malga",
"name": "pluging-vtex-ppp",
"version": "1.12"
},
"device": {"name": "iOS",
"version": "10.12"
},
"system": {"name": "VTEX",
"version": "13.12"
}
}
}

Capturar cobrança pre-autorizada

Authorizations:

X-Client-IDX-Api-Key

path Parameters

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

Payload

Content type

application/json

{"amount": 150
}

Response samples

Content type

application/json

{"id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
"clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
"createdAt": "2012-06-30 23:59:59 +0000",
"amount": 150,
"currency": "BRL",
"orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
"statementDescriptor": "LOJA JOAO",
"description": "Descrição longa da cobrança",
"capture": false,
"isDispute": false,
"status": "pre_authorized",
"paymentMethod": {"paymentType": "credit",
"installments": 1
},
"paymentSource": {"sourceType": "card",
"cardId": "148d5db0-f1c3-439f-902d-f1f268086e1d"
},
"transactionRequests": [{"id": "78601913-a176-4d71-b7e8-abb6fc49a340",
"idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
"providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
"providerType": "STRIPE",
"transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
"amount": 1500,
"authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
"requestStatus": "success",
"requestType": "authorization",
"responseTs": "2633ms",
"createdAt": "2021-08-12T16:08:39.536Z",
"updatedAt": "2021-08-12T16:08:42.212Z",
"providerAuthorization": {"networkAuthorizationCode": "00",
"networkResponseCode": ""
}
}
],
"appInfo": {"platform": {"integrator": "malga",
"name": "pluging-vtex-ppp",
"version": "1.12"
},
"device": {"name": "iOS",
"version": "10.12"
},
"system": {"name": "VTEX",
"version": "13.12"
}
}
}

Estornar cobrança aprovada

Authorizations:

X-Client-IDX-Api-Key

path Parameters

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

Payload

Content type

application/json

{"amount": 150
}

Response samples

Content type

application/json

{"id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
"clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
"createdAt": "2012-06-30 23:59:59 +0000",
"amount": 150,
"currency": "BRL",
"orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
"statementDescriptor": "LOJA JOAO",
"description": "Descrição longa da cobrança",
"capture": false,
"isDispute": false,
"status": "pre_authorized",
"paymentMethod": {"paymentType": "credit",
"installments": 1
},
"paymentSource": {"sourceType": "card",
"cardId": "148d5db0-f1c3-439f-902d-f1f268086e1d"
},
"transactionRequests": [{"id": "78601913-a176-4d71-b7e8-abb6fc49a340",
"idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
"providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
"providerType": "STRIPE",
"transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
"amount": 1500,
"authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
"requestStatus": "success",
"requestType": "authorization",
"responseTs": "2633ms",
"createdAt": "2021-08-12T16:08:39.536Z",
"updatedAt": "2021-08-12T16:08:42.212Z",
"providerAuthorization": {"networkAuthorizationCode": "00",
"networkResponseCode": ""
}
}
],
"appInfo": {"platform": {"integrator": "malga",
"name": "pluging-vtex-ppp",
"version": "1.12"
},
"device": {"name": "iOS",
"version": "10.12"
},
"system": {"name": "VTEX",
"version": "13.12"
}
}
}

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

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 (object) or PaymentMethodPixObject (object) or PaymentMethodBoletoObject (object) or PaymentMethodDripObjectRequest (object) or PaymentMethodNupayObjectRequest (object)

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

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

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

{"id": "1b0c6960-702a-4074-95c2-eed2790c16a1",
"name": "Nome da sessão",
"status": "created",
"isActive": true,
"clientId": "1b0c6960-702a-4074-95c2-eed2790c16a1",
"orderId": null,
"amount": 100,
"currency": "BRL",
"capture": true,
"merchantId": "69aea152-ba70-49a3-a31c-044ac1651146",
"dueDate": "2022-10-25T09:28:45.000Z",
"description": "Promoção Black Friday",
"statementDescriptor": "LOJA JOAO",
"paymentMethods": [{"paymentType": "credit",
"installments": 1
}
],
"items": [{"id": "78601913-a176-4d71-b7e8-abb6fc49a340",
"name": "Item 1",
"description": "Descrição do item",
"unitPrice": 10000,
"quantity": 1,
"tangible": false
}
],
"createdAt": "2022-10-25T09:28:45.000Z",
"updatedAt": "2022-10-25T09:28:45.000Z",
"publicKey": "1b0c6960-702a-4074-95c2-eed2790c16a1"
}

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) or PaymentMethodNupayObjectRequest (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

Payload

Content type

application/json

{"amount": 100,
"name": "Loja 1",
"merchantId": "1b0c6960-702a-4074-95c2-eed2790c16a1",
"dueDate": "2022-10-25T09:28:45.000Z",
"createLink": true,
"paymentMethods": [{"paymentType": "pix",
"expiresIn": 30
}
],
"items": [{"name": "Item 1",
"description": "Item do carrinho",
"unitPrice": 1000,
"quantity": 1,
"tangible": false
}
]
}

Response samples

Content type

application/json

{"id": "c1db83fa-723c-4e1f-9722-bc19d1be6791",
"name": "Pedido 1",
"status": "created",
"isActive": true,
"clientId": "39d2d314-5412-431a-b34b-74f9f0fbe7e1",
"orderId": "b84b7694-d22f-4083-bee7-c1274b16eb4a",
"amount": 100,
"currency": "BRL",
"capture": true,
"merchantId": "9930c8d9-a7a8-4039-9faf-3715ad87baf8",
"dueDate": "2022-10-26T19:32:08.000Z",
"description": "Pedido Black Friday",
"statementDescriptor": "LOJA JOAO",
"items": [{"name": "Item 1",
"description": "Item do carrinho",
"unitPrice": 1000,
"quantity": 1,
"tangible": false
}
],
"paymentLink": "https://link.malga.io/7648b72d-a79f-43e1-843d-eb0133bd2438",
"paymentMethods": [{"paymentType": "pix",
"expiresIn": 30
}
],
"createdAt": "2022-10-25T22:49:06.588Z",
"updatedAt": "2022-10-25T22:49:06.588Z",
"publicKey": "8be71cdf-01dc-4b1a-823a-4c58be6e4cf1"
}

Recuperar detalhes de uma sessão

Authorizations:

X-Client-IDX-Api-Key

path Parameters

required

string <uuid>

Identificação da sessão a ser recuperada

Responses

Response samples

Content type

application/json

{"id": "c1db83fa-723c-4e1f-9722-bc19d1be6791",
"name": "Pedido 1",
"status": "created",
"isActive": true,
"clientId": "39d2d314-5412-431a-b34b-74f9f0fbe7e1",
"orderId": "b84b7694-d22f-4083-bee7-c1274b16eb4a",
"amount": 100,
"currency": "BRL",
"capture": true,
"merchantId": "9930c8d9-a7a8-4039-9faf-3715ad87baf8",
"dueDate": "2022-10-26T19:32:08.000Z",
"description": "Pedido Black Friday",
"statementDescriptor": "LOJA JOAO",
"items": [{"name": "Item 1",
"description": "Item do carrinho",
"unitPrice": 1000,
"quantity": 1,
"tangible": false
}
],
"paymentLink": "https://link.malga.io/7648b72d-a79f-43e1-843d-eb0133bd2438",
"paymentMethods": [{"paymentType": "pix",
"expiresIn": 30
}
],
"createdAt": "2022-10-25T22:49:06.588Z",
"updatedAt": "2022-10-25T22:49:06.588Z",
"publicKey": "8be71cdf-01dc-4b1a-823a-4c58be6e4cf1"
}

Atualizar o status de uma sessão

Authorizations:

X-Client-IDX-Api-Key

path Parameters

required

string <uuid>

Identificação da sessão a ser alterada

Responses

Response samples

Content type

application/json

{"id": "c1db83fa-723c-4e1f-9722-bc19d1be6791",
"isActive": false
}

Pagar uma sessão

Authorizations:

X-Client-IDX-Api-Key

path Parameters

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 PaymentMethodPixObjectRequest (object) or PaymentMethodBoleto (object) or PaySessionPaymentMethodDripObjectRequest (object) or PaymentSessionNuPay (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

Payload

Content type

application/json

Example

{"paymentMethod": {"paymentType": "credit",
"installments": 1
},
"paymentSource": {"sourceType": "card",
"card": {"cardNumber": "5261424250184574",
"cardCvv": "321",
"cardExpirationDate": "06/2028",
"cardHolderName": "JOAO DA SILVA"
}
}
}

Response samples

Content type

application/json

Example

{"id": "148d5db0-f1c3-439f-902d-f1f268086e1d",
"clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
"merchantId": "148d5db0-f1c3-439f-902d-f1f268086e1d",
"description": "Descrição longa da cobrança",
"orderId": "32c68ff7-902c-408b-b464-cf487c7cda97",
"createdAt": "2012-06-30 23:59:59 +0000",
"amount": 150,
"originalAmount": 150,
"currency": "BRL",
"statementDescriptor": "LOJA JOAO",
"status": "pending",
"paymentMethod": {"paymentType": "credit",
"installments": 1
},
"paymentSource": {"sourceType": "card",
"cardId": "148d5db0-f1c3-439f-902d-f1f268086e1d"
},
"transactionRequests": [{"id": "78601913-a176-4d71-b7e8-abb6fc49a340",
"idempotencyKey": "fafe857b176e45d6b12e32fcaf228996",
"providerId": "2c3b57d8-ee43-4b19-bc8a-949a88c51df1",
"providerType": "STRIPE",
"transactionId": "ch_3JYE7MHjGFBGEeiP0lfTD3Ob",
"amount": 1500,
"authorizationNsu": "1cc8391c-f0d5-4b7a-9fcf-653cea26be13",
"requestStatus": "success",
"requestType": "authorization",
"responseTs": "2633ms",
"createdAt": "2021-08-12T16:08:39.536Z",
"updatedAt": "2021-08-12T16:08:42.212Z",
"providerAuthorization": {"networkAuthorizationCode": "00",
"networkResponseCode": ""
}
}
]
}

Cancelar uma sessão

Authorizations:

X-Client-IDX-Api-Key

path Parameters

required

string <uuid>

Identificação da sessão a ser cancelada

Responses

Response samples

Content type

application/json

{"id": "c1db83fa-723c-4e1f-9722-bc19d1be6791",
"status": "canceled"
}

Recuperar o histórico da sessão

Authorizations:

X-Client-IDX-Api-Key

path Parameters

required

string <uuid>

Identificação da sessão a ser recuperada

Responses

Response samples

Content type

application/json

[{"status": "created",
"id": "82aba896-9e37-45b6-aa90-d510c9050596",
"createdAt": "2022-11-11T16:35:38.870Z",
"updatedAt": "2022-11-11T16:35:38.870Z"
}
]

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

Authorizations:

X-Client-IDX-Api-Key

path Parameters

required

string <uuid>

Identificação da sessão a ser recuperada

Responses

Response samples

Content type

application/json

{"id": "1b0c6960-702a-4074-95c2-eed2790c16a1",
"name": "Nome da sessão",
"status": "created",
"isActive": true,
"clientId": "1b0c6960-702a-4074-95c2-eed2790c16a1",
"orderId": null,
"amount": 100,
"currency": "BRL",
"capture": true,
"merchantId": "69aea152-ba70-49a3-a31c-044ac1651146",
"dueDate": "2022-10-25T09:28:45.000Z",
"description": "Promoção Black Friday",
"statementDescriptor": "LOJA JOAO",
"paymentMethods": [{"paymentType": "credit",
"installments": 1
}
],
"items": [{"id": "78601913-a176-4d71-b7e8-abb6fc49a340",
"name": "Item 1",
"description": "Descrição do item",
"unitPrice": 10000,
"quantity": 1,
"tangible": false
}
],
"createdAt": "2022-10-25T09:28:45.000Z",
"updatedAt": "2022-10-25T09:28:45.000Z",
"publicKey": "1b0c6960-702a-4074-95c2-eed2790c16a1",
"settings": {"id": "78601913-a176-4d71-b7e8-abb6fc49a340",
"email": "company@email.com",
"phone": "5551996225566",
"statementDescription": "LOJA JOAO",
"logo": "https://logo.com/images/logo.png",
"mainColor": "#fff000",
"secondaryColor": "#fff000",
"attentionColor": "#333333",
"errorColor": "#ff0000",
"successColor": "#00FF00",
"backgroundColor": "#fff000",
"companyName": "Company Name",
"clientId": "1b0c6960-702a-4074-95c2-eed2790c16a1",
"documentNumber": "011001001001000010",
"language": "pt_BR"
}
}

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

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

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

{"merchantId": "b1612460-0fef-447d-9590-97825cf60cf6",
"owner": {"name": "Seller test",
"email": "seller@gmail.com",
"phoneNumber": "21 98889999099",
"birthdate": "27-01-1995",
"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"
}
},
"business": {"name": "Seller business test",
"phoneNumber": "21 98889999099",
"email": "seller@gmail.com",
"website": "www.sellerbusiness.com.br",
"description": "Seller business",
"facebook": "facebook Seller business",
"twitter": "twitter Seller business",
"openingDate": "27-01-1995",
"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": "36243319067",
"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": ""
}
}

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

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

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

Payload

Content type

application/json

Example

{"merchantId": "b1612460-0fef-447d-9590-97825cf60cf6",
"owner": {"name": "Seller test",
"email": "seller@gmail.com",
"phoneNumber": "21 98889999099",
"birthdate": "27-01-1995",
"document": {"type": "cpf",
"number": "36243319067",
"country": "BR"
},
"address": {"street": "Av Geraldo Cardoso",
"streetNumber": "205",
"complement": "Apto 203",