Home
Documentation
Resources
Partners
Community

Resources

Check for updates on our solutions and system performance, or request technical support.

Partners

Discover our program for agencies or developers that offer integration services and sellers who want to hire them.

Community

Get the latest news, ask others for help and share your knowledge.

Get agreement - Agreements - Mercado Pago Developers

Intelligent search powered by OpenAI 

Get agreement

GET

https://api.mercadopago.com/v2/wallet_connect/agreements/{agreement_id}
Endpoint to get an agreement by id. An agreement is an authorization link that the buyer receives to allow the seller to access their Mercado Pago wallet to debit the payment.
Request's parameters
PATH
agreement_id
string

REQUIRED

Unique ID that identifies an agreement.
QUERY
client.id
number
Unique ID that identifies a client.
HEADER
x-platform-id
string
Field intended for platforms or modules that offer Mercado Pago in their solutions.
Response parameters
id
string
Unique ID that identifies an agreement.
date_created
string
Agreement creation date.
date_cancelled
string
Agreement cancelled date.
date_expire
string
Agreement expiration date.
Errors

400Error

400

Bad-Request

404Error

404

Not-Found

500Error

500

Error

Request
curl -X GET \
    'https://api.mercadopago.com/v2/wallet_connect/agreements/{agreement_id}?client.id=1451895580758649'\
    -H 'Content-Type: application/json' \
       -H 'x-platform-id: YOUR_PLATFORM_ID' \
       -H 'Authorization: Bearer TEST-8971*********918-01191*********5874530a4*********4799fdf-1*********' \
    
Sample answer
{
  "id": "b1234e5678b91c23a456e78912345b67",
  "date_created": "2023-02-16T00:02:52Z",
  "date_cancelled": "2023-02-16T00:02:52Z",
  "date_expire": "2023-02-16T00:02:52Z",
  "validation_code": "790eb6591ff68df74c57930551ed980239f4538a7e530",
  "approval_uri": "https://www.mercadopago.com.ar/v1/wallet_agreement/b1234e5678b91c23a456e78912345b67",
  "redirect_uri": "https://www.mercadopago.com/",
  "status": "confirmed_by_user",
  "external_flow_id": "external_flow_id",
  "external_user": {
    "id": "usertest",
    "description": "Test account"
  },
  "agreement_data": {
    "validation_amount": 3.14,
    "description": "Test agreement"
  },
  "site_id": "MLA",
  "application_id": 123456789,
  "collector_id": 987654,
  "model_version": 2
}