For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
StatusDashboard
  • Getting Started
    • Introduction
    • Authentication
    • Rate Limits
    • Error Handling
  • Guides
    • Cash-In (Receiving Payments)
    • Cash-Out (Sending Payments)
    • PIX Keys Management
    • Webhooks Integration
    • MED (Special Returns)
  • API Reference
      • POSTRespond to MED Request
      • GETList MED by Status
LogoLogo
StatusDashboard
API ReferenceMed

Respond to MED Request

POST
https://api.brzip.com.br/api/v1/pix/med/:med_id/respond
POST
/api/v1/pix/med/:med_id/respond
$curl -X POST https://api.brzip.com.br/api/v1/pix/med/med_id/respond \
>     -H "Content-Type: application/json" \
>     -d '{
>  "action": "approve"
>}'
1{}
Responds to an inbound MED (Special Return Mechanism) request. **Possible actions:** - `approve` — Approves the return (captures the precautionary hold and credits the funds) - `reject` — Rejects the return (releases the precautionary hold) **Scope:** `pix:med:write`
Was this page helpful?
Previous

List MED by Status

Next
Built with

Responds to an inbound MED (Special Return Mechanism) request.

Possible actions:

  • approve — Approves the return (captures the precautionary hold and credits the funds)
  • reject — Rejects the return (releases the precautionary hold)

Scope: pix:med:write

Path parameters

med_idstringRequired
MED request ID

Request

This endpoint expects an object.
actionenumRequired
Action to take on the MED request
Allowed values:
reasonstringOptional

Reason for the decision (optional)

Response

MED response recorded

Errors

404
Not Found Error