{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.143.28.57
208.93.65.172
40.143.28.44

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 sua chave de API. Para isso, entre em contato com a nossa área comercial, através do e-mail: contato@mundipagg.com, para conhecer nossos planos. Se você já é nosso cliente, solicite a chave de API à nossa área de Relacionamento com o Cliente, pelo e-mail: suporte@mundipagg.com.

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

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": "tstark@avengers.com",
  }
}
 
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.

"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"
 }
 
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

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": "e9619c78-6e00-42ba-abea-3adf95a77d0a@avengers.com",
    "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": "e9619c78-6e00-42ba-abea-3adf95a77d0a@avengers.com",
    "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": "e9619c78-6e00-42ba-abea-3adf95a77d0a@avengers.com",
    "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

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

phones.mobile_phone
object

Telefone móvel do cliente

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": "tonystarkk@avengers.com",
    "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 = "tonystark@avengers.com",
        Type = "individual",
        Document = "93095135270",
        Gender = "male",
        Code = "MY_CUSTOMER_001"
        Phones = phones,
        Address = address,
        Metadata = metadata
    };

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

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

You couldn't be authenticated

{
    "id": "cus_QA5V47r9c0Im3dzN",
    "name": "Tony Stark",
    "email": "tonystarkk@avengers.com",
    "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": "tonystarkk@avengers.com",
        "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.


Access Token

Para a autenticação deste endpoint via access_token, deverá ser enviada a public_key da loja no parâmetro appId na query string. Saiba mais sobre Access Tokens.

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();
}
}
}
A binary file was returned

You couldn't be authenticated

{
    "id": "cus_6l5dMWZ0hkHZ4XnE",
    "name": "Wonderful Woman",
    "email": "wonderfulwoman@avengers.com",
  	"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": "parker@avengers.com",
  "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 = "parker@avengers.com"
    };

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

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

You couldn't be authenticated

{
  "id": "cus_6l5dMWZ0hkHZ4XnE",
  "name": "Peter Parker",
  "email": "parker@avengers.com",
  "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": "parker@avengers.com",
        "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": "9bfdfb6b-405f-489e-a4e0-b66101c86743@mundipagg.com",
      "delinquent": false,
      "created_at": "2017-04-19T17:43:10Z",
      "updated_at": "2017-04-19T17:43:10Z"
    },
    {
      "id": "cus_Z7DvZNpUZhYlvndR",
      "name": "Monitor",
      "gender": "female",
      "email": "c17b44be-85a8-4a1c-a9d1-5e0109cb4ece@mundipagg.com",
      "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 ou Sodexo.

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
required

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.

metadata
object

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


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": "5425019448107793",
    "holder_name": "Tony Stark",
    "holder_document": "93095135270",
    "exp_month": 1,
    "exp_year": 20,
    "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 = 20,
        Cvv = "351",
        Brand = "Mastercard",
        PrivateLabel = false,
        BillingAddress = billingAddress,
        Metadata = metadata,
    };

    var response = client.Customers.CreateCard(customerId, request);
    
    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",
    "holder_document": "93095135270",
    "exp_month": 1,
    "exp_year": 2020,
    "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": "0fee2dc5-e440-4dd1-9cd6-9c2bc90533d0@avengers.com",
        "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": 2018,
    "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": "0fee2dc5-e440-4dd1-9cd6-9c2bc90533d0@avengers.com",
        "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
required

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.


Access Token

Para a autenticação deste endpoint via access_token, deverá ser enviada a public_key da loja no parâmetro appId na query string.

{
    "holder_name": "Peter Parker",
    "exp_month": 12,
    "exp_year": 2018,
    "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 = 18,
        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": 2018,
    "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": "14a2f1a5-79a8-4b2b-a658-d4f931b0e02e@avengers.com",
        "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": "609671d7-7b1b-4b31-b3e0-1709cc8d9637@avengers.com",
        "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": {
       "street": "Malibu Point",
       "number": "10880",
       "zip_code": "90265",
       "neighborhood": "Central Malibu",
       "city": "Malibu",
       "state": "CA",
       "country": "US",
       "line_1": "10880, Malibu Point, Central Malibu"
   },
   "customer": {
       "id": "cus_BzRmLzQHEyurPkKo",
       "name": "Tony Stark",
       "email": "203b6f70-61ec-4f30-b00a-8a1823500ab4@avengers.com",
       "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();
    }
}
}
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": 2018,
      "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": 2018,
      "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": "4011185771285580",
    "holder_name": "Tony Stark",
    "exp_month": 1,
    "exp_year": 20,
    "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": 20,
        "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();
    }
}
}
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": "lskywalker@r2d2.com",
    "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": "lskywalker@r2d2.com",
    "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": "lskywalker@r2d2.com",
    "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

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

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

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.

capture

boolean

Indica se o pagamento deve ser processado imediatamente. Caso seja false o pagamento deverá ser confirmado posteriormente. Valor padrão: true.

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.

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.

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:

mpi

string

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

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

cavv

string

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

transaction_id

string

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

redirect_url

string

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.

{
  "amount": 200000,
  "customer": {
    "name": "Tony Stark",
    "email": "email@email.com",
    "metadata": {
      "company": "Mundipagg"
    }
  },
  "payment":{
   "metadata":{
     "mundipagg_payment_method_code": "1"
   },
   "payment_method": "credit_card",
   "credit_card": {
     "merchant_category_code" : 7025,
     "extended_limit_enabled": false,
     "extended_limit_code": null,
      "recurrence": false,
      "installments": 1,
      "statement_descriptor": "AVENGERS",
      "card": {
        "number": "342793631858229",
        "holder_name": "Tony Stark",
        "exp_month": 1,
        "exp_year": 20,
        "cvv": "3531",
        "billing_address": {
          "street": "Malibu Point",
          "number": "10880",
          "zip_code": "90265",
          "neighborhood": "Central Malibu",
          "city": "Malibu",
          "state": "CA",
          "country": "US"
        }
      }
    }
  }
}
{
    "id": "ch_4qbkd9ULBh8aD9lg",
    "code": "N3YKB9GTD2",
    "gateway_id": "10770bd4-3cb9-4384-a6de-e11b43d75c4f",
    "amount": 2000,
    "status": "paid",
    "currency": "BRL",
    "payment_method": "credit_card",
    "paid_at": "2017-07-05T16:57:36Z",
    "created_at": "2017-07-05T16:57:35Z",
    "updated_at": "2017-07-05T16:57:35Z",
    "customer": {
        "id": "cus_X46GD9GcQ4ckLWgz",
        "name": "Tony Stark",
        "email": "email@email.com",
        "delinquent": false,
        "created_at": "2017-07-05T16:57:09Z",
        "updated_at": "2017-07-05T16:57:09Z",
        "phones": {},
        "metadata": {
            "company": "Mundipagg"
        }
    },
    "last_transaction": {
        "id": "tran_evqjL0LsoQtojKdr",
        "transaction_type": "credit_card",
        "gateway_id": "5df60eb8-0545-4fc4-a852-3b9bae3eb656",
        "amount": 2000,
        "status": "captured",
        "success": true,
        "installments": 1,
        "statement_descriptor": "AVENGERS",
        "acquirer_name": "simulator",
        "acquirer_affiliation_code": "000000000",
        "acquirer_tid": "984204",
        "acquirer_nsu": "977090",
        "acquirer_auth_code": "445191",
        "acquirer_message": "Simulator|Transação de simulação autorizada com sucesso",
        "acquirer_return_code": "0",
        "operation_type": "auth_and_capture",
        "card": {
            "id": "card_lXzrODhnySAlmdMe",
            "last_four_digits": "8229",
            "brand": "Amex",
            "holder_name": "Tony Stark",
            "exp_month": 1,
            "exp_year": 2020,
            "status": "active",
            "created_at": "2017-07-05T16:57:09Z",
            "updated_at": "2017-07-05T16:57:09Z",
            "billing_address": {
                "street": "Malibu Point",
                "number": "10880",
                "zip_code": "90265",
                "neighborhood": "Central Malibu",
                "city": "Malibu",
                "state": "CA",
                "country": "US"
            },
            "type": "credit"
        },
        "created_at": "2017-07-05T16:57:36Z",
        "updated_at": "2017-07-05T16:57:36Z",
        "gateway_response": {
            "code": "201"
        }
    }
}

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

Voucher

Para criar uma cobrança ou um pedido com voucher, devemos incluir o objeto voucher dentro do nó payment, assim como a propriedade "payment_method": "voucher". O objeto voucher contém as seguintes propriedades:

 
Atributos
Tipo
Descrição

capture

boolean

Indica se o pagamento deve ser processado imediatamente. Caso seja false o pagamento deverá ser confirmado posteriormente. Valor padrão: true.

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.

card.holder_document

string

Número do documento do portador do cartão. Este campo deverá ser enviado dentro do objeto card e é obrigatório para voucher.

metadata

object

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

{
  "amount": 200000,
  "customer": {
    "name": "Tony Stark",
    "email": "email@email.com",
    "metadata": {
      "company": "Mundipagg"
    }
  },
  "payment":{
    "metadata":{
     "code": "6"  
   },
    "payment_method": "voucher",
   "voucher": {
      "statement_descriptor": "AVENGERS",
      "card": {
        "number": "6033890101091462",
        "holder_name": "Tony Stark",
        "holder_document": "93095135270",
        "exp_month": 1,
        "exp_year": 20,
        "cvv": "351",
        "billing_address": {
          "street": "Malibu Point",
          "number": "10880",
          "zip_code": "90265",
          "neighborhood": "Central Malibu",
          "city": "Malibu",
          "state": "CA",
          "country": "US"
        }
      }
    }
  }
}
{
    "id": "ch_OlD7AZwTbMs6VnBb",
    "code": "X2ZSVNUGP7",
    "gateway_id": "1cb59dd1-b57c-47ec-9bac-803d6ddd5eba",
    "amount": 2000,
    "paid_amount": 2000,
    "status": "paid",
    "currency": "BRL",
    "payment_method": "voucher",
    "paid_at": "2017-09-11T16:37:47Z",
    "created_at": "2017-09-11T16:37:46Z",
    "updated_at": "2017-09-11T16:37:46Z",
    "customer": {
        "id": "cus_roAvZy1HmIW7ZzG3",
        "name": "Tony Stark",
        "email": "email@email.com",
        "type": "",
        "delinquent": false,
        "created_at": "2017-04-28T18:24:19Z",
        "updated_at": "2017-09-11T16:32:53Z",
        "phones": {},
        "metadata": {
            "company": "Mundipagg"
        }
    },
    "last_transaction": {
        "id": "tran_LBgVZRJyIgtnZ1ry",
        "transaction_type": "voucher",
        "gateway_id": "50ce1756-335a-433b-89d1-69afc2797f33",
        "amount": 2000,
        "status": "captured",
        "success": true,
        "statement_descriptor": "AVENGERS",
        "acquirer_name": "simulator",
        "acquirer_affiliation_code": "MUNDI",
        "acquirer_tid": "652894",
        "acquirer_nsu": "724175",
        "acquirer_auth_code": "369074",
        "acquirer_message": "Simulator|Transação de simulação autorizada com sucesso",
        "acquirer_return_code": "0",
        "operation_type": "auth_and_capture",
        "card": {
            "id": "card_4wJODqpqS0C6nMbq",
            "first_six_digits": "600818",
            "last_four_digits": "3014",
            "brand": "Sodexo",
            "holder_name": "Tony Stark",
            "holder_document": "93095135270",
            "exp_month": 1,
            "exp_year": 2018,
            "status": "active",
            "created_at": "2017-09-11T16:37:13Z",
            "updated_at": "2017-09-11T16:37:46Z",
            "billing_address": {
                "street": "Malibu Point",
                "number": "10880",
                "zip_code": "90265",
                "neighborhood": "Central Malibu",
                "city": "Malibu",
                "state": "CA",
                "country": "US"
            },
            "customer": {
                "id": "cus_roAvZy9HmIW7ZzG3",
                "name": "Tony Stark",
                "email": "email@email.com",
                "type": "",
                "delinquent": false,
                "created_at": "2017-04-28T18:24:19Z",
                "updated_at": "2017-09-11T16:32:53Z",
                "phones": {},
                "metadata": {
                    "company": "MundiPagg"
                }
            },
            "type": "voucher"
        },
        "created_at": "2017-09-11T16:37:46Z",
        "updated_at": "2017-09-11T16:37:46Z",
        "gateway_response": {
            "code": "201"
        }
    }
}

Status das transações de Voucher (Transaction)

As transações de Voucher 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

refunded

Estornada

voided

Cancelada

partial_refunded

Estornada parcialmente

partial_void

Cancelada parcialemente

error_on_voiding

Erro no cancelamento

error_on_refunding

Erro no estorno

waiting_cancellation

Aguardando cancelamento

with_error

Com erro

failed

Falha

 
Suggest Edits

Boleto

Para criar uma cobrança ou um pedido com boleto, devemos incluir o objeto boleto dentro do nó payment, assim como a propriedade "payment_method": "boleto". O objeto boleto contém as seguintes propriedades:

 
Atributos
Tipo
Descrição

bank

string

Código do banco. 001 (Banco do Brasil); 033 (Santander); 237 (Bradesco); 341 (Itau); 745 (Citibank) e 104 (Caixa Econômica Federal).

instructions

string

Instruções do boleto. Max: 256 caracteres.

due_at

datetime

Data de vencimento. (Opcional)

nosso_numero

string

Número que identifica unicamente um boleto para uma conta.

metadata

object

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

document_number

string

Identificador do boleto. Max: 16 caracteres.

BOLETOS COM REGISTRO TÊM CAMPOS OBRIGATÓRIOS

Para requisições de cobrança de boletos com registro os campos name, address e document do cliente (objeto customer) devem ser enviados OBRIGATORIAMENTE.

{
  "amount": 1490,
  "customer": {
      "name": "Tony Stark",
      "email": "tstark@avengers.com",
    	"document": "123456789",
      "address": {
          "street": "Av. General Justo",
          "number": "375",
          "complement": "9º andar",
          "zip_code": "20021130",
          "neighborhood": "Centro",
          "city": "Rio de Janeiro",
          "state": "RJ",
          "country": "BR"
      }
  },
  "payment": {
    "metadata":{
	     "code": "2"  
   },
      "payment_method": "boleto",
      "boleto": {
        "bank": "033",
        "instructions": "Pagar até o vencimento",
        "due_at": "2020-09-20T00:00:00Z",
        "document_number": "123"
      }
  }
}
{
    "id": "ch_myqEBxohLaCmp8NJ",
    "code": "XQKMIQYU7E",
    "gateway_id": "54b4e150-fe87-4216-a72d-c84081b4f5db",
    "amount": 1490,
    "status": "pending",
    "currency": "BRL",
    "payment_method": "boleto",
    "created_at": "2017-07-05T16:55:20Z",
    "updated_at": "2017-07-05T16:55:20Z",
    "customer": {
        "id": "cus_D7LQBbRU6qF9QO42",
        "name": "Tony Stark",
        "email": "tstark@avengers.com",
      	"document": "123456789",
        "delinquent": false,
        "address": {
            "id": "addr_OZ9yQGdIOF9AvYMK",
            "street": "Av. General Justo",
            "number": "375",
            "complement": "9º andar",
            "zip_code": "20021130",
            "neighborhood": "Centro",
            "city": "Rio de Janeiro",
            "state": "RJ",
            "country": "BR",
            "status": "active",
            "created_at": "2017-07-05T16:55:20Z",
            "updated_at": "2017-07-05T16:55:20Z"
        },
        "created_at": "2017-07-05T16:55:20Z",
        "updated_at": "2017-07-05T16:55:20Z",
        "phones": {}
    },
    "last_transaction": {
        "id": "tran_kAbYK1fmNsPKwdWa",
        "transaction_type": "boleto",
        "gateway_id": "51c00c63-e9d4-485a-8eec-f1760e07ab9e",
        "amount": 1490,
        "status": "generated",
        "success": true,
        "url": "https://sandbox.mundipaggone.com/Boleto/ViewBoleto.aspx?51c00c63-e9d4-485a-8eec-f1762e07ab9e",
        "pdf": "https://api.mundipagg.com/core/v1/transactions/tran_kAbYK1fmNsPKwd2a/pdf",
        "line": "34191.75009 04191.381237 41234.510000 2 105750000001490",
        "barcode": "https://api.mundipagg.com/core/v1/transactions/tran_kAbYK1fmNsP2wdWa/barcode",
        "qr_code": "https://api.mundipagg.com/core/v1/transactions/tran_kAbYK1fmNs2KwdWa/qrcode",
        "nosso_numero": "00041913",
        "bank": "033",
        "document_number": "123",
        "instructions": "Pagar até o vencimento",
        "due_at": "2026-09-20T00:00:00Z",
        "created_at": "2017-07-05T16:55:20Z",
        "updated_at": "2017-07-05T16:55:20Z",
        "gateway_response": {
            "code": "201"
        }
    }
}

Status das transações de boleto (Transaction)

As transações de boleto podem possuir os seguintes status:

Status
Descrição

generated

Gerado

viewed

Visualizado

underpaid

Pago a menor

overpaid

Pago a maior

paid

Pago

voided

Cancelado

with_error

Com erro

failed

Falha

 
Suggest Edits

Transferência bancária

Para criar uma cobrança ou um pedido com transferência bancária, devemos incluir a propriedade "payment_method": "bank_transfer" dentro do nó payment, e caso necessário o objeto bank_transfer. O objeto bank_transfer tem as seguintes propriedades:

 
Atributos
Tipo
Descrição

bank

string

Código do Banco. 001 (Banco do Brasil); 237 (Bradesco) e 341 (Itau).

metadata

object

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

Código do Banco padrão

Você pode configurar um código padrão para a sua loja. Desta forma, você não precisa enviá-lo em toda requisição e o nó bank_transfer sendo o mesmo opcional.

{
  "amount": 1490000,
  "customer": {
    "name": "Tony Stark",
    "email": "{{email}}",
  "document": "57510831563",
  "type": "individual"
  },
  "payment":{
    "metadata":{
	     "code": "3"  
   },
    "payment_method": "bank_transfer",
    "bank_transfer":{
    	"bank": 001
    }
  },
  "metadata": {
    "code": "123"
  }
}
{
    "id": "ch_j2bkebpurbCgEGpq",
    "code": "0X7JFVQSN0",
    "gateway_id": "364b6d2e-62e9-4fed-8646-3af3320d153b",
    "amount": 1490000,
    "status": "pending",
    "currency": "BRL",
    "payment_method": "bank_transfer",
    "created_at": "2017-07-05T16:52:36Z",
    "updated_at": "2017-07-05T16:52:36Z",
    "customer": {
        "id": "cus_1rp2jAES3RCwnyz0",
        "name": "Tony Stark",
        "email": "974169e4-9f6c-42ef-8355-a82a4ef4c388@avengers.com",
        "document": "57510831563",
        "type": "individual",
        "delinquent": false,
        "created_at": "2017-07-05T16:52:36Z",
        "updated_at": "2017-07-05T16:52:36Z",
        "phones": {}
    },
    "last_transaction": {
        "url": "https://onlinedebitsandbox.mundipaggone.com:4443/OnlineDebit/Checkout/e17a8b29-857a-4087-8d27-4c0ab4e2e08b",
        "bank_tid": "00000427",
        "bank": "341",
        "id": "tran_kEnJLNRH2sBLdBpW",
        "transaction_type": "bank_transfer",
        "gateway_id": "e17a8b29-857a-4087-8d27-4c0ab4e2e98b",
        "amount": 1490000,
        "status": "pending",
        "success": true,
        "created_at": "2017-07-05T16:52:36Z",
        "updated_at": "2017-07-05T16:52:36Z",
        "gateway_response": {
            "code": "201"
        }
    },
    "metadata": {
        "code": "123"
    }
}

Status das transações de Transferência Bancária (Transaction)

As transações de transferência bancária podem possuir os seguintes status:

Status
Descrição

pending

Pendente

paid

Paga

overpaid

Paga a maior

underpaid

Paga a menor

with_error

Com erro

not_paid

Não paga

failed

Falha

 
Suggest Edits

SafetyPay

Para criar uma cobrança ou um pedido com SafetyPay, devemos incluir a propriedade "payment_method": "safetypay" dentro do nó payment.

 
{
  "amount": 1490,
  "customer": {
    "name": "Tony Stark",
    "email": "{{email}}",
    "document": "24551132802",
    "type" : "individual"
  },
  "payment":{
    "metadata":{
     "code": "4"  
   },
    "payment_method": "safetypay"
  },
  "metadata": {
    "code": "123"
  }
}
{
    "id": "ch_GM0yWaBkFmuZV5lo",
    "code": "5GV2BQS6K5",
    "gateway_id": "7a9610b3-bbc0-4ec0-831f-cfdb87744ae4",
    "amount": 1490,
    "status": "pending",
    "currency": "BRL",
    "payment_method": "safetypay",
    "created_at": "2017-07-05T16:59:30Z",
    "updated_at": "2017-07-05T16:59:30Z",
    "customer": {
        "id": "cus_Zmqy7GJHQocWER0k",
        "name": "Tony Stark",
        "email": "a0b401c8-7f01-4d9a-a953-c19ebbb1806f@avengers.com",
        "document": "24551132802",
        "type": "individual",
        "delinquent": false,
        "created_at": "2017-07-05T16:59:30Z",
        "updated_at": "2017-07-05T16:59:30Z",
        "phones": {}
    },
    "last_transaction": {
        "url": "https://sandbox-gateway.safetypay.com/Express4/Checkout/index?TokenID=6c60d19c-64bf-4a81-96d1-ad46bdba9764",
        "safetypay_tid": "e09f39ad33fc4c3b",
        "id": "tran_2vrxYNnhZpSQazQ5",
        "transaction_type": "safetypay",
        "gateway_id": "e09f39ad-33fc-4c3b-a88a-103df99c3614",
        "amount": 1490,
        "status": "pending",
        "success": true,
        "created_at": "2017-07-05T16:59:30Z",
        "updated_at": "2017-07-05T16:59:30Z",
        "gateway_response": {
            "code": "201"
        }
    },
    "metadata": {
        "code": "123"
    }
}

