{"openapi":"3.0.0","paths":{"/v1/auth/sign-up/email":{"post":{"description":"Creates a user account using email, password, and display name. Returns an active JWT token upon successful registration.","operationId":"AuthController_signUp_v1","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignUpEmailDto"},"examples":{"default":{"summary":"Standard user registration","value":{"email":"developer@fintech.io","password":"SecurePassword123!","name":"Jane Smith"}}}}}},"responses":{"201":{"description":"User successfully created and authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JwtResponseDto"}}}},"400":{"description":"Validation failed or email already registered.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}}},"summary":"Register a new partner developer or operator user","tags":["01. Authentication"]}},"/v1/auth/sign-in/email":{"post":{"description":"Validates credentials against registered users and issues a stateless Bearer JWT token for subsequent API calls.","operationId":"AuthController_signIn_v1","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignInEmailDto"},"examples":{"default":{"summary":"Demo partner login","value":{"email":"client@rook.com","password":"client"}}}}}},"responses":{"200":{"description":"Successfully authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JwtResponseDto"}}}},"400":{"description":"Malformed request body or validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}},"401":{"description":"Invalid credentials or inactive account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}}},"summary":"Authenticate user and obtain JWT access token","tags":["01. Authentication"]}},"/v1/auth/session":{"get":{"description":"Extracts identity information from the verified JWT access token, returning the user ID, email, name, and timestamps.","operationId":"AuthController_getSession_v1","parameters":[],"responses":{"200":{"description":"Current session user profile successfully retrieved."},"401":{"description":"Missing or expired Bearer token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}}},"security":[{"bearer":[]}],"summary":"Retrieve currently authenticated user profile and roles","tags":["01. Authentication"]}},"/v1/auth/invitations/{token}":{"get":{"operationId":"InvitationsController_resolve_v1","parameters":[{"name":"token","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"404":{"description":"Unknown token."},"410":{"description":"Expired or used."}},"summary":"Describe a pending user invitation","tags":["01. Authentication"]}},"/v1/auth/invitations/{token}/accept":{"post":{"operationId":"InvitationsController_accept_v1","parameters":[{"name":"token","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptInvitationDto"}}}},"responses":{"404":{"description":"Unknown token."},"410":{"description":"Expired or used."},"422":{"description":"Invalid password."}},"summary":"Set the password and activate the user","tags":["01. Authentication"]}},"/organizations":{"post":{"description":"Provisions a new tenant organization entity and atomically links the authenticated user as an active admin member. The returned organization can be immediately specified in x-organization-id headers for quotes and orders.","operationId":"OrganizationsController_create[0]","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrganizationDto"},"examples":{"default":{"summary":"Standard entity creation","value":{"name":"Acme Payments S.A.S.","countryId":"CO","kybData":{"taxId":"900123456-1","taxIdType":"NIT"}}}}}}},"responses":{"201":{"description":"Organization successfully created with admin membership.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationResponseDto"}}}},"400":{"description":"Validation failed (name is required, countryId must be 2 characters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}},"401":{"description":"Missing or expired Bearer token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}}},"security":[{"bearer":[]}],"summary":"Create a new organization and assign caller as admin","tags":["05. Organizations"]},"get":{"description":"Returns tenant organizations, membership roles, and status for the current user. Integrators should copy the organizationId to pass in the x-organization-id header on tenant-scoped endpoints.","operationId":"OrganizationsController_getUserOrganizations[0]","parameters":[{"name":"page","required":false,"in":"query","description":"Page number (1-based index)","schema":{"minimum":1,"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Number of items per page","schema":{"minimum":1,"maximum":100,"default":10,"type":"number"}},{"name":"role","required":false,"in":"query","description":"Filter by member role (admin, operator, approver, viewer, etc.)","schema":{"type":"string"}},{"name":"userId","required":false,"in":"query","description":"Filter by user ID","schema":{"type":"string"}},{"name":"organizationId","required":false,"in":"query","description":"Filter by organization ID","schema":{"type":"string"}}],"responses":{"200":{"description":"List of active organization memberships and pagination metadata."},"401":{"description":"Missing or expired Bearer token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}}},"security":[{"bearer":[]}],"summary":"List organizations the authenticated user belongs to","tags":["05. Organizations"]}},"/v1/organizations":{"post":{"description":"Provisions a new tenant organization entity and atomically links the authenticated user as an active admin member. The returned organization can be immediately specified in x-organization-id headers for quotes and orders.","operationId":"OrganizationsController_create[1]_v1","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrganizationDto"},"examples":{"default":{"summary":"Standard entity creation","value":{"name":"Acme Payments S.A.S.","countryId":"CO","kybData":{"taxId":"900123456-1","taxIdType":"NIT"}}}}}}},"responses":{"201":{"description":"Organization successfully created with admin membership.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationResponseDto"}}}},"400":{"description":"Validation failed (name is required, countryId must be 2 characters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}},"401":{"description":"Missing or expired Bearer token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}}},"security":[{"bearer":[]}],"summary":"Create a new organization and assign caller as admin","tags":["05. Organizations"]},"get":{"description":"Returns tenant organizations, membership roles, and status for the current user. Integrators should copy the organizationId to pass in the x-organization-id header on tenant-scoped endpoints.","operationId":"OrganizationsController_getUserOrganizations[1]_v1","parameters":[{"name":"page","required":false,"in":"query","description":"Page number (1-based index)","schema":{"minimum":1,"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Number of items per page","schema":{"minimum":1,"maximum":100,"default":10,"type":"number"}},{"name":"role","required":false,"in":"query","description":"Filter by member role (admin, operator, approver, viewer, etc.)","schema":{"type":"string"}},{"name":"userId","required":false,"in":"query","description":"Filter by user ID","schema":{"type":"string"}},{"name":"organizationId","required":false,"in":"query","description":"Filter by organization ID","schema":{"type":"string"}}],"responses":{"200":{"description":"List of active organization memberships and pagination metadata."},"401":{"description":"Missing or expired Bearer token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}}},"security":[{"bearer":[]}],"summary":"List organizations the authenticated user belongs to","tags":["05. Organizations"]}},"/beneficiaries":{"post":{"description":"Creates a beneficiary bank account record tied to the caller organization and asynchronously triggers registration with active destination liquidity providers (e.g. Velafi, Hi-Fi). Accounts are identified by country-specific banking rails (e.g. 18-digit CLABE for Mexico, Routing/Account for USA, IBAN for Europe, Bank/Account for Colombia).","operationId":"BeneficiariesController_create[0]","parameters":[{"name":"x-organization-id","required":false,"in":"header","description":"Tenant organization ID for multi-entity developers. Defaults to primary organization if omitted.","schema":{"type":"string","example":"51e0dbd1-5e9f-4a84-ad83-e747e60f269c"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBeneficiaryDto"},"examples":{"colombiaAch":{"summary":"Colombia (COP) - Bancolombia ACH","value":{"currency":"COP","name":"Textiles Medellín S.A.S.","countryId":"CO","bankName":"Bancolombia","accountNumber":"9007712345","accountType":"savings","extraDetails":{"identificationType":"NIT","identificationNumber":"900123456-1"}}},"mexicoSpei":{"summary":"Mexico (MXN) - SPEI CLABE","value":{"currency":"MXN","name":"Comercializadora Azteca S.A. de C.V.","countryId":"MX","bankName":"BBVA México","accountNumber":"012180001234567890","accountType":"checking","extraDetails":{"rfc":"CAZ120315ABC"}}},"unitedStatesAch":{"summary":"United States (USD) - ACH / Domestic Wire","value":{"currency":"USD","name":"Miami Supplies LLC","countryId":"US","bankName":"Wells Fargo Bank, N.A.","accountNumber":"5501238901","accountType":"checking","routingNumber":"121000248","swiftCode":"WFBIUS6S","extraDetails":{"ein":"12-3456789","address":"100 Biscayne Blvd, Miami, FL 33132"}}},"europeSepa":{"summary":"Europe (EUR) - SEPA IBAN","value":{"currency":"EUR","name":"Berlin Parts GmbH","countryId":"DE","bankName":"Deutsche Bank","accountNumber":"DE89370400440532013000","accountType":"checking","swiftCode":"DEUTDEDDFXX","extraDetails":{"vatNumber":"DE123456789"}}}}}}},"responses":{"201":{"description":"Beneficiary created successfully and queued for upstream liquidity provider registration."},"400":{"description":"Validation failed or missing required banking fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}},"403":{"description":"Caller does not have access to specified organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}}},"security":[{"bearer":[]}],"summary":"Register a recipient bank account for cross-border payouts","tags":["04. Beneficiaries (Bank Accounts)"]},"get":{"description":"Retrieves beneficiaries associated with the organization, optionally filtered by country or search term.","operationId":"BeneficiariesController_findByOrganization[0]","parameters":[{"name":"x-organization-id","required":false,"in":"header","description":"Tenant organization ID for multi-entity developers. Defaults to primary organization if omitted.","schema":{"type":"string","example":"51e0dbd1-5e9f-4a84-ad83-e747e60f269c"}},{"name":"page","required":false,"in":"query","description":"Page number (1-based index)","schema":{"minimum":1,"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Number of items per page","schema":{"minimum":1,"maximum":100,"default":10,"type":"number"}},{"name":"name","required":false,"in":"query","description":"Filter by beneficiary name (partial match)","schema":{"type":"string"}},{"name":"countryId","required":false,"in":"query","description":"Filter by country ID/code","schema":{"type":"string"}},{"name":"bankName","required":false,"in":"query","description":"Filter by bank name","schema":{"type":"string"}},{"name":"accountNumber","required":false,"in":"query","description":"Filter by account number","schema":{"type":"string"}},{"name":"accountType","required":false,"in":"query","description":"Filter by account type (checking, savings)","schema":{"type":"string"}},{"name":"routingNumber","required":false,"in":"query","description":"Filter by routing number","schema":{"type":"string"}},{"name":"swiftCode","required":false,"in":"query","description":"Filter by SWIFT code","schema":{"type":"string"}}],"responses":{"200":{"description":"List of beneficiaries retrieved successfully."}},"security":[{"bearer":[]}],"summary":"List recipient bank accounts for the caller organization","tags":["04. Beneficiaries (Bank Accounts)"]}},"/v1/beneficiaries":{"post":{"description":"Creates a beneficiary bank account record tied to the caller organization and asynchronously triggers registration with active destination liquidity providers (e.g. Velafi, Hi-Fi). Accounts are identified by country-specific banking rails (e.g. 18-digit CLABE for Mexico, Routing/Account for USA, IBAN for Europe, Bank/Account for Colombia).","operationId":"BeneficiariesController_create[1]_v1","parameters":[{"name":"x-organization-id","required":false,"in":"header","description":"Tenant organization ID for multi-entity developers. Defaults to primary organization if omitted.","schema":{"type":"string","example":"51e0dbd1-5e9f-4a84-ad83-e747e60f269c"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBeneficiaryDto"},"examples":{"colombiaAch":{"summary":"Colombia (COP) - Bancolombia ACH","value":{"currency":"COP","name":"Textiles Medellín S.A.S.","countryId":"CO","bankName":"Bancolombia","accountNumber":"9007712345","accountType":"savings","extraDetails":{"identificationType":"NIT","identificationNumber":"900123456-1"}}},"mexicoSpei":{"summary":"Mexico (MXN) - SPEI CLABE","value":{"currency":"MXN","name":"Comercializadora Azteca S.A. de C.V.","countryId":"MX","bankName":"BBVA México","accountNumber":"012180001234567890","accountType":"checking","extraDetails":{"rfc":"CAZ120315ABC"}}},"unitedStatesAch":{"summary":"United States (USD) - ACH / Domestic Wire","value":{"currency":"USD","name":"Miami Supplies LLC","countryId":"US","bankName":"Wells Fargo Bank, N.A.","accountNumber":"5501238901","accountType":"checking","routingNumber":"121000248","swiftCode":"WFBIUS6S","extraDetails":{"ein":"12-3456789","address":"100 Biscayne Blvd, Miami, FL 33132"}}},"europeSepa":{"summary":"Europe (EUR) - SEPA IBAN","value":{"currency":"EUR","name":"Berlin Parts GmbH","countryId":"DE","bankName":"Deutsche Bank","accountNumber":"DE89370400440532013000","accountType":"checking","swiftCode":"DEUTDEDDFXX","extraDetails":{"vatNumber":"DE123456789"}}}}}}},"responses":{"201":{"description":"Beneficiary created successfully and queued for upstream liquidity provider registration."},"400":{"description":"Validation failed or missing required banking fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}},"403":{"description":"Caller does not have access to specified organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}}},"security":[{"bearer":[]}],"summary":"Register a recipient bank account for cross-border payouts","tags":["04. Beneficiaries (Bank Accounts)"]},"get":{"description":"Retrieves beneficiaries associated with the organization, optionally filtered by country or search term.","operationId":"BeneficiariesController_findByOrganization[1]_v1","parameters":[{"name":"x-organization-id","required":false,"in":"header","description":"Tenant organization ID for multi-entity developers. Defaults to primary organization if omitted.","schema":{"type":"string","example":"51e0dbd1-5e9f-4a84-ad83-e747e60f269c"}},{"name":"page","required":false,"in":"query","description":"Page number (1-based index)","schema":{"minimum":1,"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Number of items per page","schema":{"minimum":1,"maximum":100,"default":10,"type":"number"}},{"name":"name","required":false,"in":"query","description":"Filter by beneficiary name (partial match)","schema":{"type":"string"}},{"name":"countryId","required":false,"in":"query","description":"Filter by country ID/code","schema":{"type":"string"}},{"name":"bankName","required":false,"in":"query","description":"Filter by bank name","schema":{"type":"string"}},{"name":"accountNumber","required":false,"in":"query","description":"Filter by account number","schema":{"type":"string"}},{"name":"accountType","required":false,"in":"query","description":"Filter by account type (checking, savings)","schema":{"type":"string"}},{"name":"routingNumber","required":false,"in":"query","description":"Filter by routing number","schema":{"type":"string"}},{"name":"swiftCode","required":false,"in":"query","description":"Filter by SWIFT code","schema":{"type":"string"}}],"responses":{"200":{"description":"List of beneficiaries retrieved successfully."}},"security":[{"bearer":[]}],"summary":"List recipient bank accounts for the caller organization","tags":["04. Beneficiaries (Bank Accounts)"]}},"/beneficiaries/{id}":{"get":{"description":"Returns the full bank details for a single beneficiary and indicates which providers have recognized this bank account.","operationId":"BeneficiariesController_findOne[0]","parameters":[{"name":"x-organization-id","required":false,"in":"header","description":"Tenant organization ID for multi-entity developers. Defaults to primary organization if omitted.","schema":{"type":"string","example":"51e0dbd1-5e9f-4a84-ad83-e747e60f269c"}},{"name":"id","required":true,"in":"path","description":"Beneficiary UUID identifier","schema":{"example":"84ecbd88-c083-49d6-a780-ef7da4b15e64","type":"string"}}],"responses":{"200":{"description":"Beneficiary record found."},"404":{"description":"Beneficiary not found under organization context.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}}},"security":[{"bearer":[]}],"summary":"Retrieve beneficiary details and provider registration status","tags":["04. Beneficiaries (Bank Accounts)"]},"patch":{"description":"Modifies recipient bank information. If banking details change, re-triggers provider registration.","operationId":"BeneficiariesController_update[0]","parameters":[{"name":"x-organization-id","required":false,"in":"header","description":"Tenant organization ID for multi-entity developers. Defaults to primary organization if omitted.","schema":{"type":"string","example":"51e0dbd1-5e9f-4a84-ad83-e747e60f269c"}},{"name":"id","required":true,"in":"path","description":"Beneficiary UUID identifier","schema":{"example":"84ecbd88-c083-49d6-a780-ef7da4b15e64","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBeneficiaryDto"}}}},"responses":{"200":{"description":"Beneficiary updated successfully."},"404":{"description":"Beneficiary not found under organization context.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}}},"security":[{"bearer":[]}],"summary":"Update beneficiary details","tags":["04. Beneficiaries (Bank Accounts)"]},"delete":{"description":"Removes a recipient bank account from the active organization directory.","operationId":"BeneficiariesController_remove[0]","parameters":[{"name":"x-organization-id","required":false,"in":"header","description":"Tenant organization ID for multi-entity developers. Defaults to primary organization if omitted.","schema":{"type":"string","example":"51e0dbd1-5e9f-4a84-ad83-e747e60f269c"}},{"name":"id","required":true,"in":"path","description":"Beneficiary UUID identifier","schema":{"example":"84ecbd88-c083-49d6-a780-ef7da4b15e64","type":"string"}}],"responses":{"200":{"description":"Beneficiary removed successfully."},"404":{"description":"Beneficiary not found under organization context.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}}},"security":[{"bearer":[]}],"summary":"Delete a beneficiary","tags":["04. Beneficiaries (Bank Accounts)"]}},"/v1/beneficiaries/{id}":{"get":{"description":"Returns the full bank details for a single beneficiary and indicates which providers have recognized this bank account.","operationId":"BeneficiariesController_findOne[1]_v1","parameters":[{"name":"x-organization-id","required":false,"in":"header","description":"Tenant organization ID for multi-entity developers. Defaults to primary organization if omitted.","schema":{"type":"string","example":"51e0dbd1-5e9f-4a84-ad83-e747e60f269c"}},{"name":"id","required":true,"in":"path","description":"Beneficiary UUID identifier","schema":{"example":"84ecbd88-c083-49d6-a780-ef7da4b15e64","type":"string"}}],"responses":{"200":{"description":"Beneficiary record found."},"404":{"description":"Beneficiary not found under organization context.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}}},"security":[{"bearer":[]}],"summary":"Retrieve beneficiary details and provider registration status","tags":["04. Beneficiaries (Bank Accounts)"]},"patch":{"description":"Modifies recipient bank information. If banking details change, re-triggers provider registration.","operationId":"BeneficiariesController_update[1]_v1","parameters":[{"name":"x-organization-id","required":false,"in":"header","description":"Tenant organization ID for multi-entity developers. Defaults to primary organization if omitted.","schema":{"type":"string","example":"51e0dbd1-5e9f-4a84-ad83-e747e60f269c"}},{"name":"id","required":true,"in":"path","description":"Beneficiary UUID identifier","schema":{"example":"84ecbd88-c083-49d6-a780-ef7da4b15e64","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBeneficiaryDto"}}}},"responses":{"200":{"description":"Beneficiary updated successfully."},"404":{"description":"Beneficiary not found under organization context.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}}},"security":[{"bearer":[]}],"summary":"Update beneficiary details","tags":["04. Beneficiaries (Bank Accounts)"]},"delete":{"description":"Removes a recipient bank account from the active organization directory.","operationId":"BeneficiariesController_remove[1]_v1","parameters":[{"name":"x-organization-id","required":false,"in":"header","description":"Tenant organization ID for multi-entity developers. Defaults to primary organization if omitted.","schema":{"type":"string","example":"51e0dbd1-5e9f-4a84-ad83-e747e60f269c"}},{"name":"id","required":true,"in":"path","description":"Beneficiary UUID identifier","schema":{"example":"84ecbd88-c083-49d6-a780-ef7da4b15e64","type":"string"}}],"responses":{"200":{"description":"Beneficiary removed successfully."},"404":{"description":"Beneficiary not found under organization context.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}}},"security":[{"bearer":[]}],"summary":"Delete a beneficiary","tags":["04. Beneficiaries (Bank Accounts)"]}},"/rates/quote":{"post":{"description":"Discovers all possible direct or bridged corridors connecting the currency pair, queries active liquidity providers in parallel, selects the most efficient route, applies destination markup, and persists the quote under the caller organization context. The response intentionally does not disclose external provider identities.","operationId":"PricingController_getBestQuote[0]","parameters":[{"name":"x-organization-id","required":false,"in":"header","description":"Tenant organization ID for multi-entity developers. Defaults to primary organization if omitted.","schema":{"type":"string","example":"51e0dbd1-5e9f-4a84-ad83-e747e60f269c"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuoteRequestDto"},"examples":{"sendUsdToCop":{"summary":"Fixed Send Amount (USD to COP)","value":{"from":"USD","to":"COP","amount":"500.00","side":"SEND","toCountry":"CO"}},"receiveUsdToMxn":{"summary":"Fixed Receive Amount (USD to MXN)","value":{"from":"USD","to":"MXN","amount":"10000.00","side":"RECEIVE","toCountry":"MX"}},"eurToUsd":{"summary":"Euro to USD Wire / ACH","value":{"from":"EUR","to":"USD","amount":"1000.00","side":"SEND","toCountry":"US"}}}}}},"responses":{"201":{"description":"Indicative quote successfully generated and persisted. Valid until expiresAt.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuoteResponseDto"}}}},"400":{"description":"Amount out of provider corridor bounds or precision exceeds allowed decimals (AMOUNT_OUT_OF_BOUNDS).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}},"422":{"description":"No route supported between selected currencies (ROUTE_NOT_SUPPORTED) or no active provider returned executable liquidity (NO_LIQUIDITY_AVAILABLE).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}}},"security":[{"bearer":[]}],"summary":"Request real-time indicative quote routed across optimal providers","tags":["02. Rates & Quotes"]}},"/v1/rates/quote":{"post":{"description":"Discovers all possible direct or bridged corridors connecting the currency pair, queries active liquidity providers in parallel, selects the most efficient route, applies destination markup, and persists the quote under the caller organization context. The response intentionally does not disclose external provider identities.","operationId":"PricingController_getBestQuote[1]_v1","parameters":[{"name":"x-organization-id","required":false,"in":"header","description":"Tenant organization ID for multi-entity developers. Defaults to primary organization if omitted.","schema":{"type":"string","example":"51e0dbd1-5e9f-4a84-ad83-e747e60f269c"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuoteRequestDto"},"examples":{"sendUsdToCop":{"summary":"Fixed Send Amount (USD to COP)","value":{"from":"USD","to":"COP","amount":"500.00","side":"SEND","toCountry":"CO"}},"receiveUsdToMxn":{"summary":"Fixed Receive Amount (USD to MXN)","value":{"from":"USD","to":"MXN","amount":"10000.00","side":"RECEIVE","toCountry":"MX"}},"eurToUsd":{"summary":"Euro to USD Wire / ACH","value":{"from":"EUR","to":"USD","amount":"1000.00","side":"SEND","toCountry":"US"}}}}}},"responses":{"201":{"description":"Indicative quote successfully generated and persisted. Valid until expiresAt.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuoteResponseDto"}}}},"400":{"description":"Amount out of provider corridor bounds or precision exceeds allowed decimals (AMOUNT_OUT_OF_BOUNDS).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}},"422":{"description":"No route supported between selected currencies (ROUTE_NOT_SUPPORTED) or no active provider returned executable liquidity (NO_LIQUIDITY_AVAILABLE).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}}},"security":[{"bearer":[]}],"summary":"Request real-time indicative quote routed across optimal providers","tags":["02. Rates & Quotes"]}},"/orders":{"post":{"description":"Transforms an active and unexpired indicative quote into an executable order assigned to a pre-registered beneficiary. Persists the order, schedules underlying leg executions, and returns bank payment instructions for the payer to send funds to the origin on-ramp.","operationId":"OrdersController_createOrder[0]","parameters":[{"name":"x-organization-id","required":false,"in":"header","description":"Tenant organization ID for multi-entity developers. Defaults to primary organization if omitted.","schema":{"type":"string","example":"51e0dbd1-5e9f-4a84-ad83-e747e60f269c"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderDto"},"examples":{"standardOrder":{"summary":"Confirm Quote for Beneficiary Payout","value":{"quoteId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","beneficiaryId":"84ecbd88-c083-49d6-a780-ef7da4b15e64"}}}}}},"responses":{"201":{"description":"Order successfully created. Contains initial status (AWAITING_FIAT) and origin payment instructions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderResponseDto"}}}},"400":{"description":"Beneficiary destination currency/country mismatch with quote, or validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}},"422":{"description":"Quote has expired or was already consumed into another order.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}}},"security":[{"bearer":[]}],"summary":"Confirm an indicative quote into an active executable order","tags":["03. Orders & Execution"]},"get":{"description":"Retrieves a paginated list of orders matching optional status, currency, or date filters for the active organization.","operationId":"OrdersController_listOrders[0]","parameters":[{"name":"x-organization-id","required":false,"in":"header","description":"Tenant organization ID for multi-entity developers. Defaults to primary organization if omitted.","schema":{"type":"string","example":"51e0dbd1-5e9f-4a84-ad83-e747e60f269c"}},{"name":"page","required":false,"in":"query","description":"Page number (1-based index)","schema":{"minimum":1,"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Number of items per page","schema":{"minimum":1,"maximum":100,"default":10,"type":"number"}},{"name":"organizationId","required":false,"in":"query","description":"Filter by organization ID (cross-tenant for admin)","schema":{"type":"string"}},{"name":"status","required":false,"in":"query","description":"Filter by order lifecycle status","schema":{"type":"string","enum":["CONFIRMED","AWAITING_FIAT","FIAT_RECEIVED","USDT_SENT","USDT_RECEIVED","PAID_OUT","CANCELLED","EXPIRED","REFUNDED","EXCEPTION","PAYOUT_FAILED","RETURNED"]}},{"name":"fromCurrency","required":false,"in":"query","description":"Filter by source currency (e.g. EUR, MXN, USD)","schema":{"type":"string"}},{"name":"toCurrency","required":false,"in":"query","description":"Filter by target currency (e.g. USD, COP, MXN)","schema":{"type":"string"}}],"responses":{"200":{"description":"Paginated list of orders retrieved successfully."}},"security":[{"bearer":[]}],"summary":"List cross-border orders for the caller organization","tags":["03. Orders & Execution"]}},"/v1/orders":{"post":{"description":"Transforms an active and unexpired indicative quote into an executable order assigned to a pre-registered beneficiary. Persists the order, schedules underlying leg executions, and returns bank payment instructions for the payer to send funds to the origin on-ramp.","operationId":"OrdersController_createOrder[1]_v1","parameters":[{"name":"x-organization-id","required":false,"in":"header","description":"Tenant organization ID for multi-entity developers. Defaults to primary organization if omitted.","schema":{"type":"string","example":"51e0dbd1-5e9f-4a84-ad83-e747e60f269c"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderDto"},"examples":{"standardOrder":{"summary":"Confirm Quote for Beneficiary Payout","value":{"quoteId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","beneficiaryId":"84ecbd88-c083-49d6-a780-ef7da4b15e64"}}}}}},"responses":{"201":{"description":"Order successfully created. Contains initial status (AWAITING_FIAT) and origin payment instructions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderResponseDto"}}}},"400":{"description":"Beneficiary destination currency/country mismatch with quote, or validation failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}},"422":{"description":"Quote has expired or was already consumed into another order.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}}},"security":[{"bearer":[]}],"summary":"Confirm an indicative quote into an active executable order","tags":["03. Orders & Execution"]},"get":{"description":"Retrieves a paginated list of orders matching optional status, currency, or date filters for the active organization.","operationId":"OrdersController_listOrders[1]_v1","parameters":[{"name":"x-organization-id","required":false,"in":"header","description":"Tenant organization ID for multi-entity developers. Defaults to primary organization if omitted.","schema":{"type":"string","example":"51e0dbd1-5e9f-4a84-ad83-e747e60f269c"}},{"name":"page","required":false,"in":"query","description":"Page number (1-based index)","schema":{"minimum":1,"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Number of items per page","schema":{"minimum":1,"maximum":100,"default":10,"type":"number"}},{"name":"organizationId","required":false,"in":"query","description":"Filter by organization ID (cross-tenant for admin)","schema":{"type":"string"}},{"name":"status","required":false,"in":"query","description":"Filter by order lifecycle status","schema":{"type":"string","enum":["CONFIRMED","AWAITING_FIAT","FIAT_RECEIVED","USDT_SENT","USDT_RECEIVED","PAID_OUT","CANCELLED","EXPIRED","REFUNDED","EXCEPTION","PAYOUT_FAILED","RETURNED"]}},{"name":"fromCurrency","required":false,"in":"query","description":"Filter by source currency (e.g. EUR, MXN, USD)","schema":{"type":"string"}},{"name":"toCurrency","required":false,"in":"query","description":"Filter by target currency (e.g. USD, COP, MXN)","schema":{"type":"string"}}],"responses":{"200":{"description":"Paginated list of orders retrieved successfully."}},"security":[{"bearer":[]}],"summary":"List cross-border orders for the caller organization","tags":["03. Orders & Execution"]}},"/orders/{id}":{"get":{"description":"Returns complete forensic state of an order including current execution status, origin payment instructions, and state change event history.","operationId":"OrdersController_getOrder[0]","parameters":[{"name":"x-organization-id","required":false,"in":"header","description":"Tenant organization ID for multi-entity developers. Defaults to primary organization if omitted.","schema":{"type":"string","example":"51e0dbd1-5e9f-4a84-ad83-e747e60f269c"}},{"name":"id","required":true,"in":"path","description":"UUID of the order to inspect","schema":{"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"}}],"responses":{"200":{"description":"Detailed order state retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderResponseDto"}}}},"404":{"description":"Order not found under current organization context.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}}},"security":[{"bearer":[]}],"summary":"Retrieve order status, payment instructions, and execution timeline","tags":["03. Orders & Execution"]}},"/v1/orders/{id}":{"get":{"description":"Returns complete forensic state of an order including current execution status, origin payment instructions, and state change event history.","operationId":"OrdersController_getOrder[1]_v1","parameters":[{"name":"x-organization-id","required":false,"in":"header","description":"Tenant organization ID for multi-entity developers. Defaults to primary organization if omitted.","schema":{"type":"string","example":"51e0dbd1-5e9f-4a84-ad83-e747e60f269c"}},{"name":"id","required":true,"in":"path","description":"UUID of the order to inspect","schema":{"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"}}],"responses":{"200":{"description":"Detailed order state retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderResponseDto"}}}},"404":{"description":"Order not found under current organization context.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}}},"security":[{"bearer":[]}],"summary":"Retrieve order status, payment instructions, and execution timeline","tags":["03. Orders & Execution"]}},"/v1/textile/operations":{"get":{"operationId":"TextileController_list_v1","parameters":[{"name":"x-organization-id","in":"header","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}},{"name":"status","required":false,"in":"query","schema":{"enum":["pending"],"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"List Textile operations (pending: waiting on the client wallet)","tags":["03. Orders & Execution"]}},"/v1/textile/operations/{id}":{"get":{"operationId":"TextileController_get_v1","parameters":[{"name":"x-organization-id","in":"header","required":false,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Read a Textile operation (refreshes it from Textile)","tags":["03. Orders & Execution"]}},"/v1/textile/operations/{id}/swap":{"post":{"operationId":"TextileController_requestSwap_v1","parameters":[{"name":"x-organization-id","in":"header","required":false,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Request the firm swap now: unsigned approve + swap for the client wallet (60 s)","tags":["03. Orders & Execution"]}},"/v1/textile/operations/{id}/swap/submit":{"post":{"operationId":"TextileController_submitSwap_v1","parameters":[{"name":"x-organization-id","in":"header","required":false,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TextileSubmitSwapDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Report the swap transaction the client broadcast","tags":["03. Orders & Execution"]}},"/v1/textile/operations/{id}/sell/challenge":{"get":{"operationId":"TextileController_sellChallenge_v1","parameters":[{"name":"x-organization-id","in":"header","required":false,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"EIP-712 TakerControl message the client wallet signs to authorize the ramp sale","tags":["03. Orders & Execution"]}},"/v1/textile/operations/{id}/sell":{"post":{"operationId":"TextileController_sell_v1","parameters":[{"name":"x-organization-id","in":"header","required":false,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TextileSellDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Book the ramp sale with the signed proof; returns the unsigned cNGN deposit","tags":["03. Orders & Execution"]}},"/v1/textile/operations/{id}/deposit/submit":{"post":{"operationId":"TextileController_submitDeposit_v1","parameters":[{"name":"x-organization-id","in":"header","required":false,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TextileSubmitDepositDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Report the cNGN deposit transaction the client broadcast","tags":["03. Orders & Execution"]}},"/v1/swaps/pairs":{"get":{"operationId":"SwapsController_pairs_v1","parameters":[{"name":"x-organization-id","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Pairs available for swaps, by chain","tags":["05. Swaps"]}},"/v1/swaps/preview":{"post":{"operationId":"SwapsController_preview_v1","parameters":[{"name":"x-organization-id","in":"header","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwapPreviewDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Indicative price; nothing is reserved","tags":["05. Swaps"]}},"/v1/swaps":{"post":{"operationId":"SwapsController_create_v1","parameters":[{"name":"x-organization-id","in":"header","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSwapDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Firm quote now, with the organization wallet as taker: unsigned approve + swap (60 s)","tags":["05. Swaps"]},"get":{"operationId":"SwapsController_list_v1","parameters":[{"name":"x-organization-id","in":"header","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"The organization's swaps, newest first","tags":["05. Swaps"]}},"/v1/swaps/{id}/submit":{"post":{"operationId":"SwapsController_submit_v1","parameters":[{"name":"x-organization-id","in":"header","required":false,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitSwapDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Report the swap transaction the wallet broadcast","tags":["05. Swaps"]}},"/v1/swaps/{id}":{"get":{"operationId":"SwapsController_get_v1","parameters":[{"name":"x-organization-id","in":"header","required":false,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Read a swap (refreshes it from Textile)","tags":["05. Swaps"]}},"/credit":{"get":{"operationId":"CreditController_overview[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Credit account with live limit and balances","tags":["07. Credit"]}},"/v1/credit":{"get":{"operationId":"CreditController_overview[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Credit account with live limit and balances","tags":["07. Credit"]}},"/credit/limit":{"get":{"operationId":"CreditController_limit[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Credit limit, usage and open increase request","tags":["07. Credit"]}},"/v1/credit/limit":{"get":{"operationId":"CreditController_limit[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Credit limit, usage and open increase request","tags":["07. Credit"]}},"/credit/limit-requests":{"post":{"operationId":"CreditController_requestLimit[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestCreditLimitDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Ask the provider to raise the credit limit","tags":["07. Credit"]}},"/v1/credit/limit-requests":{"post":{"operationId":"CreditController_requestLimit[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestCreditLimitDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Ask the provider to raise the credit limit","tags":["07. Credit"]}},"/credit/facility-requests":{"post":{"operationId":"CreditController_requestFacility[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestFacilityDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Request a facility (credit line) on a chain","tags":["07. Credit"]}},"/v1/credit/facility-requests":{"post":{"operationId":"CreditController_requestFacility[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestFacilityDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Request a facility (credit line) on a chain","tags":["07. Credit"]}},"/credit/requests":{"get":{"operationId":"CreditController_listRequests[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"Page number (1-based index)","schema":{"minimum":1,"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Number of items per page","schema":{"minimum":1,"maximum":100,"default":10,"type":"number"}},{"name":"kind","required":false,"in":"query","schema":{"type":"string","enum":["CREDIT_LIMIT","FACILITY"]}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Credit limit and facility requests sent through Rook","tags":["07. Credit"]}},"/v1/credit/requests":{"get":{"operationId":"CreditController_listRequests[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"Page number (1-based index)","schema":{"minimum":1,"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Number of items per page","schema":{"minimum":1,"maximum":100,"default":10,"type":"number"}},{"name":"kind","required":false,"in":"query","schema":{"type":"string","enum":["CREDIT_LIMIT","FACILITY"]}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Credit limit and facility requests sent through Rook","tags":["07. Credit"]}},"/credit/requests/{id}":{"get":{"operationId":"CreditController_getRequest[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"One credit request","tags":["07. Credit"]}},"/v1/credit/requests/{id}":{"get":{"operationId":"CreditController_getRequest[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"One credit request","tags":["07. Credit"]}},"/credit/facilities":{"get":{"operationId":"CreditController_listFacilities[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"Page number (1-based index)","schema":{"minimum":1,"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Number of items per page","schema":{"minimum":1,"maximum":100,"default":10,"type":"number"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Facilities (credit lines) mirrored from the provider","tags":["07. Credit"]}},"/v1/credit/facilities":{"get":{"operationId":"CreditController_listFacilities[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"Page number (1-based index)","schema":{"minimum":1,"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Number of items per page","schema":{"minimum":1,"maximum":100,"default":10,"type":"number"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Facilities (credit lines) mirrored from the provider","tags":["07. Credit"]}},"/credit/facilities/{id}":{"get":{"operationId":"CreditController_getFacility[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"One facility","tags":["07. Credit"]}},"/v1/credit/facilities/{id}":{"get":{"operationId":"CreditController_getFacility[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"One facility","tags":["07. Credit"]}},"/credit/chains":{"get":{"operationId":"CreditController_chains[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"Page number (1-based index)","schema":{"minimum":1,"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Number of items per page","schema":{"minimum":1,"maximum":100,"default":10,"type":"number"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Chains available at the provider","tags":["07. Credit"]}},"/v1/credit/chains":{"get":{"operationId":"CreditController_chains[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"Page number (1-based index)","schema":{"minimum":1,"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Number of items per page","schema":{"minimum":1,"maximum":100,"default":10,"type":"number"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Chains available at the provider","tags":["07. Credit"]}},"/credit/chains/default":{"get":{"operationId":"CreditController_defaultChain[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Chain the provider uses for this organization","tags":["07. Credit"]}},"/v1/credit/chains/default":{"get":{"operationId":"CreditController_defaultChain[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Chain the provider uses for this organization","tags":["07. Credit"]}},"/credit/balances":{"get":{"operationId":"CreditController_balances[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"chainRef","required":false,"in":"query","schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Live wallet balances at the provider","tags":["07. Credit"]}},"/v1/credit/balances":{"get":{"operationId":"CreditController_balances[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"chainRef","required":false,"in":"query","schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Live wallet balances at the provider","tags":["07. Credit"]}},"/credit/wallets":{"get":{"operationId":"CreditController_wallets[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"Page number (1-based index)","schema":{"minimum":1,"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Number of items per page","schema":{"minimum":1,"maximum":100,"default":10,"type":"number"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Whitelisted withdrawal wallets (live from the provider; use their ref as walletRef)","tags":["07. Credit"]},"post":{"operationId":"CreditController_addWallet[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCreditWalletDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Ask the provider to whitelist a withdrawal wallet","tags":["07. Credit"]}},"/v1/credit/wallets":{"get":{"operationId":"CreditController_wallets[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"Page number (1-based index)","schema":{"minimum":1,"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Number of items per page","schema":{"minimum":1,"maximum":100,"default":10,"type":"number"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Whitelisted withdrawal wallets (live from the provider; use their ref as walletRef)","tags":["07. Credit"]},"post":{"operationId":"CreditController_addWallet[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCreditWalletDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Ask the provider to whitelist a withdrawal wallet","tags":["07. Credit"]}},"/credit/wallet-requests":{"get":{"operationId":"CreditController_walletRequests[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"Page number (1-based index)","schema":{"minimum":1,"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Number of items per page","schema":{"minimum":1,"maximum":100,"default":10,"type":"number"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Whitelist requests sent through Rook","tags":["07. Credit"]}},"/v1/credit/wallet-requests":{"get":{"operationId":"CreditController_walletRequests[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"Page number (1-based index)","schema":{"minimum":1,"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Number of items per page","schema":{"minimum":1,"maximum":100,"default":10,"type":"number"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Whitelist requests sent through Rook","tags":["07. Credit"]}},"/credit/withdrawals":{"post":{"operationId":"CreditController_requestWithdrawal[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestWithdrawalDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Draw on the line: withdrawal request, approved and then disbursed by the provider","tags":["07. Credit"]},"get":{"operationId":"CreditController_listWithdrawals[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"Page number (1-based index)","schema":{"minimum":1,"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Number of items per page","schema":{"minimum":1,"maximum":100,"default":10,"type":"number"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Withdrawals sent through Rook","tags":["07. Credit"]}},"/v1/credit/withdrawals":{"post":{"operationId":"CreditController_requestWithdrawal[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestWithdrawalDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Draw on the line: withdrawal request, approved and then disbursed by the provider","tags":["07. Credit"]},"get":{"operationId":"CreditController_listWithdrawals[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"Page number (1-based index)","schema":{"minimum":1,"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Number of items per page","schema":{"minimum":1,"maximum":100,"default":10,"type":"number"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Withdrawals sent through Rook","tags":["07. Credit"]}},"/credit/withdrawals/{id}":{"get":{"operationId":"CreditController_getWithdrawal[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"One withdrawal with its disbursement","tags":["07. Credit"]}},"/v1/credit/withdrawals/{id}":{"get":{"operationId":"CreditController_getWithdrawal[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"One withdrawal with its disbursement","tags":["07. Credit"]}},"/credit/withdrawals/{id}/proof-of-funds":{"post":{"operationId":"CreditController_uploadProofOfFunds[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Upload a proof of funds for a withdrawal (multipart \"file\")","tags":["07. Credit"]}},"/v1/credit/withdrawals/{id}/proof-of-funds":{"post":{"operationId":"CreditController_uploadProofOfFunds[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Upload a proof of funds for a withdrawal (multipart \"file\")","tags":["07. Credit"]}},"/credit/repayments/estimate":{"get":{"operationId":"CreditController_estimate[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"What is owed now (principal, interest)","tags":["07. Credit"]}},"/v1/credit/repayments/estimate":{"get":{"operationId":"CreditController_estimate[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"What is owed now (principal, interest)","tags":["07. Credit"]}},"/credit/repayments/clear-dues":{"post":{"operationId":"CreditController_clearDues[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClearDuesDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Pay what is due on a chain (interest first, then principal)","tags":["07. Credit"]}},"/v1/credit/repayments/clear-dues":{"post":{"operationId":"CreditController_clearDues[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClearDuesDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Pay what is due on a chain (interest first, then principal)","tags":["07. Credit"]}},"/credit/repayments":{"get":{"operationId":"CreditController_listRepayments[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"Page number (1-based index)","schema":{"minimum":1,"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Number of items per page","schema":{"minimum":1,"maximum":100,"default":10,"type":"number"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Repayments mirrored from the provider","tags":["07. Credit"]}},"/v1/credit/repayments":{"get":{"operationId":"CreditController_listRepayments[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"Page number (1-based index)","schema":{"minimum":1,"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Number of items per page","schema":{"minimum":1,"maximum":100,"default":10,"type":"number"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Repayments mirrored from the provider","tags":["07. Credit"]}},"/credit/utilization-proofs":{"post":{"operationId":"CreditController_submitUtilization[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/UtilizationProofFormDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Report what a facility paid for (multipart: \"data\" JSON plus settlement_<routeId> / payment_<corridorId> files)","tags":["07. Credit"]}},"/v1/credit/utilization-proofs":{"post":{"operationId":"CreditController_submitUtilization[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/UtilizationProofFormDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Report what a facility paid for (multipart: \"data\" JSON plus settlement_<routeId> / payment_<corridorId> files)","tags":["07. Credit"]}},"/credit/proofs":{"get":{"operationId":"CreditController_listProofs[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"Page number (1-based index)","schema":{"minimum":1,"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Number of items per page","schema":{"minimum":1,"maximum":100,"default":10,"type":"number"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Proofs sent through Rook (metadata and hashes only)","tags":["07. Credit"]}},"/v1/credit/proofs":{"get":{"operationId":"CreditController_listProofs[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"Page number (1-based index)","schema":{"minimum":1,"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Number of items per page","schema":{"minimum":1,"maximum":100,"default":10,"type":"number"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Proofs sent through Rook (metadata and hashes only)","tags":["07. Credit"]}},"/credit/sync":{"post":{"operationId":"CreditController_sync[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Refresh statuses from the provider now","tags":["07. Credit"]}},"/v1/credit/sync":{"post":{"operationId":"CreditController_sync[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Refresh statuses from the provider now","tags":["07. Credit"]}},"/webhooks/endpoint":{"put":{"description":"Sets the HTTPS URL that receives `order.status_changed` events. The signing secret is returned only when the endpoint is created or when `regenerateSecret` is true; store it, it is never shown again.","operationId":"ClientWebhooksController_upsert[0]","parameters":[{"name":"x-organization-id","required":false,"in":"header","description":"Tenant organization ID for multi-entity developers. Defaults to primary organization if omitted.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertWebhookEndpointDto"}}}},"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Create or update the webhook endpoint","tags":["08. Webhooks"]},"get":{"operationId":"ClientWebhooksController_get[0]","parameters":[{"name":"x-organization-id","required":false,"in":"header","description":"Tenant organization ID for multi-entity developers. Defaults to primary organization if omitted.","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Read the webhook endpoint (without its secret)","tags":["08. Webhooks"]}},"/v1/webhooks/endpoint":{"put":{"description":"Sets the HTTPS URL that receives `order.status_changed` events. The signing secret is returned only when the endpoint is created or when `regenerateSecret` is true; store it, it is never shown again.","operationId":"ClientWebhooksController_upsert[1]_v1","parameters":[{"name":"x-organization-id","required":false,"in":"header","description":"Tenant organization ID for multi-entity developers. Defaults to primary organization if omitted.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertWebhookEndpointDto"}}}},"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Create or update the webhook endpoint","tags":["08. Webhooks"]},"get":{"operationId":"ClientWebhooksController_get[1]_v1","parameters":[{"name":"x-organization-id","required":false,"in":"header","description":"Tenant organization ID for multi-entity developers. Defaults to primary organization if omitted.","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Read the webhook endpoint (without its secret)","tags":["08. Webhooks"]}},"/webhooks/test":{"post":{"description":"Delivers immediately and returns the attempt (status code, error). A failed test is retried like any other delivery.","operationId":"ClientWebhooksController_test[0]","parameters":[{"name":"x-organization-id","required":false,"in":"header","description":"Tenant organization ID for multi-entity developers. Defaults to primary organization if omitted.","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Send a signed `webhook.test` event now","tags":["08. Webhooks"]}},"/v1/webhooks/test":{"post":{"description":"Delivers immediately and returns the attempt (status code, error). A failed test is retried like any other delivery.","operationId":"ClientWebhooksController_test[1]_v1","parameters":[{"name":"x-organization-id","required":false,"in":"header","description":"Tenant organization ID for multi-entity developers. Defaults to primary organization if omitted.","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Send a signed `webhook.test` event now","tags":["08. Webhooks"]}},"/webhooks/deliveries":{"get":{"operationId":"ClientWebhooksController_deliveries[0]","parameters":[{"name":"page","required":false,"in":"query","description":"Page number (1-based index)","schema":{"minimum":1,"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Number of items per page","schema":{"minimum":1,"maximum":100,"default":10,"type":"number"}},{"name":"status","required":false,"in":"query","schema":{"type":"string","enum":["PENDING","DELIVERED","FAILED"]}},{"name":"orderId","required":false,"in":"query","description":"Only deliveries for this order","schema":{"type":"string"}},{"name":"x-organization-id","required":false,"in":"header","description":"Tenant organization ID for multi-entity developers. Defaults to primary organization if omitted.","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Delivery log, newest first","tags":["08. Webhooks"]}},"/v1/webhooks/deliveries":{"get":{"operationId":"ClientWebhooksController_deliveries[1]_v1","parameters":[{"name":"page","required":false,"in":"query","description":"Page number (1-based index)","schema":{"minimum":1,"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Number of items per page","schema":{"minimum":1,"maximum":100,"default":10,"type":"number"}},{"name":"status","required":false,"in":"query","schema":{"type":"string","enum":["PENDING","DELIVERED","FAILED"]}},{"name":"orderId","required":false,"in":"query","description":"Only deliveries for this order","schema":{"type":"string"}},{"name":"x-organization-id","required":false,"in":"header","description":"Tenant organization ID for multi-entity developers. Defaults to primary organization if omitted.","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Delivery log, newest first","tags":["08. Webhooks"]}},"/webhooks/deliveries/{id}/resend":{"post":{"operationId":"ClientWebhooksController_resend[0]","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"x-organization-id","required":false,"in":"header","description":"Tenant organization ID for multi-entity developers. Defaults to primary organization if omitted.","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Send a delivery again (same eventId) as a new delivery","tags":["08. Webhooks"]}},"/v1/webhooks/deliveries/{id}/resend":{"post":{"operationId":"ClientWebhooksController_resend[1]_v1","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"x-organization-id","required":false,"in":"header","description":"Tenant organization ID for multi-entity developers. Defaults to primary organization if omitted.","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Send a delivery again (same eventId) as a new delivery","tags":["08. Webhooks"]}},"/compliance":{"get":{"operationId":"ComplianceController_status[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"KYB verification status of the organization","tags":["08. Compliance"]}},"/v1/compliance":{"get":{"operationId":"ComplianceController_status[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"KYB verification status of the organization","tags":["08. Compliance"]}},"/compliance/kyb/link":{"post":{"operationId":"ComplianceController_kybLink[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Get a link to complete or resume the KYB","tags":["08. Compliance"]}},"/v1/compliance/kyb/link":{"post":{"operationId":"ComplianceController_kybLink[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Get a link to complete or resume the KYB","tags":["08. Compliance"]}},"/compliance/consents":{"get":{"operationId":"ComplianceController_listConsents[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Consents given to share the KYB","tags":["08. Compliance"]},"post":{"operationId":"ComplianceController_grantConsent[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrantConsentDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Consent to share the verified KYB with a receiving provider","tags":["08. Compliance"]}},"/v1/compliance/consents":{"get":{"operationId":"ComplianceController_listConsents[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Consents given to share the KYB","tags":["08. Compliance"]},"post":{"operationId":"ComplianceController_grantConsent[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrantConsentDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Consent to share the verified KYB with a receiving provider","tags":["08. Compliance"]}},"/compliance/consents/{target}":{"delete":{"operationId":"ComplianceController_revokeConsent[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"target","required":true,"in":"path","schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Revoke a consent","tags":["08. Compliance"]}},"/v1/compliance/consents/{target}":{"delete":{"operationId":"ComplianceController_revokeConsent[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"target","required":true,"in":"path","schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"Revoke a consent","tags":["08. Compliance"]}},"/compliance/shares":{"get":{"operationId":"ComplianceController_listShares[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"KYB shares issued to receiving providers","tags":["08. Compliance"]},"post":{"operationId":"ComplianceController_issueShare[0]","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueShareDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Share the verified KYB with a receiving provider","tags":["08. Compliance"]}},"/v1/compliance/shares":{"get":{"operationId":"ComplianceController_listShares[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"security":[{"bearer":[]}],"summary":"KYB shares issued to receiving providers","tags":["08. Compliance"]},"post":{"operationId":"ComplianceController_issueShare[1]_v1","parameters":[{"name":"x-organization-id","in":"header","description":"Organization to act for when the user belongs to several.","required":false,"schema":{"type":"string"}},{"name":"x-organization-id","required":true,"in":"header","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueShareDto"}}}},"responses":{"201":{"description":""}},"security":[{"bearer":[]}],"summary":"Share the verified KYB with a receiving provider","tags":["08. Compliance"]}},"/notifications":{"get":{"description":"Retrieves operational events, status alerts, and action items for the user with pagination and unread filters.","operationId":"NotificationsController_list[0]","parameters":[{"name":"page","required":false,"in":"query","description":"Page number (1-based index)","schema":{"minimum":1,"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Number of items per page","schema":{"minimum":1,"maximum":100,"default":10,"type":"number"}},{"name":"status","required":false,"in":"query","description":"Filter by notification status","schema":{"type":"string","enum":["unread","read"]}},{"name":"type","required":false,"in":"query","description":"Filter by notification type","schema":{"type":"string"}},{"name":"organizationId","required":false,"in":"query","description":"Filter by organization ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Paginated list of user notifications."},"401":{"description":"Missing or invalid Bearer token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}}},"security":[{"bearer":[]}],"summary":"List notifications for the authenticated user","tags":["06. Notifications"]}},"/v1/notifications":{"get":{"description":"Retrieves operational events, status alerts, and action items for the user with pagination and unread filters.","operationId":"NotificationsController_list[1]_v1","parameters":[{"name":"page","required":false,"in":"query","description":"Page number (1-based index)","schema":{"minimum":1,"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"Number of items per page","schema":{"minimum":1,"maximum":100,"default":10,"type":"number"}},{"name":"status","required":false,"in":"query","description":"Filter by notification status","schema":{"type":"string","enum":["unread","read"]}},{"name":"type","required":false,"in":"query","description":"Filter by notification type","schema":{"type":"string"}},{"name":"organizationId","required":false,"in":"query","description":"Filter by organization ID","schema":{"type":"string"}}],"responses":{"200":{"description":"Paginated list of user notifications."},"401":{"description":"Missing or invalid Bearer token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}}},"security":[{"bearer":[]}],"summary":"List notifications for the authenticated user","tags":["06. Notifications"]}},"/notifications/{id}/read":{"post":{"description":"Acknowledges receipt of a notification message.","operationId":"NotificationsController_markRead[0]","parameters":[{"name":"id","required":true,"in":"path","description":"Notification UUID identifier","schema":{"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"}}],"responses":{"204":{"description":"Notification marked as read successfully."},"404":{"description":"Notification not found or access denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}}},"security":[{"bearer":[]}],"summary":"Mark a notification as read","tags":["06. Notifications"]}},"/v1/notifications/{id}/read":{"post":{"description":"Acknowledges receipt of a notification message.","operationId":"NotificationsController_markRead[1]_v1","parameters":[{"name":"id","required":true,"in":"path","description":"Notification UUID identifier","schema":{"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"}}],"responses":{"204":{"description":"Notification marked as read successfully."},"404":{"description":"Notification not found or access denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}}},"security":[{"bearer":[]}],"summary":"Mark a notification as read","tags":["06. Notifications"]}},"/notifications/{id}":{"delete":{"description":"Removes the notification from the active user notification feed.","operationId":"NotificationsController_remove[0]","parameters":[{"name":"id","required":true,"in":"path","description":"Notification UUID identifier","schema":{"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"}}],"responses":{"200":{"description":"Notification removed."},"404":{"description":"Notification not found or access denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}}},"security":[{"bearer":[]}],"summary":"Dismiss or soft delete a notification","tags":["06. Notifications"]}},"/v1/notifications/{id}":{"delete":{"description":"Removes the notification from the active user notification feed.","operationId":"NotificationsController_remove[1]_v1","parameters":[{"name":"id","required":true,"in":"path","description":"Notification UUID identifier","schema":{"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"string"}}],"responses":{"200":{"description":"Notification removed."},"404":{"description":"Notification not found or access denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponseDto"}}}}},"security":[{"bearer":[]}],"summary":"Dismiss or soft delete a notification","tags":["06. Notifications"]}}},"info":{"title":"Rook Public API","description":"## Overview\n\nRook is a non-custodial cross-border payments and smart liquidity routing infrastructure. It connects banking systems, fintechs, and cross-border platforms with verified on-ramp and off-ramp liquidity providers across Latin America, the United States, Europe, and Asia.\n\n**Rook does not custody client funds.** Funds flow directly:\n- The sender transfers fiat or local currency to the origin on-ramp provider according to generated payment instructions.\n- Value is settled cross-border in stablecoins (e.g. USDT) between authorized liquidity providers.\n- The destination off-ramp provider disburses local fiat directly to the registered recipient bank account.\n\n---\n\n## Authentication & Headers\n\nAll private endpoints require standard HTTP Bearer token authentication:\n```http\nAuthorization: Bearer <JWT_TOKEN>\n```\n\n### Multi-Tenant Context Header (`x-organization-id`)\n\nPartners may manage multiple subsidiaries or legal entities under a single developer account. When interacting with tenant-scoped endpoints (quotes, orders, beneficiaries), provide the UUID of the target organization:\n```http\nx-organization-id: 51e0dbd1-5e9f-4a84-ad83-e747e60f269c\n```\nIf omitted, the API defaults to the user's primary active organization membership.\n\n---\n\n## Cross-Border Lifecycle\n\n1. **Authentication**: Obtain an access token via `POST /v1/auth/sign-in/email`.\n2. **Organization Context**: Retrieve valid organization IDs via `GET /v1/organizations`.\n3. **Beneficiary Registration**: Create recipient bank accounts via `POST /v1/beneficiaries`. Accounts are automatically synced with active payout rails.\n4. **Indicative RFQ Quote**: Fetch real-time routed quotes with commercial markup via `POST /v1/rates/quote`.\n5. **Order Confirmation**: Lock an active quote into an executable order via `POST /v1/orders` and receive origin payment instructions.\n6. **Execution Tracking**: Monitor order lifecycle and payment settlement milestones via `GET /v1/orders/:id`.","version":"1.0.0","contact":{}},"tags":[{"name":"01. Authentication","description":"Partner identity verification, email/password authentication, and active session inspection"},{"name":"02. Rates & Quotes","description":"Real-time indicative Request For Quote (RFQ) discovery routed across optimal liquidity provider corridors"},{"name":"03. Orders & Execution","description":"Quote confirmation into active executable orders, payment instruction generation, and settlement tracking"},{"name":"04. Beneficiaries (Bank Accounts)","description":"Management of payout bank accounts and automatic compliance synchronization across active liquidity providers"},{"name":"05. Organizations","description":"Multi-tenant enterprise accounts, organization memberships, and role assignments"},{"name":"06. Notifications","description":"Partner operational alerts, order status notifications, and message lifecycle"},{"name":"07. Credit","description":"Your organization's own credit line at Mansa, operated through Rook: limit, facilities, withdrawals, repayments and proofs"},{"name":"08. Webhooks","description":"Signed order.status_changed events pushed to your HTTPS endpoint, with retries and a delivery log"}],"servers":[],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"SignUpEmailDto":{"type":"object","properties":{"email":{"type":"string","example":"user@example.com","description":"The email address of the user"},"password":{"type":"string","example":"password123","description":"The password for the user account (minimum 8 characters)","minLength":8},"name":{"type":"string","example":"John Doe","description":"The full display name of the user"},"image":{"type":"string","example":"https://example.com/avatar.jpg","description":"Optional URL to the user profile avatar"}},"required":["email","password","name"]},"UserDto":{"type":"object","properties":{"id":{"type":"string","example":"d4847e70-c75c-43f1-bd1b-df0cfdfd1234","description":"UUID of the user"},"email":{"type":"string","example":"user@example.com","description":"Email address of the user"},"name":{"type":"string","example":"John Doe","description":"Display name of the user"},"image":{"type":"object","example":"https://example.com/avatar.jpg","nullable":true,"description":"Avatar image URL"},"emailVerified":{"type":"boolean","example":true,"description":"Whether the user email is verified"},"createdAt":{"format":"date-time","type":"string","example":"2026-05-26T23:59:00.000Z","description":"Account creation timestamp"},"updatedAt":{"format":"date-time","type":"string","example":"2026-05-26T23:59:00.000Z","description":"Account last update timestamp"}},"required":["id","email","name","image","emailVerified","createdAt","updatedAt"]},"JwtResponseDto":{"type":"object","properties":{"token":{"type":"string","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...","description":"The stateless JWT token"},"user":{"description":"The authenticated user profile data","allOf":[{"$ref":"#/components/schemas/UserDto"}]}},"required":["token","user"]},"ApiErrorResponseDto":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code","example":400},"error":{"type":"string","description":"Short error title or category","example":"Bad Request"},"message":{"type":"object","description":"Detailed error message or list of validation failures","example":"amount must be a positive decimal string with at most 6 decimals"},"code":{"type":"string","description":"Machine-readable domain error code","example":"AMOUNT_OUT_OF_BOUNDS"},"timestamp":{"type":"string","description":"ISO timestamp when the error occurred","example":"2026-10-21T21:40:00.000Z"},"path":{"type":"string","description":"Request path that triggered the error","example":"/v1/rates/quote"}},"required":["statusCode","error","message"]},"SignInEmailDto":{"type":"object","properties":{"email":{"type":"string","example":"user@example.com","description":"The email address of the user"},"password":{"type":"string","example":"password123","description":"The password for the user account"},"dontRememberMe":{"type":"boolean","example":false,"description":"Set to true to disable persistent sessions (cookie expires when browser closes)"},"twoFactorToken":{"type":"string","example":"123456","description":"The 2FA token if 2FA is enabled for the account"}},"required":["email","password"]},"AcceptInvitationDto":{"type":"object","properties":{"password":{"type":"string","minLength":8,"maxLength":128}},"required":["password"]},"CreateOrganizationDto":{"type":"object","properties":{"name":{"type":"string","description":"Legal commercial name of the company or tenant organization","example":"Acme Payments S.A.S.","minLength":2,"maxLength":100},"countryId":{"type":"string","description":"ISO-2 alpha-2 country code of legal incorporation","example":"CO"},"kybData":{"type":"object","description":"Preliminary KYB and tax identification metadata","example":{"taxId":"900123456-1","taxIdType":"NIT","legalRepresentative":"Jane Doe"}}},"required":["name"]},"OrganizationResponseDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique UUIDv4 identifier of the organization","example":"51e0dbd1-5e9f-4a84-ad83-e747e60f269c"},"name":{"type":"string","description":"Legal commercial name of the company or organization","example":"Acme Payments S.A.S."},"status":{"type":"string","description":"Operating status of the organization","example":"active"},"countryId":{"type":"object","description":"ISO-2 alpha-2 country code of legal incorporation","example":"CO","nullable":true},"role":{"type":"string","description":"Assigned role for the creator or authenticated member","example":"admin"},"kybData":{"type":"object","description":"Preliminary KYB and tax identification metadata","example":{"taxId":"900123456-1","taxIdType":"NIT"},"nullable":true},"createdAt":{"format":"date-time","type":"string","description":"Timestamp when the organization was created","example":"2026-10-27T12:00:00.000Z"}},"required":["id","name","status","countryId","role","createdAt"]},"BeneficiaryIdentityAddressDto":{"type":"object","properties":{"street":{"type":"string","example":"Calle 1 # 2-3"},"city":{"type":"string","example":"Bogota"},"postCode":{"type":"string","example":"110111"},"country":{"type":"string","description":"ISO-2 country code","example":"CO"}},"required":["street","city","country"]},"BeneficiaryIdentityDto":{"type":"object","properties":{"firstName":{"type":"string","example":"Ana"},"lastName":{"type":"string","example":"Gomez"},"dateOfBirth":{"type":"string","description":"YYYY-MM-DD","example":"1990-01-02"},"nationality":{"type":"string","description":"ISO-2 country code","example":"CO"},"idNumber":{"type":"string","example":"1020304050"},"idType":{"type":"string","enum":["CCPT","RAID","DRLC","SOCS","TXID","IDCD","MISC"],"example":"CCPT"},"address":{"$ref":"#/components/schemas/BeneficiaryIdentityAddressDto"}},"required":["firstName","lastName","dateOfBirth","nationality","idNumber","idType","address"]},"CreateBeneficiaryDto":{"type":"object","properties":{"currency":{"type":"string","description":"Fiat currency the beneficiary receives","example":"COP"},"name":{"type":"string","description":"Full name or company name of the beneficiary","example":"Empresa Europea S.L."},"countryId":{"type":"string","description":"ISO 3166-1 alpha-2 country code (e.g. ES, DE, FR, IT, PT, EU, EC, CO, US)","example":"ES"},"bankName":{"type":"string","description":"Name of the recipient bank or financial institution","example":"Banco Santander"},"accountNumber":{"type":"string","description":"Bank account number or international standard IBAN (for European accounts)","example":"ES9121000418450200051332"},"accountType":{"type":"string","description":"Account type (checking or savings)","example":"checking","enum":["checking","savings"],"default":"checking"},"routingNumber":{"type":"string","description":"Routing number / ABA / Sort code (if applicable)","example":null},"swiftCode":{"type":"string","description":"SWIFT / BIC code for international wire transfers or SEPA","example":"BSCHESMMXXX"},"extraDetails":{"type":"object","description":"Additional provider or rail-specific parameters (e.g. tax ID, address, phone)","example":{"taxId":"B12345678","address":"Calle Gran Via 12, Madrid"}},"identity":{"description":"Identity data used for compliance screening","allOf":[{"$ref":"#/components/schemas/BeneficiaryIdentityDto"}]}},"required":["name","countryId","bankName","accountNumber"]},"UpdateBeneficiaryDto":{"type":"object","properties":{"currency":{"type":"string","description":"Fiat currency the beneficiary receives","example":"COP"},"name":{"type":"string","description":"Full name or company name of the beneficiary","example":"Empresa Europea S.L."},"countryId":{"type":"string","description":"ISO 3166-1 alpha-2 country code (e.g. ES, DE, FR, IT, PT, EU, EC, CO, US)","example":"ES"},"bankName":{"type":"string","description":"Name of the recipient bank or financial institution","example":"Banco Santander"},"accountNumber":{"type":"string","description":"Bank account number or international standard IBAN (for European accounts)","example":"ES9121000418450200051332"},"accountType":{"type":"string","description":"Account type (checking or savings)","example":"checking","enum":["checking","savings"],"default":"checking"},"routingNumber":{"type":"string","description":"Routing number / ABA / Sort code (if applicable)","example":null},"swiftCode":{"type":"string","description":"SWIFT / BIC code for international wire transfers or SEPA","example":"BSCHESMMXXX"},"extraDetails":{"type":"object","description":"Additional provider or rail-specific parameters (e.g. tax ID, address, phone)","example":{"taxId":"B12345678","address":"Calle Gran Via 12, Madrid"}},"identity":{"description":"Identity data used for compliance screening","allOf":[{"$ref":"#/components/schemas/BeneficiaryIdentityDto"}]}}},"QuoteRequestDto":{"type":"object","properties":{"from":{"type":"string","description":"ISO 4217 fiat currency or stablecoin code the client sends (e.g. USD, EUR, MXN, COP, USDT)","example":"USD"},"to":{"type":"string","description":"ISO 4217 fiat currency or stablecoin code the beneficiary receives (e.g. COP, MXN, EUR, USD, CNY, VES, USDT)","example":"COP"},"amount":{"type":"string","description":"Positive decimal string representing the monetary amount. Must not exceed 6 decimal places. Represents sendAmount when side is SEND, or receiveAmount when side is RECEIVE.","example":"500.00"},"side":{"type":"string","description":"Quoting direction: SEND fixes what the sender pays and calculates destination payout; RECEIVE fixes the recipient payout and calculates sender cost.","enum":["SEND","RECEIVE"],"default":"SEND","example":"SEND"},"toCountry":{"type":"string","description":"ISO 3166-1 alpha-2 destination country code (e.g. CO, MX, US, DE, EC). Narrows candidate destination payout corridors.","example":"CO"}},"required":["from","to","amount"]},"QuoteResponseDto":{"type":"object","properties":{"quoteId":{"type":"string","description":"Unique identifier of the persisted indicative quote","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"from":{"type":"string","description":"Source currency code sent by the payer","example":"USD"},"to":{"type":"string","description":"Target currency code delivered to the beneficiary","example":"COP"},"side":{"type":"string","description":"Quoting side specified in the request (SEND or RECEIVE)","enum":["SEND","RECEIVE"],"example":"SEND"},"sendAmount":{"type":"string","description":"Exact monetary amount in source currency (from units)","example":"500.00"},"receiveAmount":{"type":"string","description":"Calculated payout amount in destination currency (to units), with commercial markups applied","example":"2045900.00"},"clientRate":{"type":"string","description":"Effective client exchange rate (destination units per 1 source unit) including markups","example":"4091.80000000"},"expiresAt":{"format":"date-time","type":"string","description":"ISO 8601 timestamp after which the indicative quote can no longer be converted to an order","example":"2026-10-22T01:30:00.000Z"},"indicative":{"type":"boolean","description":"Indicates the rate is indicative and final execution rate is captured at order settlement time","example":true},"legs":{"type":"number","description":"Number of hops/legs traversed (1 for direct corridor, 2 for stablecoin bridge). Specific providers remain confidential.","example":2}},"required":["quoteId","from","to","side","sendAmount","receiveAmount","clientRate","expiresAt","indicative","legs"]},"CreateOrderDto":{"type":"object","properties":{"quoteId":{"type":"string","description":"UUID of an active and unexpired indicative quote obtained via POST /v1/rates/quote","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"beneficiaryId":{"type":"string","description":"UUID of the pre-registered beneficiary belonging to the caller organization, matching destination payout currency and country","example":"84ecbd88-c083-49d6-a780-ef7da4b15e64"}},"required":["quoteId","beneficiaryId"]},"OrderBeneficiarySummaryDto":{"type":"object","properties":{"id":{"type":"string","example":"a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d"},"name":{"type":"string","example":"Empresa Importadora Ecuador S.A."},"bankName":{"type":"string","example":"Banco Pichincha"},"accountNumber":{"type":"string","example":"2100192837"},"accountType":{"type":"string","example":"checking"}},"required":["id","name","bankName","accountNumber"]},"OrderEventSummaryDto":{"type":"object","properties":{"id":{"type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"previousStatus":{"type":"string","enum":["CONFIRMED","AWAITING_FIAT","FIAT_RECEIVED","USDT_SENT","USDT_RECEIVED","PAID_OUT","CANCELLED","EXPIRED","REFUNDED","EXCEPTION","PAYOUT_FAILED","RETURNED"],"example":"CONFIRMED"},"newStatus":{"type":"string","enum":["CONFIRMED","AWAITING_FIAT","FIAT_RECEIVED","USDT_SENT","USDT_RECEIVED","PAID_OUT","CANCELLED","EXPIRED","REFUNDED","EXCEPTION","PAYOUT_FAILED","RETURNED"],"example":"AWAITING_FIAT"},"source":{"type":"string","example":"API"},"createdAt":{"format":"date-time","type":"string","example":"2026-10-15T18:20:00.000Z"}},"required":["id","newStatus","source","createdAt"]},"OrderLegSummaryDto":{"type":"object","properties":{"legIndex":{"type":"number","example":0},"providerSlug":{"type":"string","example":"mock"},"legKey":{"type":"string","example":"ONRAMP:EUR>USDT@POLYGON"},"kind":{"type":"string","example":"ONRAMP"},"status":{"type":"string","example":"EXECUTED"},"fromCurrency":{"type":"string","example":"EUR"},"toCurrency":{"type":"string","example":"USDT"},"sendAmount":{"type":"string","example":"1000.00"},"receiveAmount":{"type":"string","example":"1082.50"},"rate":{"type":"string","example":"1.0825000000"},"providerRef":{"type":"object","example":"ord-12345"},"txHash":{"type":"object","example":"0x123abc456def"}},"required":["legIndex","providerSlug","legKey","kind","status","fromCurrency","toCurrency","sendAmount","receiveAmount","rate"]},"OrderResponseDto":{"type":"object","properties":{"orderId":{"type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"status":{"type":"string","enum":["CONFIRMED","AWAITING_FIAT","FIAT_RECEIVED","USDT_SENT","USDT_RECEIVED","PAID_OUT","CANCELLED","EXPIRED","REFUNDED","EXCEPTION","PAYOUT_FAILED","RETURNED"],"example":"AWAITING_FIAT"},"from":{"type":"string","example":"EUR"},"to":{"type":"string","example":"USD"},"sendAmount":{"type":"string","example":"1000.00"},"receiveAmount":{"type":"string","example":"1082.50"},"clientRate":{"type":"string","example":"1.0825000000"},"expiresAt":{"type":"object","example":"2026-10-15T18:35:00.000Z"},"paymentInstructions":{"type":"object","description":"Instructions for the payer to send fiat to the on-ramp"},"beneficiary":{"$ref":"#/components/schemas/OrderBeneficiarySummaryDto"},"timeline":{"type":"array","items":{"$ref":"#/components/schemas/OrderEventSummaryDto"}},"legs":{"type":"array","items":{"$ref":"#/components/schemas/OrderLegSummaryDto"}},"createdAt":{"format":"date-time","type":"string","example":"2026-10-15T18:20:00.000Z"},"updatedAt":{"format":"date-time","type":"string","example":"2026-10-15T18:20:00.000Z"}},"required":["orderId","status","from","to","sendAmount","receiveAmount","clientRate","createdAt","updatedAt"]},"TextileSubmitSwapDto":{"type":"object","properties":{}},"TextileSellDto":{"type":"object","properties":{}},"TextileSubmitDepositDto":{"type":"object","properties":{}},"SwapPreviewDto":{"type":"object","properties":{}},"CreateSwapDto":{"type":"object","properties":{}},"SubmitSwapDto":{"type":"object","properties":{}},"RequestCreditLimitDto":{"type":"object","properties":{"clientRequestId":{"type":"string","description":"UUID you generate per operation; resending the same value never creates a duplicate"},"amount":{"type":"string","example":"150000"}},"required":["amount"]},"RequestFacilityDto":{"type":"object","properties":{"clientRequestId":{"type":"string","description":"UUID you generate per operation; resending the same value never creates a duplicate"},"amount":{"type":"string","example":"50000"},"chainRef":{"type":"string","description":"Provider chain id; defaults to the account default or the provider chain for the organization"},"notes":{"type":"string"}},"required":["amount"]},"AddCreditWalletDto":{"type":"object","properties":{"clientRequestId":{"type":"string","description":"UUID you generate per operation; resending the same value never creates a duplicate"},"address":{"type":"string","example":"0x1111111111111111111111111111111111111111"},"label":{"type":"string","example":"Treasury"}},"required":["address","label"]},"RequestWithdrawalDto":{"type":"object","properties":{"clientRequestId":{"type":"string","description":"UUID you generate per operation; resending the same value never creates a duplicate"},"amount":{"type":"string","example":"10000"},"walletRef":{"type":"string","description":"Whitelisted wallet id at the provider"},"acceptedAdvancedNotice":{"type":"boolean","description":"Must be true: accepts the provider's Advanced Notice terms"},"chainRef":{"type":"string"},"notes":{"type":"string"}},"required":["amount","walletRef","acceptedAdvancedNotice"]},"ClearDuesDto":{"type":"object","properties":{"chainRef":{"type":"string"}}},"UtilizationProofFormDto":{"type":"object","properties":{"data":{"type":"string","description":"JSON: { facilityId, amount, currencyId, corridors: [{ id, amount, currencyId, routes: [{ id, ... }] }], clientRequestId? }"}},"required":["data"]},"UpsertWebhookEndpointDto":{"type":"object","properties":{"url":{"type":"string","description":"HTTPS URL that receives the events. Private and loopback addresses are rejected.","example":"https://api.example.com/rook/webhooks"},"enabled":{"type":"boolean","description":"Pause (false) or resume (true) deliveries.","default":true},"regenerateSecret":{"type":"boolean","description":"Issue a new signing secret. The previous one stops working immediately.","default":false}},"required":["url"]},"GrantConsentDto":{"type":"object","properties":{"target":{"type":"string","description":"Rook slug of the receiving provider"},"accepted":{"type":"boolean","enum":[true],"description":"Must be literally true"},"consentTextVersion":{"type":"string","description":"Version of the consent text shown to the user"}},"required":["target","accepted","consentTextVersion"]},"IssueShareDto":{"type":"object","properties":{"target":{"type":"string","description":"Rook slug of the receiving provider"}},"required":["target"]}}}}