mayarin
API Reference
GET
/v1/payments/{id}

Accepts a payment intent id (pi_…) or clearing transaction id (clr_…).

Path Parameters

id*string

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/payments/string"
{  "paymentIntent": {    "id": "string",    "status": "string",    "merchant": {      "id": "string",      "name": "string",      "city": "string",      "countryCode": "string",      "categoryCode": "string"    },    "amount": {      "amount": "string",      "asset": "string",      "formatted": "string",      "display": "string"    },    "settlementAsset": "string",    "provider": "string",    "payment": {      "asset": "string",      "chain": "string",      "payerAddress": "string"    },    "executionPath": "string",    "source": "string",    "metadata": {      "property1": "string",      "property2": "string"    },    "merchantReference": "string",    "clearingTransactionId": "string",    "failureReason": "string",    "createdAt": "string",    "updatedAt": "string",    "expiresAt": "string",    "confirmedAt": "string",    "completedAt": "string"  },  "clearing": {    "id": "string",    "state": "string",    "provider": "string",    "providerReference": "string",    "transactionHash": "string",    "sourceAmount": {      "amount": "string",      "asset": "string",      "formatted": "string",      "display": "string"    },    "settlementAmount": {      "amount": "string",      "asset": "string",      "formatted": "string",      "display": "string"    },    "fee": {      "amount": "string",      "asset": "string",      "formatted": "string",      "display": "string"    },    "netAmount": {      "amount": "string",      "asset": "string",      "formatted": "string",      "display": "string"    },    "rate": {      "from": "string",      "to": "string",      "scaledRate": "string",      "source": "string",      "lockedAt": "string"    },    "failure": {      "reason": "string",      "code": "string",      "at": "string"    },    "createdAt": "string",    "updatedAt": "string"  },  "deposit": {    "address": "string",    "chain": "string",    "asset": "string",    "amount": {      "amount": "string",      "asset": "string",      "formatted": "string",      "display": "string"    },    "uri": "string",    "received": {      "amount": "string",      "asset": "string",      "formatted": "string",      "display": "string"    },    "required": 0,    "reviewRequired": true,    "deposits": [      {        "txHash": "string",        "logIndex": 0,        "amount": {          "amount": "string",          "asset": "string",          "formatted": "string",          "display": "string"        },        "status": "string",        "confirmations": 0,        "firstSeenAt": "string"      }    ]  },  "timeline": [    {      "sequence": 0,      "state": "string",      "from": "string",      "occurredAt": "string"    }  ]}

Confirm a payment intent

Confirms the intent and hands it to the clearing engine. Safe to retry: confirming an intent that is already clearing returns its current position rather than starting a second one.

Retry a failed payment whose funds arrived

Reopens a `FAILED` payment at `ASSET_RECEIVED` and replays the clearing steps, for a failure since fixed (a missing swap pool, an asset not yet whitelisted) while the payer's money sat at the deposit address. Every step is idempotent per state, so nothing that already happened happens twice. A deposit-match order whose deadline passed is re-signed with the same terms and a fresh deadline. Refused with 409 when the payment has not failed or its funds never arrived.