Status das transações de SafetyPay (Transaction)

As transações de SafatyPay podem possuir os seguintes status:

Status
Descrição

pending

Pendente

paid

Paga

overpaid

Paga a maior

underpaid

Paga a menor

with_error

Com erro

not_paid

Não paga

failed

Falha

 
Suggest Edits

Checkout

Para criar um pedido com checkout, devemos incluir o objeto checkout dentro do nó payment, assim como a propriedade "payment_method": "checkout". O objeto checkout contêm as seguintes propriedades:

 
Atributos
Tipo
Descrição

accepted_payment_method

array of string

Meios de pagamento aceitos para o checkout. Valores possíveis: credit_card, boleto e bank_transfer.

accepted_multi_payment_methods

array of array of string

Meios de pagamentos aceitos para permitir ao cliente a opção de multimeios. Valores possíveis: credit_card, boleto e credit_card, credit_card .

default_payment_method

string

Meio de pagamento padrão.

success_url

string

URL para redirecionamento de sucesso.

credit_card

object

Configurações para pagamento com cartão de crédito.

credit_card.capture

boolean

Indica se a transação deve ser capturada ou somente autorizada. Caso seja true, o valor é capturado simultaneamente à autorização.

credit_card.statement_descriptor

string

Texto da fatura do cartão.

credit_card.installments

array of objects

Array de configurações de parcelas.

credit_card.installments.number

number

Quantidade de parcelas.

credit_card.installments.total

number

Valor total referente à quantidade de parcelas.

boleto

object

Configurações para pagamento com boleto.

boleto.due_at

string

Data de vencimento do boleto.

boleto.instructions

string

Instruções do boleto.

skip_checkout_success_page

boolean

Permite pular a tela de redirecionamento pós pagamento.

customer_editable

boolean

Torna o objeto do cliente editável.

metadata

object

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

bank_transfer

object

Configurações para pagamento via transferência bancária.

bank_transfer.bank

array of objects

Array de configurações para indicar quais bancos serão utilizados para a transferência bancária.

expires_in

integer

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

billing_address_editable

boolean

Torna o objeto billing address editável.

billing_address

object

Configuração para endereço de cobrança.

{
   "items":[
      {
         "amount":2990,
         "description":"Chaveiro do Tesseract",
         "quantity":1
      }
   ],
   "customer":{
      "name":"Tony Stark",
      "email":"tstark@avengers.com"
   },
   "payments":[
      {
         "payment_method":"checkout",
         "amount":2000,
         "checkout": {
           "customer_editable" : false,
           "skip_checkout_success_page": true,
           "accepted_payment_methods": [ "credit_card", "boleto", "bank_transfer"],
           "accepted_multi_payment_methods": [ 
		      		["credit_card","credit_card"],
		      		["credit_card","boleto"]
		   			],
           "success_url": "https://www.mundipagg.com",
           "banktransfer": {
             "bank": ["237", "001", "341"]
           },
           "boleto": {
             "bank": "033",
             "instructions": "Pagar até o vencimento",
             "due_at": "2020-07-25T00:00:00Z"
         },
           "credit_card": {
              "capture": true,
              "statement_descriptor": "Desc na fatura",
              "installments": [
                {
                  "number": 1,
                  "total": 2000
                },
                {
                  "number": 2,
                  "total": 2500
                }
             ]
           }
         }
      }
   ]
}
{
    "id": "or_5ayWvnd3cbHr4w06",
    "code": "5YG7FQF975",
    "amount": 2990,
    "currency": "BRL",
    "closed": false,
    "items": [
        {
            "id": "oi_yB6wRX8psDU7RVPb",
            "description": "Chaveiro do Tesseract",
            "amount": 2990,
            "quantity": 1,
            "status": "active",
            "created_at": "2018-01-05T22:10:28Z",
            "updated_at": "2018-01-05T22:10:28Z"
        }
    ],
    "customer": {
        "id": "cus_XenkEVAFQfZ98mo3",
        "name": "Tony Stark",
        "email": "tstark@avengers.com",
        "delinquent": false,
        "created_at": "2018-01-05T22:08:00Z",
        "updated_at": "2018-01-05T22:08:00Z",
        "phones": {}
    },
    "Shipping": {
          "amount": 1000,
          "description": "Express Shipping",
          "recipient_name": "Gustavo Fonseca",
          "recipient_phone": "707070707070",
          "address": {
  						"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"
  					}
					}
        },
  	"shippable" : true,
    "status": "pending",
    "created_at": "2018-01-05T22:10:28Z",
    "updated_at": "2018-01-05T22:10:28Z",
    "checkouts": [
        {
            "id": "chk_mLoWDeXQuXcyj24O",
            "amount": 2000,
          	"currency" : "BRL",
            "success_url": "https://www.mundipagg.com",
            "payment_url": "https://api.mundipagg.com/checkout/v1/orders/chk_mLoWDeXQuXcyj24O",
            "accepted_payment_methods": [
                "credit_card"
            ],
            "status": "open",
            "skip_checkout_success_page": true,
            "created_at": "2018-01-05T22:10:28Z",
            "expires_at": "2018-02-05T22:08:00Z",
            "updated_at": "2018-01-05T22:10:28Z",
            "customer_editable" : false,
            "customer": {
                "id": "cus_XenkEVAFQfZ98mo3",
                "name": "Tony Stark",
                "email": "tstark@avengers.com",
                "delinquent": false,
                "created_at": "2018-01-05T22:08:00Z",
                "updated_at": "2018-01-05T22:08:00Z",
                "phones": {}
            },
            "billing_address_editable" : false,
            "billing_address": {
                  "street": "Malibu Point",
                  "number": "10880",
                  "zip_code": "90265",
                  "neighborhood": "Central Malibu",
                  "city": "Malibu",
                  "state": "CA",
                  "country": "US"
                },
             "shippable" : true,
             "shipping": {
             "amount": 1000,
             "description": "Express Shipping",
             "recipient_name": "Gustavo Fonseca",
             "recipient_phone": "707070707070",
             "address": {
                 "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"
               }
             }
           },
            "bank_transfer": {
                "bank": [
                    "234",
                    "001",
                    "033"
                ]
            },
            "credit_card": {
                "statementDescriptor": "Desc na fatura",
                "installments": [
                    {
                        "number": 1,
                        "total": 2000
                    },
                    {
                        "number": 2,
                        "total": 2500
                    }
                ]
            }
        }
    ]
}

CHECKOUT APLICA-SE APENAS A PEDIDOS

É importante notar que o meio de pagamento checkout é suportado somente por pedidos, não podendo ser utilizado em cobranças.

 
Suggest Edits

Apple Pay

Para criar uma cobrança ou um pedido com apple pay, devemos incluir o objeto credit_card dentro do nó payment, assim como a propriedade "payment_method": "credit_card". Além disso, o objeto credit_card deve conter os atributos de token e apple_pay. O objeto token possui os seguintes atributos:

 
Atributos
Tipo
Descrição

type

string

Determina o tipo de token. Para Apple Pay deve-se enviar apple_pay

apple_pay

object

Campos a serem enviados para pagamento com Apple Pay

O objeto apple_pay possui os seguintes atributos:

Atributos
Tipo
Descrição

version

string

Informação sobre a versão do token. Único valor aceito é EC_v1

merchant_identifier

string

Identificador da loja na Apple

data

string

Dados de pagamento criptografados

header

object

Informações utilizadas para descriptografar e verificar o pagamento

signature

string

Assinatura dos dados de pagamento e do header

Além disso, o objeto 'header' contém os seguintes atributos:

ephemeral_public_key

string

Ephemeral public key do lojista. EC_v1 apenas.

public_key_hash

string

Hash da public key criptografada em X.509 do certificado da loja.

transaction_id

string

É o id da transação, gerado no aparelho

Atenção!

Todos os campos do objeto apple_pay são obrigatórios caso a transação seja feita por esse meio de pagamento!

{
  "amount": 1490,
  "currency": "BRL",
  "customer": {
    "name": "Tony Stark",
    "email": "{{email}}"
  },
  "payment":{
    "payment_method": "credit_card",
    "credit_card": {
      "installments": 1,
      "statement_descriptor": "AVENGERS",
      "token":{
        "type":"apple_pay",
        "apple_pay": {
        "version": "EC_v1",
        "merchant_identifier": "merchant.com.example.mundipagg",
        "data": "uxXQ79wQwUFs/ffeQEzcu6u6HCZjBoVdxjxA/BLKUDheuEWSzm1GqWr05ablgcuqNZI1ia4cd52ePuAA2Rb/5iGbNvgQcxBWqBUJ45bJwIb3TsBdRaWMc7HDrDzvBXEtipGBfaep09CZiUQ2XeqaEqXATwGsW8wlwFmuUaoK05+u9KpIWzfA9fb3Ub/45TB0iu1ZWXQdxBSPRUJ771dKaMhdI9qqGZSsg7qb9Bxk+fQw5VXREAu57r7NN70zc6dwBS7kYk4OhieenPTc2iw8PGkqFUyXtb8vwF5TwGzDoKsosFURtFVgfXtpU8DCBM26uW9PX8DMe9mW7ohHrnmuCxRgdJevHLge8ckwE1xibGFsALe7e+GnZP691DGGi4C32G3H3GilDNufaG+NHdjVxS/UOnc5Z7/Vb1cZNg55Jt5r",
        "header": {
          "ephemeral_public_key": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE1H48bA6ULVpuJVmIwjw6uiH2774SmxlPVzztBMxVFSbBANxlqqTL2lM3HG9LwW09mYTkpkgsK1KHgaKDwI6eWg==",
          "public_key_hash": "Z1/wkFT2/GKkQ/wJnq1RiqB2SlKuPoBMQTUkGlLKIaY=",
          "transaction_id": "a1a24121fd3c9dcf5e9efb41af99c4a516094ec624e9f40fbbe5865442d8d8e8"
        },
        "signature": "MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwEAAKCAMIID5jCCA4ugAwIBAgIIaGD2mdnMpw8wCgYIKoZIzj0EAwIwejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMB4XDTE2MDYwMzE4MTY0MFoXDTIxMDYwMjE4MTY0MFowYjEoMCYGA1UEAwwfZWNjLXNtcC1icm9rZXItc2lnbl9VQzQtU0FOREJPWDEUMBIGA1UECwwLaU9TIFN5c3RlbXMxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEgjD9q8Oc914gLFDZm0US5jfiqQHdbLPgsc1LUmeY+M9OvegaJajCHkwz3c6OKpbC9q+hkwNFxOh6RCbOlRsSlaOCAhEwggINMEUGCCsGAQUFBwEBBDkwNzA1BggrBgEFBQcwAYYpaHR0cDovL29jc3AuYXBwbGUuY29tL29jc3AwNC1hcHBsZWFpY2EzMDIwHQYDVR0OBBYEFAIkMAua7u1GMZekplopnkJxghxFMAwGA1UdEwEB/wQCMAAwHwYDVR0jBBgwFoAUI/JJxE+T5O8n5sT2KGw/orv9LkswggEdBgNVHSAEggEUMIIBEDCCAQwGCSqGSIb3Y2QFATCB/jCBwwYIKwYBBQUHAgIwgbYMgbNSZWxpYW5jZSBvbiB0aGlzIGNlcnRpZmljYXRlIGJ5IGFueSBwYXJ0eSBhc3N1bWVzIGFjY2VwdGFuY2Ugb2YgdGhlIHRoZW4gYXBwbGljYWJsZSBzdGFuZGFyZCB0ZXJtcyBhbmQgY29uZGl0aW9ucyBvZiB1c2UsIGNlcnRpZmljYXRlIHBvbGljeSBhbmQgY2VydGlmaWNhdGlvbiBwcmFjdGljZSBzdGF0ZW1lbnRzLjA2BggrBgEFBQcCARYqaHR0cDovL3d3dy5hcHBsZS5jb20vY2VydGlmaWNhdGVhdXRob3JpdHkvMDQGA1UdHwQtMCswKaAnoCWGI2h0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlYWljYTMuY3JsMA4GA1UdDwEB/wQEAwIHgDAPBgkqhkiG92NkBh0EAgUAMAoGCCqGSM49BAMCA0kAMEYCIQDaHGOui+X2T44R6GVpN7m2nEcr6T6sMjOhZ5NuSo1egwIhAL1a+/hp88DKJ0sv3eT3FxWcs71xmbLKD/QJ3mWagrJNMIIC7jCCAnWgAwIBAgIISW0vvzqY2pcwCgYIKoZIzj0EAwIwZzEbMBkGA1UEAwwSQXBwbGUgUm9vdCBDQSAtIEczMSYwJAYDVQQLDB1BcHBsZSBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eTETMBEGA1UECgwKQXBwbGUgSW5jLjELMAkGA1UEBhMCVVMwHhcNMTQwNTA2MjM0NjMwWhcNMjkwNTA2MjM0NjMwWjB6MS4wLAYDVQQDDCVBcHBsZSBBcHBsaWNhdGlvbiBJbnRlZ3JhdGlvbiBDQSAtIEczMSYwJAYDVQQLDB1BcHBsZSBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eTETMBEGA1UECgwKQXBwbGUgSW5jLjELMAkGA1UEBhMCVVMwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAATwFxGEGddkhdUaXiWBB3bogKLv3nuuTeCN/EuT4TNW1WZbNa4i0Jd2DSJOe7oI/XYXzojLdrtmcL7I6CmE/1RFo4H3MIH0MEYGCCsGAQUFBwEBBDowODA2BggrBgEFBQcwAYYqaHR0cDovL29jc3AuYXBwbGUuY29tL29jc3AwNC1hcHBsZXJvb3RjYWczMB0GA1UdDgQWBBQj8knET5Pk7yfmxPYobD+iu/0uSzAPBgNVHRMBAf8EBTADAQH/MB8GA1UdIwQYMBaAFLuw3qFYM4iapIqZ3r6966/ayySrMDcGA1UdHwQwMC4wLKAqoCiGJmh0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlcm9vdGNhZzMuY3JsMA4GA1UdDwEB/wQEAwIBBjAQBgoqhkiG92NkBgIOBAIFADAKBggqhkjOPQQDAgNnADBkAjA6z3KDURaZsYb7NcNWymK/9Bft2Q91TaKOvvGcgV5Ct4n4mPebWZ+Y1UENj53pwv4CMDIt1UQhsKMFd2xd8zg7kGf9F3wsIW2WT8ZyaYISb1T4en0bmcubCYkhYQaZDwmSHQAAMYIBizCCAYcCAQEwgYYwejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTAghoYPaZ2cynDzANBglghkgBZQMEAgEFAKCBlTAYBgkqhkiG9w0BCQMxCwYJKoZIhvcNAQcBMBwGCSqGSIb3DQEJBTEPFw0xODAzMjIxODIwMzVaMCoGCSqGSIb3DQEJNDEdMBswDQYJYIZIAWUDBAIBBQChCgYIKoZIzj0EAwIwLwYJKoZIhvcNAQkEMSIEIP04r38aKvOWJbQ5VgbNPRQoKViGH4p0uza6dcEontZJMAoGCCqGSM49BAMCBEYwRAIgOiofZlNby6PYO1rt4THd0jYcOPVwG0YJ9CrtibxwHn8CIFSNaGQchaoNllndK9PuoFQl4cUlxg3a/kGC3FeePxI7AAAAAAAA"
      }
      }
    }
  },
  "metadata": {
    "code": "123"
  }
}
{
    "id": "ch_Ox5jvKKTpZcK9glQ",
    "code": "6JDECEKS10",
    "gateway_id": "3e4d45cb-01cd-4976-987d-e0539c765086",
    "amount": 1490,
    "paid_amount": 1490,
    "status": "paid",
    "currency": "BRL",
    "payment_method": "credit_card",
    "paid_at": "2018-10-02T16:49:28Z",
    "created_at": "2018-10-02T16:49:27Z",
    "updated_at": "2018-10-02T16:49:27Z",
    "customer": {
        "id": "cus_8z3L0ogfNRTdlZnD",
        "name": "Tony Stark",
        "email": "7ef91f96-c068-4354-b797-b4ef128db404@avengers.com",
        "delinquent": false,
        "created_at": "2018-10-02T16:49:27Z",
        "updated_at": "2018-10-02T16:49:27Z",
        "phones": {}
    },
    "last_transaction": {
        "id": "tran_4vP712Qs6tkxmkDV",
        "transaction_type": "credit_card",
        "gateway_id": "d7809471-4a89-4198-9a30-bf621ef2f8fc",
        "amount": 1490,
        "status": "captured",
        "success": true,
        "installments": 1,
        "statement_descriptor": "AVENGERS",
        "acquirer_name": "simulator",
        "acquirer_affiliation_code": "",
        "acquirer_tid": "287049",
        "acquirer_nsu": "337532",
        "acquirer_auth_code": "862029",
        "acquirer_message": "Simulator|Transação de simulação autorizada com sucesso",
        "acquirer_return_code": "0",
        "operation_type": "auth_and_capture",
        "card": {
            "id": "card_2qE8eEGSrHqR7j3Q",
            "first_six_digits": "483026",
            "last_four_digits": "7665",
            "brand": "Visa",
            "holder_name": "APPLE PAY",
            "exp_month": 12,
            "exp_year": 2023,
            "status": "active",
            "type": "credit",
            "tokenization_method": "apple_pay",
            "created_at": "2018-10-02T16:49:27Z",
            "updated_at": "2018-10-02T16:49:27Z"
        },
        "created_at": "2018-10-02T16:49:27Z",
        "updated_at": "2018-10-02T16:49:27Z",
        "gateway_response": {
            "code": "201"
        }
    },
    "metadata": {
        "code": "123"
    }
}
 
Suggest Edits

Cash

Para criar uma cobrança ou um pedido com cash, devemos incluir o objeto cash dentro do nó payment, assim como a propriedade "payment_method": "cash". O objeto cash contém as seguintes propriedades:

 
Atributos
Tipo
Descrição

description

string

Descrição do pagamento. Max: 256 caracteres.

confirm

boolean

Indica se o pagamento será confirmado no ato da criação da cobrança ou se deve ser confirmado posteriormente.

metadata

object

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

{
  "amount": 1490,
  "currency": "BRL",
  "customer": {
    "name": "Tony Stark",
    "email": "tony.stark@avengers.com"
  },
  "payment":{
    "payment_method": "cash",
    "cash": {
      "description": "Teste",
      "confirm": false
    }
  },
  "metadata": {
    "code": "123"
  }
}
{
    "id": "ch_1GWo9VyiBJs4AOBy",
    "code": "6OY1HPSX3L",
    "amount": 1490,
    "paid_amount": 1490,
    "status": "pending",
    "currency": "BRL",
    "payment_method": "cash",
    "created_at": "2018-06-28T18:58:03Z",
    "updated_at": "2018-06-28T18:58:03Z",
    "customer": {
        "id": "cus_qGW6pRYCrU5qwPm2",
        "name": "Tony Stark",
        "email": "tony.stark@avengers.com",
        "delinquent": false,
        "created_at": "2018-06-28T18:58:03Z",
        "updated_at": "2018-06-28T18:58:03Z",
        "phones": {}
    },
    "last_transaction": {
        "description": "Teste",
        "id": "tran_4rKBYmDT9TxWyJgn",
        "transaction_type": "cash",
        "amount": 1490,
        "status": "pending",
        "success": true,
        "created_at": "2018-06-28T18:58:05Z",
        "updated_at": "2018-06-28T18:58:05Z",
        "gateway_response": {}
    },
    "metadata": {
        "code": "123"
    }
}

Status das transações de Cash (Transaction)

As transações de Cash podem pussuir os seguintes status:

Status
Descrição

pending

Pendente

paid

Paga

 
Suggest Edits

Cobranças

Para realizar cobranças de cartão de crédito ou boleto, você deve criar um objeto charge. Este objeto tem os seguintes atributos:

 
Atributos
Tipo
Descrição

id

string

Código da cobrança. Formato: ch_XXXXXXXXXXXXXXXX.

code

string

Código identificador da cobrança no sistema da loja.

gateway_id

string

Código da cobrança no gateway de pagamento.

amount

integer

Valor da cobrança.

payment_method

string

Meio de pagamento.

status

string

Status da cobrança. Valores possíveis: pending, paid, canceled, processing, failed, overpaid ou underpaid.

