Register receipt

Registers a credit received without automatically treating it as a commission.

POST/commissions/receiptscommissions:write

BEHAVIOR

The change is validated and persisted in the key account before responding. Query the returned resource as the source of truth.

EFFECT

It can change the resource and emit the corresponding domain event.

REPETITION

On network failure, confirm the resource status before retrying. Automatically redo only 429 and 5xx with backoff and jitter.

Request

sourcestring · bodySource of payment.mandatory

amountnumber · bodyAmount received.min 0.0001mandatory

currencystring · bodyISO 4217 currency.default BRLoptional

referencestring · bodyIdempotent external reference.optional

period_startstring · bodyStart of period.date-timeoptional

period_endstring · bodyEnd of period.date-timeoptional

paid_atstring · bodyCredit date.date-timemandatory

notesstring · bodyInternal notes.maxLength 2000optional

AuthorizationBearer ach_live_...

Acceptapplication/json

Scopecommissions:write

Executable example

curl

curl -X POST 'https://achadu.com/api/v1/commissions/receipts' \
  -H 'Authorization: Bearer ach_live_...' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data '{
  "source": "string",
  "amount": 10,
  "paid_at": "2026-09-01T15:00:00Z",
  "currency": "BRL",
  "reference": "string",
  "period_start": "2026-09-01T15:00:00Z"
}'

Response and errors

Every response includes request_id. Lists add pagination; mutable resources return the persisted state after the operation.

201 application/json

{
  "data": {
    "id": "com_01J...",
    "marketplace": "amazon",
    "amount": 24.73,
    "currency": "BRL",
    "status": "approved",
    "order_id": "ORDER-123",
    "occurred_at": "2026-08-31T18:20:00.000Z"
  },
  "created": true,
  "request_id": "req_01J..."
}

201Resource created and persisted.

400Invalid parameter, body or transition.

401Missing, invalid, expired or revoked key.

402The account plan does not release this interface.

403A chave precisa do escopo commissions:write.

404Feature does not exist in this account.

409The current state prevents this operation.

413The JSON body exceeds 128 KB.

429The 120 requests per minute window has been exceeded.

Register receipt

Request

Executable example

Response and errors

Related operations