Payins and deposits
Every incoming payment is a payin: statuses, the pending → settled rule and a deposit account per MID.
A payin is any incoming money for your merchant, whether it comes from a payment link or a deposit. It is the object to check to know whether you received the money.
Statuses
- Every payin starts as
pending. - It settles only from
pendingand only after Clobepay validates the payment (exact amount and asset). Anexpiredorfailedpayin never becomessettledon its own. settledAtis when it was accepted;availableAtis when the balance becomes available (while in the future it shows as “Pending settlement”).- Amounts are decimal strings; the settlement asset is
USDT.
Source
The source field tells where it came from: payment_link, deposit_account, bank_transfer, crypto_deposit or internal_transfer.
Retrieve
GET /payins filters: status, source, from, to, limit and startingAfter (cursor pagination).
curl -X GET "$CLOBEPAY_API_BASE/payins?status=pending&limit=10" \ -H "Authorization: Bearer $CLOBEPAY_API_KEY"Response
HTTP 200{
"object": "list",
"data": [
{
"id": "pi_3Kx9mQ2vR8wL0tYbA4nC1e",
"object": "payin",
"status": "pending",
"source": "payment_link",
"amount": "50.00",
"asset": "USDT",
"providerFee": null,
"netAmount": null,
"paymentLinkId": "7c2e1a4b-9d83-4f21-a6b0-2e8c91f04d17",
"providerReference": null,
"settledAt": null,
"availableAt": null,
"refundedAt": null,
"metadata": {
"cart_id": "c_77"
},
"createdAt": "2026-11-19T18:00:00.000Z",
"updatedAt": "2026-11-19T18:00:00.000Z"
}
],
"hasMore": false
}Deposit account per merchant
To receive bank transfers without creating a link for each one, every merchant has its own deposit account (in Mexico, a CLABE). Each deposit to that account is recorded as a payin of your merchant with source = deposit_account and follows the same pending → settled rule.
In Mexico the account is a CLABE. POST /deposit-accounts requires Idempotency-Keyand the body { "currency": "MXN" }. If an account in that currency already exists, the API returns the same one (HTTP 200). Each credit to that account is recorded as a payin with source = deposit_account and follows pending → settled. You receive deposit_account.created when it is created and payin.settled when the deposit is settled.
curl -X POST "$CLOBEPAY_API_BASE/deposit-accounts" \ -H "Idempotency-Key: deposit-mxn-1" \ -H "Authorization: Bearer $CLOBEPAY_API_KEY" \ -H "Content-Type: application/json" \ -d '{"currency":"MXN"}'Response
{
"id": "c5d18a90-4e27-4b6f-91c2-7a8e3d5f0146",
"object": "deposit_account",
"currency": "MXN",
"country": "MX",
"accountNumber": "646180110400000000",
"bankName": "Example Bank",
"status": "active",
"createdAt": "2026-11-19T18:00:00.000Z"
}