due_at

datetime

Data de vencimento da cobrança.

created_at

datetime

Data de criação da cobrança.

updated_at

datetime

Data de atualização da cobrança.

customer

object

Dados do cliente. Saiba mais sobre clientes.

invoice

object

Dados da fatura. Saiba mais sobre faturas.

last_transaction

object

Informações sobre a última transação da cobrança.

metadata

object

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

 
Suggest Edits

Capturar cobrança

 
posthttps://api.mundipagg.com/core/v1/charges/charge_id/capture

Path Params

charge_id
string
required

Código da cobrança.

Body Params

amount
string

Valor a ser capturado. Caso não seja informado, será considerado o valor total da cobrança

code
string

Código da cobrança no sistema da loja. Irá atualizar o valor informado na criação da cobrança. Max: 52 caracteres

 
{
  "amount":"100",
  "code":"ABCDE123"
}
    // Neste exemplo estamos utilizando A sdk C# MundiAPI.PCL
    // 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 chargeId = "ch_exRAY21fvNFVD9EX";
            
    // Opcional
    var request = new CreateCaptureChargeRequest {
        Amount = 100,
        Code = "ABCDE123"
    };

    var response = client.Charges.CaptureCharge(chargeId, request);
A binary file was returned

You couldn't be authenticated

{
  "id": "ch_7YBoBPWCVKS3QdyM",
  "code": "WZQS3LHEKW",
  "gateway_id": "42c243c4-0b52-49f3-ba92-e8661ebc7916",
  "amount": 1490,
  "status": "paid",
  "currency": "BRL",
  "payment_method": "credit_card",
  "due_at": "2017-04-04T00:00:00",
  "paid_at": "2017-04-04T20:06:14",
  "created_at": "2017-04-04T20:05:39",
  "updated_at": "2017-04-04T20:06:14",
  "customer": {
    "id": "cus_aEkwKv0SmNHMR931",
    "name": "Luke Skywalker",
    "email": "lskywalker@r2d2.com",
    "delinquent": false,
    "created_at": "2017-04-04T19:41:31",
    "updated_at": "2017-04-04T19:41:31"
  },
  "last_transaction": {
    "id": "tran_9KYq34mcDfOnXg1Z",
    "transaction_type": "credit_card",
    "gateway_id": "d8033a7c-2d31-4840-8870-8a71bd16cacc",
    "amount": 1490,
    "status": "captured",
    "success": true,
    "installments": 1,
    "statement_descriptor": "Spotify",
    "acquirer_name": "simulator",
    "acquirer_affiliation_code": "MUNDI",
    "acquirer_tid": "856202",
    "acquirer_nsu": "503081",
    "acquirer_auth_code": "405205",
    "operation_type": "capture",
    "credit_card": {
      "id": "card_2bKzdEGsYYFkymqG",
      "first_six_digits": "542501",
      "last_four_digits": "5322",
      "brand": "Visa",
      "holder_name": "Luke Skywalker",
      "exp_month": 5,
      "exp_year": 2017,
      "status": "active",
      "created_at": "2017-04-04T19:41:31",
      "updated_at": "2017-04-04T19:41:31",
      "billing_address": {
        "street": "Av. General Justo",
        "number": "375",
        "complement": "9º andar",
        "zip_code": "20021130",
        "neighborhood": "Centro",
        "city": "Rio de Janeiro",
        "state": "RJ",
        "country": "BR"
      }
    },
    "created_at": "2017-04-04T20:06:14",
    "updated_at": "2017-04-04T20:06:14"
  },
  "metadata": {
    "id": "my_charge_id"
  }
}
{
  "message": "This charge can not be captured."
}
 
Suggest Edits

Obter cobrança

 
gethttps://api.mundipagg.com/core/v1/charges/charge_id

Path Params

charge_id
string
required

Código da cobrança.

 
    // Neste exemplo estamos utilizando A sdk C# MundiAPI.PCL    
    // 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 chargeId = "ch_exRAY21fvNFVD9EX";

    var response = client.Charges.GetCharge(chargeId);
A binary file was returned

You couldn't be authenticated

{
  "id": "ch_exRAY21fvNFVD9EX",
  "code": "Y146FPVB4Y",
  "gateway_id": "08357d68-4f45-4099-bedd-af9fc6f0de4f",
  "amount": 1490,
  "status": "paid",
  "currency": "BRL",
  "payment_method": "credit_card",
  "due_at": "2017-04-04T00:00:00",
  "paid_at": "2017-04-04T19:41:49",
  "created_at": "2017-04-04T19:41:31",
  "updated_at": "2017-04-04T19:41:31",
  "customer": {
    "id": "cus_aEkwKv0SmNHMR931",
    "name": "Luke Skywalker",
    "email": "lskywalker@r2d2.com",
    "delinquent": false,
    "created_at": "2017-04-04T19:41:31",
    "updated_at": "2017-04-04T19:41:31"
  },
  "last_transaction": {
    "id": "tran_9Rr1xByT8nsxvMbY",
    "transaction_type": "credit_card",
    "gateway_id": "0e3bbc98-cd83-4408-ba05-1bab3cef3bfa",
    "amount": 1490,
    "status": "captured",
    "success": true,
    "installments": 1,
    "statement_descriptor": "Spotify",
    "acquirer_name": "simulator",
    "acquirer_affiliation_code": "MUNDI",
    "acquirer_tid": "532187",
    "acquirer_nsu": "779673",
    "acquirer_auth_code": "458559",
    "acquirer_message": "Simulator|Transação de simulação autorizada com sucesso",
    "acquirer_return_code": "0",
    "operation_type": "auth_and_capture",
    "credit_card": {
      "id": "card_2bKzdEGsYYFkymqG",
      "first_six_digits": "542501",
      "last_four_digits": "5322",
      "brand": "Visa",
      "holder_name": "Luke Skywalker",
      "exp_month": 5,
      "exp_year": 2017,
      "status": "active",
      "created_at": "2017-04-04T19:41:31",
      "updated_at": "2017-04-04T19:41:31",
      "billing_address": {
        "street": "Av. General Justo",
        "number": "375",
        "complement": "9º andar",
        "zip_code": "20021130",
        "neighborhood": "Centro",
        "city": "Rio de Janeiro",
        "state": "RJ",
        "country": "BR"
      }
    },
    "created_at": "2017-04-04T19:41:31",
    "updated_at": "2017-04-04T19:41:31"
  },
  "metadata": {
    "id": "my_charge_id"
  }
}
 
Suggest Edits

Editar metadados da cobrança

 
patchhttps://api.mundipagg.com/core/v1/charges/charge_id/metadata

Path Params

charge_id
string
required

Código da cobrança.

Body Params

metadata
string
required

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

 
{
    "metadata": {
      "code": "12345"
    }
}
		// Neste exemplo estamos utilizando A sdk C# MundiAPI.PCL
    // 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 chargeId = "ch_3rY2xJzh1FY7BZqd";

    var metadata = new Dictionary<string, string> {
        { "code", "12345" }
    };

    var request = new UpdateMetadataRequest {
        Metadata = metadata
    };

    var response = client.Charges.UpdateChargeMetadata(chargeId, request);
A binary file was returned

You couldn't be authenticated

{
    "id": "ch_3rY2xJzh1FY7BZqd",
    "code": "R10KFGXIMZ",
    "gateway_id": "1805994",
    "amount": 1490,
    "status": "pending",
    "currency": "BRL",
    "payment_method": "credit_card",
    "created_at": "2017-08-08T20:22:47Z",
    "updated_at": "2017-08-08T20:22:55Z",
    "customer": {
        "id": "cus_ob5v7gCgqTx9v3gk",
        "name": "Felipe Stark",
        "email": "e8a9c04f-97f2-45f3-a1e5-90e806e3ef34@avengers.com",
        "delinquent": false,
        "created_at": "2017-08-08T20:22:46Z",
        "updated_at": "2017-08-08T20:22:46Z",
        "phones": {}
    },
    "last_transaction": {
        "id": "tran_YNbZPN3HmFx76znM",
        "transaction_type": "credit_card",
        "gateway_id": "1805994",
        "amount": 1490,
        "status": "authorized_pending_capture",
        "success": true,
        "installments": 1,
        "statement_descriptor": "AVENGERS",
        "acquirer_name": "pagarme",
        "acquirer_tid": "1805994",
        "acquirer_nsu": "1805994",
        "acquirer_return_code": "0000",
        "operation_type": "auth_only",
        "card": {
            "id": "card_D5j6xo7IpDIGxJzq",
            "first_six_digits": "455685",
            "last_four_digits": "7525",
            "brand": "Visa",
            "holder_name": "Tony Stark",
            "exp_month": 1,
            "exp_year": 2018,
            "status": "active",
            "created_at": "2017-08-08T20:22:47Z",
            "updated_at": "2017-08-08T20:22:47Z",
            "type": "credit"
        },
        "created_at": "2017-08-08T20:22:47Z",
        "updated_at": "2017-08-08T20:22:47Z",
        "gateway_response": {
            "code": "200"
        }
    },
    "metadata": {
        "code": "12345"
    }
}
{
    "message": "Charge not found."
}
 
Suggest Edits

Editar cartão de cobrança

Esse recurso só pode ser chamado quando o cartão a ser editado teve a transação não autorizada.

 
patchhttps://api.mundipagg.com/core/v1/charges/charge_id/card

Path Params

charge_id
string
required

Código da cobrança.

Body Params

update_subscription
string

Indica se o cartão da assinatura deve ser atualizado

card_id
string

Código do cartão.

card
object

Dados do cartão. Saiba mais sobre cartões.

card_token
string

Token do cartão

 
{
  "card": {
    "number": "342793631858229",
    "holder_name": "Tony Stark",
    "exp_month": 1,
    "exp_year": 20,
    "cvv": "3531",
    "billing_address": {
      "street": "Malibu Point",
      "number": "10880",
      "zip_code": "90265",
      "neighborhood": "Central Malibu",
      "city": "Malibu",
      "state": "CA",
      "country": "US"
    }
  }
}
// Neste exemplo estamos utilizando A sdk C# MundiAPI.PCL
// 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 chargeId = "ch_exRAY21fvNFVD9EX";

var card = new CreateCardRequest
{
    Number = "4532953577256893",
    HolderName = "Tony Stark",
    ExpMonth = 12,
    ExpYear = 18,
    Cvv = "243", 
};
        
var request = new UpdateChargeCardRequest
{
    Card = card
};

var response = client.Charges.UpdateChargeCard(chargeId, request);
A binary file was returned

You couldn't be authenticated

{
  "id": "ch_9R6419s6Btvp4ykO",
  "code": "R8VI5WU79R",
  "gateway_id": "043b7a3c-df2d-4e1b-86a2-5837f9897a60",
  "amount": 14900000,
  "status": "failed",
  "currency": "BRL",
  "payment_method": "credit_card",
  "due_at": "2017-04-04T00:00:00",
  "created_at": "2017-04-04T21:34:32",
  "updated_at": "2017-04-04T21:35:11",
  "customer": {
    "id": "cus_aEkwKv0SmNHMR931",
    "name": "Luke Skywalker",
    "email": "lskywalker@r2d2.com",
    "delinquent": false,
    "created_at": "2017-04-04T19:41:31",
    "updated_at": "2017-04-04T19:41:31"
  },
  "last_transaction": {
    "id": "tran_QMK4mkvcmRSP5Dmv",
    "transaction_type": "credit_card",
    "gateway_id": "f408b4db-ba46-45d3-8c36-7b9ff5816db6",
    "amount": 14900000,
    "status": "not_authorized",
    "success": false,
    "installments": 1,
    "statement_descriptor": "Spotify",
    "acquirer_name": "simulator",
    "acquirer_affiliation_code": "MUNDI",
    "acquirer_tid": "",
    "acquirer_nsu": "",
    "acquirer_auth_code": "",
    "acquirer_message": "Simulator|Transação de simulação não autorizada",
    "acquirer_return_code": "1",
    "operation_type": "auth_only",
    "card": {
      "id": "card_4j2beVVh9U48eR6d",
      "first_six_digits": "342793",
      "last_four_digits": "8229",
      "brand": "Amex",
      "holder_name": "Tony Stark",
      "exp_month": 1,
      "exp_year": 2020,
      "status": "active",
      "created_at": "2017-04-04T21:35:10",
      "updated_at": "2017-04-04T21:35:10"
    },
    "created_at": "2017-04-04T21:35:10",
    "updated_at": "2017-04-04T21:35:10"
  },
  "metadata": {
    "id": "my_charge_id"
  }
}
{
  "message": "This charge may not have changed the card."
}
 
Suggest Edits

Editar data de vencimento da cobrança

 
patchhttps://api.mundipagg.com/core/v1/charges/charge_id/due-date

Path Params

charge_id
string
required

Código da cobrança.

Body Params

due_at
date
required

Data de vencimento.

 
No code samples available
A binary file was returned

You couldn't be authenticated

{
  "id": "ch_9R6419s6Btvp4ykO",
  "code": "R8VI5WU79R",
  "gateway_id": "efda8d57-50d8-4b19-b2d4-873bee2e1b62",
  "amount": 14900000,
  "status": "pending",
  "currency": "BRL",
  "payment_method": "boleto",
  "due_at": "2017-04-04T00:00:00",
  "created_at": "2017-04-04T21:34:32",
  "updated_at": "2017-04-04T21:44:05",
  "customer": {
    "id": "cus_aEkwKv0SmNHMR931",
    "name": "Luke Skywalker",
    "email": "lskywalker@r2d2.com",
    "delinquent": false,
    "created_at": "2017-04-04T19:41:31",
    "updated_at": "2017-04-04T19:41:31"
  },
  "last_transaction": {
    "id": "tran_E3r7OrMh3hbjvwKj",
    "transaction_type": "boleto",
    "gateway_id": "19372a76-a8de-4017-aa91-8c9d21c34185",
    "amount": 14900000,
    "status": "generated",
    "success": true,
    "url": "https://sandbox.mundipaggone.com/Boleto/ViewBoleto.aspx?19372a76-a8de-4017-aa91-8c9d21c34185",
    "pdf": "https://api.mundipagg.com/core/v1.0/transactions/tran_E3r7OrMh3hbjvwKj/pdf",
    "line": "34191.75009 03073.581237 41234.510000 2 71240014900000",
    "barcode": "https://api.mundipagg.com/core/v1.0/transactions/tran_E3r7OrMh3hbjvwKj/barcode",
    "qr_code": "https://api.mundipagg.com/core/v1.0/transactions/tran_E3r7OrMh3hbjvwKj/qrcode",
    "nosso_numero": "00030735",
    "bank": "001",
    "document_number": "094408333",
    "created_at": "2017-04-04T21:44:05",
    "updated_at": "2017-04-04T21:44:05"
  },
  "metadata": {
    "id": "my_charge_id"
  }
}
 
Suggest Edits

Editar método de pagamento

 
patchhttps://api.mundipagg.com/core/v1/charges/charge_id/payment-method

Path Params

charge_id
string
required

Código da cobrança.

Body Params

update_subscription
string

Indica se o meio de pagamento da assinatura deve ser atualizado

payment_method
string
required

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

credit_card
object

Dados sobre o pagamento com cartão de crédito (obrigatório caso 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 payment_method seja voucher). Saiba mais sobre pagamentos com voucher

boleto
object

Dados sobre o pagamento com boleto (obrigatório caso 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 payment_method seja bank_transfer). Saiba mais sobre pagamentos com transferência entre contas

 
{
    "payment_method": "boleto",
    "boleto": {
      "bank": "033",
      "instructions": "Pagar até o vencimento",
      "due_at": "2020-12-31"
    }
}
    // Neste exemplo estamos utilizando A sdk C# MundiAPI.PCL    
    // 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 chargeId = "ch_exRAY21fvNFVD9EX";

    var request = new UpdateChargePaymentMethodRequest {
        PaymentMethod = "boleto",
        Boleto = new CreateBoletoPaymentRequest {
            Bank = "033",
            Instructions = "Pagar até o vencimento",
            DueAt = DateTime.UtcNow.AddDays(2)
        }
    };

    var response = client.Charges.UpdateChargePaymentMethod(chargeId, request);
A binary file was returned

You couldn't be authenticated

{
    "id": "ch_PA2gLJYc9hDxRrXV",
    "code": "DPRWS1C38N",
    "gateway_id": "c22a0e61-2e3e-4317-b11f-08d03046a1a8",
    "amount": 1490000,
    "status": "pending",
    "currency": "BRL",
    "payment_method": "boleto",
    "created_at": "2017-10-05T19:16:51Z",
    "updated_at": "2017-10-05T19:18:39Z",
    "customer": {
        "id": "cus_9rOWDePfdC5qRYgE",
        "name": "Tony Stark",
        "email": "a999087b-1fa2-4ed9-8499-5065ebc2a46a@avengers.com",
        "delinquent": false,
        "created_at": "2017-10-05T19:16:51Z",
        "updated_at": "2017-10-05T19:16:51Z",
        "phones": {}
    },
    "last_transaction": {
        "id": "tran_OX28mah1bSP084wB",
        "transaction_type": "boleto",
        "gateway_id": "659298db-dcae-492a-afc5-47774026ca9f",
        "amount": 1490000,
        "status": "generated",
        "success": true,
        "url": "https://sandbox.mundipaggone.com/Boleto/ViewBoleto.aspx?659298db-dcae-492a-afc5-47774026ca9f",
        "pdf": "https://api.mundipagg.com/core/v1/transactions/tran_OX28mah1bSP084wB/pdf",
        "line": "34191.75009 05636.791237 41234.510000 8 84860001490000",
        "barcode": "https://api.mundipagg.com/core/v1/transactions/tran_OX28mah1bSP084wB/barcode",
        "qr_code": "https://api.mundipagg.com/core/v1/transactions/tran_OX28mah1bSP084wB/qrcode",
        "nosso_numero": "00056367",
        "bank": "033",
        "document_number": "071838848",
        "instructions": "Pagar até o vencimento",
        "due_at": "2020-12-31T00:00:00Z",
        "created_at": "2017-10-05T19:18:39Z",
        "updated_at": "2017-10-05T19:18:39Z",
        "gateway_response": {
            "code": "201"
        }
    },
    "metadata": {
        "code": "123"
    }
}
{
    "message": "This charge can't have the payment method changed."
}
 
Suggest Edits

Cancelar cobrança

 
deletehttps://api.mundipagg.com/core/v1/charges/charge_id

Path Params

charge_id
string
required

Código da cobrança.

Body Params

amount
int32

Valor a ser cancelado. Caso não seja informado, será considerado o valor total da cobrança.

 
    // Neste exemplo estamos utilizando A sdk C# MundiAPI.PCL     
    // 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 chargeId = "ch_exRAY21fvNFVD9EX";
  
    var response = client.Charges.CancelCharge(chargeId);
A binary file was returned

You couldn't be authenticated

{
  "id": "ch_M70jWWwFN8T1j8Wz",
  "code": "4QJ5BXDSKE",
  "gateway_id": "1585fc8f-6afa-4e4e-b75a-2f7131557c7d",
  "status": "canceled",
  "currency": "BRL",
  "payment_method": "credit_card",
  "paid_at": "2017-05-09T14:04:39Z",
  "canceled_at": "2017-05-09T14:04:44Z",
  "created_at": "2017-05-09T14:04:39Z",
  "updated_at": "2017-05-09T14:04:44Z",
  "customer": {
    "id": "cus_mBloKMLnswtD4O3a",
    "name": "Tony Stark",
    "email": "carlospecanha@outlook.com",
    "delinquent": false,
    "created_at": "2016-10-07T19:50:39Z",
    "updated_at": "2017-04-24T21:13:04Z",
    "phones": {},
    "metadata": {
      "company": "MundiPagg",
      "nome_da_mae": "Maria"
    }
  },
  "last_transaction": {
    "id": "tran_o8BJeXvUDPsLMqb6",
    "transaction_type": "credit_card",
    "gateway_id": "70b4da27-1d84-40d1-84d8-9530a0bc3034",
    "amount": 200,
    "status": "voided",
    "success": true,
    "acquirer_name": "simulator",
    "acquirer_affiliation_code": "MUNDI",
    "acquirer_tid": "319658",
    "acquirer_nsu": "933095",
    "acquirer_auth_code": "133806",
    "operation_type": "cancel",
    "card": {
      "id": "card_vY1L4g5UeAsWZKw3",
      "first_six_digits": "542501",
      "last_four_digits": "5580",
      "brand": "Visa",
      "holder_name": "Tony Stark",
      "exp_month": 1,
      "exp_year": 2018,
      "status": "active",
      "created_at": "2017-01-03T18:57:57Z",
      "updated_at": "2017-01-03T18:57:57Z",
      "billing_address": {
        "street": "Malibu Point",
        "number": "10881",
        "zip_code": "90265",
        "neighborhood": "Central Malibu",
        "city": "Malibu",
        "state": "CA",
        "country": "US"
      }
    },
    "created_at": "2017-05-09T14:04:44Z",
    "updated_at": "2017-05-09T14:04:44Z",
    "gateway_response": {
      "code": "200"
    }
  }
}
 
Suggest Edits

Listar cobranças

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

Query Params

code
string

