{Developer's Center}

Seja bem vindo! Aqui você vai encontrar toda a documentação, SDKs e links referentes à MundiPagg, reunidos em um só lugar.

/* Mug.fill("coffee") */

Suggest Edits

Introdução

Bem vindo a API Reference da Mundipagg !

 


A API Mundipagg foi desenvolvida de acordo com os melhores padrões REST.

As operações são feitas por requisições aos endpoints, de acordo com os verbos HTTP, com corpos de mensagem em JSON. As respostas podem ser interpretadas através do código de status HTTP. Isso permite que quaisquer aplicações consumam a API de forma simples e clara, independente da linguagem utilizada.

Para facilitar ainda mais a integração, fornecemos SDKs em todas as principais linguagens de programação. Saiba mais sobre as nossas SDKs.

Também oferecemos uma chave de testes na API para que a integração seja feita com testes a vontade, sem se preocupar com cobranças reais nos cartões de crédito utilizados.

 
Suggest Edits

Segurança

Normas PCI Compliance

 


Para manter a segurança na troca de mensagens é necessário que nossos servidores sejam liberados no seu ambiente. Recomendamos fortemente que você libere o domínio: api.mundipagg.com. Caso não seja possível a liberação do domínio, segue abaixo a lista de IP's que devem ser liberados:

IPs

208.93.65.185
40.70.66.232
208.93.65.172
52.147.171.141
52.186.34.80/28
104.45.183.192/28
52.160.136.0/28
13.88.79.144/28

Além disso, por sermos uma empresa com certficado PCI Compliance precisamos manter a segurança na troca de informações com a nossa API. Seguem as configurações aceitas:

Protocolos aceitos

TLS 1.1
TLS 1.2 (A Mundipagg recomenda fortemente a utilização deste protocolo)

Hashs Codes

SHA256
SHA384
SHA512

Cipher Suites

Com criptografia igual ou superior a 128 bits.

 
Suggest Edits

Autenticação

Obtendo sua Chave de API

 


Antes de começar, você precisa obter suas chaves de API.
Para isso, siga os seguintes passos:
1 - Acesse este link e crie sua Loja e seu Usuário em nosso Dash,
2 - Após acessar o Dash, navegue até a área de Configurações e resgate suas chaves.

Clientes integrados na versão anterior da API

Caso você já seja cliente Mundipagg e esteja integrado na versão anterior da API, entre em contato com o nosso time de migração através do email [email protected]

Endpoints para teste e produção

As chamadas de testes e de produção devem ser feitas para o mesmo endpoint: https://api.mundipagg.com/core/v1.

O que definirá se a transação irá utilizar o nosso simulador ou se seguirá o fluxo de produção é o tipo da Chave de API enviada.

Tipos de Chave

Nós disponibilizaremos 02 chaves para que você possa realizar testes:

  • Exemplo de Chave Secreta de Sandbox: sk_test_tra6ezsW3BtPPXQa
  • Exemplo de Chave Pública de Sandbox: pk_test_gaa5xzfz7CfPPZAv

Após o fechamento do contrato o cliente receberá as chaves do ambiente de produção:

  • Exemplo de Chave Secreta de Produção: sk_fbt5cahT3BbHAXZy
  • Exemplo de Chave Pública de Produção: pk_ghc3waxT4BaCZXAb

Autorização Basic Auth

Para se autenticar conosco você deve enviar a Chave de API no cabeçalho Authorization, seguindo o padrão da HTTP Basic Authentication.

var fs = require('fs');
const request = require("request");
var body = JSON.parse(fs.readFileSync('body.json', 'utf8'));

var options = {                 
    method: 'POST',             
    uri: 'https://api.mundipagg.com/core/v1/orders',                    
    headers: {               
      'Authorization': 'Basic ' + new Buffer("sk_test_tra6ezsW3BtPPXQa:").toString('base64'),
      'Content-Type': 'application/json'              
    },
    json : body
};    

request(options, function(error, response, body) {  
    console.log(response.body);
});

Chave Pública de API (PK)

Essas chaves serão utilizadas para representar a sua loja na integração com o checkout transparente.

NÃO COMPARTILHE SUAS CHAVES DE API

A sua chave da API é SECRETA e não deve ser compartilhada com terceiros.

Saiba mais informações sobre como criar e utilizar o Access Token

 
Suggest Edits

Erros

HTTP Status Codes

 


A nossa API valida cada um dos campos enviados na requisição antes de prosseguir com a criação, consulta ou gerenciamento dos pedidos, transações e recursos.

Utilizamos os códigos de resposta convencionais do HTTP para indicar o sucesso ou a falha de uma requisição. Sendo assim, códigos 2xx indicam sucesso, 4xx indicam erros por algum dado informado incorretamente (por exemplo, algum campo obrigatório não enviado ou um cartão sem data de validade) e 5xx indicando erros nos servidores da Mundipagg.

Tabela dos HTTP Status Code:

Código
Status
Definição

200

OK

Sucesso

400

Bad Request

Requisição inválida

401

Unauthorized

Chave de API inválida

404

Not Found

O recurso solicitado não existe

412

Precondition Failed

Parâmetros válidos mas a requisição falhou

422

Unprocessable Entity

Parâmetros inválidos

500

Internal Server Error

Ocorreu um erro interno

{
  "message": "Customer not found."
}
{
  "message": "The request is invalid.",
  "errors": {
    "customer.name": [
      "The name field is required."
    ]
  },
  "request": {
    "name": null,
    "email": "[email protected]",
  }
}
 
Suggest Edits

Paginação

 


A API Mundipagg tem suporte a buscas em massa através dos métodos list. Deste modo, você pode listar compradores, assinaturas, pedidos e diversos outros objetos da Mundipagg. Todos esses métodos de listagem possuem uma estrutura em comum, que é a de paginação.

{
  "data": [...],
  "paging": {
    "total": 11,
    "previous": null,
    "next": "{url}?page=2&size=10"
  }
}
 
 


A maioria dos nossos objetos - como customer, card, address, subscription, plan, order, charge e invoice - possuem o parâmetro metadata, pelo qual você consegue armazenar dados chave-valor.

Metadados são interessantes para o armazenamento estruturado de dados complementares relacionados a algum objeto. Um exemplo seria adição do nome do pai de um cliente para ter essa informação em sua carteira de clientes.

{
  ...
  "metadata": {
    "meu_campo1": "valor1",
    "meu_campo2": "valor2"
  }
}
 
Suggest Edits

Telefones

O objeto phones possui os seguintes atributos:

 
Atributos
Tipo
Descrição

home_phone

object

Telefone residencial.

mobile_phone

object

Telefone móvel.

Tanto o home_phone quanto o mobile_phone são compostos pelos seguintes atributos:

Atributos
Tipo
Descrição

country_code

string

Código do País (Apenas numérico).

area_code

string

Código da área (Apenas numérico).

number

string

Número do telefone (Apenas numérico).

"phones": {
  "home_phone": {
    "country_code": "55",
    "number": "000000000",
    "area_code": "21"
  },
  "mobile_phone": {
    "country_code": "55",
    "number": "000000000",
    "area_code": "21"
  }
}
 
Suggest Edits

Entregas

O objeto shipping contém informações referentes à entrega do produto ao comprador, e possui os seguintes atributos:

 
Atributos
Tipo
Descrição

amount

integer

Valor da entrega.

description

string

Descrição da entrega.

recipient_name

string

Destinatário da entrega.

recipient_phone

string

Telefone do destinatário.

address

object

Endereço de entrega. Saiba mais sobre endereços.

max_delivery_date

string

Data de entrega máxima.

estimated_delivery_date

string

Data de entrega estimada.

type

string

Tipo de entrega.

"shipping" : {
    "amount": 100,
    "description": "Express Shipping",
    "recipient_name": "Tony Stark",
    "recipient_phone": "24586787867",
    "address": {
        "line_1": "10880, Malibu Point, Malibu Central",
        "zip_code": "90265",
        "city": "Malibu",
        "state": "CA",
        "country": "US"
    },
    "max_delivery_date": "2020-07-31",
  	"estimated_delivery_date": "2020-07-30",
    "type": "Express"
 }
 
Suggest Edits

Facilitadores de pagamento

Por determinação do Banco Central e das bandeiras os cliente de E-commerce que se enquadram na categoria de Facilitadores de Pagamento deverão enviar dados referentes aos seus sub credenciados em cada requisição transacional.

 

O objeto SubMerchant possibilita o envio de informação de sub credenciados.
Um SubMerchant possui os seguintes atributos:

Atributos
Tipo
Descrição

SubMerchant

object

Dados de sub credenciador

Merchant_Category_Code

string

MCC - Código de categoria do estabelecimento comercial

Payment_Facilitator_Code

string

Código de identificação do Facilitador de pagamentos

Code

string

Código de identificação do sub credenciado

name

string

Nome do sub credenciado.

Document

string

CPF ou CNPJ do sub credenciado.

Type

string

_Tipo de sub credenciado. Valores possíveis: individual e company.

phones

object

Telefones do sub credenciado ,

Coutry_code

string

Código do País (Apenas numérico).

Area_code

string

Código da área (Apenas numérico).

Number

string

Número do telefone (Apenas numérico).

Address

object

Endereço do sub credenciado.

Country

string

País.

State

string

Estado.

City

string

Cidade.

Neighborhood

string

Bairro.

Street

string

Rua.

Number

string

Número da rua.

Complement

string

Complemento.

Zip_Code

string

Código Postal (CEP).

{
    "Submerchant": {
    	"Merchant_Category_Code":"44444",
    	"Payment_Facilitator_Code":"5555555",
        "Code": "code2",
        "Name": "Sub Tony Stark",
        "Document": "123456789",
        "Type": "individual",
        "Phone": {
            "Country_Code": "55",
            "Number": "000000000",
            "Area_Code": "21"
        },
        "Address": {
            "Street": "Malibu Point",
            "Number": "10880",
            "Complement": "A",
            "Neighborhood": "Central Malibu",
            "City": "Malibu",
            "State": "CA",
            "Country": "US",
            "zip_code": "24210-460"
        }
    },
    "items": [
        {
            "amount": 2990,
            "description": "Chaveiro do Tesseract",
            "quantity": 1
        }
    ],
    "customer": {
        "name": "Tony Stark",
        "email": "{{email}}"
    },
    "ip": "192.168.0.1",
    "location": {
        "latitude": "10",
        "longitude": "20"
    },
    "session_id": "session_id_test",
    "device": {
        "platform": "ANDROID OS"
    },
    "payments": [
        {
        	"gateway_affiliation_code":"6A507067-4435-4F45-9E38-7103DE8CC91B",
        	"gateway_affiliation_id":"6A507067-4435-4F45-9E38-7103DE8CC91B",
            "payment_method": "credit_card",
            "credit_card": {
                "installments": 1,
                "statement_descriptor": "AVENGERS",
                "card": {
                    "number": "4000000000000010",
                    "holder_name": "Tony Stark",
                    "exp_month": 1,
                    "exp_year": 25,
                    "cvv": "351",
                    "billing_address": {
                        "street": "Malibu Point",
                        "number": "10880",
                        "zip_code": "90265",
                        "neighborhood": "Central Malibu",
                        "city": "Malibu",
                        "state": "CA",
                        "country": "US"
                    }
                }
            }
        }
    ],
    "shipping": {
        "amount": 110,
        "description": "teste",
        "recipient_name": "Marcelo",
        "type": "standard",
        "address": {
            "street": "Malibu Point",
            "number": "10882",
            "zip_code": "90265",
            "neighborhood": "Central Malibu",
            "city": "Malibu",
            "state": "CA",
            "country": "US"
        }
    }
}
{
    "items": [
        {
            "amount": 3000,
            "description": "Chaveiro do Teressact",
            "quantity": 1
        }
    ],
    "customer": {
        "name": "Tony Stark"
    },
    "Submerchant": {
        "Payment_Facilitator_Code": "55555",
        "Merchant_Category_Code": "44444",
        "Code": "code2",
        "Name": "Sub Tony Stark",
        "Document": "123456789",
        "Type": "individual",
        "Phone": {
            "Country_Code": "55",
            "Number": "000000000",
            "Area_Code": "21"
        },
        "Address": {
            "Street": "Malibu Point",
            "Number": "10880",
            "Neighborhood": "Central Malibu",
            "City": "Malibu",
            "State": "CA",
            "Country": "US",
            "zip_code": "24210-460"
        }
    },
    "payments": [
        {
            "amount": 3000,
            "payment_method": "checkout",
            "checkout": {
                "expires_in": 120,
                "billing_address_editable": false,
                "customer_editable": true,
                "accepted_payment_methods": [
                    "credit_card"
                ],
                "success_url": "https://www.mundipagg.com",
                "credit_card": {
                    "installments": [
                        {
                            "number": 1,
                            "total": 3000
                        },
                        {
                            "number": 2,
                            "total": 3000
                        }
                    ]
                }
            }
        }
    ]
}
{
    "Submerchant": {
    	"Payment_Facilitator_Code":"55555",
    	"Merchant_Category_Code": "44444",
        "Code": "code2",
        "Name": "Sub Tony Stark",
        "Document": "123456789",
        "Type": "individual",
        "Phone": {
            "Country_Code": "55",
            "Number": "000000000",
            "Area_Code": "21"
        },
        "Address": {
            "Street": "Malibu Point",
            "Number": "10880",
            "Neighborhood": "Central Malibu",
            "City": "Malibu",
            "State": "CA",
            "Country": "US",
            "zip_code": "24210-460"
        }
    },
    "billing_type": "prepaid",
    "items": [
        {
            "name": "Premium",
            "description": "Sem anuncios",
            "quantity": 1,
            "pricing_scheme": {
                "price": 1490
            },
            "discounts": [
                {
                    "discount_type": "percentage",
                    "value": 10,
                    "description": "Desconto 10% Item Sem Anuncios"
                }
            ],
            "increments": [
                {
                    "discount_type": "percentage",
                    "value": 20,
                    "description": "Incremento 20% Item Sem Anuncios"
                }
            ]
        },
        {
            "name": "Silver",
            "description": "Com anuncios",
            "quantity": 1,
            "pricing_scheme": {
                "price": 2000
            },
            "increments": [
                {
                    "discount_type": "percentage",
                    "value": 20
                }
            ]
        }
    ],
    "customer": {
        "name": "Tony Stark",
        "email": "[email protected]"
    },
    "card": {
        "number": "4000000000000010",
        "holder_name": "Tony Stark",
        "exp_month": 1,
        "exp_year": 22,
        "cvv": "3531",
        "billing_address": {
            "street": "Malibu Point",
            "number": "10880",
            "zip_code": "90265",
            "neighborhood": "Central Malibu",
            "city": "Malibu",
            "state": "CA",
            "country": "US"
        }
    },
    "discounts": [
        {
            "discount_type": "percentage",
            "value": 10,
            "description": "Desconto 10% Assinatura Sem Anuncios"
        }
    ],
    "increments": [
        {
            "discount_type": "percentage",
            "value": 20,
            "description": "Incremento 20% Assinatura Sem Anuncios"
        }
    ]
}

Importante

Essa é uma determinação do Banco Central e das bandeiras e para saber quais dados são obrigatórios para sua integração entre em contato com sua adquirente.

 
Suggest Edits

Autenticação com AccessToken

Obtendo sua Chave de API

 


Antes de começar, você precisa obter suas chaves de API.
Para isso, siga os seguintes passos:
1 - Acesse este link e crie sua Loja e seu Usuário em nosso Dash,
2 - Após acessar o Dash, navegue até a área de Configurações e resgate suas chaves.

Clientes integrados na versão anterior da API

Caso você já seja cliente Mundipagg e esteja integrado na versão anterior da API, entre em contato com o nosso time de migração através do email [email protected]

Endpoints para teste e produção

As chamadas de testes e de produção devem ser feitas para o mesmo endpoint: https://api.mundipagg.com/core/v1.

O que definirá se a transação irá utilizar o nosso simulador ou se seguirá o fluxo de produção é o tipo da Chave de API enviada.

Tipos de Chave

Nós disponibilizaremos 02 chaves para que você possa realizar testes:

  • Exemplo de Chave Secreta de Sandbox: sk_test_tra6ezsW3BtPPXQa
  • Exemplo de Chave Pública de Sandbox: pk_test_gaa5xzfz7CfPPZAv

Após o fechamento do contrato o cliente receberá as chaves do ambiente de produção:

  • Exemplo de Chave Secreta de Produção: sk_fbt5cahT3BbHAXZy
  • Exemplo de Chave Pública de Produção: pk_ghc3waxT4BaCZXAb

Autorização Basic Auth

Para se autenticar conosco você deve enviar a Chave de API no cabeçalho Authorization, seguindo o padrão da HTTP Basic Authentication.

var fs = require('fs');
const request = require("request");
var body = JSON.parse(fs.readFileSync('body.json', 'utf8'));

var options = {                 
    method: 'POST',             
    uri: 'https://api.mundipagg.com/core/v1/orders',                    
    headers: {               
      'Authorization': 'Basic ' + new Buffer("sk_test_tra6ezsW3BtPPXQa:").toString('base64'),
      'Content-Type': 'application/json'              
    },
    json : body
};    

request(options, function(error, response, body) {  
    console.log(response.body);
});

Chave Pública de API (PK)

Essas chaves serão utilizadas para representar a sua loja na integração com o checkout transparente.

NÃO COMPARTILHE SUAS CHAVES DE API

A sua chave da API é SECRETA e não deve ser compartilhada com terceiros.

Autorização Bearer Token para Gerenciamento de Wallets

Para o gerenciamento de Wallets você deverá autenticar-se nos servidores da Mundipagg através de um Access Token, que é um token temporário que permitirá o gerenciamento de cartões, pedido, cobranças e muitos outros recursos, sem que dados sensíveis trafeguem em seus servidores. Saiba mais sobre Wallets.

Para se autenticar conosco através do Access Token você deve enviá-lo no cabeçalho Authorization, seguindo o padrão da HTTP Bearer Token.

var fs = require('fs');
const request = require("request");
var body = JSON.parse(fs.readFileSync('body_card.json', 'utf8'));

var access_token = '4wdOK29W6RvyYbgPv63VPMYopk4Jy752dqbQxmm3qOgKy8dbexRvXQaGDZE0AYws88s7z64lWJnM1P7Vk9jYL2No5wp89jg1leNnG0WwXZOKDaLER3MXq07jQLokJn5m'

var customer_id = 'cus_9El4qnTEKFKQoV7r'

console.log(body);

var options = {                 
    method: 'POST',             
    uri: 'https://api.mundipagg.com/core/v1//customers/'+customer_id+'/cards',                    
    headers: {               
      'Authorization': 'Bearer ' + access_token,
      'Content-Type': 'application/json'              
    },
    json : body
};    

  request(options, function(error, response, body) {  
    console.log(options.headers['Authorization']);
    console.log(response.body);
});

Saiba mais informações sobre como criar e utilizar o Access Token

 
Suggest Edits

Visão Geral sobre Conta

A nova API fornece um recurso de criação de diversas contas dentro de uma loja. Possibilitando assim um maior controle.

 
 
 
Suggest Edits

Conta

O objeto account possibilita a criação e gerenciamento de uma Conta. Uma Account possui os seguintes atributos:

 


Atributos
Tipo
Descrição

name

string

Nome do cliente.

default_currency

string

Moeda principal .

time_zone

string

Time zone de operação .

mundipagg_settings

object

Informações do gateway Mundipagg. Saiba mais sobre mundipagg_settings.

pagarme_settings

object

Informações do gateway Pagar.me. Saiba mais sobre pagarme_settings.

domains

array of string

Domínios permitidos para fazer requisições.

boleto_settings

object

Informações sobre processamento de boletos.
Saiba mais sobre boleto_settings.

credit_card_settings

object

Informações sobre processamento de cartões de crédito.
Saiba mais sobre credit_card_settings.

voucher_settings

object

Informações sobre processamento de vouchers.
Saiba mais sobre voucher_settings.

safetypay_settings

object

Informações sobre processamento utilizando o SafetyPay.
Saiba mais sobre safetypay_settings.

facebook_settings

object

Informações de acesso ao facebook.
Saiba mais sobre facebook_settings.

general_settings

object

Informações gerais sobre a conta.
Saiba mais sobre general_settings.

wallet_settings

object

Informações sobre configurações da wallet.
Saiba mais sobre wallet_settings.

bank_transfer_settings

object

Informações sobre processamento de transferências bancarias.
Saiba mais sobre bank_transfer_settings.

webhook_settings

array of object

Informações sobre configurações de notificação via webhook.
Saiba mais sobre webhook_settings.

allowed_ips

array of string

Ip's liberados para fazerem requisições.
Saiba mais sobre boleto_settings.

split_settings

object

Informações sobre divisão de pagamentos.
Saiba mais sobre split_settings.

subscription_settings

object

Informações sobre assinaturas.
Saiba mais sobre subscription_settings.

order_settings

object

Informações sobre pedidos.
Saiba mais sobre order_settings.

notification_settings

object

Informações sobre notificações por e-mail.
Saiba mais sobre notification_settings.

guaranteed_cancellation_settings

object

Informações sobre cancelamento garantido.
Saiba mais sobre guaranteed_cancellation_settings.

 
Suggest Edits

Criar Conta

 
posthttps://api.mundipagg.com/core/v1/accounts

Body Params

Name
string
required

Nome do cliente

time_zone
string
required

Time zone de operação

default_currency
string
required

Moeda principal

domains
array of strings

Domínios permitidos para fazer requisições

mundipagg_settings
object

Informações do gateway Mundipagg

pagarme_settings
object

Informações do gateway Pagar.me

boleto_settings
object

Informações sobre processamento de boletos

credit_card_settings
object

Informações sobre processamento de cartões de crédito

voucher_settings
object

Informações sobre processamento de vouchers

safetypay_settings
object

Informações sobre processamento utilizando o SafetyPay

facebook_settings
object

Informações de acesso ao facebook

general_settings
object

Informações gerais sobre a conta

wallet_settings
object

Informações sobre configurações da wallet

webhook_settings
object

Informações sobre configurações de notificação via webhook

allowed_ips
array of strings

Ip's liberados para fazerem requisições

split_settings
object

Informações sobre divisão de pagamentos

subscription_settings
object

Informações sobre assinaturas

order_settings
object

Informações sobre pedidos

notification_settings
object

Informações sobre notificações por e-mail

guaranteed_cancellation_settings
object

Informações sobre cancelamento garantido

 
{
   "name":"Marvel",
   "time_zone":"E. South America Standard Time",
   "default_currency":"BRL",
    "mundipagg_settings":{
      "merchant_key":"00000000-0000-0000-0000-000000000000"
   },
   "domains":[
      "mundipagg.com"
   ],
   "boleto_settings":{
      "enabled":true,
      "bank":"001",
      "instructions":"Pagar até o vencimento",
      "gateway":"mundipagg"
   },
   "credit_card_settings":{
      "enabled":true,
      "gateway":"mundipagg"
   },
   "voucher_settings": {
    "enabled": true,
    "gateway":"mundipagg"
   },
   "facebook_settings":{
      "app_id":742347362566492,
      "app_secret":"fc0fb083cbdef4",
      "permissions":[
         "email",
         "user_likes"
      ]
   },
   "general_settings":{
      "display_name":"MundiPagg",
      "theme":"http://www.mundipagg.com/mundi.css",
      "email":"[email protected]",
      "website":"http://www.mundipagg.com"
   },
   "wallet_settings":{
     "max_cards":10,
     "shared":false
     
   },
   "webhook_settings":[
      {
         "url":"https://www.mundipagg.com/",
         "events":[
            "charge.paid"
         ]
      },
      {
         "url":"https://www.mundipagg.com/",
         "events":[
            "charge.paid"
         ]
      }
   ]
}
A binary file was returned

You couldn't be authenticated

{
    "id": "acc_N4sdfsde3whx0",
    "secret_key": "sk_Sksdfsda24fs",
    "public_key": "pk_sfsdfsdfsd",
    "name": "Marvel",
    "time_zone": "E. South America Standard Time",
    "default_currency": "BRL",
    "status": "active",
    "domains": [
        "mundipagg.com"
    ],
    "mundipagg_settings": {
        "merchant_key":"00000000-0000-0000-0000-000000000000"
    },
    "pagarme_settings": {
        "api_key": null,
        "crypto_key": null
    },
    "credit_card_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "voucher_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "boleto_settings": {
        "enabled": true,
        "bank": "001",
        "instructions": "Pagar até o vencimento",
        "gateway": "mundipagg",
        "due_days": 3
    },
    "bank_transfer_settings": {
        "enabled": false
    },
    "wallet_settings": {
        "max_cards": 10,
        "enabled": false,
        "shared": false
    },
    "safety_pay_settings": {
        "enabled": false
    },
    "facebook_settings": {
        "app_id": 742347362566492,
        "app_secret": "65240426365c0sf099fc0fb083cbdef4",
        "permissions": [
            "email",
            "user_likes"
        ]
    },
    "general_settings": {
        "display_name": "MundiPagg",
        "logo": null,
        "email": "[email protected]",
        "website": "http://www.mundipagg.com",
        "theme": "http://www.mundipagg.com/mundi.css",
        "address_type": "global",
        "checkout_redirect_enabled": false
    },
    "webhook_settings": [
        {
            "id": "hookset_q2424234wGVy",
						"url":"https://www.mundipagg.com/",
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T16:03:52Z",
            "updated_at": "2018-05-03T16:03:52Z"
        },
        {
            "id": "hookset_eQ234324Mnd",
						"url":"https://www.mundipagg.com/",
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T16:03:52Z",
            "updated_at": "2018-05-03T16:03:52Z"
        }
    ],
    "split_settings": {
        "enabled": false
    },
    "subscription_settings": {
        "enabled": false,
        "boleto_due_days": null
    },
    "order_settings": {
        "multi_payments_enabled": false,
        "multi_buyers_enabled": false,
        "open_orders_enabled": false
    },
    "notification_settings": {
        "enabled": false
    },
    "guaranteed_cancellation_settings": {
        "enabled": false,
        "updated_At": "2018-05-03T16:03:52Z"
    }
}
 
Suggest Edits

Atualizar Conta

 
puthttps://api.mundipagg.com/core/v1/accounts/account_id

Path Params

account_id
string
required

Identificador da conta

Body Params

name
string
required

Nome do cliente

time_zone
string
required

Time zone de operação

default_currency
string
required

Moeda principal

domains
array of strings

Domínios permitidos para fazer requisições

status
string
required

Status da conta

allowed_ips
array of strings

Ip's liberados para fazerem requisições

 
{
  "name": "MundiPagg",
  "time_zone": "E. South America Standard Time",
  "default_currency": "BRL",
  "status": "inactive",
  "domains": [
    "localhost"
  ]
}
A binary file was returned

You couldn't be authenticated

{
    "id": "acc_GsdfsdfsdaYEOB",
    "secret_key": "sk_Zasdasdasd5",
    "public_key": "pk_keasdasdasdQ",
    "name": "MundiPagg",
    "time_zone": "E. South America Standard Time",
    "default_currency": "BRL",
    "status": "inactive",
    "domains": [
        "localhost"
    ],
    "mundipagg_settings": {
        "merchant_key": "asdasd-asdasd9-4asd3-basde-6asdasefadad5"
    },
    "pagarme_settings": {
        "api_key": null,
        "crypto_key": null
    },
    "credit_card_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "voucher_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "boleto_settings": {
        "enabled": true,
        "bank": "001",
        "instructions": "Pagar até o vencimento",
        "gateway": "mundipagg",
        "due_days": 3
    },
    "bank_transfer_settings": {
        "enabled": false
    },
    "wallet_settings": {
        "max_cards": 10,
        "enabled": false,
        "shared": false
    },
    "safety_pay_settings": {
        "enabled": false
    },
    "facebook_settings": {
        "app_id": 742347232346492,
        "app_secret": "65c4263asdasdas9fc0fb083cbdef4",
        "permissions": [
            "email",
            "user_likes"
        ]
    },
    "general_settings": {
        "display_name": "MundiPagg",
        "logo": null,
        "email": "[email protected]",
        "website": "http://www.mundipagg.com",
        "theme": "http://www.mundipagg.com/mundi.css",
        "address_type": "global",
        "checkout_redirect_enabled": false
    },
    "webhook_settings": [
        {
            "id": "hookset_k3nBpk0He7HWY1jz",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        },
        {
            "id": "hookset_0r1kYjKInOIVLRzn",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        }
    ],
    "split_settings": {
        "enabled": false
    },
    "subscription_settings": {
        "enabled": false,
        "boleto_due_days": null
    },
    "order_settings": {
        "multi_payments_enabled": false,
        "multi_buyers_enabled": false,
        "open_orders_enabled": false
    },
    "notification_settings": {
        "enabled": false
    },
    "guaranteed_cancellation_settings": {
        "enabled": false,
        "updated_At": "2018-05-03T19:20:34Z"
    }
}
 
Suggest Edits

Obter Conta

 
gethttps://api.mundipagg.com/core/v1/accounts/account_id

Path Params

account_id
string
required

Identificador da conta

 
No code samples available
A binary file was returned

You couldn't be authenticated

{
    "id": "acc_GsdfsdfsdaYEOB",
    "secret_key": "sk_Zasdasdasd5",
    "public_key": "pk_keasdasdasdQ",
    "name": "MundiPagg",
    "time_zone": "E. South America Standard Time",
    "default_currency": "BRL",
    "status": "inactive",
    "domains": [
        "localhost"
    ],
    "mundipagg_settings": {
        "merchant_key": "asdasd-asdasd9-4asd3-basde-6asdasefadad5"
    },
    "pagarme_settings": {
        "api_key": null,
        "crypto_key": null
    },
    "credit_card_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "voucher_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "boleto_settings": {
        "enabled": true,
        "bank": "001",
        "instructions": "Pagar até o vencimento",
        "gateway": "mundipagg",
        "due_days": 3
    },
    "bank_transfer_settings": {
        "enabled": false
    },
    "wallet_settings": {
        "max_cards": 10,
        "enabled": false,
        "shared": false
    },
    "safety_pay_settings": {
        "enabled": false
    },
    "facebook_settings": {
        "app_id": 742347232346492,
        "app_secret": "65c4263asdasdas9fc0fb083cbdef4",
        "permissions": [
            "email",
            "user_likes"
        ]
    },
    "general_settings": {
        "display_name": "MundiPagg",
        "logo": null,
        "email": "[email protected]",
        "website": "http://www.mundipagg.com",
        "theme": "http://www.mundipagg.com/mundi.css",
        "address_type": "global",
        "checkout_redirect_enabled": false
    },
    "webhook_settings": [
        {
            "id": "hookset_k3nBpk0He7HWY1jz",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        },
        {
            "id": "hookset_0r1kYjKInOIVLRzn",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        }
    ],
    "split_settings": {
        "enabled": false
    },
    "subscription_settings": {
        "enabled": false,
        "boleto_due_days": null
    },
    "order_settings": {
        "multi_payments_enabled": false,
        "multi_buyers_enabled": false,
        "open_orders_enabled": false
    },
    "notification_settings": {
        "enabled": false
    },
    "guaranteed_cancellation_settings": {
        "enabled": false,
        "updated_At": "2018-05-03T19:20:34Z"
    }
}
 
Suggest Edits

Obter Contas

 
gethttps://api.mundipagg.com/core/v1/accounts

Query Params

page
string

Numero da pagina

size
string

Quantidade de dados por pagina

name
string

Nome da Conta

order_by_name
boolean

Indicador para ordenação por nome

 
{
 "name" : "Loja do Infinito"
}
A binary file was returned

You couldn't be authenticated

{
    "data": [
        {
            "id": "acc_pasddfgjG",
            "secret_key": "sk_nasdadfg7Dxo",
            "public_key": "pk_5RLasdasdXGnzMo",
            "name": "Loja do infinito",
            "time_zone": "E. South America Standard Time",
            "default_currency": "BRL",
            "status": "active",
            "domains": [
                "mundipagg.com"
            ]
        }
    ],
    "paging": {
        "total": 1
    }
}
 
Suggest Edits

Criar Conta de teste

 
posthttps://api.mundipagg.com/core/v1/accounts/account_id/tests

Path Params

account_id
string
required

Identificador da conta

Body Params

Name
string
required

Nome do cliente

time_zone
string
required

Time zone de operação

default_currency
string
required

Moeda principal

domains
array of strings

Domínios permitidos para fazer requisições

mundipagg_settings
object

Informações do gateway Mundipagg

pagarme_settings
object

Informações do gateway Pagar.me

boleto_settings
object

Informações sobre processamento de boletos

credit_card_settings
object

Informações sobre processamento de cartões de crédito

voucher_settings
object

Informações sobre processamento de vouchers

safetypay_settings
object

Informações sobre processamento utilizando o SafetyPay

facebook_settings
object

Informações de acesso ao facebook

general_settings
object

Informações gerais sobre a conta

wallet_settings
object

Informações sobre configurações da wallet

webhook_settings
object

Informações sobre configurações de notificação via webhook

allowed_ips
array of strings

Ip's liberados para fazerem requisições

split_settings
object

Informações sobre divisão de pagamentos

subscription_settings
object

Informações sobre assinaturas

order_settings
object

Informações sobre pedidos

notification_settings
object

Informações sobre notificações por e-mail

guaranteed_cancellation_settings
object

Informações sobre cancelamento garantido

 
{
   "name":"Marvel",
   "time_zone":"E. South America Standard Time",
   "default_currency":"BRL",
    "mundipagg_settings":{
      "merchant_key":"00000000-0000-0000-0000-000000000000"
   },
   "domains":[
      "mundipagg.com"
   ],
   "boleto_settings":{
      "enabled":true,
      "bank":"001",
      "instructions":"Pagar até o vencimento",
      "gateway":"mundipagg"
   },
   "credit_card_settings":{
      "enabled":true,
      "gateway":"mundipagg"
   },
   "voucher_settings": {
    "enabled": true,
    "gateway":"mundipagg"
   },
   "facebook_settings":{
      "app_id":742347362566492,
      "app_secret":"fc0fb083cbdef4",
      "permissions":[
         "email",
         "user_likes"
      ]
   },
   "general_settings":{
      "display_name":"MundiPagg",
      "theme":"http://www.mundipagg.com/mundi.css",
      "email":"[email protected]",
      "website":"http://www.mundipagg.com"
   },
   "wallet_settings":{
     "max_cards":10,
     "shared":false
     
   },
   "webhook_settings":[
      {
         "url":"https://www.mundipagg.com/",
         "events":[
            "charge.paid"
         ]
      },
      {
         "url":"https://www.mundipagg.com/",
         "events":[
            "charge.paid"
         ]
      }
   ]
}
A binary file was returned

You couldn't be authenticated

{
    "id": "acc_N4sdfsde3whx0",
    "secret_key": "sk_test_Sksdfsda24fs",
    "public_key": "pk_test_sfsdfsdfsd",
    "name": "Marvel",
    "time_zone": "E. South America Standard Time",
    "default_currency": "BRL",
    "status": "active",
    "domains": [
        "mundipagg.com"
    ],
    "mundipagg_settings": {
        "merchant_key":"00000000-0000-0000-0000-000000000000"
    },
    "pagarme_settings": {
        "api_key": null,
        "crypto_key": null
    },
    "credit_card_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "voucher_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "boleto_settings": {
        "enabled": true,
        "bank": "001",
        "instructions": "Pagar até o vencimento",
        "gateway": "mundipagg",
        "due_days": 3
    },
    "bank_transfer_settings": {
        "enabled": false
    },
    "wallet_settings": {
        "max_cards": 10,
        "enabled": false,
        "shared": false
    },
    "safety_pay_settings": {
        "enabled": false
    },
    "facebook_settings": {
        "app_id": 742347362566492,
        "app_secret": "65240426365c0sf099fc0fb083cbdef4",
        "permissions": [
            "email",
            "user_likes"
        ]
    },
    "general_settings": {
        "display_name": "MundiPagg",
        "logo": null,
        "email": "[email protected]",
        "website": "http://www.mundipagg.com",
        "theme": "http://www.mundipagg.com/mundi.css",
        "address_type": "global",
        "checkout_redirect_enabled": false
    },
    "webhook_settings": [
        {
            "id": "hookset_q2424234wGVy",
						"url":"https://www.mundipagg.com/",
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T16:03:52Z",
            "updated_at": "2018-05-03T16:03:52Z"
        },
        {
            "id": "hookset_eQ234324Mnd",
						"url":"https://www.mundipagg.com/",
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T16:03:52Z",
            "updated_at": "2018-05-03T16:03:52Z"
        }
    ],
    "split_settings": {
        "enabled": false
    },
    "subscription_settings": {
        "enabled": false,
        "boleto_due_days": null
    },
    "order_settings": {
        "multi_payments_enabled": false,
        "multi_buyers_enabled": false,
        "open_orders_enabled": false
    },
    "notification_settings": {
        "enabled": false
    },
    "guaranteed_cancellation_settings": {
        "enabled": false,
        "updated_At": "2018-05-03T16:03:52Z"
    }
}
 
Suggest Edits

Obter Conta de teste

 
gethttps://api.mundipagg.com/core/v1/accounts/account_id/tests
 
No code samples available
A binary file was returned

You couldn't be authenticated

{
    "data": [
        {
            "id": "acc_eAsdfasdCaWG0M5",
            "secret_key": "sk_test_ldW45asdfa2ax42P",
            "public_key": "pk_test_dDsdfgassABY4qZ",
            "name": "MundiPagg - Teste",
            "time_zone": "E. South America Standard Time",
            "default_currency": "BRL",
            "status": "active",
            "domains": [
                "mundipagg.com"
            ]
        }
    ],
    "paging": {
        "total": 1
    }
}
 
Suggest Edits

Configuração Mundipagg

O objeto account possui em suas propriedade um objeto denominado mundipagg_settings

 
Atributos
Tipo
Descrição

merchant_key

string

Chave de configuração.

 
Suggest Edits

Atualizar Configurações Mundipagg

 
patchhttps://api.mundipagg.com/core/v1/accounts/account_id/mundipagg-settings

Path Params

account_id
string
required

Identificação da conta

Body Params

merchant_key
string
required

Chave de configuração

 
{
  "merchant_key": "2asd9a4e-9230-46fd-2348-e7asdf42dfe"
}
A binary file was returned

You couldn't be authenticated

{
    "id": "acc_GsdfsdfsdaYEOB",
    "secret_key": "sk_Zasdasdasd5",
    "public_key": "pk_keasdasdasdQ",
    "name": "MundiPagg",
    "time_zone": "E. South America Standard Time",
    "default_currency": "BRL",
    "status": "inactive",
    "domains": [
        "localhost"
    ],
    "mundipagg_settings": {
        "merchant_key": "2asd9a4e-9230-46fd-2348-e7asdf42dfe"
    },
    "pagarme_settings": {
        "api_key": null,
        "crypto_key": null
    },
    "credit_card_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "voucher_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "boleto_settings": {
        "enabled": true,
        "bank": "001",
        "instructions": "Pagar até o vencimento",
        "gateway": "mundipagg",
        "due_days": 3
    },
    "bank_transfer_settings": {
        "enabled": false
    },
    "wallet_settings": {
        "max_cards": 10,
        "enabled": false,
        "shared": false
    },
    "safety_pay_settings": {
        "enabled": false
    },
    "facebook_settings": {
        "app_id": 742347232346492,
        "app_secret": "65c4263asdasdas9fc0fb083cbdef4",
        "permissions": [
            "email",
            "user_likes"
        ]
    },
    "general_settings": {
        "display_name": "MundiPagg",
        "logo": null,
        "email": "[email protected]",
        "website": "http://www.mundipagg.com",
        "theme": "http://www.mundipagg.com/mundi.css",
        "address_type": "global",
        "checkout_redirect_enabled": false
    },
    "webhook_settings": [
        {
            "id": "hookset_k3nBpk0He7HWY1jz",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        },
        {
            "id": "hookset_0r1kYjKInOIVLRzn",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        }
    ],
    "split_settings": {
        "enabled": false
    },
    "subscription_settings": {
        "enabled": false,
        "boleto_due_days": null
    },
    "order_settings": {
        "multi_payments_enabled": false,
        "multi_buyers_enabled": false,
        "open_orders_enabled": false
    },
    "notification_settings": {
        "enabled": false
    },
    "guaranteed_cancellation_settings": {
        "enabled": false,
        "updated_At": "2018-05-03T19:20:34Z"
    }
}
 
Suggest Edits

Configuração Pagar.me

O objeto account possui em suas propriedade um objeto denominado pagarme_settings

 
Atributos
Tipo
Descrição

api_key

string

Chave de configuração da API Pagar.me.

crypto_key

string

Chave de criptografia.

 
Suggest Edits

Atualizar Configuração Pagar.me

 
patchhttps://api.mundipagg.com/core/v1/accounts/account_id/pagarme-settings

Path Params

account_id
string
required

Identificação da conta

Body Params

api_key
string
required

Chave de configuração da API Pagar.me

crypto_key
string
required

Chave de criptografia

 
{
  "api_key":"ak_live_xsgdasfgnXKSmSDFZTZpfD1iLazO48hb",
   "crypto_key": "ek_live_7g7w5srCGAys8cZJ4pgxish4yjWbT"
}
A binary file was returned

You couldn't be authenticated

{
    "id": "acc_GsdfsdfsdaYEOB",
    "secret_key": "sk_Zasdasdasd5",
    "public_key": "pk_keasdasdasdQ",
    "name": "MundiPagg",
    "time_zone": "E. South America Standard Time",
    "default_currency": "BRL",
    "status": "inactive",
    "domains": [
        "localhost"
    ],
    "mundipagg_settings": {
        "merchant_key": "asdasd-asdasd9-4asd3-basde-6asdasefadad5"
    },
    "pagarme_settings": {
        "api_key": "ak_live_xsgdasfgnXKSmSDFZTZpfD1iLazO48hb",
   			"crypto_key": "ek_live_7g7w5srCGAys8cZJ4pgxish4yjWbT"
    },
    "credit_card_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "voucher_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "boleto_settings": {
        "enabled": true,
        "bank": "001",
        "instructions": "Pagar até o vencimento",
        "gateway": "mundipagg",
        "due_days": 3
    },
    "bank_transfer_settings": {
        "enabled": false
    },
    "wallet_settings": {
        "max_cards": 10,
        "enabled": false,
        "shared": false
    },
    "safety_pay_settings": {
        "enabled": false
    },
    "facebook_settings": {
        "app_id": 742347232346492,
        "app_secret": "65c4263asdasdas9fc0fb083cbdef4",
        "permissions": [
            "email",
            "user_likes"
        ]
    },
    "general_settings": {
        "display_name": "MundiPagg",
        "logo": null,
        "email": "[email protected]",
        "website": "http://www.mundipagg.com",
        "theme": "http://www.mundipagg.com/mundi.css",
        "address_type": "global",
        "checkout_redirect_enabled": false
    },
    "webhook_settings": [
        {
            "id": "hookset_k3nBpk0He7HWY1jz",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        },
        {
            "id": "hookset_0r1kYjKInOIVLRzn",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        }
    ],
    "split_settings": {
        "enabled": false
    },
    "subscription_settings": {
        "enabled": false,
        "boleto_due_days": null
    },
    "order_settings": {
        "multi_payments_enabled": false,
        "multi_buyers_enabled": false,
        "open_orders_enabled": false
    },
    "notification_settings": {
        "enabled": false
    },
    "guaranteed_cancellation_settings": {
        "enabled": false,
        "updated_At": "2018-05-03T19:20:34Z"
    }
}
 
Suggest Edits

Configuração de cartão de crédito

O objeto account possui em suas propriedade um objeto denominado credit_card_settings

 
Atributos
Tipo
Descrição

enabled

bool

Indica se o pagamento com cartão de crédito está habilitado.

gateway

string

Gateway responsável pelo processamento do pagamento.

 
Suggest Edits

Atualizar configurações de cartão de crédito

 
patchhttps://api.mundipagg.com/core/v1/accounts/account_id/credit-card-settings

Path Params

account_id
string
required

Identificador da conta

Body Params

enabled
boolean

Indica se o pagamento com cartão de crédito está habilitado

gateway
string

Gateway responsável pelo processamento do pagamento

 
{
  "enabled": true,
  "gateway": "mundipagg"
}
A binary file was returned

You couldn't be authenticated

{
    "id": "acc_GsdfsdfsdaYEOB",
    "secret_key": "sk_Zasdasdasd5",
    "public_key": "pk_keasdasdasdQ",
    "name": "MundiPagg",
    "time_zone": "E. South America Standard Time",
    "default_currency": "BRL",
    "status": "inactive",
    "domains": [
        "localhost"
    ],
    "mundipagg_settings": {
        "merchant_key": "asdasd-asdasd9-4asd3-basde-6asdasefadad5"
    },
    "pagarme_settings": {
        "api_key": null,
        "crypto_key": null
    },
    "credit_card_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "voucher_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "boleto_settings": {
        "enabled": true,
        "bank": "001",
        "instructions": "Pagar até o vencimento",
        "gateway": "mundipagg",
        "due_days": 3
    },
    "bank_transfer_settings": {
        "enabled": false
    },
    "wallet_settings": {
        "max_cards": 10,
        "enabled": false,
        "shared": false
    },
    "safety_pay_settings": {
        "enabled": false
    },
    "facebook_settings": {
        "app_id": 742347232346492,
        "app_secret": "65c4263asdasdas9fc0fb083cbdef4",
        "permissions": [
            "email",
            "user_likes"
        ]
    },
    "general_settings": {
        "display_name": "MundiPagg",
        "logo": null,
        "email": "[email protected]",
        "website": "http://www.mundipagg.com",
        "theme": "http://www.mundipagg.com/mundi.css",
        "address_type": "global",
        "checkout_redirect_enabled": false
    },
    "webhook_settings": [
        {
            "id": "hookset_k3nBpk0He7HWY1jz",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        },
        {
            "id": "hookset_0r1kYjKInOIVLRzn",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        }
    ],
    "split_settings": {
        "enabled": false
    },
    "subscription_settings": {
        "enabled": false,
        "boleto_due_days": null
    },
    "order_settings": {
        "multi_payments_enabled": false,
        "multi_buyers_enabled": false,
        "open_orders_enabled": false
    },
    "notification_settings": {
        "enabled": false
    },
    "guaranteed_cancellation_settings": {
        "enabled": false,
        "updated_At": "2018-05-03T19:20:34Z"
    }
}
 
Suggest Edits

Configuração de voucher

O objeto account possui em suas propriedade um objeto denominado voucher_settings

 
Atributos
Tipo
Descrição

enabled

bool

Indica se o pagamento com voucher está habilitado.

gateway

string

Gateway responsável pelo processamento do pagamento.

 
Suggest Edits

Atualizar configurações de voucher

 
patchhttps://api.mundipagg.com/core/v1/accounts/account_id/voucher-settings

Path Params

account_id
string
required

Identificador da conta

Body Params

enabled
boolean

Indica se o pagamento com voucher está habilitado

gateway
string

Gateway responsável pelo processamento do pagamento

 
{
  "enabled": true,
  "gateway": "mundipagg"
}
A binary file was returned

You couldn't be authenticated

{
    "id": "acc_GsdfsdfsdaYEOB",
    "secret_key": "sk_Zasdasdasd5",
    "public_key": "pk_keasdasdasdQ",
    "name": "MundiPagg",
    "time_zone": "E. South America Standard Time",
    "default_currency": "BRL",
    "status": "inactive",
    "domains": [
        "localhost"
    ],
    "mundipagg_settings": {
        "merchant_key": "asdasd-asdasd9-4asd3-basde-6asdasefadad5"
    },
    "pagarme_settings": {
        "api_key": null,
        "crypto_key": null
    },
    "credit_card_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "voucher_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "boleto_settings": {
        "enabled": true,
        "bank": "001",
        "instructions": "Pagar até o vencimento",
        "gateway": "mundipagg",
        "due_days": 3
    },
    "bank_transfer_settings": {
        "enabled": false
    },
    "wallet_settings": {
        "max_cards": 10,
        "enabled": false,
        "shared": false
    },
    "safety_pay_settings": {
        "enabled": false
    },
    "facebook_settings": {
        "app_id": 742347232346492,
        "app_secret": "65c4263asdasdas9fc0fb083cbdef4",
        "permissions": [
            "email",
            "user_likes"
        ]
    },
    "general_settings": {
        "display_name": "MundiPagg",
        "logo": null,
        "email": "[email protected]",
        "website": "http://www.mundipagg.com",
        "theme": "http://www.mundipagg.com/mundi.css",
        "address_type": "global",
        "checkout_redirect_enabled": false
    },
    "webhook_settings": [
        {
            "id": "hookset_k3nBpk0He7HWY1jz",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        },
        {
            "id": "hookset_0r1kYjKInOIVLRzn",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        }
    ],
    "split_settings": {
        "enabled": false
    },
    "subscription_settings": {
        "enabled": false,
        "boleto_due_days": null
    },
    "order_settings": {
        "multi_payments_enabled": false,
        "multi_buyers_enabled": false,
        "open_orders_enabled": false
    },
    "notification_settings": {
        "enabled": false
    },
    "guaranteed_cancellation_settings": {
        "enabled": false,
        "updated_At": "2018-05-03T19:20:34Z"
    }
}
 
Suggest Edits

Configuração de boleto

O objeto account possui em suas propriedade um objeto denominado boleto_settings

 
Atributos
Tipo
Descrição

enabled

bool

Indica se o pagamento com boleto está habilitado.

instructions

string

Instruções do boleto.

gateway

string

Gateway responsável pelo processamento do pagamento.

Bank

string

Numero de representação do banco perante ao órgão regulamentador.

due_days

integer

Numero padrão de dias de vencimento do boleto .

 
Suggest Edits

Atualizar configurações de boleto

 
patchhttps://api.mundipagg.com/core/v1/accounts/account_id/boleto-settings

Path Params

account_id
string
required

Identificador da conta

Body Params

enabled
boolean

Indica se o pagamento com voucher está habilitado

gateway
string

Gateway responsável pelo processamento do pagamento

instructions
string

Instruções presentes no boleto

bank
string

Numero de representação do banco perante ao órgão regulamentador

due_days
int32

Numero padrão de dias de vencimento do boleto

 
{
  "enabled": true,
  "instructions": "Pagar antes do vencimento",
  "bank": "001",
  "gateway":"mundipagg",
  "due_days":3
}
A binary file was returned

You couldn't be authenticated

{
    "id": "acc_GsdfsdfsdaYEOB",
    "secret_key": "sk_Zasdasdasd5",
    "public_key": "pk_keasdasdasdQ",
    "name": "MundiPagg",
    "time_zone": "E. South America Standard Time",
    "default_currency": "BRL",
    "status": "inactive",
    "domains": [
        "localhost"
    ],
    "mundipagg_settings": {
        "merchant_key": "asdasd-asdasd9-4asd3-basde-6asdasefadad5"
    },
    "pagarme_settings": {
        "api_key": null,
        "crypto_key": null
    },
    "credit_card_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "voucher_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "boleto_settings": {
        "enabled": true,
        "bank": "001",
        "instructions": "Pagar antes do vencimento",
        "gateway": "mundipagg",
        "due_days": 3
    },
    "bank_transfer_settings": {
        "enabled": false
    },
    "wallet_settings": {
        "max_cards": 10,
        "enabled": false,
        "shared": false
    },
    "safety_pay_settings": {
        "enabled": false
    },
    "facebook_settings": {
        "app_id": 742347232346492,
        "app_secret": "65c4263asdasdas9fc0fb083cbdef4",
        "permissions": [
            "email",
            "user_likes"
        ]
    },
    "general_settings": {
        "display_name": "MundiPagg",
        "logo": null,
        "email": "[email protected]",
        "website": "http://www.mundipagg.com",
        "theme": "http://www.mundipagg.com/mundi.css",
        "address_type": "global",
        "checkout_redirect_enabled": false
    },
    "webhook_settings": [
        {
            "id": "hookset_k3nBpk0He7HWY1jz",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        },
        {
            "id": "hookset_0r1kYjKInOIVLRzn",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        }
    ],
    "split_settings": {
        "enabled": false
    },
    "subscription_settings": {
        "enabled": false,
        "boleto_due_days": null
    },
    "order_settings": {
        "multi_payments_enabled": false,
        "multi_buyers_enabled": false,
        "open_orders_enabled": false
    },
    "notification_settings": {
        "enabled": false
    },
    "guaranteed_cancellation_settings": {
        "enabled": false,
        "updated_At": "2018-05-03T19:20:34Z"
    }
}
 
Suggest Edits

Configuração de transferência bancaria

O objeto account possui em suas propriedade um objeto denominado bank_transfer_settings

 
Atributos
Tipo
Descrição

enabled

bool

Indica se o pagamento com boleto está habilitado.

instructions

string

Instruções do boleto.

gateway

string

Gateway responsável pelo processamento do pagamento.

Bank

string

Numero de representação do banco perante ao órgão regulamentador.

due_days

integer

Numero padrão de dias de vencimento do boleto .

 
Suggest Edits

Atualizar configurações de transferência bancaria

 
patchhttps://api.mundipagg.com/core/v1/accounts/account_id/bank-transfer-settings

Path Params

account_id
string
required

Identificador da conta

Body Params

enabled
boolean

Indica se transferência bancaria esta disponivel

gateway
string

Gateway responsável pelo processamento do pagamento

bank
string

Numero de representação do banco perante ao órgão regulamentador

 
{
  "enabled": true,
  "bank": "001",
  "gateway":"mundipagg"
}
A binary file was returned

You couldn't be authenticated

{
    "id": "acc_GsdfsdfsdaYEOB",
    "secret_key": "sk_Zasdasdasd5",
    "public_key": "pk_keasdasdasdQ",
    "name": "MundiPagg",
    "time_zone": "E. South America Standard Time",
    "default_currency": "BRL",
    "status": "inactive",
    "domains": [
        "localhost"
    ],
    "mundipagg_settings": {
        "merchant_key": "asdasd-asdasd9-4asd3-basde-6asdasefadad5"
    },
    "pagarme_settings": {
        "api_key": null,
        "crypto_key": null
    },
    "credit_card_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "voucher_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "boleto_settings": {
        "enabled": true,
        "bank": "001",
        "instructions": "Pagar antes do vencimento",
        "gateway": "mundipagg",
        "due_days": 3
    },
    "bank_transfer_settings": {
        "enabled": true,
      	"bank": "001",
  			"gateway":"mundipagg"
    },
    "wallet_settings": {
        "max_cards": 10,
        "enabled": false,
        "shared": false
    },
    "safety_pay_settings": {
        "enabled": false
    },
    "facebook_settings": {
        "app_id": 742347232346492,
        "app_secret": "65c4263asdasdas9fc0fb083cbdef4",
        "permissions": [
            "email",
            "user_likes"
        ]
    },
    "general_settings": {
        "display_name": "MundiPagg",
        "logo": null,
        "email": "[email protected]",
        "website": "http://www.mundipagg.com",
        "theme": "http://www.mundipagg.com/mundi.css",
        "address_type": "global",
        "checkout_redirect_enabled": false
    },
    "webhook_settings": [
        {
            "id": "hookset_k3nBpk0He7HWY1jz",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        },
        {
            "id": "hookset_0r1kYjKInOIVLRzn",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        }
    ],
    "split_settings": {
        "enabled": false
    },
    "subscription_settings": {
        "enabled": false,
        "boleto_due_days": null
    },
    "order_settings": {
        "multi_payments_enabled": false,
        "multi_buyers_enabled": false,
        "open_orders_enabled": false
    },
    "notification_settings": {
        "enabled": false
    },
    "guaranteed_cancellation_settings": {
        "enabled": false,
        "updated_At": "2018-05-03T19:20:34Z"
    }
}
 
Suggest Edits

Configuração da wallet

O objeto account possui em suas propriedade um objeto denominado wallet_settings

 
Atributos
Tipo
Descrição

enabled

bool

Indica se o pagamento com boleto está habilitado.

max_cards

integer

Quantidade máxima de cartões por customer que podem ser cadastrados dentro de um tempo pre determinado.

shared

bool

Indica se a loja compartilha a wallet.

 
Suggest Edits

Atualizar configurações da wallet

 
patchhttps://api.mundipagg.com/core/v1/accounts/account_id/wallet_settings

Path Params

account_id
string
required

Identificador da conta

Body Params

enabled
boolean

Indica se a configuração de wallet está habilitada

max_cards
string

Quantidade máxima de cartões por customer que podem ser cadastrados dentro de um tempo pre determinado

shared
boolean

Indica se a loja compartilha a wallet

 
{
   "max_cards": 5,
   "enabled": true,
   "shared": "false"
}
A binary file was returned

You couldn't be authenticated

{
    "id": "acc_GsdfsdfsdaYEOB",
    "secret_key": "sk_Zasdasdasd5",
    "public_key": "pk_keasdasdasdQ",
    "name": "MundiPagg",
    "time_zone": "E. South America Standard Time",
    "default_currency": "BRL",
    "status": "inactive",
    "domains": [
        "localhost"
    ],
    "mundipagg_settings": {
        "merchant_key": "asdasd-asdasd9-4asd3-basde-6asdasefadad5"
    },
    "pagarme_settings": {
        "api_key": null,
        "crypto_key": null
    },
    "credit_card_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "voucher_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "boleto_settings": {
        "enabled": true,
        "bank": "001",
        "instructions": "Pagar antes do vencimento",
        "gateway": "mundipagg",
        "due_days": 3
    },
    "bank_transfer_settings": {
        "enabled": true,
      	"bank": "001",
  			"gateway":"mundipagg"
    },
    "wallet_settings": {
        "max_cards": 5,
        "enabled": true,
        "shared": true
    },
    "safety_pay_settings": {
        "enabled": false
    },
    "facebook_settings": {
        "app_id": 742347232346492,
        "app_secret": "65c4263asdasdas9fc0fb083cbdef4",
        "permissions": [
            "email",
            "user_likes"
        ]
    },
    "general_settings": {
        "display_name": "MundiPagg",
        "logo": null,
        "email": "[email protected]",
        "website": "http://www.mundipagg.com",
        "theme": "http://www.mundipagg.com/mundi.css",
        "address_type": "global",
        "checkout_redirect_enabled": false
    },
    "webhook_settings": [
        {
            "id": "hookset_k3nBpk0He7HWY1jz",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        },
        {
            "id": "hookset_0r1kYjKInOIVLRzn",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        }
    ],
    "split_settings": {
        "enabled": false
    },
    "subscription_settings": {
        "enabled": false,
        "boleto_due_days": null
    },
    "order_settings": {
        "multi_payments_enabled": false,
        "multi_buyers_enabled": false,
        "open_orders_enabled": false
    },
    "notification_settings": {
        "enabled": false
    },
    "guaranteed_cancellation_settings": {
        "enabled": false,
        "updated_At": "2018-05-03T19:20:34Z"
    }
}
 
Suggest Edits

Configuração da SafetyPay

O objeto account possui em suas propriedade um objeto denominado safetypay_settings

 
Atributos
Tipo
Descrição

enabled

bool

Indica se o pagamento com SafetyPay está habilitado.

gateway

string

Gateway responsável pelo processamento do pagamento.

 
Suggest Edits

Atualizar configurações da SafetyPay

 
patchhttps://api.mundipagg.com/core/v1/accounts/account_id/safetypay-settings

Path Params

account_id
string
required

Identificador da conta

Body Params

enabled
boolean

Indica se o pagamento com safety pay está habilitado

gateway
string

Gateway responsável pelo processamento do pagamento

 
{
  "enabled": true,
  "gateway": "mundipagg"
}
A binary file was returned

You couldn't be authenticated

{
    "id": "acc_GsdfsdfsdaYEOB",
    "secret_key": "sk_Zasdasdasd5",
    "public_key": "pk_keasdasdasdQ",
    "name": "MundiPagg",
    "time_zone": "E. South America Standard Time",
    "default_currency": "BRL",
    "status": "inactive",
    "domains": [
        "localhost"
    ],
    "mundipagg_settings": {
        "merchant_key": "asdasd-asdasd9-4asd3-basde-6asdasefadad5"
    },
    "pagarme_settings": {
        "api_key": null,
        "crypto_key": null
    },
    "credit_card_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "voucher_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "boleto_settings": {
        "enabled": true,
        "bank": "001",
        "instructions": "Pagar antes do vencimento",
        "gateway": "mundipagg",
        "due_days": 3
    },
    "bank_transfer_settings": {
        "enabled": true,
      	"bank": "001",
  			"gateway":"mundipagg"
    },
    "wallet_settings": {
        "max_cards": 5,
        "enabled": true,
        "shared": true
    },
    "safety_pay_settings": {
        "enabled": true,
        "gateway" : "mundipagg"
    },
    "facebook_settings": {
        "app_id": 742347232346492,
        "app_secret": "65c4263asdasdas9fc0fb083cbdef4",
        "permissions": [
            "email",
            "user_likes"
        ]
    },
    "general_settings": {
        "display_name": "MundiPagg",
        "logo": null,
        "email": "[email protected]",
        "website": "http://www.mundipagg.com",
        "theme": "http://www.mundipagg.com/mundi.css",
        "address_type": "global",
        "checkout_redirect_enabled": false
    },
    "webhook_settings": [
        {
            "id": "hookset_k3nBpk0He7HWY1jz",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        },
        {
            "id": "hookset_0r1kYjKInOIVLRzn",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        }
    ],
    "split_settings": {
        "enabled": false
    },
    "subscription_settings": {
        "enabled": false,
        "boleto_due_days": null
    },
    "order_settings": {
        "multi_payments_enabled": false,
        "multi_buyers_enabled": false,
        "open_orders_enabled": false
    },
    "notification_settings": {
        "enabled": false
    },
    "guaranteed_cancellation_settings": {
        "enabled": false,
        "updated_At": "2018-05-03T19:20:34Z"
    }
}
 
Suggest Edits

Configurações gerais

O objeto account possui em suas propriedade um objeto denominado general-settings

 
Atributos
Tipo
Descrição

enabled

bool

Indica se o pagamento com boleto está habilitado.

display_name

string

Nome disponível para os clientes.

logo

string

Url da logo do cliente.

email

string

E-mail de contato.

website

string

Url do site do cliente.

theme

string

Tema da página.

color

string

Cor dos elementos da página.

address_type

string

Tipo de Endereço - Global ou Brazilian.

checkout_redirect_enabled

bool

Indica se Checkout Redirect está habiltado para a conta.

optional_fields

array of string

Campos que serão tratados como opcionais no Checkout.

required_fields

array of string

Campos que serão tratados como obrigatórios no Checkout.

 
Suggest Edits

Atualizar configurações gerais

 
patchhttps://api.mundipagg.com/core/v1/accounts/account_id/general-settings

Path Params

account_id
string
required

Identificador da conta

Body Params

display_name
string

Gateway responsável pelo processamento do pagamento

logo
string

Url da logo do cliente

email
string

E-mail de contato

website
string

Url do site do cliente

theme
string

Tema da página

color
string

Cor dos elementos da página

address_type
string

Tipo de Endereço - Global ou Brazilian

checkout_redirect_enabled
boolean

Indica se Checkout Redirect está habiltado para a conta

optional_fields
array of strings

Campos que serão tratados como opcionais no Checkout

required_fields
array of strings

Campos que serão tratados como obrigatórios no Checkout

 
{
   "display_name":"MundiPagg2",
   "logo":"http://www.mundipagg.com",
   "email":"[email protected]",
   "website":"http://www.mundipagg.com",
   "address_type":"brazilian",
   "checkout_redirect_enabled":true
}
A binary file was returned

You couldn't be authenticated

{
    "id": "acc_GsdfsdfsdaYEOB",
    "secret_key": "sk_Zasdasdasd5",
    "public_key": "pk_keasdasdasdQ",
    "name": "MundiPagg",
    "time_zone": "E. South America Standard Time",
    "default_currency": "BRL",
    "status": "inactive",
    "domains": [
        "localhost"
    ],
    "mundipagg_settings": {
        "merchant_key": "asdasd-asdasd9-4asd3-basde-6asdasefadad5"
    },
    "pagarme_settings": {
        "api_key": null,
        "crypto_key": null
    },
    "credit_card_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "voucher_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "boleto_settings": {
        "enabled": true,
        "bank": "001",
        "instructions": "Pagar antes do vencimento",
        "gateway": "mundipagg",
        "due_days": 3
    },
    "bank_transfer_settings": {
        "enabled": true,
      	"bank": "001",
  			"gateway":"mundipagg"
    },
    "wallet_settings": {
        "max_cards": 5,
        "enabled": true,
        "shared": true
    },
    "safety_pay_settings": {
        "enabled": true,
        "gateway" : "mundipagg"
    },
    "facebook_settings": {
        "app_id": 742347232346492,
        "app_secret": "65c4263asdasdas9fc0fb083cbdef4",
        "permissions": [
            "email",
            "user_likes"
        ]
    },
    "general_settings": {
        "display_name": "MundiPagg",
        "logo": null,
        "email": "[email protected]",
        "website": "http://www.mundipagg.com",
        "theme": "http://www.mundipagg.com/mundi.css",
        "address_type": "brazilian",
        "checkout_redirect_enabled": false
    },
    "webhook_settings": [
        {
            "id": "hookset_k3nBpk0He7HWY1jz",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        },
        {
            "id": "hookset_0r1kYjKInOIVLRzn",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        }
    ],
    "split_settings": {
        "enabled": false
    },
    "subscription_settings": {
        "enabled": false,
        "boleto_due_days": null
    },
    "order_settings": {
        "multi_payments_enabled": false,
        "multi_buyers_enabled": false,
        "open_orders_enabled": false
    },
    "notification_settings": {
        "enabled": false
    },
    "guaranteed_cancellation_settings": {
        "enabled": false,
        "updated_At": "2018-05-03T19:20:34Z"
    }
}
 
Suggest Edits

Configurações de split

O objeto account possui em suas propriedade um objeto denominado split-settings

 
Atributos
Tipo
Descrição

enabled

bool

Indica se Split está habilitado.

 
Suggest Edits

Atualizar configurações de split

 
patchhttps://api.mundipagg.com/core/v1/accounts/account_id/split-settings

Path Params

account_id
string
required

Identificador da conta

Body Params

enabled
boolean

Indica se o split de pagamentos está habilitado

Atenção

Somente disponível caso possua configurações do gateway pagarme.

{
  "enabled": true,
}
A binary file was returned

You couldn't be authenticated

{
    "id": "acc_GsdfsdfsdaYEOB",
    "secret_key": "sk_Zasdasdasd5",
    "public_key": "pk_keasdasdasdQ",
    "name": "MundiPagg",
    "time_zone": "E. South America Standard Time",
    "default_currency": "BRL",
    "status": "inactive",
    "domains": [
        "localhost"
    ],
    "mundipagg_settings": {
        "merchant_key": "asdasd-asdasd9-4asd3-basde-6asdasefadad5"
    },
    "pagarme_settings": {
        "api_key": null,
        "crypto_key": null
    },
    "credit_card_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "voucher_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "boleto_settings": {
        "enabled": true,
        "bank": "001",
        "instructions": "Pagar antes do vencimento",
        "gateway": "mundipagg",
        "due_days": 3
    },
    "bank_transfer_settings": {
        "enabled": true,
      	"bank": "001",
  			"gateway":"mundipagg"
    },
    "wallet_settings": {
        "max_cards": 5,
        "enabled": true,
        "shared": true
    },
    "safety_pay_settings": {
        "enabled": true,
        "gateway" : "mundipagg"
    },
    "facebook_settings": {
        "app_id": 742347232346492,
        "app_secret": "65c4263asdasdas9fc0fb083cbdef4",
        "permissions": [
            "email",
            "user_likes"
        ]
    },
    "general_settings": {
        "display_name": "MundiPagg",
        "logo": null,
        "email": "[email protected]",
        "website": "http://www.mundipagg.com",
        "theme": "http://www.mundipagg.com/mundi.css",
        "address_type": "global",
        "checkout_redirect_enabled": false
    },
    "webhook_settings": [
        {
            "id": "hookset_k3nBpk0He7HWY1jz",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        },
        {
            "id": "hookset_0r1kYjKInOIVLRzn",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        }
    ],
    "split_settings": {
        "enabled": true
    },
    "subscription_settings": {
        "enabled": false,
        "boleto_due_days": null
    },
    "order_settings": {
        "multi_payments_enabled": false,
        "multi_buyers_enabled": false,
        "open_orders_enabled": false
    },
    "notification_settings": {
        "enabled": false
    },
    "guaranteed_cancellation_settings": {
        "enabled": false,
        "updated_At": "2018-05-03T19:20:34Z"
    }
}
 
Suggest Edits

Configuração de assinatura

O objeto account possui em suas propriedade um objeto denominado subscription-settings

 
Atributos
Tipo
Descrição

enabled

bool

Indica se assinatura está habilitada.

boleto_due_days

integer

Indica a quantidade de dias para acrescentar no vencimento do boleto .

 
Suggest Edits

Atualizar configurações de assinatura

 
patchhttps://api.mundipagg.com/core/v1/accounts/account_id/subscription_settings

Path Params

account_id
string
required

Identificador da conta

Body Params

enabled
boolean

Indica se a funcionalidade de assinatura esta disponível

boleto_due_days
int32

Indica a quantidade de dias para acrescentar no vencimento do boleto

Atenção

Somente disponível caso possua configurações do gateway pagarme.

{
   "enabled":true,
    boleto_due_days : 3,
  
}
A binary file was returned

You couldn't be authenticated

{
    "id": "acc_GsdfsdfsdaYEOB",
    "secret_key": "sk_Zasdasdasd5",
    "public_key": "pk_keasdasdasdQ",
    "name": "MundiPagg",
    "time_zone": "E. South America Standard Time",
    "default_currency": "BRL",
    "status": "inactive",
    "domains": [
        "localhost"
    ],
    "mundipagg_settings": {
        "merchant_key": "asdasd-asdasd9-4asd3-basde-6asdasefadad5"
    },
    "pagarme_settings": {
        "api_key": null,
        "crypto_key": null
    },
    "credit_card_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "voucher_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "boleto_settings": {
        "enabled": true,
        "bank": "001",
        "instructions": "Pagar antes do vencimento",
        "gateway": "mundipagg",
        "due_days": 3
    },
    "bank_transfer_settings": {
        "enabled": true,
      	"bank": "001",
  			"gateway":"mundipagg"
    },
    "wallet_settings": {
        "max_cards": 5,
        "enabled": true,
        "shared": true
    },
    "safety_pay_settings": {
        "enabled": true,
        "gateway" : "mundipagg"
    },
    "facebook_settings": {
        "app_id": 742347232346492,
        "app_secret": "65c4263asdasdas9fc0fb083cbdef4",
        "permissions": [
            "email",
            "user_likes"
        ]
    },
    "general_settings": {
        "display_name": "MundiPagg",
        "logo": null,
        "email": "[email protected]",
        "website": "http://www.mundipagg.com",
        "theme": "http://www.mundipagg.com/mundi.css",
        "address_type": "global",
        "checkout_redirect_enabled": false
    },
    "webhook_settings": [
        {
            "id": "hookset_k3nBpk0He7HWY1jz",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        },
        {
            "id": "hookset_0r1kYjKInOIVLRzn",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        }
    ],
    "split_settings": {
        "enabled": true
    },
    "subscription_settings": {
        "enabled": false,
        "boleto_due_days": null
    },
    "order_settings": {
        "multi_payments_enabled": false,
        "multi_buyers_enabled": false,
        "open_orders_enabled": false
    },
    "notification_settings": {
        "enabled": false
    },
    "guaranteed_cancellation_settings": {
        "enabled": false,
        "updated_At": "2018-05-03T19:20:34Z"
    }
}
 
Suggest Edits

Configuração de pedido

O objeto account possui em suas propriedade um objeto denominado order-settings

 
Atributos
Tipo
Descrição

multi_payments_enabled

bool

Identifica se pedidos Multimeios estão habiltiados para a conta .

multi_buyers_enabled

bool

Identifica se pedidos com MultiCompradores estão habiltiados para a conta .

open_orders_enabled

bool

Identifica se pedidos abertos estão liberados para a conta .

 
Suggest Edits

Atualizar configurações de pedido

 
patchhttps://api.mundipagg.com/core/v1/accounts/account_id/order_settings

Path Params

account_id
string
required

Identificador da conta

Body Params

multi_payments_enabled
boolean

Identifica se pedidos Multimeios estão habiltiados para a conta

multi_buyers_enabled
boolean

Identifica se pedidos com MultiCompradores estão habiltiados para a conta

open_orders_enabled
boolean

Identifica se pedidos abertos estão liberados para a conta

Atenção

Somente disponível caso possua configurações do gateway pagarme.

{
   "multi_payments_enabled":false,
   "multi_buyers_enabled":false,
   "open_orders_enabled":false
}
A binary file was returned

You couldn't be authenticated

{
    "id": "acc_GsdfsdfsdaYEOB",
    "secret_key": "sk_Zasdasdasd5",
    "public_key": "pk_keasdasdasdQ",
    "name": "MundiPagg",
    "time_zone": "E. South America Standard Time",
    "default_currency": "BRL",
    "status": "inactive",
    "domains": [
        "localhost"
    ],
    "mundipagg_settings": {
        "merchant_key": "asdasd-asdasd9-4asd3-basde-6asdasefadad5"
    },
    "pagarme_settings": {
        "api_key": null,
        "crypto_key": null
    },
    "credit_card_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "voucher_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "boleto_settings": {
        "enabled": true,
        "bank": "001",
        "instructions": "Pagar antes do vencimento",
        "gateway": "mundipagg",
        "due_days": 3
    },
    "bank_transfer_settings": {
        "enabled": true,
      	"bank": "001",
  			"gateway":"mundipagg"
    },
    "wallet_settings": {
        "max_cards": 5,
        "enabled": true,
        "shared": true
    },
    "safety_pay_settings": {
        "enabled": true,
        "gateway" : "mundipagg"
    },
    "facebook_settings": {
        "app_id": 742347232346492,
        "app_secret": "65c4263asdasdas9fc0fb083cbdef4",
        "permissions": [
            "email",
            "user_likes"
        ]
    },
    "general_settings": {
        "display_name": "MundiPagg",
        "logo": null,
        "email": "[email protected]",
        "website": "http://www.mundipagg.com",
        "theme": "http://www.mundipagg.com/mundi.css",
        "address_type": "global",
        "checkout_redirect_enabled": false
    },
    "webhook_settings": [
        {
            "id": "hookset_k3nBpk0He7HWY1jz",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        },
        {
            "id": "hookset_0r1kYjKInOIVLRzn",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        }
    ],
    "split_settings": {
        "enabled": true
    },
    "subscription_settings": {
        "enabled": false,
        "boleto_due_days": null
    },
    "order_settings": {
        "multi_payments_enabled": false,
        "multi_buyers_enabled": false,
        "open_orders_enabled": false
    },
    "notification_settings": {
        "enabled": false
    },
    "guaranteed_cancellation_settings": {
        "enabled": false,
        "updated_At": "2018-05-03T19:20:34Z"
    }
}
 
Suggest Edits

Configuração do facebook

O objeto account possui em suas propriedade um objeto denominado facebook-settings

 
Atributos
Tipo
Descrição

app_id

string

Código do aplicativo no Facebook.

app_secret

string

Chave secreta do aplicativo no Facebook.

permissions

array of string

Conjunto de permissões no Facebook.

 
Suggest Edits

Atualizar configurações do facebook

 
patchhttps://api.mundipagg.com/core/v1/accounts/account_id/facebook-settings

Path Params

account_id
string
required

Identificador da conta

Body Params

app_id
string

Código do aplicativo no Facebook

app_secret
string

Chave secreta do aplicativo no Facebook

permissions
array of strings

Conjunto de permissões no Facebook

Atenção

Somente disponível caso possua configurações do gateway pagarme.

{
   "app_id":742347362566491,
   "app_secret":"65c426365c8f8fe399fc0fb083cbdef4",
   "permissions":[
      "email",
      "user_likes"
   ]
}
A binary file was returned

You couldn't be authenticated

{
    "id": "acc_GsdfsdfsdaYEOB",
    "secret_key": "sk_Zasdasdasd5",
    "public_key": "pk_keasdasdasdQ",
    "name": "MundiPagg",
    "time_zone": "E. South America Standard Time",
    "default_currency": "BRL",
    "status": "inactive",
    "domains": [
        "localhost"
    ],
    "mundipagg_settings": {
        "merchant_key": "asdasd-asdasd9-4asd3-basde-6asdasefadad5"
    },
    "pagarme_settings": {
        "api_key": null,
        "crypto_key": null
    },
    "credit_card_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "voucher_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "boleto_settings": {
        "enabled": true,
        "bank": "001",
        "instructions": "Pagar antes do vencimento",
        "gateway": "mundipagg",
        "due_days": 3
    },
    "bank_transfer_settings": {
        "enabled": true,
      	"bank": "001",
  			"gateway":"mundipagg"
    },
    "wallet_settings": {
        "max_cards": 5,
        "enabled": true,
        "shared": true
    },
    "safety_pay_settings": {
        "enabled": true,
        "gateway" : "mundipagg"
    },
    "facebook_settings": {
        "app_id": 742347232346492,
        "app_secret": "65c4263asdasdas9fc0fb083cbdef4",
        "permissions": [
            "email",
            "user_likes"
        ]
    },
    "general_settings": {
        "display_name": "MundiPagg",
        "logo": null,
        "email": "[email protected]",
        "website": "http://www.mundipagg.com",
        "theme": "http://www.mundipagg.com/mundi.css",
        "address_type": "global",
        "checkout_redirect_enabled": false
    },
    "webhook_settings": [
        {
            "id": "hookset_k3nBpk0He7HWY1jz",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        },
        {
            "id": "hookset_0r1kYjKInOIVLRzn",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        }
    ],
    "split_settings": {
        "enabled": true
    },
    "subscription_settings": {
        "enabled": false,
        "boleto_due_days": null
    },
    "order_settings": {
        "multi_payments_enabled": false,
        "multi_buyers_enabled": false,
        "open_orders_enabled": false
    },
    "notification_settings": {
        "enabled": false
    },
    "guaranteed_cancellation_settings": {
        "enabled": false,
        "updated_At": "2018-05-03T19:20:34Z"
    }
}
 
Suggest Edits

Configuração de notificação

O objeto account possui em suas propriedade um objeto denominado notification-settings

 
Atributos
Tipo
Descrição

enabled

bool

Indica se notificação está habilitado.

 
Suggest Edits

Atualizar configurações de notificação

 
patchhttps://api.mundipagg.com/core/v1/accounts/account_id/notification-settings

Path Params

account_id
string
required

Identificador da conta

Body Params

enabled
boolean

Indica se notificação está habilitado

Atenção

Somente disponível caso possua configurações do gateway pagarme.

{
   "enabled":true
}
A binary file was returned

You couldn't be authenticated

{
    "id": "acc_GsdfsdfsdaYEOB",
    "secret_key": "sk_Zasdasdasd5",
    "public_key": "pk_keasdasdasdQ",
    "name": "MundiPagg",
    "time_zone": "E. South America Standard Time",
    "default_currency": "BRL",
    "status": "inactive",
    "domains": [
        "localhost"
    ],
    "mundipagg_settings": {
        "merchant_key": "asdasd-asdasd9-4asd3-basde-6asdasefadad5"
    },
    "pagarme_settings": {
        "api_key": null,
        "crypto_key": null
    },
    "credit_card_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "voucher_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "boleto_settings": {
        "enabled": true,
        "bank": "001",
        "instructions": "Pagar antes do vencimento",
        "gateway": "mundipagg",
        "due_days": 3
    },
    "bank_transfer_settings": {
        "enabled": true,
      	"bank": "001",
  			"gateway":"mundipagg"
    },
    "wallet_settings": {
        "max_cards": 5,
        "enabled": true,
        "shared": true
    },
    "safety_pay_settings": {
        "enabled": true,
        "gateway" : "mundipagg"
    },
    "facebook_settings": {
        "app_id": 742347232346492,
        "app_secret": "65c4263asdasdas9fc0fb083cbdef4",
        "permissions": [
            "email",
            "user_likes"
        ]
    },
    "general_settings": {
        "display_name": "MundiPagg",
        "logo": null,
        "email": "[email protected]",
        "website": "http://www.mundipagg.com",
        "theme": "http://www.mundipagg.com/mundi.css",
        "address_type": "global",
        "checkout_redirect_enabled": false
    },
    "webhook_settings": [
        {
            "id": "hookset_k3nBpk0He7HWY1jz",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        },
        {
            "id": "hookset_0r1kYjKInOIVLRzn",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        }
    ],
    "split_settings": {
        "enabled": true
    },
    "subscription_settings": {
        "enabled": false,
        "boleto_due_days": null
    },
    "order_settings": {
        "multi_payments_enabled": false,
        "multi_buyers_enabled": false,
        "open_orders_enabled": false
    },
    "notification_settings": {
        "enabled": false
    },
    "guaranteed_cancellation_settings": {
        "enabled": false,
        "updated_At": "2018-05-03T19:20:34Z"
    }
}
 
Suggest Edits

Configuração de cancelamento garantido

O objeto account possui em suas propriedade um objeto denominado guaranteed-cancellation-settings

 
Atributos
Tipo
Descrição

enabled

bool

Indica se o cancelamento garantido está habilitado.

 
Suggest Edits

Atualizar configurações de cancelamento garantido

 
patchhttps://api.mundipagg.com/core/v1/accountId/guaranteed-cancellation-settings

Path Params

account_id
string
required

Identificador da conta

Body Params

enabled
boolean

Indica se está habilitado a configuração

 
    {
     "enabled" : true,
    }
A binary file was returned

You couldn't be authenticated

{
 "enabled" : true,
}
 
Suggest Edits

Configuração de webhook

O objeto account possui em suas propriedade um objeto denominado webhook-settings

 
Atributos
Tipo
Descrição

url

string

Url destino.

events

array of string

Eventos direcionados a url.

interval

integer

Intervalo em segundos para tentativa.

max_attempts

integer

Quantidade máxima de tentativas.

authentication_type

string

Tipo de autenticação.

basic_authentication.username

string

Nome do usuário da autenticação.

basic_authentication.password

string

Senha do usuário da autenticação.

 
Suggest Edits

Atualizar configurações de webhook

 
puthttps://api.mundipagg.com/core/v1/accounts/account_id/webhook-settings/hookSetId

Path Params

account_id
string
required

Identificador da conta

hookset_id
string
required

Identificador da configuração de webhook

Body Params

status
string
required

Status do webhook . 'active' ou 'inactive

url
string
required

Url de notificação

events
array of strings

Lista de eventos disparados para essa url

Interval
int32

Intervalo de tempo entre tentativas

max_attempts
int32

Quantidade máxima de tentativas

authentication_type
string

Tipo de autenticação

basic_authentication
object
basic_authentication.username
string

Login de autenticação

basic_authentication.password
string

Senha de autenticação

Atenção

Somente disponível caso possua configurações do gateway pagarme.

{
  "url": "https://www.mundipagg2.com",
  "events": [ "charge.paid" ],
  "authentication_type" : "Basic",
  "basic_authentication":{
  	"username" : "stark",
  	"password" : "123"
  }
}
A binary file was returned

You couldn't be authenticated

{
    "id": "acc_GsdfsdfsdaYEOB",
    "secret_key": "sk_Zasdasdasd5",
    "public_key": "pk_keasdasdasdQ",
    "name": "MundiPagg",
    "time_zone": "E. South America Standard Time",
    "default_currency": "BRL",
    "status": "inactive",
    "domains": [
        "localhost"
    ],
    "mundipagg_settings": {
        "merchant_key": "asdasd-asdasd9-4asd3-basde-6asdasefadad5"
    },
    "pagarme_settings": {
        "api_key": null,
        "crypto_key": null
    },
    "credit_card_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "voucher_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "boleto_settings": {
        "enabled": true,
        "bank": "001",
        "instructions": "Pagar antes do vencimento",
        "gateway": "mundipagg",
        "due_days": 3
    },
    "bank_transfer_settings": {
        "enabled": true,
      	"bank": "001",
  			"gateway":"mundipagg"
    },
    "wallet_settings": {
        "max_cards": 5,
        "enabled": true,
        "shared": true
    },
    "safety_pay_settings": {
        "enabled": true,
        "gateway" : "mundipagg"
    },
    "facebook_settings": {
        "app_id": 742347232346492,
        "app_secret": "65c4263asdasdas9fc0fb083cbdef4",
        "permissions": [
            "email",
            "user_likes"
        ]
    },
    "general_settings": {
        "display_name": "MundiPagg",
        "logo": null,
        "email": "[email protected]",
        "website": "http://www.mundipagg.com",
        "theme": "http://www.mundipagg.com/mundi.css",
        "address_type": "global",
        "checkout_redirect_enabled": false
    },
    "webhook_settings": [
        {
            "id": "hookset_k3nBpk0He7HWY1jz",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
          	"basic_authentication":{
  							"username" : "stark",
  							"password" : "123"
 						 },
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        }
    ],
    "split_settings": {
        "enabled": true
    },
    "subscription_settings": {
        "enabled": false,
        "boleto_due_days": null
    },
    "order_settings": {
        "multi_payments_enabled": false,
        "multi_buyers_enabled": false,
        "open_orders_enabled": false
    },
    "notification_settings": {
        "enabled": false
    },
    "guaranteed_cancellation_settings": {
        "enabled": false,
        "updated_At": "2018-05-03T19:20:34Z"
    }
}
 
Suggest Edits

Deletar configurações de webhook

 
deletehttps://api.mundipagg.com/core/v1/accounts/account_id/webhook-settings/hookSetId

Path Params

account_id
string
required

Identificador da conta

hookset_id
string
required

Identificador da configuração de webhook

Atenção

Somente disponível caso possua configurações do gateway pagarme.

No code samples available
A binary file was returned

You couldn't be authenticated

{
    "id": "hookset_zn5VJXQHYCr1eLRg",
    "url": "https://www.mundipagg2.com",
    "status": "deleted",
    "events": [
        "charge.paid"
    ],
    "interval": 300,
    "max_attempts": 3,
    "authentication_type": "basic",
    "created_at": "2018-05-08T15:59:35Z",
    "updated_at": "2018-05-08T15:59:38Z",
    "deleted_at": "2018-05-08T15:59:38Z"
}
 
Suggest Edits

Obter configurações de webhook

 
gethttps://api.mundipagg.com/core/v1/accounts/account_id/webhook-settings/hookSetId

Path Params

account_id
string
required

Identificador da conta

hookset_id
string
required

Identificador da configuração de webhook

Atenção

Somente disponível caso possua configurações do gateway pagarme.

No code samples available
A binary file was returned

You couldn't be authenticated

{
    "id": "hookset_3KlpAGU4xiBLV7aZ",
    "url": "https://www.mundipagg2.com",
    "status": "active",
    "events": [
        "charge.paid"
    ],
    "interval": 300,
    "max_attempts": 3,
    "created_at": "2018-05-07T16:48:44Z",
    "updated_at": "2018-05-07T16:48:44Z"
}
 
Suggest Edits

Criar configurações de webhook

 
posthttps://api.mundipagg.com/core/v1/accounts/account_id/webhook-settings

Path Params

account_id
string
required

Identificador da conta

Body Params

url
string
required

Url de notificação

events
array of strings

Lista de eventos disparados para essa url

Interval
int32

Intervalo de tempo entre tentativas

max_attempts
int32

Quantidade máxima de tentativas

authentication_type
string

Tipo de autenticação

basic_authentication
object
basic_authentication.username
string

Login de autenticação

basic_authentication.password
string

Senha de autenticação

Atenção

Somente disponível caso possua configurações do gateway pagarme.

{
  "url": "https://www.mundipagg2.com",
  "events": [ "charge.paid" ],
  "authentication_type" : "Basic",
  "basic_authentication":{
  	"username" : "stark",
  	"password" : "123"
  }
}
A binary file was returned

You couldn't be authenticated

{
    "id": "acc_GsdfsdfsdaYEOB",
    "secret_key": "sk_Zasdasdasd5",
    "public_key": "pk_keasdasdasdQ",
    "name": "MundiPagg",
    "time_zone": "E. South America Standard Time",
    "default_currency": "BRL",
    "status": "inactive",
    "domains": [
        "localhost"
    ],
    "mundipagg_settings": {
        "merchant_key": "asdasd-asdasd9-4asd3-basde-6asdasefadad5"
    },
    "pagarme_settings": {
        "api_key": null,
        "crypto_key": null
    },
    "credit_card_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "voucher_settings": {
        "enabled": true,
        "gateway": "mundipagg"
    },
    "boleto_settings": {
        "enabled": true,
        "bank": "001",
        "instructions": "Pagar antes do vencimento",
        "gateway": "mundipagg",
        "due_days": 3
    },
    "bank_transfer_settings": {
        "enabled": true,
      	"bank": "001",
  			"gateway":"mundipagg"
    },
    "wallet_settings": {
        "max_cards": 5,
        "enabled": true,
        "shared": true
    },
    "safety_pay_settings": {
        "enabled": true,
        "gateway" : "mundipagg"
    },
    "facebook_settings": {
        "app_id": 742347232346492,
        "app_secret": "65c4263asdasdas9fc0fb083cbdef4",
        "permissions": [
            "email",
            "user_likes"
        ]
    },
    "general_settings": {
        "display_name": "MundiPagg",
        "logo": null,
        "email": "[email protected]",
        "website": "http://www.mundipagg.com",
        "theme": "http://www.mundipagg.com/mundi.css",
        "address_type": "global",
        "checkout_redirect_enabled": false
    },
    "webhook_settings": [
        {
            "id": "hookset_k3nBpk0He7HWY1jz",
            "url": "https://www.mundipagg.com/"
            "status": "active",
            "events": [
                "charge.paid"
            ],
            "interval": 300,
          	"basic_authentication":{
  							"username" : "stark",
  							"password" : "123"
 						 },
            "max_attempts": 3,
            "created_at": "2018-05-03T19:20:34Z",
            "updated_at": "2018-05-03T19:20:34Z"
        }
    ],
    "split_settings": {
        "enabled": true
    },
    "subscription_settings": {
        "enabled": false,
        "boleto_due_days": null
    },
    "order_settings": {
        "multi_payments_enabled": false,
        "multi_buyers_enabled": false,
        "open_orders_enabled": false
    },
    "notification_settings": {
        "enabled": false
    },
    "guaranteed_cancellation_settings": {
        "enabled": false,
        "updated_At": "2018-05-03T19:20:34Z"
    }
}
 
