Listar um dos pagamentos

Listar um dos Pagamentos Parceiros

1 - Esse endpoint lista um dos pagamentos parceiros.

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

endpoint: {{base_url}}/partner/baas/account/partner_payments

verbo http GET

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

{{Authorization}} enviado no header da requisição (Bearer {{token}}).

{{token}} chave de autorização da requisição.

2 - Para listar um pagamento para um parceiro é necessário o envio dos seguintes parâmetros.

CHAVE	VALOR	DESCRIÇÃO
account	{{account}}	número da conta que buscará os dados.

{
  "data": [
    {
  		"account": '999999'
    }
   ]
}

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

Retorno da requisição:

{
    "data": {
            "id": "15407",
            "type": "partner_payments",
            "attributes": {
                "user_id": 1,
                "type": "PartnerPayment",
                "status": "waiting",
                "cancel_reason": null,
                "reverse_reason": null,
                "auth_code": null,
                "date": "08/03/2022",
                "value": "216.4",
                "agency": "4298",
                "account": "{{account}}",
                "tags": [],
                "ticket_code": null,
                "updated_at": "2022-03-08T11:02:07.749-03:00",
                "created_at": "2022-03-08T11:02:07.749-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": "216.4",
                "financial_institution_id": null,
                "approved_by": "NOME DO PAGADOR",
                "created_by": "NOME DO PAGADOR",
                "cancelable_by_user?": false,
                "user": {
                    "name": "NOME DO PAGADOR",
                    "account": "{{account}}",
                    "document": "28785746007320",
                    "holder": 1,
                    "phone": "996309729",
                    "uid": "{{account}}[email protected]",
                    "payment_max_value": "999999999.99",
                    "info_email": null,
                    "set_password": false,
                    "set_short_password": false
                },
                "liquidation_disponibility_id": null,
                "late_reason": null,
                "pix_favored": null,
                "document_number": "9999999999999999999956555555555555555551621691",
                "discount": "0.0",
                "rebate": "0.0",
                "interest": "0.0",
                "other_value": "0.0",
                "total": "216.4",
                "bank_name": null,
                "assignor": null,
                "assignor_document": null,
                "fee_amount": "0.0",
                "segmento": "Órgãos Governamentais",
                "favored": null,
                "transfer_reason": null,
                "bank": null,
                "history": null,
                "phoneddd": "",
                "phonenumber": "",
                "carrier": "",
                "provider_id": null,
                "pix_transaction_id": null,
                "description": null,
                "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