Código de referência da cobrança no sistema da loja

status
string

Status da cobrança. Valores possíveis: pending, paid, canceled, processing, failed, overpaid ou underpaid

payment_method
string

Meio de pagamento. Valores possíveis: credit_card, boleto, bank_transfer, safetypay ou voucher

customer_id
string

Código do cliente.

order_id
string

Código do pedido.

created_since
date

Data de início do período de criação a ser listado.

created_until
date

Data de final do período de criação a ser listado.

page
int32

Página atual.

size
int32

Quantidade de itens por página.


Paginação

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

    // Neste exemplo estamos utilizando A sdk C# MundiAPI.PCL    
    // 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.Charges.GetCharges();
A binary file was returned

You couldn't be authenticated

{
  "data": [
    {
      "id": "ch_exRAY21fvNFVD9EX",
      "code": "9L6PBE8I70",
      "gateway_id": "934dc0dd-4b4e-4f72-941b-d9fcb6ca2b65",
      "amount": 2990,
      "status": "paid",
      "currency": "BRL",
      "payment_method": "credit_card",
      "due_at": "2017-04-04T00:00:00",
      "paid_at": "2017-04-04T19:51:01",
      "created_at": "2017-04-04T19:51:00",
      "updated_at": "2017-04-04T19:51:00",
      "order": {
        "id": "or_07d5VN8hxlFlY1GK",
        "code": "9L6PBE8I70",
        "amount": 2990,
        "currency": "BRL",
        "closed": true,
        "status": "paid",
        "created_at": "2017-04-04T19:51:00",
        "updated_at": "2017-04-04T19:51:01",
        "closed_at": "2017-04-04T19:51:01"
      },
      "customer": {
        "id": "cus_DzZP26RFe5cyP0nY",
        "name": "Tony Stark",
        "email": "a9bbfc80-58a1-4999-bdd9-e9284abf6c79@avengers.com",
        "delinquent": false,
        "created_at": "2017-04-04T19:51:00",
        "updated_at": "2017-04-04T19:51:00"
      },
      "last_transaction": {
        "id": "tran_1RlLK6ZTDKU0QOPm",
        "transaction_type": "credit_card",
        "gateway_id": "8e4205e9-1517-43fa-93dc-2746840da9e3",
        "amount": 2990,
        "status": "captured",
        "success": true,
        "installments": 1,
        "statement_descriptor": "AVENGERS",
        "acquirer_name": "simulator",
        "acquirer_affiliation_code": "MUNDI",
        "acquirer_tid": "394106",
        "acquirer_nsu": "975196",
        "acquirer_auth_code": "534636",
        "acquirer_message": "Simulator|Transação de simulação autorizada com sucesso",
        "acquirer_return_code": "0",
        "operation_type": "auth_and_capture",
        "credit_card": {
          "id": "card_doRmZrwKCDtDWVwX",
          "first_six_digits": "542501",
          "last_four_digits": "8229",
          "brand": "Amex",
          "holder_name": "Tony Stark",
          "exp_month": 1,
          "exp_year": 2018,
          "status": "active",
          "created_at": "2017-04-04T19:51:00",
          "updated_at": "2017-04-04T19:51:00",
          "billing_address": {
            "street": "Malibu Point",
            "number": "10880",
            "zip_code": "90265",
            "neighborhood": "Central Malibu",
            "city": "Malibu",
            "state": "CA",
            "country": "US"
          }
        },
        "created_at": "2017-04-04T19:51:00",
        "updated_at": "2017-04-04T19:51:00"
      }
    }
  ],
  "paging": {
    "total": 1
  }
}
 
Suggest Edits

Retentar uma cobrança manualmente

 
posthttps://api.mundipagg.com/core/v1/charges/charge_id/retry

Path Params

charge_id
string
required

Código da cobrança.


A Mundipagg oferece métodos de RETENTATIVA AUTOMÁTICA !

  • Retentativa Automática: reprocessa automaticamente na mesma ou em outra adquirente, as transações não autorizadas, de acordo com a configuração programada.

  • Retentativa Offline: visa recuperar cobranças não autorizadas, sendo configuradas através da unidade de medida hora, tendo como base a última tentativa.

Saiba mais sobre os retentativas através de nossa documentação de negócios ou entrando em contato conosco através de suporte@mundipagg.com!

     // Neste exemplo estamos utilizando A sdk C# MundiAPI.PCL
		// 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 chargeId = "ch_exRAY21fvNFVD9EX";

    var response = client.Charges.RetryCharge(chargeId);
A binary file was returned

You couldn't be authenticated

{
  "id": "ch_exRAY21fvNFVD9EX",
  "code": "8M2OT2SRX8",
  "gateway_id": "c5d71b01-174e-453f-8563-fd089cf7b39b",
  "amount": 14900000,
  "status": "failed",
  "currency": "BRL",
  "payment_method": "credit_card",
  "due_at": "2017-04-04T00:00:00",
  "created_at": "2017-04-04T22:29:33",
  "updated_at": "2017-04-04T22:29:54",
  "customer": {
    "id": "cus_aEkwKv0SmNHMR931",
    "name": "Luke Skywalker",
    "email": "lskywalker@r2d2.com",
    "delinquent": false,
    "created_at": "2017-04-04T19:41:31",
    "updated_at": "2017-04-04T19:41:31"
  },
  "last_transaction": {
    "id": "tran_dZm79oYT0ckRlw1o",
    "transaction_type": "credit_card",
    "gateway_id": "f3c316f7-3f6c-47bc-ac03-da01e51444aa",
    "amount": 14900000,
    "status": "not_authorized",
    "success": false,
    "installments": 1,
    "statement_descriptor": "Spotify",
    "acquirer_name": "simulator",
    "acquirer_affiliation_code": "MUNDI",
    "acquirer_tid": "",
    "acquirer_nsu": "",
    "acquirer_auth_code": "",
    "acquirer_message": "Simulator|Transação de simulação não autorizada",
    "acquirer_return_code": "1",
    "operation_type": "auth_only",
    "credit_card": {
      "id": "card_2bKzdEGsYYFkymqG",
      "first_six_digits": "542501",
      "last_four_digits": "5322",
      "brand": "Visa",
      "holder_name": "Luke Skywalker",
      "exp_month": 5,
      "exp_year": 2017,
      "status": "active",
      "created_at": "2017-04-04T19:41:31",
      "updated_at": "2017-04-04T19:41:31",
      "billing_address": {
        "street": "Av. General Justo",
        "number": "375",
        "complement": "9º andar",
        "zip_code": "20021130",
        "neighborhood": "Centro",
        "city": "Rio de Janeiro",
        "state": "RJ",
        "country": "BR"
      }
    },
    "created_at": "2017-04-04T22:29:33",
    "updated_at": "2017-04-04T22:29:33"
  },
  "metadata": {
    "id": "my_charge_id"
  }
}
 
Suggest Edits

Confirmar cobrança (cash)

Para a confirmação de cobranças com meio de pagamento cash com o status pending.

 
posthttps://api.mundipagg.com/core/v1/charges/charge_id/confirm-payment

Path Params

charge_id
string
required

Código da cobrança.

Body Params

amount
string

Valor a ser confirmado. Caso não seja informado, será considerado o valor total da cobrança

code
string

Código da cobrança no sistema da loja. Irá atualizar o valor informado na criação da cobrança. Max: 52 caracteres

description
string

Descrição

 
{
  "amount":"100",
  "code":"ABCDE123"
  "description": "teste"
}
    // Neste exemplo estamos utilizando A sdk C# MundiAPI.PCL
    // 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 chargeId = "ch_exRAY21fvNFVD9EX";
            
    // Opcional
    var request = new CreateCaptureChargeRequest {
        Amount = 100,
        Code = "ABCDE123"
    };

    var response = client.Charges.CaptureCharge(chargeId, request);
A binary file was returned

You couldn't be authenticated

{
  "id": "ch_7YBoBPWCVKS3QdyM",
  "code": "WZQS3LHEKW",
  "gateway_id": "42c243c4-0b52-49f3-ba92-e8661ebc7916",
  "amount": 1490,
  "status": "paid",
  "currency": "BRL",
  "payment_method": "credit_card",
  "due_at": "2017-04-04T00:00:00",
  "paid_at": "2017-04-04T20:06:14",
  "created_at": "2017-04-04T20:05:39",
  "updated_at": "2017-04-04T20:06:14",
  "customer": {
    "id": "cus_aEkwKv0SmNHMR931",
    "name": "Luke Skywalker",
    "email": "lskywalker@r2d2.com",
    "delinquent": false,
    "created_at": "2017-04-04T19:41:31",
    "updated_at": "2017-04-04T19:41:31"
  },
  "last_transaction": {
    "id": "tran_9KYq34mcDfOnXg1Z",
    "transaction_type": "credit_card",
    "gateway_id": "d8033a7c-2d31-4840-8870-8a71bd16cacc",
    "amount": 1490,
    "status": "captured",
    "success": true,
    "installments": 1,
    "statement_descriptor": "Spotify",
    "acquirer_name": "simulator",
    "acquirer_affiliation_code": "MUNDI",
    "acquirer_tid": "856202",
    "acquirer_nsu": "503081",
    "acquirer_auth_code": "405205",
    "operation_type": "capture",
    "credit_card": {
      "id": "card_2bKzdEGsYYFkymqG",
      "first_six_digits": "542501",
      "last_four_digits": "5322",
      "brand": "Visa",
      "holder_name": "Luke Skywalker",
      "exp_month": 5,
      "exp_year": 2017,
      "status": "active",
      "created_at": "2017-04-04T19:41:31",
      "updated_at": "2017-04-04T19:41:31",
      "billing_address": {
        "street": "Av. General Justo",
        "number": "375",
        "complement": "9º andar",
        "zip_code": "20021130",
        "neighborhood": "Centro",
        "city": "Rio de Janeiro",
        "state": "RJ",
        "country": "BR"
      }
    },
    "created_at": "2017-04-04T20:06:14",
    "updated_at": "2017-04-04T20:06:14"
  },
  "metadata": {
    "id": "my_charge_id"
  }
}
{
  "message": "This charge can not be captured."
}
 
Suggest Edits

Pedidos

Para realizar pedidos de cartão de crédito ou boleto, você deve criar um objeto order. Este objeto tem os seguintes atributos:

 
Atributos
Tipo
Descrição

id

string

Código do pedido. Formato: or_XXXXXXXXXXXXXXXX

currency

string

Moeda. Valor possível: BRL.

status

string

Status do pedido. Possíveis valores: Pending, Paid, Canceled, Failed.

code

string

Código identificador do pedido no sistema da loja.

customer

object

Dados do cliente. Saiba mais sobre clientes.

shipping

object

Dados para entrega. Saiba mais sobre entregas.

charges

array of object

Lista de dados de cobrança. Saiba mais sobre cobranças.

items

object

closed

boolean

Indica se o pedido fechado. Valor padrão: true.

created_at

datetime

Data de criação do pedido.

metadata

object

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

Pedidos Abertos e Fechados

Existem duas opções de pedido: Pedido Aberto e Pedido Fechado, de acordo com o atributo closed.
Um pedido fechado, ou seja, "closed" : "true", não pode sofrer interação.
Um pedido aberto, isto é, "closed" : "false", pode sofrer interação após sua criação.

Caso o pedido seja criado como aberto, ou seja, o atributo "closed" : "false", seu status não será alterado para 'paid' até que seja ele seja fechado manualmente. Saiba mais sobre fechamento de pedidos.

Vale ressaltar que seu status não será mudado para pago, ainda que todas as suas cobranças estejam pagas.

 
Suggest Edits

Criar pedido

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

Body Params

code
string

Código identificador do pedido no sistema da loja. Max: 52 caracteres.

customer_id
string
required

Código do cliente. Obrigatório, caso não seja informado o objeto customer

customer
object
required

Dados do cliente. Obrigatório caso o customer_id não seja informado. Saiba mais sobre clientes

items
array
required

Itens do pedido. Saiba mais sobre itens do pedido

shipping
object

Dados para entrega. Saiba mais sobre entregas

payments
array
required

Dados de pagamento. Saiba mais sobre pagamentos

closed
boolean

Informa se o pedido será criado aberto ou fechado.

metadata
string

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

device
object

Dados do dispositivo

location
object

Dados de geolocalização

ip
string

Endereço IP do dispositivo que solicitou a compra

session_id
string

Código da sessão do usuário

antifraud_enabled
boolean

Indica se o pedido passará ou não pelo antifraude. Se não for enviado, será considerada a configuração da conta


NÃO ENVIE DADOS ABERTOS DO CARTÃO DO COMPRADOR

Para poder trafegar dados de cartão abertos em seu servidor, você deve ser PCI Compliance. Por isso, recomendamos fortemente que as requisições sejam enviadas sempre usando o card_id ou card_token, de forma que você não precise trafegar os dados de cartão no seu servidor.

DADOS DO COMPRADOR SÃO OBRIGATÓRIOS

Caso seja informado o customer_id, não é necessário incluir o objeto customer. Entretanto, é obrigatório que um desses parâmetros seja informado.

{
    "items": [
        {
            "amount": 2990,
            "description": "Chaveiro do Tesseract",
            "quantity": 1
        }
    ],
    "customer": {
        "name": "Tony Stark",
        "email": "avengerstark@ligadajustica.com.br"
    },
    "ip": "52.168.67.32",
    "location": {
        "latitude": "-22.970722",
        "longitude": "43.182365"
    },
    "shipping": {
        "amount": 100,
        "description": "Stark",
        "recipient_name": "Tony Stark",
        "recipient_phone": "24586787867",
        "address": {
            "line_1": "10880, Malibu Point, Malibu Central",
            "zip_code": "90265",
            "city": "Malibu",
            "state": "CA",
            "country": "US"    
        }
    },
    "session_id": "322b821a",
    "device": {
        "platform": "ANDROID OS"
    },
    "payments": [
        {
            "payment_method": "credit_card",
            "credit_card": {
                "recurrence": false,
                "installments": 1,
                "statement_descriptor": "AVENGERS",
                "card": {
                    "number": "342793631858229",
                    "holder_name": "Tony Stark",
                    "exp_month": 1,
                    "exp_year": 20,
                    "cvv": "3531",
                    "billing_address": {
                        "line_1": "10880, Malibu Point, Malibu Central",
                        "zip_code": "90265",
                        "city": "Malibu",
                        "state": "CA",
                        "country": "US"                
                    }
                }
            }
        }
    ]
}
{
  "items": [
    {
      "amount": 2990,
      "description": "Chaveiro do Tesseract",
      "quantity": 1
    }
  ],
  "customer": {
    "name": "Tony Stark",
    "email": "avengerstark@ligadajustica.com.br"
  },
  "payments": [{
    "payment_method": "credit_card",
    "credit_card": {
      "installments": 1,
      "statement_descriptor": "AVENGERS",
      "card_token": "token_zVw7rqvHEPH8XlbE"
    }
  }]
}
{
  "items": [
    {
      "amount": 2990,
      "description": "Chaveiro do Tesseract",
      "quantity": 1
    }
  ],
  "customer": {
    "name": "Tony Stark",
    "email": "avengerstark@ligadajustica.com.br"
  },
  "payments": [{
    "payment_method": "credit_card",
    "credit_card": {
      "installments": 1,
      "statement_descriptor": "AVENGERS",
      "card_id": "card_oqyg5aZuP2zK1dja",
      "card": {
        "cvv": "123"
      }
    }
  }]
}
     // Neste exemplo estamos utilizando A sdk C# MundiAPI.PCL
     // 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 items = new List<CreateOrderItemRequest> {
         new CreateOrderItemRequest {
         Amount = 2990,
         Description = "Chaveiro do Tesseract",
         Quantity = 1
         }
     };
     var customer = new CreateCustomerRequest {
         Name = "Tony Stark",
         Email = "tonystark@avengers.com",
     };

     var payments = new List<CreatePaymentRequest> {
         new CreatePaymentRequest {
         PaymentMethod = "credit_card",
         CreditCard = new CreateCreditCardPaymentRequest {
         Card = new CreateCardRequest {
         HolderName = "Tony Stark",
         Number = "342793631858229",
         ExpMonth = 1,
         ExpYear = 18,
         Cvv = "3531",
         }
         }
         }
     };
     var request = new CreateOrderRequest {
         Items = items,
         Customer = customer,
         Payments = payments
     };

     var response = client.Orders.CreateOrder (request);
A binary file was returned

You couldn't be authenticated

{
    "id": "or_28dN9w7CLU79kDjL",
    "code": "62LVFN7I4R",
    "amount": 2990,
    "currency": "BRL",
    "closed": true,
    "items": [
        {
            "id": "oi_d478RMAS3bC74PrL",
            "description": "Chaveiro do Tesseract",
            "amount": 2990,
            "quantity": 1,
            "status": "active",
            "created_at": "2017-04-19T16:01:09Z",
            "updated_at": "2017-04-19T16:01:09Z"
        }
    ],
    "customer": {
        "id": "cus_eaEXlZvhBfeGlDOm",
        "name": "Tony Stark",
        "email": "f1492621-4f39-45f7-adfb-82a373a0a85c@avengers.com",
        "delinquent": false,
        "created_at": "2017-04-19T16:01:09Z",
        "updated_at": "2017-04-19T16:01:09Z"
    },
    "shipping": {
        "amount": 100,
        "description": "Stark",
        "recipient_name": "Tony Stark",
        "recipient_phone": "24586787867",
        "address": {
            "line_1": "10880, Malibu Point, Malibu Central",
            "zip_code": "90265",
            "city": "Malibu",
            "state": "CA",
            "country": "US"    
        }
    },
    "status": "paid",
    "created_at": "2017-04-19T16:01:09Z",
    "updated_at": "2017-04-19T16:01:11Z",
    "closed_at": "2017-04-19T16:01:11Z",
    "charges": [
        {
            "id": "ch_gmnW101c9YTvQVLB",
            "code": "62LVFN7I4R",
            "gateway_id": "ef5e977b-93d2-485a-b15d-36e5eb3d8cf5",
            "amount": 2990,
            "status": "paid",
            "currency": "BRL",
            "payment_method": "credit_card",
            "paid_at": "2017-04-19T16:01:11Z",
            "created_at": "2017-04-19T16:01:09Z",
            "updated_at": "2017-04-19T16:01:09Z",
            "customer": {
                "id": "cus_eaEXlZvhBfeGlDOm",
                "name": "Tony Stark",
                "email": "f1492621-4f39-45f7-adfb-82a373a0a85c@avengers.com",
                "delinquent": false,
                "created_at": "2017-04-19T16:01:09Z",
                "updated_at": "2017-04-19T16:01:09Z"
            },
            "last_transaction": {
                "id": "tran_3RYbBQjcnEcwrGp0",
                "transaction_type": "credit_card",
                "gateway_id": "ddab707d-72ba-49f9-b356-f0b9ebfa3039",
                "amount": 2990,
                "status": "captured",
                "success": true,
                "installments": 1,
                "statement_descriptor": "AVENGERS",
                "acquirer_name": "simulator",
                "acquirer_affiliation_code": "MUNDI",
                "acquirer_tid": "342793",
                "acquirer_nsu": "512784",
                "acquirer_auth_code": "233215",
                "acquirer_message": "Stone|Transação autorizada com sucesso",
                "acquirer_return_code": "0",
                "operation_type": "auth_and_capture",
                "card": {
                    "id": "card_6xk9deAu2I2MdPzJ",
                    "first_six_digits": "542501",
                    "last_four_digits": "8229",
                    "brand": "Amex",
                    "holder_name": "Tony Stark",
                    "exp_month": 1,
                    "exp_year": 2020,
                    "status": "active",
                    "created_at": "2017-04-19T16:01:09Z",
                    "updated_at": "2017-04-19T16:01:09Z",
                    "billing_address": {
                        "line_1": "10880, Malibu Point, Malibu Central",
                        "zip_code": "90265",
                        "city": "Malibu",
                        "state": "CA",
                        "country": "US"                
                    },
                    "type": "credit"
                },
                "created_at": "2017-04-19T16:01:09Z",
                "updated_at": "2017-04-19T16:01:09Z",
                "gateway_response": {
                    "code": "201"
                }
            }
        }
    ]
}
{
    "message": "Authorization has been denied for this request."
}
 
Suggest Edits

Incluir cobrança no pedido

Enquanto um pedido estiver aberto, é possível adicionar novas cobranças utilizando o order_id na criação de uma cobrança.

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

Body Params

order_id
string
required

Código do pedido

amount
int32
required

Valor da cobrança em centavos

payment
object
required

Dados sobre pagamento. Saiba mais sobre pagamentos

due_at
date

Data de vencimento da cobrança.

customer_id
string

Código do cliente.

customer
object

Dados do cliente. Se nem o customer_id nem o customer forem informados, será considerado o mesmo cliente do pedido. Saiba mais sobre clientes

metadata
string

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

 
{
  "order_id": "or_gnvV6V1VTgspL4JB",
  "amount": 2990,
  "payment": {
    "payment_method": "credit_card",
    "credit_card": {
      "installments": 1,
      "statement_descriptor": "AVENGERS",
      "card": {
        "number": "342793631858229",
        "holder_name": "Tony Stark",
        "exp_month": 1,
        "exp_year": 18,
        "cvv": "3531",
        "billing_address": {
          "street": "Malibu Point",
          "number": "10881",
          "zip_code": "90265",
          "neighborhood": "Central Malibu",
          "city": "Malibu",
          "state": "CA",
          "country": "US"
        }
      }
    }
  }
}
A binary file was returned