Suggest Edits

Configurações de re-tentativa

O objeto account possui em suas propriedade um objeto denominado webhook-settings

 
Atributos
Tipo
Descrição

type

string

Tipo da tentativa. Valores possíveis : "SUBSCRIPTION", "CHARGE".

interval

array of longs

Intervalos de horas entre as re-tentativas.

 
Suggest Edits

Criar configuração de re-tentativa

 
posthttps://api.mundipagg.com/core/v1/accounts/accountId/attempt-settings

Path Params

account_id
string
required

Identificação do usuario

Body Params

type
string
required

Tipo da tentativa

intervals
array of integers

Intervalos de horas entre as retentativas

 
    {
      "type" : "charge",
      "intervals" : 1
    } 
A binary file was returned

You couldn't be authenticated

{
    "id": "attemp_8KVB2qjiJsY9w21z",
    "type": "charge",
    "status": "active",
    "intervals": [
        1
    ],
    "created_at": "2018-05-07T16:30:05Z",
    "updated_at": "2018-05-07T16:30:05Z"
}
 
Suggest Edits

Atualizar configuração de re-tentativa

 
puthttps://api.mundipagg.com/core/v1/accounts/accountId/attempt-settings/attempId

Path Params

account_id
string
required

Identificação do usuario

attempd_id
string
required

