Documentação Malga API (0.5)
Download OpenAPI specification:Download
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.
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 |
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 |
curl --location --request GET 'https://api.malga.io/v1/' \
--header 'X-Client-Id: <YOUR_CLIENT_ID>' \
--header 'X-Api-Key: <YOUR_SECRET_KEY>'
É 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: "tokens" "charges" "cards" "webhooks" 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": "tokens",
- "expires": 0
}
Retorno da chamada de criação da chave pública:
scope | string Enum: "tokens" "charges" "cards" "webhooks" 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": "tokens",
- "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:
Request Body schema: application/json
Creat authentication token
scope | string Enum: "tokens" "charges" "cards" "webhooks" 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
{- "scope": [
- "tokens"
], - "expires": 31104000
}
Response samples
- 201
- 400
- 500
{- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "publicKey": "<YOUR_PUBLIC_KEY>",
- "scope": [
- "tokens"
], - "expires": 31104000,
- "createdAt": "20200110 00:00:00"
}
Dados básicos de uma requisição de criação de card token
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 novo token de cartão
Authorizations:
Request Body schema: application/json
Tokenize credit card
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
{- "cardHolderName": "JOSE DAS NEVES",
- "cardNumber": "4019598346009339",
- "cardCvv": "123",
- "cardExpirationDate": "12/2026"
}
Response samples
- 201
- 400
- 500
{- "id": "82aba896-9e37-45b6-aa90-d510c9050596",
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "createdAt": "2012-06-30 23:59:59 +0000"
}
Dados básicos de um objeto cartão
id | string ID do cartão | ||||||||||||||||||||||||||||||||||||||||||
expirationMonth | string Data de expiração MM | ||||||||||||||||||||||||||||||||||||||||||
expirationYear | string Data de expiração YYYY | ||||||||||||||||||||||||||||||||||||||||||
brand | string Enum: "American Express" "Mastercard" "Visa" "Elo" "Discover" "JCB" "Diners" Bandeira | ||||||||||||||||||||||||||||||||||||||||||
cvvChecked | boolean Identifica se o CVV foi verificado | ||||||||||||||||||||||||||||||||||||||||||
fingerprint | string Hash de identificação única do cartão com base nos dados sensíveis | ||||||||||||||||||||||||||||||||||||||||||
first6digits | string Primeiros 6 digitos do cartão | ||||||||||||||||||||||||||||||||||||||||||
last4digits | string Últimos 4 digitos do cartão | ||||||||||||||||||||||||||||||||||||||||||
status | string Enum: "failed" "active" "pending" Status de validação dos dados cartões, failed (cartão inválido para uso), active (cartão válido para uso), pending (validação do cartão pendente, uso autorizado temporariamente) | ||||||||||||||||||||||||||||||||||||||||||
createdAt | string Data de criação do cartão | ||||||||||||||||||||||||||||||||||||||||||
updatedAt | string Data de atualização do cartão | ||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||
|
{- "id": "string",
- "expirationMonth": "string",
- "expirationYear": "string",
- "brand": "American Express",
- "cvvChecked": true,
- "fingerprint": "string",
- "first6digits": "string",
- "last4digits": "string",
- "status": "failed",
- "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": "BR"
}, - "address": {
- "country": "string",
- "state": "string",
- "city": "string",
- "district": "string",
- "zipCode": "string",
- "street": "string",
- "streetNumber": "string",
- "complement": "string"
}
}
}
Criar novo cartão a partir de token
Authorizations:
Request Body schema: application/json
Create credit card
tokenId required | string <uuid> Identificador do token gerado |
Responses
Request samples
- Payload
- Python
{- "tokenId": "82aba896-9e37-45b6-aa90-d510c9050596"
}
Response samples
- 201
- 400
- 500
{- "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"
}
Listar cartões
Authorizations:
query Parameters
page | number número da página |
limit | number quantidade de itens por página |
Responses
Response Schema: application/json
object | |||||||||||
| |||||||||||
items | array |
Response samples
- 200
- 400
- 500
{- "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:
path Parameters
id required | string <uuid> ID do cartão |
Responses
Response Schema: application/json
id | string ID do cartão | ||||||||||||||||||||||||||||||||||||||||||
expirationMonth | string Data de expiração MM | ||||||||||||||||||||||||||||||||||||||||||
expirationYear | string Data de expiração YYYY | ||||||||||||||||||||||||||||||||||||||||||
brand | string Enum: "American Express" "Mastercard" "Visa" "Elo" "Discover" "JCB" "Diners" Bandeira | ||||||||||||||||||||||||||||||||||||||||||
cvvChecked | boolean Identifica se o CVV foi verificado | ||||||||||||||||||||||||||||||||||||||||||
fingerprint | string Hash de identificação única do cartão com base nos dados sensíveis | ||||||||||||||||||||||||||||||||||||||||||
first6digits | string Primeiros 6 digitos do cartão | ||||||||||||||||||||||||||||||||||||||||||
last4digits | string Últimos 4 digitos do cartão | ||||||||||||||||||||||||||||||||||||||||||
status | string Enum: "failed" "active" "pending" Status de validação dos dados cartões, failed (cartão inválido para uso), active (cartão válido para uso), pending (validação do cartão pendente, uso autorizado temporariamente) | ||||||||||||||||||||||||||||||||||||||||||
createdAt | string Data de criação do cartão | ||||||||||||||||||||||||||||||||||||||||||
updatedAt | string Data de atualização do cartão | ||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||
|
Response samples
- 200
- 400
- 500
{- "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"
}
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 anti fraude 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
- Crie um
customer
informando os dados básicos de identificação e endereço - Crie um novo
token
de cartão a partir dos dados do portador - Crie um novo
card
a partir do token gerado e guarde o cardId gerado para associação futura com o customer - Associe o
card
criado com ocustomer
criado através do serviço de associação de cartão com comprador - Liste os cartões vinculados ao comprador através do serviço de listagem de cartões por customer
curl --location --request POST 'https://api.malga.io/v1/customers' \
--header 'X-Client-Id: <YOUR_CLIENT_ID>' \
--header 'X-Api-Key: <YOUR_SECRET_KEY>' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Jose Bonifacio Da Silveira",
"phoneNumber": "21 98889999099",
"email": "jose@gmail.com",
"document": {
"number": "72912053013",
"type": "cpf",
"country": "BR"
},
"address": {
"country": "BR",
"state": "Rio de Janeiro",
"city": "Rio de Janeiro",
"district": "Leblon",
"zipCode": "25650-011",
"street": "Av Geraldo Cardoso",
"streetNumber": "205",
"complement": "Apto 203"
}
}'
- Crie um
customer
informando os dados básicos de identificação e endereço - Crie um novo
charge
informando comopaymentSource
o customer criado previamente, dessa forma iremos utilizar os dados do comprador para geração da cobrança.
Dados básicos de um objeto do tipo customer
id | 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 | |||||||||||||||||
| |||||||||||||||||
object | |||||||||||||||||
|
{- "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"
}
}
Criação de novo customer para cobrança
Authorizations:
Request Body schema: application/json
name required | string nome do usuario | ||||||||||||||||
email required | string email do usuario | ||||||||||||||||
phoneNumber required | string telefone de contato do usuario | ||||||||||||||||
required | object | ||||||||||||||||
| |||||||||||||||||
object | |||||||||||||||||
|
Responses
Request samples
- Payload
{- "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:
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 | |||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||||||
|
Response samples
- 200
- 400
- 500
{- "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:
path Parameters
id required | string <uuid> id do customers que deseja recuperar |
Responses
Response Schema: application/json
id | string identificador do customer | ||||||||||||||||
createdAt | string data de criação | ||||||||||||||||
clientId | string <uuid> identificador do client | ||||||||||||||||
name | string nome do usuario | ||||||||||||||||
string email do usuario | |||||||||||||||||
phoneNumber | string telefones de contato do usuario | ||||||||||||||||
object | |||||||||||||||||
| |||||||||||||||||
object | |||||||||||||||||
|
Response samples
- 200
- 400
- 500
{- "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"
}
}
Atualizar customer pelo id
Authorizations:
path Parameters
id required | string <uuid> id do customers que deseja alterar |
Request Body schema: application/json
name | string nome do usuario | ||||||||||||||||
phoneNumber | string telefone de contato do usuario | ||||||||||||||||
object | |||||||||||||||||
|
Responses
Request samples
- Payload
{- "name": "string",
- "phoneNumber": "string",
- "address": {
- "country": "string",
- "state": "string",
- "city": "string",
- "district": "string",
- "zipCode": "string",
- "street": "string",
- "streetNumber": "string",
- "complement": "string"
}
}
Adicionar cartão de crédito ao customer
Authorizations:
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
{- "cardId": "82aba896-9e37-45b6-aa90-d510c9050596"
}
Listagem dos cartões do customer
Authorizations:
path Parameters
customer_id required | string <uuid> id do customers que deseja alterar |
Responses
Response Schema: application/json
object | |||||||||||
| |||||||||||
items | array |
Response samples
- 200
{- "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"
}
]
}
Para realizar uma cobrança deve criar um objeto charge
. É possível recuperar detalhes de transações individuais ou listar todas as cobranças realizadas em um determinado merchant
. Os charges
são identificados a partir de um id 'único'.
Dados básicos de um objeto do tipo charge
id | string identificador da transação | ||||||||||||||||||||||||||||||||||||||||||
clientId | string <uuid> identificador do cliente na Malga | ||||||||||||||||||||||||||||||||||||||||||
merchantId | string <uuid> identificador do merchant id utilizado na transação | ||||||||||||||||||||||||||||||||||||||||||
customerId | string <uuid> identificador do customer id | ||||||||||||||||||||||||||||||||||||||||||
description | string Descrição da cobrança para consulta futura | ||||||||||||||||||||||||||||||||||||||||||
amount | number valor da transação em centavos, exemplo 100 para cobrar R$ 1,00 | ||||||||||||||||||||||||||||||||||||||||||
currency | string Default: "BRL" Identificador da moeda para processamento da cobrança, formato ISO 4217. | ||||||||||||||||||||||||||||||||||||||||||
statementDescriptor | string descrição a ser exibida na fatura do comprador | ||||||||||||||||||||||||||||||||||||||||||
capture | boolean determina se a transação deve ser capturada automaticamente | ||||||||||||||||||||||||||||||||||||||||||
isDispute | boolean determina se a transação está em disputa | ||||||||||||||||||||||||||||||||||||||||||
status | string Enum: "pending" "pre_authorized" "authorized" "failed" "canceled" "voided" "refund_pending" "charged_back" status da transação na Malga | ||||||||||||||||||||||||||||||||||||||||||
orderId | string Identificador único da cobrança do lado do cliente para conciliação futura | ||||||||||||||||||||||||||||||||||||||||||
PaymentMethodCardObject (object) or PaymentMethodPixObject (object) or PaymentMethodBoletoObject (object) or PaymentMethodNuPayObject (object) | |||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||
SourceTypeCardObject (object) or SourceTypeTokenObject (object) or SourceTypeCustomerObject (object) | |||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||
object Campos adicionais para uso em condicionais dos fluxos inteligentes | |||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||
Array of objects (TransactionRequest) [ items ] | |||||||||||||||||||||||||||||||||||||||||||
Array
|
{- "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": ""
}
}
]
}
Realizar nova cobrança
Authorizations:
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) Define o método de cobrança | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | SourceTypeCard (object) or SourceTypeCardOneShot (object) or SourceTypeToken (object) or SourceTypeCustomer (object) or SourceTypeCustomerOneShot (object) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Parâmetros adicionais para analise de fraude, obrigatório quando anti-fraude ligado. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Parâmetros adicionais para transacionar com Split | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Campos adicionais para uso em condicionais dos fluxos inteligentes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Responses
Request samples
- Payload
{- "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
- 201
- 400
- 500
{- "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": ""
}
}
]
}
Listar cobranças
Authorizations:
query Parameters
page | number numero da pagina ativa |
limit | number quantidade de registros por página 1-100 |
sort | 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 | enum - pending - pre_authorized - authorized - voided - refund_pending - canceled - charged_back status da cobrança |
paymentType | 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 | |||||||||||
| |||||||||||
items | array |
Response samples
- 200
- 400
- 500
{- "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": ""
}
}
]
}
]
}
Recuperar detalhes de cobrança
Authorizations:
path Parameters
id required | string <uuid> id da cobrança que deseja recuperar |
Responses
Response Schema: application/json
object | |||||||||||
| |||||||||||
items | array |
Response samples
- 200
- 400
- 500
{- "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": ""
}
}
]
}
Alterar o status de uma cobrança no ambiente de sandbox
Authorizations:
path Parameters
id required | string <uuid> id da cobrança que deseja alterar no sandbox |
Request Body schema: application/json
status | string Enum: "pending" "pre_authorized" "authorized" "failed" "canceled" "voided" "charged_back" "created" "processed" "capture_pending" "refund_pending" status da transação |
Responses
Response Schema: application/json
id | string identificador da transação | ||||||||||||||||||||||||||||||||||||||||||
clientId | string <uuid> identificador do cliente na Malga | ||||||||||||||||||||||||||||||||||||||||||
merchantId | string <uuid> identificador do merchant id utilizado na transação | ||||||||||||||||||||||||||||||||||||||||||
customerId | string <uuid> identificador do customer id | ||||||||||||||||||||||||||||||||||||||||||
description | string Descrição da cobrança para consulta futura | ||||||||||||||||||||||||||||||||||||||||||
amount | number valor da transação em centavos, exemplo 100 para cobrar R$ 1,00 | ||||||||||||||||||||||||||||||||||||||||||
currency | string Default: "BRL" Identificador da moeda para processamento da cobrança, formato ISO 4217. | ||||||||||||||||||||||||||||||||||||||||||
statementDescriptor | string descrição a ser exibida na fatura do comprador | ||||||||||||||||||||||||||||||||||||||||||
capture | boolean determina se a transação deve ser capturada automaticamente | ||||||||||||||||||||||||||||||||||||||||||
isDispute | boolean determina se a transação está em disputa | ||||||||||||||||||||||||||||||||||||||||||
status | string Enum: "pending" "pre_authorized" "authorized" "failed" "canceled" "voided" "refund_pending" "charged_back" status da transação na Malga | ||||||||||||||||||||||||||||||||||||||||||
orderId | string Identificador único da cobrança do lado do cliente para conciliação futura | ||||||||||||||||||||||||||||||||||||||||||
PaymentMethodCardObject (object) or PaymentMethodPixObject (object) or PaymentMethodBoletoObject (object) or PaymentMethodNuPayObject (object) | |||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||
SourceTypeCardObject (object) or SourceTypeTokenObject (object) or SourceTypeCustomerObject (object) | |||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||
object Campos adicionais para uso em condicionais dos fluxos inteligentes | |||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||
Array of objects (TransactionRequest) [ items ] | |||||||||||||||||||||||||||||||||||||||||||
Array
|
Request samples
- Payload
{- "status": "charged_back"
}
Response samples
- 200
- 400
- 500
{- "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": ""
}
}
]
}
Capturar cobrança pre-autorizada
Authorizations:
path Parameters
id required | string <uuid> id da cobrança que deseja capturar |
Request Body schema: application/json
amount | number valor da captura em centavos não podendo ser maior que o valor da transação, exemplo 100 para cobrar R$ 1,00 |
Responses
Request samples
- Payload
{- "amount": 150
}
Response samples
- 201
- 400
- 500
{- "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": ""
}
}
]
}
Estornar cobrança aprovada
Authorizations:
path Parameters
id required | string <uuid> id da cobrança que deseja estornar |
Request Body schema: application/json
amount | number valor do estorno em centavos não podendo ser maior que o valor da transação, exemplo 100 para cobrar R$ 1,00 |
delayToCompose | number número de dias para compor o valor a ser estornado. Utilizado apenas pela NuPay. |
Responses
Request samples
- Payload
{- "amount": 150
}
Response samples
- 201
- 400
- 500
{- "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": ""
}
}
]
}
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.
- Crie uma
sessão
informando os dados básicos necessários - Utilize a
publicKey
retornada na criação ou recuperada na rota de detalhes noX-Api-Key
para autenticar o pagamento
Dados básicos de um objeto do tipo session
id | string Identificação da sessão a ser utilizada | ||||||||||
name | string Nome que identifica a sessão | ||||||||||
status | string Enum: "created" "paid" "canceled" "voided" Status da sessão | ||||||||||
isActive | boolean Determina se a sessão está ativa | ||||||||||
clientId | string Identificador do cliente na Malga | ||||||||||
orderId | string Identificador único da cobrança do lado do cliente para conciliação futura | ||||||||||
amount | number Valor da transação em centavos, exemplo 100 para cobrar R$ 1,00 | ||||||||||
currency | string Identificador da moeda para processamento da cobrança, formato ISO 4217. | ||||||||||
capture | boolean Determina se a transação deve ser capturada automaticamente | ||||||||||
merchantId | string Identificação do merchant id a ser utilizado | ||||||||||
dueDate | string Data de expiração de uma sessão | ||||||||||
description | string Descrição da sessão | ||||||||||
statementDescriptor | string Descrição a ser exibida fatura do comprador | ||||||||||
Array of objects (SessionItemObject) [ items ] Itens do pedido | |||||||||||
Array
| |||||||||||
paymentLink | string Link para acessar o Link de Pagamento desta sessão | ||||||||||
PaymentMethodCardObject (array) or PaymentMethodPixObject (array) or PaymentMethodBoletoObject (array) Métodos de pagamento disponíveis na sessão | |||||||||||
One of array | |||||||||||
createdAt | string Data de criação da sessão | ||||||||||
updatedAt | string Data da atualização da sessão | ||||||||||
publicKey | string Chave de acesso com escopo restrito, usada para pagar a sessão |
{- "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:
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) Métodos de pagamento disponíveis na sessão | ||||||||||
Any of
| |||||||||||
required | Array of objects (SessionItemObject) [ items ] Itens do pedido | ||||||||||
Array
|
Responses
Request samples
- Payload
{- "amount": 100,
- "name": "Loja 1",
- "merchantId": "1b0c6960-702a-4074-95c2-eed2790c16a1",
- "dueDate": "2022-10-25T09:28:45.000Z",
- "paymentMethods": [
- {
- "paymentType": "pix",
- "expiresIn": 30
}
], - "items": [
- {
- "name": "Item 1",
- "description": "Item do carrinho",
- "unitPrice": 1000,
- "quantity": 1,
- "tangible": false
}
]
}
Response samples
- 201
{- "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
}
], - "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:
path Parameters
id required | string <uuid> Identificação da sessão a ser recuperada |
Responses
Response samples
- 201
{- "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
}
], - "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"
}
Pagar uma sessão
Authorizations:
path Parameters
id required | string <uuid> Identificação da sessão a ser paga |
Request Body schema: application/json
customerId | string <uuid> Identificador de comprador para consulta futura | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | PaymentMethodCard (object) or PaymentMethodPix (object) or PaymentMethodBoleto (object) Define o método de cobrança | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | SourceTypeCard (object) or SourceTypeCardOneShot (object) or SourceTypeToken (object) or SourceTypeCustomer (object) or SourceTypeCustomerOneShot (object) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Parâmetros adicionais para analise de fraude, obrigatório quando anti-fraude ligado. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Responses
Request samples
- Payload
{- "paymentMethod": {
- "paymentType": "credit",
- "installments": 1
}, - "paymentSource": {
- "sourceType": "card",
- "card": {
- "cardNumber": "5261424250184574",
- "cardCvv": "321",
- "cardExpirationDate": "06/2028",
- "cardHolderName": "JOAO DA SILVA"
}
}
}
Response samples
- 201
{- "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": ""
}
}
]
}
Recuperar o histórico da sessão
Authorizations:
path Parameters
id required | string <uuid> Identificação da sessão a ser recuperada |
Responses
Response samples
- 201
[- {
- "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:
path Parameters
id required | string <uuid> Identificação da sessão a ser recuperada |
Responses
Response samples
- 201
{- "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",
- "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"
}
}
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.
merchantId required | string identificação do merchant id a ser utilizado | ||||||||||||||||||||||||||||||||||||||
mcc required | string código de segmento do lojista no adquirente, solicite ao seu provedor caso não saiba qual o seu Merchant Category Code. | ||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
required | object | ||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
required | object | ||||||||||||||||||||||||||||||||||||||
|
{- "merchantId": "5616b19e-4d99-4bd3-b415-4990e5cab4f4",
- "mcc": 4040,
- "business": {
- "name": "Seller business test",
- "phoneNumber": "21 98889999099",
- "email": "seller@gmail.com",
- "openingDate": "27-01-1995",
- "document": {
- "number": "94938591000196",
- "type": "cnpj",
- "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"
}, - "bankAccount": {
- "holderName": "Seller Name",
- "holderDocument": "36243319067",
- "bank": "077",
- "branchNumber": "492",
- "branchCheckDigit": "1",
- "accountNumber": "4929",
- "accountCheckDigit": "12",
- "type": "conta_corrente"
}
}, - "transferPolicy": {
- "transferDay": "5",
- "transferInterval": "monthly",
- "transferEnabled": true
}
}
Criar um novo recebedor
Authorizations:
Request Body schema: application/json
merchantId | string identificação do merchant | ||||||||||||||||||||||||||||||||||||||
mcc | string código de segmento do lojista no adquirente | ||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||
|
Responses
Request samples
- Payload
{- "merchantId": "5616b19e-4d99-4bd3-b415-4990e5cab4f4",
- "mcc": 4040,
- "business": {
- "name": "Seller business test",
- "phoneNumber": "21 98889999099",
- "email": "seller@gmail.com",
- "openingDate": "27-01-1995",
- "document": {
- "number": "94938591000196",
- "type": "cnpj",
- "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"
}, - "bankAccount": {
- "holderName": "Seller Name",
- "holderDocument": "36243319067",
- "bank": "077",
- "branchNumber": "492",
- "branchCheckDigit": "1",
- "accountNumber": "4929",
- "accountCheckDigit": "12",
- "type": "conta_corrente"
}
}, - "transferPolicy": {
- "transferDay": "5",
- "transferInterval": "monthly",
- "transferEnabled": true
}
}
Response samples
- 201
- 400
- 500
{- "id": "ea115e44-7048-11ed-a1eb-0242ac120002",
- "providers": [
- {
- "id": "f218697a-7048-11ed-a1eb-0242ac120002",
- "providerType": "PLUG_SANDBOX",
- "status": "active",
- "createdAt": "2021-08-12T16:08:39.536Z",
- "updatedAt": "2021-08-12T16:08:39.536Z"
}
], - "merchantId": "5616b19e-4d99-4bd3-b415-4990e5cab4f4",
- "mcc": 4040,
- "business": {
- "name": "Seller test",
- "phoneNumber": "21 98889999099",
- "email": "seller@gmail.com",
- "openingDate": "27-01-1995",
- "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"
}, - "bankAccount": {
- "id": "242b9be8-cd60-461d-af27-f31e3d6e3fb7"
}, - "transferPolicy": {
- "transferDay": "5",
- "transferInterval": "monthly",
- "transferEnabled": true
}, - "metadata": null
}
}
Recuperar seller pelo id
Authorizations:
path Parameters
id required | string <uuid> id do seller |
Responses
Response Schema: application/json
merchantId | string identificação do merchant | ||||||||||||||||||||||||||||||||||||||
mcc | string código de segmento do lojista no adquirente | ||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
object | |||||||||||||||||||||||||||||||||||||||
|
Response samples
- 200
{- "id": "ea115e44-7048-11ed-a1eb-0242ac120002",
- "providers": [
- {
- "id": "f218697a-7048-11ed-a1eb-0242ac120002",
- "providerType": "PLUG_SANDBOX",
- "status": "active",
- "createdAt": "2021-08-12T16:08:39.536Z",
- "updatedAt": "2021-08-12T16:08:39.536Z"
}
], - "merchantId": "5616b19e-4d99-4bd3-b415-4990e5cab4f4",
- "mcc": 4040,
- "business": {
- "name": "Seller test",
- "phoneNumber": "21 98889999099",
- "email": "seller@gmail.com",
- "openingDate": "27-01-1995",
- "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"
}, - "bankAccount": {
- "id": "242b9be8-cd60-461d-af27-f31e3d6e3fb7"
}, - "transferPolicy": {
- "transferDay": "5",
- "transferInterval": "monthly",
- "transferEnabled": true
}, - "metadata": null
}
}
Para realizar uma cobrança com Split, usaremos os dados de uma cobrança, acrescentando a propriedade splitRules
.
Essa propriedade conterá os dados necessários para a transferência dos valores ao recebedor.
Dados básicos de uma requisição de criação de transação com Split
sellerId | string <uuid> identificador do recebedor já cadastrado na API de |
percentage | number porcentagem do valor da transação 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 |
{- "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"
}
}, - "splitRules": {
- "sellerId": "32c68557-902c-408b-b464-cf487c7cda97",
- "percentage": 80,
- "liable": true,
- "processingFee": true
}
}
A Malga utiliza o serviço de webhooks para notificar o seu sistema sobre os eventos ocorridos na nossa plataforma. Através de webhooks você consegue atualizar seu sistema sempre que um evento importante acontece, como a atualização de status de uma cobrança para confirmar ou cancelar um determinado pagamento.
Dados básicos de um objeto do tipo event:
id | string identificador único do evento, também enviado no header |
createdAt | string data de criação do evento |
object | string Tipo do objeto atualizado |
event | string Tipo do evento de atualização que ocorreu no objeto atualizado |
apiVersion | number Versão da api da Malga que seu webhook implementa |
data | object Dados do objeto alterado com base na definição do schema de cada objeto |
{- "id": "5616b19e-4d99-4bd3-b415-4990e5cab4f4",
- "apiVersion": "1.1",
- "object": "transaction",
- "event": "authorized",
- "createdAt": "2021-07-05T18:56:08.672Z",
- "data": {
- "id"": "242b9be8-cd60-461d-af27-f31e3d6e3fb7",
- "updatedAt"": "2021-07-05T18:56:08.247Z",
- "createdAt"": "2021-07-05T18:56:08.247Z",
- "amount"": 1500,
- "currency": "BRL",
- "originalAmount"": 1500,
- "installments"": 1,
- "clientId"": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "description"": null,
- "statementDescriptor"": "LOJA JOAO",
- "status"": "authorized",
- "capture"": true,
- "fee"": null,
- "feeAmount"": null
}
}
Criação de novo webhook para notificação
Authorizations:
Request Body schema: application/json
event required | string Evento que deseja receber notificações no seu webhook conforme descrito na seção Eventos suportados para notificação via webhooks. Deve ser criado um webhook para cada evento, podendo ser utilizado o wildcard |
endpoint required | string URL do seu sistema que deverá receber as notificações de evento |
version required | number Default: 1.1 Versão da api da Malga que seu webhook implementa |
status required | boolean Default: true Enum: true false Identifica se o webhooks está ativo ou não para receber notificações de evento da Malga |
Responses
Request samples
- Payload
{- "event": "transaction.authorized",
- "version": 1.1,
- "status": true
}
Response samples
- 201
{- "id": "31c142ad-4c30-4964-ba24-2df0f2bbb745",
- "event": "transaction.authorized",
- "version": 1.1,
- "publicKey": "-----BEGIN PUBLIC KEY-----\nMCowBQYDK2VwAyEAnFQSIT7Mwg5QLeJLAwhAJx9wS+XsQvnyph/Lz7AJyQA=\n-----END PUBLIC KEY-----\n",
- "status": true,
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "createdAt": "2021-07-06T21:03:36.590Z",
- "updatedAt": "2021-07-06T21:03:36.590Z"
}
Listagem de webhooks cadastrados
Authorizations:
query Parameters
page | number número da página |
limit | number quantidade de itens por página |
Responses
Response Schema: application/json
object | |||||||||||||||||
| |||||||||||||||||
object | |||||||||||||||||
|
Response samples
- 200
- 400
- 500
{- "meta": {
- "itemCount": 10,
- "totalItems": 20,
- "itemsPerPage": 10,
- "totalPages": 5,
- "currentPage": 2
}, - "items": [
- {
- "id": "31c142ad-4c30-4964-ba24-2df0f2bbb745",
- "event": "transaction.authorized",
- "version": 1.1,
- "publicKey": "-----BEGIN PUBLIC KEY-----\nMCowBQYDK2VwAyEAnFQSIT7Mwg5QLeJLAwhAJx9wS+XsQvnyph/Lz7AJyQA=\n-----END PUBLIC KEY-----\n",
- "status": true,
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "createdAt": "2021-07-06T21:03:36.590Z",
- "updatedAt": "2021-07-06T21:03:36.590Z"
}
]
}
Recuperar detalhes de webhook
Authorizations:
path Parameters
id required | string <uuid> id do webhook que deseja recuperar |
Responses
Response Schema: application/json
id | string identificador do webhook |
createdAt | string data de criação |
clientId | string <uuid> identificador do client |
event | string Tipo do evento que deseja receber notificações no seu webhook |
endpoint | string URL do seu sistema que deverá receber as notificações de evento |
version | number Default: 1.1 Versão da api da Malga que seu webhook implementa |
publicKey | string Chave pública ed25519 |
status | boolean Default: true Identifica se o webhooks está ativo ou não para receber notificações de evento da Malga |
Response samples
- 200
- 400
- 500
{- "id": "31c142ad-4c30-4964-ba24-2df0f2bbb745",
- "event": "transaction.authorized",
- "version": 1.1,
- "publicKey": "-----BEGIN PUBLIC KEY-----\nMCowBQYDK2VwAyEAnFQSIT7Mwg5QLeJLAwhAJx9wS+XsQvnyph/Lz7AJyQA=\n-----END PUBLIC KEY-----\n",
- "status": true,
- "clientId": "cc0b1e41-2936-45c5-947f-93995ffcdc00",
- "createdAt": "2021-07-06T21:03:36.590Z",
- "updatedAt": "2021-07-06T21:03:36.590Z"
}
Atualizar webhook pelo id
Authorizations:
path Parameters
id required | string <uuid> id do webhook que deseja alterar |
Request Body schema: application/json
event required | string Evento que deseja receber notificações no seu webhook conforme descrito na seção Eventos suportados para notificação via webhooks. Deve ser criado um webhook para cada evento, podendo ser utilizado o wildcard |
endpoint required | string URL do seu sistema que deverá receber as notificações de evento |
version required | number Default: 1.1 Versão da api da Malga que seu webhook implementa |
status required | boolean Default: true Enum: true false Identifica se o webhooks está ativo ou não para receber notificações de evento da Malga |
Responses
Request samples
- Payload
{- "event": "string",
- "endpoint": "string",
- "version": 1.1,
- "status": true
}
Através das APIs de merchants
é possível realizar a criação e configuração de sub contas na Malga. Uma sub conta, ou um merchant
, é um cadastro de estabelecimento comercial que você tenha junto há um dos provedores de pagamentos integrados pela Malga. Uma vez que você tenha uma conta criada em um dos provedores aceitos, basta você solicitar suas credenciais de acesso ao parceiro e configurar seu cadastro na Malga.
No cadastro de merchant
é necessário informar o código da categoria mcc
do seu cadastro junto ao provedor, escolher um dos tipos de provedores suportados pela Malga, e definir a prioridade do provedor com suas credenciais de acesso à API do provedor.
O sistema de roteamento inteligente de transações da Malga foi desenvolvido de maneira a suportar o uso de múltiplos provedores por cadastro de estabelecimento. Usamos a prioridade definida no cadastro dos provedores para priorizar um determinado provedor em relação à outro, dessa forma você consegue gerenciar a ordem de provedores que será utilizado para fazer as retentativas.
Consulte a tabela de provedores aceitos para cadastro de credenciais
Consulte a tabela de código MCC para cadastro de Merchants
Dados básicos do objeto do tipo merchant
id | string dentificador do merchant | ||||||||||||||||||||||||
createdAt | string data de criação | ||||||||||||||||||||||||
clientId | string <uuid> identificador do client | ||||||||||||||||||||||||
mcc | string codigo mcc do cadatro do lojista no adquirente | ||||||||||||||||||||||||
status | string Enum: "active" "deleted" "pending" status do merchant | ||||||||||||||||||||||||
object (ProviderDto) | |||||||||||||||||||||||||
|
{- "id": "69aea152-ba70-49a3-a31c-044ac1651146",
- "updatedAt": "2021-03-12T15:57:20.239Z",
- "createdAt": "2021-03-12T15:57:20.239Z",
- "clientId": "523afbe7-36dc-4654-9dba-e7167d0e5e2d",
- "mcc": "4040",
- "status": true,
- "providers": [
- {
- "id": "72cc1ff1-5f6e-4eb2-9cc5-6a3a85525e4b",
- "updatedAt": "2021-03-12T15:57:20.239Z",
- "createdAt": "2021-03-12T15:57:20.239Z",
- "name": "PagSeguro",
- "priority": 1,
- "credentials": {
- "type": "PAGSEGURO",
- "token": "1B2B32530CA23412AB63843240F5633",
- "email": "email@gmail.com"
}
}, - {
- "id": "2cf5c350-ee26-4557-a47d-9efe1765df51",
- "updatedAt": "2021-03-12T15:57:20.239Z",
- "createdAt": "2021-03-12T15:57:20.239Z",
- "deletedAt": null,
- "idempotencyKey": null,
- "requestId": null,
- "name": "pagarme",
- "priority": 2,
- "credentials": {
- "type": "PAGARME",
- "apiKey": "ak_test_Kaa8pfXJ3WOUdCsMQiRYuV66rJZLuA"
}
}
]
}
Criação de novo merchant para cobrança
Authorizations:
Request Body schema: application/json
mcc required | string código de segmento do lojista no adquirente, solicite ao seu provedor caso não saiba qual o seu Merchant Category Code. | ||||||||||||||||||||||||
object (ProviderDto) | |||||||||||||||||||||||||
|
Responses
Request samples
- Payload
{- "mcc": "4040",
- "status": true,
- "providers": [
- {
- "name": "PagSeguro",
- "priority": 1,
- "credentials": {
- "type": "PAGSEGURO",
- "token": "1B2B32530CA24641324AB63843240F5633",
- "email": "email@gmail.com"
}
}, - {
- "name": "pagarme",
- "priority": 2,
- "credentials": {
- "type": "PAGARME",
- "apiKey": "ak_test_Kaa8pf3142dCsMQiRYuV66rJZLuA"
}
}
]
}
Response samples
- 201
{- "id": "69aea152-ba70-49a3-a31c-044ac1651146",
- "updatedAt": "2021-03-12T15:57:20.239Z",
- "createdAt": "2021-03-12T15:57:20.239Z",
- "clientId": "523afbe7-36dc-4654-9dba-e7167d0e5e2d",
- "mcc": "4040",
- "status": true,
- "providers": [
- {
- "id": "72cc1ff1-5f6e-4eb2-9cc5-6a3a85525e4b",
- "updatedAt": "2021-03-12T15:57:20.239Z",
- "createdAt": "2021-03-12T15:57:20.239Z",
- "name": "PagSeguro",
- "priority": 1,
- "credentials": {
- "type": "PAGSEGURO",
- "token": "1B2B32530CA23412AB63843240F5633",
- "email": "email@gmail.com"
}
}, - {
- "id": "2cf5c350-ee26-4557-a47d-9efe1765df51",
- "updatedAt": "2021-03-12T15:57:20.239Z",
- "createdAt": "2021-03-12T15:57:20.239Z",
- "deletedAt": null,
- "idempotencyKey": null,
- "requestId": null,
- "name": "pagarme",
- "priority": 2,
- "credentials": {
- "type": "PAGARME",
- "apiKey": "ak_test_Kaa8pfXJ3WOUdCsMQiRYuV66rJZLuA"
}
}
]
}
Listagem de merchants cadastrados
Authorizations:
query Parameters
page | number número da página |
limit | number quantidade de itens por página |
Responses
Response Schema: application/json
object | |||||||||||||||||||||||
| |||||||||||||||||||||||
object | |||||||||||||||||||||||
|
Response samples
- 200
{- "meta": {
- "itemCount": 10,
- "totalItems": 20,
- "itemsPerPage": 10,
- "totalPages": 5,
- "currentPage": 2
}, - "items": [
- {
- "id": "69aea152-ba70-49a3-a31c-044ac1651146",
- "updatedAt": "2021-03-12T15:57:20.239Z",
- "createdAt": "2021-03-12T15:57:20.239Z",
- "clientId": "523afbe7-36dc-4654-9dba-e7167d0e5e2d",
- "mcc": "4040",
- "status": true,
- "providers": [
- {
- "id": "72cc1ff1-5f6e-4eb2-9cc5-6a3a85525e4b",
- "updatedAt": "2021-03-12T15:57:20.239Z",
- "createdAt": "2021-03-12T15:57:20.239Z",
- "name": "PagSeguro",
- "priority": 1,
- "credentials": {
- "type": "PAGSEGURO",
- "token": "1B2B32530CA2464F8AB63843240F5633",
- "email": "email@gmail.com"
}
}, - {
- "id": "2cf5c350-ee26-4557-a47d-9efe1765df51",
- "updatedAt": "2021-03-12T15:57:20.239Z",
- "createdAt": "2021-03-12T15:57:20.239Z",
- "deletedAt": null,
- "idempotencyKey": null,
- "requestId": null,
- "name": "pagarme",
- "priority": 2,
- "credentials": {
- "type": "PAGARME",
- "apiKey": "ak_test_Kaa8pfXJ3WOUdCsMQiRYuV66rJZLuA"
}
}
]
}
]
}
Recuperar detalhes de merchant pelo id
Authorizations:
path Parameters
id required | string <uuid> id do merchant |
Responses
Response Schema: application/json
id | string dentificador do merchant | ||||||||||||||||||||||||
createdAt | string data de criação | ||||||||||||||||||||||||
clientId | string <uuid> identificador do client | ||||||||||||||||||||||||
mcc | string codigo mcc do cadatro do lojista no adquirente | ||||||||||||||||||||||||
status | string Enum: "active" "deleted" "pending" status do merchant | ||||||||||||||||||||||||
object (ProviderDto) | |||||||||||||||||||||||||
|
Response samples
- 200
{- "id": "69aea152-ba70-49a3-a31c-044ac1651146",
- "updatedAt": "2021-03-12T15:57:20.239Z",
- "createdAt": "2021-03-12T15:57:20.239Z",
- "clientId": "523afbe7-36dc-4654-9dba-e7167d0e5e2d",
- "mcc": "4040",
- "status": true,
- "providers": [
- {
- "id": "72cc1ff1-5f6e-4eb2-9cc5-6a3a85525e4b",
- "updatedAt": "2021-03-12T15:57:20.239Z",
- "createdAt": "2021-03-12T15:57:20.239Z",
- "name": "PagSeguro",
- "priority": 1,
- "credentials": {
- "type": "PAGSEGURO",
- "token": "1B2B32530CA23412AB63843240F5633",
- "email": "email@gmail.com"
}
}, - {
- "id": "2cf5c350-ee26-4557-a47d-9efe1765df51",
- "updatedAt": "2021-03-12T15:57:20.239Z",
- "createdAt": "2021-03-12T15:57:20.239Z",
- "deletedAt": null,
- "idempotencyKey": null,
- "requestId": null,
- "name": "pagarme",
- "priority": 2,
- "credentials": {
- "type": "PAGARME",
- "apiKey": "ak_test_Kaa8pfXJ3WOUdCsMQiRYuV66rJZLuA"
}
}
]
}
Atualizar configurações de merchant
Authorizations:
path Parameters
id required | string <uuid> id do merchant |
Request Body schema: application/json
mcc | string código de segmento do lojista no adquirente formado por quatro números, solicite ao seu provedor caso não saiba qual o seu Merchant Category Code. |
Responses
Request samples
- Payload
{- "mcc": "string"
}
Provedor | Cartão | Boleto | Pix | Descrição |
---|---|---|---|---|
PAGSEGURO |
SIM | NÃO | SIM | PagSeguro |
PAGARME |
SIM | SIM | SIM | Pagar.me |
CIELO |
SIM | NÃO | NÃO | Cielo |
STRIPE |
SIM | SIM | NÃO | Stripe |
ZOOP |
SIM | SIM | SIM | Zoop |
BS2 |
NÃO | NÃO | SIM | Banco BS2 Pix |
BS2_BOLETO |
NÃO | SIM | NÃO | Banco BS2 Boleto |
BB |
NÃO | NÃO | SIM | Banco do Brasil |
BRAINTREE |
SIM | NÃO | NÃO | Braintree |
REDE |
SIM | NÃO | NÃO | Rede |
MERCADO_PAGO |
SIM | NÃO | NÃO | Mercado pago |
ADYEN |
SIM | NÃO | SIM | Adyen |
PLUG_SANDBOX |
SIM | SIM | SIM | Simulador ambiente de teste |
Provedor | Realtime | Assíncrono | Descrição |
---|---|---|---|
CLEARSALE |
SIM | NÃO | Clearsale Realtime Decision e Behaviour Analytics |
DeclinedCode | ResponseMessage | O que fazer (ABECS) |
---|---|---|
card_not_supported | The card does not support this type of purchase | UTILIZE FUNÇÃO DÉBITO |
expired_card | The card expiration date is invalid | VERIFIQUE OS DADOS DO CARTÃO |
fraud_confirmed | The charge has been declined for confirmed fraud | TRANSAÇÃO NÃO PERMITIDA PARA O CARTÃO - NÃO TENTE NOVAMENTE |
fraud_suspect | The charge has been declined for suspect it is fraudulent | CONTATE A CENTRAL DO SEU CARTÃO |
generic | The card has been declined for a unknown reason | CONTATE A CENTRAL DO SEU CARTÃO |
insufficient_funds | The card has insufficient funds | NÃO AUTORIZADA |
invalid_amount | The charge amount is not valid or exceeded maximum allowed | VALOR DA TRANSAÇÃO NÃO PERMITIDO - NÃO TENTE NOVAMENTE |
invalid_cvv | The security code is invalid | SENHA INVÁLIDA |
invalid_data | The card has been declined for invalid data | VERIFIQUE OS DADOS DO CARTÃO |
invalid_installment | The charge has been declined because invalid number of installments | PARCELAMENTO INVÁLIDO - NÃO TENTE NOVAMENTE |
invalid_merchant | The charge has been declined because merchant is not valid | TRANSAÇÃO NÃO PERMITIDA - NÃO TENTE NOVAMENTE |
invalid_merchant | The charge has been declined because merchant is not valid | CONTA ORIGEM INVÁLIDA - NÃO TENTE NOVAMENTE |
invalid_number | The card number is invalid | VERIFIQUE OS DADOS DO CARTÃO |
invalid_pin | The card has been declined because pin is invalid | SENHA INVÁLIDA - NÃO TENTE NOVAMENTE |
issuer_not_available | The card issuer could not be reached, charge not authorized | DADOS DO CARTÃO INVÁLIDO - NÃO TENTE NOVAMENTE |
lost_card | The card has been declined because the card is reported lost | TRANSAÇÃO NÃO PERMITIDA - NÃO TENTE NOVAMENTE |
not_permitted | The charge is not permited to the card | TRANSAÇÃO NÃO PERMITIDA PARA O CARTÃO- NÃO TENTE NOVAMENTE |
pickup_card | The card cannot be used to make this charges | CONTATE A CENTRAL DO SEU CARTÃO - NÃO TENTE NOVAMENTE |
pin_try_exceeded | The card has been declined because exceeded maximum pin tries | EXCEDIDAS TENTATIVAS DE SENHA.CONTATE A CENTRAL DO SEU CARTÃO |
restricted_card | The card cannot be used to make this charge | DESBLOQUEIE O CARTÃO |
security_violation | The card has been declined for a unknown reason | VERIFIQUE OS DADOS DO CARTÃO |
service_not_allowed | The card has been declined because do not support international charge | CARTÃO NÃO PERMITE TRANSAÇÃO INTERNACIONAL |
stolen_card | The card has been declined because the card is reported stolen | TRANSAÇÃO NÃO PERMITIDA - NÃO TENTE NOVAMENTE |
transaction_not_allowed | The card has been declined for a unknown reason | ERRO NO CARTÃO - NÃO TENTE NOVAMENTE |
try_again | The card has been declined for a unknown reason | REFAZER A TRANSAÇÃO |
MCC | Descrição |
---|---|
742 | VETERINARIA |
744 | Carefree Resorts |
763 | COOPERATIVA AGRÍCOLA |
780 | SERVIÇOS DE PAISAGISMO E HORTICULTURA |
1520 | EMPREITEIROS EM GERAL - COMERCIAL E RESIDENCIAL |
1711 | PREST. DE SERV. PARA AR COND., ENCANAMENTO E AQUEC. |
1731 | ELETRICISTAS E SERVIÇOS ELÉTRICOS |
1740 | PEDREIROS E SERVIÇOS DE INSTALAÇÃO |
1750 | MARCENEIROS E SERVIÇOS DE CARPINTARIA |
1761 | METALURGICOS |
1771 | EMPREITEIO PARA SERVIÇOS ESPECIALIZADO |
1799 | DEMAIS SVS DE REFORMA E CONSTRUÇÃO NÃO-CLASSIFICADOS |
2741 | EDITORAS - PUBLICAÇÕES E IMPRESSÕES |
2791 | TYPESETTING, PLATE MAKING AND RELATED SERVICES |
2842 | SERVIÇOS DE LIMPEZA E POLIMENTO |
4011 | TRANSPORTE FERROVIÁRIO DE CARGA |
4111 | TRANSPORTE LOCAL DE PASSAGEIROS, INCLUINDO BALSAS |
4112 | TRANSPORTE DE PASSAGEIROS EM TREM (LONGA DISTÂNCIA) |
4119 | AMBULANCIAS |
4121 | LIMUSINES E TÁXIS (TAXICABS AND LIMOUSINES) |
4131 | COMPANHIAS DE ONIBUS |
4214 | TRANSPORTE DE CARGA RODOVIÁRIO E ARMAZENAMENTO |
4215 | CORREIOS - AÉREO, TERRESTRE E TRANSITÓRIOS |
4225 | ARMAZENAM. PROD AGRÍCOLAS,MERCAD REFRIGERADAS,BENS DOMÉSTICO |
4411 | LINHAS DE CRUZEROS (CRUISE LINES) |
4457 | ALUGUEL E ARRENDAMENTO DE BARCOS, ESQUIS E IATES |
4468 | MARINAS, SERVIÇOS E FORNECEDORES |
4511 | OUTRAS CIAS AÉREAS |
4582 | AEROPORTOS E SERVIÇOS LIGADOS A AERONAVES |
4722 | AGÊNCIAS DE VIAGENS (TRAVEL AGENCIES) |
4723 | AGÊNCIAS DE VIAGEM TUI (TUI TRAVEL AGENCY) |
4784 | PEDÁGIOS |
4789 | SERVIÇOS DE TRANSPORTE |
4812 | TELEFONES E EQUIPAMENTOS DE TELECOMUN. |
4813 | SERVIÇOS DE TELEC.- CHAM. LOCAIS E LONGA DISTÂNCIA |
4814 | SERVIÇOS DE TELECOMUNICAÇÃO |
4816 | REDES DE COMPUTADORES / SERVIÇOS DE INFORMAÇÃO |
4821 | TELEGRAFO |
4829 | ORDENS DE PAGAMENTO POR TRANSFERÊNCIA BANCÁRIA |
4899 | SERVIÇOS DE TV A CABO/PAGA (CABLE/PAY TV SERVICES) |
4900 | UTILID./ELEC/GAS/AGUÁ/SANI (UT../ELEC/GAS/H2O/SANI) |
5013 | ATACADISTAS E DISTRIBUIDORES DE ACESSÓRIOS DE VEÍCULOS |
5021 | MÓVEIS PARA ESCRITÓRIOS (COMMERCIAL FURNITURE) |
5039 | MATERIAL PARA CONSTRUÇÃO E AFINS (CONST. MAT. - DEF) |
5044 | A/D DE EQUIPAMENTOS DE FOTOGRAFIA, CÓPIA E MICROFILME |
5045 | COMPUTADORES, EQUIPAMENTOS E SOFTWARES |
5046 | A/D DE MÁQUINAS E EQUIPAMENTOS PARA EC |
5047 | A/D DE EQUIPAMENTO HOSPITALARES, MÉDICOS E OFTÁLMICOS |
5051 | CENTROS DE SERVIÇOS DE METAIS (METAL SERVICE CENTERS) |
5065 | LOJA ARTIGOS ELETRÔNICOS |
5072 | EQUIP./DISTRIB. DE HARDWARE (HARDWARE EQUIP.SUPPLIES) |
5074 | EQUIP. DE AQUECIMENTO/ENCANAMENTO (PLUMB./HEAT. E.) |
5085 | A/D DE SUPRIMENTOS INDUSTRIAIS (NÃO CLASSIFICADO EM OUTRO) |
5094 | JOALHERIA, PEDRAS PRECIOSAS, METAIS |
5099 | ATACADISTAS E DISTRIBUIDORES DE MERCADORIAS DURÁVEIS |
5111 | A/D DE ARTIGOS DE PAPELARIA E SUPRIMENTOS PARA ESCRITÓRIO |
5122 | FARMACEUTICOS/DROGAS (DRUGS/DRUGGISTS SUNDRIES) |
5131 | A/D DE TECIDOS E PRODUTOS DE ARMARINHO |
5137 | ATACADISTAS E DISTRIBUIDORES DE ROUPAS |
5139 | ATACADISTAS E DISTRIBUIDORES DE CALÇADOS |
5169 | A/D DE PRODUTOS QUIMICOS E SEMELHANTES (N CLASSIF. EM OUTRO) |
5172 | PRODUTOS DE PETRÓLEO (PETROLEUM/PETROLEUM PRODUCTS) |
5192 | ATAC. E DISTRIB. DE LIVROS, PERIÓDICOS E JORNAIS |
5193 | ATACADISTAS E DISTRIBUIDORES DE FLORES, PLANTAS E SEMENTES |
5198 | PINTURA, POLIMENTO E SUPRIM. (PAN.,VARN. & SUPPLIES) |
5199 | A/D DE MERCADORIAS NÃO DURÁVEIS (NÃO CLASSIF. EM OUTRO) |
5200 | LOJAS DE MATERIAL DE CONSTRUÇÃO (PEQUENO/MÉDIO PORTE) |
5211 | LOJAS DE MATERIAL DE CONSTRUÇÃO-PRODUTOS BRUTOS (EX: TIJOLO) |
5231 | LOJAS DE VIDROS, TINTAS E PAPÉIS DE PAREDE |
5251 | VENDA DE EQUIPAMENTOS, INCLUINDO DE FERRAGEM |
5261 | JARDINAGEM |
5271 | CORRETORES DE RESIDÊNCIAS MÓVEIS |
5300 | VENDA POR ATACADO (WHOLESALE CLUBS) |
5309 | DUTY FREE STORES |
5310 | LOJAS DE DESCONTO |
5311 | LOJAS DE DEPARTAMENTOS (DEPARTMENT STORES) |
5331 | LOJAS DE VARIEDADES |
5399 | LOJA MERCADORIAS GERAIS |
5411 | MERCEARIAS/SUPERMERCADOS (GROCERY STORES/SUPERM.) |
5422 | AÇOGUEIRO (FREEZER/MEAT LOCKERS) |
5441 | LOJA DE DOCES |
5451 | LOJA DE PRODUTOS DE LACTICÍNIOS (DAIRY PROD. STORES) |
5462 | CONFEITARIAS (BAKERIES) |
5499 | LOJA DE ALIMENTOS VARIADOS (MISC FOOD S. - DEFAULT) |
5511 | VENDA DE CARROS E CAMINHÕES (NOVOS E USADOS) |
5521 | VENDA DE CARROS USADOS |
5531 | Lojas de Automóveis, Lojas de Acessórios Domésticos |
5532 | LOJA DE PNEUS |
5533 | LOJA DE PEÇAS E ACESSÓRIOS DE CARROS |
5541 | ESTAÇÕES DE SERVIÇOS (SERVICE STATIONS) |
5551 | VENDA DE BARCOS MOTORIZADOS |
5561 | ARTIGOS PARA ACAMPAMENTO |
5571 | LOJAS DE MOTOCICLETAS E ACESSÓRIOS |
5592 | VENDA DE TRAILLERS |
5598 | CONSECIONÁRIA DE SNOWMOBILE |
5599 | SERVIÇOS GERIAS PARA CARROS |
5611 | ARTIGOS MASCULINOS |
5621 | LOJA DE ROUPAS FEMININAS "PRONTA PARA USAR" |
5631 | ACESSORIOS FEMININOS E LINGERIES |
5641 | ARTIGOS PARA CRIANÇAS E BEBÊS |
5651 | ROUPAS MASCULINAS, FEMININAS E INFANTIS |
5655 | ROUPA ESPORTIVA |
5661 | LOJAS DE SAPATOS |
5681 | LOJA DE PELES |
5691 | OJA ROUPA UNISSEX |
5697 | COSTUREIRAS E ALFAIATES |
5698 | LOJAS DE PERUCA |
5699 | SERVIÇOS GERIAS PARA VESTIMENTA |
5712 | LOJA DE MÓVEIS |
5713 | Loja de Pisos |
5714 | LOJA DE ESTOFADOS (DRAPERY & UPHOLSTERY STORES) |
5718 | LAREIRAS E ACESSÓRIOS (FIREPLACES & ACCESSORIES) |
5719 | LOJA DE MÓVEIS ESPECIALIZADA (HOME FURNISHING SPEC.) |
5722 | LOJAS DE ELETRODOMÉSTICOS |
5732 | LOJA DE ELETRÔNICOS |
5733 | LOJA INSTRUMENTO MUSICAIS |
5734 | LOJA DE SOFTWARE |
5735 | LOJAS DE DISCOS |
5811 | DISTRIBUIÇÃO E PRODUÇÃO DE ALIMENTOS |
5812 | RESTAURANTES |
5813 | BARES, PUBS E CASA NOTURNAS |
5814 | LANCHONETES DE COMIDAS RÁPIDAS (FAST FOOD) |
5815 | Produtos Digitais - De comunicação social audiovisual, incluindo Livros, Filmes e Música |
5816 | Pordutos Digitais - Jogos |
5817 | Produtos Digitais - Aplicativos de Software (Exceto Jogos) |
5818 | Produtos Digitais - Diversas Categorias |
5912 | FARMÁCIAS (DRUG STORES & PHARMACIES) |
5921 | CERVEJAS, VINHOS E LICORES (STORE/BEER/WINE/LIQUOR) |
5931 | LOJAS DE ARTIGOS DE SEGUNDA MÃO / BRECHÓS |
5932 | LOJA DE ANTIGUIDADES (ANTIQUE SHOPS) |
5933 | LOJAS DE PENHORES |
5935 | DEMOLIÇÕES, SUCATAS, DESMANCHES DE AUTOMÓVEIS |
5937 | L. DE REPRODUÇÃO DE ANTIQUIDADES (ANT.REPROD. STORES) |
5940 | LOJA DE BICICLETAS - VENDAS E SERVIÇOS |
5941 | SERVIÇOS GERAIS PARA ESPORTES |
5942 | LIVRARIAS |
5943 | PAPELARIAS |
5944 | JOALHERIA (JEWERLY STORE) |
5945 | LOJA DE BRINQUEDOS |
5946 | LOJA DE FOTOGRAFIA |
5947 | LOJA DE PRESENTES |
5948 | ARTIGOS DE COURO |
5949 | ARMARINHOS E LOJAS DE TECIDO |
5950 | LOJA DE COPOS/CRISTAIS (GLASSWARE/CRYSTAL STORES) |
5960 | MARK.DIRETO DE SEGUROS (DIR. MARKET. INSURANCE SVC) |
5962 | SERV. DIRETOS DE VIAGENS (D. MKTG-TRAV. RELATED ARR) |
5963 | VENDA DIRETA (DIRECT SELL/DOOR-TO-DOOR) |
5964 | CATALOGO DE COMERCIOS (CATALOG MERCHANT) |
5965 | CATÁLOGO DE VAREJO (COMB.CATALOG & RETAIL) |
5966 | MARKETING DIRETO-SAÍDA (OUTB. TELEMARKETING M.) |
5967 | MARKETING DIRETO - ENTRADA (INB. TELEMARKETING M.) |
5968 | ASSINATURA COMERCIAL (CONTINUITY/SUBSCRIP. MERCHANT) |
5969 | OUTROS VENDEDORES DE MARKETING DIRETO |
5970 | PRODUTOS ARTESANAIS |
5971 | GALERIA DE ARTE (ART DEALERS & GALLERIES) |
5972 | LOJA DE MOEDAS E SELOS |
5973 | LOJA DE BENS RELIGIOSOS |
5975 | APARELHOS AUDITIVOS - VENDAS E SERVIÇOS |
5976 | BENS ORTOPÉDICOS - PRÓTESES |
5977 | LOJA DE COSMÉTICOS |
5978 | MÁQUINAS DE ESCREVER - VENDA, ALUGUEL E SERVIÇOS |
5983 | REVENDEDORES DE COMBUSTÍVEIS (FUEL DEALERS) |
5992 | FLORICULTURA |
5993 | TABACARIA |
5994 | BANCA DE JORNAL E PROVEDOR DE NOTÍCIAS |
5995 | PET SHOP |
5996 | PISCINAS E BANHEIRAS - SERVIÇOS, SUPRIMENTOS E VENDAS |
5997 | NAVALHA ELÉTRICA - VENDA E SERVIÇOS |
5998 | LOJAS DE BARRACAS E TOLDOS |
5999 | LOJAS ESPECIALIZADAS NÃO LISTADAS ANTERIOMENTE |
6010 | BANCOS / LOJAS DE POUPANÇA E INST. FINANCEIRA |
6011 | INSTIUIÇÃO FINANCEIRA - CAIXA ELETRÔNICO |
6012 | INSTIUIÇÃO FINANCEIRA - AGÊNCIAS E SERVIÇOS |
6050 | Similar a Dinheiro (Quase Cash) - Instituição Financeira Cliente |
6051 | CASAS DE CÂMBIO |
6211 | CORRETORES DE IMÓVEIS (SECURITIES BROKERS/DEALERS) |
6300 | VENDA DE SEGUROS(INSURANCE SALES/UNDERWRITE) |
6513 | CORRETOR DE IMÓVEIS (ALUGUEL) |
6532 | PAGTOS DE TRANSAÇÕES DE INST.FINANCEIRAS |
6533 | PAGTOS DE TRANSAÇÕES COMERCIAIS |
7011 | HOTEIS (HOTELS/MOTELS/RESORTS) |
7012 | TEMPO COMPARTILHADO (TIMESHARE) |
7032 | ACAMPAMENTOS RECREATIVOS E DEPORTIVOS |
7033 | SERVIÇOS DE ACAMPAMENTOS |
7210 | LAVANDARIA, LIMPEZA E SERVIÇOS DE VESTUÁRIO |
7211 | LAVANDERIA - FAMILIAR E COMERCIAL |
7216 | LAVANDERIA TINTURARIA |
7217 | LIMPEZA DE TAPETES E ESTOFADOS |
7221 | ESTÚDIOS DE FOTOGRAFIA |
7230 | SALAO DE BELEZA / BARBEARIA / DEPILAÇÃO / MANICURE |
7251 | LOJA/REPARO DE SAPATOS |
7261 | SERVIÇO FUNERÁRIO |
7273 | SERVIÇO DE ENCONTROS E ACOMPANHANTE |
7276 | SERVIÇOS DE PREP. IMPOST. DE RENDA (TAX PREP. SVCS) |
7277 | S. DE ACONSELHAMENTO DE DÍVIDAS, CASAMENTO E PESSOAL |
7278 | CLUBES DE COMPRAS |
7296 | ALUGUEL DE ROUPAS - FANTASIAS, UNIFORMES E ROUPAS SOCIAIS |
7297 | CENTRO DE SAUNAS E MASSAGENS |
7298 | CLÍNICAS DE ESTÉTICA FACIAL / CORPORAL |
7299 | OUTROS SERVIÇOS PESSOAIS |
7311 | PUBLICIDADES |
7321 | AGÊNCIAS DE ANÁLISE DE CRÉDITO DE CONSUMIDORES |
7333 | SERVIÇOS DE IMPRESSÃO E ARTE GRÁFICA |
7338 | COPIADORAS E FOTOCOPIADORAS |
7339 | SERVIÇO DE SECRETARIADO E ESTENOGRAFIA |
7342 | DEDETIZAÇÃO E DESINFECÇÃO |
7343 | SERVIÇO DE EXTERMINIO E DESINFETAÇÃO |
7349 | SERVIÇO LIMPEZA E MANUTENÇÃO |
7361 | AGÊNCIAS DE EMPREGO |
7372 | SERVIÇOS DE PROGRAMAÇÃO DE COMPUTADORES E PROCESS. DE DADOS |
7375 | SERVIÇO DE RECUPERAÇÃO DE INFORMAÇÃO |
7379 | COMPUTADORES: CONCERTOS E REPAROS |
7392 | CONSULTORIA EMPRESARIAL E SERVIÇOS DE RELAÇÕES PÚBLICAS |
7393 | AGÊNCIAS DE DETETIVES, PROTECÇÃO E DE SEGURANÇA |
7394 | ALUGUEL DE EQUIPAMENTO E MOBÍLIA DE ESCRITÓRIOS |
7395 | LABORATÓRIOS FOTOGRÁFICOS |
7399 | SERVIÇOS DE NEGÓCIOS |
7511 | PARADA DE CAMINHÕES (TRUCK STOP) |
7512 | ALUGUEL DE AUTOMÓVEIS (AUTOMOBILE RENTAL AGENCY) |
7513 | ALUGUEL DE CAMINHÕES (TRUCK/UTILITY TRAILER RENTALS) |
7519 | ALUGUEL DE MOTOR HOME (MOTOR HOME/RV RENTALS) |
7523 | ESTACIONAMENTOS E GARAGENS DE CARRO |
7531 | FUNILARIAS E PINTURA AUTOMOTIVA |
7534 | BORRACHARIAS |
7535 | LOJAS DE PINTURA DE AUTTOMÓVEIS |
7538 | SERVIÇOS PARA CARROS (NÃO CONCESIONARIA) |
7542 | LAVA JATO |
7549 | GUINCHO |
7622 | CONSERTO DE EQUIP. AUDIO E TV |
7623 | CONSERTO DE AR CONDICIONADO |
7629 | CONSERTO DE ELETRONICOS |
7631 | CONSERTO DE RELÓGIOS E JÓIAS |
7641 | RESTAURAÇÃO DE MÓVEIS (FURNITURE REPAIR) |
7692 | SERRALHEIROS E SOLDADORES |
7699 | LOJA DE CONSERTOS GERAIS E SERVIÇOS RELACIONADOS |
7829 | PRODUTORES E DISTRIBUIDORES DE FILMES |
7832 | CINEMAS, PRODUÇÕES CINEMATOGRÁFICAS |
7841 | LOJAS DE VIDEOS |
7911 | DANÇA (ESTUDIOS, ESCOLAS E SALÕES) |
7922 | TEATROS, PRODUC. TEATR. E ESPECTAC. |
7929 | BANDAS,ORQUESTRAS,ARTISTAS DIVERSOS(N CLASSIFICADO EM OUTRO) |
7932 | BARES DE SINUCA |
7933 | BOLICHE |
7941 | QUADRAS DE ESPORTE / PROPAGANDA ESPORTIVA |
7991 | ATRAÇÕES TURÍSTICAS E EXPOSIÇÕES |
7992 | AULAS DE GOLF PUBLICA |
7993 | FORNECEDORES DE MÁQUINAS DE VIDEOGAME OU JOGOS |
7994 | LOJAS DE DIVERSÃO / VIDEO GAME / LAN HOUSE / CIBER CAFÉ |
7995 | CASSINOS, LOTERIAS E JOGOS DE AZAR |
7996 | PARQUE DE DIVERSAO, CIRCO E AFINS |
7997 | ACADEMIAS / CLUBES |
7998 | AQUÁRIOS E ZOOLÓGICOS |
7999 | SERVIÇOS DE RECREAÇÃO E FESTAS |
8011 | MÉDICOS (CLÍNICAS E CONSULTÓRIOS) |
8021 | DENTISTAS E ORTODONTISTAS (CLÍNICAS E CONSULTÓRIOS) |
8031 | OSTEOPATAS |
8041 | QUIROPRAXIA |
8042 | OFTAMOLOGISTA E OPTOMETRISTAS |
8043 | OPTICIANS, OPTICAL GOODS, AND EYEGLASSES |
8049 | TRATAMENTOS PODIÁTRICOS |
8050 | CASAS DE REPOUSO, CLÍN. DE RECUPERAÇÃO E ENFERMAGEM |
8062 | HOSPITAIS |
8071 | ANALISES CLÍNICAS MÉDICAS E DENTAIS |
8099 | MEDICINA EM GERAL E PRATICANTES DE SERVIÇOS DE SAÚDE |
8111 | SERVIÇOS JURÍDICOS - ADVOGADOS |
8211 | EDUCAÇÃO PRIMÁRIA E SECUNDÁRIA (ELEM./SEC.S.) |
8220 | UNIVERSIDADES E FACULDADES (COLLEGES/UNIV/JC/PROF.) |
8241 | EDUACAÇÃO A DISTÂNCIA (CORRESPONDENCE SCHOOLS) |
8244 | ESCOLA DE COMÉRCIOS E SECRETARIADO (BUS./SEC. SCHOOL) |
8249 | ESCOLA DE NEGÓCIOS/VOCAÇÕES (TRADE/VOCATIONS S.) |
8299 | COLEGIOS (SCHOOLS) |
8351 | SERVIÇOS DE CUIDADOS DE CRIANÇAS (CHILD CARE SVCS) |
8398 | ORGANIZAÇÕES DE SERVIÇOS BENEFICENTES E SOCIAIS |
8641 | ASSOCIAÇÕES CÍVICAS E SOCIAIS |
8651 | ORGANIZAÇÕES POLITICAS |
8661 | ORGANIZAÇÕES RELIGIOSAS |
8675 | ASSOCIAÇÃO DE CARROS |
8699 | ORG. SIND., ASSOC. CULT. E OTRS ASSOC. NÃO CLASSIF. |
8734 | LABORATÓRIOS DE TESTE (PARA TESTES NÃO MÉDICOS) |
8911 | ARQUIRETURA, ENGENHARIA E AGRIMENSURA |
8931 | CONTABILIDADE, AUDITORIA E SERVIÇOS DE CONTABILIDADE |
8999 | OUTROS SERVIÇOS PROFISSIONAIS DE ESPECIALIZADOS |
9211 | PENSÃO ALIMENTÍCIA (COURT COSTS/ALIMONY/SUPPORT) |
9222 | MULTAS (FINES) |
9223 | PAGAMENTOS DE TÍTULOS E FINANÇAS (BAIL AND BOND P.) |
9311 | PAGAMENTOS DE IMPOSTOS (TAX PAYMENTS) |
9399 | SERVIÇOS GOVERNAMENTAIS (GOVT SERV - DEFAULT) |
9402 | POSTAGENS (POSTAGE STAMPS) |
9405 | COMPRAS GOVERNAMENTAIS (INTRA-GOVERNMENT PURCHASES) |
9406 | Loteria de Propriedade do Governo (Países Específicos |
9950 | DEPART. DE COMPRAS (INTRA- COMPANY PURCHASES) |
Currency Code | Currency |
---|---|
BRL | Brazilian real |
USD | United States dollar |
EUR | Euro |
YER | Yemeni rial |
ZAR | South African rand |
AED | United Arab Emirates dirham |
AFN | Afghan afghani |
ALL | Albanian lek |
AMD | Armenian dram |
ANG | Netherlands Antillean guilder |
AOA | Angolan kwanza |
ARS | Argentine peso |
AUD | Australian dollar |
AWG | Aruban florin |
AZN | Azerbaijani manat |
BAM | Bosnia and Herzegovina convertible mark |
BBD | Barbados dollar |
BDT | Bangladeshi taka |
BGN | Bulgarian lev |
BIF | Burundian franc |
BMD | Bermudian dollar |
BND | Brunei dollar |
BOB | Boliviano |
BSD | Bahamian dollar |
BWP | Botswana pula |
BZD | Belize dollar |
CAD | Canadian dollar |
CDF | Congolese franc |
CHF | Swiss franc |
CLP | Chilean peso |
CNY | Chinese yuan[8] |
COP | Colombian peso |
CRC | Costa Rican colon |
CVE | Cape Verdean escudo |
CZK | Czech koruna |
DJF | Djiboutian franc |
DKK | Danish krone |
DOP | Dominican peso |
DZD | Algerian dinar |
EGP | Egyptian pound |
ETB | Ethiopian birr |
ZMW | Zambian kwacha |
FJD | Fiji dollar |
FKP | Falkland Islands pound |
GBP | Pound sterling |
GEL | Georgian lari |
GIP | Gibraltar pound |
GMD | Gambian dalasi |
GNF | Guinean franc |
GTQ | Guatemalan quetzal |
GYD | Guyanese dollar |
HKD | Hong Kong dollar |
HNL | Honduran lempira |
HRK | Croatian kuna |
HTG | Haitian gourde |
HUF | Hungarian forint |
IDR | Indonesian rupiah |
ILS | Israeli new shekel |
INR | Indian rupee |
ISK | Icelandic króna |
JMD | Jamaican dollar |
JPY | Japanese yen |
KES | Kenyan shilling |
KGS | Kyrgyzstani som |
KHR | Cambodian riel |
KMF | Comoro franc |
KRW | South Korean won |
KYD | Cayman Islands dollar |
KZT | Kazakhstani tenge |
LAK | Lao kip |
LBP | Lebanese pound |
LKR | Sri Lankan rupee |
LRD | Liberian dollar |
LSL | Lesotho loti |
MAD | Moroccan dirham |
MDL | Moldovan leu |
MGA | Malagasy ariary |
MKD | Macedonian denar |
MMK | Myanmar kyat |
MNT | Mongolian tögrög |
MOP | Macanese pataca |
MRO | Macanese pataca |
MUR | Mauritian rupee |
MVR | Maldivian rufiyaa |
MWK | Malawian kwacha |
MXN | Mexican peso |
MYR | Malaysian ringgit |
MZN | Mozambican metical |
NAD | Namibian dollar |
NGN | Nigerian naira |
NIO | Nicaraguan córdoba |
NOK | Norwegian krone |
NPR | Nepalese rupee |
NZD | New Zealand dollar |
PAB | Panamanian balboa |
PEN | Peruvian sol |
PGK | Papua New Guinean kina |
PHP | Philippine peso[12] |
PKR | Pakistani rupee |
PLN | Polish złoty |
PYG | Paraguayan guaraní |
QAR | Qatari riyal |
RON | Romanian leu |
RSD | Serbian dinar |
RUB | Russian ruble |
RWF | Rwandan franc |
SAR | Saudi riyal |
SBD | Solomon Islands dollar |
SCR | Seychelles rupee |
SEK | Swedish krona/kronor |
SGD | Singapore dollar |
SHP | Saint Helena pound |
SLL | Sierra Leonean leone |
SOS | Somali shilling |
SRD | Surinamese dollar |
STD | South Sudanese pound |
SZL | Swazi lilangeni |
THB | Thai baht |
TJS | Tajikistani somoni |
TOP | Tongan paʻanga |
TRY | Turkish lira |
TTD | Trinidad and Tobago dollar |
TWD | New Taiwan dollar |
TZS | Tanzanian shilling |
UAH | Ukrainian hryvnia |
UGX | Ugandan shilling |
UYU | Uruguayan peso |
UZS | Uzbekistan som |
VND | Vietnamese đồng |
VUV | Vanuatu vatu |
WST | Samoan tala |
XAF | CFA franc BEAC |
XCD | East Caribbean dollar |
XOF | CFA franc BCEAO |
XPF | CFP franc (franc Pacifique) |
Country Code | Document Type | Group | Country | Meaning |
---|---|---|---|---|
AL | NIPT | Vat | Albania | Vat Identifier (Numri i Identifikimit për Personin e Tatueshëm) |
AD | NRT | Tax | Andorra | Tax Identifier (Número de Registre Tributari) |
AR | CBU | Bank | Argentina | Bank Account (Clave Bancaria Uniforme) |
AR | CUIT | Tax | Argentina | Tax Identity (Código Único de Identificación Tributaria) |
AR | DNI | Person | Argentina | National Identity (Documento Nacional de Identidad) |
AT | Businessid | Company | Austria | Austrian Company Register Numbers |
AT | TIN | Tax | Austria | Austrian tax identification number (Abgabenkontonummer) |
AT | UID | VAT | Austria | Austrian VAT number (Umsatzsteuer-Identifikationsnummer) |
AT | VNR | Person | Austria | Austrian social security number(Versicherungsnummer) |
AU | ABN | Company | Australia | Australian Business Number |
AU | ACN | Company | Australia | Australian Company Number |
AU | TFN | Tax/Person/Company | Australia | Australian Tax File Number |
BA | JMBG | Person | Bosnia and Herzegovina | Unique Master Citizen Number |
BZ | TIN | Person/Company | Belize | Brazilian Tax ID () |
BE | VAT | Company | Belgium | Belgian Enterprise Number |
BG | EGN | Person | Bulgaria | ЕГН, Единен граждански номер, Bulgarian personal identity codes |
BG | PNF | Person | Bulgaria | PNF (ЛНЧ, Личен номер на чужденец, Bulgarian number of a foreigner). |
BG | VAT | Company | Bulgaria | Идентификационен номер по ДДС, Bulgarian VAT number |
BR | CPF | Person | Brazil | Brazilian identity number (Cadastro de Pessoas Físicas) |
BR | CNPJ | Company | Brazil | Brazilian company number (Cadastro Nacional da Pessoa Jurídica) |
BY | UNP | Person/Company | Belarus | Учетный номер плательщика, the Belarus VAT number |
CA | BN | Company | Canada | Company Identifier (Canadian Business Number) |
CA | SIN | Person | Canada | Person Identifier (Social Insurance Number) |
CU | NI | Person | Cuba | Número de identidad, Cuban identity card numbers |
CY | VAT | Company | Cyprus | Αριθμός Εγγραφής Φ.Π.Α. (Cypriot VAT number) |
CZ | DIC | Company | Czech Republic | Daňové identifikační číslo, Czech VAT number |
CZ | RC | Person | Czech Republic | Rodné číslo, the Czech birth number |
CH | SSN | Person | Swisserland | Swiss social security number ("Sozialversicherungsnummer") |
CH | UID | Company | Swisserland | Unternehmens-Identifikationsnummer, Swiss business identifier |
CH | VAT | Company | Swisserland | Mehrwertsteuernummer, the Swiss VAT number |
CL | RUT | Tax | Chile | Tax Identifier (Rol Unico Tributario) [RUN] |
CN | RIC | Person | China | Person Identifier (Chinese Resident Identity Card Number) |
CN | USCC | Company | China | Company Identifier (Unified Social Credit Code, 统一社会信用代码, China tax number) |
CO | NIT | Tax | Columbia | Tax Identifier (Número de Identificación Tributaria) |
CR | CPF | Person | Costa Rica | Person Identifier (Cédula de Persona Física) |
CR | CPJ | Company | Costa Rica | Company Identifier (Cédula de Persona Jurídica) |
CR | CR | Person | Costa Rica | Person Identifier (Cédula de Residencia) |
DE | IDNR | Person | Germany | Steuerliche Identifikationsnummer, German personal tax number |
DE | STNR | Company | Germany | Steuernummer, German tax number |
DE | VAT | Company | Germany | Vat identifier |
DK | VAT | Company | Denmark | Momsregistreringsnummer, Danish VAT number |
DO | CEDULA | Person | Dominican Republic | Person Identifier (Cédula de Residencia) |
DO | NCF | Vat | Dominican Republic | Tax Receipt Number (Números de Comprobante Fiscal) |
DO | RNC | Tax | Dominican Republic | Person Identifier (Registro Nacional del Contribuyente) |
EC | CI | Person | Ecuador | Ecuadorian person identifier (Cédula de identidad) |
EE | IK | Person | Estonia | Isikukood (Estonian Personcal ID number). |
EE | KMKR | Company | Estonia | KMKR (Käibemaksukohuslase, Estonian VAT number) |
EE | Registrikood | Company | Estonia | Registrikood (Estonian organisation registration code) |
EC | RUC | Tax/Vat | Ecuador | Ecuadorian company tax number (Registro Único de Contribuyentes) |
SV | NIT | Tax | El Salvador | Tax Identifier (Número de Identificación Tributaria) |
GT | CUI | Person | Guatemala | Guatemala person (Código Único de Identificación) |
GT | NIT | Company | Guatemala | Guatemala company tax number (Número de Identificación Tributaria) |
FI | ALV | Company | Finland | ALV nro (Arvonlisäveronumero, Finnish VAT number) |
FI | HETU | Person | Finland | HETU (Henkilötunnus, Finnish personal identity code) |
FI | YTUNNUS | Company | Finland | Y-tunnus (Finnish business identifier) |
FR | NIF | Person | France | NIF (Numéro d'Immatriculation Fiscale, French tax identification number) |
GB | UTR | Person | Great Brittan | UTR (United Kingdom Unique Taxpayer Reference) |
GB | VAT | Company | Great Brittan | VAT (United Kingdom (and Isle of Man) VAT registration number) |
GR | AMKA | Company | Greece | AMKA (Αριθμός Μητρώου Κοινωνικής Ασφάλισης, Greek social security number) |
GR | VAT | Company | Greece | FPA, ΦΠΑ, ΑΦΜ (Αριθμός Φορολογικού Μητρώου, the Greek VAT number) |
FR | NIR | Person | France | NIR (French personal identification number) |
FR | SIREN | Company | France | SIREN (a French company identification number) |
FR | SIRET | Company | France | SIRET (a French company establishment identification number) |
FR | TVA | Vat | France | VAT Identifier |
HR | OIB | Person | Croatia | Osobni identifikacijski broj, Croatian identification number |
HK | HKID | Person | Hong Kong | Hong Kong Identity Card |
HU | ANUM | Vat | Hungaria | ANUM (Közösségi adószám, Hungarian VAT number) |
IS | KENNITALA | Person/Company | Iceland | Icelandic personal and organisation identity code |
IS | VSK | Vat | Iceland | Virðisaukaskattsnúmer, Icelandic VAT number |
ID | NPWP | Person/Company | Indonesia | NPWP (Nomor Pokok Wajib Pajak, Indonesian VAT Number). |
IE | PPS | Person | Ireland | Personal Public Service Number, Irish personal number |
IE | VAT | Tax/Vat | Ireland | Ireland Value Added Tax ID |
IN | AADHAAR | Company | India | Indian digital resident personal identity number |
IN | PAN | Person | India | Permanent Account Number, Indian income tax identifier |
IL | IDNR | Person | Israel | Identity Number (Mispar Zehut, מספר זהות, Israeli identity number) |
IL | HR | Company | Israel | Company Number (מספר חברה, or short ח.פ. Israeli company number) |
IT | AIC | Drug | Italy | Italian code for identification of drugs |
IT | CODICEFISCALE | Person | Italy | Codice Fiscale (Italian tax code for individuals) |
IT | IVA | Vat | Italy | Partita IVA (Italian VAT number) |
LI | PEID | Person/Company | Liechtenstein | Personenidentifikationsnummer |
LT | ASMENS | Person | Lithuanian | Asmens kodas (Person Number) |
LT | PVM | Vat | Lithuanian | Pridėtinės vertės mokestis mokėtojo kodas |
LU | TVA | Vat | Luxembourgian | taxe sur la valeur ajoutée |
LV | PVN | Person/Vat | Latvian | Pievienotās vērtības nodokļa |
MK | JMBG | Person | Macedonia | Unique Master Citizen Number (Единствен матичен број на граѓанинот) |
MC | TVA | Vat | Monaco | taxe sur la valeur ajoutée, Monacan VAT number |
MD | IDNO | Vat | Moldavia | Moldavian VAT number |
MT | VAT | Vat | Malta | Maltese VAT number |
MU | NID | Person | Mauritius | ID number (Mauritian national identifier) |
JP | CN | Company | Japan | 法人番号, hōjin bangō, Japanese Corporate Number |
KR | BRN | Company | South Korea | 사업자 등록 번호, South Korea Business Registration Number) |
KR | RRN | Person | South Korea | South Korean resident registration number |
MX | RFC | Tax/Vat | Mexico | Tax Identifier (Registro Federal de Contribuyentes) |
MX | CURP | Person | Mexico | Individual Identifier (Clave Única de Registro de Población) |
MX | CLABE | Bank | Mexico | Bank Account (Clave Bancaria Estandarizada) |
ME | JMBG | Person | Montenegro | Unique Master Citizen Number |
MY | NRIC | Person | Malaysia | Malaysian National Registration Identity Card Number |
NL | BSN | Person | Netherlands | Burgerservicenummer, the Dutch citizen identification number |
NL | BTW | Vat | Netherlands | Btw-identificatienummer (Omzetbelastingnummer, the Dutch VAT number) |
NL | Onderwijsnummer | Person | Netherlands | Onderwijsnummer (the Dutch student identification number) |
NZ | IRD | Person/Company | New Zealand | New Zealand Inland Revenue Department (Te Tari Tāke) number |
NZ | BANK | Bank | New Zealand | New Zealand Bank Account numbers - checkdigit |
NO | Fodsels | Person | Norway | Fødselsnummer (Norwegian birth number, the national identity number) |
NO | Konto | Bank | Norway | Konto nr. (Norwegian bank account number) |
NO | MVA | Vat | Norway | Merverdiavgift, Norwegian VAT number |
NO | Orgnr | Company | Norway | Organisasjonsnummer, Norwegian organisation number |
PY | RUC | Tax/Vat | Paraguay | Tax Identifier (Registro Único de Contribuyentes) |
PE | CUI | Person | Peru | Person Identifier (Cédula Única de Identidad) |
PE | RUC | Tax/Vat | Peru | Tax Identifier (Registro Único de Contribuyentes) |
PE | CE | Person | Peru | Person Identifier (Carné de Extranjería) |
PK | CNIC | Person | Pakistan | National Identity Card |
PK | NTN | Company | Pakistan | Tax Identification Number |
PL | NIP | Vat | Poland | Numer Identyfikacji Podatkowej, Polish VAT number |
PL | PESEL | Person | Poland | Polish national identification number |
PL | REGON | Company | Poland | Rejestr Gospodarki Narodowej, Polish register of economic units |
PT | NIF | Vat | Portugual | Número de identificação fiscal, Portuguese VAT number |
RU | INN | Tax/Vat | Russia | Tax Identifier (Идентификационный номер налогоплательщика) |
RO | CF | Vat | Romania | Cod de înregistrare în scopuri de TVA, Romanian VAT number |
RO | CNP | Person | Romania | Cod Numeric Personal, Romanian Numerical Personal Code) |
RO | CUI | Tax | Romania | Codul Unic de Înregistrare, Romanian company identifier |
RO | ONRC | Company | Romania | Ordine din Registrul Comerţului, Romanian Trade Register identifier |
SM | COE | Company | San Marcos | Codice operatore economico, San Marino national tax number |
RS | PIB | Vat | Serbia | Poreski identifikacioni broj Tax identification number |
RS | JMBG | Person | Serbia | Unique Master Citizen Number (Jedinstveni matični broj građana) |
SE | ORGNR | Company | Sweden | Organisationsnummer, Swedish company number |
SE | PERSONNUMMER | Person | Sweden | Personnummer (Swedish personal identity number) |
SE | VAT | Vat | Sweden | VAT (Moms, Mervärdesskatt, Swedish VAT number) |
SG | UEN | Company | Singapore | Singapore's Unique Entity Number |
TH | IDNR | Person | Thailand | Thai National ID (บัตรประจำตัวประชาชนไทย) |
TW | UBN | Company | Taiwan | Unified Business Number, 統一編號, Taiwanese tax number |
TR | TCKIMLIK | Person | Turkey | Türkiye Cumhuriyeti Kimlik Numarası (Personal ID) |
TR | VKN | Tax | Turkey | Vergi Kimlik Numarası, Turkish tax identification number |
SI | DDV | Vatl | Slovenia | ID za DDV (Davčna številka, Slovenian VAT number) |
SI | JMBG | Person | Slovenia | Unique Master Citizen Number (Enotna matična številka občana) |
SK | DPH | Vat | Slovakia | IČ DPH (IČ pre daň z pridanej hodnoty, Slovak VAT number) |
SK | RC | Person | Slovakia | RČ (Rodné číslo, the Slovak birth number) |
ES | CIF | Tax/Vat | Spain | Tax Identifier (Código de Identificación Fiscal) |
ES | DNI | Person | Spain | Identity code (Documento Nacional de Identidad) |
ES | NIE | Person | Spain | Identity code foreigner (Número de Identificación de Extranjero) |
ES | NIF | Tax | Spain | Tax Identifier (Número de Identificación Fiscal) |
UY | RUT | Tax/Vat | Uruguay | Tax Identifier (Registro Único Tributario) |
UY | CEDULA | Person | Uruguay | Person Identifier (Cédula de Residencia) |
UY | NIE | Person | Uruguay | ForeignersI identification Number |
UA | RNTRC | Person | Ukraine | КПП, RNTRC (Individual taxpayer registration number in Ukraine) |
UA | EDRPOU | Company | Ukraine | ЄДРПОУ, EDRPOU (Identifier for enterprises and organizations in Ukraine) |
US | EIN | Tax/Company | United States | Tax Identifier (Employer Identification Number) |
US | SSN | Tax/Individual | United States | Tax Identifier (Social Security Number) |
VE | RIF | Vat | Venezuelan | Vat Identifier (Registro de Identificación Fiscal) |
VN | MST | Company | Vietnam | Mã số thuế, Vietnam tax number |
ZA | IDNR | Person | South Africa | ID number (South African Identity Document number). |
ZA | TIN | Person/Company | South Africa | TIN (South African Tax Identification Number). |
Código | Banco |
---|---|
001 | Banco do Brasil S.A. |
033 | Banco Santander (Brasil) S.A. |
104 | Caixa Econômica Federal |
237 | Banco Bradesco S.A. |
260 | Nubank |
341 | Banco Itaú S.A. |
356 | Banco Real S.A. (antigo) |
389 | Banco Mercantil do Brasil S.A. |
399 | HSBC Bank Brasil S.A. – Banco Múltiplo |
422 | Banco Safra S.A. |
453 | Banco Rural S.A. |
633 | Banco Rendimento S.A. |
652 | Itaú Unibanco Holding S.A. |
745 | Banco Citibank S.A. |