v1

latestOpenAPI 3.1.02026-08-04650218.3 KB

/pre-recharge

post/transactions/pre-recharge

Headers

Authorizationstring required

access_token gerado no endpoint /auth

Content-Typestring required

Request body

type'CPF' | 'CELLPHONE' | 'EMAIL' required

Tipo do documento a ser enviado

keystring required

Número do documento sem máscara (Ex: 70729012050) ou Celular (Ex: +5511912345678)

cellphonestring

Celular do cliente no seguinte formato: +5511999998888

webhookExternalIdstring

ExternalId do webhook caso algum webhook esteja sendo utilizado.

amountnumber float required

Valor da recarga

reasonstring

Motivo da recarga

observationstring

Observação adicional

namestring

Nome do cliente

additionalTypestring

Tipo da recarga

Response

201

idstring

applicationIdstring

typestring

keystring

amountinteger

{"stackTrail":"paths:/transactions/pre-recharge:post:responses:201:content:application/json:schema:properties:consumerId","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/transactions/pre-recharge:post:responses:201:content:application/json:schema:properties:walletTransactionId","oasType":"schema","type":"unknown"}

namestring

cellphonestring

Example response

{
  "id": "c6f4fbbc7-9342-41f4-b982-237928f1debc",
  "applicationId": "24e971b7-51f5-4b91-9f3a-00298760eeba",
  "type": "CPF",
  "key": "70729012050",
  "amount": 50,
  "name": "Leonardo",
  "cellphone": "+5511999998888"
}