Identificador da configuração

Body Params

type
string
required

Tipo da tentativa

intervals
array of integers

Intervalos de horas entre as retentativas

status
string
required

Status da configuração. Valores possíveis : active ou inactive

 
    {
      "status" : "active",
      "type" : "charge",
      "intervals" : 1
    } 
A binary file was returned

You couldn't be authenticated

{
    "id": "attemp_8KVB2qjiJsY9w21z",
    "type": "charge",
    "status": "active",
    "intervals": [
        1
    ],
    "created_at": "2018-05-07T16:30:05Z",
    "updated_at": "2018-05-07T16:30:05Z"
}
 
Suggest Edits

Obter todas as configurações de re-tentativa

 
gethttps://api.mundipagg.com/core/v1/accounts/accountId/attempt-settings

Path Params

account_id
string
required

Identificação do usuario

Query Params

page
int32

Numero da pagina

size
int32

Numero de dados por pagina

 
No code samples available
A binary file was returned

You couldn't be authenticated

{
    "data": [
        {
            "id": "attemp_8KVB2qjiJsY9w21z",
            "type": "charge",
            "status": "active",
            "intervals": [
                1
            ],
            "created_at": "2018-05-07T16:30:05Z",
            "updated_at": "2018-05-07T16:30:05Z"
        }
    ],
    "paging": {
        "total": 1
    }
}
 
