API reference

Every operation of the official Asaas API v3 specification exists here, with authentication, validation and the Asaas error format. Real behavior means a business engine with state; the rest answer 501 naming the operation, never fake data.

Conventions

  • Base URL: http://localhost:45445/v3.
  • Authentication: the access_token header with the account's key, as in Asaas. Each key is an account, with its own walletId and balance.
  • Errors: HTTP 400 with {"errors":[{"code":"…","description":"…"}]}, the codes and sentences Asaas sends (a declined card is invalid_action, not invalid_creditCard).
  • Lists: offset and limit, answered with totalCount and hasMore.
  • Money: kept in integer cents inside, answered in reais like Asaas.

The /v3 operations

Open an operation for its parameters, body fields, a request example and every response with its example, errors included, from the official specification.

Admin and test routes

They do not exist in Asaas. /_admin (the clock, accounts and keys, webhooks, cards, payer notifications) and /_mock (one call to move a charge to a state) need no access_token and go off with ADMIN_ENABLED=false; the panel is built on them. Open a route for what it takes and what it answers: every answer below, errors included, was captured from a run of the image.

When your code may also run against the real sandbox, prefer its own POST /v3/sandbox/payment/{id}/confirm and …/overdue to the /_mock routes.