Listar uma recarga telefônica

Siga nosso passo a passo para listar uma recarga telefônica.

Buscar uma recarga telefônica.

1 - Esse endpoint lista uma recarga telefonica vinculada a uma conta específica.

❗️

lembre-se de sempre enviar o token(Authorization) no header da requisição.

endpoint: {{base_url}}/partner/baas/account/phone_topups/:id

verbo http GET

{{base_url}} será substituída pela URL da sua empresa.

2 - Para listar uma recarga telefônica é necessário o envio do seguintes parâmetros.

CHAVEVALORDESCRIÇÃO
id{{id}}Identificador da recarga já efetuada.
account{{account}}Conta utilizada para busca das recargas já efetuadas.

Corpo da requisição:

{
  "id":"1",
	"account":"99999999"
}

3 - Se tudo ocorrer bem, você receberá uma resposta com Status 200 OK

Corpo da resposta com sucesso:

{
	"data": {
			"id": "1",
			"type": "v3_phone_topups",
			"attributes": {
					"user_id": 1,
					"type": "PhoneTopup",
					"status": "waiting",
					"cancel_reason": null,
					"reverse_reason": null,
					"auth_code": null,
					"date": "15/12/2022",
					"value": "15.0",
					"agency": "0001",
					"account": "{{account}}",
					"tags": [],
					"ticket_code": null,
					"updated_at": "2022-03-31T08:58:13.290-03:00",
					"created_at": "2022-03-31T08:58:13.290-03:00",
					"scheduled_at": null,
					"ticketed_at": null,
					"canceled_at": null,
					"late_at": null,
					"done_at": null,
					"reversed_at": null,
					"ticket_auth_code": null,
					"ticket_cancel_reason": null,
					"errors": [],
					"display_amount": "15.0",
					"financial_institution_id": null,
					"approved_by": "NOME DO PAGADOR",
					"created_by": "NOME DO PAGADOR",
					"cancelable_by_user?": true,
					"user": {
							"name": "NOME DO PAGADOR",
							"account": "{{account}}",
							"document": "00014725836989",
							"holder": 1,
							"phone": "996526232",
							"uid": "[email protected]",
							"payment_max_value": "999999999.99",
							"info_email": "[email protected]",
							"set_password": false,
							"set_short_password": false
					},
					"liquidation_disponibility_id": null,
					"late_reason": null,
					"pix_favored": null,
					"document_number": null,
					"discount": null,
					"rebate": null,
					"interest": null,
					"other_value": null,
					"total": "15.0",
					"bank_name": null,
					"assignor": null,
					"assignor_document": null,
					"fee_amount": "0.0",
					"segmento": null,
					"favored": null,
					"transfer_reason": null,
					"bank": null,
					"history": null,
					"phoneddd": "48",
					"phonenumber": "999632541",
					"carrier": "Tim",
					"provider_id": 2086,
					"pix_transaction_id": null,
					"description": "Teste de recarga telefonica",
					"pix_transaction_account_id": null,
					"competence": null,
					"identifier": null,
					"social_security_code_description": null,
					"pix_initiation_method": "pix_key",
					"pix_purpose": "instant_payment",
					"pix_purchase_amount": "0.0"
			}
	}
}

📘

Execute um teste em nosso sandbox Clique aqui