Suggest Edits

Obter configurações de re-tentativa

 
gethttps://api.mundipagg.com/core/v1/accounts/accountId/attempt-settings/attempId

Path Params

account_id
string
required

Identificação do usuario

attemp_Id
string
required

identificador da configuração

 
No code samples available
A binary file was returned

You couldn't be authenticated

{
            "id": "attemp_8KVB2qjiJsY9w21z",
            "type": "charge",
            "status": "active",
            "intervals": [
                1
            ],
            "created_at": "2018-05-07T16:30:05Z",
            "updated_at": "2018-05-07T16:30:05Z"
  
}
 
Suggest Edits

Visão Geral sobre Wallet

A API Mundipagg fornece o recurso Wallet, que permite o armazenamento de cartões associados a um comprador, viabilizando a realização de compras com um clique, por exemplo. Saiba mais sobre Wallet vs. Carteira de Clientes.

 
 
 
Suggest Edits

Clientes

O objeto customer possibilita a criação e gerenciamento de uma Carteira de Clientes. Um customer possui os seguintes atributos:

 
Atributos
Tipo
Descrição

id

string

Código do cliente. Formato cus_XXXXXXXXXXXXXXXX.

name

string

Nome do cliente.

email

string

E-mail do cliente.

phones

object

Telefones do cliente. Saiba mais sobre telefones.

document

string

CPF ou CNPJ do cliente.

type

enum

Tipo de cliente. Valores possíveis: individual e company.

gender

string

Sexo do cliente. Valores possíveis: male ou female.

address

object

Endereço do cliente. Saiba mais sobre endereços.

fb_id

integer

Código do cliente no Facebook.

fb_access_token

string

Token de acesso do Facebook. Usado para fazer chamadas da GraphAPI e obter informações do usuário.

delinquent

boolean

Indica se o cliente está inadimplente.

code

string

Código de referência do cliente no sistema da loja.

created_at

datetime

Data de criação do cliente.

updated_at

datetime

Data de atualização do cliente.

birthdate

datetime

Data de nascimento do cliente.

metadata

object

Informações adicionais sobre o cliente. Saiba mais sobre metadata.

 
Suggest Edits

Criar cliente

Este recurso cria um objeto customer que representa um cliente.

 
posthttps://api.mundipagg.com/core/v1/customers

Body Params

name
string
required

Nome do cliente. Max: 64 caracteres.

email
string

E-mail do cliente. Max: 64 caracteres

code
string

Código de referência do cliente no sistema da loja. Max: 52 caracteres

document
string

CPF ou CNPJ do cliente. Max: 16 caracteres

type
string
required

Tipo de cliente. Valores possíveis: individual (pessoa física) ou company (pessoa jurídica).
Obrigatório, caso o document seja enviado.

gender
string

Sexo do cliente . Valores possíveis: male ou female

address
object

Endereço do cliente. Saiba mais sobre endereços

phones
object

Telefones do cliente. Saiba mais sobre o telefones

phones.home_phone
object

Telefone residencial do cliente. Saiba mais sobre o telefones

phones.mobile_phone
object

Telefone móvel do cliente. Saiba mais sobre o telefones

birthdate
date

Data de nascimento do cliente.

metadata
string

Objeto chave/valor utilizado para armazenar informações adicionais sobre o cliente. Saiba mais sobre metadata


O e-mail do cliente é único

É importante destacar que o campo e-mail é único, ou seja, caso seja requisitada a criação de um cliente com um e-mail já cadastrado, o endpoint irá atualizar os dados do customer anteriormente cadastrado com o email informado.

{
    "name": "Tony Stark",
    "email": "[email protected]",
    "code": "MY_CUSTOMER_001",
    "document": "123456789",
    "type": "individual",
    "gender": "male",
    "address": {
    	"line_1": "375, Av. General Justo, Centro",
    	"line_2": "8º andar",
    	"zip_code": "20021130",
    	"city": "Rio de Janeiro",
    	"state": "RJ",
    	"country": "BR"
    },
    "birthdate": "05/03/1984",    
    "phones": {
      "home_phone": {
        "country_code": "55",
        "area_code": "21",
        "number": "000000000"
      },
      "mobile_phone": {
        "country_code": "55",
        "area_code": "21",
        "number": "000000000"
      }
    },
    "metadata": {
      "company": "Avengers"
    }
}
using MundiAPI.PCL;
using MundiAPI.PCL.Models;
using System.Collections.Generic;
using System.Web.Mvc;

namespace MundipaggTest.Controllers {

public class HomeController : Controller {

public ActionResult Index() {

    // Secret key fornecida pela Mundipagg
    string basicAuthUserName = "sk_test_4tdVXpseumRmqbo";

    // Senha em branco. Passando apenas a secret key
    string basicAuthPassword = "";

    var client = new MundiAPIClient(basicAuthUserName, basicAuthPassword);

    var metadata = new Dictionary<string, string>();
    metadata.Add("id", "my_customer_id");

    var address = new CreateAddressRequest {
        Line1 = "375, Av. General Justo, Centro",
        Line2 = "8º andar",
        ZipCode = "20021130",
        ZipCode = "20021130",
        City = "Rio de Janeiro",
        State = "RJ",
        Country = "BR"
    };

    var phones = new CreatePhonesRequest {
        HomePhone = new CreatePhoneRequest {

            AreaCode = "21",
            CountryCode = "55",
            Number = "000000000"
        },
        MobilePhone = new CreatePhoneRequest {

            AreaCode = "21",
            CountryCode = "55",
            Number = "000000000"
        },
    };

    var request = new CreateCustomerRequest {
        Name = "Tony Stark",
        Email = "[email protected]",
        Type = "individual",
        Document = "93095135270",
        Gender = "male",
        Code = "MY_CUSTOMER_001"
        Phones = phones,
        Address = address,
        Metadata = metadata
    };

    var response = client.Customers.CreateCustomer(request);

    return View();
}
}
}
//This example was built using MundiAPI-PHP SDK.
//For more information, please refer to https://github.com/mundipagg/MundiAPI-PHP

