post https://removeappsample.yourhost.com.br/payments
Neste endpoint nosso protocolo espera que você retorne quais as formas de parcelamento para uma forma de pagamento.
/# Request Bod
{
"id": "8b5bf004-cb12-419a-a551-22b1cbab5078",
"nsu": 1,
"amount": 100,
"payment_method": "Visa",
"card": {
"brand": "Visa",
"number": "4551870000000183",
"exp_month": "10",
"exp_year": "2019",
"holder_name": "TESTE CIELO",
"security_code": "123"
},
"installments": 1,
"request": {
"ip_address": "127.0.0.1",
"session_id": "wim2gfti63d4e9dcgvdnqdb7mwytahkf",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/68.0.3",
"device_finger_print": "a5eb67bc403ed1021b91c20f1cb4c6a0"
},
"buyer": {
"id": "bcb5d867-3a11-4ea2-b79e-0193e9152b2e",
"name": "Comprador Teste",
"document_number": "04136081820",
"document_type": "CPF",
"email": "[email protected]",
"phone": "1140107676",
"billing_address": {
"city": "RIBEIRÃO PRETO",
"state": "SP",
"street": "R BERNARDINO DE CAMPOS",
"number": "1001",
"neighborhood": "HIGIENOPOLIS",
"country": "BRA",
"zipcode": "14015130"
}
},
"cart": {
"delivery_address":{
"city": "RIBEIRÃO PRETO",
"state": "SP",
"street": "R BERNARDINO DE CAMPOS",
"number": "1001",
"neighborhood": "HIGIENOPOLIS",
"country": "BRA",
"zipcode": "14015130"
},
"items": [
{
"id", 1,
"ean_13": "1234567890123",
"reference_code": 1,
"name": "Produto de Teste",
"quantity": 1,
"unit": 100,
"total": 100,
"discount": 0
}
],
"shipping_total": 0
}
}Request Body - Descrição dos Campos
| Parameter | Type | Description |
|---|---|---|
| id | uuid | ID da transação na Convertize |
| nsu | integer | Número sequencial único da transação |
| amount | integer | Valor total do pagamento em centavos |
| payment_method | string | Nome da forma de pagamento, Veja a lista |
| card | object | Dados do cartão |
| => brand | string | Bandeira do Cartão |
| => number | string | Número do Cartão |
| => exp_month | string | Mes de Validade do Cartão |
| => exp_year | string | Ano de Validade do Cartão |
| => holder_name | string | Nome do Cartão |
| => security_code | string | Código de segurança do Cartão |
| installments | integer | Número de parcelas |
| request | object | Dados do request do usuário |
| => ip_address | string | Endereço de IP do comprador |
| => session_id | string | Id da sessão do comprador |
| => user_agent | string | User Agent do comprador |
| => device_finger_print | string | Fingerprint representa caracteristicas do dispositivo usado para fazer o pedido |
| buyer | object | Dados do comprador |
| => id | uuid | ID do comprador na Convertize |
| => name | string | Nome do comprador |
| => document_number | string | Número do documento do comprador |
| => document_type | string | Tipo do documento do comprador |
| string | E-mail do comprador | |
| => phone | string | Telefone do comprador |
| => billing_address | object | Dados do endereço de entrega |
| =>=> city | string | Cidade do endereço de pagamento |
| =>=> state | string | Estado do endereço de pagamento |
| =>=> street | string | Rua do endereço de pagamento |
| =>=> number | string | Número do endereço de pagamento |
| =>=> neighborhood | string | Bairro do endereço de pagamento |
| =>=> country | string | Pais do endereço de pagamento |
| =>=> zipcode | string | Zipcode (CEP) do endereço de pagamento |
| cart | object | Dados do carrinho |
| => delivery_address | object | Dados do endereço de entrega |
| =>=> city | string | Cidade do endereço de entrega |
| =>=> state | string | Estado do endereço de entrega |
| =>=> street | string | Rua do endereço de entrega |
| =>=> number | string | Número do endereço de entrega |
| =>=> neighborhood | string | Bairro do endereço de entrega |
| =>=> country | string | Pais do endereço de entrega |
| =>=> zipcode | string | Zipcode (CEP) do endereço de entrega |
| =>items | array of object | Lista de objetos com dados dos items |
| =>=>id | integer | ID do item na Convertize |
| =>=>ean_13 | string | EAN 13 do item na Convertize |
| =>=>reference_code | string | Código de Referência do item na Convertize |
| =>=>name | string | Nome do item |
| =>=>quantity | integer | Quantidade deste item no carrinho |
| =>=>unit | integer | Preço Unitário do item em centavos |
| =>=>total | integer | Preço Unitário do item em centavos |
| =>=>discount | integer | Desconto total do item em centavos |
| =>shipping_total | integer | Valor total do frete em centavos |
| notification_url | string | Url para notificação com o status das transações |
| return_url | string | Url de retorno (usada somente no fluxo com redirect) |
Response Body
| Parameter | Type | Description |
|---|---|---|
| id | uuid | ID da transação na Convertize |
| status | string | Status da transação (APPROVED, DENIED, AUTHENTICATING ou APPROVED_PENDING_CAPTURE) |
| payment_id | string | ID de do pagamento gerado pela sua WebAPI |
| nsu | string | Número sequencial unico |
| tid | string | ID da transação |
| redirect_url(optional) | string | URL de authenticação usando em pagamentos com redirecionamentos |
| boleto_url(optional) | string | URL do boleto usado somente em pagamentos com Boleto |
| barcode(optional) | string | Barcode do Boleto, usado somente em pagamentos com Boleto |
| billet_html(optional) | string | URL do boleto em formato HTML, usado somente em pagamentos com Boleto |
| billet_pdf(optional) | string | URL do boleto em formato PDF, usado somente em pagamentos com Boleto |
| code(optional) | string | Código de erro |
| message(optional) | string | Mensagem de erro |
| token(optional) | string | Token referente ao cartão ou forma de pagamento |
| qrcode(optional) | string | Código do QRCODE, usado somente para pagamentos via QRCODE |
| qrcode_image(optional) | string | Image do QRCODE em base64, usado somente para pagamentos via QRCODE |