Skip to main content
POST
/
payment-requests
/
{paymentRequestId}
/
settlements
Settle a payment request
curl --request POST \
  --url https://api.venlyfinance.com/v1/payment-requests/{paymentRequestId}/settlements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 25,
  "currency": "USD",
  "idempotencyKey": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}
'
{
  "success": true,
  "result": {
    "id": "d4e5f6a7-b8c9-4012-8345-6789abcdef01",
    "accountId": "b2a1f0e9-8c7d-4e3a-9f21-0a1b2c3d4e5f",
    "amount": {
      "fiat": 25,
      "crypto": "25.000000"
    },
    "settlementAmount": {
      "fiat": 25,
      "crypto": "25.000000"
    },
    "currency": "USD",
    "externalId": "order-67890",
    "status": "SETTLING",
    "executions": [
      {
        "id": "a7b8c9d0-e1f2-4345-b678-9abcdef01234",
        "walletPairId": "f6a7b8c9-d0e1-4234-a567-89abcdef0123",
        "type": "SETTLEMENT",
        "chain": "BASE",
        "asset": "USDC",
        "amount": 25,
        "exchangeRate": 1,
        "status": "PENDING",
        "createdAt": "2026-01-15T10:00:00Z",
        "updatedAt": "2026-01-15T10:00:00Z"
      }
    ],
    "createdAt": "2026-01-15T09:30:00Z",
    "updatedAt": "2026-01-15T10:00:00Z"
  }
}
Settles a reserved payment request. The call returns 202 Accepted with status: SETTLING and its executions PENDING; the request becomes SETTLED once those transfers confirm on-chain. amount is the final figure in the authorized currency, and the executions that run follow from how it compares to the authorized amount:
Settlement amountExecutions
Equal to the authorized amountone SETTLEMENT
Below the authorized amountSETTLEMENT + REFUND returning the difference to the account wallet
Above the authorized amountSETTLEMENT (the full authorized amount) + SETTLEMENT_OVERAGE collecting the extra from the account wallet
Send a unique idempotencyKey; repeating the same key and body returns the original result. Concept guide: Payment requests
amount, settlementAmount, and settledAmount come back as objects — { "fiat": <number>, "crypto": "<string>" }. To settle a request by its card-provider reference instead of its ID, use settle by reference.

Authorizations

​
Authorization
string
header
required

OAuth2 client credentials flow. Token endpoints:

Path Parameters

​
paymentRequestId
string<uuid>
required

Unique payment request identifier

Body

application/json
​
amount
number
required

Final settlement amount, in the authorized fiat currency

​
currency
string
required

Must match the authorized currency

Maximum string length: 10
​
idempotencyKey
string
required

Unique key to prevent duplicate operations on retry

Maximum string length: 255

Response

Settlement accepted; on-chain processing is asynchronous

​
success
boolean

Indicates whether the request was successful

​
result
object