$secretKey = 'sk_test_4tdVXpseumRmqbo'; //the secret key will be provided by MundiPagg.
$basicAuthPassword = ''; //fill it with an empty string

$apiClient = new \MundiAPILib\MundiAPIClient(
    $secretKey,
    $basicAuthPassword
);

$customerController = $apiClient->getCustomers();

$request = new \MundiAPILib\Models\CreateCustomerRequest();
$request->name = "sdk customer test";
$request->email = "[email protected]";
$request->type = "individual";
$request->document = "55342561094";
$request->code = "MY_CUSTOMER_001";

$request->address = new \MundiAPILib\Models\CreateAddressRequest();
$request->address->line1 = "375, Av. General Justo, Centro";
$request->address->line2 = "8º andar";
$request->address->zipCode = "20021130";
$request->address->city = "Rio de Janeiro";
$request->address->state = "RJ";
$request->address->country = "BR";
$request->address->metadata = new \MundiAPILib\Models\UpdateMetadataRequest();
$request->address->metadata->id = "my_address_id";

$request->phones = new \MundiAPILib\Models\CreatePhonesRequest();
$request->phones->homePhone = new \MundiAPILib\Models\CreatePhoneRequest();
$request->phones->homePhone->areaCode = "21";
$request->phones->homePhone->countryCode = "55";
$request->phones->homePhone->number = "000000000";
$request->phones->mobilePhone = new \MundiAPILib\Models\CreatePhoneRequest();
$request->phones->mobilePhone->areaCode = "21";
$request->phones->mobilePhone->countryCode = "55";
$request->phones->mobilePhone->number = "000000000";

$result = $customerController->createCustomer($request);

echo json_encode($result, JSON_PRETTY_PRINT);
package examples.customer;

import com.mundipagg.api.MundiAPIClient;
import com.mundipagg.api.http.client.*;
import com.mundipagg.api.models.*;
import com.mundipagg.api.controllers.*;

import java.util.LinkedHashMap;

public class CreateCustomer {
	
	public static void main(String[] args) {

        String basicAuthUserName = "sk_test_4tdVXpseumRmqbo"; // The username to use with basic authentication
        String basicAuthPassword = ""; // The password to use with basic authentication

        MundiAPIClient client = new MundiAPIClient(basicAuthUserName, basicAuthPassword);

        CustomersController customers_controller = new CustomersController();

        CreateCustomerRequest request = new CreateCustomerRequest();
        request.setName("sdk customer test");
        request.setEmail("[email protected]");
        request.setType("individual");
        request.setDocument("55342561094");
        request.setCode("MY_CUSTOMER_001");

        request.setAddress(new CreateAddressRequest());
        request.getAddress().setLine1("375, Av. General Justo, Centro");
        request.getAddress().setLine2("8º andar");
        request.getAddress().setZipCode("20021130");
        request.getAddress().setCity("Rio de Janeiro");
        request.getAddress().setState("RJ");
        request.getAddress().setCountry("BR");
        LinkedHashMap<String, String> metadata = new LinkedHashMap<String, String>();
        metadata.put("id","my_address_id");
        UpdateMetadataRequest updateMetadata = new UpdateMetadataRequest();
        updateMetadata.setMetadata(metadata);
        request.getAddress().setMetadata(updateMetadata.getMetadata());

        request.setPhones(new CreatePhonesRequest());
        request.getPhones().setHomePhone(new CreatePhoneRequest());
        request.getPhones().getHomePhone().setAreaCode("21");
        request.getPhones().getHomePhone().setCountryCode("55");
        request.getPhones().getHomePhone().setNumber("000000000");
        request.getPhones().setMobilePhone(new CreatePhoneRequest());
        request.getPhones().getMobilePhone().setAreaCode("21");
        request.getPhones().getMobilePhone().setCountryCode("55");
        request.getPhones().getMobilePhone().setNumber("000000000");

        customers_controller.createCustomerAsync(request, new APICallBack<GetCustomerResponse>() {
            @Override
            public void onSuccess(HttpContext context, GetCustomerResponse response) {

                System.out.println("Status response: " + context.getResponse().getStatusCode());
                System.out.println("Customer create !");
                System.out.println("Status response: " + context.getResponse().getStatusCode());
                System.out.println("Customer ID: " + response.getId());

            }

            @Override
            public void onFailure(HttpContext context, Throwable error) {

                System.out.println("Status response: " + context.getResponse().getStatusCode());
                System.out.println(error.getMessage());
                error.printStackTrace();

            }
        });
    }

}
from mundiapi.mundiapi_client import MundiapiClient
from mundiapi.models import *
from mundiapi.controllers import *
from mundiapi.exceptions.error_exception import *

MundiapiClient.config.basic_auth_user_name = "YOUR_SECRET_KEY:"
customers_controller = customers_controller.CustomersController()

request = create_customer_request.CreateCustomerRequest()
request.name = "sdk customer test"
request.email = "[email protected]"

try:
    result = customers_controller.create_customer(request)
    assert result is not None
    print("Customer id: ", result.id)

except ErrorException as ex:
    print(ex.message)
    print("Errors: ", ex.errors)
except Exception as ex:
    raise ex
A binary file was returned

You couldn't be authenticated

{
    "id": "cus_QA5V47r9c0Im3dzN",
    "name": "Tony Stark",
    "email": "[email protected]",
    "code": "MY_CUSTOMER_001",
    "document": "123456789",
    "type": "individual",
    "gender": "male",
    "delinquent": false,
    "address": {
        "id": "addr_KewjagEfrCbY1doZ",
        "line_1": "375, Av. General Justo, Centro",
        "line_2": "8º andar",
        "zip_code": "20021130",
        "city": "Rio de Janeiro",
        "state": "RJ",
        "country": "BR",
        "status": "active",
        "created_at": "2017-09-22T15:36:46Z",
        "updated_at": "2018-04-03T17:46:20Z"
    },
    "created_at": "2017-09-22T15:36:46Z",
    "updated_at": "2018-04-03T17:46:20Z",
    "birthdate": "1984-05-03T00:00:00Z",
    "phones": {
        "home_phone": {
            "country_code": "55",
            "number": "000000000",
            "area_code": "21"
        },
        "mobile_phone": {
            "country_code": "55",
            "number": "000000000",
            "area_code": "21"
        }
    },
    "metadata": {
        "id": "my_customer_id",
        "company": "Avengers"
    }
}
{
    "message": "The request is invalid.",
    "errors": {
        "customer.name": [
            "The name field is required."
        ]
    },
    "request": {
        "email": "[email protected]",
        "code": "MY_CUSTOMER_001",
        "document": "123456789",
        "type": "individual",
        "address": {
            "line_1": "375, Av. General Justo, Centro",
            "line_2": "8º andar",
            "zip_code": "20021130",
            "city": "Rio de Janeiro",
            "state": "RJ",
            "country": "BR",
        },
        "birthdate": "1984-05-03T00:00:00Z",
        "phones": {
            "home_phone": {
                "country_code": "55",
                "number": "000000000",
                "area_code": "21"
            },
            "mobile_phone": {
                "country_code": "55",
                "number": "000000000",
                "area_code": "21"
            }
        },
        "gender": "male",
        "metadata": {
            "company": "Avengers"
        }
    }
}
 
Suggest Edits

Obter cliente

Através do identificador do cliente (customer_id) é possível recuperar seus dados.

 
gethttps://api.mundipagg.com/core/v1/customers/customer_id

Path Params

customer_id
string
required

Código do cliente. Formato cus_XXXXXXXXXXXXXXXX.


using MundiAPI.PCL;
using System.Web.Mvc;

namespace MundipaggTest.Controllers {

    public class HomeController : Controller {

public ActionResult Index() {

    // Secret key fornecida pela Mundipagg
    string basicAuthUserName = "sk_test_4tdVXpseumRmqbo";
    // Senha em branco. Passando apenas a secret key
    string basicAuthPassword = "";

    var client = new MundiAPIClient(basicAuthUserName, basicAuthPassword);
    string customerId = "cus_6l5dMWZ0hkHZ4XnE";

    var response = client.Customers.GetCustomer(customerId);

    return View();
}
}
}
//This example was built using MundiAPI-PHP SDK.
//For more information, please refer to https://github.com/mundipagg/MundiAPI-PHP

$secretKey = 'sk_test_4tdVXpseumRmqbo'; //the secret key will be provided by MundiPagg.
$basicAuthPassword = ''; //fill it with an empty string

$apiClient = new \MundiAPILib\MundiAPIClient(
    $secretKey,
    $basicAuthPassword
);

$customersController = $apiClient->getCustomers();

$customerId = "cus_6l5dMWZ0hkHZ4XnE";

$result = $customersController->getCustomer($customerId);

echo json_encode($result, JSON_PRETTY_PRINT);
package examples.customer;

import com.mundipagg.api.MundiAPIClient;
import com.mundipagg.api.controllers.CustomersController;
import com.mundipagg.api.http.client.APICallBack;
import com.mundipagg.api.http.client.HttpContext;
import com.mundipagg.api.models.GetCustomerResponse;

public class GetCustomerById {
	
	public static void main(String[] args) {

        String basicAuthUserName = "sk_test_4tdVXpseumRmqbo"; // The username to use with basic authentication
        String basicAuthPassword = ""; // The password to use with basic authentication

        MundiAPIClient client = new MundiAPIClient(basicAuthUserName, basicAuthPassword);

        String customerId = "cus_YL6zwglSxhg2X14g";

        CustomersController customers_controller = new CustomersController();

        customers_controller.getCustomerAsync(customerId, new APICallBack<GetCustomerResponse>() {
            @Override
            public void onSuccess(HttpContext context, GetCustomerResponse response) {

                System.out.println("Status response: " + context.getResponse().getStatusCode());
                System.out.println("Customer found!");
                System.out.println("Customer ID: " + response.getId());

            }

            @Override
            public void onFailure(HttpContext context, Throwable error) {

                System.out.println("Status response: " + context.getResponse().getStatusCode());
                System.out.println(error.getMessage());
                error.printStackTrace();

            }
        });
    }

}
from mundiapi.mundiapi_client import MundiapiClient
from mundiapi.models import *
from mundiapi.controllers import *
from mundiapi.exceptions.error_exception import *

MundiapiClient.config.basic_auth_user_name = "YOUR_SECRET_KEY:"
customers_controller = customers_controller.CustomersController()

request = create_customer_request.CreateCustomerRequest()
request.name = "sdk customer test"
request.email = "[email protected]"

try:
    result = customers_controller.create_customer(request)
    myCustomer = customers_controller.get_customer(result.id)
    assert result is not None
    assert myCustomer is not None
    assert result.id == myCustomer.id
    print("Customer id: ", myCustomer.id)

except ErrorException as ex:
    print(ex.message)
    print("Errors: ", ex.errors)
except Exception as ex:
    raise ex
A binary file was returned

You couldn't be authenticated

{
    "id": "cus_6l5dMWZ0hkHZ4XnE",
    "name": "Wonderful Woman",
    "email": "[email protected]",
  	"gender": "female",
    "delinquent": false,
    "address": {
        "id": "addr_ONzp3ZbTvfDJ35k9",
        "line_1": "375, Av. General Justo, Centro",
        "line_2": "8º andar",
        "zip_code": "20021130",
        "city": "Rio de Janeiro",
        "state": "RJ",
        "country": "BR",
        "status": "active",
        "created_at": "2017-08-22T19:50:44Z",
        "updated_at": "2017-08-22T19:50:44Z"
    },
    "created_at": "2017-08-22T19:50:44Z",
    "updated_at": "2017-08-22T19:50:51Z",
    "phones": {},
    "metadata": {
        "company": "Avengers"
    }
}
{
    "message": "Customer not found."
}
 
Suggest Edits

Editar cliente

Com o verbo HTTP PUT, através do identificador do cliente (customer_id) é possível atualizar informações referentes ao cliente.

 
puthttps://api.mundipagg.com/core/v1/customers/customer_id

Path Params

customer_id
string
required

Código do cliente. Formato cus_XXXXXXXXXXXXXXXX.

Body Params

name
string
required

Nome do cliente. Max: 64 caracteres.

email
string

E-mail do cliente. Max: 64 caracteres

phones
object

Telefones do cliente. Saiba mais sobre telefones

document
string

CPF ou CNPJ do cliente. Max: 16 caracteres

code
string

Código de referência do cliente no sistema da loja. Max: 52 caracteres

type
string

Tipo de cliente . Valores possíveis: individual (pessoa física) ou company (pessoa jurídica)
Obrigatório, caso o document seja enviado.

gender
string

Sexo do cliente . Valores possíveis: male ou female

address
object

Endereço do cliente. Saiba mais sobre endereços

birthdate
date

Data de nascimento do cliente.

metadata
object

Objeto chave/valor utilizado para armazenar informações adicionais sobre o cliente. Saiba mais sobre metadata

 
{
  "name": "Peter Parker",
  "email": "[email protected]",
  "gender": "male"
}
using MundiAPI.PCL;
using MundiAPI.PCL.Models;
using System.Web.Mvc;

namespace MundipaggTest.Controllers {

public class HomeController : Controller {

    public ActionResult Index() {

    // Secret key fornecida pela Mundipagg
    string basicAuthUserName = "sk_test_4tdVXpseumRmqbo";
    // Senha em branco. Passando apenas a secret key
    string basicAuthPassword = "";

    var client = new MundiAPIClient(basicAuthUserName, basicAuthPassword);
    string customerId = "cus_6l5dMWZ0hkHZ4XnE";

    var request = new UpdateCustomerRequest {
        Name = "Peter Parker",
        Email = "[email protected]"
    };

    var response = client.Customers.UpdateCustomer(customerId, request);

    return View();
}
}
}
//This example was built using MundiAPI-PHP SDK.
//For more information, please refer to https://github.com/mundipagg/MundiAPI-PHP

$secretKey = 'sk_test_4tdVXpseumRmqbo'; //the secret key will be provided by MundiPagg.
$basicAuthPassword = ''; //fill it with an empty string

$apiClient = new \MundiAPILib\MundiAPIClient(
    $secretKey,
    $basicAuthPassword
);

$customerController = $apiClient->getCustomers();

$request = new \MundiAPILib\Models\UpdateCustomerRequest();
$request->name = "Peter Parker";
$request->email = "[email protected]";

$customerId = "cus_6l5dMWZ0hkHZ4XnE";

$result = $customerController->updateCustomer($customerId, $request);

echo json_encode($result, JSON_PRETTY_PRINT);
package examples.customer;

import com.mundipagg.api.MundiAPIClient;
import com.mundipagg.api.controllers.CustomersController;
import com.mundipagg.api.http.client.APICallBack;
import com.mundipagg.api.http.client.HttpContext;
import com.mundipagg.api.models.GetCustomerResponse;
import com.mundipagg.api.models.UpdateCustomerRequest;

public class UpdateCustomer {
	
	public static void main(String[] args) {

        String basicAuthUserName = "sk_test_4tdVXpseumRmqbo"; // The username to use with basic authentication
        String basicAuthPassword = ""; // The password to use with basic authentication

        MundiAPIClient client = new MundiAPIClient(basicAuthUserName, basicAuthPassword);

        CustomersController customers_controller = new CustomersController();

        UpdateCustomerRequest request = new UpdateCustomerRequest();

        request.setName("Peter Parker");
        request.setEmail("[email protected]");

        String customerId = "cus_YL6zwglSxhg2X14g";

        customers_controller.updateCustomerAsync(customerId, request, new APICallBack<GetCustomerResponse>() {
            @Override
            public void onSuccess(HttpContext context, GetCustomerResponse response) {

                System.out.println("Status response: " + context.getResponse().getStatusCode());
                System.out.println("Customer update!");
                System.out.println("Customer ID: " + response.getId());

            }

            @Override
            public void onFailure(HttpContext context, Throwable error) {

                System.out.println("Status response: " + context.getResponse().getStatusCode());
                System.out.println(error.getMessage());
                error.printStackTrace();

            }
        });
    }

}
from mundiapi.mundiapi_client import MundiapiClient
from mundiapi.models import *
from mundiapi.controllers import *
from mundiapi.exceptions.error_exception import *

MundiapiClient.config.basic_auth_user_name = "YOUR_SECRET_KEY:"
customers_controller = customers_controller.CustomersController()

createRequest = create_customer_request.CreateCustomerRequest()
createRequest.name = "sdk customer test"
createRequest.email = "[email protected]"

updateRequest = update_customer_request.UpdateCustomerRequest()
updateRequest.name = "New Customer Name"

try:
    result = customers_controller.create_customer(createRequest)
    customers_controller.update_customer(result.id, updateRequest)
    updatedCustomer = customers_controller.get_customer(result.id)
    assert result is not None
    assert updatedCustomer is not None
    assert result.id == updatedCustomer.id
    assert createRequest.name != updatedCustomer.name
    assert updatedCustomer.name == updateRequest.name
    print("Customer id: ", updatedCustomer.id)
    print("Old name: ", createRequest.name)
    print("New name: ", updatedCustomer.name)

except ErrorException as ex:
    print(ex.message)
    print("Errors: ", ex.errors)
except Exception as ex:
    raise ex
A binary file was returned

You couldn't be authenticated

{
  "id": "cus_6l5dMWZ0hkHZ4XnE",
  "name": "Peter Parker",
  "email": "[email protected]",
  "document": "26224451990",
  "gender": "male",
  "type": "individual",
  "delinquent": false,
  "created_at": "2017-05-02T23:26:49Z",
  "updated_at": "2017-05-02T23:28:16Z",
  "phones": {
    "home_phone": {
      "country_code": "55",
      "number": "0000002000",
      "area_code": "021"
    }
  },
  "metadata": {
    "id": "my_customer_id"
  }
}
{
    "message": "Customer not found."
}
{
    "message": "The request is invalid.",
    "errors": {
        "customer.name": [
            "The name field is required."
        ]
    },
    "request": {
        "email": "[email protected]",
        "phones": {}
    }
}
 
Suggest Edits

Listar clientes

Este recurso permite a obtenção da carteira de clientes do lojista. Pode ser utilizados alguns parâmetros como filtro da listagem.

 
gethttps://api.mundipagg.com/core/v1/customers

Query Params

name
string

Nome do cliente.

document
string

CPF ou CNPJ do cliente. Max: 16 caracteres

email
string

E-mail do cliente

gender
string

Sexo do cliente . Valores possíveis: male ou female

page
int32

Página atual.

size
int32

Quantidade de itens por página.

code
string

Código do cliente no sistema do lojista


Paginação

Este recurso utiliza paginação para manipulação da listagem resultante. Saiba mais sobre paginação.

using MundiAPI.PCL;
using System.Web.Mvc;

namespace MundipaggTest.Controllers {

    public class HomeController : Controller {

    public ActionResult Index() {

    // Secret key fornecida pela Mundipagg
    string basicAuthUserName = "sk_test_4tdVXpseumRmqbo";
    // Senha em branco. Passando apenas a secret key
    string basicAuthPassword = "";

    var client = new MundiAPIClient(basicAuthUserName, basicAuthPassword);

    var response = client.Customers.GetCustomers();

    return View();
    }
}
}
A binary file was returned

You couldn't be authenticated

