v1

latestOpenAPI 3.1.02026-07-24290162.6 KB

Inserir saldo na carteira do usuário

post/api/v2/me/balance

Headers

Acceptstring required

Content-Typestring required

Authorizationstring required

User-Agentstring required

É obrigatório que seja adicionado o cabeçalho HTTP User-Agent com o nome da sua aplicação junto a um email de contato/suporte.

Request body

gatewaystring required

Ex: yapay-transparente

valuestring required

Valor. Ex: 10.50

slugstring required

Ex: pix | boleto

redirect_urlstring

https://seuenderecoderetorno.me

finger_printstring

Finger Print

company_namestring

Nome Empresa

cnpjstring

CNPJ Empresa

Response

200

redirectstring

messagestring

{"stackTrail":"paths:/api/v2/me/balance:post:responses:200:content:application/json:schema:properties:digitable","oasType":"schema","type":"unknown"}

Example response

{
  "payment": {
    "id": "c7793ea8-ee50-45a0-9f0c-809ff34c17c8",
    "protocol": "PAY-2022032545",
    "value": 1000,
    "status": "pending",
    "redirect": "https://sandbox.melhorenvio.com.br",
    "created_at": "2022-03-30 18:06:55",
    "updated_at": "2022-03-30 18:06:55",
    "gateway": {
      "id": 2,
      "slug": "mercado-pago",
      "name": "Mercado Pago",
      "status": "available",
      "min_value": 1,
      "picture": "https://melhorenvio.s3.sa-east-1.amazonaws.com/payment-gateways/mercado-pago.png",
      "website": "https://www.mercadopago.com.br"
    },
    "transaction": {
      "id": "a9f49db7-2dd5-4e79-bd06-3a90829e359d",
      "protocol": "TRN-20220357461",
      "value": 1000,
      "type": "credit",
      "status": "pending",
      "created_at": "2022-03-30 18:06:55",
      "reason": {
        "id": 6,
        "label": "Inserção de crédito"
      }
    },
    "user": {
      "id": "779f4d62-c5b4-41e3-b0b0-ae2eb1509825",
      "protocol": 3477,
      "firstname": "Magno",
      "lastname": "xxxxxxxxx",
      "email": "x@melhorenvio.com",
      "document": "xxxxxxxxxxx",
      "birthdate": "xxxx-xx-xx 00:00:00",
      "email_confirmed_at": "2021-06-22 12:17:00",
      "access_at": "2021-09-01 12:31:29",
      "created_at": "2021-06-22 12:17:00",
      "updated_at": "2021-06-22 12:17:38"
    }
  },
  "redirect": "https://sandbox.melhorenvio.com.br/checkout/notify/2"
}