Factuarea APIDevelopers

Emetre un traspàs de NIF

Emet un traspàs de NIF sobre UN NIF del teu compte (company_id); retorna 201 amb el seu secret en text pla. - El secret es mostra una vegada i mai es desa (null en la repetició); requereix Idempotency-Key. - recipient_account_id opcional restringeix qui pot acceptar; expires_at per defecte és de 24 hores (màx. 7 dies). - 403 forbidden_action; 404 profile_not_found.

Requereix el scope nif_transfers:write, que * no cobreix: l'API key l'ha de llistar explícitament.

POST
/accounts/{account}/nif-transfers

Authorization

AuthorizationBearer <token>

La teva API key com a token Bearer: fact_live_… en producció, fact_test_… en sandbox. Consulta la guia d'autenticació.

A: header

Paràmetres de ruta

account*string

Identificador públic (UUID v7) del teu compte. Obtén-lo de GET /v1/me (data.account.id).

Formatuuid

Headers

Idempotency-Key*string

Clau opaca generada pel client (fins a 255 caràcters; es recomana UUID v7) que permet reintents segurs: la primera resposta s'emmagatzema i es reprodueix en les repeticions sense tornar a executar la mutació. Reutilitzar una clau amb un cos diferent retorna 422 idempotency_key_reused; els valors dels camps secrets (password, secret…) compten com a part del cos, així que reintentar amb un secret corregit sota la mateixa clau és una petició diferent, mai la repetició de la resposta anterior. Consulta la guia d'idempotència. Obligatòria en aquesta operació: repetir-la produeix un efecte irreversible (un correu enviat, un fitxer generat, una crida a un tercer o un càrrec), per la qual cosa una petició sense aquesta capçalera es rebutja amb 422 idempotency_key_required abans d'executar lògica de negoci.

Longitud1 <= length <= 255
Factuarea-Version?string

Fixa la versió de l'API (YYYY-MM-DD, versionat per data estil Stripe) per a aquesta petició; omet-lo per usar la versió fixada de la clau, o l'última si no n'hi ha cap. Versió no suportada → 400 unsupported_api_version; mal formada → 400 parameter_invalid_format. La versió efectiva es reflecteix a la capçalera de resposta Factuarea-Version. Consulta la guia de Versioning.

Formatdate

Cos de la petició

application/json

Definicions de TypeScript

Usa el tipus request body a TypeScript.

Cos de la resposta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json