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":"[email protected]"
},
"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": "[email protected]",
"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": "[email protected]",
"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.