Settlements
Execute quote-backed settlement into local destinations.
Create settlement
POST /v1/settlements
curl "$M2_BASE_URL/v1/settlements" \
-H "Authorization: Bearer $M2_API_KEY" \
-H "Idempotency-Key: settlement-order-1001" \
-H "Content-Type: application/json" \
-d '{
"quote_id": "quo_01JEXAMPLE",
"destination": {
"type": "bank_account",
"country": "MX",
"account_holder_name": "Acme Mexico SA",
"account_number": "0000000000"
},
"metadata": {
"order_id": "order_1001"
}
}'Retrieve settlement
GET /v1/settlements/{id}
Terminal statuses
| Status | Final? | Meaning |
|---|---|---|
completed | Yes | Destination rail confirmed delivery. |
returned | Yes | Funds were returned after failed delivery. |
failed | Yes | Settlement could not proceed. |
rejected | Yes | Risk or compliance controls blocked the flow. |