Record Mercury Bank Transaction As Payment
POST/api/mercury/bank-transactions/:transaction/record-payment
Records an outgoing transfer as a payment against a bill (bill), purchase invoice (purchase-invoice) or vendor deposit (vendor-deposit), for the transfer amount and dated on the bank date, then matches it. The amount may not exceed what is still unpaid on the document, and the document must be in USD. Under a bill payment approval policy a purchase invoice payment no approval covered is still recorded (the money already moved) and flagged as paid outside approval.
accounting:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token and the Record bank transactions permission (mercury.record). It records money that has already moved, so it never needs the Pay with Mercury permission (mercury.pay); roles and users that held mercury.pay when mercury.record was introduced were given it automatically.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.