You couldn't be authenticated

{
  "id": "ch_xyRZw5XCLhl3ENjP",
  "code": "LM4AVYSYQ9",
  "gateway_id": "769e2123-a634-46dc-8bba-529bba7fb726",
  "amount": 2990,
  "status": "paid",
  "currency": "BRL",
  "payment_method": "credit_card",
  "due_at": "2017-04-05T00:00:00",
  "paid_at": "2017-04-05T05:51:44",
  "created_at": "2017-04-05T05:51:37",
  "updated_at": "2017-04-05T05:51:37",
  "order": {
    "id": "or_gnvV6V1VTgspL4JB",
    "code": "MW6JTXGA2V",
    "amount": 2990,
    "currency": "BRL",
    "closed": false,
    "status": "pending",
    "created_at": "2017-04-05T05:51:09",
    "updated_at": "2017-04-05T05:51:09"
  },
  "customer": {
    "id": "cus_o9m12XMfrWtYKdLM",
    "name": "Tony Stark",
    "email": "e44655d3-455a-47bd-a86b-4f537aad95b5@avengers.com",
    "delinquent": false,
    "created_at": "2017-04-05T05:51:09",
    "updated_at": "2017-04-05T05:51:09"
  },
  "last_transaction": {
    "id": "tran_Bo9LkGUjjiBXLpWk",
    "transaction_type": "credit_card",
    "gateway_id": "3b0764c0-6940-4961-bac1-db5be550448a",
    "amount": 2990,
    "status": "captured",
    "success": true,
    "installments": 1,
    "statement_descriptor": "AVENGERS",
    "acquirer_name": "simulator",
    "acquirer_affiliation_code": "MUNDI",
    "acquirer_tid": "270896",
    "acquirer_nsu": "813228",
    "acquirer_auth_code": "984353",
    "acquirer_message": "Stone|Transação autorizada com sucesso",
    "acquirer_return_code": "0",
    "operation_type": "auth_and_capture",
    "credit_card": {
      "id": "card_09eV0PrfQKClNVOd",
      "last_four_digits": "8229",
      "brand": "Amex",
      "holder_name": "Tony Stark",
      "exp_month": 1,
      "exp_year": 2018,
      "status": "active",
      "created_at": "2017-04-05T05:51:37",
      "updated_at": "2017-04-05T05:51:37",
      "billing_address": {
        "street": "Malibu Point",
        "number": "10881",
        "zip_code": "90265",
        "neighborhood": "Central Malibu",
        "city": "Malibu",
        "state": "CA",
        "country": "US"
      }
    },
    "created_at": "2017-04-05T05:51:37",
    "updated_at": "2017-04-05T05:51:37"
  }
}
 
Suggest Edits

Criar pedido multimeios

Neste caso você inclui mais de um objeto na coleção de payments. Desta maneira você pode realizar pedido com diversos cartões ou combinando diferentes meios de pagamento.

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

Body Params

code
string

Código identificador do pedido no sistema da loja. Max: 52 caracteres.

items
array
required

Itens do pedido. Saiba mais sobre item do pedido

customer_id
string

Código do cliente.

customer
object

Dados do cliente. Saiba mais sobre clientes.

shipping
object

Dados para entrega. Saiba mais sobre entregas

payments
array
required

Lista de dados de pagamento. Saiba mais sobre pagamentos.

closed
boolean

Informa se o pedido será criado aberto ou fechado

metadata
string

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


MULTIMEIOS DEVEM TER SEUS VALORES DISCRIMINADOS SEPARADAMENTE

Portanto, cada objeto dentro payments deverá ter seu próprio valor, bastando para isso incluir a propriedade amount com o valor correspondente ao de cada um dos meios de pagamento escolhidos. A resposta conterá além dos valores separados, um campo amount com a soma do todos os meios utilizados, que representa o valor total do pedido.

{
   "items":[
      {
         "amount":2990,
         "description":"Chaveiro do Tesseract",
         "quantity":1
      }
   ],
   "customer":{
      "name":"Tony Stark",
      "email":"tstark@avengers.com"
   },
   "payments":[
      {
         "amount":990,
         "payment_method":"credit_card",
         "credit_card":{
            "statement_descriptor":"AVENGERS",
            "card":{
               "number":"4024007131429325",
               "holder_name":"TONY STARK",
               "exp_month":1,
               "exp_year":20,
               "cvv":"353"
            }
         }
      },
      {
         "amount":2000,
         "payment_method":"boleto",
         "boleto": {
      "bank": "033",
      "instructions": "Pagar até o vencimento",
      "due_at": "2020-12-31T00:00:00Z"
         }
      }
   ]
}
    // Neste exemplo estamos utilizando A sdk C# MundiAPI.PCL
    string basicAuthUserName = "sk_test_4tdVXpseumRmqbo";
    // Senha em branco. Passando apenas a secret key
    string basicAuthPassword = "";

    var client = new MundiAPIClient(basicAuthUserName, basicAuthPassword);
    var items = new List<CreateOrderItemRequest> {
    new CreateOrderItemRequest{

    Amount = 2990,
    Description = "Chaveiro do Tesseract",
    Quantity = 1
    }
    };

    var customer = new CreateCustomerRequest {
        Name = "Tony Stark",
        Email = "tonystark@avengers.com",
    };

    var payments = new List<CreatePaymentRequest> {
    new CreatePaymentRequest {

    PaymentMethod = "credit_card",
    Amount = 990,
    CreditCard = new CreateCreditCardPaymentRequest {
          Card = new CreateCardRequest {
    HolderName = "Tony Stark",
    Number ="342793631858229",
    ExpMonth = 1,
    ExpYear =18,
    Cvv = "3531",
}
}
},
   new CreatePaymentRequest {
        Amount = 2000,
        PaymentMethod = "boleto",
        Boleto = new CreateBoletoPaymentRequest{
            Bank = "033",
            Instructions = "Pagar até o vencimento",
            DueAt = DateTime.UtcNow
},
}
};

var request = new CreateOrderRequest {
    Items = items,
    Customer = customer,
    Payments = payments
};

var response = client.Orders.CreateOrder(request);
A binary file was returned

You couldn't be authenticated

{
    "id": "or_qn6z3jyH6ofnvDxe",
    "code": "D7W5UYES79",
    "amount": 2990,
    "currency": "BRL",
    "closed": true,
    "items": [
        {
            "id": "oi_bV7BV2kTRwhPGBAa",
            "description": "Chaveiro do Tesseract",
            "amount": 2990,
            "quantity": 1,
            "status": "active",
            "created_at": "2017-06-23T20:17:24Z",
            "updated_at": "2017-06-23T20:17:24Z"
        }
    ],
    "customer": {
        "id": "cus_l6MdrlRIZIbknz7O",
        "name": "Tony Stark",
        "email": "tstark@avengers.com",
        "delinquent": false,
        "created_at": "2017-06-23T20:17:24Z",
        "updated_at": "2017-06-23T20:17:24Z",
        "phones": {}
    },
    "status": "pending",
    "created_at": "2017-06-23T20:17:24Z",
    "updated_at": "2017-06-23T20:17:24Z",
    "closed_at": "2017-06-23T20:17:26Z",
    "charges": [
        {
            "id": "ch_YMAJljjF1TvmlGOn",
            "code": "D7W5UYES79",
            "gateway_id": "9821b308-5996-4791-8698-ec5a9918c000",
            "amount": 990,
            "status": "paid",
            "currency": "BRL",
            "payment_method": "credit_card",
            "paid_at": "2017-06-23T20:17:25Z",
            "created_at": "2017-06-23T20:17:25Z",
            "updated_at": "2017-06-23T20:17:25Z",
            "customer": {
                "id": "cus_l6MdrlRIZIbknz7O",
                "name": "Tony Stark",
                "email": "tstark@avengers.com",
                "delinquent": false,
                "created_at": "2017-06-23T20:17:24Z",
                "updated_at": "2017-06-23T20:17:24Z",
                "phones": {}
            },
            "last_transaction": {
                "id": "tran_kAYwXOoSjSnblKPV",
                "transaction_type": "credit_card",
                "gateway_id": "5e55c240-0241-4d06-9072-a41a02dc62f1",
                "amount": 990,
                "status": "captured",
                "success": true,
                "installments": 1,
                "statement_descriptor": "AVENGERS",
                "acquirer_name": "simulator",
                "acquirer_affiliation_code": "000000000",
                "acquirer_tid": "999839",
                "acquirer_nsu": "419652",
                "acquirer_auth_code": "105578",
                "acquirer_message": "Simulator|Transação de simulação autorizada com sucesso",
                "acquirer_return_code": "0",
                "operation_type": "auth_and_capture",
                "card": {
                    "id": "card_NZ4E4DYSbbsNLEDa",
                    "first_six_digits": "402400",
                    "last_four_digits": "9325",
                    "brand": "Visa",
                    "holder_name": "TONY STARK",
                    "exp_month": 1,
                    "exp_year": 2020,
                    "status": "active",
                    "created_at": "2017-06-23T20:17:25Z",
                    "updated_at": "2017-06-23T20:17:25Z",
                    "type": "credit"
                },
                "created_at": "2017-06-23T20:17:25Z",
                "updated_at": "2017-06-23T20:17:25Z",
                "gateway_response": {
                    "code": "201"
                }
            }
        },
        {
            "id": "ch_xm4BRd0HQoUMjDGv",
            "code": "D7W5UYES79",
            "gateway_id": "9821b308-5996-4791-8698-ec5a9918c000",
            "amount": 2000,
            "status": "pending",
            "currency": "BRL",
            "payment_method": "boleto",
            "created_at": "2017-06-23T20:17:25Z",
            "updated_at": "2017-06-23T20:17:25Z",
            "customer": {
                "id": "cus_l6MdrlRIZIbknz7O",
                "name": "Tony Stark",
                "email": "tstark@avengers.com",
                "delinquent": false,
                "created_at": "2017-06-23T20:17:24Z",
                "updated_at": "2017-06-23T20:17:24Z",
                "phones": {}
            },
            "last_transaction": {
                "id": "tran_8m69BZ5GT2hjxgnl",
                "transaction_type": "boleto",
                "gateway_id": "e0e053a4-832b-484c-8e7a-009441291d2d",
                "amount": 2000,
                "status": "generated",
                "success": true,
                "url": "https://sandbox.mundipaggone.com/Boleto/ViewBoleto.aspx?e0e053a4-832b-484c-8e7a-009441291d2d",
                "pdf": "https://api.mundipagg.com/core/v1/transactions/tran_8m69BZ5GT2hjxgnl/pdf",
                "line": "34191.75009 04079.681237 41234.510000 3 84860000002000",
                "barcode": "https://api.mundipagg.com/core/v1/transactions/tran_8m69BZ5GT2hjxgnl/barcode",
                "qr_code": "https://api.mundipagg.com/core/v1/transactions/tran_8m69BZ5GT2hjxgnl/qrcode",
                "nosso_numero": "00040796",
                "bank": "033",
                "document_number": "081724490",
                "instructions": "Pagar até o vencimento",
                "due_at": "2020-12-31T00:00:00Z",
                "created_at": "2017-06-23T20:17:25Z",
                "updated_at": "2017-06-23T20:17:25Z",
                "gateway_response": {
                    "code": "201"
                }
            }
        }
    ]
}
{
    "message": "The request is invalid.",
    "errors": {
        "order.payments": [
            "The amount field is required on all payments if there is more than one payment"
        ]
    },
    "request": {
        "closed": true,
        "items": [
            {
                "amount": 2990,
                "description": "Chaveiro do Tesseract",
                "quantity": 1
            }
        ],
        "customer": {
            "name": "Tony Stark",
            "email": "dac00b98-e90f-4ec3-9eea-91917c1aff84@avengers.com",
            "phones": {},
            "metadata": {}
        },
        "payments": [
            {
                "payment_method": "credit_card",
                "credit_card": {
                    "installments": 1,
                    "capture": true,
                    "statement_descriptor": "AVENGERS",
                    "card": {
                        "number": "342793631858229",
                        "last_four_digits": "8229",
                        "brand": "Amex",
                        "holder_name": "Tony Stark",
                        "exp_month": 1,
                        "exp_year": 20,
                        "cvv": "3531",
                        "options": {}
                    }
                }
            },
            {
                "payment_method": "credit_card",
                "credit_card": {
                    "installments": 1,
                    "capture": true,
                    "statement_descriptor": "AVENGERS",
                    "card": {
                        "number": "342793631858229",
                        "last_four_digits": "8229",
                        "brand": "Amex",
                        "holder_name": "Tony Stark",
                        "exp_month": 1,
                        "exp_year": 20,
                        "cvv": "3531",
                        "options": {}
                    }
                }
            }
        ]
    }
}
 
Suggest Edits

Criar pedido multicompradores

Neste caso você pode incluir um cliente (customer) dentro do nó de pagamento (payment). Caso um nó payment não possua um nó customer dentro, assumiremos que o pagador dele é o mesmo customer do pedido.

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

Body Params

code
string

Código identificador do pedido no sistema da loja. Max: 52 caracteres.

items
array
required

Itens do pedido. Saiba mais sobre item do pedido

customer_id
string

Código do cliente.

customer
object

Dados do cliente. Obrigatório caso o customer_id não seja informado. Saiba mais sobre clientes.

shipping
object

Dados para entrega. Saiba mais sobre entregas

payments
array
required

Lista de dados de pagamento. Saiba mais sobre pagamentos.

closed
boolean

Informa se o pedido será criado aberto ou fechado

metadata
string

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


MULTIMEIOS DEVEM TER SEUS VALORES DISCRIMINADOS SEPARADAMENTE

Portanto, cada objeto dentro payments deverá ter seu próprio valor, bastando para isso incluir a propriedade amount com o valor correspondente ao de cada um dos meios de pagamento escolhidos. A resposta conterá além dos valores separados, um campo amount com a soma do todos os meios utilizados, que representa o valor total do pedido.

{
   "items":[
      {
         "amount":2990,
         "description":"Chaveiro do Tesseract",
         "quantity":1
      }
   ],
   "customer":{
      "name":"Tony Stark",
      "email":"tstark@avengers.com"
   },
   "payments":[
      {
         "amount":990,
         "payment_method":"credit_card",
         "credit_card":{
            "statement_descriptor":"AVENGERS",
            "card":{
               "number":"4024007131429325",
               "holder_name":"TONY STARK",
               "exp_month":1,
               "exp_year":20,
               "cvv":"353"
            }
         }
      },
      {
         "amount":2000,
         "payment_method":"credit_card",
         "customer":{
            "name":"Bruce Banner",
            "email":"bbanner@avengers.com"
         },
         "credit_card":{
            "statement_descriptor":"AVENGERS",
            "card":{
               "number":"5180692222213436",
               "holder_name":"BRUCE BANNER",
               "exp_month":1,
               "exp_year":20,
               "cvv":"154"
            }
         }
      }
   ]
}
    // Neste exemplo estamos utilizando A sdk C# MundiAPI.PCL
    string basicAuthUserName = "sk_test_4tdVXpseumRmqbo";
    // Senha em branco. Passando apenas a secret key
    string basicAuthPassword = "";
    var client = new MundiAPIClient(basicAuthUserName, basicAuthPassword);

    var items = new List<CreateOrderItemRequest> {
        new CreateOrderItemRequest{

        Amount = 2990,
        Description = "Chaveiro do Tesseract",
        Quantity = 1
        }
        };

    var customer = new CreateCustomerRequest
    {
        Name = "Tony Stark",
        Email = "tonystark@avengers.com",
    };

    var payments = new List<CreatePaymentRequest> {
        new CreatePaymentRequest {
            Amount = 990,
            PaymentMethod = "credit_card",
            CreditCard = new CreateCreditCardPaymentRequest{
            StatementDescriptor = "AVENGERS",
                Card = new CreateCardRequest{
                    Number = "4024007131429325",
                    HolderName = "Tony Stark2",
                    ExpMonth = 1,
                    ExpYear = 18,
                    Cvv = "355",
                }
         }
         },new CreatePaymentRequest {
            Amount = 2000,
            PaymentMethod = "credit_card",
            CreditCard = new CreateCreditCardPaymentRequest{
            StatementDescriptor = "AVENGERS",
                Card = new CreateCardRequest{
                    Number = "4024007131429325",
                    HolderName = "Tony Stark3",
                    ExpMonth = 1,
                    ExpYear = 18,
                    Cvv = "355",
           }
        }
      },
    };
    var request = new CreateOrderRequest
    {
        Items = items,
        Customer = customer,
        Payments = payments
    };
    var response = client.Orders.CreateOrder(request);
A binary file was returned

You couldn't be authenticated

{
    "id": "or_ke7Dg2MFJt6eo52m",
    "code": "27PYCGA068",
    "amount": 2990,
    "currency": "BRL",
    "closed": true,
    "items": [
        {
            "id": "oi_6opA78NH0Ds4pPLd",
            "description": "Chaveiro do Tesseract",
            "amount": 2990,
            "quantity": 1,
            "status": "active",
            "created_at": "2017-06-23T20:21:31Z",
            "updated_at": "2017-06-23T20:21:31Z"
        }
    ],
    "customer": {
        "id": "cus_l6MdrlRIZIbknz7O",
        "name": "Tony Stark",
        "email": "tstark@avengers.com",
        "delinquent": false,
        "created_at": "2017-06-23T20:17:24Z",
        "updated_at": "2017-06-23T20:17:24Z",
        "phones": {}
    },
    "status": "paid",
    "created_at": "2017-06-23T20:21:31Z",
    "updated_at": "2017-06-23T20:21:32Z",
    "closed_at": "2017-06-23T20:21:32Z",
    "charges": [
        {
            "id": "ch_012oaovIlU44JzBW",
            "code": "27PYCGA068",
            "gateway_id": "56e9d2c9-7888-431e-8f6f-662c81ba0d19",
            "amount": 990,
            "status": "paid",
            "currency": "BRL",
            "payment_method": "credit_card",
            "paid_at": "2017-06-23T20:21:31Z",
            "created_at": "2017-06-23T20:21:31Z",
            "updated_at": "2017-06-23T20:21:31Z",
            "customer": {
                "id": "cus_l6MdrlRIZIbknz7O",
                "name": "Tony Stark",
                "email": "tstark@avengers.com",
                "delinquent": false,
                "created_at": "2017-06-23T20:17:24Z",
                "updated_at": "2017-06-23T20:17:24Z",
                "phones": {}
            },
            "last_transaction": {
                "id": "tran_zgydxzOI9FBzAe3O",
                "transaction_type": "credit_card",
                "gateway_id": "efa792c8-8892-475a-a294-7a1127f73771",
                "amount": 990,
                "status": "captured",
                "success": true,
                "installments": 1,
                "statement_descriptor": "AVENGERS",
                "acquirer_name": "simulator",
                "acquirer_affiliation_code": "000000000",
                "acquirer_tid": "845328",
                "acquirer_nsu": "847047",
                "acquirer_auth_code": "143559",
                "acquirer_message": "Simulator|Transação de simulação autorizada com sucesso",
                "acquirer_return_code": "0",
                "operation_type": "auth_and_capture",
                "card": {
                    "id": "card_NZ4E4DYSbbsNLEDa",
                    "first_six_digits": "402400",
                    "last_four_digits": "9325",
                    "brand": "Visa",
                    "holder_name": "TONY STARK",
                    "exp_month": 1,
                    "exp_year": 2020,
                    "status": "active",
                    "created_at": "2017-06-23T20:17:25Z",
                    "updated_at": "2017-06-23T20:17:25Z",
                    "type": "credit"
                },
                "created_at": "2017-06-23T20:21:31Z",
                "updated_at": "2017-06-23T20:21:31Z",
                "gateway_response": {
                    "code": "201"
                }
            }
        },
        {
            "id": "ch_XyoBzAviOPcNMaW1",
            "code": "27PYCGA068",
            "gateway_id": "56e9d2c9-7888-431e-8f6f-662c81ba0d19",
            "amount": 2000,
            "status": "paid",
            "currency": "BRL",
            "payment_method": "credit_card",
            "paid_at": "2017-06-23T20:21:32Z",
            "created_at": "2017-06-23T20:21:31Z",
            "updated_at": "2017-06-23T20:21:31Z",
            "customer": {
                "id": "cus_kboWB4mWI8iLAjv6",
                "name": "Bruce Banner",
                "email": "bbanner@avengers.com",
                "delinquent": false,
                "created_at": "2017-06-23T20:21:31Z",
                "updated_at": "2017-06-23T20:21:31Z",
                "phones": {}
            },
            "last_transaction": {
                "id": "tran_dG2EmBi8DF25ADoB",
                "transaction_type": "credit_card",
                "gateway_id": "7dbc3f78-2766-44e3-a2dd-c78283052c5d",
                "amount": 2000,
                "status": "captured",
                "success": true,
                "installments": 1,
                "statement_descriptor": "AVENGERS",
                "acquirer_name": "simulator",
                "acquirer_affiliation_code": "000000000",
                "acquirer_tid": "650647",
                "acquirer_nsu": "316809",
                "acquirer_auth_code": "18107",
                "acquirer_message": "Simulator|Transação de simulação autorizada com sucesso",
                "acquirer_return_code": "0",
                "operation_type": "auth_and_capture",
                "card": {
                    "id": "card_dqjQLNwCLoUBV2rw",
                    "first_six_digits": "518069",
                    "last_four_digits": "3436",
                    "brand": "Mastercard",
                    "holder_name": "BRUCE BANNER",
                    "exp_month": 1,
                    "exp_year": 2020,
                    "status": "active",
                    "created_at": "2017-06-23T20:21:31Z",
                    "updated_at": "2017-06-23T20:21:31Z",
                    "type": "credit"
                },
                "created_at": "2017-06-23T20:21:31Z",
                "updated_at": "2017-06-23T20:21:31Z",
                "gateway_response": {
                    "code": "201"
                }
            }
        }
    ]
}
 