{
  "data": [
    {
      "id": "cus_n2Y17zAt67s2Oplg",
      "name": "Monitor",
      "gender": "male",
      "email": "[email protected]",
      "delinquent": false,
      "created_at": "2017-04-19T17:43:10Z",
      "updated_at": "2017-04-19T17:43:10Z"
    },
    {
      "id": "cus_Z7DvZNpUZhYlvndR",
      "name": "Monitor",
      "gender": "female",
      "email": "[email protected]",
      "delinquent": false,
      "created_at": "2017-04-19T17:42:51Z",
      "updated_at": "2017-04-19T17:42:51Z"
    },
  "paging": {
    "total": 545797,
    "next": "https://api.mundipagg.com:4443/core/v1/customers?page=2&size=10"
  }
}
{
    "message": "Authorization has been denied for this request."
}
 
Suggest Edits

Cartões

O objeto card descreve um cartão (crédito, voucher ou private label) associado a um customer. Este recurso viabiliza a criação de uma Wallet, que representa todos os card associados a um customer. Saiba mais sobre Wallet.

 
Atributos
Tipo
Descrição

id

string

Código do cartão. Formato card_XXXXXXXXXXXXXXXX.

last_four_digits

string

Quatro últimos dígitos do cartão.

first_six_digits

string

Primeiros seis dígitos do cartão.

brand

string

Bandeira do cartão.
Para cartões de crédito, temos como valores possíveis : Elo, Mastercard, Visa, Amex, JCB, Aura, Hipercard, Diners ou Discover. Para voucher, temos como valores possíveis VR, Sodexo ou Alelo .

holder_name

string

Nome impresso no cartão.

holder_document

string

CPF ou CNPJ do portador do cartão.

exp_month

integer

Mês de vencimento do cartão.

exp_year

integer

Ano de vencimento do cartão. Formatos: yy ou yyyy.

status

enum

Status do cartão. Valores possíveis: active, deleted ou expired.

created_at

datetime

Data de criação do cartão.

update_at

datetime

Data de atualização do cartão.

deleted_at

datetime

Data de exclusão do cartão.

billing_address

object

Endereço de cobrança. Saiba mais sobre endereços.

customer

object

Dados do cliente. Saiba mais sobre clientes.

private_label

boolean

Indica se é um cartão private label.

type

string

Tipo do cartão. Valores possíveis: credit ou voucher.

metadata

object

Informações adicionais sobre o cartão. Saiba mais sobre metadata.

Autenticação para gerenciamento de Wallets

Além da autenticação via chave secreta de API (secret_key), os objetos card podem ser gerenciados utilizando-se a autenticação via access_token. Para conhecer essa forma de autenticação acesse nossa referência sobre Access Token.

 
Suggest Edits

Criar cartão

Este recurso cria um card associado ao customer através do customer_id informado.

 
posthttps://api.mundipagg.com/core/v1/customers/customer_id/cards

Path Params

customer_id
string
required

Código do cliente. Formato: cus_XXXXXXXXXXXXXXXX

Body Params

number
string
required

Número do cartão. Entre 13 e 19 caracteres

holder_name
string

Nome do portador como está impresso no cartão. Máximo de 64 caracteres (Caracteres especiais e números não são aceitos)

holder_document
string

CPF ou CNPJ do portador do cartão. Obrigatório caso o tipo do cartão seja voucher (bandeiras VR ou Sodexo).

exp_month
int32
required

Mês de validade do cartão. Valor entre 1 e 12 (inclusive)

exp_year
int32
required

Ano de validade do cartão. Formatos yy ou yyyy. Ex: 23 ou 2023.

cvv
string

Código de segurança do cartão. O campo aceita 4 ou 3 caracteres, variando por bandeira.

brand
string

Bandeira do cartão. Para cartões de crédito, temos como valores possíveis: Elo, Mastercard, Visa, Amex, JCB, Aura, Hipercard, Diners ou Discover. Para voucher, temos como valores possíveis: Alelo, VR ou Sodexo.

private_label
boolean

Indica se o cartão é um private label.

billing_address_id
string

Código do endereço de cobrança. Max: 36 caracteres.<>Opcional, pode ser utilizado no lugar do billing_address.

billing_address
object

Endereço de cobrança.

options
object

Objeto com opções para a criação do cartão. Um exemplo de opção que pode ser adicionada ao cartão é o verify_card : true, que informa que haverá uma validação do cartão antes da utilização (Zero Dollar Auth).

metadata
object

Objeto chave/valor utilizado para armazenar informações adicionais sobre o cartão. Saiba mais sobre metadata

token
string

Pode ser enviado no lugar dos dados do cartão, caso este já tenha sido tokenizado previamente. Saiba mais sobre criação de token de cartão.


CARTÃO JÁ CADASTRADO

Caso um cliente tente cadastrar um mesmo cartão mais de uma vez*, será retornado o mesmo card_id do cartão previamente cadastrado.

BRAND É OBRIGATÓRIO PARA PRIVATE LABEL

Caso o cartão seja private label (ou seja private_label = true), brand será um campo obrigatório.

{
    "number": "4000000000000010",
    "holder_name": "Tony Stark",
    "holder_document": "93095135270",
    "exp_month": 1,
    "exp_year": 30,
    "cvv": "351",
    "brand": "Mastercard",
    "private_label": false,
    "billing_address": {
        "line_1": "375, Av. General Osorio, Centro",
        "line_2": "7º Andar",
        "zip_code": "220000111",
        "city": "Rio de Janeiro",
        "state": "RJ",
        "country": "BR"
    },
    "options": {
        "verify_card": true
    }
}
using MundiAPI.PCL;
using MundiAPI.PCL.Models;
using System.Collections.Generic;
using System.Web.Mvc;

namespace MundipaggTest.Controllers {

public class HomeController : Controller {

public ActionResult Index() {

    // Secret key fornecida pela Mundipagg
    string basicAuthUserName = "sk_test_4tdVXpseumRmqbo";

    // Senha em branco. Passando apenas a secret key
    string basicAuthPassword = "";

    var client = new MundiAPIClient(basicAuthUserName, basicAuthPassword);

    string customerId = "cus_6l5dMWZ0hkHZ4XnE";
    var metadata = new Dictionary<string, string>();
    metadata.Add("company", "Avengers");

    var billingAddress = new CreateAddressRequest {
        Line1 = "375, Av. General Justo, Centro",
        Line2 = "7º andar",
        ZipCode = "22000111",
        City = "Rio de Janeiro",
        State = "RJ",
        Country = "BR"
    };

    var request = new CreateCardRequest {
        Number = "5425019448107793",
        HolderName = "Tony Stark",
        ExpMonth = 1,
        ExpYear = 30,
        Cvv = "351",
        Brand = "Mastercard",
        PrivateLabel = false,
        BillingAddress = billingAddress,
        Metadata = metadata,
    };

    var response = client.Customers.CreateCard(customerId, request);
    
    return View();
}
}
}
//This example was built using MundiAPI-PHP SDK.
//For more information, please refer to https://github.com/mundipagg/MundiAPI-PHP

$secretKey = 'sk_test_4tdVXpseumRmqbo'; //the secret key will be provided by MundiPagg.
$basicAuthPassword = ''; //fill it with an empty string

$apiClient = new \MundiAPILib\MundiAPIClient(
    $secretKey,
    $basicAuthPassword
);

$customerController = $apiClient->getCustomers();

$customer = new \MundiAPILib\Models\CreateCustomerRequest();
$customer->name = "sdk customer test";
$customer->email = "[email protected]";

$request = new \MundiAPILib\Models\CreateCardRequest();

$request->number = "4000000000000010";
$request->holderName = "Tony Stark";
$request->holderDocument = "93095135270";
$request->expMonth = 1;
$request->expYear = 30;
$request->cvv = "351";
// Brand is Optional field and autodetected;
$request->brand = "Mastercard";
$request->privateLabel = false;
// Billing Address;
$request->billingAddress = new \MundiAPILib\Models\CreateAddressRequest();
$request->billingAddress->line1 = "375, Av. General Osorio, Centro";
$request->billingAddress->line2 = "7º Andar";
$request->billingAddress->zipCode = "220000111";
$request->billingAddress->city = "Rio de Janeiro";
$request->billingAddress->state = "RJ";
$request->billingAddress->country = "BR";
// Card Options: Verify OneDollarAuth;
$request->options = new \MundiAPILib\Models\CreateCardOptionsRequest();
$request->options->verifyCard = true;

$createdCustomer = $customerController->createCustomer($customer);
$result = $customerController->createCard($createdCustomer->id, $request);

echo json_encode($result, JSON_PRETTY_PRINT);
from mundiapi.mundiapi_client import MundiapiClient
from mundiapi.models import *
from mundiapi.controllers import *
from mundiapi.exceptions.error_exception import *

MundiapiClient.config.basic_auth_user_name = "YOUR_SECRET_KEY:"
customers_controller = customers_controller.CustomersController()

customer = create_customer_request.CreateCustomerRequest()
customer.name = "sdk customer test"
customer.email = "[email protected]"

request = create_card_request.CreateCardRequest()

request.number = "4000000000000010"
request.holder_name = "Tony Stark"
request.holder_document = "93095135270"
request.exp_month = 1
request.exp_year = 30
request.cvv = "351"
request.brand = "Mastercard"
request.private_label = False
# Billing Address
request.billing_address = create_address_request.CreateAddressRequest()
request.billing_address.line_1 = "375 Av. General Osorio Centro"
request.billing_address.line_2 = "7º Andar"
request.billing_address.zip_code = "220000111"
request.billing_address.city = "Rio de Janeiro"
request.billing_address.state = "RJ"
request.billing_address.country = "BR"
# Card Options
request.options = create_card_options_request.CreateCardOptionsRequest()
request.options.verify_card = True

try:
    createdCustomer = customers_controller.create_customer(customer)
    result = customers_controller.create_card(createdCustomer.id, request)
    assert createdCustomer is not None
    assert result is not None
    print("Customer id: ", createdCustomer.id)
    print("Card id: ", result.id)

except ErrorException as ex:
    print(ex.message)
    print("Errors: ", ex.errors)
except Exception as ex:
    raise ex
A binary file was returned

You couldn't be authenticated

{
    "id": "card_8ELY0AwVF9HDa3jK",
    "first_six_digits": "542501",
    "last_four_digits": "7793",
    "brand": "Mastercard",
    "holder_name": "Tony Stark",
    "holder_document": "93095135270",
    "exp_month": 1,
    "exp_year": 2030,
    "status": "active",
    "created_at": "2017-07-07T19:50:33Z",
    "updated_at": "2017-07-07T19:50:33Z",
    "billing_address": {
        "zip_code": "220000111",
        "city": "Rio de Janeiro",
        "state": "RJ",
        "country": "BR",
        "line_1": "375, Av. General Osorio, Centro",
        "line_2": "7º Andar"
    },
    "customer": {
        "id": "cus_yoqONwOJI1IBNbjl",
        "name": "Tony Stark",
        "email": "[email protected]",
        "document": "93095135270",
        "type": "individual",
        "delinquent": false,
        "created_at": "2017-07-07T19:50:23Z",
        "updated_at": "2017-07-07T19:50:23Z",
        "phones": {
            "home_phone": {
                "country_code": "55",
                "number": "000000000",
                "area_code": "21"
            },
            "mobile_phone": {
                "country_code": "55",
                "number": "000000000",
                "area_code": "21"
            }
        },
        "metadata": {
            "company": "Avengers"
        }
    },
    "type": "credit"
}
{
    "message": "Customer not found."
}
{
    "message": "The request is invalid.",
    "errors": {
        "card": [
            "The card expiration date is invalid."
        ]
    },
    "request": {
        "number": "5425019448107793",
        "last_four_digits": "7793",
        "brand": "Mastercard",
        "holder_name": "Tony Stark",
        "exp_month": 1,
        "cvv": "123",
    "billing_address": {
        "zip_code": "220000111",
        "city": "Rio de Janeiro",
        "state": "RJ",
        "country": "BR",
        "line_1": "375, Av. General Osorio, Centro",
        "line_2": "7º Andar"
    },
        "options": {
            "verify_card": true
        }
    }
}
 
Suggest Edits

Obter cartão

Possibilita a recuperação de um card através dos identificadores do cartão (card_id) e do cliente associado (customer_id), informados por parâmetro.

 
gethttps://api.mundipagg.com/core/v1/customers/customer_id/cards/card_id

Path Params

customer_id
string
required

Código do cliente. Formato: cus_XXXXXXXXXXXXXXXX.

card_id
string
required

Código do cartão. Formato: card_XXXXXXXXXXXXXXXX.

 
using MundiAPI.PCL;
using System.Web.Mvc;

namespace MundipaggTest.Controllers {

    public class HomeController : Controller {

    public ActionResult Index() {

    // Secret key fornecida pela Mundipagg
    string basicAuthUserName = "sk_test_4tdVXpseumRmqbo";
    // Senha em branco. Passando apenas a secret key
    string basicAuthPassword = "";

    var client = new MundiAPIClient(basicAuthUserName, basicAuthPassword);

    string customerId = "cus_6l5dMWZ0hkHZ4XnE";
    string cardId = "card_8ELY0AwVF9HDa3jK";

    var response = client.Customers.GetCard(customerId, cardId);

    return View();
    }
}
}
A binary file was returned

You couldn't be authenticated

{
    "id": "card_8ELY0AwVF9HDa3jK",
    "first_six_digits": "542501",
    "last_four_digits": "7793",
    "brand": "Mastercard",
    "holder_name": "Tony Stark",
    "exp_month": 1,
    "exp_year": 2030,
    "status": "active",
    "created_at": "2017-07-07T19:50:33Z",
    "updated_at": "2017-07-07T19:50:33Z",
    "billing_address": {
        "line_1": "10880, Malibu Point, Malibu Central",
        "zip_code": "90265",
        "city": "Malibu",
        "state": "CA",
        "country": "US",
    },
    "customer": {
        "id": "cus_yoqONwOJI1IBNbjl",
        "name": "Tony Stark",
        "email": "[email protected]",
        "document": "93095135270",
        "type": "individual",
        "delinquent": false,
        "created_at": "2017-07-07T19:50:23Z",
        "updated_at": "2017-07-07T19:50:23Z",
        "phones": {
            "home_phone": {
                "country_code": "55",
                "number": "000000000",
                "area_code": "21"
            },
            "mobile_phone": {
                "country_code": "55",
                "number": "000000000",
                "area_code": "21"
            }
        },
        "metadata": {
            "company": "Avengers"
        }
    },
    "type": "credit"
}
{
    "message": "Card not found."
}
 
Suggest Edits

Editar cartão

Com o verbo HTTP PUT, através do identificador do cartão (card_id) e do identificador do cliente ao qual o mesmo está associado (customer_id) é possível alterar dados do cartão informado.

 
puthttps://api.mundipagg.com/core/v1/customers/customer_id/cards/credit_card_id

Path Params

customer_id
string
required

Código do Cliente. Formato: cus_XXXXXXXXXXXXXXXX.

card_id
string
required

Código do Cartão. Formato: card_XXXXXXXXXXXXXXXX.

Body Params

holder_name
string

Nome do portador como está impresso no cartão. Máximo de 64 caracteres.

holder_document
string

CPF ou CNPJ do portador do cartão. Máximo de 16 caracteres.

exp_month
int32
required

Mês de vencimento do cartão.

exp_year
int32
required

Ano de vencimento do cartão.

billing_address_id
string

Código do endereço de cobrança. Máximo de 36 caracteres

billing_address
object

Dados do endereço de cobrança.

metadata
object

Objeto chave/valor utilizado para armazenar informações adicionais sobre o cartão. Saiba mais sobre metadata.


{
    "holder_name": "Peter Parker",
    "exp_month": 12,
    "exp_year": 2030,
    "billing_address": {
        "line_1": "375, Av. General Osorio, Centro",
        "line_2": "7º Andar",
        "zip_code": "220000111",
        "city": "Rio de Janeiro",
        "state": "RJ",
        "country": "BR"
    }
}
using MundiAPI.PCL;
using MundiAPI.PCL.Models;
using System.Web.Mvc;

namespace MundipaggTest.Controllers {

    public class HomeController : Controller {

    public ActionResult Index() {

    // Secret key fornecida pela Mundipagg
    string basicAuthUserName = "sk_test_4tdVXpseumRmqbo";
    // Senha em branco. Passando apenas a secret key
    string basicAuthPassword = "";

    var client = new MundiAPIClient(basicAuthUserName, basicAuthPassword);

    string customerId = "cus_6l5dMWZ0hkHZ4XnE";
    string cardId = "card_onv508NKF3uy98lx";

    var billingAddress = new CreateAddressRequest {
        Line1 = "375, Av. General Osorio, Centro",
        Line2 = "7º Andar"
        ZipCode = "220000111",
        City = "Rio de Janeiro",
        State = "RJ",
        Country = "BR"
    };

    var request = new UpdateCardRequest {
        HolderName = "Peter Parker",
        ExpMonth = 12,
        ExpYear = 30,
        BillingAddress = billingAddress
    };

    var response = client.Customers.UpdateCard(customerId,cardId, request);

    return View();
    }
}
A binary file was returned

You couldn't be authenticated

{
    "id": "card_oXpOkr1Sy3UQm7P9",
    "first_six_digits": "542501",
    "last_four_digits": "7793",
    "brand": "Mastercard",
    "holder_name": "Peter Parker",
    "exp_month": 12,
    "exp_year": 2030,
    "status": "active",
    "created_at": "2018-04-03T20:54:58Z",
    "updated_at": "2018-04-04T12:25:32Z",
    "billing_address": {
        "zip_code": "220000111",
        "city": "Rio de Janeiro",
        "state": "RJ",
        "country": "BR",
        "line_1": "375, Av. General Osorio, Centro",
        "line_2": "7º Andar"
    },
    "customer": {
        "id": "cus_lNXOjXVSLZC4rQom",
        "name": "Tony Stark",
        "email": "[email protected]",
        "document": "93095135270",
        "type": "individual",
        "delinquent": false,
        "created_at": "2018-04-03T20:11:48Z",
        "updated_at": "2018-04-03T20:11:48Z",
        "phones": {
            "home_phone": {
                "country_code": "55",
                "number": "000000000",
                "area_code": "21"
            },
            "mobile_phone": {
                "country_code": "55",
                "number": "000000000",
                "area_code": "21"
            }
        },
        "metadata": {
            "company": "Avengers"
        }
    },
    "type": "credit"
}
{
    "message": "Card not found."
}
{
    "message": "The request is invalid.",
    "errors": {
        "card.exp_date": [
            "The card expiration date is invalid."
        ]
    },
    "request": {
        "holder_name": "Peter Parker",
        "exp_month": 12,
        "billing_address": {
            "zip_code": "220000111",
            "city": "Rio de Janeiro",
            "state": "RJ",
            "country": "BR",
            "line_1": "375, Av. General Osorio, Centro",
            "line_2": "7º Andar",
            "globalType": true
        }
    }
}
 
Suggest Edits

Excluir cartão

Com o verbo HTTP DELETE, através do identificador do cartão (card_id) e do identificador do cliente (customer_id) ao qual o cartão está associado, é possível remover o cartão da Wallet do cliente.

 
deletehttps://api.mundipagg.com/core/v1/customers/customer_id/cards/card_id

Path Params

customer_id
string
required

Código do cliente. Formato: cus_XXXXXXXXXXXXXXXX.

card_id
string
required

Código do cartão. Formato: card_XXXXXXXXXXXXXXXX.

 
using MundiAPI.PCL;
using System.Web.Mvc;

namespace MundipaggTest.Controllers {

    public class HomeController : Controller {

    public ActionResult Index() {

    // Secret key fornecida pela Mundipagg
    string basicAuthUserName = "sk_test_4tdVXpseumRmqbo";
    // Senha em branco. Passando apenas a secret key
    string basicAuthPassword = "";

    var client = new MundiAPIClient(basicAuthUserName, basicAuthPassword);

    string customerId = "cus_9El4qnTEKFKQoV7r";
    string cardId = "card_OBojZD1IvGcPq8gl";

    var response = client.Customers.DeleteCard(customerId,cardId);

    return View();
    }
}
}
A binary file was returned

You couldn't be authenticated

{
    "id": "card_OBojZD1IvGcPq8gl",
    "first_six_digits": "542501",
    "last_four_digits": "7793",
    "brand": "Mastercard",
    "holder_name": "Tony Stark",
    "exp_month": 1,
    "exp_year": 2022,
    "status": "deleted",
    "created_at": "2018-04-04T12:43:16Z",
    "updated_at": "2018-04-04T12:43:30Z",
    "deleted_at": "2018-04-04T12:43:30Z",
    "billing_address": {
        "zip_code": "90265",
        "city": "Malibu",
        "state": "CA",
        "country": "US",
        "line_1": "10880, Malibu Point, Malibu Central"
    },
    "customer": {
        "id": "cus_9El4qnTEKFKQoV7r",
        "name": "Tony Stark",
        "email": "[email protected]",
        "document": "93095135270",
        "type": "individual",
        "delinquent": false,
        "created_at": "2018-04-04T12:05:08Z",
        "updated_at": "2018-04-04T12:05:08Z",
        "phones": {
            "home_phone": {
                "country_code": "55",
                "number": "000000000",
                "area_code": "21"
            },
            "mobile_phone": {
                "country_code": "55",
                "number": "000000000",
                "area_code": "21"
            }
        },
        "metadata": {
            "company": "Avengers"
        }
    },
    "type": "credit"
}
{
    "message": "Card not found."
}
 
Suggest Edits

Renovar cartão

Com o verbo HTTP POST, através do identificador do cartão (card_id) e do identificador do cliente (customer_id) ao qual o cartão está associado, é possível renovar o cartão da Wallet do cliente, utilizando a funcionalidade manual do Card Updater.

 
posthttps://api.mundipagg.com/core/v1/customers/customer_id/cards/card_id/renew

Path Params

customer_id
string
required

Código do cliente. Formato: cus_XXXXXXXXXXXXXXXX.

card_id
string
required

Código do cartão. Formato: card_XXXXXXXXXXXXXXXX.

 
using MundiAPI.PCL;
using System.Web.Mvc;

namespace MundipaggTest.Controllers {

    public class HomeController : Controller {

    public ActionResult Index() {

    // Secret key fornecida pela Mundipagg
    string basicAuthUserName = "sk_test_4tdVXpseumRmqbo";
    // Senha em branco. Passando apenas a secret key
    string basicAuthPassword = "";

    var client = new MundiAPIClient(basicAuthUserName, basicAuthPassword);

    string customerId = "cus_9El4qnTEKFKQoV7r";
    string cardId = "card_OBojZD1IvGcPq8gl";

    var response = client.Customers.RenewCard(customerId,cardId);

    return View();
    }
}
}
A binary file was returned

You couldn't be authenticated

{
  "id": "card_MgwPAXnU7rHW5mNj",
  "first_six_digits": "519645",
  "last_four_digits": "5475",
  "brand": "Mastercard",
  "holder_name": "Tony Stark",
  "exp_month": 3,
  "exp_year": 2020,
  "status": "active",
  "type": "credit",
  "is_renewed": true,
  "created_at": "2018-06-22T22:49:48Z",
  "updated_at": "2018-06-22T22:49:48Z",
  "billing_address": {
    "zip_code": "90265",
    "city": "Malibu",
    "state": "CA",
    "country": "US",
    "line_1": "10880, Malibu Point, Malibu Central"
  },
  "customer": {
    "id": "cus_BzRmLzQHEyurPkKo",
    "name": "Tony Stark",
    "email": "[email protected]",
    "document": "93095135270",
    "type": "individual",
    "delinquent": false,
    "created_at": "2018-06-22T21:36:49Z",
    "updated_at": "2018-06-22T21:36:49Z",
    "phones": {
      "home_phone": {
        "country_code": "55",
        "number": "000000000",
        "area_code": "21"
      },
      "mobile_phone": {
        "country_code": "55",
        "number": "000000000",
        "area_code": "21"
      }
    },
    "metadata": {
      "company": "Avengers"
    }
  }
}
{
    "message": "Could not renew card."
}
 
Suggest Edits

Listar cartões

Este recurso permite a recuperação da Wallet contendo todos os cartões do cliente através do seu identificador (customer_id).

 
gethttps://api.mundipagg.com/core/v1/customers/customer_id/cards

Path Params

customer_id
string
required

Código do cliente. Formato: cus_XXXXXXXXXXXXXXXX.


Paginação

Este recurso utiliza paginação para manipulação da listagem resultante. Saiba mais sobre paginação.

using MundiAPI.PCL;
using System.Web.Mvc;

namespace MundipaggTest.Controllers {

    public class HomeController : Controller {

    public ActionResult Index() {

    // Secret key fornecida pela Mundipagg
    string basicAuthUserName = "sk_test_4tdVXpseumRmqbo";
    // Senha em branco. Passando apenas a secret key
    string basicAuthPassword = "";

    var client = new MundiAPIClient(basicAuthUserName, basicAuthPassword);

    string customerId = "cus_6l5dMWZ0hkHZ4XnE";

    var response = client.Customers.GetCards(customerId);

    return View();
    }
}
}
//This example was built using MundiAPI-PHP SDK.
//For more information, please refer to https://github.com/mundipagg/MundiAPI-PHP

$secretKey = 'sk_test_4tdVXpseumRmqbo'; //the secret key will be provided by MundiPagg.
$basicAuthPassword = ''; //fill it with an empty string

$apiClient = new \MundiAPILib\MundiAPIClient(
    $secretKey,
    $basicAuthPassword
);

$customerController = $apiClient->getCustomers();

$customerId = "cus_6l5dMWZ0hkHZ4XnE";

$result = $customerController->getCards($customerId, 1, 30);

echo json_encode($result, JSON_PRETTY_PRINT);
from mundiapi.mundiapi_client import MundiapiClient
from mundiapi.controllers import *
from mundiapi.exceptions.error_exception import *

MundiapiClient.config.basic_auth_user_name = "YOUR_SECRET_KEY:"
customers_controller = customers_controller.CustomersController()

customerId = "cus_G6gwy4xtJIOyNbrK"

try:
    result = customers_controller.get_cards(customerId, 1, 30)
    assert result is not None
    assert result.data is not None

    if(result.data and result.data[0]):
        print("Card[0] id: ", result.data[0].id)
        print("Cards quantity in my wallet: ", result.paging.total)
    else:
        print("My wallet is empty")


except ErrorException as ex:
    print(ex.message)
    print("Errors: ", ex.errors)
except Exception as ex:
    raise ex
A binary file was returned

You couldn't be authenticated

{
  "data": [
    {
      "id": "card_onv508NKF3uy98lx",
      "first_six_digits": "542501",
      "last_four_digits": "8229",
      "brand": "Amex",
      "holder_name": "Tony Stark",
      "exp_month": 1,
      "exp_year": 2030,
      "status": "active",
      "created_at": "2017-03-28T22:09:43Z",
      "updated_at": "2017-03-28T22:09:43Z",
      "billing_address": {
        "line_1": "10880, Malibu Point, Malibu Central",
        "zip_code": "90265",
        "city": "Malibu",
        "state": "CA",
        "country": "US",
      }
    }, 
    {
      "id": "card_k8HDT5sof8CS53KS",
      "first_six_digits": "411193",
      "last_four_digits": "6203",
      "brand": "Visa",
      "holder_name": "Tony Stark",
      "exp_month": 1,
      "exp_year": 2030,
      "status": "active",
      "created_at": "2017-03-29T22:09:43Z",
      "updated_at": "2017-03-29T22:09:43Z",
      "billing_address": {
        "line_1": "10880, Malibu Point, Malibu Central",
        "zip_code": "90265",
        "city": "Malibu",
        "state": "CA",
        "country": "US",
      }
    }
  ],
  "paging": {
    "total": 2
  }
}
{
    "message": "Customer not found."
}
 
Suggest Edits

Criar Token Cartao

 
posthttps://api.mundipagg.com/core/v1/tokens?appId=public_key

Query Params

appId
string
required

Chave publica da conta.

Body Params

type
string
required

Tipo do cartao

card
object

Informações do cartão. Saiba mais sobre cartão

 
{
  "type": "card",
  "card": {
    "number": "4000000000000010",
    "holder_name": "Tony Stark",
    "exp_month": 1,
    "exp_year": 30,
    "cvv": "651"    
  }
}
using System.Diagnostics;
using Microsoft.AspNetCore.Mvc;
using Example.Models;
using MundiAPI.PCL;
using MundiAPI.PCL.Models;

namespace Example.Controllers
{
    public class HomeController : Controller
    {
        [HttpPost, ValidateAntiForgeryToken]
        public IActionResult Index(FormModel model){
          
          string basicAuthUserName = "sk_test_4tdVXpseumRmqbo";
          string basicAuthPassword = "";
          
          var client = new MundiAPIClient(basicAuthUserName, basicAuthPassword);
          
          var tokenrequest = new CreateTokenRequest
          {
              Card = new CreateCardTokenRequest
              {
                 Number = $"{model.CardNumber}",
                 HolderName = $"{model.HolderName}",
                 ExpMonth = {model.ExpMonth},
                 ExpYear = {model.ExpYear},
                 Cvv = $"{model.Cvv}"
              }
          };
          
          var request = client.Tokens.CreateToken("Public Key", tokenrequest);
          
          return View();
        }
    ...
    }
 ...
}
A binary file was returned

You couldn't be authenticated

{
    "id": "token_zVw7rqvHEPH8XlbE",
    "type": "card",
    "created_at": "2018-06-18T18:48:58Z",
    "expires_at": "2018-06-18T18:49:58Z",
    "card": {
        "last_four_digits": "5580",
        "holder_name": "Tony Stark",
        "exp_month": 1,
        "exp_year": 30,
        "brand": "Visa"
    }
}
 
Suggest Edits

Endereços

O objeto address representam endereços associados aos customers. Um address possui os seguintes atributos:

 
Atributo
Tipo
Descrição

id

string

Código do endereço. Formato: addr_XXXXXXXXXXXXXXXX

line_1

string

Dados principais do endereço. Neste campo deve ser informado Número, Rua, Bairro, nesta ordem e separados por vírgula.

line_2

string

Dados complementares do endereço. Neste campo pode ser informado complemento, referências.

zip_code

integer

Código Postal (CEP).

city

string

Cidade.

state

string

Estado.

country

string

País.

status

enum

Status do endereço. Valores possíveis: active ou deleted

created_at

datetime

Data de criação do endereço.

updated_at

datetime

Data de atualização do endereço.

deleted_at

datetime

Data de exclusão do endereço.

customer

object

Dados do cliente. Saiba mais sobre clientes.

metadata

object

Informações adicionais sobre o endereço. Saiba mais sobre metadata.

FORMATAÇÃO DO ENDEREÇO

O atributo line_1 deverá seguir o formato: Número, Rua, Bairro - nesta ordem e separados por vírgula, em virtude do antifraude ou boleto com registro.

O atributo line_2 poderá conter informações complementares do endereço, tais como andar, apto, sala, etc.

"line_1" : "375, Av. General Justo, Centro",
"line_2" : "7º andar, sala 01"

Atributos Descontinuados

O objeto address possui ainda os atributos: street, number, complement e neighborhood porém os mesmo serão descontinuados em breve, portanto, não é recomendado o uso destes campos.

 
Suggest Edits

Criar endereço

Para a criação de um address é necessário informar o customer_id do cliente ao qual será associado o endereço.

 
posthttps://api.mundipagg.com/core/v1/customers/customer_id/addresses

Path Params

customer_id
string
required

Código do cliente. Formato: cus_XXXXXXXXXXXXXXXX

Body Params

line_1
string
required

Linha 1 do endereço. (Número, Rua, e Bairro - Nesta ordem e separados por vírgula) Max: 256 caracteres.

line_2
string

Linha 2 do endereço. (Complemento - Andar, Sala, Apto). Max: 128 caracteres.

zip_code
string
required

CEP. Max: 16 caracteres.

city
string
required

Cidade. Max: 64 caracteres.

state
string
required

Código do estado no formato ISO 3166-2. Saiba mais sobre ISO 3166-2

country
string
required

Código do país no formato ISO 3166-1 alpha-2. Saiba mais sobre ISO 3166-1 alpha-2

metadata
object

Objeto chave/valor utilizado para armazenar informações adicionais sobre o endereço. Saiba mais sobre metadata

 
{
  "line_1": "375, Av. General Justo, Centro",
  "line_2": "8º andar",
  "zip_code": "20021130",
  "city": "Rio de Janeiro",
  "state": "RJ",
  "country": "BR",
  "metadata": {
    "id": "my_address_id"
  }
}
using MundiAPI.PCL;
using MundiAPI.PCL.Models;
using System.Collections.Generic;
using System.Web.Mvc;

namespace MundipaggTest.Controllers {

    public class HomeController : Controller {

    public ActionResult Index() {

    // Secret key fornecida pela Mundipagg
    string basicAuthUserName = "sk_test_4tdVXpseumRmqbo";
    // Senha em branco. Passando apenas a secret key
    string basicAuthPassword = "";

    var client = new MundiAPIClient(basicAuthUserName, basicAuthPassword);

    string customerId = "cus_6l5dMWZ0hkHZ4XnE";

    var metadata = new Dictionary<string, string>();
    metadata.Add("id", "my_address_id");

    var request = new CreateAddressRequest {
        City = "Rio de Janeiro",
        Country = "BR",
        ZipCode = "20021130",
        State = "RJ",
        Line1 = "375, Av. General Justo, Centro",
        Line2 = "8º andar",
        Metadata = metadata
    };

    var response = client.Customers.CreateAddress(customerId,request);

    return View();
    }
}
}
//This example was built using MundiAPI-PHP SDK.
//For more information, please refer to https://github.com/mundipagg/MundiAPI-PHP

$secretKey = 'sk_test_4tdVXpseumRmqbo'; //the secret key will be provided by MundiPagg.
$basicAuthPassword = ''; //fill it with an empty string

$apiClient = new \MundiAPILib\MundiAPIClient(
    $secretKey,
    $basicAuthPassword
);

$customerController = $apiClient->getCustomers();

$customerId = "cus_6l5dMWZ0hkHZ4XnE";

$request = new \MundiAPILib\Models\CreateAddressRequest();

$request = new \MundiAPILib\Models\CreateAddressRequest();
$request->line1 = "375, Av. General Justo, Centro";
$request->line2 = "8º andar";
$request->zipCode = "20021130";
$request->city = "Rio de Janeiro";
$request->state = "RJ";
$request->country = "BR";
$request->metadata = new \MundiAPILib\Models\UpdateMetadataRequest();
$request->metadata->id = "my_address_id";

$result = $customerController->createAddress($customerId, $request);

echo json_encode($result, JSON_PRETTY_PRINT);
from mundiapi.mundiapi_client import MundiapiClient
from mundiapi.models import *
from mundiapi.controllers import *
from mundiapi.exceptions.error_exception import *

MundiapiClient.config.basic_auth_user_name = "YOUR_SECRET_KEY:"
customers_controller = customers_controller.CustomersController()

customerId = "cus_PzRyp10FeNca2rVB"

request = create_address_request.CreateAddressRequest()

request.line_1 = "375, Av. General Justo, Centro"
request.line_2  = "8º andar"
request.zip_code = "20021130"
request.city = "Rio de Janeiro"
request.state = "RJ"
request.country = "BR"
request.metadata = update_metadata_request.UpdateMetadataRequest()
request.metadata.id = "my_address_id"

try:
    result = customers_controller.create_address(customerId, request)
    assert result is not None
    print("Address id: ", result.id)

except ErrorException as ex:
    print(ex.message)
    print("Errors: ", ex.errors)
except Exception as ex:
    raise ex
A binary file was returned

You couldn't be authenticated

{
  "id": "addr_Pn5x69LCWhrANX2o",
  "line_1": "375, Av. General Justo, Centro",
  "line_2": "8º andar",
  "zip_code": "20021130",
  "city": "Rio de Janeiro",
  "state": "RJ",
  "country": "BR",
  "status": "active",
  "created_at": "2017-04-19T17:49:36Z",
  "updated_at": "2017-04-19T17:49:36Z",
  "customer": {
    "id": "cus_aEkwKv0SmNHMR931",
    "name": "Luke Skywalker",
    "email": "[email protected]",
    "document": "26224451990",
    "type": "individual",
    "delinquent": false,
    "created_at": "2017-04-04T19:41:31Z",
    "updated_at": "2017-04-19T17:44:47Z",
    "metadata": {
      "id": "my_customer_id"
    }
  },
  "metadata": {
    "id": "my_address_id"
  }
}
{
    "message": "Customer not found."
}
{
    "message": "The request is invalid.",
    "errors": {
        "address.line_1": [
            "The line_1 field is required."
        ]
    },
    "request": {
        "zip_code": "90265",
        "city": "Teresópolis",
        "state": "RJ",
        "country": "BR",
        "line_2": "sala 23",
        "globalType": true
    }
}
 
Suggest Edits

Obter endereço

Através dos identificadores do cliente (customer_id) e do endereço (address_id) é possível obter o endereço do cliente.

 
gethttps://api.mundipagg.com/core/v1/customers/customer_id/addresses/address_id

Path Params

customer_id
string
required

Código do cliente. Formato: cus_XXXXXXXXXXXXXXXX.

address_id
string
required

Código do endereço. Formato: addr_XXXXXXXXXXXXXXXX.

 
using MundiAPI.PCL;
using System.Collections.Generic;
using System.Web.Mvc;

namespace MundipaggTest.Controllers {

    public class HomeController : Controller {

    public ActionResult Index() {

    // Secret key fornecida pela Mundipagg
    string basicAuthUserName = "sk_test_4tdVXpseumRmqbo";
    // Senha em branco. Passando apenas a secret key
    string basicAuthPassword = "";

    var client = new MundiAPIClient(basicAuthUserName, basicAuthPassword);

    string customerId = "cus_6l5dMWZ0hkHZ4XnE";
    string addressId = "addr_Pn5x69LCWhrANX2o";

    var response = client.Customers.GetAddress(customerId, addressId);

    return View();
    }
}
}
A binary file was returned

You couldn't be authenticated

{
  "id": "addr_Pn5x69LCWhrANX2o",
  "line_1": "375, Av. General Justo, Centro",
  "line_2": "10º andar",
  "zip_code": "20021130",
  "city": "Rio de Janeiro",
  "state": "RJ",
  "country": "BR",
  "status": "deleted",
  "created_at": "2017-04-19T17:49:36Z",
  "updated_at": "2017-04-19T17:50:18Z",
  "deleted_at": "2017-04-19T17:50:34Z",
  "customer": {
    "id": "cus_aEkwKv0SmNHMR931",
    "name": "Luke Skywalker",
    "email": "[email protected]",
    "document": "26224451990",
    "type": "individual",
    "delinquent": false,
    "created_at": "2017-04-04T19:41:31Z",
    "updated_at": "2017-04-19T17:44:47Z",
    "metadata": {
      "id": "my_customer_id"
    }
  },
  "metadata": {
    "id": "work"
  }
}
{
    "message": "Address not found."
}
 
Suggest Edits

Editar endereço

Com o verbo HTTP PUT, através dos identificadores do cliente (customer_id) e do endereço (address_id) é possível atualizar informações complementares do endereço.

 
puthttps://api.mundipagg.com/core/v1/customers/customer_id/addresses/address_id

Path Params

customer_id
string
required

Código do cliente. Formato: cus_XXXXXXXXXXXXXXXX.

address_id
string
required

Código do endereço. Formato: addr_XXXXXXXXXXXXXXXX.

Body Params

line_2
string

Linha 2 do endereço. (Complemento - Andar, Sala, Apto). Max: 128 caracteres.

metadata
object

Objeto chave/valor utilizado para armazenar informações adicionais sobre o endereço. Saiba mais sobre metadata

 
{
  "line_2": "10º andar",
  "metadata": {
    "id": "work"
  }
}
using MundiAPI.PCL;
using System.Collections.Generic;
using System.Web.Mvc;
using MundiAPI.PCL.Models;

namespace MundipaggTest.Controllers {

    public class HomeController : Controller {

    public ActionResult Index() {

    // Secret key fornecida pela Mundipagg
    string basicAuthUserName = "sk_test_4tdVXpseumRmqbo";
    // Senha em branco. Passando apenas a secret key
    string basicAuthPassword = "";

    var client = new MundiAPIClient(basicAuthUserName, basicAuthPassword);

    string customerId = "cus_6l5dMWZ0hkHZ4XnE";

    var metadata = new Dictionary<string, string>();
    metadata.Add("id", "work");

    string addressId = "addr_Pn5x69LCWhrANX2o";
    var request = new UpdateAddressRequest {
        Line2 = "10º andar",
        Metadata = metadata
    };

    var response = client.Customers.UpdateAddress(customerId, addressId, request);

    return View();
    }
}
}
A binary file was returned

You couldn't be authenticated

{
  "id": "addr_Pn5x69LCWhrANX2o",
  "line_1": "375, Av. General Justo, Centro",
  "line_2": "10º andar",
  "zip_code": "20021130",
  "city": "Rio de Janeiro",
  "state": "RJ",
  "country": "BR",
  "status": "active",
  "created_at": "2017-04-19T17:49:36Z",
  "updated_at": "2017-04-19T17:50:18Z",
  "customer": {
    "id": "cus_aEkwKv0SmNHMR931",
    "name": "Luke Skywalker",
    "email": "[email protected]",
    "document": "26224451990",
    "type": "individual",
    "delinquent": false,
    "created_at": "2017-04-04T19:41:31Z",
    "updated_at": "2017-04-19T17:44:47Z",
    "metadata": {
      "id": "my_customer_id"
    }
  },
  "metadata": {
    "id": "work"
  }
}
{
    "message": "Address not found."
}
 
Suggest Edits

Listar endereços

Este recurso permite a recuperação dos endereços de um determinado cliente através do seu identificador(customer_id). Pode ser utilizados alguns parâmetros como filtro da listagem.

 
gethttps://api.mundipagg.com/core/v1/customers/customer_id/addresses

Path Params

customer_id
string
required

Código do cliente. Formato: cus_XXXXXXXXXXXXXXXX.

Query Params

page
int32

Página atual.

size
int32

Quantidade de itens.


Paginação

Este recurso utiliza paginação para manipulação da listagem resultante. Saiba mais sobre paginação.

using MundiAPI.PCL;
using System.Web.Mvc;

namespace MundipaggTest.Controllers {

    public class HomeController : Controller {

    public ActionResult Index() {

    // Secret key fornecida pela Mundipagg
    string basicAuthUserName = "sk_test_4tdVXpseumRmqbo";
    // Senha em branco. Passando apenas a secret key
    string basicAuthPassword = "";

    var client = new MundiAPIClient(basicAuthUserName, basicAuthPassword);

    string customerId = "cus_6l5dMWZ0hkHZ4XnE";

    var response = client.Customers.GetAddresses(customerId);

    return View();
    }
}
}
A binary file was returned

You couldn't be authenticated

{
  "data": [
    {
      "id": "addr_84BkRGZBtWiYJ9ox",
      "line_1": "10882, Malibu Point, Central Malibu",
      "zip_code": "90265",
      "city": "Malibu",
      "state": "CA",
      "country": "US",
      "status": "active",
      "created_at": "2017-04-19T17:49:05Z",
      "updated_at": "2017-04-19T17:49:05Z"
    },
    {
      "id": "addr_yQAlePAumWuBa3qJ",
      "line_1": "375, Av. General Justo, Centro",
      "line_2": "9º andar",
      "zip_code": "20021130",
      "city": "Rio de Janeiro",
      "state": "RJ",
      "country": "BR",
      "status": "active",
      "created_at": "2017-04-04T19:41:31Z",
      "updated_at": "2017-04-04T19:41:31Z"
    }
  ],
  "paging": {
    "total": 2
  }
}
{
    "message": "Customer not found."
}
 
Suggest Edits

Excluir endereço

Com o verbo HTTP DELETE, através do identificador do endereço(address_id) e do identificador do cliente (customer_id) ao qual o endereço está associado, é possível remover o endereço da Wallet do cliente.

 
deletehttps://api.mundipagg.com/core/v1/customers/customer_id/addresses/address_id

Path Params

customer_id
string
required

Código do cliente. Formato: cus_XXXXXXXXXXXXXXXX.

address_id
string
required

Código do endereço. Formato: addr_XXXXXXXXXXXXXXXX.

 
using MundiAPI.PCL;
using System.Web.Mvc;

namespace MundipaggTest.Controllers {

    public class HomeController : Controller {

    public ActionResult Index() {

    // Secret key fornecida pela Mundipagg
    string basicAuthUserName = "sk_test_4tdVXpseumRmqbo";
    // Senha em branco. Passando apenas a secret key
    string basicAuthPassword = "";

    var client = new MundiAPIClient(basicAuthUserName, basicAuthPassword);

    string customerId = "cus_9El4qnTEKFKQoV7r";
    string addressId = "addr_GEjbAjaUK9h1PRLa";

    var response = client.Customers.DeleteAddress(customerId,addressId);

    return View();
    }
}
}
A binary file was returned

You couldn't be authenticated

{
    "id": "addr_GEjbAjaUK9h1PRLa",
    "line_1": "10882, Malibu Point, Central Malibu",
    "street": "Malibu Point",
    "number": "10882",
    "zip_code": "90265",
    "neighborhood": "Central Malibu",
    "city": "Malibu",
    "state": "CA",
    "country": "US",
    "status": "deleted",
    "created_at": "2018-12-14T18:57:18Z",
    "updated_at": "2018-12-14T18:58:36Z",
    "deleted_at": "2018-12-14T18:58:36Z",
    "customer": {
        "id": "cus_lMyKPqXiRhR8w9Dr",
        "name": "Tony Stark",
        "email": "[email protected]",
        "document": "93095135270",
        "type": "individual",
        "delinquent": false,
        "created_at": "2018-12-14T17:55:36Z",
        "updated_at": "2018-12-14T17:55:36Z",
        "phones": {
            "home_phone": {
                "country_code": "55",
                "number": "000000000",
                "area_code": "21"
            },
            "mobile_phone": {
                "country_code": "55",
                "number": "000000000",
                "area_code": "21"
            }
        },
        "metadata": {
            "company": "Avengers"
        }
    }
}
{
    "message": "Card not found."
}
 
Suggest Edits

BIN

Os seis primeiros dígitos de um número de cartão (incluindo o dígito MII inicial) são conhecidos como o número de identificação do emissor (IIN) ou número de identificação do banco (BIN). Estes números identificam a instituição que emitiu o cartão ao titular do cartão. O restante do número é alocado pelo emissor. O objeto bin contém os seguintes atributos:

 
Atributos
Tipo
Descrição

brand

string

Bandeira do Cartão.

gaps

integer

Array de intervalos dos espaçamentos do número do cartão.

lenghts

integer

Array de número de dígitos possíveis para o cartão com o BIN informado.

mask

string

Expressão regular para mascarar o cartão.

cvv

integer

Número de dígitos do código de segurança do cartão.

brandImage

string

Link para imagem da bandeira.

possibleBrands

string

Possíveis bandeiras para o cartão com o BIN informado.

 
Suggest Edits

Obter informações do BIN

 
gethttps://api.mundipagg.com/bin/v1/bin

Path Params

bin
string
required

Bank Identifier Number.

 
curl --request GET --url 'https://api.mundipagg.com/bin/v1/525663'
A binary file was returned

You couldn't be authenticated

{
  "brand": "mastercard",
  "brandName": "Mastercard",
  "gaps": [
    4,
    8,
    12
  ],
  "lenghts": [
    16
  ],
  "mask": "/(\\d{1,4})/g",
  "input": "/(?:^|s)(d{4})$/",
  "cvv": 3
}
 
Suggest Edits

Access Token

O objeto access_token é um token temporário que pode ser utilizado para autenticação nos servidores da Mundipagg. Com ele é possível gerenciar os cartões da Wallet do cliente sem trafegar os dados do cartão em seus servidores. Saiba mais sobre Access Token acessando nossa documentação. Este objeto possui os seguintes atributos:

 
Atributos
Tipo
Descrição

id

string

Código do Access Token. Formato: at_XXXXXXXXXXXXXXXX

code

string

Access Token.

status

enum

Status do Access Token. Valores possíveis: active ou deleted.

created_at

datetime

Data de criação do Access Token.

customer

object

Dados do cliente. Saiba mais sobre clientes

expires_in

integer

Tempo, em minutos, para expiração do token.

deleted_at

datetime

Data de exclusão do Access Token.

Autenticação via ACCESS TOKEN

Para utilizar os métodos de gerenciamento de recursos via access_token devemos alterar a chave Authorization do cabeçalho da requisição, passando a ter como valor Bearer {{access_token}}. Além disso, a appId (public_key) da loja deve ser passada na URL.

 
Suggest Edits

Criar Access Token

Este recurso permite a criação de um access_token associado a um cliente através de seu customer_id.

 
posthttps://api.mundipagg.com/core/v1/customers/customer_id/access-tokens

Path Params

customer_id
string
required

Código do cliente. Formato: cus_XXXXXXXXXXXXXXXX.

Body Params

expires_in
int32

Tempo, em minutos, para a expiração do token.

 
{
  "expires_in": 30
}
using MundiAPI.PCL;
using MundiAPI.PCL.Models;
using System.Web.Mvc;

namespace MundipaggTest.Controllers {

    public class HomeController : Controller {

    public ActionResult Index() 

    // Secret key fornecida pela Mundipagg
    string basicAuthUserName = "sk_test_4tdVXpseumRmqbo";
    // Senha em branco. Passando apenas a secret key
    string basicAuthPassword = "";

    var client = new MundiAPIClient(basicAuthUserName, basicAuthPassword);

    string customerId = "cus_6l5dMWZ0hkHZ4XnE";

    var request = new CreateAccessTokenRequest {
        ExpiresIn = 1
    };

    var response = client.Customers.CreateAccessToken(customerId, request);

    return View();
    }
}
}
A binary file was returned

You couldn't be authenticated

{
  "id": "at_Z6AwO09CKvcZQXln",
  "code": "nZOkKvy3jz89D2RjnRZv2LWVzByqGQl1gDxmN9v8OxegKAJam72YGq0bDVMXQZkhBOfvmwrjklW3Ro4ZnEPN6By5LzQ1bEO9k750a3YKrA8o6JMPe46aBlorYE1eJx4Q",
  "status": "active",
  "created_at": "2017-04-19T22:30:26Z",
  "customer": {
    "id": "cus_6l5dMWZ0hkHZ4XnE",
    "name": "Tony Stark",
    "email": "[email protected]",
    "delinquent": false,
    "created_at": "2017-04-19T22:30:18Z",
    "updated_at": "2017-04-19T22:30:18Z"
  }
}
{
    "message": "Customer not found."
}
 
Suggest Edits

Obter Access Token

Através dos identificadores do access token (access_token_id) e de seu cliente associado (customer_id) é possível obter os dados do token gerado.

 
gethttps://api.mundipagg.com/core/v1/customers/customer_id/access-tokens/access_token_id

Path Params

customer_id
string
required

Código do cliente. Formato: cus_XXXXXXXXXXXXXXXX.

access_token_id
string
required

Código do Access Token. Formato: at_XXXXXXXXXXXXXXXX.

 
using MundiAPI.PCL;
using System.Web.Mvc;

namespace MundipaggTest.Controllers {

    public class HomeController : Controller {

    public ActionResult Index() {

    // Secret key fornecida pela Mundipagg
    string basicAuthUserName = "sk_test_4tdVXpseumRmqbo";
    // Senha em branco. Passando apenas a secret key
    string basicAuthPassword = "";

    var client = new MundiAPIClient(basicAuthUserName, basicAuthPassword);

    string customerId = "cus_6l5dMWZ0hkHZ4XnE";
    string accessTokenId = "at_Z6AwO09CKvcZQXln";

    var response = client.Customers.GetAccessToken(customerId, accessTokenId);

    return View();
    }
}
}
A binary file was returned

You couldn't be authenticated

{
  "id": "at_Z6AwO09CKvcZQXln",
  "code": "nZOkKvy3jz89D2RjnRZv2LWVzByqGQl1gDxmN9v8OxegKAJam72YGq0bDVMXQZkhBOfvmwrjklW3Ro4ZnEPN6By5LzQ1bEO9k750a3YKrA8o6JMPe46aBlorYE1eJx4Q",
  "status": "active",
  "created_at": "2017-04-19T22:30:26Z",
  "customer": {
    "id": "cus_4ZA9GDKu89TRgX1D",
    "name": "Tony Stark",
    "email": "[email protected]",
    "delinquent": false,
    "created_at": "2017-04-19T22:30:18Z",
    "updated_at": "2017-04-19T22:30:18Z"
  }
}
{
    "message": "AccessToken not found."
}
 
Suggest Edits

Excluir Access Token

Com o verbo HTTP DELETE, através dos identificadores do access token (access_token_id) e de seu cliente associado (customer_id) é possível excluir um token anteriormente gerado.

 
deletehttps://api.mundipagg.com/core/v1/customers/customer_id/access-tokens/access_token_id

Path Params

customer_id
string
required

Código do cliente. Formato: cus_XXXXXXXXXXXXXXXX.

access_token_id
string
required

Código do Access Token. Formato: at_XXXXXXXXXXXXXXXX.

 
using MundiAPI.PCL;
using System.Web.Mvc;

namespace MundipaggTest.Controllers {

    public class HomeController : Controller {

    public ActionResult Index() {

    // Secret key fornecida pela Mundipagg
    string basicAuthUserName = "sk_test_4tdVXpseumRmqbo";
    // Senha em branco. Passando apenas a secret key
    string basicAuthPassword = "";

    var client = new MundiAPIClient(basicAuthUserName, basicAuthPassword);

    string customerId = "cus_6l5dMWZ0hkHZ4XnE";
    string accessTokenId = "at_Z6AwO09CKvcZQXln";

    var response = client.Customers.DeleteAccessToken(customerId, accessTokenId);

    return View();
    }
}
}
A binary file was returned

You couldn't be authenticated

{
  "id": "at_Z6AwO09CKvcZQXln",
  "code": "nZOkKvy3jz89D2RjnRZv2LWVzByqGQl1gDxmN9v8OxegKAJam72YGq0bDVMXQZkhBOfvmwrjklW3Ro4ZnEPN6By5LzQ1bEO9k750a3YKrA8o6JMPe46aBlorYE1eJx4Q",
  "status": "deleted",
  "created_at": "2017-04-19T22:30:26Z",
  "deleted_at": "2017-04-19T22:37:51Z",
  "customer": {
    "id": "cus_4ZA9GDKu89TRgX1D",
    "name": "Tony Stark",
    "email": "[email protected]",
    "delinquent": false,
    "created_at": "2017-04-19T22:30:18Z",
    "updated_at": "2017-04-19T22:30:18Z"
  }
}
{
    "message": "AccessToken not found."
}
 
Suggest Edits

Listar Access Tokens

Este recurso permite a recuperação dos access tokens de um determinado cliente através do seu identificador (customer_id).

 
gethttps://api.mundipagg.com/core/v1/customers/customer_id/access-tokens

Path Params

customer_id
string
required

Código do cliente. Formato: cus_XXXXXXXXXXXXXXXX.


Paginação

Este recurso utiliza paginação para manipulação da listagem resultante. Saiba mais sobre paginação.

using MundiAPI.PCL;
using System.Web.Mvc;

namespace MundipaggTest.Controllers {

    public class HomeController : Controller {

    public ActionResult Index() {

    // Secret key fornecida pela Mundipagg
    string basicAuthUserName = "sk_test_4tdVXpseumRmqbo";
    // Senha em branco. Passando apenas a secret key
    string basicAuthPassword = "";

    var client = new MundiAPIClient(basicAuthUserName, basicAuthPassword);

    string customerId = "cus_6l5dMWZ0hkHZ4XnE";

    var response = client.Customers.GetAccessTokens(customerId);

    return View();
    }
}
}
A binary file was returned

You couldn't be authenticated

{
    "data": [
        {
            "id": "at_jqbgvqSpwHEb1eOE",
            "code": "2wJA4K6nyW0MEVzVMxd4Yyzb0LEeAqXN13WpJgA2QvGVd8M5aw6zm3oyqONR6WEtMQTVP0X9ek1W7rEJZbBDpLK4nYxOvQo5a8gZG96Brk2nwD7mK7NvemrbYgxDdkQq",
            "status": "active",
            "created_at": "2018-04-04T15:04:25Z"
        },
        {
            "id": "at_jgL6XmPIjgtzJXWb",
            "code": "5GEAk6Z32laJnWbxBdN6E3zWL8YjeX7pOglV9b3kJRWXelKOraYnGNwDVBA4L9ZfAoSav02dg58oPLQZ7qvm9jx6zp1EmAPbaw5rnqvQoJ2Rk1ZGKDKmQB7vPgYeOxpN",
            "status": "active",
            "created_at": "2018-04-04T13:21:20Z"
        }
    ],
    "paging": {
        "total": 2
    }
}
{
    "message": "Customer not found."
}
 
Suggest Edits

Visão Geral sobre Pagamento

Em nossos pedidos e cobranças, dentro possuímos o nó payment responsável pelas instruções de pagamento podendo comportar os meios de pagamento: credit_card, voucher, boleto, bank_transfer e safetypay. Especificamente para pedidos está disponível também o meio de pagamento checkout.

 

O objeto pagamento tem as seguintes propriedades:

Atributos
Tipo
Descrição

payment_method

string

Meio de pagamento. Valores possíveis: credit_card, boleto, voucher, bank_transfer, safety_pay, checkout ou cash.

credit_card

object

Dados sobre o pagamento com cartão de crédito (obrigatório caso o payment_method seja credit_card). Saiba mais sobre pagamentos com cartão de crédito.

voucher

object

Dados sobre o pagamento com voucher (obrigatório caso o payment_method seja voucher). Saiba mais sobre pagamentos com voucher.

boleto

object

Dados sobre o pagamento com boleto (obrigatório caso o payment_method seja boleto). Saiba mais sobre pagamentos com boleto.

bank_transfer

object

Dados sobre o pagamento com transferência entre contas bancárias. (obrigatório caso o payment_method seja bank_transfer). Saiba mais sobre pagamentos com transferência entre contas.

checkout

object

Dados sobre o pagamento com checkout. (obrigatório caso o payment_method seja checkout). Este método está disponível apenas para pedidos. Saiba mais sobre pagamentos com meio de pagamento checkout.

cash

object

Dados sobre o pagamento com cash (obrigatório caso o payment_method seja cash). Saiba mais sobre pagamentos com cash.

amount

integer

Valor da cobrança em centavos

metadata

object

Objeto chave/valor utilizado para armazenar informações adicionais sobre o pagamento. Saiba mais sobre metadata
OBS: A chave mundipagg_payment_method_code poderá ser utilizada para informar o código da adquirente, com o objetivo de indicar em qual adquirente será processado o pagamento. Saiba mais sobre metadata.

gateway_affiliation_id

string

Código da afiliação no gateway

 
Suggest Edits

Cartão de crédito

Para criar uma cobrança ou um pedido com cartão de crédito, devemos incluir o objeto credit_card dentro do nó payment, assim como a propriedade "payment_method": "credit_card". O objeto credit_card contêm os seguintes atributos:

 
Atributos
Tipo
Descrição

installments

integer

Quantidade de parcelas. Valor padrão: 1.

statement_descriptor

string

Texto exibido na fatura do cartão. Max: 22 caracteres.

operation_type

string

_Indica se a transação deve ser capturada auth_and_capture, autorizada auth_only, ou pré autorizada pre_auth.
Valor padrão: auth_and_capture.

card, card_id ou card_token

object

Cartão de crédito.
card_id é o identificador do cartão de um cliente.
card_token é o token do cartão gerado pelo checkout transparente. Saiba mais sobre cartões.

recurrence

boolean

Indica se é uma cobrança/pedido de recorrência. Valor padrão: false

metadata

object

Objeto chave/valor utilizado para armazenar informações adicionais sobre o pagamento.

extended_limit_enabled

boolean

Indica se o super limite está habilitado (para cartões private label).

extended_limit_code

string

Código do super limite (para cartões private label).

merchant_category_code

integer

Código de classificação do ramo de atuação do lojista.

authentication

object

Objeto que indica se a transação de cartão de crédito é autenticada ou não.

auto_recovery

boolean

Possibilita que a retentativa offline seja desabilitada por requisição.

payload

object

_Objeto de dados criptografados, tais como: GooglePay, ApplePay e SamsungPay

Liberação de Pré-autorização

Para realizar transações de pré-autorização via Mundipagg é necessário entrar em contato com sua adquirente e solicitar a liberação da funcionalidade.

Para os casos em que a transação é autenticada, o objeto authentication é obrigatório. Ele possui os seguintes campos:

type

string

Indica o tipo de autenticação utilizado. Atualmente o único tipo suportado é threed_secure

threed_secure

object

Indica os campos a serem enviados para a autenticação 3DS.

Por fim, o objeto threed_secure contém os seguintes campos:

Atributos
Tipo
Tamanho máximo
Descrição

mpi

string

11

Indica quem é o autenticador da transação. Pode receber os valores "acquirer" para transações autenticadas pela adquirente ou "third_party" para autenticadores externos.

eci

string

2

Indica o resultado da tentativa de autenticação. Obrigatório quando o mpi é "third_party".

cavv

string

256

Código de autenticação do dono do cartão. Obrigatório quando o mpi é "third_party".

transaction_id

string

256

id da transação no autenticador. Obrigatório quando o mpi é "third_party".

ds_transaction_id

string

256

Identificador da transação no Directory Service

version

string

6

Versão do 3DS

redirect_url

string

512

Url de redirecionamento quando a transação é aprovada pelo autenticador. Obrigatório quando o mpié "acquirer".

Autenticação 3DS

Quando a autenticação é feita por um autenticador do tipo acquirer, só é necessário enviar os campos mpi e redirect_url. Os campos mpi, eci, cavv e transaction_id são os necessários para uma transação com autenticação externa.

{
    "items": [
        {
            "amount": 2990,
            "description": "Chaveiro do Tesseract",
            "quantity": 1
        }
    ],
    "customer": {
        "name": "Tony Stark",
        "email": "[email protected]"
    },
    "payments": [
        {
            "payment_method": "credit_card",
            "credit_card": {
                "recurrence": false,
                "installments": 1,
                "statement_descriptor": "AVENGERS",
                "card": {
                    "number": "4000000000000010",
                    "holder_name": "Tony Stark",
                    "exp_month": 1,
                    "exp_year": 30,
                    "cvv": "3531",
                    "billing_address": {
                        "line_1": "10880, Malibu Point, Malibu Central",
                        "zip_code": "90265",
                        "city": "Malibu",
                        "state": "CA",
                        "country": "US"                
                    }
                }
            }
        }
    ]
}
{
    "id": "or_57oxkMntecE1P6JO",
    "code": "PGW5F69IX6",
    "amount": 2990,
    "currency": "BRL",
    "closed": true,
    "items": [
        {
            "id": "oi_DZlmrdXfXQcmr5kO",
            "description": "Chaveiro do Tesseract",
            "amount": 2990,
            "quantity": 1,
            "status": "active",
            "created_at": "2019-01-21T18:37:48Z",
            "updated_at": "2019-01-21T18:37:48Z",
            "order": {
                "id": "or_57oxkMntecE1P6JO",
                "code": "PGW5F69IX6",
                "amount": 2990,
                "closed": true,
                "created_at": "2019-01-21T18:37:48Z",
                "updated_at": "2019-01-21T18:37:48Z",
                "closed_at": "2019-01-21T18:37:48Z",
                "currency": "BRL",
                "status": "paid",
                "customer_id": "cus_n3bqEzdsZUmNA7Qp",
                "items": [
                    {
                        "id": "oi_DZlmrdXfXQcmr5kO",
                        "description": "Chaveiro do Tesseract",
                        "amount": 2990,
                        "quantity": 1,
                        "status": "active"
                    }
                ]
            }
        }
    ],
    "customer": {
        "id": "cus_n3bqEzdsZUmNA7Qp",
        "name": "Tony Stark",
        "email": "[email protected]",
        "delinquent": false,
        "created_at": "2019-01-21T18:36:30Z",
        "updated_at": "2019-01-21T18:36:30Z",
        "phones": {}
    },
    "status": "paid",
    "created_at": "2019-01-21T18:37:48Z",
    "updated_at": "2019-01-21T18:37:48Z",
    "closed_at": "2019-01-21T18:37:48Z",
    "charges": [
        {
            "id": "ch_PNbX8jDIPuL1p5nM",
            "code": "PGW5F69IX6",
            "amount": 2990,
            "paid_amount": 2990,
            "status": "paid",
            "currency": "BRL",
            "payment_method": "credit_card",
            "paid_at": "2019-01-21T18:37:48Z",
            "created_at": "2019-01-21T18:37:48Z",
            "updated_at": "2019-01-21T18:37:48Z",
            "customer": {
                "id": "cus_n3bqEzdsZUmNA7Qp",
                "name": "Tony Stark",
                "email": "[email protected]",
                "delinquent": false,
                "created_at": "2019-01-21T18:36:30Z",
                "updated_at": "2019-01-21T18:36:30Z",
                "phones": {}
            },
            "last_transaction": {
                "id": "tran_G1byLaJUXHm5Eg4R",
                "transaction_type": "credit_card",
                "gateway_id": "82c0acb3-75b0-48b8-a3ac-0e51c4b3744c",
                "amount": 2990,
                "status": "captured",
                "success": true,
                "installments": 1,
                "statement_descriptor": "AVENGERS",
                "acquirer_tid": "a4cf3de1-beb2-4724-822d-ac7ad14fa306",
                "acquirer_nsu": "a4cf3de1-beb2-4724-822d-ac7ad14fa306",
                "acquirer_auth_code": "903",
                "acquirer_message": "Transação capturada com sucesso",
                "acquirer_return_code": "00",
                "operation_type": "auth_and_capture",
                "card": {
                    "id": "card_apxQeXJsV2fGVwPL",
                    "first_six_digits": "400000",
                    "last_four_digits": "0010",
                    "brand": "Visa",
                    "holder_name": "Tony Stark",
                    "exp_month": 1,
                    "exp_year": 2030,
                    "status": "active",
                    "type": "credit",
                    "created_at": "2019-01-21T18:37:48Z",
                    "updated_at": "2019-01-21T18:37:48Z",
                    "billing_address": {
                        "zip_code": "90265",
                        "city": "Malibu",
                        "state": "CA",
                        "country": "US",
                        "line_1": "10880, Malibu Point, Malibu Central"
                    }
                },
                "created_at": "2019-01-21T18:37:48Z",
                "updated_at": "2019-01-21T18:37:48Z",
                "gateway_response": {
                    "code": "200",
                    "errors": []
                }
            }
        }
    ],
    "checkouts": []
}
//This example was built using MundiAPI-PHP SDK.
//For more information, please refer to https://github.com/mundipagg/MundiAPI-PHP

$secretKey = 'sk_test_4tdVXpseumRmqbo'; //the secret key will be provided by MundiPagg.
$basicAuthPassword = ''; //fill it with an empty string

$apiClient = new \MundiAPILib\MundiAPIClient(
    $secretKey,
    $basicAuthPassword
);

$orderController = $apiClient->getOrders();

$customer = new \MundiAPILib\Models\CreateCustomerRequest();
$customer->name = "Tony Stark";

$creditCard = new \MundiAPILib\Models\CreateCreditCardPaymentRequest();
$creditCard->capture = true;
$creditCard->installments = 2;
$creditCard->card = new \MundiAPILib\Models\CreateCardRequest();
$creditCard->card->number = "4000000000000010";
$creditCard->card->holderName = "Tony Stark";
$creditCard->card->expMonth = 1;
$creditCard->card->expYear = 2030;
$creditCard->card->cvv = "123";

$request = new \MundiAPILib\Models\CreateOrderRequest();

$request->items = [new \MundiAPILib\Models\CreateOrderItemRequest()];
$request->items[0]->description = "Tesseract Bracelet";
$request->items[0]->quantity = 1;
$request->items[0]->amount = 2990; // this value should be in cents

$request->payments = [new \MundiAPILib\Models\CreatePaymentRequest()];
$request->payments[0]->paymentMethod = "credit_card";
$request->payments[0]->creditCard = $creditCard;
$request->customer = $customer;

$result = $orderController->createOrder($request);

echo json_encode($result, JSON_PRETTY_PRINT);
package examples.order;

import com.mundipagg.api.MundiAPIClient;
import com.mundipagg.api.controllers.OrdersController;
import com.mundipagg.api.http.client.*;
import com.mundipagg.api.models.*;

import java.util.ArrayList;

public class CreateOrderCreditCard {
	
	public static void main(String[] args) {

        String basicAuthUserName = "sk_test_4tdVXpseumRmqbo"; // The username to use with basic authentication
        String basicAuthPassword = ""; // The password to use with basic authentication

        MundiAPIClient client = new MundiAPIClient(basicAuthUserName, basicAuthPassword);

        OrdersController orders_controller = new OrdersController();

        CreateCustomerRequest customer = new CreateCustomerRequest();
        customer.setName("sdk customer order");
        customer.setEmail("[email protected]ngers.com");

        CreateCreditCardPaymentRequest create_credit_card_payment_request = new CreateCreditCardPaymentRequest();
        create_credit_card_payment_request.setCapture(true);
        create_credit_card_payment_request.setInstallments(2);
        create_credit_card_payment_request.setCard(new CreateCardRequest());
        create_credit_card_payment_request.getCard().setNumber("4000000000000010");
        create_credit_card_payment_request.getCard().setHolderName("Tony Stark");
        create_credit_card_payment_request.getCard().setExpMonth(1);
        create_credit_card_payment_request.getCard().setExpYear(2030);
        create_credit_card_payment_request.getCard().setCvv("123");

        CreateOrderRequest request = new CreateOrderRequest();

        CreateOrderItemRequest orderItem = new CreateOrderItemRequest();
        orderItem.setDescription("Tesseract Bracelet");
        orderItem.setQuantity(3);
        orderItem.setAmount(1490);
        ArrayList<CreateOrderItemRequest> listOrderItem = new ArrayList<CreateOrderItemRequest>();
        listOrderItem.add(orderItem);
        request.setItems(listOrderItem);

        CreatePaymentRequest paymentItem = new CreatePaymentRequest();
        paymentItem.setPaymentMethod("credit_card");
        paymentItem.setCreditCard(create_credit_card_payment_request);
        request.setCustomer(customer);
        ArrayList<CreatePaymentRequest> lisPaymentItem = new ArrayList<CreatePaymentRequest>();
        lisPaymentItem.add(paymentItem);
        request.setPayments(lisPaymentItem);

        orders_controller.createOrderAsync(request, new APICallBack<GetOrderResponse>() {
            public void onSuccess(HttpContext context, GetOrderResponse response) {

                System.out.println("Order credit card create !");
                System.out.println("Status response: " + context.getResponse().getStatusCode());
                System.out.println("Order result status: " + response.getStatus());
                System.out.println("Order id: " + response.getId());

            }

            public void onFailure(HttpContext context, Throwable error) {

                System.out.println("Status response: " + context.getResponse().getStatusCode());
                System.out.println(error.getMessage());
                error.printStackTrace();

            }
        });

    }

}
from mundiapi.mundiapi_client import MundiapiClient
from mundiapi.models import *
from mundiapi.controllers import *
from mundiapi.exceptions.error_exception import *

MundiapiClient.config.basic_auth_user_name = "SUA_SECRET_KEY:"
orders_controller = orders_controller.OrdersController()

customer = create_customer_request.CreateCustomerRequest()
customer.name = "sdk customer test"
customer.email = "[email protected]"

credit_card = create_credit_card_payment_request.CreateCreditCardPaymentRequest()
credit_card.capture = True
credit_card.installments = 2
credit_card.statement_descriptor = "test descriptor"
credit_card.card = create_card_request.CreateCardRequest()
credit_card.card.number = "4000000000000010"
credit_card.card.holder_name = "Tony Stark"
credit_card.card.exp_month = 1
credit_card.card.exp_year = 2030
credit_card.card.cvv = "123"

request = create_order_request.CreateOrderRequest()

request.items = [create_order_item_request.CreateOrderItemRequest()]
request.items[0].description = "Tesseract Bracelet"
request.items[0].quantity = 3
request.items[0].amount = 1490

request.payments = [create_payment_request.CreatePaymentRequest()]
request.payments[0].payment_method = "credit_card"
request.payments[0].credit_card = credit_card
request.customer = customer

try:
    result = orders_controller.create_order(request)
    assert result.status == "paid"
	print("Order id is: ", result.id)
    print("Order result status: ", result.status)
except ErrorException as ex:
    print(ex.message)
    print("Errors: ", ex.errors)
except Exception as ex:
    raise ex

Status da transação de cartão de crédito (Transaction)

As transações de Cartão de Crédito podem possuir os seguintes status:

Status
Descrição

authorized_pending_capture

Autorizada pendente de captura

not_authorized

Não autorizada

captured

Capturada

partial_capture

Capturada parcialmente

waiting_capture

Aguardando captura

refunded

Estornada

voided

Cancelada

partial_refunded

Estornada parcialmente

partial_void

Cancelada parcialmente

error_on_voiding

Erro no cancelamento

error_on_refunding

Erro no estorno

waiting_cancellation

Aguardando cancelamento

with_error

Com erro

failed

Falha

 
Suggest Edits

Cartão de débito

Para criar uma cobrança ou um pedido com cartão de débito, devemos incluir o objeto debit_card dentro do nó payment, assim como a propriedade "payment_method": "debit_card". O objeto debit_card contêm os seguintes atributos:

 
Atributos
Tipo
Descrição

statement_descriptor

string

Texto exibido na fatura do cartão. Max: 22 caracteres.

card, card_id ou card_token

object

Cartão de crédito.
card_id é o identificador do cartão de um cliente.
card_token é o token do cartão gerado pelo checkout transparente. Saiba mais sobre cartões.

recurrence

boolean

Indica se é uma cobrança/pedido de recorrência. Valor padrão: false

metadata

object

Objeto chave/valor utilizado para armazenar informações adicionais sobre o pagamento.
OBS: A chave mundipagg_payment_method_code poderá ser utilizada para informar o código da adquirente, com o objetivo de indicar em qual adquirente será processado o pagamento. Saiba mais sobre metadata.

merchant_category_code

integer

Código de classificação do ramo de atuação do lojista.

authentication

object

Objeto que indica se a transação de débito é autenticada ou não.

payload

object

_Objeto de dados criptografados, tais como: GooglePay, ApplePay e SamsungPay

Para os casos em que a transação é autenticada, o objeto authentication é obrigatório. Ele possui os seguintes campos:

type

string

Indica o tipo de autenticação utilizado. Atualmente o único tipo suportado é threed_secure

threed_secure

object

Indica os campos a serem enviados para a autenticação 3DS.

Por fim, o objeto threed_secure contém os seguintes campos:

Atributos
Tipo
Tamanho máximo
Descrição

mpi

string

11

Indica quem é o autenticador da transação. Pode receber os valores "acquirer" para transações autenticadas pela adquirente ou "third_party" para autenticadores externos.

eci

string

2

Indica o resultado da tentativa de autenticação. Obrigatório quando o mpi é "third_party".

cavv

string

256

Código de autenticação do dono do cartão. Obrigatório quando o mpi é "third_party".

transaction_id

string

256

id da transação no autenticador. Obrigatório quando o mpi é "third_party".

ds_transaction_id

string

256

Identificador da transação no Directory Service

version

string

6

Versão do 3D-S

success_url

string

512

Url de redirecionamento quando a transação é aprovada pelo autenticador. Obrigatório quando o mpié "acquirer".

Autenticação 3DS

Quando a autenticação é feita por um autenticador do tipo acquirer, só é necessário enviar os campos mpi e redirect_url. Os campos mpi, eci, cavv e transaction_id são os necessários para uma transação com autenticação externa.

{
	"items": [
        {
            "amount": 2990,
            "description": "Chaveiro do Tesseract",
            "quantity": 1
        }
    ],
    "amount":"2990",
    "customer": {
        "name": "Tony Stark",
        "email": "[email protected]"
    },
    "payments":[{
        "payment_method": "debit_card",
        "debit_card": {
            "statement_descriptor": "AVENGERS",
            "card": {
                "number": "4000000000000010",
                "holder_name": "Tony Stark",
                "exp_month": 12,
                "exp_year": 30,
                "cvv": "235"
            },
            "authentication": {
                "type": "threed_secure",
                "threed_secure": {
                    "mpi": "acquirer",
                    "success_url": "http://www.mundipagg.com"
                }
            }
        },
        "metadata": {
            "mundipagg_payment_method_code": "62"
        }
    }]
}
{
  "id": "or_7K8A8vkCmtLDG5Xl",
  "code": "XMWI23FMYL",
  "amount": 2990,
  "currency": "BRL",
  "closed": true,
  "items": [
    {
      "id": "oi_4MrX5mRc9UWVX985",
      "description": "Chaveiro do Tesseract",
      "amount": 2990,
      "quantity": 1,
      "status": "active",
      "created_at": "2019-09-30T16:20:48Z",
      "updated_at": "2019-09-30T16:20:48Z"
    }
  ],
  "customer": {
    "id": "cus_rdK4yjmHRdUe8LJl",
    "name": "Tony Stark",
    "email": "[email protected]",
    "delinquent": false,
    "created_at": "2019-09-30T15:38:58Z",
    "updated_at": "2019-09-30T15:38:58Z",
    "phones": {}
  },
  "status": "pending",
  "created_at": "2019-09-30T16:20:48Z",
  "updated_at": "2019-09-30T16:20:48Z",
  "closed_at": "2019-09-30T16:20:48Z",
  "charges": [
    {
      "id": "ch_oAk1KDXIvMCLbgav",
      "code": "XMWI23FMYL",
      "amount": 2990,
      "status": "pending",
      "currency": "BRL",
      "payment_method": "debit_card",
      "created_at": "2019-09-30T16:20:48Z",
      "updated_at": "2019-09-30T16:20:48Z",
      "customer": {
        "id": "cus_rdK4yjmHRdUe8LJl",
        "name": "Tony Stark",
        "email": "[email protected]",
        "delinquent": false,
        "created_at": "2019-09-30T15:38:58Z",
        "updated_at": "2019-09-30T15:38:58Z",
        "phones": {}
      },
      "last_transaction": {
        "id": "tran_10ELvKJtGnTNmxk2",
        "transaction_type": "debit_card",
        "gateway_id": "db0ad0b2-3556-49d2-9d52-16e6f9f4694f",
        "amount": 2990,
        "status": "pending_authentication",
        "success": true,
        "statement_descriptor": "AVENGERS",
        "acquirer_tid": "658cbfcd-29bc-4c22-89c3-ee7fa755e214",
        "acquirer_nsu": "658cbfcd-29bc-4c22-89c3-ee7fa755e214",
        "acquirer_message": "Transação não autorizada",
        "acquirer_return_code": "01",
        "operation_type": "capture",
        "mpi": "acquirer",
        "authentication_type": "threed_secure",
        "threed_authentication_url": "https://simulatorpages.mundipagg.com/ThreeDS/transactionKeyToAcquirer=db0ad0b2-3556-49d2-9d52-16e6f9f4694f&amount=2990",
        "card": {
          "id": "card_aYVpJ6xCQMU2pDk1",