Suggest Edits

Obter pedido

 
gethttps://api.mundipagg.com/core/v1/orders/order_id

Body Params

order_id
string
required

Código identificador do pedido no sistema da loja. Max: 52 caracteres.

 
          // Neste exemplo estamos utilizando A sdk C# MundiAPI.PCL
          // 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 orderid = "or_28dN9w7CLU79kDjL";
            var response = client.Orders.GetOrder(orderid);
A binary file was returned

You couldn't be authenticated

{
  "id": "or_28dN9w7CLU79kDjL",
  "code": "62LVFN7I4R",
  "amount": 2990,
  "currency": "BRL",
  "closed": true,
  "items": [
    {
      "id": "oi_d478RMAS3bC74PrL",
      "description": "Chaveiro do Tesseract",
      "amount": 2990,
      "quantity": 1,
      "status": "active",
      "created_at": "2017-04-19T16:01:09Z",
      "updated_at": "2017-04-19T16:01:09Z"
    }
  ],
  "customer": {
    "id": "cus_eaEXlZvhBfeGlDOm",
    "name": "Tony Stark",
    "email": "f1492621-4f39-45f7-adfb-82a373a0a85c@avengers.com",
    "delinquent": false,
    "created_at": "2017-04-19T16:01:09Z",
    "updated_at": "2017-04-19T16:01:09Z"
  },
  "status": "paid",
  "created_at": "2017-04-19T16:01:09Z",
  "updated_at": "2017-04-19T16:01:11Z",
  "closed_at": "2017-04-19T16:01:11Z",
  "charges": [
    {
      "id": "ch_gmnW101c9YTvQVLB",
      "code": "62LVFN7I4R",
      "gateway_id": "ef5e977b-93d2-485a-b15d-36e5eb3d8cf5",
      "amount": 2990,
      "status": "paid",
      "currency": "BRL",
      "payment_method": "credit_card",
      "paid_at": "2017-04-19T16:01:11Z",
      "created_at": "2017-04-19T16:01:09Z",
      "updated_at": "2017-04-19T16:01:09Z",
      "customer": {
        "id": "cus_eaEXlZvhBfeGlDOm",
        "name": "Tony Stark",
        "email": "f1492621-4f39-45f7-adfb-82a373a0a85c@avengers.com",
        "delinquent": false,
        "created_at": "2017-04-19T16:01:09Z",
        "updated_at": "2017-04-19T16:01:09Z"
      },
      "last_transaction": {
        "id": "tran_3RYbBQjcnEcwrGp0",
        "transaction_type": "credit_card",
        "gateway_id": "ddab707d-72ba-49f9-b356-f0b9ebfa3039",
        "amount": 2990,
        "status": "captured",
        "success": true,
        "installments": 1,
        "statement_descriptor": "AVENGERS",
        "acquirer_name": "simulator",
        "acquirer_affiliation_code": "MUNDI",
        "acquirer_tid": "431837",
        "acquirer_nsu": "512784",
        "acquirer_auth_code": "233215",
        "acquirer_message": "Simulator|Transação de simulação autorizada com sucesso",
        "acquirer_return_code": "0",
        "operation_type": "auth_and_capture",
        "card": {
          "id": "card_6xk9deAu2I2MdPzJ",
          "first_six_digits": "402400",
          "last_four_digits": "8229",
          "brand": "Amex",
          "holder_name": "Tony Stark",
          "exp_month": 1,
          "exp_year": 2018,
          "status": "active",
          "created_at": "2017-04-19T16:01:09Z",
          "updated_at": "2017-04-19T16:01:09Z",
          "billing_address": {
            "street": "Malibu Point",
            "number": "10880",
            "zip_code": "90265",
            "neighborhood": "Central Malibu",
            "city": "Malibu",
            "state": "CA",
            "country": "US"
          },
          "type": "credit"
        },
        "created_at": "2017-04-19T16:01:09Z",
        "updated_at": "2017-04-19T16:01:09Z",
        "gateway_response": {
          "code": "201"
        }
      }
    }
  ]
}
 
Suggest Edits

Editar metadados do pedido

 
patchhttps://api.mundipagg.com/core/v1/orders/order_id/metadata

Path Params

order_id
string
required

Código do pedido

Body Params

metadata
object
required

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

 
{
    "metadata": {
      "code": "1234",
      "company": "Avengers"
    }
}
    // Neste exemplo estamos utilizando A sdk C# MundiAPI.PCL
    // 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 orderId = "or_R05JE7RHdgIQYleW";

    var metadata = new Dictionary<string, string> {
        { "code", "1234" },
      	{ "company", "Avengers" }
    };

    var request = new UpdateMetadataRequest {
        Metadata = metadata
    };

    var response = client.Orders.UpdateOrderMetadata(orderId, request);
A binary file was returned

You couldn't be authenticated

{
    "id": "or_R05JE7RHdgIQYleW",
    "code": "V09WIJC9RV",
    "amount": 2990,
    "currency": "BRL",
    "closed": true,
    "items": [
        {
            "id": "oi_xgAVZzzS0f3dZp6r",
            "description": "Chaveiro do Tesseract",
            "amount": 2990,
            "quantity": 1,
            "status": "active",
            "created_at": "2017-08-10T15:45:46Z",
            "updated_at": "2017-08-10T15:45:46Z"
        }
    ],
    "customer": {
        "id": "cus_3yq5oM0IG8Cm96ge",
        "name": "Tony Stark",
        "email": "43af3255-ec8c-447a-80fe-440ee4ac3fa2@avengers.com",
        "delinquent": false,
        "created_at": "2017-08-10T15:45:46Z",
        "updated_at": "2017-08-10T15:45:46Z",
        "phones": {}
    },
    "status": "failed",
    "created_at": "2017-08-10T15:45:46Z",
    "updated_at": "2017-08-10T15:48:21Z",
    "closed_at": "2017-08-10T15:45:46Z",
    "charges": [
        {
            "id": "ch_EZeGKaNNC8tLxQzd",
            "code": "V09WIJC9RV",
            "amount": 2990,
            "status": "failed",
            "currency": "BRL",
            "payment_method": "credit_card",
            "created_at": "2017-08-10T15:45:46Z",
            "updated_at": "2017-08-10T15:45:46Z",
            "customer": {
                "id": "cus_3yq5oM0IG8Cm96ge",
                "name": "Tony Stark",
                "email": "43af3255-ec8c-447a-80fe-440ee4ac3fa2@avengers.com",
                "delinquent": false,
                "created_at": "2017-08-10T15:45:46Z",
                "updated_at": "2017-08-10T15:45:46Z",
                "phones": {}
            },
            "last_transaction": {
                "id": "tran_qrj3KzvhLJcE7WL7",
                "transaction_type": "credit_card",
                "amount": 2990,
                "status": "with_error",
                "success": false,
                "installments": 1,
                "statement_descriptor": "AVENGERS",
                "operation_type": "auth_and_capture",
                "card": {
                    "id": "card_2jPo1d0hPWCK1m9M",
                    "first_six_digits": "342793",
                    "last_four_digits": "8229",
                    "brand": "Amex",
                    "holder_name": "Tony Stark",
                    "exp_month": 1,
                    "exp_year": 2018,
                    "status": "active",
                    "created_at": "2017-08-10T15:45:46Z",
                    "updated_at": "2017-08-10T15:45:46Z",
                    "billing_address": {
                        "street": "Malibu Point",
                        "number": "10880",
                        "zip_code": "90265",
                        "neighborhood": "Central Malibu",
                        "city": "Malibu",
                        "state": "CA",
                        "country": "US"
                    },
                    "type": "credit"
                },
                "created_at": "2017-08-10T15:45:46Z",
                "updated_at": "2017-08-10T15:45:46Z",
                "gateway_response": {
                    "code": "401",
                    "errors": [
                        {
                            "message": "A MerchantKey informada não existe."
                        }
                    ]
                }
            }
        }
    ],
    "metadata": {
        "code": "1234",
        "company": "Avengers"
    }
}
{
    "message": "Order not found."
}
 
Suggest Edits

Fechar um pedido

Utilizado para fechar um pedido para que não seja mais possível adicionar cobranças.

 
patchhttps://api.mundipagg.com/core/v1/orders/order_id/closed

Path Params

order_id
string
required

Código do pedido.

Body Params

status
string
required

Status final do pedido. Valores possíveis: paid, canceled ou failed

 
No code samples available
A binary file was returned

You couldn't be authenticated

{
  "id": "or_koMvlQOTMCb9dpPO",
  "code": "O8YDFPZUM3",
  "amount": 2990,
  "currency": "BRL",
  "closed": true,
  "items": [
    {
      "id": "oi_jkW1MBc9MtKdzK20",
      "description": "Bolinho de feijoada",
      "amount": 2990,
      "quantity": 1,
      "status": "active",
      "created_at": "2017-06-06T16:03:41Z",
      "updated_at": "2017-06-06T16:03:41Z"
    }
  ],
  "customer": {
    "id": "cus_mBloKMLnswtD4O3a",
    "name": "Carlos Peçanha",
    "email": "carlospecanha@outlook.com",
    "delinquent": false,
    "created_at": "2016-10-07T19:50:39Z",
    "updated_at": "2017-06-06T16:03:40Z",
    "phones": {},
    "metadata": {
      "company": "Mundipagg",
      "nome_da_mae": "Maria"
    }
  },
  "status": "paid",
  "created_at": "2017-06-06T16:03:40Z",
  "updated_at": "2017-06-06T16:03:40Z",
  "closed_at": "2017-06-06T16:03:47Z"
}
 
Suggest Edits

Listar pedidos

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

Query Params

code
string

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

status
string

Status do pedido. Valores possíveis: pending, paid, canceled ou failed

customer_id
string

Código do cliente.

created_since
date

Data de início do período de criação a ser listado.

created_until
date

Data de final do período de criação a ser listado.

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.

            // Neste exemplo estamos utilizando A sdk C# MundiAPI.PCL
            // 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.Orders.GetOrders();
A binary file was returned

You couldn't be authenticated

{
  "data": [
    {
      "id": "or_28dN9w7CLU79kDjL",
      "code": "62LVFN7I4R",
      "amount": 2990,
      "currency": "BRL",
      "closed": true,
      "items": [
        {
          "id": "oi_d478RMAS3bC74PrL",
          "description": "Chaveiro do Tesseract",
          "amount": 2990,
          "quantity": 1,
          "status": "active",
          "created_at": "2017-04-19T16:01:09Z",
          "updated_at": "2017-04-19T16:01:09Z"
        }
      ],
      "customer": {
        "id": "cus_eaEXlZvhBfeGlDOm",
        "name": "Tony Stark",
        "email": "f1492621-4f39-45f7-adfb-82a373a0a85c@avengers.com",
        "delinquent": false,
        "created_at": "2017-04-19T16:01:09Z",
        "updated_at": "2017-04-19T16:01:09Z"
      },
      "status": "paid",
      "created_at": "2017-04-19T16:01:09Z",
      "updated_at": "2017-04-19T16:01:11Z",
      "closed_at": "2017-04-19T16:01:11Z",
      "charges": [
        {
          "id": "ch_gmnW101c9YTvQVLB",
          "code": "62LVFN7I4R",
          "gateway_id": "ef5e977b-93d2-485a-b15d-36e5eb3d8cf5",
          "amount": 2990,
          "status": "paid",
          "currency": "BRL",
          "payment_method": "credit_card",
          "paid_at": "2017-04-19T16:01:11Z",
          "created_at": "2017-04-19T16:01:09Z",
          "updated_at": "2017-04-19T16:01:09Z",
          "customer": {
            "id": "cus_eaEXlZvhBfeGlDOm",
            "name": "Tony Stark",
            "email": "f1492621-4f39-45f7-adfb-82a373a0a85c@avengers.com",
            "delinquent": false,
            "created_at": "2017-04-19T16:01:09Z",
            "updated_at": "2017-04-19T16:01:09Z"
          }
        }
      ]
    },
    {
      "id": "or_dW6vZoJfLhw3Rb10",
      "code": "65JGU05FX0",
      "amount": 2990,
      "currency": "BRL",
      "closed": true,
      "items": [
        {
          "id": "oi_zYGxV8rU36HPWQMg",
          "description": "Chaveiro do Tesseract",
          "amount": 2990,
          "quantity": 1,
          "status": "active",
          "created_at": "2017-04-19T15:58:23Z",
          "updated_at": "2017-04-19T15:58:23Z"
        }
      ],
      "customer": {
        "id": "cus_rG3592i17uQgxK2Q",
        "name": "Tony Stark",
        "email": "5d76b138-2963-40f7-ba71-c9ae2cc65518@avengers.com",
        "delinquent": false,
        "created_at": "2017-04-19T15:58:23Z",
        "updated_at": "2017-04-19T15:58:23Z"
      },
      "status": "failed",
      "created_at": "2017-04-19T15:58:23Z",
      "updated_at": "2017-04-19T15:58:24Z",
      "closed_at": "2017-04-19T15:58:24Z",
      "charges": [
        {
          "id": "ch_nM5PkjcyLUa6Nr1w",
          "code": "65JGU05FX0",
          "amount": 2990,
          "status": "failed",
          "currency": "BRL",
          "payment_method": "credit_card",
          "created_at": "2017-04-19T15:58:23Z",
          "updated_at": "2017-04-19T15:58:24Z",
          "customer": {
            "id": "cus_rG3592i17uQgxK2Q",
            "name": "Tony Stark",
            "email": "5d76b138-2963-40f7-ba71-c9ae2cc65518@avengers.com",
            "delinquent": false,
            "created_at": "2017-04-19T15:58:23Z",
            "updated_at": "2017-04-19T15:58:23Z"
          }
        }
      ]
    }
  ],
  "paging": {
    "total": 406,
    "next": "https://api.mundipagg.com:4443/core/v1/orders?page=2&size=2"
  }
}
 
Suggest Edits

Criar pedido com meio de pagamento Checkout

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

Body Params

items
array
required

Itens do pedido. Saiba mais sobre item do pedido

customer_id
string

Código do cliente.

customer
object

Dados do cliente. Obrigatório caso o customer_id não seja informado. Saiba mais sobre clientes.

shipping
object

Dados para entrega. Saiba mais sobre entregas

payments
array
required

Lista de dados de pagamento. Saiba mais sobre pagamentos.

metadata
string

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


{
   "items":[
      {
         "amount":3000,
         "description":"Chaveiro do Teressact",
         "quantity":1
      }
   ],
   "customer":{
      "name":"Tony Stark"
   },
   "payments":[
      {
        "amount" : 3000,
         "payment_method":"checkout",
         "checkout": {
         "expires_in":120,
         "billing_address_editable" : false,
          "customer_editable" : true,
           "accepted_payment_methods": ["credit_card", "boleto" ],
           "success_url": "https://www.mundipagg.com",
           "boleto": {
             "bank": "033",
             "instructions": "Pagar até o vencimento",
             "due_at": "2020-07-25T00:00:00Z",
           },
           "credit_card": {
              "installments": [
                {
                  "number": 1,
                  "total": 3000
                },
                {
                  "number": 2,
                  "total": 3000
                }
             ]
           }
         }
      }
   ]
}
    // Neste exemplo estamos utilizando A sdk C# MundiAPI.PCL
    string basicAuthUserName = "sk_test_4tdVXpseumRmqbo";
    // Senha em branco. Passando apenas a secret key
    string basicAuthPassword = "";
    var client = new MundiAPIClient(basicAuthUserName, basicAuthPassword);

    var items = new List<CreateOrderItemRequest> {
        new CreateOrderItemRequest{

        Amount = 2990,
        Description = "Chaveiro do Tesseract",
        Quantity = 1
        }
        };

    var customer = new CreateCustomerRequest
    {
        Name = "Tony Stark",
        Email = "tonystark@avengers.com",
    };

    var payments = new List<CreatePaymentRequest> {
        new CreatePaymentRequest {
            Amount = 990,
            PaymentMethod = "credit_card",
            CreditCard = new CreateCreditCardPaymentRequest{
            StatementDescriptor = "AVENGERS",
                Card = new CreateCardRequest{
                    Number = "4024007131429325",
                    HolderName = "Tony Stark2",
                    ExpMonth = 1,
                    ExpYear = 18,
                    Cvv = "355",
                }
         }
         },new CreatePaymentRequest {
            Amount = 2000,
            PaymentMethod = "credit_card",
            CreditCard = new CreateCreditCardPaymentRequest{
            StatementDescriptor = "AVENGERS",
                Card = new CreateCardRequest{
                    Number = "4024007131429325",
                    HolderName = "Tony Stark3",
                    ExpMonth = 1,
                    ExpYear = 18,
                    Cvv = "355",
           }
        }
      },
    };
    var request = new CreateOrderRequest
    {
        Items = items,
        Customer = customer,
        Payments = payments
    };
    var response = client.Orders.CreateOrder(request);
A binary file was returned

You couldn't be authenticated

{
    "id": "or_ywXmL2LCQuYlZ5O3",
    "code": "1V82IK0C81",
    "amount": 3000,
    "currency": "BRL",
    "closed": false,
    "items": [
        {
            "id": "oi_l0qy5l6FzBI6ONYQ",
            "description": "Chaveiro do Teressact",
            "amount": 3000,
            "quantity": 1,
            "status": "active",
            "created_at": "2018-06-18T18:31:16Z",
            "updated_at": "2018-06-18T18:31:16Z"
        }
    ],
    "customer": {
        "id": "cus_qa9WbRztpc7bKpyN",
        "name": "Tony Stark",
        "email": "",
        "delinquent": false,
        "created_at": "2018-06-18T18:31:09Z",
        "updated_at": "2018-06-18T18:31:09Z",
        "phones": {}
    },
    "status": "pending",
    "created_at": "2018-06-18T18:31:14Z",
    "updated_at": "2018-06-18T18:31:14Z",
    "checkouts": [
        {
            "id": "chk_lJrO6LLcGQh46EqX",
            "amount": 3000,
            "status": "open",
            "success_url": "https://www.mundipagg.com",
            "payment_url": "https://api.mundipagg.com/checkout/v1/orders/chk_lJrO6LLcGQh46EqX",
            "customer_editable": true,
            "billing_address_editable": true,
            "skip_checkout_success_page": false,
            "created_at": "2018-06-18T18:31:18Z",
            "updated_at": "2018-06-18T18:31:18Z",
            "expires_at": "2018-06-18T20:31:18Z",
            "accepted_payment_methods": [
                "credit_card", "boleto"
            ],
            "customer": {
                "id": "cus_qa9WbRztpc7bKpyN",
                "name": "Tony Stark",
                "email": "",
                "delinquent": false,
                "created_at": "2018-06-18T18:31:09Z",
                "updated_at": "2018-06-18T18:31:09Z",
                "phones": {}
            },
            "credit_card": {
                "capture": true,
                "installments": [
                    {
                        "number": 1,
                        "total": 3000
                    },
                    {
                        "number": 2,
                        "total": 3000
                    }
                ]
            },
          "boleto": {
                "due_at": "2020-07-25T00:00:00Z",
                "instructions": "Pagar até o vencimento"
            },
            "billing_address": {},
            "shippable": false,
            "currency": "BRL",
            "metadata": {}
        }
    ]
}
 
Suggest Edits

Criar pedido com meio de pagamento Checkout multimeios

Neste caso, para habilitar o multimeios, você precisa incluir o array accepted_multi_payment_methods dentro do objeto checkout. Desta maneira você pode fornecer ao seu cliente final a possibilidade de pagar com dois cartões ou cartão mais boleto.

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

Body Params

items
array
required

Itens do pedido. Saiba mais sobre item do pedido

customer_id
string

Código do cliente.

customer
object

Dados do cliente. Obrigatório caso o customer_id não seja informado. Saiba mais sobre clientes.

shipping
object

Dados para entrega. Saiba mais sobre entregas

payments
array
required

Lista de dados de pagamento. Saiba mais sobre pagamentos.

metadata
string

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


{
   "items":[
      {
         "amount":3000,
         "description":"Chaveiro do Teressact",
         "quantity":1
      }
   ],
   "customer":{
      "name":"Tony Stark"
   },
   "payments":[
      {
        "amount" : 3000,
         "payment_method":"checkout",
         "checkout": {
         "expires_in":120,
         "billing_address_editable" : false,
          "customer_editable" : true,
           "accepted_payment_methods": ["credit_card", "boleto" ],
           "accepted_multi_payment_methods": [ 
		      		["credit_card","credit_card"],
		      		["credit_card","boleto"]
		   			],
           "success_url": "https://www.mundipagg.com",
           "boleto": {
             "bank": "033",
             "instructions": "Pagar até o vencimento",
             "due_at": "2020-07-25T00:00:00Z",
           },
           "credit_card": {
              "installments": [
                {
                  "number": 1,
                  "total": 3000
                },
                {
                  "number": 2,
                  "total": 3000
                }
             ]
           }
         }
      }
   ]
}
    // Neste exemplo estamos utilizando A sdk C# MundiAPI.PCL
    string basicAuthUserName = "sk_test_4tdVXpseumRmqbo";
    // Senha em branco. Passando apenas a secret key
    string basicAuthPassword = "";
    var client = new MundiAPIClient(basicAuthUserName, basicAuthPassword);

    var items = new List<CreateOrderItemRequest> {
        new CreateOrderItemRequest{

        Amount = 2990,
        Description = "Chaveiro do Tesseract",
        Quantity = 1
        }
        };

    var customer = new CreateCustomerRequest
    {
        Name = "Tony Stark",
        Email = "tonystark@avengers.com",
    };

    var payments = new List<CreatePaymentRequest> {
        new CreatePaymentRequest {
            Amount = 990,
            PaymentMethod = "credit_card",
            CreditCard = new CreateCreditCardPaymentRequest{
            StatementDescriptor = "AVENGERS",
                Card = new CreateCardRequest{
                    Number = "4024007131429325",
                    HolderName = "Tony Stark2",
                    ExpMonth = 1,
                    ExpYear = 18,
                    Cvv = "355",
                }
         }
         },new CreatePaymentRequest {
            Amount = 2000,
            PaymentMethod = "credit_card",
            CreditCard = new CreateCreditCardPaymentRequest{
            StatementDescriptor = "AVENGERS",
                Card = new CreateCardRequest{
                    Number = "4024007131429325",
                    HolderName = "Tony Stark3",
                    ExpMonth = 1,
                    ExpYear = 18,
                    Cvv = "355",
           }
        }
      },
    };
    var request = new CreateOrderRequest
    {
        Items = items,
        Customer = customer,
        Payments = payments
    };
    var response = client.Orders.CreateOrder(request);
A binary file was returned

You couldn't be authenticated

{
    "id": "or_ywXmL2LCQuYlZ5O3",
    "code": "1V82IK0C81",
    "amount": 3000,
    "currency": "BRL",
    "closed": false,
    "items": [
        {
            "id": "oi_l0qy5l6FzBI6ONYQ",
            "description": "Chaveiro do Teressact",
            "amount": 3000,
            "quantity": 1,
            "status": "active",
            "created_at": "2018-06-18T18:31:16Z",
            "updated_at": "2018-06-18T18:31:16Z"
        }
    ],
    "customer": {
        "id": "cus_qa9WbRztpc7bKpyN",
        "name": "Tony Stark",
        "email": "",
        "delinquent": false,
        "created_at": "2018-06-18T18:31:09Z",
        "updated_at": "2018-06-18T18:31:09Z",
        "phones": {}
    },
    "status": "pending",
    "created_at": "2018-06-18T18:31:14Z",
    "updated_at": "2018-06-18T18:31:14Z",
    "checkouts": [
        {
            "id": "chk_lJrO6LLcGQh46EqX",
            "amount": 3000,
            "status": "open",
            "success_url": "https://www.mundipagg.com",
            "payment_url": "http://localhost:56351/checkout/v1/orders/chk_lJrO6LLcGQh46EqX",
            "customer_editable": true,
            "billing_address_editable": true,
            "skip_checkout_success_page": false,
            "created_at": "2018-06-18T18:31:18Z",
            "updated_at": "2018-06-18T18:31:18Z",
            "expires_at": "2018-06-18T20:31:18Z",
            "accepted_payment_methods": [
                "credit_card", "boleto"
            ],
            "accepted_multi_payment_methods": [ 
		      		["credit_card","credit_card"],
		      		["credit_card","boleto"]
		   			],
            "customer": {
                "id": "cus_qa9WbRztpc7bKpyN",
                "name": "Tony Stark",
                "email": "",
                "delinquent": false,
                "created_at": "2018-06-18T18:31:09Z",
                "updated_at": "2018-06-18T18:31:09Z",
                "phones": {}
            },
            "credit_card": {
                "capture": true,
                "installments": [
                    {
                        "number": 1,
                        "total": 3000
                    },
                    {
                        "number": 2,
                        "total": 3000
                    }
                ]
            },
          "boleto": {
                "due_at": "2020-07-25T00:00:00Z",
                "instructions": "Pagar até o vencimento"
            },
            "billing_address": {},
            "shippable": false,
            "currency": "BRL",
            "metadata": {}
        }
    ]
}
 
Suggest Edits

Item do pedido

Com a criação de um pedido aberto, é possível que itens sejam gerenciados. O objeto item do pedido tem os seguintes atributos:

 
Atributos
Tipo
Descrição

id

string

Código do item do pedido. Formato: oi_XXXXXXXXXXXXXXXX.

amount

integer

Valor unitário.

description

string

Descrição do item.

quantity

short

Quantidade de itens.

code

string

Código do item no sistema da loja.

category

string

Categoria do item.

seller

object

Dados do vendedor do item.

seller_id

string

Código do vendedor. Formato: sl_XXXXXXXXXXXXXXXX

status

string

Status do item do pedido. Valores possíveis: active ou deleted.

created_at

datetime

Data de criação do item do pedido.

updated_at

datetime

Data de última atualização do item do pedido.

deleted_at

datetime

Data de exclusão do item do pedido.

order

object

Dados do pedido.

 
Suggest Edits

Incluir item

Quando um pedido está aberto, você pode incluir itens nele.

 
posthttps://api.mundipagg.com/core/v1/orders/order_id/items

Path Params

order_id
string
required

Código do pedido.

Body Params

amount
int32
required

Valor do item.

code
string

Código do item no sistema da loja. Max: 52 caracteres.

description
string
required

Descrição do item. Max: 256 caracteres.

quantity
int32
required

Quantidade de itens.

category
string

Categoria do item. Max: 64 caracteres.

seller_id
string

Código do vendedor do item

seller
object

Dados do vendedor do item. Obrigatório caso o seller_id não seja informado. Saiba mais sobre vendedores

 
{
  "amount": 1090,
  "description": "Caneca Zero Grau",
  "quantity": 1,
  "seller": {
    "document":"26224451990",
    "name":"Stark Industries",
    "code":"STRK_01",
    "description": "Changing the world for a better future.",
    "address":{
      "street": "Park Avenue",
      "number": "200",
      "zip_code": "10166",
      "neighborhood": "Manhattan",
      "city": "New York City",
      "state": "NY",
      "country": "US"
    }
  }
}
// Neste exemplo estamos utilizando A sdk C# MundiAPI.PCL
// 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 item = new CreateOrderItemRequest {
    Amount = 10,
    Category = "Mark 1 Gloves",
    Description = "Gloves",
    Quantity = 1,
};
var request = client.Orders.CreateOrderItem("or_JQ35ED8izte8BN9k", item);
A binary file was returned

You couldn't be authenticated

{
    "id": "oi_ZD2lNDKcORty1pzw",
    "description": "Caneca Zero Grau",
    "amount": 1090,
    "quantity": 1,
    "status": "active",
    "created_at": "2017-10-05T20:24:38Z",
    "updated_at": "2017-10-05T20:24:38Z",
    "order": {
        "id": "or_oO7vgpeh1rF4DX3A",
        "code": "7W86TKXIO1",
        "amount": 5170,
        "currency": "BRL",
        "closed": false,
        "status": "pending",
        "created_at": "2017-10-05T19:41:29Z",
        "updated_at": "2017-10-05T19:41:29Z"
    },
    "seller": {
        "id": "sl_jY3D2MziacQnR01W",
        "name": "Stark Industries",
        "code": "STRK_01",
        "document": "26224451990",
        "description": "Changing the world for a better future.",
        "status": "active",
        "created_at": "2017-10-05T20:24:38Z",
        "updated_at": "2017-10-05T20:24:38Z",
        "address": {
            "street": "Park Avenue",
            "number": "200",
            "zip_code": "10166",
            "neighborhood": "Manhattan",
            "city": "New York City",
            "state": "NY",
            "country": "US"
        },
        "metadata": {}
    }
}
 
Suggest Edits

Editar item do pedido

Quando um pedido está aberto, você pode editar os itens dele.

 
patchhttps://api.mundipagg.com/core/v1/orders/order_id/items/order_item_id

Path Params

order_id
string
required

Código do carrinho

order_item_id
string
required

Código do item do pedido

Body Params

amount
int32
required

Valor do item.

description
string
required

Descrição do item. Max: 256 caracteres.

quantity
int32
required

Quantidade de itens.

category
string

Categoria do item. Max: 64 caracteres.

 
{
  "amount": 1090,
  "description": "Água com gás",
  "quantity": 2
}
// Neste exemplo estamos utilizando A sdk C# MundiAPI.PCL
// 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 item = new UpdateOrderItemRequest {
    Amount = 10,
    Category = "Mark 1 Gloves",
    Description = "Glove",
    Quantity = 1,
};
var request = client.Orders.UpdateOrderItem("or_JQ35ED8izte8BN9k","oi_XAYlREWTbT2ngZLy",item);
A binary file was returned

You couldn't be authenticated

{
  "id": "oi_AQKqAnGhQGsYd1b6",
  "description": "Água com gás",
  "amount": 1090,
  "quantity": 2,
  "status": "active",
  "created_at": "2017-04-05T03:55:48",
  "updated_at": "2017-04-05T05:05:14",
  "order": {
    "id": "or_5OKyl9fNwIKDzjWJ",
    "code": "7P03S0FOQN",
    "amount": 6260,
    "currency": "BRL",
    "closed": false,
    "status": "pending",
    "created_at": "2017-04-05T03:54:42",
    "updated_at": "2017-04-05T03:54:42"
  }
}
 
Suggest Edits

Deletar item

Quando um pedido está aberto, você pode excluir itens dele.

 
deletehttps://api.mundipagg.com/core/v1/orders/order_id/items/order_item_id

Path Params

order_id
string
required

Cógido do pedido.

order_item_id
string
required

Código do item do pedido.

 
// Neste exemplo estamos utilizando A sdk C# MundiAPI.PCL
// 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);
// Utilizando o order_id e o item_id
var request = client.Orders.DeleteOrderItem("or_JQ35ED8izte8BN9k", "oi_XAYlREWTbT2ngZLy");
A binary file was returned

You couldn't be authenticated

{
  "id": "oi_AQKqAnGhQGsYd1b6",
  "description": "Caneca Zero Grau",
  "amount": 1090,
  "quantity": 2,
  "status": "deleted",
  "created_at": "2017-04-05T03:55:48",
  "updated_at": "2017-04-05T05:05:14",
  "deleted_at": "2017-04-05T05:30:34",
  "order": {
    "id": "or_5OKyl9fNwIKDzjWJ",
    "code": "7P03S0FOQN",
    "amount": 4080,
    "currency": "BRL",
    "closed": false,
    "status": "pending",
    "created_at": "2017-04-05T03:54:42",
    "updated_at": "2017-04-05T03:54:42"
  }
}
{
  "id": "oi_ZR3AjrjFwsg2A7bz",
  "description": "Caneca Zero Grau",
  "amount": 1090,
  "quantity": 1,
  "status": "deleted",
  "created_at": "2017-04-05T05:33:29",
  "updated_at": "2017-04-05T05:33:29",
  "deleted_at": "2017-04-05T05:33:38",
  "order": {
    "id": "or_5OKyl9fNwIKDzjWJ",
    "code": "7P03S0FOQN",
    "amount": 4080,
    "currency": "BRL",
    "closed": false,
    "status": "pending",
    "created_at": "2017-04-05T03:54:42",
    "updated_at": "2017-04-05T03:54:42"
  }
}
 
Suggest Edits

Remover todos os itens

Quando um pedido está aberto, você pode remover todos os itens dele.

 
deletehttps://api.mundipagg.com/core/v1/orders/order_id/items

Path Params

order_id
string
required

Código do pedido.

 
// Neste exemplo estamos utilizando A sdk C# MundiAPI.PCL
// 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);
// Utilizando o order_id para deletar todos os items do pedido.
var request = client.Orders.DeleteAllOrderItems("or_JQ35ED8izte8BN9k");
A binary file was returned

You couldn't be authenticated

{
  "id": "or_5OKyl9fNwIKDzjWJ",
  "code": "7P03S0FOQN",
  "currency": "BRL",
  "closed": false,
  "customer": {
    "id": "cus_oWQOPg5tJF8ml0ny",
    "name": "Tony Stark",
    "email": "9fb571fc-79c3-4293-aafd-61fd8afa6c38@avengers.com",
    "delinquent": false,
    "created_at": "2017-04-05T03:54:42",
    "updated_at": "2017-04-05T03:54:42"
  },
  "status": "pending",
  "created_at": "2017-04-05T03:54:42",
  "updated_at": "2017-04-05T03:54:42"
}
 
Suggest Edits

Obter item do pedido

Obter um item especifico dentro de um pedido especifico.

 
gethttps://api.mundipagg.com/core/v1/orderId/items/itemId

Path Params

order_id*
string
required

Cógido do pedido.

order_item_id*
string
required

Código do item do pedido.

 
// Neste exemplo estamos utilizando a sdk C# MundiAPI.PCL
// 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);
// Utilizando o order_id e o order_item_id
var request = client.Orders.DeleteAllOrderItems("or_JQ35ED8izte8BN9k");
             
A binary file was returned

You couldn't be authenticated

{
    "id": "oi_gJ4RZVujNFDVRwpn",
    "description": "Chaveiro do Tesseract",
    "amount": 2990,
    "quantity": 1,
    "status": "active",
    "created_at": "2017-12-18T16:49:43Z",
    "updated_at": "2017-12-18T16:49:43Z",
    "order": {
        "id": "or_WpJzPeCwQtlYrEGO",
        "code": "ELVRSL8S7Z",
        "amount": 2990,
        "currency": "BRL",
        "closed": true,
        "status": "paid",
        "created_at": "2017-12-18T16:49:43Z",
        "updated_at": "2017-12-18T16:49:44Z",
        "closed_at": "2017-12-18T16:49:44Z"
    }
}
{
    "message": "Item not found."
}
{
    "message": "Order not found."
}
 
Suggest Edits

Visão Geral da Recorrência

A API Mundipagg provê ferramentas para você gerenciamento de forma fácil cobranças recorrentes.

 
 
 
Suggest Edits

Precificação

O objeto price_scheme dá suporte para criação de diferentes formas de precificação de assinaturas, adequadas a serviços distintos, facilitando a criação de modelos de preços para o seu clientes. O objeto price_scheme pode conter ainda um objeto price_brackets que dá suporte para criação de faixas distintas de preço de acordo com o serviço prestado. Saiba mais sobre os modelos de precificação acessando nossa documentação.

O objeto price_scheme contêm os seguintes atributos:

 
Atributos
Tipo
Descrição

price

integer

Valor por unidade.

mininum_price

integer

Valor mínimo a ser cobrado.

scheme_type

string

Tipo de unidade de precificação. Valores possíveis são: unit, package, volume e tier.

price_brackets

object

Intervalo de preços. Este atributo está disponível para os scheme_type : package, volume e tier.

Por sua vez o objeto price_brackets é geralmente estruturado como um array objects onde cada item representa um intervalo de cobrança tendo, cada objeto, os seguintes atributos:

Atributos
Tipo
Descrição

start_quantity

integer

Valor que define a quantidade inicial de unidades do intervalo.

end_quantity

integer

Valor que define a quantidade final de unidades do intervalo.

overage_price

integer

Valor para cálculo do preço por unidade que exceder o intervalo.

price

integer

Valor para cálculo do preço dentro do intervalo.
OBS: o preço a ser cobrado do cliente será calculado de acordo com a quantidade e o scheme_type definidos. Conheça mais sobre o cálculo dos tipos de precificação acessando nossa documentação.

A Precificação é um modelo de preço para o comprador final

É importante destacar que esta não é a forma de cobrança da Mundipagg, e sim, o modelo de precificação que você poderá aplicar em seus planos e assinaturas para cobrar seus clientes.

Como exemplo do uso da precificação, vamos explorar a seguir os scheme_type tendo como unidade de medida tempo (minutos), porém podem ser aplicados outros tipos de medida, tais como: tamanho, objetos, dentre outros.

 
Suggest Edits

Unidade

No scheme_type : unit, preço final é baseado no consumo direto de unidades.

 
{
  "scheme_type": "unit",
  "price": 500,
  "minimum_price": 100,
}

No exemplo acima temos a seguinte precificação:

1 minuto = R$ 5,00.

Assim, se um cliente utilizar 100 minutos o valor total será R$ 500,00 (100 x R$ 5,00).
Caso o consumo seja menor que 1 minuto, será cobrado o valor mínimo R$ 1,00.

 
Suggest Edits

Pacote

No scheme_type : package, o preço final é baseado no consumo direto de um bloco de unidades.

 
{
    "scheme_type": "package",
    "price_brackets": [
        {
            "start_quantity": 0,
            "end_quantity": 10,
            "price": 5000
        },
        {
            "start_quantity": 11,
            "end_quantity": 50,
            "price": 7000
        },
        {
            "start_quantity": 51,
            "end_quantity": 100,
            "price": 10000,
            "overage_price": 90
        }
    ]
}

No exemplo acima temos a seguinte precificação:

De 0 a 10 minutos = R$ 50,00.
De 11 a 50 minutos = R$ 70,00.
De 51 a 100 minutos = R$ 100,00.
Cada minuto acima da última faixa = R$0,90.

Se um cliente utilizar 25 minutos o valor será R$ 70,00.
Se um cliente utilizar 110 minutos o valor será R$ 109,00 (R$ 100,00 + (10 x R$ 0,90)).

 
Suggest Edits

Volume

No scheme_type : volume, o preço final é baseado na faixa de consumo final de unidades.

 
{
    "scheme_type": "volume",
    "price_brackets": [
        {
            "start_quantity": 0,
            "end_quantity": 10,
            "price": 100
        },
        {
            "start_quantity": 11,
            "end_quantity": 20,
            "price": 90
        },
        {
            "start_quantity": 21,
            "end_quantity": 50,
            "price": 80,
            "overage_price": 70
        }
    ]
}

No exemplo acima temos a seguinte precificação:

Se utilizar entre 1 ~ 10 minutos - Cada minuto custa R$ 1,00.
Se utilizar entre 11 ~ 20 minutos - Cada minuto custa R$ 0,90.
Se utilizar entre 21 ~ 50 minutos - Cada minuto custa R$ 0,80.
Cada minuto acima da última faixa custa R$ 0,70.

Se um cliente utilizar 25 minutos o valor total será R$ 20,00 (25 x R$ 0,80).
Se um cliente utilizar 52 minutos o valor total será R$ 41,40 ((50 x R$ 0,80) + (2 x R$ 0,70)).

 
Suggest Edits

Faixa

No scheme_type : tier, o preço final é baseado nas faixa de consumo de unidades, de forma cumulativa.

 
{
    "scheme_type": "tier",
    "price_brackets": [
        {
            "start_quantity": 0,
            "end_quantity": 10,
            "price": 100
        },
        {
            "start_quantity": 11,
            "end_quantity": 20,
            "price": 90
        },
        {
            "start_quantity": 21,
            "end_quantity": 50,
            "price": 80,
            "overage_price": 70
        }
    ]
}

No exemplo acima temos a seguinte precificação:

Do 1° ao 10° minuto - Cada minuto custa R$ 1,00.
Do 11° ao 20° minuto - Cada minuto custa R$ 0,90.
Do 21° ao 50° minuto - Cada minuto custa R$ 0,80.
Cada minuto acima da última faixa custa R$ 0,70.

Se um cliente utilizar 25 minutos o valor total será R$23,00 ((10 x R$ 1,00) + (10 x R$ 0,90) + (5 x R$0,80)).

 
Suggest Edits

Assinaturas

O objeto subscription é uma recorrência em si, que possibilita a cobrança do clientes com intervalos pré determinados, sem que seja necessário criar essa regra de negócio do seu lado. O objeto subscription contêm os seguintes atributos:

 
Atributos
Tipo
Descrição

id

string

Código da assinatura. Formato: sub_XXXXXXXXXXXXXXXX.

payment_method

string

Meio de pagamento. Valores possíveis: credit_card, boleto ou cash.

currency

string

Moeda. Valor possível: BRL.

start_at

datetime

Data de início da assinatura.

interval

string

Intervalo da recorrência. Valores possíveis: week, month ou year.

interval_count

string

Repetições do intervalo da recorrência. Ex: plano mensal = interval_count (1) e interval (month); plano trimestral = interval_count (3) e interval (month); plano semestral = interval_count (6) e interval (month).

billing_type

string

Tipo de cobrança. Valores possíveis: prepaid, postpaidou exact_day.

billing_day

integer

Dia da cobrança. Obrigatório, caso o billing_type seja exact_day.

current_period

object

Período atual da assinatura.

next_billing_at

datetime

Data da próxima cobrança.

installments

integer

Quantidade de parcelas. Será aplicada caso o método de pagamento da assinatura seja cartão de crédito .

statement_descriptor

integer

Texto exibido na fatura do cartão.

customer

object

Dados do cliente. Saiba mais sobre clientes

card

object

Dados do cartão de crédito. Saiba mais sobre cartões

plan

object

Dados do plano. Saiba mais sobre planos

discounts

array of objects

Descontos.

increments

array of objects

Incrementos.

minimum_price

integer

Valor mínimo, em centavos, da assinatura.

items

array of objects

status

string

Status da assinatura. Valores possíveis: active, canceled ou future.

created_at

datetime

Data de criação da assinatura.

updated_at

datetime

Data de atualização da assinatura.

canceled_at

datetime

Data de cancelamento da assinatura.

metadata

object

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

gateway_affiliation_id

string

Código da afiliação no gateway.

Formas de Pagamento de Assinaturas

Podemos criar uma assinatura com os dois meios de pagamento distintos: credit_card ou boleto. Caso utilize credit_card será necessário o envio do card dentro da requisição juntamente do payment_method. Já no caso do boleto somente será necessário o payment_method.

 
Suggest Edits

Criar assinatura avulsa

Fornecemos a possibilidade de criação de uma assinatura (subscription) sem a necessidade de criação de um plano (plan).

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

Body Params

code
string

Código da assinatura no sistema da loja.

payment_method
string
required

Meio de pagamento.
Valores possíveis: credit_card ou boleto .

currency
string

Moeda. Valores possíveis: BRL, ARS, BOB, CLP, COP , MXN, PYG, USD , UYU e EUR.

start_at
string

Data de início da assinatura.
Se não for informada, a assinatura será iniciada imediatamente.

interval
string
required

Intervalo da recorrência.
Valores possíveis: day, week, month ou year.

minimum_price
int32

Valor mínimo em centavos da assinatura.

interval_count
int32

Repetições do intervalo da recorrência.
Ex: mensal = interval_count (1) e interval (month); trimestral = interval_count (3) e interval (month); semestral = interval_count (6) e interval (month).

billing_type
string

Tipo de cobrança.
Valores possíveis: prepaid, postpaid ou exact_day.

billing_day
int32
required

Dia da cobrança.
Obrigatório, caso o billing_type seja exact_day

installments
int32

Quantidade de parcelas.
Será aplicada caso o método de pagamento da assinatura seja cartão de crédito .

statement_descriptor
string

Texto exibido na fatura do cartão.
Será aplicado caso o método de pagamento da assinatura seja cartão de crédito

customer_id
string
required

Código do cliente.
Obrigatório caso o customer não seja informado. Saiba mais sobre clientes

customer
object
required

Dados do cliente.
Obrigatório caso o customer_id não seja informado. Saiba mais sobre clientes

discounts
array

Descontos.

increments
array

Incrementos

items
array
required

Itens do assinatura.
Saiba mais sobre item da assinatura

setup
object

Pedido que pode ser criado assim que a assinatura for iniciada.

setup.amount
integer
required

Valor do setup (pedido) em centavos.

setup.description
string
required

Descrição do setup (pedido).

setup.payment
object
required

Pagamento do pedido. Saiba mais sobre pagamentos

card
object
required

Cartão de crédito.
- card_id é o código do cartão do cliente.
- card_token é token do cartão gerado pelo checkout transparente.
É obrigatório o envio de uma dessas identificações, caso o payment_method seja credit_card.
Saiba mais sobre cartões de crédito.

gateway_affiliation_id
string

Código da afiliação no gateway.

boleto_due_days
int32

Dias para expiração do boleto. (Caso não seja passado, será pego um valor padrão das configurações da loja)

metadata
object

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

 
{
    "payment_method": "credit_card",
    "currency": "BRL",
    "interval": "month",
    "interval_count": 3,
    "billing_type": "prepaid",
    "installments": 3,
    "gateway_affiliation_id": "C56A4180-65AA-42EC-A945-5FD21DEC0538",
    "minimum_price": 10000,
    "boleto_due_days":5,
    "customer": {
        "name": "Tony Stark",
        "email": "tonystark@avengers.com"
    },
    "card": {
        "holder_name": "Tony Stark",
        "number": "4532464862385322",
        "exp_month": 1,
        "exp_year": 26,
        "cvv": "903",
        "billing_address": {
            "line_1": "375, Av. General Justo, Centro",
            "line_2": "8º andar",
            "zip_code": "20021130",
            "city": "Rio de Janeiro",
            "state": "RJ",
            "country": "BR",
        }
    },
    "discounts": [
        {
            "cycles": 3,
            "value": 10,
            "discount_type": "percentage"
        }
    ],
    "increments": [
        {
            "cycles": 2,
            "value": 20,
            "discount_type": "percentage"
        }
    ],
    "items": [
        {
            "description": "Musculação",
            "quantity": 1,
            "pricing_scheme": {
                "price": 18990
            }
        },
        {
            "description": "Matrícula",
            "quantity": 1,
            "cycles": 1,
            "pricing_scheme": {
                "price": 5990
            }
        }
    ],
    "metadata": {
        "id": "my_subscription_id"
    }
}
{
    "payment_method": "boleto",
    "items": [
        {
            "name": "Premium",
            "description": "Sem anuncios",
            "quantity": 1,
            "pricing_scheme": {
                "price": 1490
            }
        },
        {
            "name": "Silver",
            "description": "Com anuncios",
            "quantity": 1,
            "pricing_scheme": {
                "price": 2000
            }
        }
    ],
    "customer": {
        "name": "Tony Stark",
        "email": "tonystark@avengers.com"
    }
}
using System.Collections.Generic;
using System.Web.Mvc;
using MundiAPI.PCL;
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);

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

            var card = new CreateCardRequest {
                HolderName = "Tony Stark",
                Number = "4532464862385322",
                ExpMonth = 1,
                ExpYear = 26,
                Cvv = "903",
                BillingAddress = billinAddress
            };

            var discounts = new List<CreateDiscountRequest> {
                new CreateDiscountRequest {
                Cycles = 3,
                Value = 10,
                DiscountType = "percentage"
                }
            };

            var items = new List<CreateSubscriptionItemRequest> {
                new CreateSubscriptionItemRequest {
                Description = "Musculação",
                Quantity = 1,
                PricingScheme = new CreatePricingSchemeRequest {
                Price = 18990
                }
                },

                new CreateSubscriptionItemRequest {
                Description = "Matrícula",
                Quantity = 1,
                PricingScheme = new CreatePricingSchemeRequest {
                Price = 5990
                }
                }
            };

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

            var request = new CreateSubscriptionRequest {
                PaymentMethod = "credit_card",
                Currency = "BRL",
                Interval = "month",
                IntervalCount = 3,
                BillingType = "prepaid",
                Installments = 3,
                Customer = new CreateCustomerRequest {
                Name = "Tony Stark",
                Email = "tonystark@avengers.com"
                },
                Card = card,
                Discounts = discounts,
                Items = items,
                Metadata = metadata
            };

            var response = client.Subscriptions.CreateSubscription (request);

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

You couldn't be authenticated

{
    "id": "sub_05jkdIfGYPfN26mI",
    "payment_method": "credit_card",
    "currency": "BRL",
    "interval": "month",
    "interval_count": 3,
    "gateway_affiliation_id": "C56A4180-65AA-42EC-A945-5FD21DEC0538",
    "minimum_price": 10000,
    "billing_type": "prepaid",
    "boleto_due_days":5,
    "current_period": {
        "start_at": "2016-07-19T00:00:00Z",
        "end_at": "2016-10-18T23:59:59Z"
    },
    "next_billing_at": "2016-10-19T00:00:00Z",
    "installments": 3,
    "customer": {
        "id": "cus_017228NmffGbA3d4",
        "name": "Tony Stark",
        "email": "tonystark@avengers.com",
        "delinquent": false,
        "created_at": "2016-07-12T18:25:40Z",
        "updated_at": "2016-07-12T18:25:40Z",
    },
    "credit_card": {
        "id": "card_Mome2meGz4PDNQbX",
        "holder_name": "Tony Stark",
        "masked_number": "453246******5322",
        "exp_month": 1,
        "exp_year": 17,
        "expired": false,
        "status": "active",
        "created_at": "2016-07-12T18:25:40Z",
        "update_at": "2016-07-12T18:25:40Z",
        "billing_address": {
            "id": "addr_Mome2meGz4PDNQbX",
            "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": "2016-07-12T18:25:40Z",
            "updated_at": "2016-07-12T18:25:40Z"
        }
    },
    "discounts": [
        {
            "id": "si_k2zpBDMsOs0fDfHe",
            "cycles": 3,
            "value": 10,
            "discount_type": "percentage",
            "created_at": "2016-07-12T18:25:40Z"
        }
    ],
    "increments": [
        {
            "id": "inc_IYzpxgjsOs0fDIoP",
            "cycles": 2,
            "value": 20,
            "discount_type": "percentage",
            "created_at": "2016-07-12T18:25:40Z"
        }
    ],
    "items": [
        {
            "id": "si_B6555Riyq9lj6klS",
            "description": "Musculação",
            "quantity": 1,
            "pricing_scheme": {
                "price": 18990,
                "scheme_type": "unit"
            },
            "status": "active",
            "created_at": "2016-07-12T18:25:40Z",
            "updated_at": "2016-07-12T18:25:40Z",
        },
        {
            "id": "si_lFjtC2xYGttulJpn",
            "description": "Matrícula",
            "quantity": 1,
            "cycles": 1,
            "pricing_scheme": {
                "price": 5990,
                "scheme_type": "unit"
            },
            "status": "active",
            "created_at": "2016-07-12T18:25:40Z",
            "updated_at": "2016-07-12T18:25:40Z",
        }
    ],
    "status": "active",
    "created_at": "2016-07-12T18:25:40Z",
    "updated_at": "2016-07-12T18:25:40Z",
    "metadata": {
        "id": "my_subscription_id"
    }
}
{
    "id": "sub_8RQW76TG8SOeYZro",
    "code": "3R0ZSQ5BJ5",
    "start_at": "2018-04-04T00:00:00Z",
    "interval": "month",
    "interval_count": 1,
    "billing_type": "prepaid",
    "current_cycle": {
        "id": "cycle_GvX8zgQU9NUemBm5",
        "start_at": "2018-04-04T00:00:00Z",
        "end_at": "2018-05-03T23:59:59Z",
        "billing_at": "2018-04-04T00:00:00Z"
    },
    "next_billing_at": "2018-05-04T00:00:00Z",
    "payment_method": "boleto",
    "currency": "BRL",
    "installments": 1,
    "status": "active",
    "created_at": "2018-04-04T20:59:01Z",
    "updated_at": "2018-04-04T20:59:01Z",
    "customer": {
        "id": "cus_a21Y9wCnVszRqVR5",
        "name": "Tony Stark",
        "email": "903c2a55-0ce0-47c5-8b64-fa6a3036f861@avengers.com",
        "delinquent": false,
        "created_at": "2018-04-04T20:59:01Z",
        "updated_at": "2018-04-04T20:59:01Z",
        "phones": {}
    },
    "items": [
        {
            "id": "si_6DOoWzDip7izX8xV",
            "name": "Premium",
            "description": "Sem anuncios",
            "quantity": 1,
            "status": "active",
            "created_at": "2018-04-04T20:59:01Z",
            "updated_at": "2018-04-04T20:59:01Z",
            "pricing_scheme": {
                "price": 1490,
                "scheme_type": "unit"
            }
        },
        {
            "id": "si_yp9G6e2T54t0r7OB",
            "name": "Silver",
            "description": "Com anuncios",
            "quantity": 1,
            "status": "active",
            "created_at": "2018-04-04T20:59:01Z",
            "updated_at": "2018-04-04T20:59:01Z",
            "pricing_scheme": {
                "price": 2000,
                "scheme_type": "unit"
            }
        }
    ]
}
{
    "message": "Authorization has been denied for this request."
}
 
Suggest Edits

Criar assinatura de plano

Fornecemos a possibilidade de criação de uma assinatura (subscription) a partir de plano (plan).

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

Body Params

code
string

Código da assinatura no sistema da loja.

plan_id
string
required

Código do plano.
Formato: plan_XXXXXXXXXXXXXXXX

payment_method
string
required

Meio de pagamento.
Valores possíveis: credit_card ou boleto .

start_at
date

Data de início da assinatura .
Se não for informada, a assinatura será iniciada imediatamente.

customer_id
string
required

Código do cliente.
Formato: cus_XXXXXXXXXXXXXXXX
Obrigatório, caso o customer não seja informado.

customer
object
required

Dados do cliente.
Obrigatório caso o customer_id não seja informado.
Saiba mais sobre clientes.

card
object
required

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.

discounts
array

Descontos.

increments
array

Incrementos

gateway_affiliation_id
string

Código de afiliação no gateway.

boleto_due_days
int32

Dias para expiração do boleto. (Caso não seja passado, será pego um valor padrão das configurações da loja)

metadata
object

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

 
{
    "plan_id": "plan_21r4CTG0ux77Qv13",
    "payment_method": "credit_card",
    "gateway_affiliation_id": "C56A4180-65AA-42EC-A945-5FD21DEC0538",
     "boleto_due_days":5,
    "customer": {
        "name": "Tony Stark",
        "email": "tonystark@avengers.com"
    },
    "card": {
        "holder_name": "Tony Stark",
        "number": "4532464862385322",
        "exp_month": 1,
        "exp_year": 17,
        "cvv": "903",
        "billing_address": {
            "line_1": "375, Av. General Justo, Centro",
            "line_2": "8º andar",
            "zip_code": "20021130",
            "city": "Rio de Janeiro",
            "state": "RJ",
            "country": "BR"
        }
    },
    "discounts": [
        {
            "cycles": 3,
            "value": 10,
            "discount_type": "percentage"
        }
    ],
    "increments": [
        {
            "cycles": 2,
            "value": 20,
            "discount_type": "percentage"
        }
    ],
    "metadata": {
        "id": "my_subscription_id"
    }
}
{
    "plan_id": "plan_21r4CTG0ux77Qv13",
    "customer": {
        "name": "Tony Stark",
        "email": "tonystark@avengers.com"
    },
    "payment_method": "boleto"
}
using System.Collections.Generic;
using System.Web.Mvc;
using MundiAPI.PCL;
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 planId = "plan_21r4CTG0ux77Qv13";

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

            var card = new CreateCardRequest {
                HolderName = "Tony Stark",
                Number = "4532464862385322",
                ExpMonth = 1,
                ExpYear = 26,
                Cvv = "903",
                BillingAddress = billinAddress
            };

            var discounts = new List<CreateDiscountRequest> {
                new CreateDiscountRequest {
                Cycles = 3,
                Value = 10,
                DiscountType = "percentage"
                }
            };

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

            var request = new CreateSubscriptionRequest {
                PlanId = planId,
                PaymentMethod = "credit_card",
                Currency = "BRL",
                Interval = "month",
                IntervalCount = 3,
                BillingType = "prepaid",
                Installments = 3,
                Customer = new CreateCustomerRequest {
                Name = "Tony Stark",
                Email = "tonystark@avengers.com"
                },
                Card = card,
                Discounts = discounts,
                Metadata = metadata
            };

            var response = client.Subscriptions.CreateSubscription (request);

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

You couldn't be authenticated

{
    "id": "sub_05jkdIfGYPfN26mI",
    "payment_method": "credit_card",
    "currency": "BRL",
    "interval": "month",
    "interval_count": 3,
    "billing_type": "prepaid",
    "boleto_due_days":5,
    "current_period": {
        "start_at": "2016-07-19T00:00:00Z",
        "end_at": "2016-10-18T23:59:59Z"
    },
    "next_billing_at": "2016-10-19T00:00:00Z",
    "installments": 3,
    "customer": {
        "id": "cus_017228NmffGbA3d4",
        "name": "Luke Skywalker",
        "email": "lskywalker@r2d2.com",
        "delinquent": false,
        "created_at": "2016-07-12T18:25:40Z",
        "updated_at": "2016-07-12T18:25:40Z",
    },
    "card": {
        "id": "card_Mome2meGz4PDNQbX",
        "holder_name": "Luke Skywalker",
        "masked_number": "453246******5322",
        "exp_month": 1,
        "exp_year": 17,
        "expired": false,
        "status": "active",
        "created_at": "2016-07-12T18:25:40Z",
        "update_at": "2016-07-12T18:25:40Z",
        "billing_address": {
            "id": "addr_Mome2meGz4PDNQbX",
            "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": "2016-07-12T18:25:40Z",
            "updated_at": "2016-07-12T18:25:40Z"
        }
    },
    "plan": {
        "id": "plan_21r4CTG0ux77Qv13",
        "name": "Plano Gold",
        "url": "/plan_21r4CTG0ux77Qv13/academia/plano-gold",
        "currency": "BRL",
        "interval": "month",
        "minimum_price": 10000,
        "interval_count": 3,
        "billing_type": "prepaid",
        "installments": 3,
        "status": "active",
        "created_at": "2016-07-12T18:25:40Z",
        "updated_at": "2016-07-12T18:25:40Z",
        "metadata": {
            "id": "my_plan_id"
        }
    },
    "discounts": [
        {
            "id": "si_k2zpBDMsOs0fDfHe",
            "cycles": 3,
            "value": 10,
            "discount_type": "percentage",
            "created_at": "2016-07-12T18:25:40Z"
        }
    ],
    "increments": [
        {
            "cycles": 2,
            "value": 20,
            "discount_type": "percentage"
        }
     ],
    "items": [
        {
            "id": "si_B6555Riyq9lj6klS",
            "description": "Musculação",
            "quantity": 1,
            "pricing_scheme": {
                "price": 18990
            },
            "status": "active",
            "created_at": "2016-07-12T18:25:40Z",
            "updated_at": "2016-07-12T18:25:40Z",
        },
        {
            "id": "si_lFjtC2xYGttulJpn",
            "description": "Matrícula",
            "quantity": 1,
            "cycles": 1,
            "pricing_scheme": {
                "price": 5990
            },
            "status": "active",
            "created_at": "2016-07-12T18:25:40Z",
            "updated_at": "2016-07-12T18:25:40Z",
        }
    ],
    "status": "active",
    "created_at": "2016-07-12T18:25:40Z",
    "updated_at": "2016-07-12T18:25:40Z",
    "metadata": {
        "id": "my_subscription_id"
    }
}
{
    "id": "sub_bpYjMr9f8sA6QJNg",
    "code": "XPLMBV9U10",
    "start_at": "2018-04-04T00:00:00Z",
    "interval": "month",
    "interval_count": 1,
    "billing_type": "postpaid",
    "current_cycle": {
        "id": "cycle_j6WnJ7ei1hW68bXo",
        "start_at": "2018-04-04T00:00:00Z",
        "end_at": "2018-05-03T23:59:59Z",
        "billing_at": "2018-05-04T00:00:00Z"
    },
    "next_billing_at": "2018-05-04T00:00:00Z",
    "payment_method": "boleto",
    "currency": "BRL",
    "statement_descriptor": "Spotify",
    "installments": 1,
    "status": "active",
    "created_at": "2018-04-04T21:36:13Z",
    "updated_at": "2018-04-04T21:36:13Z",
    "customer": {
        "id": "cus_qr2AgDGiOhr61Y5L",
        "name": "Tony Stark",
        "email": "cc25e912-197c-4626-a85d-8c0597e9b157@avengers.com",
        "delinquent": false,
        "created_at": "2018-04-04T21:36:13Z",
        "updated_at": "2018-04-04T21:36:13Z",
        "phones": {}
    },
    "plan": {
        "id": "plan_85AK5eF15feLKM4J",
        "name": "Premium",
        "description": "Vá de Premium. E seja feliz!",
        "url": "/plans/plan_85AK5eF15feLKM4J/mundipagg-teste/premium",
        "statement_descriptor": "Spotify",
        "interval": "month",
        "interval_count": 1,
        "billing_type": "postpaid",
        "payment_methods": [
            "boleto",
            "credit_card"
        ],
        "installments": [
            1
        ],
        "status": "active",
        "currency": "BRL",
        "created_at": "2018-04-04T21:36:09Z",
        "updated_at": "2018-04-04T21:36:09Z"
    },
    "items": [
        {
            "id": "si_xGw3AeYiaTJ639A6",
            "name": "Name - Premium",
            "description": "Test - Description",
            "quantity": 1,
            "status": "active",
            "created_at": "2018-04-04T21:36:13Z",
            "updated_at": "2018-04-04T21:36:13Z",
            "pricing_scheme": {
                "price": 1490,
                "scheme_type": "unit"
            }
        }
    ]
}
{
    "message": "Plan not found."
}
 
Suggest Edits

Obter assinatura

Este recurso possibilita, através do identificador da assinatura (subscription_id), recuperar as informações da assinatura.

 
gethttps://api.mundipagg.com/core/v1/subscriptions/subscription_id

Query Params

subscription_id
string
required

Código da assinatura.
Formato: sub_XXXXXXXXXXXXXXXX.