{ "openapi": "3.0.0", "paths": { "/v1/webhooks": { "post": { "description": "Registers an HTTPS endpoint to receive signed Wayex events for this tenant account. Create one when your integration needs asynchronous transfer, Treasury, verification, or route updates.", "operationId": "WebhookController2_subscribe_v1", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique key for this logical action. Reuse the same key and identical payload when retrying after an unknown response.", "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "example": "13bda8d7-87bd-4fa4-b7d5-e740725f9bd2" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscribeWebhookDto" } } } }, "responses": { "201": { "description": "The created subscription (the signing secret is never echoed).", "content": { "application/json": { "schema": { "description": "A webhook subscription (the signing secret is never echoed).", "type": "object", "properties": { "id": { "description": "The subscription id.", "type": "string" }, "url": { "description": "The endpoint deliveries are sent to.", "type": "string", "format": "uri" }, "eventTypes": { "description": "The event types subscribed to.", "type": "array", "items": { "type": "string", "enum": [ "counterparty.created", "counterparty.invited", "counterparty.activated", "customer.created", "kyc.updated", "payment_route.created", "payment_route.activity.created", "rate.updated", "quote.created", "transfer.created", "transfer.updated", "transfer.completed", "treasury.wallet.updated", "treasury.payin.updated", "treasury.deposit.updated", "treasury.payout.updated", "treasury.withdrawal.updated", "treasury.conversion.updated", "approval.created", "approval.resolved" ] } }, "status": { "description": "Whether the subscription receives events.", "type": "string", "enum": [ "active", "disabled" ] }, "createdAt": { "description": "When the subscription was created (ISO 8601).", "type": "string" } }, "required": [ "id", "url", "eventTypes", "status", "createdAt" ] } } } }, "400": { "description": "Validation failed — invalid event types, or a url that is not https / resolves to a private, loopback or link-local address / cannot be resolved at all." } }, "summary": "Create a webhook subscription", "tags": [ "Webhooks" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/webhooks/create-a-subscription", "metadata": { "title": "Create a webhook subscription", "description": "Registers an HTTPS endpoint to receive signed Wayex events for this tenant account." }, "content": "## What this endpoint does\n\nRegisters an HTTPS endpoint to receive signed Wayex events for this tenant account.\n\n## When to use it\n\nCreate one when your integration needs asynchronous transfer, Treasury, verification, or route updates.\n\n## Before you call\n\nUse a secret API key with webhook write access. You choose and supply the HMAC signing `secret` (minimum 8 characters) in this request; it is stored encrypted and never returned in any response, so save your copy first. The destination `url` must be a public HTTPS endpoint — private, loopback, link-local, and metadata addresses are refused — and your handler must preserve the raw request body to verify signatures.\n\n## Money and balance effect\n\nThis changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.\n\n## States and completion\n\nCreation confirms the subscription exists; it does not prove your endpoint acknowledged a delivery. Inspect delivery records and verify every signature.\n\n## Safe retries\n\nSend a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out.\n\nRead [Webhooks](/console/developers) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/developers", "moneyEffect": "This changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.", "retry": "Send a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out." } }, "get": { "description": "Lists the webhook endpoints registered for the current tenant account. Use it to audit integrations, check which URL receives events, or locate a subscription before reviewing deliveries.", "operationId": "WebhookController2_list_v1", "parameters": [], "responses": { "200": { "description": "Your webhook subscriptions.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "description": "A webhook subscription (the signing secret is never echoed).", "type": "object", "properties": { "id": { "description": "The subscription id.", "type": "string" }, "url": { "description": "The endpoint deliveries are sent to.", "type": "string", "format": "uri" }, "eventTypes": { "description": "The event types subscribed to.", "type": "array", "items": { "type": "string", "enum": [ "counterparty.created", "counterparty.invited", "counterparty.activated", "customer.created", "kyc.updated", "payment_route.created", "payment_route.activity.created", "rate.updated", "quote.created", "transfer.created", "transfer.updated", "transfer.completed", "treasury.wallet.updated", "treasury.payin.updated", "treasury.deposit.updated", "treasury.payout.updated", "treasury.withdrawal.updated", "treasury.conversion.updated", "approval.created", "approval.resolved" ] } }, "status": { "description": "Whether the subscription receives events.", "type": "string", "enum": [ "active", "disabled" ] }, "createdAt": { "description": "When the subscription was created (ISO 8601).", "type": "string" } }, "required": [ "id", "url", "eventTypes", "status", "createdAt" ] } } }, "required": [ "data" ] } } } } }, "summary": "List webhook subscriptions", "tags": [ "Webhooks" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/webhooks/list-subscriptions", "metadata": { "title": "List webhook subscriptions", "description": "Lists the webhook endpoints registered for the current tenant account." }, "content": "## What this endpoint does\n\nLists the webhook endpoints registered for the current tenant account.\n\n## When to use it\n\nUse it to audit integrations, check which URL receives events, or locate a subscription before reviewing deliveries.\n\n## Before you call\n\nAuthenticate with an API key that can read this resource. Results are restricted to the tenant account bound to that key.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nA subscription’s `status` is `active` or `disabled`; only `active` subscriptions receive deliveries. An `active` status does not prove your endpoint is accepting events — check its deliveries, where each event is `pending`, `failed`, `delivered`, or `dead`.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Webhooks](/console/developers) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/developers", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/webhooks/{id}/deliveries": { "get": { "description": "Returns recent delivery attempts for one webhook subscription, including their outcome. Use it to diagnose missing events, non-2xx responses, or repeated delivery attempts.", "operationId": "WebhookController2_deliveries_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The delivery history for the subscription (newest first).", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "description": "A single webhook delivery and its true outcome.", "type": "object", "properties": { "id": { "description": "The delivery id — `:`, stable across retries.", "type": "string" }, "subscriptionId": { "description": "The subscription this delivery belongs to.", "type": "string" }, "eventId": { "description": "The id of the delivered event (used by consumers to dedupe).", "type": "string" }, "eventType": { "description": "The type of the delivered event.", "type": "string", "enum": [ "counterparty.created", "counterparty.invited", "counterparty.activated", "customer.created", "kyc.updated", "payment_route.created", "payment_route.activity.created", "rate.updated", "quote.created", "transfer.created", "transfer.updated", "transfer.completed", "treasury.wallet.updated", "treasury.payin.updated", "treasury.deposit.updated", "treasury.payout.updated", "treasury.withdrawal.updated", "treasury.conversion.updated", "approval.created", "approval.resolved" ] }, "status": { "description": "The TRUE state of this delivery. `pending` = queued, not yet attempted. `failed` = attempted, no 2xx, a retry is scheduled. `delivered` = your endpoint returned a 2xx. `dead` = the retry budget is exhausted and it will not be retried again.", "type": "string", "enum": [ "pending", "failed", "delivered", "dead" ] }, "attempts": { "description": "How many attempts have actually been made.", "type": "integer" }, "nextAttemptAt": { "description": "When the next retry is due (ISO 8601). Meaningless once terminal.", "type": "string" }, "lastStatusCode": { "description": "The HTTP status your endpoint returned on the last attempt, if it responded.", "type": "integer" }, "lastError": { "description": "A machine reason code for the last failure (e.g. `http_error`, `timeout`).", "type": "string" }, "createdAt": { "description": "When the delivery was queued (ISO 8601).", "type": "string" }, "updatedAt": { "description": "When the delivery was last attempted/updated (ISO 8601).", "type": "string" }, "deliveredAt": { "description": "When a 2xx was actually received. Absent unless status is `delivered`.", "type": "string" } }, "required": [ "id", "subscriptionId", "eventId", "eventType", "status", "attempts", "nextAttemptAt", "createdAt", "updatedAt" ] } } }, "required": [ "data" ] } } } }, "404": { "description": "No such webhook subscription." } }, "summary": "List webhook deliveries", "tags": [ "Webhooks" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/webhooks/list-deliveries", "metadata": { "title": "List webhook deliveries", "description": "Returns recent delivery attempts for one webhook subscription, including their outcome." }, "content": "## What this endpoint does\n\nReturns recent delivery attempts for one webhook subscription, including their outcome.\n\n## When to use it\n\nUse it to diagnose missing events, non-2xx responses, or repeated delivery attempts.\n\n## Before you call\n\nAuthenticate with an API key that can read webhooks, and pass a subscription ID owned by the same tenant account.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nDelivery success means your endpoint returned an accepted response. Events remain at-least-once and unordered, so deduplicate by event ID.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Webhooks](/console/developers) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/developers", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/invite/{token}": { "get": { "description": "Checks whether a one-time team invitation token is valid and returns the invitation details needed by the activation screen. Call it after a recipient opens an invitation link and before showing the account-activation form.", "operationId": "InviteController2_validate_v1", "parameters": [ { "name": "token", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The minimal context for the setup page.", "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "companyName": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "invited", "active", "suspended" ] } }, "required": [ "email", "companyName", "status" ] } } } }, "404": { "description": "The token is unknown, expired, or already used." } }, "summary": "Validate a team invitation", "tags": [ "Invitations" ], "security": [], "x-mint": { "href": "/api-reference/invitations/validate-an-invitation", "metadata": { "title": "Validate a team invitation", "description": "Checks whether a one-time team invitation token is valid and returns the invitation details needed by the activation screen." }, "content": "## What this endpoint does\n\nChecks whether a one-time team invitation token is valid and returns the invitation details needed by the activation screen.\n\n## When to use it\n\nCall it after a recipient opens an invitation link and before showing the account-activation form.\n\n## Before you call\n\nPass the invitation token from the link. This endpoint does not require an API key.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nA valid token returns the invitation context. Unknown, expired, and already-used tokens all return the same generic `404` — the response deliberately never reveals which — so build the activation screen around two outcomes: proceed with activation, or request a new invitation.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Team and roles](/console/team-roles) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/team-roles", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/invite/{token}/complete": { "post": { "description": "Uses a valid invitation token to set the first administrator’s permanent console password and activate the account the invitation was issued to. Submit it once after the recipient has reviewed the invitation and chosen a password.", "operationId": "InviteController2_complete_v1", "parameters": [ { "name": "token", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompleteInviteDto" } } } }, "responses": { "201": { "description": "Account activated; includes the login URL.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "loginUrl": { "type": "string", "format": "uri" } }, "required": [ "ok", "loginUrl" ] } } } }, "400": { "description": "Validation failed (e.g. password too weak)." }, "404": { "description": "The token is unknown, expired, or already used." } }, "summary": "Accept a team invitation", "tags": [ "Invitations" ], "security": [], "x-mint": { "href": "/api-reference/invitations/accept-an-invitation", "metadata": { "title": "Accept a team invitation", "description": "Uses a valid invitation token to set the first administrator’s permanent console password and activate the account the invitation was issued to." }, "content": "## What this endpoint does\n\nUses a valid invitation token to set the first administrator’s permanent console password and activate the account the invitation was issued to.\n\n## When to use it\n\nSubmit it once after the recipient has reviewed the invitation and chosen a password.\n\n## Before you call\n\nPass a valid, unused invitation token and a request that meets the credential requirements. No API key is required.\n\n## Money and balance effect\n\nThis changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.\n\n## States and completion\n\nA successful response consumes the token. Expired or previously used tokens must be replaced by a new invitation.\n\n## Safe retries\n\nDo not submit concurrently. If the response is lost, validate the token again before retrying; a consumed token means activation already completed.\n\nRead [Team and roles](/console/team-roles) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/team-roles", "moneyEffect": "This changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.", "retry": "Do not submit concurrently. If the response is lost, validate the token again before retrying; a consumed token means activation already completed." } } }, "/v1/customers": { "post": { "description": "Creates an individual or business customer under the current tenant account. Create the customer before issuing verification or customer-owned payment routes.", "operationId": "CustomerController2_create_v1", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique key for this logical action. Reuse the same key and identical payload when retrying after an unknown response.", "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "example": "13bda8d7-87bd-4fa4-b7d5-e740725f9bd2" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "business" ] }, "externalCustomerId": { "type": "string", "minLength": 1 }, "contact": { "type": "object", "properties": { "email": { "description": "The customer's contact email address.", "type": "string", "format": "email" }, "name": { "description": "Optional display name for the customer.", "type": "string", "minLength": 1 } }, "required": [ "email" ] }, "businessDetails": { "type": "object", "properties": { "companyName": { "type": "string", "minLength": 1 }, "registrationNumber": { "type": "string", "minLength": 1 }, "country": { "type": "string", "minLength": 1 } }, "required": [ "companyName", "registrationNumber", "country" ] }, "requestedEntitlements": { "type": "array", "items": { "type": "string", "enum": [ "aud_onramp", "aud_offramp", "payment_route", "higher_limits" ] }, "default": [ "payment_route", "aud_onramp", "aud_offramp" ] }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "type", "contact", "businessDetails" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "individual" ] }, "externalCustomerId": { "type": "string", "minLength": 1 }, "contact": { "type": "object", "properties": { "email": { "description": "The customer's contact email address.", "type": "string", "format": "email" }, "name": { "description": "Optional display name for the customer.", "type": "string", "minLength": 1 } }, "required": [ "email" ] }, "individualDetails": { "type": "object", "properties": { "firstName": { "type": "string", "minLength": 1 }, "lastName": { "type": "string", "minLength": 1 }, "dob": { "type": "string", "minLength": 1 }, "nationality": { "type": "string", "minLength": 1 }, "country": { "type": "string", "minLength": 1 } }, "required": [ "firstName", "lastName", "dob", "nationality", "country" ] }, "requestedEntitlements": { "type": "array", "items": { "type": "string", "enum": [ "aud_onramp", "aud_offramp", "payment_route", "higher_limits" ] }, "default": [ "payment_route", "aud_onramp", "aud_offramp" ] }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "type", "contact" ] }, { "type": "object", "properties": { "email": { "description": "The customer's email. Minimal onboarding: the customer self-completes verification.", "type": "string", "format": "email" }, "externalCustomerId": { "description": "Your own identifier for this customer, echoed back for cross-referencing.", "type": "string", "minLength": 1 }, "name": { "description": "Optional display name for the customer.", "type": "string", "minLength": 1 }, "requestedEntitlements": { "description": "Capabilities to request; granted only once verification is approved.", "type": "array", "items": { "type": "string", "enum": [ "aud_onramp", "aud_offramp", "payment_route", "higher_limits" ] }, "default": [ "payment_route", "aud_onramp", "aud_offramp" ] }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "email" ] } ] } } } }, "responses": { "201": { "description": "The created customer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Unique Wayex identifier for this customer.", "type": "string", "minLength": 1 }, "counterpartyId": { "description": "The client account (counterparty) this customer belongs to. For API callers this is always your own account id.", "type": "string", "minLength": 1 }, "externalCustomerId": { "description": "Your own identifier for this customer, echoed back for cross-referencing.", "type": "string", "minLength": 1 }, "type": { "description": "Whether the customer is an individual (natural person) or a business (legal entity).", "type": "string", "enum": [ "individual", "business" ] }, "contact": { "type": "object", "properties": { "email": { "description": "The customer's contact email address.", "type": "string", "format": "email" }, "name": { "description": "Optional display name for the customer.", "type": "string", "minLength": 1 } }, "required": [ "email" ] }, "businessDetails": { "type": "object", "properties": { "companyName": { "type": "string", "minLength": 1 }, "registrationNumber": { "type": "string", "minLength": 1 }, "country": { "type": "string", "minLength": 1 } }, "required": [ "companyName", "registrationNumber", "country" ] }, "individualDetails": { "type": "object", "properties": { "firstName": { "type": "string", "minLength": 1 }, "lastName": { "type": "string", "minLength": 1 }, "dob": { "type": "string", "minLength": 1 }, "nationality": { "type": "string", "minLength": 1 }, "country": { "type": "string", "minLength": 1 } }, "required": [ "firstName", "lastName", "dob", "nationality", "country" ] }, "verificationStatus": { "description": "Current verification state. Value can only move on the customer's behalf once approved.", "type": "string", "enum": [ "in_progress", "approved", "rejected", "requires_action" ] }, "entitlements": { "description": "The capabilities this customer is cleared for, granted as verification completes.", "type": "array", "items": { "type": "object", "properties": { "entitlement": { "type": "string", "enum": [ "aud_onramp", "aud_offramp", "payment_route", "higher_limits" ] }, "status": { "type": "string", "enum": [ "in_progress", "approved", "rejected", "requires_action" ] } }, "required": [ "entitlement", "status" ] } }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } }, "createdAt": { "description": "When the customer was created (ISO 8601).", "type": "string", "format": "date-time" } }, "required": [ "id", "counterpartyId", "type", "contact", "verificationStatus", "entitlements", "createdAt" ] } } } }, "400": { "description": "Validation failed (unknown or malformed fields)." }, "401": { "description": "Missing or invalid API key." }, "409": { "description": "Idempotency-Key reused with a different request body." } }, "summary": "Create a customer", "tags": [ "Customers" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/customers/create-a-customer", "metadata": { "title": "Create a customer", "description": "Creates an individual or business customer under the current tenant account." }, "content": "## What this endpoint does\n\nCreates an individual or business customer under the current tenant account.\n\n## When to use it\n\nCreate the customer before issuing verification or customer-owned payment routes.\n\n## Before you call\n\nUse a secret API key with customer write access. The minimum body is the customer’s email — the customer then self-completes verification via a verification link. To supply identity up front, send the typed shape instead (`type` plus `contact`, and `businessDetails` for businesses). `externalCustomerId` is optional on every shape and is echoed back for cross-referencing. The optional free-form `metadata` map reserves one key name, `@@wxtype` (and any `@@wxtype.esc…` variant): a bag containing it is refused with `400 invalid_request` and nothing is written.\n\n## Money and balance effect\n\nThis changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.\n\n## States and completion\n\nCreation does not approve the customer. Verification and entitlements progress asynchronously.\n\n## Safe retries\n\nSend a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out.\n\nRead [Customers](/console/customers) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/customers", "moneyEffect": "This changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.", "retry": "Send a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out." } }, "get": { "description": "Lists end customers onboarded under the current tenant account. Use it to build customer search, onboarding queues, and links into customer detail.", "operationId": "CustomerController2_list_v1", "parameters": [ { "name": "counterparty_id", "required": false, "in": "query", "description": "Admin keys only: scope results to the given client account (counterparty). Non-admin callers passing this parameter receive `403` — it is never silently ignored.", "schema": { "type": "string" } }, { "name": "cursor", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "schema": { "example": 25, "type": "number" } } ], "responses": { "200": { "description": "A cursor-paginated page of customers.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "description": "The page of results, newest first.", "items": { "type": "object", "properties": { "id": { "description": "Unique Wayex identifier for this customer.", "type": "string", "minLength": 1 }, "counterpartyId": { "description": "The client account (counterparty) this customer belongs to. For API callers this is always your own account id.", "type": "string", "minLength": 1 }, "externalCustomerId": { "description": "Your own identifier for this customer, echoed back for cross-referencing.", "type": "string", "minLength": 1 }, "type": { "description": "Whether the customer is an individual (natural person) or a business (legal entity).", "type": "string", "enum": [ "individual", "business" ] }, "contact": { "type": "object", "properties": { "email": { "description": "The customer's contact email address.", "type": "string", "format": "email" }, "name": { "description": "Optional display name for the customer.", "type": "string", "minLength": 1 } }, "required": [ "email" ] }, "businessDetails": { "type": "object", "properties": { "companyName": { "type": "string", "minLength": 1 }, "registrationNumber": { "type": "string", "minLength": 1 }, "country": { "type": "string", "minLength": 1 } }, "required": [ "companyName", "registrationNumber", "country" ] }, "individualDetails": { "type": "object", "properties": { "firstName": { "type": "string", "minLength": 1 }, "lastName": { "type": "string", "minLength": 1 }, "dob": { "type": "string", "minLength": 1 }, "nationality": { "type": "string", "minLength": 1 }, "country": { "type": "string", "minLength": 1 } }, "required": [ "firstName", "lastName", "dob", "nationality", "country" ] }, "verificationStatus": { "description": "Current verification state. Value can only move on the customer's behalf once approved.", "type": "string", "enum": [ "in_progress", "approved", "rejected", "requires_action" ] }, "entitlements": { "description": "The capabilities this customer is cleared for, granted as verification completes.", "type": "array", "items": { "type": "object", "properties": { "entitlement": { "type": "string", "enum": [ "aud_onramp", "aud_offramp", "payment_route", "higher_limits" ] }, "status": { "type": "string", "enum": [ "in_progress", "approved", "rejected", "requires_action" ] } }, "required": [ "entitlement", "status" ] } }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } }, "createdAt": { "description": "When the customer was created (ISO 8601).", "type": "string", "format": "date-time" } }, "required": [ "id", "counterpartyId", "type", "contact", "verificationStatus", "entitlements", "createdAt" ] } }, "hasMore": { "type": "boolean", "description": "Whether a further page exists after this one." }, "nextCursor": { "type": "string", "nullable": true, "description": "Opaque cursor to pass as `cursor` to fetch the next page, or null at the end." } }, "required": [ "data", "hasMore", "nextCursor" ] } } } }, "403": { "description": "counterparty_id passed with a non-admin key." } }, "summary": "List customers", "tags": [ "Customers" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/customers/list-customers", "metadata": { "title": "List customers", "description": "Lists end customers onboarded under the current tenant account." }, "content": "## What this endpoint does\n\nLists end customers onboarded under the current tenant account.\n\n## When to use it\n\nUse it to build customer search, onboarding queues, and links into customer detail.\n\n## Before you call\n\nAuthenticate with an API key that can read this resource. Results are restricted to the tenant account bound to that key.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nCustomer and verification states are snapshots. Fetch the customer or its entitlements when you need current eligibility.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Customers](/console/customers) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/customers", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/customers/{id}": { "get": { "description": "Returns the current record for one customer. Use it for customer detail, support checks, and authoritative state after a webhook.", "operationId": "CustomerController2_get_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The customer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Unique Wayex identifier for this customer.", "type": "string", "minLength": 1 }, "counterpartyId": { "description": "The client account (counterparty) this customer belongs to. For API callers this is always your own account id.", "type": "string", "minLength": 1 }, "externalCustomerId": { "description": "Your own identifier for this customer, echoed back for cross-referencing.", "type": "string", "minLength": 1 }, "type": { "description": "Whether the customer is an individual (natural person) or a business (legal entity).", "type": "string", "enum": [ "individual", "business" ] }, "contact": { "type": "object", "properties": { "email": { "description": "The customer's contact email address.", "type": "string", "format": "email" }, "name": { "description": "Optional display name for the customer.", "type": "string", "minLength": 1 } }, "required": [ "email" ] }, "businessDetails": { "type": "object", "properties": { "companyName": { "type": "string", "minLength": 1 }, "registrationNumber": { "type": "string", "minLength": 1 }, "country": { "type": "string", "minLength": 1 } }, "required": [ "companyName", "registrationNumber", "country" ] }, "individualDetails": { "type": "object", "properties": { "firstName": { "type": "string", "minLength": 1 }, "lastName": { "type": "string", "minLength": 1 }, "dob": { "type": "string", "minLength": 1 }, "nationality": { "type": "string", "minLength": 1 }, "country": { "type": "string", "minLength": 1 } }, "required": [ "firstName", "lastName", "dob", "nationality", "country" ] }, "verificationStatus": { "description": "Current verification state. Value can only move on the customer's behalf once approved.", "type": "string", "enum": [ "in_progress", "approved", "rejected", "requires_action" ] }, "entitlements": { "description": "The capabilities this customer is cleared for, granted as verification completes.", "type": "array", "items": { "type": "object", "properties": { "entitlement": { "type": "string", "enum": [ "aud_onramp", "aud_offramp", "payment_route", "higher_limits" ] }, "status": { "type": "string", "enum": [ "in_progress", "approved", "rejected", "requires_action" ] } }, "required": [ "entitlement", "status" ] } }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } }, "createdAt": { "description": "When the customer was created (ISO 8601).", "type": "string", "format": "date-time" } }, "required": [ "id", "counterpartyId", "type", "contact", "verificationStatus", "entitlements", "createdAt" ] } } } }, "404": { "description": "No such customer for this account." } }, "summary": "Get a customer", "tags": [ "Customers" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/customers/get-a-customer", "metadata": { "title": "Get a customer", "description": "Returns the current record for one customer." }, "content": "## What this endpoint does\n\nReturns the current record for one customer.\n\n## When to use it\n\nUse it for customer detail, support checks, and authoritative state after a webhook.\n\n## Before you call\n\nAuthenticate with customer read access and pass a customer ID owned by the same tenant account.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nThe customer’s `verificationStatus` is `in_progress`, `approved`, `rejected`, or `requires_action`; each `entitlements` entry carries its own `status` from the same set. Both are authoritative at response time — only `approved` entitlements can be used.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Customers](/console/customers) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/customers", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } }, "patch": { "description": "Updates supported fields on an existing customer without replacing the whole record. Use it when customer details change and the schema permits that field to be edited.", "operationId": "CustomerController2_patch_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchCustomerDto" } } } }, "responses": { "200": { "description": "The updated customer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Unique Wayex identifier for this customer.", "type": "string", "minLength": 1 }, "counterpartyId": { "description": "The client account (counterparty) this customer belongs to. For API callers this is always your own account id.", "type": "string", "minLength": 1 }, "externalCustomerId": { "description": "Your own identifier for this customer, echoed back for cross-referencing.", "type": "string", "minLength": 1 }, "type": { "description": "Whether the customer is an individual (natural person) or a business (legal entity).", "type": "string", "enum": [ "individual", "business" ] }, "contact": { "type": "object", "properties": { "email": { "description": "The customer's contact email address.", "type": "string", "format": "email" }, "name": { "description": "Optional display name for the customer.", "type": "string", "minLength": 1 } }, "required": [ "email" ] }, "businessDetails": { "type": "object", "properties": { "companyName": { "type": "string", "minLength": 1 }, "registrationNumber": { "type": "string", "minLength": 1 }, "country": { "type": "string", "minLength": 1 } }, "required": [ "companyName", "registrationNumber", "country" ] }, "individualDetails": { "type": "object", "properties": { "firstName": { "type": "string", "minLength": 1 }, "lastName": { "type": "string", "minLength": 1 }, "dob": { "type": "string", "minLength": 1 }, "nationality": { "type": "string", "minLength": 1 }, "country": { "type": "string", "minLength": 1 } }, "required": [ "firstName", "lastName", "dob", "nationality", "country" ] }, "verificationStatus": { "description": "Current verification state. Value can only move on the customer's behalf once approved.", "type": "string", "enum": [ "in_progress", "approved", "rejected", "requires_action" ] }, "entitlements": { "description": "The capabilities this customer is cleared for, granted as verification completes.", "type": "array", "items": { "type": "object", "properties": { "entitlement": { "type": "string", "enum": [ "aud_onramp", "aud_offramp", "payment_route", "higher_limits" ] }, "status": { "type": "string", "enum": [ "in_progress", "approved", "rejected", "requires_action" ] } }, "required": [ "entitlement", "status" ] } }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } }, "createdAt": { "description": "When the customer was created (ISO 8601).", "type": "string", "format": "date-time" } }, "required": [ "id", "counterpartyId", "type", "contact", "verificationStatus", "entitlements", "createdAt" ] } } } }, "400": { "description": "Validation failed (unknown or malformed fields)." }, "404": { "description": "No such customer for this account." } }, "summary": "Update a customer", "tags": [ "Customers" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/customers/update-a-customer", "metadata": { "title": "Update a customer", "description": "Updates supported fields on an existing customer without replacing the whole record." }, "content": "## What this endpoint does\n\nUpdates supported fields on an existing customer without replacing the whole record.\n\n## When to use it\n\nUse it when customer details change and the schema permits that field to be edited.\n\n## Before you call\n\nUse a secret API key with customer write access and pass a customer ID owned by the same tenant account.\n\n## Money and balance effect\n\nThis changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.\n\n## States and completion\n\nUpdates apply immediately and do not re-trigger verification. The customer’s verification state and entitlements are unchanged by this call.\n\n## Safe retries\n\nPATCH does not use an `Idempotency-Key`. After an unknown response, read the customer first; retry the identical field update only if the desired values are not present.\n\nRead [Customers](/console/customers) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/customers", "moneyEffect": "This changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.", "retry": "PATCH does not use an `Idempotency-Key`. After an unknown response, read the customer first; retry the identical field update only if the desired values are not present." } } }, "/v1/customers/{id}/entitlements": { "get": { "description": "Returns the capabilities currently granted to one customer. Check it before creating a payment route or enabling a customer flow in your product.", "operationId": "EntitlementsController2_get_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The customer's entitlement statuses." }, "404": { "description": "No such customer for this account." } }, "summary": "List customer entitlements", "tags": [ "Customers" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/customers/list-entitlements", "metadata": { "title": "List customer entitlements", "description": "Returns the capabilities currently granted to one customer." }, "content": "## What this endpoint does\n\nReturns the capabilities currently granted to one customer.\n\n## When to use it\n\nCheck it before creating a payment route or enabling a customer flow in your product.\n\n## Before you call\n\nAuthenticate with customer read access and pass a customer ID owned by the same tenant account.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nEntitlements can be in progress, approved, rejected, or require action. Only approved capabilities may be used.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Customers](/console/customers) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/customers", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/customers/{id}/verification-link": { "post": { "description": "Issues a hosted link where a customer completes identity or business verification. Create it after onboarding a customer that still needs verification, then redirect or send them to the returned URL.", "operationId": "VerificationController2_createLink_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique key for this logical action. Reuse the same key and identical payload when retrying after an unknown response.", "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "example": "13bda8d7-87bd-4fa4-b7d5-e740725f9bd2" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ttlSeconds": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 86400, "exclusiveMaximum": false } } } } } }, "responses": { "201": { "description": "The hosted verification link." }, "400": { "description": "Validation failed." }, "404": { "description": "No such customer for this account." } }, "summary": "Create a hosted verification link", "tags": [ "Customers" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/customers/create-a-verification-link", "metadata": { "title": "Create a hosted verification link", "description": "Issues a hosted link where a customer completes identity or business verification." }, "content": "## What this endpoint does\n\nIssues a hosted link where a customer completes identity or business verification.\n\n## When to use it\n\nCreate it after onboarding a customer that still needs verification, then redirect or send them to the returned URL.\n\n## Before you call\n\nUse a secret API key with customer write access and pass a customer ID owned by this tenant account.\n\n## Money and balance effect\n\nThis changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.\n\n## States and completion\n\nThe link only starts verification. The final result arrives asynchronously and updates the customer and entitlements.\n\n## Safe retries\n\nSend a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out.\n\nRead [Customers](/console/customers) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/customers", "moneyEffect": "This changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.", "retry": "Send a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out." } } }, "/v1/transfers": { "get": { "description": "Lists conversions automatically created when customers fund direct payment routes. Use it for transfer search, reconciliation, and monitoring across customers and routes.", "operationId": "TransferController2_list_v1", "parameters": [ { "name": "customer_id", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "type", "required": false, "in": "query", "schema": { "enum": [ "onramp", "offramp" ], "type": "string" } }, { "name": "route_id", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "counterparty_id", "required": false, "in": "query", "description": "Admin keys only: scope results to the given client account (counterparty). Non-admin callers passing this parameter receive `403` — it is never silently ignored.", "schema": { "type": "string" } }, { "name": "cursor", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "schema": { "example": 25, "type": "number" } }, { "name": "sort", "required": false, "in": "query", "schema": { "enum": [ "-created_at", "created_at", "-updated_at", "updated_at" ], "type": "string" } } ], "responses": { "200": { "description": "A cursor-paginated page of transfers.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "description": "The page of results, newest first.", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "description": "Unique identifier for this transfer.", "type": "string", "minLength": 1 }, "counterpartyId": { "description": "The client account (counterparty) this transfer belongs to. For API callers this is always your own account id.", "type": "string", "minLength": 1 }, "customerId": { "description": "The customer this transfer is for.", "type": "string", "minLength": 1 }, "routeId": { "description": "The payment route whose funding spawned this transfer.", "type": "string", "minLength": 1 }, "quoteId": { "description": "Reference to the live price struck at funding; absent until the conversion executes.", "type": "string", "minLength": 1 }, "status": { "description": "Current lifecycle status. State advances asynchronously, so treat this as the source of truth.", "type": "string", "enum": [ "created", "validated", "screening", "fx_executed", "completed", "awaiting_deposit", "deposit_detected", "deposit_confirming", "deposit_cleared", "sweeping", "onforwarding", "payout_instructed", "payout_held", "payout_settled", "awaiting_payin", "payin_cleared", "disbursing", "sending", "send_confirming", "pooled", "on_hold", "frozen", "failed", "cancelled", "returned", "expired", "reversing", "reversed" ] }, "sourceDepositInstructions": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "crypto" ] }, "address": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" } }, "required": [ "kind", "address", "currency", "network", "amount" ] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "aud" ] }, "bsb": { "type": "string", "minLength": 1 }, "accountNumber": { "type": "string", "minLength": 1 }, "payId": { "type": "string" }, "reference": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "enum": [ "AUD" ] }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" } }, "required": [ "kind", "bsb", "accountNumber", "reference", "currency", "amount" ] } ] }, "references": { "type": "object", "properties": { "payoutHoldReason": { "type": "string" }, "quoteId": { "type": "string", "minLength": 1 }, "providerQuoteId": { "type": "string" }, "liquidationAddress": { "type": "string" }, "vaultId": { "type": "string" }, "disbursementVaultId": { "type": "string" }, "depositReference": { "type": "string" }, "payinReference": { "type": "string" }, "tradeId": { "type": "string" }, "sweepTxId": { "type": "string" }, "failedSweepTxIds": { "type": "array", "items": { "type": "string" } }, "onforwardTxId": { "type": "string" }, "failedOnforwardTxIds": { "type": "array", "items": { "type": "string" } }, "onforwardToAddress": { "type": "string" }, "onforwardTxHash": { "type": "string" }, "onforwardDepositId": { "type": "string" }, "fiatWithdrawalId": { "type": "string" }, "stablecoinWithdrawalId": { "type": "string" }, "fxFundingPayoutId": { "type": "string" }, "sendTxId": { "type": "string" }, "failedSendTxIds": { "type": "array", "items": { "type": "string" } }, "payoutId": { "type": "string" }, "ledgerEntryRefs": { "type": "array", "items": { "type": "string" } } } }, "timeline": { "description": "Ordered history of the states this transfer passed through, with timestamps.", "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "created", "validated", "screening", "fx_executed", "completed", "awaiting_deposit", "deposit_detected", "deposit_confirming", "deposit_cleared", "sweeping", "onforwarding", "payout_instructed", "payout_held", "payout_settled", "awaiting_payin", "payin_cleared", "disbursing", "sending", "send_confirming", "pooled", "on_hold", "frozen", "failed", "cancelled", "returned", "expired", "reversing", "reversed" ] }, "at": { "type": "string", "format": "date-time" }, "providerRef": { "type": "string" }, "description": { "type": "string" } }, "required": [ "status", "at" ] } }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } }, "createdAt": { "description": "When the transfer was created (ISO 8601).", "type": "string", "format": "date-time" }, "updatedAt": { "description": "When the transfer was last updated (ISO 8601).", "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "offramp" ] }, "source": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" } }, "required": [ "currency", "network", "amount" ] }, "destination": { "oneOf": [ { "type": "object", "properties": { "account_holder_name": { "type": "string", "minLength": 1 }, "bsb_code": { "type": "string", "minLength": 1 }, "account_number": { "type": "string", "minLength": 1 }, "bank_country": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "enum": [ "AUD" ] } }, "required": [ "account_holder_name", "bsb_code", "account_number", "bank_country", "currency" ] }, { "type": "object", "properties": { "payid": { "type": "string", "minLength": 1 }, "payid_type": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "account_holder_name": { "type": "string", "minLength": 1 }, "bank_country": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "enum": [ "AUD" ] } }, "required": [ "payid", "payid_type", "account_holder_name", "bank_country", "currency" ] } ] }, "destinationAmount": { "description": "Net AUD the customer receives as a decimal string; set once the conversion executes (\"0\" before).", "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "destinationCurrency": { "type": "string", "enum": [ "AUD" ] } }, "required": [ "id", "counterpartyId", "customerId", "status", "sourceDepositInstructions", "references", "timeline", "createdAt", "updatedAt", "type", "source", "destination", "destinationAmount", "destinationCurrency" ] }, { "type": "object", "properties": { "id": { "description": "Unique identifier for this transfer.", "type": "string", "minLength": 1 }, "counterpartyId": { "description": "The client account (counterparty) this transfer belongs to. For API callers this is always your own account id.", "type": "string", "minLength": 1 }, "customerId": { "description": "The customer this transfer is for.", "type": "string", "minLength": 1 }, "routeId": { "description": "The payment route whose funding spawned this transfer.", "type": "string", "minLength": 1 }, "quoteId": { "description": "Reference to the live price struck at funding; absent until the conversion executes.", "type": "string", "minLength": 1 }, "status": { "description": "Current lifecycle status. State advances asynchronously, so treat this as the source of truth.", "type": "string", "enum": [ "created", "validated", "screening", "fx_executed", "completed", "awaiting_deposit", "deposit_detected", "deposit_confirming", "deposit_cleared", "sweeping", "onforwarding", "payout_instructed", "payout_held", "payout_settled", "awaiting_payin", "payin_cleared", "disbursing", "sending", "send_confirming", "pooled", "on_hold", "frozen", "failed", "cancelled", "returned", "expired", "reversing", "reversed" ] }, "sourceDepositInstructions": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "crypto" ] }, "address": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" } }, "required": [ "kind", "address", "currency", "network", "amount" ] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "aud" ] }, "bsb": { "type": "string", "minLength": 1 }, "accountNumber": { "type": "string", "minLength": 1 }, "payId": { "type": "string" }, "reference": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "enum": [ "AUD" ] }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" } }, "required": [ "kind", "bsb", "accountNumber", "reference", "currency", "amount" ] } ] }, "references": { "type": "object", "properties": { "payoutHoldReason": { "type": "string" }, "quoteId": { "type": "string", "minLength": 1 }, "providerQuoteId": { "type": "string" }, "liquidationAddress": { "type": "string" }, "vaultId": { "type": "string" }, "disbursementVaultId": { "type": "string" }, "depositReference": { "type": "string" }, "payinReference": { "type": "string" }, "tradeId": { "type": "string" }, "sweepTxId": { "type": "string" }, "failedSweepTxIds": { "type": "array", "items": { "type": "string" } }, "onforwardTxId": { "type": "string" }, "failedOnforwardTxIds": { "type": "array", "items": { "type": "string" } }, "onforwardToAddress": { "type": "string" }, "onforwardTxHash": { "type": "string" }, "onforwardDepositId": { "type": "string" }, "fiatWithdrawalId": { "type": "string" }, "stablecoinWithdrawalId": { "type": "string" }, "fxFundingPayoutId": { "type": "string" }, "sendTxId": { "type": "string" }, "failedSendTxIds": { "type": "array", "items": { "type": "string" } }, "payoutId": { "type": "string" }, "ledgerEntryRefs": { "type": "array", "items": { "type": "string" } } } }, "timeline": { "description": "Ordered history of the states this transfer passed through, with timestamps.", "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "created", "validated", "screening", "fx_executed", "completed", "awaiting_deposit", "deposit_detected", "deposit_confirming", "deposit_cleared", "sweeping", "onforwarding", "payout_instructed", "payout_held", "payout_settled", "awaiting_payin", "payin_cleared", "disbursing", "sending", "send_confirming", "pooled", "on_hold", "frozen", "failed", "cancelled", "returned", "expired", "reversing", "reversed" ] }, "at": { "type": "string", "format": "date-time" }, "providerRef": { "type": "string" }, "description": { "type": "string" } }, "required": [ "status", "at" ] } }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } }, "createdAt": { "description": "When the transfer was created (ISO 8601).", "type": "string", "format": "date-time" }, "updatedAt": { "description": "When the transfer was last updated (ISO 8601).", "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "onramp" ] }, "source": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AUD" ] }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" } }, "required": [ "currency", "amount" ] }, "destination": { "type": "object", "properties": { "address": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "address", "currency", "network" ] }, "destinationAmount": { "description": "Net stablecoin the customer receives as a decimal string; set once the conversion executes (\"0\" before).", "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "destinationCurrency": { "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "id", "counterpartyId", "customerId", "status", "sourceDepositInstructions", "references", "timeline", "createdAt", "updatedAt", "type", "source", "destination", "destinationAmount", "destinationCurrency" ] } ] } }, "hasMore": { "type": "boolean", "description": "Whether a further page exists after this one." }, "nextCursor": { "type": "string", "nullable": true, "description": "Opaque cursor to pass as `cursor` to fetch the next page, or null at the end." } }, "required": [ "data", "hasMore", "nextCursor" ] } } } }, "403": { "description": "counterparty_id passed with a non-admin key." } }, "summary": "List direct-route transfers", "tags": [ "Transfers" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/transfers/list-transfers", "metadata": { "title": "List direct-route transfers", "description": "Lists conversions automatically created when customers fund direct payment routes." }, "content": "## What this endpoint does\n\nLists conversions automatically created when customers fund direct payment routes.\n\n## When to use it\n\nUse it for transfer search, reconciliation, and monitoring across customers and routes.\n\n## Before you call\n\nAuthenticate with an API key that can read this resource. Results are restricted to the tenant account bound to that key.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nThe `status` field carries the enum values shown in the schema, not display copy. Broadly: `awaiting_payin`, `awaiting_deposit`, and the `deposit_*` states are waiting on funds; states such as `screening`, `fx_executed`, `sweeping`, `pooled`, `payout_instructed`, and `sending` are in flight; `on_hold`, `payout_held`, and `frozen` are holds; `completed`, `failed`, `cancelled`, `returned`, `expired`, and `reversed` are terminal. Treat only `completed` as settled — never infer settlement from creation alone.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Activity and history](/console/activity) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/activity", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/transfers/{id}": { "get": { "description": "Returns the authoritative lifecycle and linked references for one direct-route transfer. Use it after a webhook, when investigating a transfer, or when you need its current settlement state.", "operationId": "TransferController2_get_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The transfer with its lifecycle timeline.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "id": { "description": "Unique identifier for this transfer.", "type": "string", "minLength": 1 }, "counterpartyId": { "description": "The client account (counterparty) this transfer belongs to. For API callers this is always your own account id.", "type": "string", "minLength": 1 }, "customerId": { "description": "The customer this transfer is for.", "type": "string", "minLength": 1 }, "routeId": { "description": "The payment route whose funding spawned this transfer.", "type": "string", "minLength": 1 }, "quoteId": { "description": "Reference to the live price struck at funding; absent until the conversion executes.", "type": "string", "minLength": 1 }, "status": { "description": "Current lifecycle status. State advances asynchronously, so treat this as the source of truth.", "type": "string", "enum": [ "created", "validated", "screening", "fx_executed", "completed", "awaiting_deposit", "deposit_detected", "deposit_confirming", "deposit_cleared", "sweeping", "onforwarding", "payout_instructed", "payout_held", "payout_settled", "awaiting_payin", "payin_cleared", "disbursing", "sending", "send_confirming", "pooled", "on_hold", "frozen", "failed", "cancelled", "returned", "expired", "reversing", "reversed" ] }, "sourceDepositInstructions": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "crypto" ] }, "address": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" } }, "required": [ "kind", "address", "currency", "network", "amount" ] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "aud" ] }, "bsb": { "type": "string", "minLength": 1 }, "accountNumber": { "type": "string", "minLength": 1 }, "payId": { "type": "string" }, "reference": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "enum": [ "AUD" ] }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" } }, "required": [ "kind", "bsb", "accountNumber", "reference", "currency", "amount" ] } ] }, "references": { "type": "object", "properties": { "payoutHoldReason": { "type": "string" }, "quoteId": { "type": "string", "minLength": 1 }, "providerQuoteId": { "type": "string" }, "liquidationAddress": { "type": "string" }, "vaultId": { "type": "string" }, "disbursementVaultId": { "type": "string" }, "depositReference": { "type": "string" }, "payinReference": { "type": "string" }, "tradeId": { "type": "string" }, "sweepTxId": { "type": "string" }, "failedSweepTxIds": { "type": "array", "items": { "type": "string" } }, "onforwardTxId": { "type": "string" }, "failedOnforwardTxIds": { "type": "array", "items": { "type": "string" } }, "onforwardToAddress": { "type": "string" }, "onforwardTxHash": { "type": "string" }, "onforwardDepositId": { "type": "string" }, "fiatWithdrawalId": { "type": "string" }, "stablecoinWithdrawalId": { "type": "string" }, "fxFundingPayoutId": { "type": "string" }, "sendTxId": { "type": "string" }, "failedSendTxIds": { "type": "array", "items": { "type": "string" } }, "payoutId": { "type": "string" }, "ledgerEntryRefs": { "type": "array", "items": { "type": "string" } } } }, "timeline": { "description": "Ordered history of the states this transfer passed through, with timestamps.", "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "created", "validated", "screening", "fx_executed", "completed", "awaiting_deposit", "deposit_detected", "deposit_confirming", "deposit_cleared", "sweeping", "onforwarding", "payout_instructed", "payout_held", "payout_settled", "awaiting_payin", "payin_cleared", "disbursing", "sending", "send_confirming", "pooled", "on_hold", "frozen", "failed", "cancelled", "returned", "expired", "reversing", "reversed" ] }, "at": { "type": "string", "format": "date-time" }, "providerRef": { "type": "string" }, "description": { "type": "string" } }, "required": [ "status", "at" ] } }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } }, "createdAt": { "description": "When the transfer was created (ISO 8601).", "type": "string", "format": "date-time" }, "updatedAt": { "description": "When the transfer was last updated (ISO 8601).", "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "offramp" ] }, "source": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" } }, "required": [ "currency", "network", "amount" ] }, "destination": { "oneOf": [ { "type": "object", "properties": { "account_holder_name": { "type": "string", "minLength": 1 }, "bsb_code": { "type": "string", "minLength": 1 }, "account_number": { "type": "string", "minLength": 1 }, "bank_country": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "enum": [ "AUD" ] } }, "required": [ "account_holder_name", "bsb_code", "account_number", "bank_country", "currency" ] }, { "type": "object", "properties": { "payid": { "type": "string", "minLength": 1 }, "payid_type": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "account_holder_name": { "type": "string", "minLength": 1 }, "bank_country": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "enum": [ "AUD" ] } }, "required": [ "payid", "payid_type", "account_holder_name", "bank_country", "currency" ] } ] }, "destinationAmount": { "description": "Net AUD the customer receives as a decimal string; set once the conversion executes (\"0\" before).", "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "destinationCurrency": { "type": "string", "enum": [ "AUD" ] } }, "required": [ "id", "counterpartyId", "customerId", "status", "sourceDepositInstructions", "references", "timeline", "createdAt", "updatedAt", "type", "source", "destination", "destinationAmount", "destinationCurrency" ] }, { "type": "object", "properties": { "id": { "description": "Unique identifier for this transfer.", "type": "string", "minLength": 1 }, "counterpartyId": { "description": "The client account (counterparty) this transfer belongs to. For API callers this is always your own account id.", "type": "string", "minLength": 1 }, "customerId": { "description": "The customer this transfer is for.", "type": "string", "minLength": 1 }, "routeId": { "description": "The payment route whose funding spawned this transfer.", "type": "string", "minLength": 1 }, "quoteId": { "description": "Reference to the live price struck at funding; absent until the conversion executes.", "type": "string", "minLength": 1 }, "status": { "description": "Current lifecycle status. State advances asynchronously, so treat this as the source of truth.", "type": "string", "enum": [ "created", "validated", "screening", "fx_executed", "completed", "awaiting_deposit", "deposit_detected", "deposit_confirming", "deposit_cleared", "sweeping", "onforwarding", "payout_instructed", "payout_held", "payout_settled", "awaiting_payin", "payin_cleared", "disbursing", "sending", "send_confirming", "pooled", "on_hold", "frozen", "failed", "cancelled", "returned", "expired", "reversing", "reversed" ] }, "sourceDepositInstructions": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "crypto" ] }, "address": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" } }, "required": [ "kind", "address", "currency", "network", "amount" ] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "aud" ] }, "bsb": { "type": "string", "minLength": 1 }, "accountNumber": { "type": "string", "minLength": 1 }, "payId": { "type": "string" }, "reference": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "enum": [ "AUD" ] }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" } }, "required": [ "kind", "bsb", "accountNumber", "reference", "currency", "amount" ] } ] }, "references": { "type": "object", "properties": { "payoutHoldReason": { "type": "string" }, "quoteId": { "type": "string", "minLength": 1 }, "providerQuoteId": { "type": "string" }, "liquidationAddress": { "type": "string" }, "vaultId": { "type": "string" }, "disbursementVaultId": { "type": "string" }, "depositReference": { "type": "string" }, "payinReference": { "type": "string" }, "tradeId": { "type": "string" }, "sweepTxId": { "type": "string" }, "failedSweepTxIds": { "type": "array", "items": { "type": "string" } }, "onforwardTxId": { "type": "string" }, "failedOnforwardTxIds": { "type": "array", "items": { "type": "string" } }, "onforwardToAddress": { "type": "string" }, "onforwardTxHash": { "type": "string" }, "onforwardDepositId": { "type": "string" }, "fiatWithdrawalId": { "type": "string" }, "stablecoinWithdrawalId": { "type": "string" }, "fxFundingPayoutId": { "type": "string" }, "sendTxId": { "type": "string" }, "failedSendTxIds": { "type": "array", "items": { "type": "string" } }, "payoutId": { "type": "string" }, "ledgerEntryRefs": { "type": "array", "items": { "type": "string" } } } }, "timeline": { "description": "Ordered history of the states this transfer passed through, with timestamps.", "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "created", "validated", "screening", "fx_executed", "completed", "awaiting_deposit", "deposit_detected", "deposit_confirming", "deposit_cleared", "sweeping", "onforwarding", "payout_instructed", "payout_held", "payout_settled", "awaiting_payin", "payin_cleared", "disbursing", "sending", "send_confirming", "pooled", "on_hold", "frozen", "failed", "cancelled", "returned", "expired", "reversing", "reversed" ] }, "at": { "type": "string", "format": "date-time" }, "providerRef": { "type": "string" }, "description": { "type": "string" } }, "required": [ "status", "at" ] } }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } }, "createdAt": { "description": "When the transfer was created (ISO 8601).", "type": "string", "format": "date-time" }, "updatedAt": { "description": "When the transfer was last updated (ISO 8601).", "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "onramp" ] }, "source": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AUD" ] }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" } }, "required": [ "currency", "amount" ] }, "destination": { "type": "object", "properties": { "address": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "address", "currency", "network" ] }, "destinationAmount": { "description": "Net stablecoin the customer receives as a decimal string; set once the conversion executes (\"0\" before).", "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "destinationCurrency": { "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "id", "counterpartyId", "customerId", "status", "sourceDepositInstructions", "references", "timeline", "createdAt", "updatedAt", "type", "source", "destination", "destinationAmount", "destinationCurrency" ] } ] } } } }, "404": { "description": "No such transfer for this account." } }, "summary": "Get a direct-route transfer", "tags": [ "Transfers" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/transfers/get-a-transfer", "metadata": { "title": "Get a direct-route transfer", "description": "Returns the authoritative lifecycle and linked references for one direct-route transfer." }, "content": "## What this endpoint does\n\nReturns the authoritative lifecycle and linked references for one direct-route transfer.\n\n## When to use it\n\nUse it after a webhook, when investigating a transfer, or when you need its current settlement state.\n\n## Before you call\n\nAuthenticate with transfer read access and pass a transfer ID owned by the same tenant account.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nRead `status` together with the `timeline` array: entries record each state with its timestamp and, when present, a plain-language `description` explaining holds. `on_hold`, `payout_held`, `frozen`, `failed`, and `returned` are not settlement — only `completed` is.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Activity and history](/console/activity) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/activity", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/activity": { "get": { "description": "Returns a reverse-chronological, cursor-paginated feed of direct-route transfer activity across all of your customers — a compact projection of the same set `GET /v1/transfers` returns. Treasury operations and customer events never appear here. Use it for a dashboard feed of direct-route transfers. Treasury operations never appear here — read those from `GET /v1/treasury/operations` and `GET /v1/treasury/transactions`. Use resource-specific list and detail endpoints for full reconciliation.", "operationId": "ActivityController2_list_v1", "parameters": [ { "name": "cursor", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "schema": { "example": 25, "type": "number" } } ], "responses": { "200": { "description": "A cursor-paginated page of activity items." } }, "summary": "List recent account activity", "tags": [ "Transfers" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/transfers/list-recent-activity", "metadata": { "title": "List recent account activity", "description": "Returns a reverse-chronological, cursor-paginated feed of direct-route transfer activity across all of your customers — a compact projection of the same set `GET /v1/transfers` returns. Treasury operations and customer events never appear here." }, "content": "## What this endpoint does\n\nReturns a reverse-chronological, cursor-paginated feed of direct-route transfer activity across all of your customers — a compact projection of the same set `GET /v1/transfers` returns. Treasury operations and customer events never appear here.\n\n## When to use it\n\nUse it for a dashboard feed of direct-route transfers. Treasury operations never appear here — read those from `GET /v1/treasury/operations` and `GET /v1/treasury/transactions`. Use resource-specific list and detail endpoints for full reconciliation.\n\n## Before you call\n\nAuthenticate with an API key that can read this resource. Results are restricted to the tenant account bound to that key.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nEntries are compact transfer summaries; each entry’s `id` is the transfer ID. Fetch the transfer for its authoritative status and timeline.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Activity and history](/console/activity) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/activity", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/payment-routes": { "post": { "description": "Creates a standing on-ramp or off-ramp route and provisions its reusable funding instructions. Use it after the customer has the required approved entitlement and you know the delivery destination and route limits.", "operationId": "PaymentRouteController2_create_v1", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique key for this logical action. Reuse the same key and identical payload when retrying after an unknown response.", "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "example": "13bda8d7-87bd-4fa4-b7d5-e740725f9bd2" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "customerId": { "description": "The verified customer this route belongs to.", "type": "string", "minLength": 1 }, "direction": { "description": "The customer funds AUD and receives stablecoin at the destination address.", "type": "string", "enum": [ "aud_to_stablecoin" ] }, "destination": { "description": "Where the converted stablecoin is delivered.", "type": "object", "properties": { "network": { "description": "The network the stablecoin is delivered on.", "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "address": { "description": "The destination crypto address the converted stablecoin is sent to.", "type": "string", "minLength": 1 }, "currency": { "description": "Which stablecoin to deliver.", "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "network", "address", "currency" ] }, "limits": { "description": "Optional per-route min/max/daily limits; a deposit outside them is held, not converted.", "type": "object", "properties": { "min": { "type": "string" }, "max": { "type": "string" }, "daily": { "type": "string" } } }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "customerId", "direction", "destination" ] }, { "type": "object", "properties": { "customerId": { "description": "The verified customer this route belongs to.", "type": "string", "minLength": 1 }, "direction": { "description": "The customer sends stablecoin and receives AUD at the destination bank account or PayID.", "type": "string", "enum": [ "stablecoin_to_aud" ] }, "destination": { "description": "The AUD payout target (bank account or PayID) plus the deposit side — either a single `network`, or the EVM option `{ networkScope: 'evm' }` to accept the asset on any wired EVM chain at one address (acceptedNetworks are server-filled).", "oneOf": [ { "type": "object", "properties": { "bankAccount": { "type": "object", "properties": { "accountHolderName": { "description": "Name on the destination AUD bank account.", "type": "string", "minLength": 1 }, "bsb": { "description": "The 6-digit BSB of the destination AUD bank account.", "type": "string", "minLength": 1 }, "accountNumber": { "description": "The destination AUD bank account number.", "type": "string", "minLength": 1 } }, "required": [ "accountHolderName", "bsb", "accountNumber" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "bankAccount", "asset", "network" ] }, { "type": "object", "properties": { "bankAccount": { "type": "object", "properties": { "accountHolderName": { "description": "Name on the destination AUD bank account.", "type": "string", "minLength": 1 }, "bsb": { "description": "The 6-digit BSB of the destination AUD bank account.", "type": "string", "minLength": 1 }, "accountNumber": { "description": "The destination AUD bank account number.", "type": "string", "minLength": 1 } }, "required": [ "accountHolderName", "bsb", "accountNumber" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] } }, "required": [ "bankAccount", "asset", "networkScope" ] }, { "type": "object", "properties": { "payId": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "type", "value" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "payId", "asset", "network" ] }, { "type": "object", "properties": { "payId": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "type", "value" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] } }, "required": [ "payId", "asset", "networkScope" ] } ] }, "limits": { "description": "Optional per-route min/max/daily limits; a deposit outside them is held, not converted.", "type": "object", "properties": { "min": { "type": "string" }, "max": { "type": "string" }, "daily": { "type": "string" } } }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "customerId", "direction", "destination" ] } ] } } } }, "responses": { "201": { "description": "The created payment route with deposit instructions.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "counterpartyId": { "description": "The client account (counterparty) this route belongs to. For API callers this is always your own account id.", "type": "string", "minLength": 1 }, "customerId": { "type": "string", "minLength": 1 }, "direction": { "type": "string", "enum": [ "aud_to_stablecoin" ] }, "destination": { "type": "object", "properties": { "network": { "description": "The network the stablecoin is delivered on.", "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "address": { "description": "The destination crypto address the converted stablecoin is sent to.", "type": "string", "minLength": 1 }, "currency": { "description": "Which stablecoin to deliver.", "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "network", "address", "currency" ] }, "limits": { "type": "object", "properties": { "min": { "type": "string" }, "max": { "type": "string" }, "daily": { "type": "string" } } }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "instructions": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "reference": { "type": "string", "minLength": 1 }, "deposit": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "aud" ] }, "bsb": { "type": "string", "minLength": 1 }, "accountNumber": { "type": "string", "minLength": 1 }, "payId": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "type", "value" ] }, "reference": { "type": "string", "minLength": 1 } }, "required": [ "kind", "bsb", "accountNumber", "reference" ] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "crypto" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "address": { "type": "string", "minLength": 1 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "kind", "network", "address", "asset" ] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "crypto" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] }, "acceptedNetworks": { "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "address": { "type": "string", "minLength": 1 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "kind", "networkScope", "acceptedNetworks", "address", "asset" ] } ] }, "destinationSummary": { "type": "string", "minLength": 1 }, "limits": { "type": "object", "properties": { "min": { "type": "string" }, "max": { "type": "string" }, "daily": { "type": "string" } } }, "steps": { "type": "array", "items": { "type": "string" } } }, "required": [ "title", "reference", "deposit", "destinationSummary", "steps" ] }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "counterpartyId", "customerId", "direction", "destination", "status", "instructions", "createdAt" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "counterpartyId": { "description": "The client account (counterparty) this route belongs to. For API callers this is always your own account id.", "type": "string", "minLength": 1 }, "customerId": { "type": "string", "minLength": 1 }, "direction": { "type": "string", "enum": [ "stablecoin_to_aud" ] }, "destination": { "oneOf": [ { "type": "object", "properties": { "bankAccount": { "type": "object", "properties": { "accountHolderName": { "description": "Name on the destination AUD bank account.", "type": "string", "minLength": 1 }, "bsb": { "description": "The 6-digit BSB of the destination AUD bank account.", "type": "string", "minLength": 1 }, "accountNumber": { "description": "The destination AUD bank account number.", "type": "string", "minLength": 1 } }, "required": [ "accountHolderName", "bsb", "accountNumber" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "bankAccount", "asset", "network" ] }, { "type": "object", "properties": { "bankAccount": { "type": "object", "properties": { "accountHolderName": { "description": "Name on the destination AUD bank account.", "type": "string", "minLength": 1 }, "bsb": { "description": "The 6-digit BSB of the destination AUD bank account.", "type": "string", "minLength": 1 }, "accountNumber": { "description": "The destination AUD bank account number.", "type": "string", "minLength": 1 } }, "required": [ "accountHolderName", "bsb", "accountNumber" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] }, "acceptedNetworks": { "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } } }, "required": [ "bankAccount", "asset", "networkScope", "acceptedNetworks" ] }, { "type": "object", "properties": { "payId": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "type", "value" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "payId", "asset", "network" ] }, { "type": "object", "properties": { "payId": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "type", "value" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] }, "acceptedNetworks": { "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } } }, "required": [ "payId", "asset", "networkScope", "acceptedNetworks" ] } ] }, "limits": { "type": "object", "properties": { "min": { "type": "string" }, "max": { "type": "string" }, "daily": { "type": "string" } } }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "instructions": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "reference": { "type": "string", "minLength": 1 }, "deposit": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "aud" ] }, "bsb": { "type": "string", "minLength": 1 }, "accountNumber": { "type": "string", "minLength": 1 }, "payId": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "type", "value" ] }, "reference": { "type": "string", "minLength": 1 } }, "required": [ "kind", "bsb", "accountNumber", "reference" ] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "crypto" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "address": { "type": "string", "minLength": 1 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "kind", "network", "address", "asset" ] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "crypto" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] }, "acceptedNetworks": { "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "address": { "type": "string", "minLength": 1 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "kind", "networkScope", "acceptedNetworks", "address", "asset" ] } ] }, "destinationSummary": { "type": "string", "minLength": 1 }, "limits": { "type": "object", "properties": { "min": { "type": "string" }, "max": { "type": "string" }, "daily": { "type": "string" } } }, "steps": { "type": "array", "items": { "type": "string" } } }, "required": [ "title", "reference", "deposit", "destinationSummary", "steps" ] }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "counterpartyId", "customerId", "direction", "destination", "status", "instructions", "createdAt" ] } ] } } } }, "400": { "description": "Validation failed (destination mismatches direction, etc.)." }, "403": { "description": "Customer not verified or not entitled for this direction." }, "409": { "description": "Idempotency-Key reused with a different request body." } }, "summary": "Create a payment route", "tags": [ "Payment routes" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/payment-routes/create-a-payment-route", "metadata": { "title": "Create a payment route", "description": "Creates a standing on-ramp or off-ramp route and provisions its reusable funding instructions." }, "content": "## What this endpoint does\n\nCreates a standing on-ramp or off-ramp route and provisions its reusable funding instructions.\n\n## When to use it\n\nUse it after the customer has the required approved entitlement and you know the delivery destination and route limits.\n\n## Before you call\n\nUse a secret API key with route write access. The customer must belong to this tenant account and be eligible for the requested route.\n\n## Money and balance effect\n\nCreating the route does not move money. A later funding event starts a transfer and may convert and deliver funds.\n\n## States and completion\n\nCreation returns the route, not a completed transfer. Monitor transfers created when the route receives funding.\n\n## Safe retries\n\nSend a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out.\n\nRead [Payment routes](/console/payment-routes) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/payment-routes", "moneyEffect": "Creating the route does not move money. A later funding event starts a transfer and may convert and deliver funds.", "retry": "Send a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out." } }, "get": { "description": "Lists standing customer payment routes for the current tenant account. Use it for route search, monitoring, or locating the route linked to a direct-route transfer.", "operationId": "PaymentRouteController2_list_v1", "parameters": [ { "name": "customer_id", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "counterparty_id", "required": false, "in": "query", "description": "Admin keys only: scope results to the given client account (counterparty). Non-admin callers passing this parameter receive `403` — it is never silently ignored.", "schema": { "type": "string" } }, { "name": "cursor", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "schema": { "example": 25, "type": "number" } } ], "responses": { "200": { "description": "A cursor-paginated page of payment routes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "description": "The page of results, newest first.", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "counterpartyId": { "description": "The client account (counterparty) this route belongs to. For API callers this is always your own account id.", "type": "string", "minLength": 1 }, "customerId": { "type": "string", "minLength": 1 }, "direction": { "type": "string", "enum": [ "aud_to_stablecoin" ] }, "destination": { "type": "object", "properties": { "network": { "description": "The network the stablecoin is delivered on.", "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "address": { "description": "The destination crypto address the converted stablecoin is sent to.", "type": "string", "minLength": 1 }, "currency": { "description": "Which stablecoin to deliver.", "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "network", "address", "currency" ] }, "limits": { "type": "object", "properties": { "min": { "type": "string" }, "max": { "type": "string" }, "daily": { "type": "string" } } }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "instructions": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "reference": { "type": "string", "minLength": 1 }, "deposit": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "aud" ] }, "bsb": { "type": "string", "minLength": 1 }, "accountNumber": { "type": "string", "minLength": 1 }, "payId": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "type", "value" ] }, "reference": { "type": "string", "minLength": 1 } }, "required": [ "kind", "bsb", "accountNumber", "reference" ] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "crypto" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "address": { "type": "string", "minLength": 1 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "kind", "network", "address", "asset" ] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "crypto" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] }, "acceptedNetworks": { "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "address": { "type": "string", "minLength": 1 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "kind", "networkScope", "acceptedNetworks", "address", "asset" ] } ] }, "destinationSummary": { "type": "string", "minLength": 1 }, "limits": { "type": "object", "properties": { "min": { "type": "string" }, "max": { "type": "string" }, "daily": { "type": "string" } } }, "steps": { "type": "array", "items": { "type": "string" } } }, "required": [ "title", "reference", "deposit", "destinationSummary", "steps" ] }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "counterpartyId", "customerId", "direction", "destination", "status", "instructions", "createdAt" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "counterpartyId": { "description": "The client account (counterparty) this route belongs to. For API callers this is always your own account id.", "type": "string", "minLength": 1 }, "customerId": { "type": "string", "minLength": 1 }, "direction": { "type": "string", "enum": [ "stablecoin_to_aud" ] }, "destination": { "oneOf": [ { "type": "object", "properties": { "bankAccount": { "type": "object", "properties": { "accountHolderName": { "description": "Name on the destination AUD bank account.", "type": "string", "minLength": 1 }, "bsb": { "description": "The 6-digit BSB of the destination AUD bank account.", "type": "string", "minLength": 1 }, "accountNumber": { "description": "The destination AUD bank account number.", "type": "string", "minLength": 1 } }, "required": [ "accountHolderName", "bsb", "accountNumber" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "bankAccount", "asset", "network" ] }, { "type": "object", "properties": { "bankAccount": { "type": "object", "properties": { "accountHolderName": { "description": "Name on the destination AUD bank account.", "type": "string", "minLength": 1 }, "bsb": { "description": "The 6-digit BSB of the destination AUD bank account.", "type": "string", "minLength": 1 }, "accountNumber": { "description": "The destination AUD bank account number.", "type": "string", "minLength": 1 } }, "required": [ "accountHolderName", "bsb", "accountNumber" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] }, "acceptedNetworks": { "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } } }, "required": [ "bankAccount", "asset", "networkScope", "acceptedNetworks" ] }, { "type": "object", "properties": { "payId": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "type", "value" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "payId", "asset", "network" ] }, { "type": "object", "properties": { "payId": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "type", "value" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] }, "acceptedNetworks": { "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } } }, "required": [ "payId", "asset", "networkScope", "acceptedNetworks" ] } ] }, "limits": { "type": "object", "properties": { "min": { "type": "string" }, "max": { "type": "string" }, "daily": { "type": "string" } } }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "instructions": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "reference": { "type": "string", "minLength": 1 }, "deposit": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "aud" ] }, "bsb": { "type": "string", "minLength": 1 }, "accountNumber": { "type": "string", "minLength": 1 }, "payId": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "type", "value" ] }, "reference": { "type": "string", "minLength": 1 } }, "required": [ "kind", "bsb", "accountNumber", "reference" ] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "crypto" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "address": { "type": "string", "minLength": 1 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "kind", "network", "address", "asset" ] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "crypto" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] }, "acceptedNetworks": { "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "address": { "type": "string", "minLength": 1 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "kind", "networkScope", "acceptedNetworks", "address", "asset" ] } ] }, "destinationSummary": { "type": "string", "minLength": 1 }, "limits": { "type": "object", "properties": { "min": { "type": "string" }, "max": { "type": "string" }, "daily": { "type": "string" } } }, "steps": { "type": "array", "items": { "type": "string" } } }, "required": [ "title", "reference", "deposit", "destinationSummary", "steps" ] }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "counterpartyId", "customerId", "direction", "destination", "status", "instructions", "createdAt" ] } ] } }, "hasMore": { "type": "boolean", "description": "Whether a further page exists after this one." }, "nextCursor": { "type": "string", "nullable": true, "description": "Opaque cursor to pass as `cursor` to fetch the next page, or null at the end." } }, "required": [ "data", "hasMore", "nextCursor" ] } } } }, "403": { "description": "counterparty_id passed with a non-admin key." } }, "summary": "List payment routes", "tags": [ "Payment routes" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/payment-routes/list-payment-routes", "metadata": { "title": "List payment routes", "description": "Lists standing customer payment routes for the current tenant account." }, "content": "## What this endpoint does\n\nLists standing customer payment routes for the current tenant account.\n\n## When to use it\n\nUse it for route search, monitoring, or locating the route linked to a direct-route transfer.\n\n## Before you call\n\nAuthenticate with an API key that can read this resource. Results are restricted to the tenant account bound to that key.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nA route’s `status` is `active` or `inactive`; only share an `active` route’s instructions with payers. Funding events and their conversion states appear as transfers, not on the route.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Payment routes](/console/payment-routes) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/payment-routes", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/payment-routes/{id}": { "get": { "description": "Returns configuration and current status for one standing payment route. Use it to display route detail, validate its state, or follow a route reference from a transfer.", "operationId": "PaymentRouteController2_get_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The payment route.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "counterpartyId": { "description": "The client account (counterparty) this route belongs to. For API callers this is always your own account id.", "type": "string", "minLength": 1 }, "customerId": { "type": "string", "minLength": 1 }, "direction": { "type": "string", "enum": [ "aud_to_stablecoin" ] }, "destination": { "type": "object", "properties": { "network": { "description": "The network the stablecoin is delivered on.", "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "address": { "description": "The destination crypto address the converted stablecoin is sent to.", "type": "string", "minLength": 1 }, "currency": { "description": "Which stablecoin to deliver.", "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "network", "address", "currency" ] }, "limits": { "type": "object", "properties": { "min": { "type": "string" }, "max": { "type": "string" }, "daily": { "type": "string" } } }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "instructions": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "reference": { "type": "string", "minLength": 1 }, "deposit": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "aud" ] }, "bsb": { "type": "string", "minLength": 1 }, "accountNumber": { "type": "string", "minLength": 1 }, "payId": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "type", "value" ] }, "reference": { "type": "string", "minLength": 1 } }, "required": [ "kind", "bsb", "accountNumber", "reference" ] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "crypto" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "address": { "type": "string", "minLength": 1 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "kind", "network", "address", "asset" ] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "crypto" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] }, "acceptedNetworks": { "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "address": { "type": "string", "minLength": 1 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "kind", "networkScope", "acceptedNetworks", "address", "asset" ] } ] }, "destinationSummary": { "type": "string", "minLength": 1 }, "limits": { "type": "object", "properties": { "min": { "type": "string" }, "max": { "type": "string" }, "daily": { "type": "string" } } }, "steps": { "type": "array", "items": { "type": "string" } } }, "required": [ "title", "reference", "deposit", "destinationSummary", "steps" ] }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "counterpartyId", "customerId", "direction", "destination", "status", "instructions", "createdAt" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "counterpartyId": { "description": "The client account (counterparty) this route belongs to. For API callers this is always your own account id.", "type": "string", "minLength": 1 }, "customerId": { "type": "string", "minLength": 1 }, "direction": { "type": "string", "enum": [ "stablecoin_to_aud" ] }, "destination": { "oneOf": [ { "type": "object", "properties": { "bankAccount": { "type": "object", "properties": { "accountHolderName": { "description": "Name on the destination AUD bank account.", "type": "string", "minLength": 1 }, "bsb": { "description": "The 6-digit BSB of the destination AUD bank account.", "type": "string", "minLength": 1 }, "accountNumber": { "description": "The destination AUD bank account number.", "type": "string", "minLength": 1 } }, "required": [ "accountHolderName", "bsb", "accountNumber" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "bankAccount", "asset", "network" ] }, { "type": "object", "properties": { "bankAccount": { "type": "object", "properties": { "accountHolderName": { "description": "Name on the destination AUD bank account.", "type": "string", "minLength": 1 }, "bsb": { "description": "The 6-digit BSB of the destination AUD bank account.", "type": "string", "minLength": 1 }, "accountNumber": { "description": "The destination AUD bank account number.", "type": "string", "minLength": 1 } }, "required": [ "accountHolderName", "bsb", "accountNumber" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] }, "acceptedNetworks": { "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } } }, "required": [ "bankAccount", "asset", "networkScope", "acceptedNetworks" ] }, { "type": "object", "properties": { "payId": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "type", "value" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "payId", "asset", "network" ] }, { "type": "object", "properties": { "payId": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "type", "value" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] }, "acceptedNetworks": { "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } } }, "required": [ "payId", "asset", "networkScope", "acceptedNetworks" ] } ] }, "limits": { "type": "object", "properties": { "min": { "type": "string" }, "max": { "type": "string" }, "daily": { "type": "string" } } }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "instructions": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "reference": { "type": "string", "minLength": 1 }, "deposit": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "aud" ] }, "bsb": { "type": "string", "minLength": 1 }, "accountNumber": { "type": "string", "minLength": 1 }, "payId": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "type", "value" ] }, "reference": { "type": "string", "minLength": 1 } }, "required": [ "kind", "bsb", "accountNumber", "reference" ] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "crypto" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "address": { "type": "string", "minLength": 1 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "kind", "network", "address", "asset" ] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "crypto" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] }, "acceptedNetworks": { "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "address": { "type": "string", "minLength": 1 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "kind", "networkScope", "acceptedNetworks", "address", "asset" ] } ] }, "destinationSummary": { "type": "string", "minLength": 1 }, "limits": { "type": "object", "properties": { "min": { "type": "string" }, "max": { "type": "string" }, "daily": { "type": "string" } } }, "steps": { "type": "array", "items": { "type": "string" } } }, "required": [ "title", "reference", "deposit", "destinationSummary", "steps" ] }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "counterpartyId", "customerId", "direction", "destination", "status", "instructions", "createdAt" ] } ] } } } }, "404": { "description": "No such payment route for this account." } }, "summary": "Get a payment route", "tags": [ "Payment routes" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/payment-routes/get-a-payment-route", "metadata": { "title": "Get a payment route", "description": "Returns configuration and current status for one standing payment route." }, "content": "## What this endpoint does\n\nReturns configuration and current status for one standing payment route.\n\n## When to use it\n\nUse it to display route detail, validate its state, or follow a route reference from a transfer.\n\n## Before you call\n\nAuthenticate with route read access and pass a route ID owned by the same tenant account.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nThe route status does not describe an individual funding. Read the linked transfer for conversion and settlement state.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Payment routes](/console/payment-routes) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/payment-routes", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/payment-routes/{id}/instructions": { "get": { "description": "Returns the reusable bank or blockchain instructions a payer uses to fund one route. Fetch it immediately before displaying or sharing instructions so you show the current values exactly as issued.", "operationId": "PaymentRouteController2_instructions_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The payment route deposit instructions.", "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "reference": { "type": "string", "minLength": 1 }, "deposit": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "aud" ] }, "bsb": { "type": "string", "minLength": 1 }, "accountNumber": { "type": "string", "minLength": 1 }, "payId": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "type", "value" ] }, "reference": { "type": "string", "minLength": 1 } }, "required": [ "kind", "bsb", "accountNumber", "reference" ] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "crypto" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "address": { "type": "string", "minLength": 1 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "kind", "network", "address", "asset" ] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "crypto" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] }, "acceptedNetworks": { "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "address": { "type": "string", "minLength": 1 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "kind", "networkScope", "acceptedNetworks", "address", "asset" ] } ] }, "destinationSummary": { "type": "string", "minLength": 1 }, "limits": { "type": "object", "properties": { "min": { "type": "string" }, "max": { "type": "string" }, "daily": { "type": "string" } } }, "steps": { "type": "array", "items": { "type": "string" } } }, "required": [ "title", "reference", "deposit", "destinationSummary", "steps" ] } } } }, "404": { "description": "No such payment route for this account." } }, "summary": "Get payment route funding instructions", "tags": [ "Payment routes" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/payment-routes/get-funding-instructions", "metadata": { "title": "Get payment route funding instructions", "description": "Returns the reusable bank or blockchain instructions a payer uses to fund one route." }, "content": "## What this endpoint does\n\nReturns the reusable bank or blockchain instructions a payer uses to fund one route.\n\n## When to use it\n\nFetch it immediately before displaying or sharing instructions so you show the current values exactly as issued.\n\n## Before you call\n\nAuthenticate with route read access and pass a route ID owned by the same tenant account.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nInstructions do not prove a payment was received. A funding event creates a transfer that must be tracked separately.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Payment routes](/console/payment-routes) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/payment-routes", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/customers/{customerId}/payment-routes": { "post": { "description": "Creates a standing payment route under the customer identified in the URL. Use this customer-scoped form when your integration already works from a customer record.", "operationId": "CustomerPaymentRouteController2_create_v1", "parameters": [ { "name": "customerId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique key for this logical action. Reuse the same key and identical payload when retrying after an unknown response.", "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "example": "13bda8d7-87bd-4fa4-b7d5-e740725f9bd2" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "direction": { "description": "The customer funds AUD and receives stablecoin at the destination address.", "type": "string", "enum": [ "aud_to_stablecoin" ] }, "destination": { "description": "Where the converted stablecoin is delivered.", "type": "object", "properties": { "network": { "description": "The network the stablecoin is delivered on.", "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "address": { "description": "The destination crypto address the converted stablecoin is sent to.", "type": "string", "minLength": 1 }, "currency": { "description": "Which stablecoin to deliver.", "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "network", "address", "currency" ] }, "limits": { "description": "Optional per-route min/max/daily limits; a deposit outside them is held, not converted.", "type": "object", "properties": { "min": { "type": "string" }, "max": { "type": "string" }, "daily": { "type": "string" } } }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "direction", "destination" ] }, { "type": "object", "properties": { "direction": { "description": "The customer sends stablecoin and receives AUD at the destination bank account or PayID.", "type": "string", "enum": [ "stablecoin_to_aud" ] }, "destination": { "description": "The AUD payout target (bank account or PayID) plus the deposit side — either a single `network`, or the EVM option `{ networkScope: 'evm' }` to accept the asset on any wired EVM chain at one address (acceptedNetworks are server-filled).", "oneOf": [ { "type": "object", "properties": { "bankAccount": { "type": "object", "properties": { "accountHolderName": { "description": "Name on the destination AUD bank account.", "type": "string", "minLength": 1 }, "bsb": { "description": "The 6-digit BSB of the destination AUD bank account.", "type": "string", "minLength": 1 }, "accountNumber": { "description": "The destination AUD bank account number.", "type": "string", "minLength": 1 } }, "required": [ "accountHolderName", "bsb", "accountNumber" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "bankAccount", "asset", "network" ] }, { "type": "object", "properties": { "bankAccount": { "type": "object", "properties": { "accountHolderName": { "description": "Name on the destination AUD bank account.", "type": "string", "minLength": 1 }, "bsb": { "description": "The 6-digit BSB of the destination AUD bank account.", "type": "string", "minLength": 1 }, "accountNumber": { "description": "The destination AUD bank account number.", "type": "string", "minLength": 1 } }, "required": [ "accountHolderName", "bsb", "accountNumber" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] } }, "required": [ "bankAccount", "asset", "networkScope" ] }, { "type": "object", "properties": { "payId": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "type", "value" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "payId", "asset", "network" ] }, { "type": "object", "properties": { "payId": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "type", "value" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] } }, "required": [ "payId", "asset", "networkScope" ] } ] }, "limits": { "description": "Optional per-route min/max/daily limits; a deposit outside them is held, not converted.", "type": "object", "properties": { "min": { "type": "string" }, "max": { "type": "string" }, "daily": { "type": "string" } } }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "direction", "destination" ] } ] } } } }, "responses": { "201": { "description": "The created payment route with deposit instructions.", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "counterpartyId": { "description": "The client account (counterparty) this route belongs to. For API callers this is always your own account id.", "type": "string", "minLength": 1 }, "customerId": { "type": "string", "minLength": 1 }, "direction": { "type": "string", "enum": [ "aud_to_stablecoin" ] }, "destination": { "type": "object", "properties": { "network": { "description": "The network the stablecoin is delivered on.", "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "address": { "description": "The destination crypto address the converted stablecoin is sent to.", "type": "string", "minLength": 1 }, "currency": { "description": "Which stablecoin to deliver.", "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "network", "address", "currency" ] }, "limits": { "type": "object", "properties": { "min": { "type": "string" }, "max": { "type": "string" }, "daily": { "type": "string" } } }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "instructions": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "reference": { "type": "string", "minLength": 1 }, "deposit": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "aud" ] }, "bsb": { "type": "string", "minLength": 1 }, "accountNumber": { "type": "string", "minLength": 1 }, "payId": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "type", "value" ] }, "reference": { "type": "string", "minLength": 1 } }, "required": [ "kind", "bsb", "accountNumber", "reference" ] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "crypto" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "address": { "type": "string", "minLength": 1 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "kind", "network", "address", "asset" ] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "crypto" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] }, "acceptedNetworks": { "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "address": { "type": "string", "minLength": 1 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "kind", "networkScope", "acceptedNetworks", "address", "asset" ] } ] }, "destinationSummary": { "type": "string", "minLength": 1 }, "limits": { "type": "object", "properties": { "min": { "type": "string" }, "max": { "type": "string" }, "daily": { "type": "string" } } }, "steps": { "type": "array", "items": { "type": "string" } } }, "required": [ "title", "reference", "deposit", "destinationSummary", "steps" ] }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "counterpartyId", "customerId", "direction", "destination", "status", "instructions", "createdAt" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "counterpartyId": { "description": "The client account (counterparty) this route belongs to. For API callers this is always your own account id.", "type": "string", "minLength": 1 }, "customerId": { "type": "string", "minLength": 1 }, "direction": { "type": "string", "enum": [ "stablecoin_to_aud" ] }, "destination": { "oneOf": [ { "type": "object", "properties": { "bankAccount": { "type": "object", "properties": { "accountHolderName": { "description": "Name on the destination AUD bank account.", "type": "string", "minLength": 1 }, "bsb": { "description": "The 6-digit BSB of the destination AUD bank account.", "type": "string", "minLength": 1 }, "accountNumber": { "description": "The destination AUD bank account number.", "type": "string", "minLength": 1 } }, "required": [ "accountHolderName", "bsb", "accountNumber" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "bankAccount", "asset", "network" ] }, { "type": "object", "properties": { "bankAccount": { "type": "object", "properties": { "accountHolderName": { "description": "Name on the destination AUD bank account.", "type": "string", "minLength": 1 }, "bsb": { "description": "The 6-digit BSB of the destination AUD bank account.", "type": "string", "minLength": 1 }, "accountNumber": { "description": "The destination AUD bank account number.", "type": "string", "minLength": 1 } }, "required": [ "accountHolderName", "bsb", "accountNumber" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] }, "acceptedNetworks": { "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } } }, "required": [ "bankAccount", "asset", "networkScope", "acceptedNetworks" ] }, { "type": "object", "properties": { "payId": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "type", "value" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "payId", "asset", "network" ] }, { "type": "object", "properties": { "payId": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "type", "value" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] }, "acceptedNetworks": { "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } } }, "required": [ "payId", "asset", "networkScope", "acceptedNetworks" ] } ] }, "limits": { "type": "object", "properties": { "min": { "type": "string" }, "max": { "type": "string" }, "daily": { "type": "string" } } }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "instructions": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "reference": { "type": "string", "minLength": 1 }, "deposit": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "aud" ] }, "bsb": { "type": "string", "minLength": 1 }, "accountNumber": { "type": "string", "minLength": 1 }, "payId": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "type", "value" ] }, "reference": { "type": "string", "minLength": 1 } }, "required": [ "kind", "bsb", "accountNumber", "reference" ] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "crypto" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "address": { "type": "string", "minLength": 1 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "kind", "network", "address", "asset" ] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "crypto" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] }, "acceptedNetworks": { "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "address": { "type": "string", "minLength": 1 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "kind", "networkScope", "acceptedNetworks", "address", "asset" ] } ] }, "destinationSummary": { "type": "string", "minLength": 1 }, "limits": { "type": "object", "properties": { "min": { "type": "string" }, "max": { "type": "string" }, "daily": { "type": "string" } } }, "steps": { "type": "array", "items": { "type": "string" } } }, "required": [ "title", "reference", "deposit", "destinationSummary", "steps" ] }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "counterpartyId", "customerId", "direction", "destination", "status", "instructions", "createdAt" ] } ] } } } }, "400": { "description": "Validation failed (destination mismatches direction, etc.)." }, "403": { "description": "Customer not verified or not entitled for this direction." }, "404": { "description": "No such customer for this account." }, "409": { "description": "Idempotency-Key reused with a different request body." } }, "summary": "Create a payment route for a customer", "tags": [ "Payment routes" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/payment-routes/create-a-customer-payment-route", "metadata": { "title": "Create a payment route for a customer", "description": "Creates a standing payment route under the customer identified in the URL." }, "content": "## What this endpoint does\n\nCreates a standing payment route under the customer identified in the URL.\n\n## When to use it\n\nUse this customer-scoped form when your integration already works from a customer record.\n\n## Before you call\n\nUse a secret API key with route write access. The customer must belong to this tenant account and have the required approved entitlement.\n\n## Money and balance effect\n\nCreating the route does not move money. Funding the issued instructions later starts a transfer.\n\n## States and completion\n\nCreation confirms route provisioning, not funding or settlement. Track each later funding through its transfer.\n\n## Safe retries\n\nSend a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out.\n\nRead [Payment routes](/console/payment-routes) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/payment-routes", "moneyEffect": "Creating the route does not move money. Funding the issued instructions later starts a transfer.", "retry": "Send a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out." } }, "get": { "description": "Lists standing payment routes owned by one customer. Use it on customer detail pages or before deciding whether another route is needed.", "operationId": "CustomerPaymentRouteController2_list_v1", "parameters": [ { "name": "customerId", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "cursor", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "schema": { "example": 25, "type": "number" } } ], "responses": { "200": { "description": "A cursor-paginated page of the customer's payment routes.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "description": "The page of results, newest first.", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "counterpartyId": { "description": "The client account (counterparty) this route belongs to. For API callers this is always your own account id.", "type": "string", "minLength": 1 }, "customerId": { "type": "string", "minLength": 1 }, "direction": { "type": "string", "enum": [ "aud_to_stablecoin" ] }, "destination": { "type": "object", "properties": { "network": { "description": "The network the stablecoin is delivered on.", "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "address": { "description": "The destination crypto address the converted stablecoin is sent to.", "type": "string", "minLength": 1 }, "currency": { "description": "Which stablecoin to deliver.", "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "network", "address", "currency" ] }, "limits": { "type": "object", "properties": { "min": { "type": "string" }, "max": { "type": "string" }, "daily": { "type": "string" } } }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "instructions": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "reference": { "type": "string", "minLength": 1 }, "deposit": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "aud" ] }, "bsb": { "type": "string", "minLength": 1 }, "accountNumber": { "type": "string", "minLength": 1 }, "payId": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "type", "value" ] }, "reference": { "type": "string", "minLength": 1 } }, "required": [ "kind", "bsb", "accountNumber", "reference" ] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "crypto" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "address": { "type": "string", "minLength": 1 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "kind", "network", "address", "asset" ] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "crypto" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] }, "acceptedNetworks": { "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "address": { "type": "string", "minLength": 1 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "kind", "networkScope", "acceptedNetworks", "address", "asset" ] } ] }, "destinationSummary": { "type": "string", "minLength": 1 }, "limits": { "type": "object", "properties": { "min": { "type": "string" }, "max": { "type": "string" }, "daily": { "type": "string" } } }, "steps": { "type": "array", "items": { "type": "string" } } }, "required": [ "title", "reference", "deposit", "destinationSummary", "steps" ] }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "counterpartyId", "customerId", "direction", "destination", "status", "instructions", "createdAt" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "counterpartyId": { "description": "The client account (counterparty) this route belongs to. For API callers this is always your own account id.", "type": "string", "minLength": 1 }, "customerId": { "type": "string", "minLength": 1 }, "direction": { "type": "string", "enum": [ "stablecoin_to_aud" ] }, "destination": { "oneOf": [ { "type": "object", "properties": { "bankAccount": { "type": "object", "properties": { "accountHolderName": { "description": "Name on the destination AUD bank account.", "type": "string", "minLength": 1 }, "bsb": { "description": "The 6-digit BSB of the destination AUD bank account.", "type": "string", "minLength": 1 }, "accountNumber": { "description": "The destination AUD bank account number.", "type": "string", "minLength": 1 } }, "required": [ "accountHolderName", "bsb", "accountNumber" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "bankAccount", "asset", "network" ] }, { "type": "object", "properties": { "bankAccount": { "type": "object", "properties": { "accountHolderName": { "description": "Name on the destination AUD bank account.", "type": "string", "minLength": 1 }, "bsb": { "description": "The 6-digit BSB of the destination AUD bank account.", "type": "string", "minLength": 1 }, "accountNumber": { "description": "The destination AUD bank account number.", "type": "string", "minLength": 1 } }, "required": [ "accountHolderName", "bsb", "accountNumber" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] }, "acceptedNetworks": { "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } } }, "required": [ "bankAccount", "asset", "networkScope", "acceptedNetworks" ] }, { "type": "object", "properties": { "payId": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "type", "value" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "payId", "asset", "network" ] }, { "type": "object", "properties": { "payId": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "type", "value" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] }, "acceptedNetworks": { "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } } }, "required": [ "payId", "asset", "networkScope", "acceptedNetworks" ] } ] }, "limits": { "type": "object", "properties": { "min": { "type": "string" }, "max": { "type": "string" }, "daily": { "type": "string" } } }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "instructions": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "reference": { "type": "string", "minLength": 1 }, "deposit": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "aud" ] }, "bsb": { "type": "string", "minLength": 1 }, "accountNumber": { "type": "string", "minLength": 1 }, "payId": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "value": { "type": "string", "minLength": 1 } }, "required": [ "type", "value" ] }, "reference": { "type": "string", "minLength": 1 } }, "required": [ "kind", "bsb", "accountNumber", "reference" ] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "crypto" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "address": { "type": "string", "minLength": 1 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "kind", "network", "address", "asset" ] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "crypto" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] }, "acceptedNetworks": { "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "address": { "type": "string", "minLength": 1 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] } }, "required": [ "kind", "networkScope", "acceptedNetworks", "address", "asset" ] } ] }, "destinationSummary": { "type": "string", "minLength": 1 }, "limits": { "type": "object", "properties": { "min": { "type": "string" }, "max": { "type": "string" }, "daily": { "type": "string" } } }, "steps": { "type": "array", "items": { "type": "string" } } }, "required": [ "title", "reference", "deposit", "destinationSummary", "steps" ] }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "counterpartyId", "customerId", "direction", "destination", "status", "instructions", "createdAt" ] } ] } }, "hasMore": { "type": "boolean", "description": "Whether a further page exists after this one." }, "nextCursor": { "type": "string", "nullable": true, "description": "Opaque cursor to pass as `cursor` to fetch the next page, or null at the end." } }, "required": [ "data", "hasMore", "nextCursor" ] } } } }, "404": { "description": "No such customer for this account." } }, "summary": "List a customer’s payment routes", "tags": [ "Payment routes" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/payment-routes/list-customer-payment-routes", "metadata": { "title": "List a customer’s payment routes", "description": "Lists standing payment routes owned by one customer." }, "content": "## What this endpoint does\n\nLists standing payment routes owned by one customer.\n\n## When to use it\n\nUse it on customer detail pages or before deciding whether another route is needed.\n\n## Before you call\n\nAuthenticate with route read access and pass a customer ID owned by the same tenant account.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nRoute states indicate availability; individual funding and settlement states belong to transfers.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Payment routes](/console/payment-routes) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/payment-routes", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/treasury": { "get": { "operationId": "TreasuryController2_overview_v1", "parameters": [], "responses": { "200": { "description": "Tenant balances, funding instructions, and effective capabilities.", "content": { "application/json": { "schema": { "type": "object", "properties": { "clientId": { "type": "string", "minLength": 1 }, "balances": { "type": "array", "items": { "type": "object", "properties": { "clientId": { "type": "string", "minLength": 1 }, "asset": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "posted": { "description": "Wallet-ledger balance: available plus reserved. Pending inbound receipts are excluded.", "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "pending": { "description": "Gross amount received for detected or confirming inbound funding. Fees may not be final; this amount is not posted, reserved or spendable.", "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "reserved": { "description": "Posted wallet money durably reserved for accepted operations or funding holds.", "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "available": { "description": "Posted wallet money currently available to spend.", "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "asOf": { "type": "string", "format": "date-time" } }, "required": [ "clientId", "asset", "posted", "pending", "reserved", "available", "asOf" ] } }, "configurations": { "type": "array", "items": { "type": "object", "properties": { "limits": { "type": "object", "properties": { "rules": { "type": "array", "items": { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "funding", "payout", "stable_withdrawal", "conversion" ] }, "asset": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "perTransactionMinimum": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "perTransactionMaximum": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "dailyMaximum": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "maxCount": { "type": "integer", "minimum": 0, "exclusiveMinimum": true }, "windowSeconds": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } }, "required": [ "operation", "asset" ] }, "default": [] }, "beneficiaryDailyMaximum": { "type": "integer", "minimum": 0, "exclusiveMinimum": true }, "creditLimits": { "type": "array", "items": { "type": "object", "properties": { "asset": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" } }, "required": [ "asset", "amount" ] }, "default": [] } } }, "capabilities": { "type": "object", "properties": { "fundingEnabled": { "type": "boolean", "default": true }, "payoutsEnabled": { "type": "boolean", "default": true }, "stableWithdrawalsEnabled": { "type": "boolean", "default": true }, "conversionsEnabled": { "type": "boolean", "default": true }, "audInboundRails": { "type": "array", "items": { "type": "string", "enum": [ "bsb_account", "payid" ] }, "default": [ "bsb_account" ] }, "audOutboundRails": { "type": "array", "items": { "type": "string", "enum": [ "bsb_account", "payid" ] }, "default": [ "bsb_account" ] }, "assetNetworks": { "type": "array", "items": { "type": "object", "properties": { "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "asset", "network" ] }, "default": [] } } }, "returns": { "type": "object", "properties": { "lossAllocation": { "type": "string", "enum": [ "client", "wayex" ], "default": "client" }, "refundDeductedFee": { "type": "boolean", "default": false }, "holdbackBps": { "type": "integer", "minimum": 0, "exclusiveMinimum": false, "maximum": 10000, "exclusiveMaximum": false, "default": 0 }, "replenishment": { "type": "string", "enum": [ "required", "automatic_debit", "manual" ], "default": "required" }, "retryLimit": { "type": "integer", "minimum": 0, "exclusiveMinimum": false, "maximum": 20, "exclusiveMaximum": false, "default": 3 }, "timeoutSeconds": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "default": 300 }, "staleEventSeconds": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "default": 900 } } }, "accounting": { "type": "object", "properties": { "glMapping": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1 }, "default": {} }, "policyTemplate": { "type": "string", "minLength": 1, "default": "standard" }, "statementFrequency": { "type": "string", "enum": [ "daily", "weekly", "monthly" ], "default": "daily" }, "notifyOnReturn": { "type": "boolean", "default": true } } }, "recovery": { "type": "object", "properties": { "rtoMinutes": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "default": 60 }, "rpoMinutes": { "type": "integer", "minimum": 0, "exclusiveMinimum": false, "default": 5 }, "queueRecoveryMinutes": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "default": 15 }, "reconciliationStaleMinutes": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "default": 30 }, "accountingCloseHours": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "default": 24 } } }, "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "version": { "type": "integer", "minimum": 0, "exclusiveMinimum": true }, "effectiveAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "minLength": 1 }, "reason": { "type": "string", "minLength": 1, "maxLength": 500 }, "pricing": { "type": "object", "properties": { "fees": { "type": "array", "items": { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "funding", "payout", "stable_withdrawal", "conversion" ] }, "asset": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "percentBps": { "type": "integer", "minimum": 0, "exclusiveMinimum": false, "maximum": 10000, "exclusiveMaximum": false, "default": 0 }, "fixedAmount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$", "default": "0" }, "minimumAmount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "maximumAmount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "treatment": { "type": "string", "enum": [ "deduct" ], "default": "deduct" } }, "required": [ "operation", "asset" ] }, "default": [] } } }, "identity": { "type": "object", "properties": { "requireSumsubEvidence": { "type": "boolean", "default": false }, "sumsubLevelName": { "type": "string", "minLength": 1 }, "evidenceMaxAgeSeconds": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "default": 86400 }, "manualReviewThreshold": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" } } }, "settlement": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "automatic", "manual_review" ], "default": "automatic" }, "quoteTtlSeconds": { "type": "integer", "minimum": 5, "exclusiveMinimum": false, "maximum": 3600, "exclusiveMaximum": false, "default": 30 }, "maximumSlippageBps": { "type": "integer", "minimum": 0, "exclusiveMinimum": false, "maximum": 10000, "exclusiveMaximum": false, "default": 0 } } } }, "required": [ "limits", "capabilities", "returns", "accounting", "recovery", "id", "clientId", "version", "effectiveAt", "createdAt", "createdBy", "reason", "pricing", "identity", "settlement" ] } }, "fundingInstruments": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "providerReference": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deactivatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "aud_account" ] }, "asset": { "type": "string", "enum": [ "AUD" ] }, "accountName": { "type": "string", "minLength": 1 }, "bsb": { "type": "string", "pattern": "^\\d{6}$" }, "accountNumber": { "type": "string", "pattern": "^\\d{1,9}$" }, "payId": { "type": "string", "minLength": 1 }, "activationMessage": { "type": "string", "minLength": 1 } }, "required": [ "id", "clientId", "providerReference", "status", "createdAt", "updatedAt", "type", "asset", "accountName", "bsb", "accountNumber" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "providerReference": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deactivatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "stable_address" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "address": { "type": "string", "minLength": 1 }, "tag": { "type": "string", "minLength": 1 } }, "required": [ "id", "clientId", "providerReference", "status", "createdAt", "updatedAt", "type", "asset", "network", "address" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "providerReference": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deactivatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "stable_address" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] }, "acceptedNetworks": { "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "address": { "type": "string", "minLength": 1 }, "tag": { "type": "string", "minLength": 1 } }, "required": [ "id", "clientId", "providerReference", "status", "createdAt", "updatedAt", "type", "asset", "networkScope", "acceptedNetworks", "address" ] } ] } }, "fundingReceipts": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "fundingInstrumentId": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "detected", "confirming", "credited", "held", "returned" ] }, "gross": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "inboundFee": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "netCredit": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "providerReference": { "type": "string", "minLength": 1 }, "externalReference": { "type": "string", "minLength": 1 }, "downstreamReference": { "type": "string", "minLength": 1 }, "movementId": { "type": "string", "minLength": 1 }, "reason": { "type": "string", "minLength": 1 }, "nextAction": { "type": "string", "enum": [ "none", "wait_for_confirmation", "contact_support" ] }, "occurredAt": { "type": "string", "format": "date-time" }, "creditedAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "aud_payin" ] }, "asset": { "type": "string", "enum": [ "AUD" ] } }, "required": [ "id", "clientId", "fundingInstrumentId", "status", "gross", "inboundFee", "netCredit", "providerReference", "nextAction", "occurredAt", "updatedAt", "type", "asset" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "fundingInstrumentId": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "detected", "confirming", "credited", "held", "returned" ] }, "gross": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "inboundFee": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "netCredit": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "providerReference": { "type": "string", "minLength": 1 }, "externalReference": { "type": "string", "minLength": 1 }, "downstreamReference": { "type": "string", "minLength": 1 }, "movementId": { "type": "string", "minLength": 1 }, "reason": { "type": "string", "minLength": 1 }, "nextAction": { "type": "string", "enum": [ "none", "wait_for_confirmation", "contact_support" ] }, "occurredAt": { "type": "string", "format": "date-time" }, "creditedAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "stable_deposit" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "transactionHash": { "type": "string", "minLength": 1 }, "finalityReached": { "type": "boolean" } }, "required": [ "id", "clientId", "fundingInstrumentId", "status", "gross", "inboundFee", "netCredit", "providerReference", "nextAction", "occurredAt", "updatedAt", "type", "asset", "network", "finalityReached" ] } ] } }, "cryptoDestinations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "address": { "type": "string", "minLength": 1 }, "tag": { "type": "string", "minLength": 1 }, "externalReference": { "type": "string", "minLength": 1 }, "version": { "type": "integer", "minimum": 0, "exclusiveMinimum": true }, "validationStatus": { "type": "string", "enum": [ "validated" ] }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deactivatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "clientId", "name", "asset", "network", "address", "externalReference", "version", "validationStatus", "status", "createdAt", "updatedAt" ] } }, "recentMovements": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "asset": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "kind": { "type": "string", "enum": [ "funding_credited", "funding_returned", "admin_adjustment", "payout_reserved", "withdrawal_reserved", "conversion_reserved", "conversion_credited", "reservation_released", "reservation_captured", "late_execution_debited", "funding_hold_released", "payout_returned" ] }, "availableDelta": { "type": "string", "pattern": "^-?\\d+(\\.\\d+)?$" }, "reservedDelta": { "type": "string", "pattern": "^-?\\d+(\\.\\d+)?$" }, "reference": { "type": "string", "minLength": 1 }, "reason": { "type": "string", "minLength": 1 }, "occurredAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "clientId", "asset", "kind", "availableDelta", "reservedDelta", "reference", "occurredAt" ] } }, "runtimeCapabilities": { "type": "array", "items": { "type": "object", "properties": { "configurationId": { "type": "string", "minLength": 1 }, "assetNetworks": { "type": "array", "items": { "type": "object", "properties": { "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "asset", "network" ] } }, "audInboundRails": { "type": "array", "items": { "type": "string", "enum": [ "bsb_account", "payid" ] } }, "audOutboundRails": { "type": "array", "items": { "type": "string", "enum": [ "bsb_account", "payid" ] } } }, "required": [ "configurationId", "assetNetworks", "audInboundRails", "audOutboundRails" ] } } }, "required": [ "clientId", "balances", "configurations", "fundingInstruments", "fundingReceipts", "cryptoDestinations", "recentMovements", "runtimeCapabilities" ] } } } } }, "summary": "Get the Treasury overview", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "description": "Returns the tenant account’s Treasury summary, including wallet balances, funding setup, and effective capabilities. Use it to initialise a Treasury dashboard or confirm the account is ready before beginning a workflow.", "x-mint": { "href": "/api-reference/treasury/get-the-overview", "metadata": { "title": "Get the Treasury overview", "description": "Returns the tenant account’s Treasury summary, including wallet balances, funding setup, and effective capabilities." }, "content": "## What this endpoint does\n\nReturns the tenant account’s Treasury summary, including wallet balances, funding setup, and effective capabilities.\n\n## When to use it\n\nUse it to initialise a Treasury dashboard or confirm the account is ready before beginning a workflow.\n\n## Before you call\n\nAuthenticate with `treasury:read`. The API key is bound to one tenant account and cannot select or read another account.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nTreat balance timestamps and capability flags as point-in-time values. Read the specific resource before acting on changing state.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Treasury overview](/treasury/overview) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/overview", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/treasury/configurations/effective": { "get": { "operationId": "TreasuryController2_effectiveConfiguration_v1", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "limits": { "type": "object", "properties": { "rules": { "type": "array", "items": { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "funding", "payout", "stable_withdrawal", "conversion" ] }, "asset": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "perTransactionMinimum": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "perTransactionMaximum": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "dailyMaximum": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "maxCount": { "type": "integer", "minimum": 0, "exclusiveMinimum": true }, "windowSeconds": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } }, "required": [ "operation", "asset" ] }, "default": [] }, "beneficiaryDailyMaximum": { "type": "integer", "minimum": 0, "exclusiveMinimum": true }, "creditLimits": { "type": "array", "items": { "type": "object", "properties": { "asset": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" } }, "required": [ "asset", "amount" ] }, "default": [] } } }, "capabilities": { "type": "object", "properties": { "fundingEnabled": { "type": "boolean", "default": true }, "payoutsEnabled": { "type": "boolean", "default": true }, "stableWithdrawalsEnabled": { "type": "boolean", "default": true }, "conversionsEnabled": { "type": "boolean", "default": true }, "audInboundRails": { "type": "array", "items": { "type": "string", "enum": [ "bsb_account", "payid" ] }, "default": [ "bsb_account" ] }, "audOutboundRails": { "type": "array", "items": { "type": "string", "enum": [ "bsb_account", "payid" ] }, "default": [ "bsb_account" ] }, "assetNetworks": { "type": "array", "items": { "type": "object", "properties": { "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "asset", "network" ] }, "default": [] } } }, "returns": { "type": "object", "properties": { "lossAllocation": { "type": "string", "enum": [ "client", "wayex" ], "default": "client" }, "refundDeductedFee": { "type": "boolean", "default": false }, "holdbackBps": { "type": "integer", "minimum": 0, "exclusiveMinimum": false, "maximum": 10000, "exclusiveMaximum": false, "default": 0 }, "replenishment": { "type": "string", "enum": [ "required", "automatic_debit", "manual" ], "default": "required" }, "retryLimit": { "type": "integer", "minimum": 0, "exclusiveMinimum": false, "maximum": 20, "exclusiveMaximum": false, "default": 3 }, "timeoutSeconds": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "default": 300 }, "staleEventSeconds": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "default": 900 } } }, "accounting": { "type": "object", "properties": { "glMapping": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1 }, "default": {} }, "policyTemplate": { "type": "string", "minLength": 1, "default": "standard" }, "statementFrequency": { "type": "string", "enum": [ "daily", "weekly", "monthly" ], "default": "daily" }, "notifyOnReturn": { "type": "boolean", "default": true } } }, "recovery": { "type": "object", "properties": { "rtoMinutes": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "default": 60 }, "rpoMinutes": { "type": "integer", "minimum": 0, "exclusiveMinimum": false, "default": 5 }, "queueRecoveryMinutes": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "default": 15 }, "reconciliationStaleMinutes": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "default": 30 }, "accountingCloseHours": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "default": 24 } } }, "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "version": { "type": "integer", "minimum": 0, "exclusiveMinimum": true }, "effectiveAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "minLength": 1 }, "reason": { "type": "string", "minLength": 1, "maxLength": 500 }, "pricing": { "type": "object", "properties": { "fees": { "type": "array", "items": { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "funding", "payout", "stable_withdrawal", "conversion" ] }, "asset": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "percentBps": { "type": "integer", "minimum": 0, "exclusiveMinimum": false, "maximum": 10000, "exclusiveMaximum": false, "default": 0 }, "fixedAmount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$", "default": "0" }, "minimumAmount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "maximumAmount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "treatment": { "type": "string", "enum": [ "deduct" ], "default": "deduct" } }, "required": [ "operation", "asset" ] }, "default": [] } } }, "identity": { "type": "object", "properties": { "requireSumsubEvidence": { "type": "boolean", "default": false }, "sumsubLevelName": { "type": "string", "minLength": 1 }, "evidenceMaxAgeSeconds": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "default": 86400 }, "manualReviewThreshold": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" } } }, "settlement": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "automatic", "manual_review" ], "default": "automatic" }, "quoteTtlSeconds": { "type": "integer", "minimum": 5, "exclusiveMinimum": false, "maximum": 3600, "exclusiveMaximum": false, "default": 30 }, "maximumSlippageBps": { "type": "integer", "minimum": 0, "exclusiveMinimum": false, "maximum": 10000, "exclusiveMaximum": false, "default": 0 } } } }, "required": [ "limits", "capabilities", "returns", "accounting", "recovery", "id", "clientId", "version", "effectiveAt", "createdAt", "createdBy", "reason", "pricing", "identity", "settlement" ] } } } } }, "summary": "Get effective Treasury settings", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "description": "Returns the client-safe fees, limits, rails, networks, and evidence policy currently effective for this tenant account. Use it to explain availability, validate user input, and display the settings Wayex will enforce server-side.", "x-mint": { "href": "/api-reference/treasury/get-effective-settings", "metadata": { "title": "Get effective Treasury settings", "description": "Returns the client-safe fees, limits, rails, networks, and evidence policy currently effective for this tenant account." }, "content": "## What this endpoint does\n\nReturns the client-safe fees, limits, rails, networks, and evidence policy currently effective for this tenant account.\n\n## When to use it\n\nUse it to explain availability, validate user input, and display the settings Wayex will enforce server-side.\n\n## Before you call\n\nAuthenticate with `treasury:read`. The current tenant account is inferred from the API key; clients do not send an account selector.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nThe response is effective at read time. Every accepted operation records the configuration version used for its decision. Internal pricing-margin settings are never returned to client credentials.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Treasury overview](/treasury/overview) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/overview", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/treasury/settings": { "get": { "description": "Returns this tenant account’s writable payout preferences — currently the payout remitter default that controls whose name appears on AUD payouts. Read it before showing a payout settings screen, or to confirm the current default before submitting payouts that rely on it.", "operationId": "TreasuryController2_settings_v1", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "payoutRemitter": { "type": "string", "enum": [ "wayex", "tenant" ] }, "tenantRemitterName": { "type": "string", "minLength": 1 }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "payoutRemitter", "tenantRemitterName" ] } } } } }, "summary": "Get tenant treasury settings", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/treasury/get-tenant-settings", "metadata": { "title": "Get tenant treasury settings", "description": "Returns this tenant account’s writable payout preferences — currently the payout remitter default that controls whose name appears on AUD payouts." }, "content": "## What this endpoint does\n\nReturns this tenant account’s writable payout preferences — currently the payout remitter default that controls whose name appears on AUD payouts.\n\n## When to use it\n\nRead it before showing a payout settings screen, or to confirm the current default before submitting payouts that rely on it.\n\n## Before you call\n\nAuthenticate with `treasury:read`. The setting is bound to the tenant account inferred from the API key.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nThe response is the current default. Individual payouts may still override the remitter per request, so a payout’s recorded remitter can differ from this default.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Beneficiaries and payouts](/treasury/beneficiaries-and-payouts) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/beneficiaries-and-payouts", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } }, "put": { "description": "Sets the tenant-wide payout remitter default: `wayex` shows “Wayex” as the remitter on AUD payouts, while `tenant` shows your onboarded company name. The choice is constrained to those two values — it is never free text. Set it during onboarding, or whenever you want subsequent payouts to default to a different remitter. Each payout request can still override the default per payout.", "operationId": "TreasuryController2_updateSettings_v1", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique key for this logical action. Reuse the same key and identical payload when retrying after an unknown response.", "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "example": "13bda8d7-87bd-4fa4-b7d5-e740725f9bd2" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "payoutRemitter": { "type": "string", "enum": [ "wayex", "tenant" ] } }, "required": [ "payoutRemitter" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "payoutRemitter": { "type": "string", "enum": [ "wayex", "tenant" ] }, "tenantRemitterName": { "type": "string", "minLength": 1 }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "payoutRemitter", "tenantRemitterName" ] } } } } }, "summary": "Update tenant treasury settings", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/treasury/update-tenant-settings", "metadata": { "title": "Update tenant treasury settings", "description": "Sets the tenant-wide payout remitter default: `wayex` shows “Wayex” as the remitter on AUD payouts, while `tenant` shows your onboarded company name. The choice is constrained to those two values — it is never free text." }, "content": "## What this endpoint does\n\nSets the tenant-wide payout remitter default: `wayex` shows “Wayex” as the remitter on AUD payouts, while `tenant` shows your onboarded company name. The choice is constrained to those two values — it is never free text.\n\n## When to use it\n\nSet it during onboarding, or whenever you want subsequent payouts to default to a different remitter. Each payout request can still override the default per payout.\n\n## Before you call\n\nUse a secret API key with `treasury:write`. The onboarded company name used by the `tenant` option comes from your account profile and cannot be edited through this endpoint.\n\n## Money and balance effect\n\nThis changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.\n\n## States and completion\n\nThe new default applies to payouts created after it is set; it does not change the remitter recorded on payouts already submitted.\n\n## Safe retries\n\nSend a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out.\n\nRead [Beneficiaries and payouts](/treasury/beneficiaries-and-payouts) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/beneficiaries-and-payouts", "moneyEffect": "This changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.", "retry": "Send a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out." } } }, "/v1/treasury/balances": { "get": { "operationId": "TreasuryController2_balances_v1", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "clientId": { "type": "string", "minLength": 1 }, "asset": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "posted": { "description": "Wallet-ledger balance: available plus reserved. Pending inbound receipts are excluded.", "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "pending": { "description": "Gross amount received for detected or confirming inbound funding. Fees may not be final; this amount is not posted, reserved or spendable.", "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "reserved": { "description": "Posted wallet money durably reserved for accepted operations or funding holds.", "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "available": { "description": "Posted wallet money currently available to spend.", "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "asOf": { "type": "string", "format": "date-time" } }, "required": [ "clientId", "asset", "posted", "pending", "reserved", "available", "asOf" ] } } }, "required": [ "data" ] } } } } }, "summary": "List Treasury wallet balances", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "description": "Lists the isolated AUD and stablecoin wallet balances owned by this tenant account. Use it before previews and to display available, reserved, pending, and posted amounts with their `asOf` time (`posted` is available plus reserved; pending is excluded).", "x-mint": { "href": "/api-reference/treasury/list-balances", "metadata": { "title": "List Treasury wallet balances", "description": "Lists the isolated AUD and stablecoin wallet balances owned by this tenant account." }, "content": "## What this endpoint does\n\nLists the isolated AUD and stablecoin wallet balances owned by this tenant account.\n\n## When to use it\n\nUse it before previews and to display available, reserved, pending, and posted amounts with their `asOf` time (`posted` is available plus reserved; pending is excluded).\n\n## Before you call\n\nAuthenticate with `treasury:read`. A different tenant login or API key reads a different wallet and cannot net or spend this balance.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nOnly `available` is spendable. `reserved` backs accepted operations; `pending` is detected but not yet usable. Stale or unavailable balance data must not be treated as zero.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Funding and balances](/treasury/funding-and-balances) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/funding-and-balances", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/treasury/movements": { "get": { "operationId": "TreasuryController2_movements_v1", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "asset": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "kind": { "type": "string", "enum": [ "funding_credited", "funding_returned", "admin_adjustment", "payout_reserved", "withdrawal_reserved", "conversion_reserved", "conversion_credited", "reservation_released", "reservation_captured", "late_execution_debited", "funding_hold_released", "payout_returned" ] }, "availableDelta": { "type": "string", "pattern": "^-?\\d+(\\.\\d+)?$" }, "reservedDelta": { "type": "string", "pattern": "^-?\\d+(\\.\\d+)?$" }, "reference": { "type": "string", "minLength": 1 }, "reason": { "type": "string", "minLength": 1 }, "occurredAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "clientId", "asset", "kind", "availableDelta", "reservedDelta", "reference", "occurredAt" ] } } }, "required": [ "data" ] } } } } }, "summary": "List Treasury wallet movements", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "description": "Lists immutable wallet credits, debits, reservations, releases, returns, and adjustments for this tenant account. Fees never appear as separate movements: each operation’s reserved debit already includes its fee, and a pay-in is credited net of its inbound fee. Use it to reconcile balance changes and follow a payout, conversion, withdrawal, or funding reference into the wallet ledger.", "x-mint": { "href": "/api-reference/treasury/list-wallet-movements", "metadata": { "title": "List Treasury wallet movements", "description": "Lists immutable wallet credits, debits, reservations, releases, returns, and adjustments for this tenant account. Fees never appear as separate movements: each operation’s reserved debit already includes its fee, and a pay-in is credited net of its inbound fee." }, "content": "## What this endpoint does\n\nLists immutable wallet credits, debits, reservations, releases, returns, and adjustments for this tenant account. Fees never appear as separate movements: each operation’s reserved debit already includes its fee, and a pay-in is credited net of its inbound fee.\n\n## When to use it\n\nUse it to reconcile balance changes and follow a payout, conversion, withdrawal, or funding reference into the wallet ledger.\n\n## Before you call\n\nAuthenticate with an API key that can read this resource. Results are restricted to the tenant account bound to that key.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nMovements are financial facts, while operations have workflows. A movement does not by itself prove an external bank or blockchain leg settled.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Operations and reconciliation](/treasury/operations-and-reconciliation) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/operations-and-reconciliation", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/treasury/operations": { "get": { "description": "Returns a cursor-paginated view across this tenant account’s payouts, conversions, and stablecoin withdrawals. Use it to operate a queue, filter lifecycle states, or recover an operation by `externalReference` after a create response was lost.", "operationId": "TreasuryController2_operationReport_v1", "parameters": [ { "name": "limit", "required": false, "in": "query", "schema": { "example": 25, "type": "number" } }, { "name": "cursor", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "to", "required": false, "in": "query", "schema": { "format": "date-time", "type": "string" } }, { "name": "from", "required": false, "in": "query", "schema": { "format": "date-time", "type": "string" } }, { "name": "status", "required": false, "in": "query", "schema": { "enum": [ "accepted", "held", "submitted", "settled", "failed", "returned" ], "type": "string" } }, { "name": "kind", "required": false, "in": "query", "schema": { "enum": [ "payout", "stable_withdrawal", "conversion" ], "type": "string" } }, { "name": "externalReference", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "enum": [ "payout", "stable_withdrawal", "conversion" ] }, "status": { "type": "string", "enum": [ "accepted", "held", "submitted", "settled", "failed", "returned" ] }, "source": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "destination": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "fee": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "sourceDebit": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "configurationId": { "type": "string", "minLength": 1 }, "externalReference": { "type": "string", "minLength": 1 }, "providerReference": { "type": "string", "minLength": 1 }, "statusReason": { "type": "string", "minLength": 1 }, "reservation": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "reserved", "captured", "released" ] }, "amount": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] } }, "required": [ "status", "amount" ] }, "nextAction": { "type": "string", "enum": [ "none", "wait_for_settlement", "contact_support", "retry_new_request", "review_balance" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "clientId", "kind", "status", "source", "fee", "sourceDebit", "configurationId", "externalReference", "reservation", "nextAction", "createdAt", "updatedAt" ] } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": "string", "minLength": 1, "nullable": true } }, "required": [ "data", "hasMore", "nextCursor" ] } } } } }, "summary": "Search Treasury operations", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/treasury/search-operations", "metadata": { "title": "Search Treasury operations", "description": "Returns a cursor-paginated view across this tenant account’s payouts, conversions, and stablecoin withdrawals." }, "content": "## What this endpoint does\n\nReturns a cursor-paginated view across this tenant account’s payouts, conversions, and stablecoin withdrawals.\n\n## When to use it\n\nUse it to operate a queue, filter lifecycle states, or recover an operation by `externalReference` after a create response was lost.\n\n## Before you call\n\nAuthenticate with `treasury:read`. Filter by operation kind, status, external reference, or an ISO 8601 date range; cursors belong to the exact filtered result set.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nEach row reports the current operation state and next action. `accepted`, `held`, and `submitted` do not prove external settlement; open the resource detail before acting.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Operations and reconciliation](/treasury/operations-and-reconciliation) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/operations-and-reconciliation", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/treasury/transactions": { "get": { "description": "Returns cursor-paginated wallet movements enriched with their operation kind, operation state, and external reference when available. Use it for transaction history, balance reconciliation, and investigation without exposing beneficiary bank details or saved wallet addresses.", "operationId": "TreasuryController2_transactionReport_v1", "parameters": [ { "name": "limit", "required": false, "in": "query", "schema": { "example": 25, "type": "number" } }, { "name": "cursor", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "to", "required": false, "in": "query", "schema": { "format": "date-time", "type": "string" } }, { "name": "from", "required": false, "in": "query", "schema": { "format": "date-time", "type": "string" } }, { "name": "status", "required": false, "in": "query", "schema": { "enum": [ "accepted", "held", "submitted", "settled", "failed", "returned" ], "type": "string" } }, { "name": "kind", "required": false, "in": "query", "schema": { "enum": [ "funding_credited", "funding_returned", "admin_adjustment", "payout_reserved", "withdrawal_reserved", "conversion_reserved", "conversion_credited", "reservation_released", "reservation_captured", "late_execution_debited", "funding_hold_released", "payout_returned" ], "type": "string" } }, { "name": "externalReference", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "asset": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "kind": { "type": "string", "enum": [ "funding_credited", "funding_returned", "admin_adjustment", "payout_reserved", "withdrawal_reserved", "conversion_reserved", "conversion_credited", "reservation_released", "reservation_captured", "late_execution_debited", "funding_hold_released", "payout_returned" ] }, "availableDelta": { "type": "string", "pattern": "^-?\\d+(\\.\\d+)?$" }, "reservedDelta": { "type": "string", "pattern": "^-?\\d+(\\.\\d+)?$" }, "reference": { "type": "string", "minLength": 1 }, "reason": { "type": "string", "minLength": 1 }, "occurredAt": { "type": "string", "format": "date-time" }, "externalReference": { "type": "string", "minLength": 1 }, "operationId": { "type": "string", "minLength": 1 }, "operationKind": { "type": "string", "enum": [ "payout", "stable_withdrawal", "conversion" ] }, "operationStatus": { "type": "string", "enum": [ "accepted", "held", "submitted", "settled", "failed", "returned" ] } }, "required": [ "id", "clientId", "asset", "kind", "availableDelta", "reservedDelta", "reference", "occurredAt", "externalReference" ] } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": "string", "minLength": 1, "nullable": true } }, "required": [ "data", "hasMore", "nextCursor" ] } } } } }, "summary": "Search Treasury transactions", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/treasury/search-transactions", "metadata": { "title": "Search Treasury transactions", "description": "Returns cursor-paginated wallet movements enriched with their operation kind, operation state, and external reference when available." }, "content": "## What this endpoint does\n\nReturns cursor-paginated wallet movements enriched with their operation kind, operation state, and external reference when available.\n\n## When to use it\n\nUse it for transaction history, balance reconciliation, and investigation without exposing beneficiary bank details or saved wallet addresses.\n\n## Before you call\n\nAuthenticate with `treasury:read`. Filter by movement kind, operation status, external reference, or an ISO 8601 date range; pass `nextCursor` unchanged to read the next page.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nA transaction is an immutable wallet effect, while its linked operation can still be in progress. Reconcile the movement and operation state together.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Operations and reconciliation](/treasury/operations-and-reconciliation) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/operations-and-reconciliation", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/treasury/transactions/export": { "get": { "description": "Exports the same tenant-scoped, non-PII transaction view as a CSV file for reconciliation and finance workflows. Use it for a bounded accounting export after selecting an external reference, movement kind, operation status, or date range.", "operationId": "TreasuryController2_exportTransactions_v1", "parameters": [ { "name": "limit", "required": false, "in": "query", "schema": { "example": 5000, "type": "number" } }, { "name": "to", "required": false, "in": "query", "schema": { "format": "date-time", "type": "string" } }, { "name": "from", "required": false, "in": "query", "schema": { "format": "date-time", "type": "string" } }, { "name": "status", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "kind", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "externalReference", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A complete CSV for the selected bounded result set.", "content": { "text/csv": { "schema": { "type": "string" } } } } }, "summary": "Export Treasury transactions", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/treasury/export-transactions", "metadata": { "title": "Export Treasury transactions", "description": "Exports the same tenant-scoped, non-PII transaction view as a CSV file for reconciliation and finance workflows." }, "content": "## What this endpoint does\n\nExports the same tenant-scoped, non-PII transaction view as a CSV file for reconciliation and finance workflows.\n\n## When to use it\n\nUse it for a bounded accounting export after selecting an external reference, movement kind, operation status, or date range.\n\n## Before you call\n\nAuthenticate with `treasury:read`. The export supports up to 5,000 rows; if the selected result is larger, narrow the filters and request another export.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nThe file is a point-in-time transaction snapshot. A linked operation may still be accepted, held, or submitted, so CSV presence is not proof of external settlement.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Operations and reconciliation](/treasury/operations-and-reconciliation) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/operations-and-reconciliation", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/treasury/funding-instruments": { "get": { "operationId": "TreasuryController2_fundingInstruments_v1", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "providerReference": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deactivatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "aud_account" ] }, "asset": { "type": "string", "enum": [ "AUD" ] }, "accountName": { "type": "string", "minLength": 1 }, "bsb": { "type": "string", "pattern": "^\\d{6}$" }, "accountNumber": { "type": "string", "pattern": "^\\d{1,9}$" }, "payId": { "type": "string", "minLength": 1 }, "activationMessage": { "type": "string", "minLength": 1 } }, "required": [ "id", "clientId", "providerReference", "status", "createdAt", "updatedAt", "type", "asset", "accountName", "bsb", "accountNumber" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "providerReference": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deactivatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "stable_address" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "address": { "type": "string", "minLength": 1 }, "tag": { "type": "string", "minLength": 1 } }, "required": [ "id", "clientId", "providerReference", "status", "createdAt", "updatedAt", "type", "asset", "network", "address" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "providerReference": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deactivatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "stable_address" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] }, "acceptedNetworks": { "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "address": { "type": "string", "minLength": 1 }, "tag": { "type": "string", "minLength": 1 } }, "required": [ "id", "clientId", "providerReference", "status", "createdAt", "updatedAt", "type", "asset", "networkScope", "acceptedNetworks", "address" ] } ] } } }, "required": [ "data" ] } } } } }, "summary": "List Treasury funding instructions", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "description": "Lists reusable AUD funding instructions — a BSB and account number, plus any issued `payId` — and stablecoin deposit addresses issued to this tenant account. Use it when displaying where to send funds, or when verifying the asset and network before a deposit.", "x-mint": { "href": "/api-reference/treasury/list-funding-instruments", "metadata": { "title": "List Treasury funding instructions", "description": "Lists reusable AUD funding instructions — a BSB and account number, plus any issued `payId` — and stablecoin deposit addresses issued to this tenant account." }, "content": "## What this endpoint does\n\nLists reusable AUD funding instructions — a BSB and account number, plus any issued `payId` — and stablecoin deposit addresses issued to this tenant account.\n\n## When to use it\n\nUse it when displaying where to send funds, or when verifying the asset and network before a deposit.\n\n## Before you call\n\nAuthenticate with an API key that can read this resource. Results are restricted to the tenant account bound to that key.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nAn active instrument can receive funds. A newly issued AUD account or PayID can take a few minutes to activate for NPP; honour any `activationMessage` before relying on the PayID. The instrument is not a deposit record and does not prove funds arrived or became available.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Funding and balances](/treasury/funding-and-balances) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/funding-and-balances", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } }, "post": { "operationId": "TreasuryController2_createFundingInstrument_v1", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique key for this logical action. Reuse the same key and identical payload when retrying after an unknown response.", "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "example": "13bda8d7-87bd-4fa4-b7d5-e740725f9bd2" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "aud_account" ] }, "accountName": { "type": "string", "minLength": 1 }, "includePayId": { "type": "boolean", "default": true } }, "required": [ "type", "accountName" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "stable_address" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "type", "asset", "network" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "stable_address" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] } }, "required": [ "type", "asset", "networkScope" ] } ] } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "providerReference": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deactivatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "aud_account" ] }, "asset": { "type": "string", "enum": [ "AUD" ] }, "accountName": { "type": "string", "minLength": 1 }, "bsb": { "type": "string", "pattern": "^\\d{6}$" }, "accountNumber": { "type": "string", "pattern": "^\\d{1,9}$" }, "payId": { "type": "string", "minLength": 1 }, "activationMessage": { "type": "string", "minLength": 1 } }, "required": [ "id", "clientId", "providerReference", "status", "createdAt", "updatedAt", "type", "asset", "accountName", "bsb", "accountNumber" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "providerReference": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deactivatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "stable_address" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "address": { "type": "string", "minLength": 1 }, "tag": { "type": "string", "minLength": 1 } }, "required": [ "id", "clientId", "providerReference", "status", "createdAt", "updatedAt", "type", "asset", "network", "address" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "providerReference": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deactivatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "stable_address" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] }, "acceptedNetworks": { "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "address": { "type": "string", "minLength": 1 }, "tag": { "type": "string", "minLength": 1 } }, "required": [ "id", "clientId", "providerReference", "status", "createdAt", "updatedAt", "type", "asset", "networkScope", "acceptedNetworks", "address" ] } ] } } } } }, "summary": "Create Treasury funding instructions", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "description": "Provisions reusable AUD funding instructions or a stablecoin deposit address for this tenant account. An AUD instrument returns a BSB and account number and, by default, an email `payId` to pay into as well — set `includePayId` to false to skip the PayID. Create one when the account does not already have suitable instructions for the required asset, rail, or network.", "x-mint": { "href": "/api-reference/treasury/create-a-funding-instrument", "metadata": { "title": "Create Treasury funding instructions", "description": "Provisions reusable AUD funding instructions or a stablecoin deposit address for this tenant account. An AUD instrument returns a BSB and account number and, by default, an email `payId` to pay into as well — set `includePayId` to false to skip the PayID." }, "content": "## What this endpoint does\n\nProvisions reusable AUD funding instructions or a stablecoin deposit address for this tenant account. An AUD instrument returns a BSB and account number and, by default, an email `payId` to pay into as well — set `includePayId` to false to skip the PayID.\n\n## When to use it\n\nCreate one when the account does not already have suitable instructions for the required asset, rail, or network.\n\n## Before you call\n\nUse a secret API key with `treasury:write`. The requested rail, asset, and network must be enabled for this tenant account. `includePayId` applies to AUD instruments only and defaults to true.\n\n## Money and balance effect\n\nProvisioning instructions does not credit the wallet. The balance changes only after Wayex detects, validates, and credits incoming funds.\n\n## States and completion\n\nCreation confirms the instrument was issued. A newly issued AUD account or PayID can take a few minutes to become active for NPP; when the response carries an `activationMessage`, show it and wait for activation before relying on the PayID. Track incoming funds separately and wait for the wallet credit before spending them.\n\n## Safe retries\n\nSend a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out.\n\nRead [Funding and balances](/treasury/funding-and-balances) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/funding-and-balances", "moneyEffect": "Provisioning instructions does not credit the wallet. The balance changes only after Wayex detects, validates, and credits incoming funds.", "retry": "Send a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out." } } }, "/v1/treasury/funding-instruments/{id}": { "get": { "description": "Returns one reusable AUD or stablecoin funding instrument owned by this tenant account. An AUD instrument shows its BSB and account number and any issued `payId`. Use it to display the exact current instructions or inspect an instrument followed from an incoming pay-in or deposit.", "operationId": "TreasuryController2_fundingInstrument_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "providerReference": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deactivatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "aud_account" ] }, "asset": { "type": "string", "enum": [ "AUD" ] }, "accountName": { "type": "string", "minLength": 1 }, "bsb": { "type": "string", "pattern": "^\\d{6}$" }, "accountNumber": { "type": "string", "pattern": "^\\d{1,9}$" }, "payId": { "type": "string", "minLength": 1 }, "activationMessage": { "type": "string", "minLength": 1 } }, "required": [ "id", "clientId", "providerReference", "status", "createdAt", "updatedAt", "type", "asset", "accountName", "bsb", "accountNumber" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "providerReference": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deactivatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "stable_address" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "address": { "type": "string", "minLength": 1 }, "tag": { "type": "string", "minLength": 1 } }, "required": [ "id", "clientId", "providerReference", "status", "createdAt", "updatedAt", "type", "asset", "network", "address" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "providerReference": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deactivatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "stable_address" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] }, "acceptedNetworks": { "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "address": { "type": "string", "minLength": 1 }, "tag": { "type": "string", "minLength": 1 } }, "required": [ "id", "clientId", "providerReference", "status", "createdAt", "updatedAt", "type", "asset", "networkScope", "acceptedNetworks", "address" ] } ] } } } } }, "summary": "Get Treasury funding instructions", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/treasury/get-a-funding-instrument", "metadata": { "title": "Get Treasury funding instructions", "description": "Returns one reusable AUD or stablecoin funding instrument owned by this tenant account. An AUD instrument shows its BSB and account number and any issued `payId`." }, "content": "## What this endpoint does\n\nReturns one reusable AUD or stablecoin funding instrument owned by this tenant account. An AUD instrument shows its BSB and account number and any issued `payId`.\n\n## When to use it\n\nUse it to display the exact current instructions or inspect an instrument followed from an incoming pay-in or deposit.\n\n## Before you call\n\nAuthenticate with `treasury:read` and pass a funding-instrument ID owned by the same tenant account.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nAn active instrument can receive funds. A newly issued AUD account or PayID can take a few minutes to activate for NPP; honour any `activationMessage` before relying on the PayID. An inactive instrument remains readable for history but must not be shared for new funding.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Funding and balances](/treasury/funding-and-balances) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/funding-and-balances", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/treasury/funding-instruments/{id}/deactivate": { "post": { "description": "Deactivates a reusable funding instrument without deleting its historical funding links. Use it when instructions must no longer be shown or used for new funding.", "operationId": "TreasuryController2_deactivateFundingInstrument_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique key for this logical action. Reuse the same key and identical payload when retrying after an unknown response.", "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "example": "13bda8d7-87bd-4fa4-b7d5-e740725f9bd2" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "providerReference": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deactivatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "aud_account" ] }, "asset": { "type": "string", "enum": [ "AUD" ] }, "accountName": { "type": "string", "minLength": 1 }, "bsb": { "type": "string", "pattern": "^\\d{6}$" }, "accountNumber": { "type": "string", "pattern": "^\\d{1,9}$" }, "payId": { "type": "string", "minLength": 1 }, "activationMessage": { "type": "string", "minLength": 1 } }, "required": [ "id", "clientId", "providerReference", "status", "createdAt", "updatedAt", "type", "asset", "accountName", "bsb", "accountNumber" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "providerReference": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deactivatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "stable_address" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "address": { "type": "string", "minLength": 1 }, "tag": { "type": "string", "minLength": 1 } }, "required": [ "id", "clientId", "providerReference", "status", "createdAt", "updatedAt", "type", "asset", "network", "address" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "providerReference": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deactivatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "stable_address" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "networkScope": { "type": "string", "enum": [ "evm" ] }, "acceptedNetworks": { "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "address": { "type": "string", "minLength": 1 }, "tag": { "type": "string", "minLength": 1 } }, "required": [ "id", "clientId", "providerReference", "status", "createdAt", "updatedAt", "type", "asset", "networkScope", "acceptedNetworks", "address" ] } ] } } } } }, "summary": "Deactivate Treasury funding instructions", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/treasury/deactivate-a-funding-instrument", "metadata": { "title": "Deactivate Treasury funding instructions", "description": "Deactivates a reusable funding instrument without deleting its historical funding links." }, "content": "## What this endpoint does\n\nDeactivates a reusable funding instrument without deleting its historical funding links.\n\n## When to use it\n\nUse it when instructions must no longer be shown or used for new funding.\n\n## Before you call\n\nUse a secret API key with `treasury:write` and pass an active funding-instrument ID owned by this tenant account.\n\n## Money and balance effect\n\nThis changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.\n\n## States and completion\n\nDeactivation prevents normal new use but does not erase incoming funding or wallet movements already linked to the instrument.\n\n## Safe retries\n\nSend a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out.\n\nRead [Funding and balances](/treasury/funding-and-balances) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/funding-and-balances", "moneyEffect": "This changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.", "retry": "Send a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out." } } }, "/v1/treasury/payins": { "get": { "description": "Lists provider-created incoming AUD payments observed on this tenant account’s funding instructions. Use it to monitor incoming AUD activity and reconcile each pay-in to its funding instrument, source references, and wallet movement.", "operationId": "TreasuryController2_payins_v1", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "fundingInstrumentId": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "detected", "confirming", "credited", "held", "returned" ] }, "gross": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "inboundFee": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "netCredit": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "providerReference": { "type": "string", "minLength": 1 }, "externalReference": { "type": "string", "minLength": 1 }, "downstreamReference": { "type": "string", "minLength": 1 }, "movementId": { "type": "string", "minLength": 1 }, "reason": { "type": "string", "minLength": 1 }, "nextAction": { "type": "string", "enum": [ "none", "wait_for_confirmation", "contact_support" ] }, "occurredAt": { "type": "string", "format": "date-time" }, "creditedAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "aud_payin" ] }, "asset": { "type": "string", "enum": [ "AUD" ] } }, "required": [ "id", "clientId", "fundingInstrumentId", "status", "gross", "inboundFee", "netCredit", "providerReference", "nextAction", "occurredAt", "updatedAt", "type", "asset" ] } } }, "required": [ "data" ] } } } } }, "summary": "List incoming AUD pay-ins", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/treasury/list-aud-payins", "metadata": { "title": "List incoming AUD pay-ins", "description": "Lists provider-created incoming AUD payments observed on this tenant account’s funding instructions." }, "content": "## What this endpoint does\n\nLists provider-created incoming AUD payments observed on this tenant account’s funding instructions.\n\n## When to use it\n\nUse it to monitor incoming AUD activity and reconcile each pay-in to its funding instrument, source references, and wallet movement.\n\n## Before you call\n\nAuthenticate with an API key that can read this resource. Results are restricted to the tenant account bound to that key.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nDetected and confirming funds are not spendable. A credited record links gross amount, inbound fee, net credit, and the wallet movement; held and returned remain explicit.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Funding and balances](/treasury/funding-and-balances) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/funding-and-balances", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/treasury/payins/{id}": { "get": { "operationId": "TreasuryController2_payin_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "fundingInstrumentId": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "detected", "confirming", "credited", "held", "returned" ] }, "gross": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "inboundFee": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "netCredit": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "providerReference": { "type": "string", "minLength": 1 }, "externalReference": { "type": "string", "minLength": 1 }, "downstreamReference": { "type": "string", "minLength": 1 }, "movementId": { "type": "string", "minLength": 1 }, "reason": { "type": "string", "minLength": 1 }, "nextAction": { "type": "string", "enum": [ "none", "wait_for_confirmation", "contact_support" ] }, "occurredAt": { "type": "string", "format": "date-time" }, "creditedAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "aud_payin" ] }, "asset": { "type": "string", "enum": [ "AUD" ] } }, "required": [ "id", "clientId", "fundingInstrumentId", "status", "gross", "inboundFee", "netCredit", "providerReference", "nextAction", "occurredAt", "updatedAt", "type", "asset" ] } } } } }, "summary": "Get an incoming AUD pay-in", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "description": "Returns one provider-created AUD pay-in with amounts, source references, status, reason, next action, and linked wallet movement. Use it after a pay-in webhook, during reconciliation, or when a detected payment has not become available.", "x-mint": { "href": "/api-reference/treasury/get-an-aud-payin", "metadata": { "title": "Get an incoming AUD pay-in", "description": "Returns one provider-created AUD pay-in with amounts, source references, status, reason, next action, and linked wallet movement." }, "content": "## What this endpoint does\n\nReturns one provider-created AUD pay-in with amounts, source references, status, reason, next action, and linked wallet movement.\n\n## When to use it\n\nUse it after a pay-in webhook, during reconciliation, or when a detected payment has not become available.\n\n## Before you call\n\nAuthenticate with `treasury:read` and pass a pay-in ID owned by the same tenant account.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nFollow detected, confirming, credited, held, and returned. Only credited net funds represented in the available balance can be spent.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Funding and balances](/treasury/funding-and-balances) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/funding-and-balances", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/treasury/deposits": { "get": { "description": "Lists provider-created stablecoin deposits observed on this tenant account’s issued addresses. Use it to monitor incoming stablecoin activity and reconcile each deposit to its address, transaction reference, finality, and wallet movement.", "operationId": "TreasuryController2_deposits_v1", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "fundingInstrumentId": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "detected", "confirming", "credited", "held", "returned" ] }, "gross": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "inboundFee": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "netCredit": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "providerReference": { "type": "string", "minLength": 1 }, "externalReference": { "type": "string", "minLength": 1 }, "downstreamReference": { "type": "string", "minLength": 1 }, "movementId": { "type": "string", "minLength": 1 }, "reason": { "type": "string", "minLength": 1 }, "nextAction": { "type": "string", "enum": [ "none", "wait_for_confirmation", "contact_support" ] }, "occurredAt": { "type": "string", "format": "date-time" }, "creditedAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "stable_deposit" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "transactionHash": { "type": "string", "minLength": 1 }, "finalityReached": { "type": "boolean" } }, "required": [ "id", "clientId", "fundingInstrumentId", "status", "gross", "inboundFee", "netCredit", "providerReference", "nextAction", "occurredAt", "updatedAt", "type", "asset", "network", "finalityReached" ] } } }, "required": [ "data" ] } } } } }, "summary": "List incoming stablecoin deposits", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/treasury/list-stablecoin-deposits", "metadata": { "title": "List incoming stablecoin deposits", "description": "Lists provider-created stablecoin deposits observed on this tenant account’s issued addresses." }, "content": "## What this endpoint does\n\nLists provider-created stablecoin deposits observed on this tenant account’s issued addresses.\n\n## When to use it\n\nUse it to monitor incoming stablecoin activity and reconcile each deposit to its address, transaction reference, finality, and wallet movement.\n\n## Before you call\n\nAuthenticate with an API key that can read this resource. Results are restricted to the tenant account bound to that key.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nDetected and confirming deposits are not spendable. Wayex credits the net amount only after required finality and screening; held and returned remain explicit.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Funding and balances](/treasury/funding-and-balances) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/funding-and-balances", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/treasury/deposits/{id}": { "get": { "operationId": "TreasuryController2_deposit_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "fundingInstrumentId": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "detected", "confirming", "credited", "held", "returned" ] }, "gross": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "inboundFee": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "netCredit": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "providerReference": { "type": "string", "minLength": 1 }, "externalReference": { "type": "string", "minLength": 1 }, "downstreamReference": { "type": "string", "minLength": 1 }, "movementId": { "type": "string", "minLength": 1 }, "reason": { "type": "string", "minLength": 1 }, "nextAction": { "type": "string", "enum": [ "none", "wait_for_confirmation", "contact_support" ] }, "occurredAt": { "type": "string", "format": "date-time" }, "creditedAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "stable_deposit" ] }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "transactionHash": { "type": "string", "minLength": 1 }, "finalityReached": { "type": "boolean" } }, "required": [ "id", "clientId", "fundingInstrumentId", "status", "gross", "inboundFee", "netCredit", "providerReference", "nextAction", "occurredAt", "updatedAt", "type", "asset", "network", "finalityReached" ] } } } } }, "summary": "Get an incoming stablecoin deposit", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "description": "Returns one provider-created stablecoin deposit with asset/network, transaction reference, finality, amounts, status, next action, and linked wallet movement. Use it after a deposit webhook, during blockchain reconciliation, or when a detected transaction has not become available.", "x-mint": { "href": "/api-reference/treasury/get-a-stablecoin-deposit", "metadata": { "title": "Get an incoming stablecoin deposit", "description": "Returns one provider-created stablecoin deposit with asset/network, transaction reference, finality, amounts, status, next action, and linked wallet movement." }, "content": "## What this endpoint does\n\nReturns one provider-created stablecoin deposit with asset/network, transaction reference, finality, amounts, status, next action, and linked wallet movement.\n\n## When to use it\n\nUse it after a deposit webhook, during blockchain reconciliation, or when a detected transaction has not become available.\n\n## Before you call\n\nAuthenticate with `treasury:read` and pass a deposit ID owned by the same tenant account.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nFollow detected, confirming, credited, held, and returned. A transaction hash is not enough: only a credited deposit with finality can increase spendable balance.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Funding and balances](/treasury/funding-and-balances) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/funding-and-balances", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/treasury/beneficiaries": { "get": { "operationId": "TreasuryController2_beneficiaries_v1", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "externalReference": { "description": "Your own reference for this beneficiary, echoed back for correlation. Wayex generates one when you do not supply it at creation.", "type": "string", "minLength": 1 }, "destination": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "payid" ] }, "payId": { "type": "string", "minLength": 1 }, "payIdType": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "accountName": { "type": "string", "minLength": 2 } }, "required": [ "type", "payId", "payIdType", "accountName" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bank_account" ] }, "bsb": { "type": "string", "pattern": "^\\d{6}$" }, "accountNumber": { "type": "string", "pattern": "^\\d{1,9}$" }, "accountName": { "type": "string", "minLength": 2 } }, "required": [ "type", "bsb", "accountNumber", "accountName" ] } ] }, "partyContext": { "description": "Optional free-form key/value metadata about the beneficiary party (e.g. your internal tags or travel-rule party context). Stored and returned; Wayex does not interpret the keys.", "type": "object", "additionalProperties": { "type": "string" } }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deactivatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "individual" ] }, "firstName": { "type": "string", "minLength": 1 }, "lastName": { "type": "string", "minLength": 1 }, "dateOfBirth": { "type": "string" }, "address": { "type": "string", "minLength": 1 } }, "required": [ "id", "clientId", "externalReference", "destination", "status", "createdAt", "updatedAt", "type", "firstName", "lastName", "dateOfBirth", "address" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "externalReference": { "description": "Your own reference for this beneficiary, echoed back for correlation. Wayex generates one when you do not supply it at creation.", "type": "string", "minLength": 1 }, "destination": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "payid" ] }, "payId": { "type": "string", "minLength": 1 }, "payIdType": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "accountName": { "type": "string", "minLength": 2 } }, "required": [ "type", "payId", "payIdType", "accountName" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bank_account" ] }, "bsb": { "type": "string", "pattern": "^\\d{6}$" }, "accountNumber": { "type": "string", "pattern": "^\\d{1,9}$" }, "accountName": { "type": "string", "minLength": 2 } }, "required": [ "type", "bsb", "accountNumber", "accountName" ] } ] }, "partyContext": { "description": "Optional free-form key/value metadata about the beneficiary party (e.g. your internal tags or travel-rule party context). Stored and returned; Wayex does not interpret the keys.", "type": "object", "additionalProperties": { "type": "string" } }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deactivatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "business" ] }, "businessName": { "type": "string", "minLength": 1 }, "businessIdentity": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "id", "clientId", "externalReference", "destination", "status", "createdAt", "updatedAt", "type", "businessName" ] } ] } } }, "required": [ "data" ] } } } } }, "summary": "List Treasury beneficiaries", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "description": "Lists reusable individual and business recipients that this tenant account can pay in AUD. Use it to select a recipient for a payout and confirm its BSB/account details and status.", "x-mint": { "href": "/api-reference/treasury/list-beneficiaries", "metadata": { "title": "List Treasury beneficiaries", "description": "Lists reusable individual and business recipients that this tenant account can pay in AUD." }, "content": "## What this endpoint does\n\nLists reusable individual and business recipients that this tenant account can pay in AUD.\n\n## When to use it\n\nUse it to select a recipient for a payout and confirm its BSB/account details and status.\n\n## Before you call\n\nAuthenticate with an API key that can read this resource. Results are restricted to the tenant account bound to that key.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nOnly an eligible active beneficiary can be used. Identity or screening state may require evidence or review before payout submission.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Beneficiaries and payouts](/treasury/beneficiaries-and-payouts) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/beneficiaries-and-payouts", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } }, "post": { "operationId": "TreasuryController2_createBeneficiary_v1", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique key for this logical action. Reuse the same key and identical payload when retrying after an unknown response.", "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "example": "13bda8d7-87bd-4fa4-b7d5-e740725f9bd2" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "destination": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "payid" ] }, "payId": { "type": "string", "minLength": 1 }, "payIdType": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "accountName": { "type": "string", "minLength": 2 } }, "required": [ "type", "payId", "payIdType", "accountName" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bank_account" ] }, "bsb": { "type": "string", "pattern": "^\\d{6}$" }, "accountNumber": { "type": "string", "pattern": "^\\d{1,9}$" }, "accountName": { "type": "string", "minLength": 2 } }, "required": [ "type", "bsb", "accountNumber", "accountName" ] } ] }, "partyContext": { "description": "Optional free-form key/value metadata about the beneficiary party (e.g. your internal tags or travel-rule party context). Stored and returned; Wayex does not interpret the keys.", "type": "object", "additionalProperties": { "type": "string" } }, "type": { "type": "string", "enum": [ "individual" ] }, "firstName": { "type": "string", "minLength": 1 }, "lastName": { "type": "string", "minLength": 1 }, "dateOfBirth": { "type": "string" }, "address": { "type": "string", "minLength": 1 }, "externalReference": { "type": "string", "minLength": 1, "maxLength": 512 }, "sumsub": { "type": "object", "properties": { "shareToken": { "type": "string", "minLength": 1, "maxLength": 1024 }, "externalReference": { "description": "Optional. Your own reference for this beneficiary, echoed back for correlation. Wayex generates one when omitted.", "type": "string", "minLength": 1, "maxLength": 512 }, "levelName": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [ "shareToken" ] } }, "required": [ "destination", "type", "firstName", "lastName", "dateOfBirth", "address" ] }, { "type": "object", "properties": { "destination": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "payid" ] }, "payId": { "type": "string", "minLength": 1 }, "payIdType": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "accountName": { "type": "string", "minLength": 2 } }, "required": [ "type", "payId", "payIdType", "accountName" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bank_account" ] }, "bsb": { "type": "string", "pattern": "^\\d{6}$" }, "accountNumber": { "type": "string", "pattern": "^\\d{1,9}$" }, "accountName": { "type": "string", "minLength": 2 } }, "required": [ "type", "bsb", "accountNumber", "accountName" ] } ] }, "partyContext": { "description": "Optional free-form key/value metadata about the beneficiary party (e.g. your internal tags or travel-rule party context). Stored and returned; Wayex does not interpret the keys.", "type": "object", "additionalProperties": { "type": "string" } }, "type": { "type": "string", "enum": [ "business" ] }, "businessName": { "type": "string", "minLength": 1 }, "businessIdentity": { "type": "object", "additionalProperties": { "type": "string" } }, "externalReference": { "type": "string", "minLength": 1, "maxLength": 512 }, "sumsub": { "type": "object", "properties": { "shareToken": { "type": "string", "minLength": 1, "maxLength": 1024 }, "externalReference": { "description": "Optional. Your own reference for this beneficiary, echoed back for correlation. Wayex generates one when omitted.", "type": "string", "minLength": 1, "maxLength": 512 }, "levelName": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [ "shareToken" ] } }, "required": [ "destination", "type", "businessName" ] } ] } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "externalReference": { "description": "Your own reference for this beneficiary, echoed back for correlation. Wayex generates one when you do not supply it at creation.", "type": "string", "minLength": 1 }, "destination": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "payid" ] }, "payId": { "type": "string", "minLength": 1 }, "payIdType": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "accountName": { "type": "string", "minLength": 2 } }, "required": [ "type", "payId", "payIdType", "accountName" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bank_account" ] }, "bsb": { "type": "string", "pattern": "^\\d{6}$" }, "accountNumber": { "type": "string", "pattern": "^\\d{1,9}$" }, "accountName": { "type": "string", "minLength": 2 } }, "required": [ "type", "bsb", "accountNumber", "accountName" ] } ] }, "partyContext": { "description": "Optional free-form key/value metadata about the beneficiary party (e.g. your internal tags or travel-rule party context). Stored and returned; Wayex does not interpret the keys.", "type": "object", "additionalProperties": { "type": "string" } }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deactivatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "individual" ] }, "firstName": { "type": "string", "minLength": 1 }, "lastName": { "type": "string", "minLength": 1 }, "dateOfBirth": { "type": "string" }, "address": { "type": "string", "minLength": 1 } }, "required": [ "id", "clientId", "externalReference", "destination", "status", "createdAt", "updatedAt", "type", "firstName", "lastName", "dateOfBirth", "address" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "externalReference": { "description": "Your own reference for this beneficiary, echoed back for correlation. Wayex generates one when you do not supply it at creation.", "type": "string", "minLength": 1 }, "destination": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "payid" ] }, "payId": { "type": "string", "minLength": 1 }, "payIdType": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "accountName": { "type": "string", "minLength": 2 } }, "required": [ "type", "payId", "payIdType", "accountName" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bank_account" ] }, "bsb": { "type": "string", "pattern": "^\\d{6}$" }, "accountNumber": { "type": "string", "pattern": "^\\d{1,9}$" }, "accountName": { "type": "string", "minLength": 2 } }, "required": [ "type", "bsb", "accountNumber", "accountName" ] } ] }, "partyContext": { "description": "Optional free-form key/value metadata about the beneficiary party (e.g. your internal tags or travel-rule party context). Stored and returned; Wayex does not interpret the keys.", "type": "object", "additionalProperties": { "type": "string" } }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deactivatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "business" ] }, "businessName": { "type": "string", "minLength": 1 }, "businessIdentity": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "id", "clientId", "externalReference", "destination", "status", "createdAt", "updatedAt", "type", "businessName" ] } ] } } } } }, "summary": "Create a Treasury beneficiary", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "description": "Creates a reusable individual or business recipient whose AUD payout destination is either a bank account (BSB and account number) or a PayID (email, phone, or ABN) — each carries an account name — and can validate optional Sumsub evidence in the same request. Create the beneficiary before the first payout. Choose the `destination.type` your recipient uses (`bank_account` or `payid`). Supply `externalReference` only when your system already has a stable recipient identifier; otherwise Wayex generates one.", "x-mint": { "href": "/api-reference/treasury/create-a-beneficiary", "metadata": { "title": "Create a Treasury beneficiary", "description": "Creates a reusable individual or business recipient whose AUD payout destination is either a bank account (BSB and account number) or a PayID (email, phone, or ABN) — each carries an account name — and can validate optional Sumsub evidence in the same request." }, "content": "## What this endpoint does\n\nCreates a reusable individual or business recipient whose AUD payout destination is either a bank account (BSB and account number) or a PayID (email, phone, or ABN) — each carries an account name — and can validate optional Sumsub evidence in the same request.\n\n## When to use it\n\nCreate the beneficiary before the first payout. Choose the `destination.type` your recipient uses (`bank_account` or `payid`). Supply `externalReference` only when your system already has a stable recipient identifier; otherwise Wayex generates one.\n\n## Before you call\n\nUse a secret API key with `treasury:write`. Supply the required recipient and destination data. If a fresh end-client Sumsub share token is available or required by policy, send it in the input-only, single-use `sumsub.shareToken` field on this request. The free-form maps on this request — `partyContext`, `businessIdentity`, and `glMapping` — reserve one key name, `@@wxtype` (and any `@@wxtype.esc…` variant): a map containing it is refused with `400 invalid_request` and nothing is written.\n\n## Money and balance effect\n\nThis changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.\n\n## States and completion\n\nCreation does not guarantee a payout will pass current policy. Evidence, screening, limits, and balance are checked when the payout is submitted.\n\n## Safe retries\n\nSend a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out.\n\nRead [Beneficiaries and payouts](/treasury/beneficiaries-and-payouts) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/beneficiaries-and-payouts", "moneyEffect": "This changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.", "retry": "Send a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out." } } }, "/v1/treasury/beneficiaries/{id}": { "get": { "operationId": "TreasuryController2_beneficiary_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "externalReference": { "description": "Your own reference for this beneficiary, echoed back for correlation. Wayex generates one when you do not supply it at creation.", "type": "string", "minLength": 1 }, "destination": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "payid" ] }, "payId": { "type": "string", "minLength": 1 }, "payIdType": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "accountName": { "type": "string", "minLength": 2 } }, "required": [ "type", "payId", "payIdType", "accountName" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bank_account" ] }, "bsb": { "type": "string", "pattern": "^\\d{6}$" }, "accountNumber": { "type": "string", "pattern": "^\\d{1,9}$" }, "accountName": { "type": "string", "minLength": 2 } }, "required": [ "type", "bsb", "accountNumber", "accountName" ] } ] }, "partyContext": { "description": "Optional free-form key/value metadata about the beneficiary party (e.g. your internal tags or travel-rule party context). Stored and returned; Wayex does not interpret the keys.", "type": "object", "additionalProperties": { "type": "string" } }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deactivatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "individual" ] }, "firstName": { "type": "string", "minLength": 1 }, "lastName": { "type": "string", "minLength": 1 }, "dateOfBirth": { "type": "string" }, "address": { "type": "string", "minLength": 1 } }, "required": [ "id", "clientId", "externalReference", "destination", "status", "createdAt", "updatedAt", "type", "firstName", "lastName", "dateOfBirth", "address" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "externalReference": { "description": "Your own reference for this beneficiary, echoed back for correlation. Wayex generates one when you do not supply it at creation.", "type": "string", "minLength": 1 }, "destination": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "payid" ] }, "payId": { "type": "string", "minLength": 1 }, "payIdType": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "accountName": { "type": "string", "minLength": 2 } }, "required": [ "type", "payId", "payIdType", "accountName" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bank_account" ] }, "bsb": { "type": "string", "pattern": "^\\d{6}$" }, "accountNumber": { "type": "string", "pattern": "^\\d{1,9}$" }, "accountName": { "type": "string", "minLength": 2 } }, "required": [ "type", "bsb", "accountNumber", "accountName" ] } ] }, "partyContext": { "description": "Optional free-form key/value metadata about the beneficiary party (e.g. your internal tags or travel-rule party context). Stored and returned; Wayex does not interpret the keys.", "type": "object", "additionalProperties": { "type": "string" } }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deactivatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "business" ] }, "businessName": { "type": "string", "minLength": 1 }, "businessIdentity": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "id", "clientId", "externalReference", "destination", "status", "createdAt", "updatedAt", "type", "businessName" ] } ] } } } } }, "summary": "Get a Treasury beneficiary", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "description": "Returns one saved AUD beneficiary and its current eligibility details for this tenant account. Use it before payout review, after an evidence change, or when investigating a beneficiary reference.", "x-mint": { "href": "/api-reference/treasury/get-a-beneficiary", "metadata": { "title": "Get a Treasury beneficiary", "description": "Returns one saved AUD beneficiary and its current eligibility details for this tenant account." }, "content": "## What this endpoint does\n\nReturns one saved AUD beneficiary and its current eligibility details for this tenant account.\n\n## When to use it\n\nUse it before payout review, after an evidence change, or when investigating a beneficiary reference.\n\n## Before you call\n\nAuthenticate with `treasury:read` and pass a beneficiary ID owned by the same tenant account.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nOnly an active eligible beneficiary can receive a new payout. Inactive records remain readable for historical operations.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Beneficiaries and payouts](/treasury/beneficiaries-and-payouts) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/beneficiaries-and-payouts", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/treasury/beneficiaries/{id}/deactivate": { "post": { "description": "Deactivates a beneficiary for new payouts without deleting its identity or payout history. Use it when a recipient should no longer be selectable, such as after destination details change.", "operationId": "TreasuryController2_deactivateBeneficiary_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique key for this logical action. Reuse the same key and identical payload when retrying after an unknown response.", "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "example": "13bda8d7-87bd-4fa4-b7d5-e740725f9bd2" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "externalReference": { "description": "Your own reference for this beneficiary, echoed back for correlation. Wayex generates one when you do not supply it at creation.", "type": "string", "minLength": 1 }, "destination": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "payid" ] }, "payId": { "type": "string", "minLength": 1 }, "payIdType": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "accountName": { "type": "string", "minLength": 2 } }, "required": [ "type", "payId", "payIdType", "accountName" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bank_account" ] }, "bsb": { "type": "string", "pattern": "^\\d{6}$" }, "accountNumber": { "type": "string", "pattern": "^\\d{1,9}$" }, "accountName": { "type": "string", "minLength": 2 } }, "required": [ "type", "bsb", "accountNumber", "accountName" ] } ] }, "partyContext": { "description": "Optional free-form key/value metadata about the beneficiary party (e.g. your internal tags or travel-rule party context). Stored and returned; Wayex does not interpret the keys.", "type": "object", "additionalProperties": { "type": "string" } }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deactivatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "individual" ] }, "firstName": { "type": "string", "minLength": 1 }, "lastName": { "type": "string", "minLength": 1 }, "dateOfBirth": { "type": "string" }, "address": { "type": "string", "minLength": 1 } }, "required": [ "id", "clientId", "externalReference", "destination", "status", "createdAt", "updatedAt", "type", "firstName", "lastName", "dateOfBirth", "address" ] }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "externalReference": { "description": "Your own reference for this beneficiary, echoed back for correlation. Wayex generates one when you do not supply it at creation.", "type": "string", "minLength": 1 }, "destination": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "payid" ] }, "payId": { "type": "string", "minLength": 1 }, "payIdType": { "type": "string", "enum": [ "email", "phone", "abn" ] }, "accountName": { "type": "string", "minLength": 2 } }, "required": [ "type", "payId", "payIdType", "accountName" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "bank_account" ] }, "bsb": { "type": "string", "pattern": "^\\d{6}$" }, "accountNumber": { "type": "string", "pattern": "^\\d{1,9}$" }, "accountName": { "type": "string", "minLength": 2 } }, "required": [ "type", "bsb", "accountNumber", "accountName" ] } ] }, "partyContext": { "description": "Optional free-form key/value metadata about the beneficiary party (e.g. your internal tags or travel-rule party context). Stored and returned; Wayex does not interpret the keys.", "type": "object", "additionalProperties": { "type": "string" } }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deactivatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "business" ] }, "businessName": { "type": "string", "minLength": 1 }, "businessIdentity": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "id", "clientId", "externalReference", "destination", "status", "createdAt", "updatedAt", "type", "businessName" ] } ] } } } } }, "summary": "Deactivate a Treasury beneficiary", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/treasury/deactivate-a-beneficiary", "metadata": { "title": "Deactivate a Treasury beneficiary", "description": "Deactivates a beneficiary for new payouts without deleting its identity or payout history." }, "content": "## What this endpoint does\n\nDeactivates a beneficiary for new payouts without deleting its identity or payout history.\n\n## When to use it\n\nUse it when a recipient should no longer be selectable, such as after destination details change.\n\n## Before you call\n\nUse a secret API key with `treasury:write` and pass an active beneficiary ID owned by this tenant account.\n\n## Money and balance effect\n\nThis changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.\n\n## States and completion\n\nDeactivation blocks new payout use. Existing accepted or historical payouts keep their original beneficiary snapshot and continue through their real lifecycle.\n\n## Safe retries\n\nSend a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out.\n\nRead [Beneficiaries and payouts](/treasury/beneficiaries-and-payouts) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/beneficiaries-and-payouts", "moneyEffect": "This changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.", "retry": "Send a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out." } } }, "/v1/treasury/destinations": { "get": { "description": "Lists saved, validated stablecoin withdrawal destinations owned by this tenant account. Use it to select an eligible destination before previewing or submitting a stablecoin withdrawal.", "operationId": "TreasuryController2_cryptoDestinations_v1", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "address": { "type": "string", "minLength": 1 }, "tag": { "type": "string", "minLength": 1 }, "externalReference": { "type": "string", "minLength": 1 }, "version": { "type": "integer", "minimum": 0, "exclusiveMinimum": true }, "validationStatus": { "type": "string", "enum": [ "validated" ] }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deactivatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "clientId", "name", "asset", "network", "address", "externalReference", "version", "validationStatus", "status", "createdAt", "updatedAt" ] } } }, "required": [ "data" ] } } } } }, "summary": "List stablecoin destinations", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/treasury/list-stablecoin-destinations", "metadata": { "title": "List stablecoin destinations", "description": "Lists saved, validated stablecoin withdrawal destinations owned by this tenant account." }, "content": "## What this endpoint does\n\nLists saved, validated stablecoin withdrawal destinations owned by this tenant account.\n\n## When to use it\n\nUse it to select an eligible destination before previewing or submitting a stablecoin withdrawal.\n\n## Before you call\n\nAuthenticate with an API key that can read this resource. Results are restricted to the tenant account bound to that key.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nOnly an active destination matching the withdrawal asset and network can be used. Inactive versions remain readable for historical withdrawals.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Conversions and withdrawals](/treasury/conversions-and-withdrawals) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/conversions-and-withdrawals", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } }, "post": { "description": "Saves and validates an asset/network/address destination for later stablecoin withdrawals from this tenant account. Create it after verifying the owner, exact network, address, and required tag or memo out of band.", "operationId": "TreasuryController2_createCryptoDestination_v1", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique key for this logical action. Reuse the same key and identical payload when retrying after an unknown response.", "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "example": "13bda8d7-87bd-4fa4-b7d5-e740725f9bd2" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "address": { "type": "string", "minLength": 1 }, "tag": { "type": "string", "minLength": 1 }, "externalReference": { "type": "string", "minLength": 1 } }, "required": [ "name", "asset", "network", "address", "externalReference" ] } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "address": { "type": "string", "minLength": 1 }, "tag": { "type": "string", "minLength": 1 }, "externalReference": { "type": "string", "minLength": 1 }, "version": { "type": "integer", "minimum": 0, "exclusiveMinimum": true }, "validationStatus": { "type": "string", "enum": [ "validated" ] }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deactivatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "clientId", "name", "asset", "network", "address", "externalReference", "version", "validationStatus", "status", "createdAt", "updatedAt" ] } } } } }, "summary": "Create a stablecoin destination", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/treasury/create-a-stablecoin-destination", "metadata": { "title": "Create a stablecoin destination", "description": "Saves and validates an asset/network/address destination for later stablecoin withdrawals from this tenant account." }, "content": "## What this endpoint does\n\nSaves and validates an asset/network/address destination for later stablecoin withdrawals from this tenant account.\n\n## When to use it\n\nCreate it after verifying the owner, exact network, address, and required tag or memo out of band.\n\n## Before you call\n\nUse a secret API key with `treasury:write`. The asset/network must be enabled and the address must pass format validation and screening.\n\n## Money and balance effect\n\nCreating a destination does not reserve or move wallet money.\n\n## States and completion\n\nA successful response returns an active validated destination. A failed or held screening result cannot be used for withdrawal.\n\n## Safe retries\n\nSend a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out.\n\nRead [Conversions and withdrawals](/treasury/conversions-and-withdrawals) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/conversions-and-withdrawals", "moneyEffect": "Creating a destination does not reserve or move wallet money.", "retry": "Send a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out." } } }, "/v1/treasury/destinations/{id}": { "get": { "operationId": "TreasuryController2_cryptoDestination_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "address": { "type": "string", "minLength": 1 }, "tag": { "type": "string", "minLength": 1 }, "externalReference": { "type": "string", "minLength": 1 }, "version": { "type": "integer", "minimum": 0, "exclusiveMinimum": true }, "validationStatus": { "type": "string", "enum": [ "validated" ] }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deactivatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "clientId", "name", "asset", "network", "address", "externalReference", "version", "validationStatus", "status", "createdAt", "updatedAt" ] } } } } }, "summary": "Get a stablecoin destination", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "description": "Returns one saved stablecoin destination with its asset, network, address, version, validation, and activity status. Use it for withdrawal review, audit, or to resolve the destination referenced by a historical withdrawal.", "x-mint": { "href": "/api-reference/treasury/get-a-stablecoin-destination", "metadata": { "title": "Get a stablecoin destination", "description": "Returns one saved stablecoin destination with its asset, network, address, version, validation, and activity status." }, "content": "## What this endpoint does\n\nReturns one saved stablecoin destination with its asset, network, address, version, validation, and activity status.\n\n## When to use it\n\nUse it for withdrawal review, audit, or to resolve the destination referenced by a historical withdrawal.\n\n## Before you call\n\nAuthenticate with `treasury:read` and pass a destination ID owned by the same tenant account.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nActive validated destinations may be used when they match the withdrawal. Inactive versions are historical only.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Conversions and withdrawals](/treasury/conversions-and-withdrawals) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/conversions-and-withdrawals", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/treasury/destinations/{id}/deactivate": { "post": { "description": "Deactivates a saved stablecoin destination for new withdrawals without rewriting withdrawal history. Use it when an address should no longer receive funds or when replacing its details with a newly validated destination.", "operationId": "TreasuryController2_deactivateCryptoDestination_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique key for this logical action. Reuse the same key and identical payload when retrying after an unknown response.", "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "example": "13bda8d7-87bd-4fa4-b7d5-e740725f9bd2" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "address": { "type": "string", "minLength": 1 }, "tag": { "type": "string", "minLength": 1 }, "externalReference": { "type": "string", "minLength": 1 }, "version": { "type": "integer", "minimum": 0, "exclusiveMinimum": true }, "validationStatus": { "type": "string", "enum": [ "validated" ] }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deactivatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "clientId", "name", "asset", "network", "address", "externalReference", "version", "validationStatus", "status", "createdAt", "updatedAt" ] } } } } }, "summary": "Deactivate a stablecoin destination", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/treasury/deactivate-a-stablecoin-destination", "metadata": { "title": "Deactivate a stablecoin destination", "description": "Deactivates a saved stablecoin destination for new withdrawals without rewriting withdrawal history." }, "content": "## What this endpoint does\n\nDeactivates a saved stablecoin destination for new withdrawals without rewriting withdrawal history.\n\n## When to use it\n\nUse it when an address should no longer receive funds or when replacing its details with a newly validated destination.\n\n## Before you call\n\nUse a secret API key with `treasury:write` and pass an active destination ID owned by this tenant account.\n\n## Money and balance effect\n\nThis changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.\n\n## States and completion\n\nDeactivation blocks new use. Existing accepted or historical withdrawals retain the exact destination snapshot used at submission.\n\n## Safe retries\n\nSend a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out.\n\nRead [Conversions and withdrawals](/treasury/conversions-and-withdrawals) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/conversions-and-withdrawals", "moneyEffect": "This changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.", "retry": "Send a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out." } } }, "/v1/treasury/sumsub-evidence": { "post": { "operationId": "TreasuryController2_submitEvidence_v1", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique key for this logical action. Reuse the same key and identical payload when retrying after an unknown response.", "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "example": "13bda8d7-87bd-4fa4-b7d5-e740725f9bd2" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "beneficiaryId": { "type": "string", "minLength": 1 }, "externalReference": { "type": "string", "minLength": 1 }, "shareToken": { "type": "string", "minLength": 1, "maxLength": 1024 } }, "required": [ "beneficiaryId", "externalReference", "shareToken" ] } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "beneficiaryId": { "type": "string", "minLength": 1 }, "applicantId": { "type": "string", "minLength": 1 }, "levelName": { "type": "string", "minLength": 1 }, "externalReference": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "accepted", "pending", "manual_review", "rejected", "expired" ] }, "checkedAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "clientId", "beneficiaryId", "applicantId", "levelName", "externalReference", "status", "checkedAt" ] } } } } }, "summary": "Submit optional reusable identity evidence", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "description": "Validates a single-use Sumsub share token and binds the reusable accepted evidence result to one beneficiary. Use it only to add evidence to an existing beneficiary. The normal flow submits the token in `sumsub.shareToken` while creating the beneficiary, never on a payout.", "x-mint": { "href": "/api-reference/treasury/submit-identity-evidence", "metadata": { "title": "Submit optional reusable identity evidence", "description": "Validates a single-use Sumsub share token and binds the reusable accepted evidence result to one beneficiary." }, "content": "## What this endpoint does\n\nValidates a single-use Sumsub share token and binds the reusable accepted evidence result to one beneficiary.\n\n## When to use it\n\nUse it only to add evidence to an existing beneficiary. The normal flow submits the token in `sumsub.shareToken` while creating the beneficiary, never on a payout.\n\n## Before you call\n\nUse a secret API key with `treasury:write`. The beneficiary must belong to this tenant account and the fresh single-use token must match that beneficiary.\n\n## Money and balance effect\n\nEvidence validation does not reserve or move wallet money.\n\n## States and completion\n\nAccepted evidence can later satisfy payout policy until it expires. Invalid, mismatched, rejected, or unavailable evidence is never silently ignored.\n\n## Safe retries\n\nThe share token is single-use. Send one `Idempotency-Key`, then retry the exact request with the same key after a lost response so Wayex replays the result rather than validating the token again.\n\nRead [Beneficiaries and payouts](/treasury/beneficiaries-and-payouts) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/beneficiaries-and-payouts", "moneyEffect": "Evidence validation does not reserve or move wallet money.", "retry": "The share token is single-use. Send one `Idempotency-Key`, then retry the exact request with the same key after a lost response so Wayex replays the result rather than validating the token again." } } }, "/v1/treasury/payouts/preview": { "post": { "description": "Calculates the effective payout fee, total AUD source debit, current eligibility, and any hold reason without creating an operation. Call it after the user enters the payout and before showing the final review screen. Submit the same intent to the create endpoint only after confirmation.", "operationId": "TreasuryController2_previewPayout_v1", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique key for this logical action. Reuse the same key and identical payload when retrying after an unknown response.", "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "example": "13bda8d7-87bd-4fa4-b7d5-e740725f9bd2" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "beneficiaryId": { "type": "string", "minLength": 1 }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD" ] }, "externalReference": { "description": "Your own reference for this payout, echoed back for correlation and reconciliation. This is NOT the idempotency key — use the Idempotency-Key header for retry-safety.", "type": "string", "minLength": 1 }, "purpose": { "type": "string", "minLength": 1, "maxLength": 255 }, "walletProviderReference": { "description": "Optional. Your own reference for the upstream wallet or provider these funds relate to. Stored and returned for your reconciliation; Wayex does not interpret it.", "type": "string", "minLength": 1 }, "downstreamMerchantReference": { "description": "Optional. Your own reference for the downstream merchant or end-customer this payout is made for. Reconciliation and reporting metadata only; Wayex does not interpret it.", "type": "string", "minLength": 1 }, "evidenceId": { "description": "Optional. Pin a specific accepted, unexpired source-of-funds evidence record (belonging to this beneficiary) to back this payout. Omit to let Wayex use the beneficiary's newest accepted, unexpired evidence when policy requires it.", "type": "string", "minLength": 1 }, "remitter": { "type": "string", "enum": [ "wayex", "tenant" ] } }, "required": [ "beneficiaryId", "amount", "currency", "externalReference", "purpose" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "principal": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "fee": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "sourceDebit": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "asset": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "configurationId": { "type": "string", "minLength": 1 }, "canProceed": { "type": "boolean" }, "holdReason": { "type": "string", "minLength": 1 } }, "required": [ "principal", "fee", "sourceDebit", "asset", "configurationId", "canProceed" ] } } } } }, "summary": "Preview an AUD payout", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/treasury/preview-a-payout", "metadata": { "title": "Preview an AUD payout", "description": "Calculates the effective payout fee, total AUD source debit, current eligibility, and any hold reason without creating an operation." }, "content": "## What this endpoint does\n\nCalculates the effective payout fee, total AUD source debit, current eligibility, and any hold reason without creating an operation.\n\n## When to use it\n\nCall it after the user enters the payout and before showing the final review screen. Submit the same intent to the create endpoint only after confirmation.\n\n## Before you call\n\nUse a secret API key with `treasury:write`. The saved beneficiary must be active. You may select an existing `evidenceId`; otherwise Wayex uses the beneficiary’s newest accepted, unexpired evidence when policy requires it.\n\n## Money and balance effect\n\nPreviewing does not reserve, debit, or send AUD. The returned source debit and `canProceed` value are advisory until the create request atomically rechecks policy and reserves funds.\n\n## States and completion\n\n`canProceed` reports current static eligibility. A `holdReason` explains a current block or review path; the final create response remains authoritative under concurrent balance and provider changes.\n\n## Safe retries\n\nSend a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out.\n\nRead [Beneficiaries and payouts](/treasury/beneficiaries-and-payouts) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/beneficiaries-and-payouts", "moneyEffect": "Previewing does not reserve, debit, or send AUD. The returned source debit and `canProceed` value are advisory until the create request atomically rechecks policy and reserves funds.", "retry": "Send a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out." } } }, "/v1/treasury/payouts": { "post": { "description": "Creates an AUD payout to a saved beneficiary and durably reserves its source debit from this tenant account’s AUD wallet. Submit it after choosing the beneficiary, confirming the amount and purpose, and reviewing the effective fee and available balance.", "operationId": "TreasuryController2_createPayout_v1", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique key for this logical action. Reuse the same key and identical payload when retrying after an unknown response.", "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "example": "13bda8d7-87bd-4fa4-b7d5-e740725f9bd2" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "beneficiaryId": { "type": "string", "minLength": 1 }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD" ] }, "externalReference": { "description": "Your own reference for this payout, echoed back for correlation and reconciliation. This is NOT the idempotency key — use the Idempotency-Key header for retry-safety.", "type": "string", "minLength": 1 }, "purpose": { "type": "string", "minLength": 1, "maxLength": 255 }, "walletProviderReference": { "description": "Optional. Your own reference for the upstream wallet or provider these funds relate to. Stored and returned for your reconciliation; Wayex does not interpret it.", "type": "string", "minLength": 1 }, "downstreamMerchantReference": { "description": "Optional. Your own reference for the downstream merchant or end-customer this payout is made for. Reconciliation and reporting metadata only; Wayex does not interpret it.", "type": "string", "minLength": 1 }, "evidenceId": { "description": "Optional. Pin a specific accepted, unexpired source-of-funds evidence record (belonging to this beneficiary) to back this payout. Omit to let Wayex use the beneficiary's newest accepted, unexpired evidence when policy requires it.", "type": "string", "minLength": 1 }, "remitter": { "type": "string", "enum": [ "wayex", "tenant" ] } }, "required": [ "beneficiaryId", "amount", "currency", "externalReference", "purpose" ] } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "beneficiaryId": { "type": "string", "minLength": 1 }, "amount": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "fee": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "sourceDebit": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "status": { "type": "string", "enum": [ "accepted", "held", "submitted", "settled", "failed", "returned" ] }, "configurationId": { "type": "string", "minLength": 1 }, "externalReference": { "description": "Your own reference for this payout, echoed back for correlation and reconciliation. This is NOT the idempotency key — use the Idempotency-Key header for retry-safety.", "type": "string", "minLength": 1 }, "purpose": { "type": "string", "minLength": 1, "maxLength": 255 }, "walletProviderReference": { "description": "Optional. Your own reference for the upstream wallet or provider these funds relate to. Stored and returned for your reconciliation; Wayex does not interpret it.", "type": "string", "minLength": 1 }, "downstreamMerchantReference": { "description": "Optional. Your own reference for the downstream merchant or end-customer this payout is made for. Reconciliation and reporting metadata only; Wayex does not interpret it.", "type": "string", "minLength": 1 }, "evidenceId": { "description": "The specific source-of-funds evidence record backing this payout (auto-selected when you do not pin one).", "type": "string", "minLength": 1 }, "providerReference": { "type": "string", "minLength": 1 }, "statusReason": { "type": "string", "minLength": 1 }, "remitter": { "type": "string", "enum": [ "wayex", "tenant" ] }, "reservation": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "reserved", "captured", "released" ] }, "amount": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] } }, "required": [ "status", "amount" ] }, "nextAction": { "type": "string", "enum": [ "none", "wait_for_settlement", "contact_support", "retry_new_request", "review_balance" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "clientId", "beneficiaryId", "amount", "fee", "sourceDebit", "status", "configurationId", "externalReference", "purpose", "reservation", "nextAction", "createdAt", "updatedAt" ] } } } } }, "summary": "Create an AUD payout", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/treasury/create-a-payout", "metadata": { "title": "Create an AUD payout", "description": "Creates an AUD payout to a saved beneficiary and durably reserves its source debit from this tenant account’s AUD wallet." }, "content": "## What this endpoint does\n\nCreates an AUD payout to a saved beneficiary and durably reserves its source debit from this tenant account’s AUD wallet.\n\n## When to use it\n\nSubmit it after choosing the beneficiary, confirming the amount and purpose, and reviewing the effective fee and available balance.\n\n## Before you call\n\nUse a secret API key with `treasury:write`. The beneficiary, its accepted evidence when required, limits, BSB/account rail, and wallet balance must all be eligible. Sumsub share tokens are submitted with beneficiary creation, not here.\n\n## Money and balance effect\n\nOn acceptance, the payout source debit is reserved so it cannot be spent twice. Settlement captures the reservation; a proven pre-settlement failure releases it, while returns follow the configured return policy.\n\n## States and completion\n\nBoth `accepted` and `held` payouts have durably reserved the source debit — the response’s `reservation` object shows `reserved`. `accepted` means policy passed; `held` needs review before submission. `submitted` reached the bank rail; `settled`, `failed`, and `returned` describe later outcomes.\n\n## Safe retries\n\nSend a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out.\n\nRead [Beneficiaries and payouts](/treasury/beneficiaries-and-payouts) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/beneficiaries-and-payouts", "moneyEffect": "On acceptance, the payout source debit is reserved so it cannot be spent twice. Settlement captures the reservation; a proven pre-settlement failure releases it, while returns follow the configured return policy.", "retry": "Send a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out." } }, "get": { "operationId": "TreasuryController2_payouts_v1", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "beneficiaryId": { "type": "string", "minLength": 1 }, "amount": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "fee": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "sourceDebit": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "status": { "type": "string", "enum": [ "accepted", "held", "submitted", "settled", "failed", "returned" ] }, "configurationId": { "type": "string", "minLength": 1 }, "externalReference": { "description": "Your own reference for this payout, echoed back for correlation and reconciliation. This is NOT the idempotency key — use the Idempotency-Key header for retry-safety.", "type": "string", "minLength": 1 }, "purpose": { "type": "string", "minLength": 1, "maxLength": 255 }, "walletProviderReference": { "description": "Optional. Your own reference for the upstream wallet or provider these funds relate to. Stored and returned for your reconciliation; Wayex does not interpret it.", "type": "string", "minLength": 1 }, "downstreamMerchantReference": { "description": "Optional. Your own reference for the downstream merchant or end-customer this payout is made for. Reconciliation and reporting metadata only; Wayex does not interpret it.", "type": "string", "minLength": 1 }, "evidenceId": { "description": "The specific source-of-funds evidence record backing this payout (auto-selected when you do not pin one).", "type": "string", "minLength": 1 }, "providerReference": { "type": "string", "minLength": 1 }, "statusReason": { "type": "string", "minLength": 1 }, "remitter": { "type": "string", "enum": [ "wayex", "tenant" ] }, "reservation": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "reserved", "captured", "released" ] }, "amount": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] } }, "required": [ "status", "amount" ] }, "nextAction": { "type": "string", "enum": [ "none", "wait_for_settlement", "contact_support", "retry_new_request", "review_balance" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "clientId", "beneficiaryId", "amount", "fee", "sourceDebit", "status", "configurationId", "externalReference", "purpose", "reservation", "nextAction", "createdAt", "updatedAt" ] } } }, "required": [ "data" ] } } } } }, "summary": "List AUD payouts", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "description": "Lists AUD payouts submitted by this tenant account. Use it for payout operations, customer support, and reconciliation by Wayex or external reference.", "x-mint": { "href": "/api-reference/treasury/list-payouts", "metadata": { "title": "List AUD payouts", "description": "Lists AUD payouts submitted by this tenant account." }, "content": "## What this endpoint does\n\nLists AUD payouts submitted by this tenant account.\n\n## When to use it\n\nUse it for payout operations, customer support, and reconciliation by Wayex or external reference.\n\n## Before you call\n\nAuthenticate with an API key that can read this resource. Results are restricted to the tenant account bound to that key.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nAccepted, held, and submitted do not mean bank settlement. Treat settled, returned, and failed outcomes distinctly; an operation whose provider outcome is still unknown stays in a non-terminal status with its reservation intact until reconciled.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Beneficiaries and payouts](/treasury/beneficiaries-and-payouts) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/beneficiaries-and-payouts", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/treasury/payouts/{id}": { "get": { "operationId": "TreasuryController2_payout_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "beneficiaryId": { "type": "string", "minLength": 1 }, "amount": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "fee": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "sourceDebit": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "status": { "type": "string", "enum": [ "accepted", "held", "submitted", "settled", "failed", "returned" ] }, "configurationId": { "type": "string", "minLength": 1 }, "externalReference": { "description": "Your own reference for this payout, echoed back for correlation and reconciliation. This is NOT the idempotency key — use the Idempotency-Key header for retry-safety.", "type": "string", "minLength": 1 }, "purpose": { "type": "string", "minLength": 1, "maxLength": 255 }, "walletProviderReference": { "description": "Optional. Your own reference for the upstream wallet or provider these funds relate to. Stored and returned for your reconciliation; Wayex does not interpret it.", "type": "string", "minLength": 1 }, "downstreamMerchantReference": { "description": "Optional. Your own reference for the downstream merchant or end-customer this payout is made for. Reconciliation and reporting metadata only; Wayex does not interpret it.", "type": "string", "minLength": 1 }, "evidenceId": { "description": "The specific source-of-funds evidence record backing this payout (auto-selected when you do not pin one).", "type": "string", "minLength": 1 }, "providerReference": { "type": "string", "minLength": 1 }, "statusReason": { "type": "string", "minLength": 1 }, "remitter": { "type": "string", "enum": [ "wayex", "tenant" ] }, "reservation": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "reserved", "captured", "released" ] }, "amount": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] } }, "required": [ "status", "amount" ] }, "nextAction": { "type": "string", "enum": [ "none", "wait_for_settlement", "contact_support", "retry_new_request", "review_balance" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "clientId", "beneficiaryId", "amount", "fee", "sourceDebit", "status", "configurationId", "externalReference", "purpose", "reservation", "nextAction", "createdAt", "updatedAt" ] } } } } }, "summary": "Get an AUD payout", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "description": "Returns the authoritative amount, fee, reservation, beneficiary, references, and lifecycle for one AUD payout. Use it after a webhook, timeout, hold, return, or support question to determine the current payout outcome.", "x-mint": { "href": "/api-reference/treasury/get-a-payout", "metadata": { "title": "Get an AUD payout", "description": "Returns the authoritative amount, fee, reservation, beneficiary, references, and lifecycle for one AUD payout." }, "content": "## What this endpoint does\n\nReturns the authoritative amount, fee, reservation, beneficiary, references, and lifecycle for one AUD payout.\n\n## When to use it\n\nUse it after a webhook, timeout, hold, return, or support question to determine the current payout outcome.\n\n## Before you call\n\nAuthenticate with `treasury:read` and pass a payout ID owned by the same tenant account.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nRead the status, reason, reservation state, and next action together. Never infer settlement from `accepted` or `submitted`.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Beneficiaries and payouts](/treasury/beneficiaries-and-payouts) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/beneficiaries-and-payouts", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/treasury/withdrawals/preview": { "post": { "description": "Calculates the effective withdrawal fee, total source debit, current eligibility, and any hold reason for a saved destination without creating an operation. Call it after the user chooses the active destination and amount, then show the returned terms on the final review screen before confirmation.", "operationId": "TreasuryController2_previewWithdrawal_v1", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique key for this logical action. Reuse the same key and identical payload when retrying after an unknown response.", "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "example": "13bda8d7-87bd-4fa4-b7d5-e740725f9bd2" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "destinationId": { "type": "string", "minLength": 1 }, "externalReference": { "type": "string", "minLength": 1 } }, "required": [ "asset", "network", "amount", "externalReference", "destinationId" ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "principal": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "fee": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "sourceDebit": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "asset": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "configurationId": { "type": "string", "minLength": 1 }, "canProceed": { "type": "boolean" }, "holdReason": { "type": "string", "minLength": 1 } }, "required": [ "principal", "fee", "sourceDebit", "asset", "configurationId", "canProceed" ] } } } } }, "summary": "Preview a stablecoin withdrawal", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/treasury/preview-a-withdrawal", "metadata": { "title": "Preview a stablecoin withdrawal", "description": "Calculates the effective withdrawal fee, total source debit, current eligibility, and any hold reason for a saved destination without creating an operation." }, "content": "## What this endpoint does\n\nCalculates the effective withdrawal fee, total source debit, current eligibility, and any hold reason for a saved destination without creating an operation.\n\n## When to use it\n\nCall it after the user chooses the active destination and amount, then show the returned terms on the final review screen before confirmation.\n\n## Before you call\n\nUse a secret API key with `treasury:write`. The saved destination must belong to this tenant account and match an enabled asset and network.\n\n## Money and balance effect\n\nPreviewing does not reserve, debit, or send stablecoin. The create request rechecks the balance, destination, screening, limits, and provider capacity before reserving funds.\n\n## States and completion\n\n`canProceed` reports current static eligibility. A `holdReason` identifies a current block or review path; any later create response — `accepted` or `held` — records a durable reservation. The preview does not test whether this account holds the requested network: a withdrawal on a chain with no credited deposit or settled conversion previews cleanly and is then held on create with `withdrawal_network_not_held`.\n\n## Safe retries\n\nSend a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out.\n\nRead [Conversions and withdrawals](/treasury/conversions-and-withdrawals) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/conversions-and-withdrawals", "moneyEffect": "Previewing does not reserve, debit, or send stablecoin. The create request rechecks the balance, destination, screening, limits, and provider capacity before reserving funds.", "retry": "Send a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out." } } }, "/v1/treasury/withdrawals": { "post": { "operationId": "TreasuryController2_createWithdrawal_v1", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique key for this logical action. Reuse the same key and identical payload when retrying after an unknown response.", "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "example": "13bda8d7-87bd-4fa4-b7d5-e740725f9bd2" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "destinationId": { "type": "string", "minLength": 1 }, "externalReference": { "type": "string", "minLength": 1 } }, "required": [ "asset", "network", "amount", "externalReference", "destinationId" ] } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "fee": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "sourceDebit": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "destinationId": { "type": "string", "minLength": 1 }, "destinationAddress": { "type": "string", "minLength": 1 }, "destinationTag": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "accepted", "held", "submitted", "settled", "failed", "returned" ] }, "configurationId": { "type": "string", "minLength": 1 }, "externalReference": { "type": "string", "minLength": 1 }, "providerReference": { "type": "string", "minLength": 1 }, "statusReason": { "type": "string", "minLength": 1 }, "reservation": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "reserved", "captured", "released" ] }, "amount": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] } }, "required": [ "status", "amount" ] }, "nextAction": { "type": "string", "enum": [ "none", "wait_for_settlement", "contact_support", "retry_new_request", "review_balance" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "clientId", "asset", "network", "amount", "fee", "sourceDebit", "destinationAddress", "status", "configurationId", "externalReference", "reservation", "nextAction", "createdAt", "updatedAt" ] } } } } }, "summary": "Create a stablecoin withdrawal", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "description": "Creates a stablecoin withdrawal and durably reserves its source debit from this tenant account’s matching asset/network wallet. Submit it after reviewing the approved destination, exact network, fee, source debit, and available balance.", "x-mint": { "href": "/api-reference/treasury/create-a-withdrawal", "metadata": { "title": "Create a stablecoin withdrawal", "description": "Creates a stablecoin withdrawal and durably reserves its source debit from this tenant account’s matching asset/network wallet." }, "content": "## What this endpoint does\n\nCreates a stablecoin withdrawal and durably reserves its source debit from this tenant account’s matching asset/network wallet.\n\n## When to use it\n\nSubmit it after reviewing the approved destination, exact network, fee, source debit, and available balance.\n\n## Before you call\n\nUse a secret API key with `treasury:write`. The destination, asset/network, limits, screening, and available balance must all be eligible.\n\n## Money and balance effect\n\nOn acceptance, the source debit is reserved. It is captured after confirmed execution or released only when non-execution is proven.\n\n## States and completion\n\nBoth `accepted` and `held` withdrawals have durably reserved the source debit; `accepted` means reserved, not sent, and `held` needs review before submission. A withdrawal on a network this account has no credited deposit or settled conversion for is accepted as `held` with `statusReason` `withdrawal_network_not_held` and stays parked until Wayex releases it — withdraw on a chain you have funded, or convert onto it first. The status moves to `settled` only after on-chain finality is reached — confirmation counts are not exposed on this resource. Follow status, reason, and next action through submission, failure, and hold; an unresolved outcome remains reconciling.\n\n## Safe retries\n\nSend a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out.\n\nRead [Conversions and withdrawals](/treasury/conversions-and-withdrawals) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/conversions-and-withdrawals", "moneyEffect": "On acceptance, the source debit is reserved. It is captured after confirmed execution or released only when non-execution is proven.", "retry": "Send a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out." } }, "get": { "operationId": "TreasuryController2_withdrawals_v1", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "fee": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "sourceDebit": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "destinationId": { "type": "string", "minLength": 1 }, "destinationAddress": { "type": "string", "minLength": 1 }, "destinationTag": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "accepted", "held", "submitted", "settled", "failed", "returned" ] }, "configurationId": { "type": "string", "minLength": 1 }, "externalReference": { "type": "string", "minLength": 1 }, "providerReference": { "type": "string", "minLength": 1 }, "statusReason": { "type": "string", "minLength": 1 }, "reservation": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "reserved", "captured", "released" ] }, "amount": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] } }, "required": [ "status", "amount" ] }, "nextAction": { "type": "string", "enum": [ "none", "wait_for_settlement", "contact_support", "retry_new_request", "review_balance" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "clientId", "asset", "network", "amount", "fee", "sourceDebit", "destinationAddress", "status", "configurationId", "externalReference", "reservation", "nextAction", "createdAt", "updatedAt" ] } } }, "required": [ "data" ] } } } } }, "summary": "List stablecoin withdrawals", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "description": "Lists stablecoin withdrawals from this tenant account’s wallet. Use it for withdrawal operations, blockchain reconciliation, and customer support.", "x-mint": { "href": "/api-reference/treasury/list-withdrawals", "metadata": { "title": "List stablecoin withdrawals", "description": "Lists stablecoin withdrawals from this tenant account’s wallet." }, "content": "## What this endpoint does\n\nLists stablecoin withdrawals from this tenant account’s wallet.\n\n## When to use it\n\nUse it for withdrawal operations, blockchain reconciliation, and customer support.\n\n## Before you call\n\nAuthenticate with an API key that can read this resource. Results are restricted to the tenant account bound to that key.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nAccepted and submitted withdrawals remain unsettled. Track status, reason, and next action explicitly; `settled` is reached only after on-chain finality.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Conversions and withdrawals](/treasury/conversions-and-withdrawals) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/conversions-and-withdrawals", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/treasury/withdrawals/{id}": { "get": { "operationId": "TreasuryController2_withdrawal_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "asset": { "type": "string", "enum": [ "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "fee": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "sourceDebit": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "destinationId": { "type": "string", "minLength": 1 }, "destinationAddress": { "type": "string", "minLength": 1 }, "destinationTag": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "accepted", "held", "submitted", "settled", "failed", "returned" ] }, "configurationId": { "type": "string", "minLength": 1 }, "externalReference": { "type": "string", "minLength": 1 }, "providerReference": { "type": "string", "minLength": 1 }, "statusReason": { "type": "string", "minLength": 1 }, "reservation": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "reserved", "captured", "released" ] }, "amount": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] } }, "required": [ "status", "amount" ] }, "nextAction": { "type": "string", "enum": [ "none", "wait_for_settlement", "contact_support", "retry_new_request", "review_balance" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "clientId", "asset", "network", "amount", "fee", "sourceDebit", "destinationAddress", "status", "configurationId", "externalReference", "reservation", "nextAction", "createdAt", "updatedAt" ] } } } } }, "summary": "Get a stablecoin withdrawal", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "description": "Returns the authoritative amount, fee, reservation, destination, transaction reference, and lifecycle for one withdrawal. Use it after a webhook, timeout, hold, or support question to determine the current on-chain outcome.", "x-mint": { "href": "/api-reference/treasury/get-a-withdrawal", "metadata": { "title": "Get a stablecoin withdrawal", "description": "Returns the authoritative amount, fee, reservation, destination, transaction reference, and lifecycle for one withdrawal." }, "content": "## What this endpoint does\n\nReturns the authoritative amount, fee, reservation, destination, transaction reference, and lifecycle for one withdrawal.\n\n## When to use it\n\nUse it after a webhook, timeout, hold, or support question to determine the current on-chain outcome.\n\n## Before you call\n\nAuthenticate with `treasury:read` and pass a withdrawal ID owned by the same tenant account.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nRead status, reservation state, reason, and next action together. Confirmation counts are not exposed; the status moves to `settled` only after on-chain finality is reached. Unknown is not failed and must be reconciled.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Conversions and withdrawals](/treasury/conversions-and-withdrawals) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/conversions-and-withdrawals", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/treasury/conversion-quotes": { "post": { "description": "Creates an exact, short-lived quote to convert between AUD and an enabled stablecoin in this tenant account. Create it after the user chooses a direction and source amount, then display its all-in rate, fee, source debit, destination amount, and expiry for review alongside the available source balance from the balances endpoint. The quote always returns the settlement network it was struck on; the console stores the returned quote ID internally.", "operationId": "TreasuryController2_createConversionQuote_v1", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique key for this logical action. Reuse the same key and identical payload when retrying after an unknown response.", "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "example": "13bda8d7-87bd-4fa4-b7d5-e740725f9bd2" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "sourceAsset": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "destinationAsset": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "settlementNetwork": { "description": "Physical settlement network. REQUIRED when sourceAsset is AUD — the chain the purchased stablecoin is settled onto. Optional routing override when converting a stablecoin to AUD.", "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "sourceAmount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "externalReference": { "type": "string", "minLength": 1 } }, "required": [ "sourceAsset", "destinationAsset", "sourceAmount", "externalReference" ] } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "externalReference": { "type": "string", "minLength": 1 }, "source": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "destination": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "settlementNetwork": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "rate": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "fee": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "sourceDebit": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "configurationId": { "type": "string", "minLength": 1 }, "expiresAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "clientId", "externalReference", "source", "destination", "settlementNetwork", "rate", "fee", "sourceDebit", "configurationId", "expiresAt", "createdAt" ] } } } } }, "summary": "Create a Treasury conversion quote", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/treasury/create-a-conversion-quote", "metadata": { "title": "Create a Treasury conversion quote", "description": "Creates an exact, short-lived quote to convert between AUD and an enabled stablecoin in this tenant account." }, "content": "## What this endpoint does\n\nCreates an exact, short-lived quote to convert between AUD and an enabled stablecoin in this tenant account.\n\n## When to use it\n\nCreate it after the user chooses a direction and source amount, then display its all-in rate, fee, source debit, destination amount, and expiry for review alongside the available source balance from the balances endpoint. The quote always returns the settlement network it was struck on; the console stores the returned quote ID internally.\n\n## Before you call\n\nUse a secret API key with `treasury:write`. The pair must be enabled and the source amount must meet current limits. Converting **AUD to a stablecoin** requires `settlementNetwork` — the chain the purchased stablecoin is settled onto, and therefore the chain you will hold and withdraw it on. There is no default: omitting it fails with `settlement_network_required`, a chain Wayex cannot receive on fails with `unsupported_asset_network`, and a chain that differs from a route Wayex has pinned for that asset fails with `conversion_route_conflict`. Converting a stablecoin to AUD does not need the field — that direction routes by the balance you already hold, and a supplied value is only an override.\n\n## Money and balance effect\n\nCreating a quote does not reserve or move money. The source wallet is checked and reserved only when the quote is accepted.\n\n## States and completion\n\nA quote is usable until its expiry. If it expires or no longer passes acceptance checks, create a fresh quote rather than altering it.\n\n## Safe retries\n\nSend a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out.\n\nRead [Conversions and withdrawals](/treasury/conversions-and-withdrawals) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/conversions-and-withdrawals", "moneyEffect": "Creating a quote does not reserve or move money. The source wallet is checked and reserved only when the quote is accepted.", "retry": "Send a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out." } } }, "/v1/treasury/conversions": { "post": { "description": "Accepts an unexpired quote, creates the wallet conversion, and durably reserves its source debit. Submit the quote ID returned by quote creation only after the user reviews and confirms the exact terms. Console users never type or copy that ID.", "operationId": "TreasuryController2_acceptConversion_v1", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique key for this logical action. Reuse the same key and identical payload when retrying after an unknown response.", "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "example": "13bda8d7-87bd-4fa4-b7d5-e740725f9bd2" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "quoteId": { "type": "string", "minLength": 1 }, "externalReference": { "type": "string", "minLength": 1 } }, "required": [ "quoteId", "externalReference" ] } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "quoteId": { "type": "string", "minLength": 1 }, "source": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "destination": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "settlementNetwork": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "fee": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "sourceDebit": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "status": { "type": "string", "enum": [ "accepted", "held", "submitted", "settled", "failed", "returned" ] }, "settlementStatus": { "type": "string", "enum": [ "source_settling", "trading", "destination_settling", "settled", "held" ] }, "configurationId": { "type": "string", "minLength": 1 }, "externalReference": { "type": "string", "minLength": 1 }, "providerReference": { "type": "string", "minLength": 1 }, "statusReason": { "type": "string", "minLength": 1 }, "reservation": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "reserved", "captured", "released" ] }, "amount": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] } }, "required": [ "status", "amount" ] }, "nextAction": { "type": "string", "enum": [ "none", "wait_for_settlement", "contact_support", "retry_new_request", "review_balance" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "clientId", "quoteId", "source", "destination", "settlementNetwork", "fee", "sourceDebit", "status", "settlementStatus", "configurationId", "externalReference", "reservation", "nextAction", "createdAt", "updatedAt" ] } } } } }, "summary": "Accept a Treasury conversion quote", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/treasury/accept-a-conversion-quote", "metadata": { "title": "Accept a Treasury conversion quote", "description": "Accepts an unexpired quote, creates the wallet conversion, and durably reserves its source debit." }, "content": "## What this endpoint does\n\nAccepts an unexpired quote, creates the wallet conversion, and durably reserves its source debit.\n\n## When to use it\n\nSubmit the quote ID returned by quote creation only after the user reviews and confirms the exact terms. Console users never type or copy that ID.\n\n## Before you call\n\nUse a secret API key with `treasury:write`. The quote must belong to this tenant account, remain unexpired, and still pass balance, limit, and provider-capacity checks.\n\n## Money and balance effect\n\nAcceptance reserves the quoted source debit. Wayex credits the destination wallet only after the trade and physical post-trade fund movements complete.\n\n## States and completion\n\nBoth `accepted` and `held` conversions have durably reserved the source debit. `accepted` means execution work is also durable; follow trade and settlement progress — an unknown leg remains reserved and reconciling until its real outcome is known.\n\n## Safe retries\n\nSend a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out.\n\nRead [Conversions and withdrawals](/treasury/conversions-and-withdrawals) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/conversions-and-withdrawals", "moneyEffect": "Acceptance reserves the quoted source debit. Wayex credits the destination wallet only after the trade and physical post-trade fund movements complete.", "retry": "Send a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out." } }, "get": { "operationId": "TreasuryController2_conversions_v1", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "quoteId": { "type": "string", "minLength": 1 }, "source": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "destination": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "settlementNetwork": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "fee": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "sourceDebit": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "status": { "type": "string", "enum": [ "accepted", "held", "submitted", "settled", "failed", "returned" ] }, "settlementStatus": { "type": "string", "enum": [ "source_settling", "trading", "destination_settling", "settled", "held" ] }, "configurationId": { "type": "string", "minLength": 1 }, "externalReference": { "type": "string", "minLength": 1 }, "providerReference": { "type": "string", "minLength": 1 }, "statusReason": { "type": "string", "minLength": 1 }, "reservation": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "reserved", "captured", "released" ] }, "amount": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] } }, "required": [ "status", "amount" ] }, "nextAction": { "type": "string", "enum": [ "none", "wait_for_settlement", "contact_support", "retry_new_request", "review_balance" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "clientId", "quoteId", "source", "destination", "settlementNetwork", "fee", "sourceDebit", "status", "settlementStatus", "configurationId", "externalReference", "reservation", "nextAction", "createdAt", "updatedAt" ] } } }, "required": [ "data" ] } } } } }, "summary": "List Treasury wallet conversions", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "description": "Lists accepted AUD-to-stablecoin and stablecoin-to-AUD wallet conversions for this tenant account. Use it for conversion operations and to reconcile each quote, trade, physical settlement leg, and wallet credit.", "x-mint": { "href": "/api-reference/treasury/list-conversions", "metadata": { "title": "List Treasury wallet conversions", "description": "Lists accepted AUD-to-stablecoin and stablecoin-to-AUD wallet conversions for this tenant account." }, "content": "## What this endpoint does\n\nLists accepted AUD-to-stablecoin and stablecoin-to-AUD wallet conversions for this tenant account.\n\n## When to use it\n\nUse it for conversion operations and to reconcile each quote, trade, physical settlement leg, and wallet credit.\n\n## Before you call\n\nAuthenticate with an API key that can read this resource. Results are restricted to the tenant account bound to that key.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nA conversion is not complete until every required funding, trade, and destination-settlement leg succeeds. Accepted or submitted is not destination credit.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Conversions and withdrawals](/treasury/conversions-and-withdrawals) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/conversions-and-withdrawals", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/treasury/conversions/{id}": { "get": { "operationId": "TreasuryController2_conversion_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "clientId": { "type": "string", "minLength": 1 }, "quoteId": { "type": "string", "minLength": 1 }, "source": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "destination": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "settlementNetwork": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "fee": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "sourceDebit": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] }, "status": { "type": "string", "enum": [ "accepted", "held", "submitted", "settled", "failed", "returned" ] }, "settlementStatus": { "type": "string", "enum": [ "source_settling", "trading", "destination_settling", "settled", "held" ] }, "configurationId": { "type": "string", "minLength": 1 }, "externalReference": { "type": "string", "minLength": 1 }, "providerReference": { "type": "string", "minLength": 1 }, "statusReason": { "type": "string", "minLength": 1 }, "reservation": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "reserved", "captured", "released" ] }, "amount": { "type": "object", "properties": { "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "currency": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] } }, "required": [ "amount", "currency" ] } }, "required": [ "status", "amount" ] }, "nextAction": { "type": "string", "enum": [ "none", "wait_for_settlement", "contact_support", "retry_new_request", "review_balance" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "clientId", "quoteId", "source", "destination", "settlementNetwork", "fee", "sourceDebit", "status", "settlementStatus", "configurationId", "externalReference", "reservation", "nextAction", "createdAt", "updatedAt" ] } } } } }, "summary": "Get a Treasury wallet conversion", "tags": [ "Treasury" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "description": "Returns the quote, source reservation, fee, trade, physical settlement legs, destination credit, and current state for one conversion. Use it after a webhook, timeout, recovery event, or support question to determine which leg has completed and whether funds are spendable.", "x-mint": { "href": "/api-reference/treasury/get-a-conversion", "metadata": { "title": "Get a Treasury wallet conversion", "description": "Returns the quote, source reservation, fee, trade, physical settlement legs, destination credit, and current state for one conversion." }, "content": "## What this endpoint does\n\nReturns the quote, source reservation, fee, trade, physical settlement legs, destination credit, and current state for one conversion.\n\n## When to use it\n\nUse it after a webhook, timeout, recovery event, or support question to determine which leg has completed and whether funds are spendable.\n\n## Before you call\n\nAuthenticate with `treasury:read` and pass a conversion ID owned by the same tenant account.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nDestination funds are spendable only after the conversion settles and the destination wallet credit exists. Held or unknown legs require reconciliation, not a duplicate conversion.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Conversions and withdrawals](/treasury/conversions-and-withdrawals) for the complete workflow." }, "x-wayex-explainer": { "guide": "/treasury/conversions-and-withdrawals", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/rates": { "get": { "description": "Returns the current indicative all-in rate for an AUD and stablecoin pair. It is useful for estimates and display only. Call it before showing an estimate. Do not treat the response as a locked quote: direct payment routes price when funds arrive, while Treasury conversions use a conversion quote.", "operationId": "RateController2_get_v1", "parameters": [ { "name": "source", "required": true, "in": "query", "schema": { "type": "string" } }, { "name": "destination", "required": true, "in": "query", "schema": { "type": "string" } }, { "name": "network", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "customer_id", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "counterparty_id", "required": false, "in": "query", "description": "Admin keys only: scope results to the given client account (counterparty). Non-admin callers passing this parameter receive `403` — it is never silently ignored.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The live indicative all-in rate (spread included).", "content": { "application/json": { "schema": { "type": "object", "properties": { "pair": { "description": "The asset pair this rate applies to, e.g. AUD/USDC.", "type": "string", "pattern": "^(AUD|USDC|USDT)\\/(AUD|USDC|USDT)$" }, "source": { "description": "The asset being converted from.", "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "destination": { "description": "The asset being converted to.", "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "network": { "description": "The network for the crypto leg, when relevant.", "type": "string", "enum": [ "ethereum", "base", "arbitrum", "optimism", "polygon", "bsc", "avalanche", "solana", "tron" ] }, "rate": { "description": "The indicative price as a decimal string (units of destination per unit of source). It is all-in — Wayex's spread is already inside it. Indicative only — the binding price is struck at funding.", "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "inverseRate": { "description": "The exact reciprocal of `rate` (units of source per 1 unit of destination) — the same spread-inclusive price expressed in the opposite quote convention, computed server-side (ADR-0007: clients render it verbatim, never derive it). Display convenience only — indicative, never binds. OPTIONAL so cached payloads without it stay valid.", "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "asOf": { "description": "When this indicative rate was observed (ISO 8601).", "type": "string", "format": "date-time" } }, "required": [ "pair", "source", "destination", "rate", "asOf" ] } } } }, "400": { "description": "Missing or unsupported source/destination asset." }, "403": { "description": "counterparty_id passed with a non-admin key." } }, "summary": "Get an indicative exchange rate", "tags": [ "Rates" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/rates/get-an-indicative-rate", "metadata": { "title": "Get an indicative exchange rate", "description": "Returns the current indicative all-in rate for an AUD and stablecoin pair. It is useful for estimates and display only." }, "content": "## What this endpoint does\n\nReturns the current indicative all-in rate for an AUD and stablecoin pair. It is useful for estimates and display only.\n\n## When to use it\n\nCall it before showing an estimate. Do not treat the response as a locked quote: direct payment routes price when funds arrive, while Treasury conversions use a conversion quote.\n\n## Before you call\n\nAuthenticate with an API key that can read this resource. Results are restricted to the tenant account bound to that key.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nA successful response is a point-in-time indication. It does not create an operation and has no settlement status.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Quickstart](/quickstart) for the complete workflow." }, "x-wayex-explainer": { "guide": "/quickstart", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/developer-fees": { "get": { "description": "Returns the developer fee schedule applied to eligible future direct-route conversions. Use it to display the current flat and basis-point fee configuration.", "operationId": "DeveloperFeesController2_get_v1", "parameters": [], "responses": { "200": { "description": "Your current developer fee schedule.", "content": { "application/json": { "schema": { "type": "object", "properties": { "counterpartyId": { "type": "string", "minLength": 1 }, "transfer": { "type": "object", "properties": { "flatAud": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "bps": { "type": "integer", "minimum": 0, "exclusiveMinimum": false, "maximum": 10000, "exclusiveMaximum": false } } }, "updatedAt": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string", "minLength": 1 } }, "required": [ "counterpartyId", "updatedAt", "updatedBy" ] } } } } }, "summary": "Get the developer fee schedule", "tags": [ "Fees" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/fees/get-developer-fees", "metadata": { "title": "Get the developer fee schedule", "description": "Returns the developer fee schedule applied to eligible future direct-route conversions." }, "content": "## What this endpoint does\n\nReturns the developer fee schedule applied to eligible future direct-route conversions.\n\n## When to use it\n\nUse it to display the current flat and basis-point fee configuration.\n\n## Before you call\n\nAuthenticate with an API key that can read this resource. Results are restricted to the tenant account bound to that key.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nThe response is the effective schedule at read time. It does not reprice transfers already in progress.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Developer settings](/console/developers) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/developers", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } }, "put": { "description": "Replaces the developer fee schedule used for eligible future direct-route conversions. Use it when changing the flat amount, basis-point amount, or removing the schedule.", "operationId": "DeveloperFeesController2_set_v1", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique key for this logical action. Reuse the same key and identical payload when retrying after an unknown response.", "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "example": "13bda8d7-87bd-4fa4-b7d5-e740725f9bd2" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetDeveloperFeesDto" } } } }, "responses": { "200": { "description": "The updated developer fee schedule.", "content": { "application/json": { "schema": { "type": "object", "properties": { "counterpartyId": { "type": "string", "minLength": 1 }, "transfer": { "type": "object", "properties": { "flatAud": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "bps": { "type": "integer", "minimum": 0, "exclusiveMinimum": false, "maximum": 10000, "exclusiveMaximum": false } } }, "updatedAt": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string", "minLength": 1 } }, "required": [ "counterpartyId", "updatedAt", "updatedBy" ] } } } }, "400": { "description": "Validation failed." }, "401": { "description": "Missing or invalid secret API key." }, "403": { "description": "No fresh second factor was presented (`step_up_required`)." }, "422": { "description": "The fee exceeds the allowed caps (developer_fee_over_cap); nothing was stored." } }, "summary": "Set the developer fee schedule", "tags": [ "Fees" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/fees/set-developer-fees", "metadata": { "title": "Set the developer fee schedule", "description": "Replaces the developer fee schedule used for eligible future direct-route conversions." }, "content": "## What this endpoint does\n\nReplaces the developer fee schedule used for eligible future direct-route conversions.\n\n## When to use it\n\nUse it when changing the flat amount, basis-point amount, or removing the schedule.\n\n## Before you call\n\nRequires a secret API key plus a recent second-factor (MFA) confirmation from the signed-in user — a request authenticated only with an API key is refused with `403 step_up_required`. In practice, change the schedule from a console session and send the complete desired schedule.\n\n## Money and balance effect\n\nThis does not debit a wallet immediately. The new schedule affects eligible conversions created after the change.\n\n## States and completion\n\nA successful response confirms the saved schedule. In-flight transfers keep the pricing captured for them.\n\n## Safe retries\n\nSend a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out.\n\nRead [Developer settings](/console/developers) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/developers", "moneyEffect": "This does not debit a wallet immediately. The new schedule affects eligible conversions created after the change.", "retry": "Send a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out." } } }, "/v1/invoices": { "get": { "description": "Lists invoices issued to the current tenant account. Use it to reconcile billing periods, platform fees, developer-fee credits, and payment status.", "operationId": "InvoicesController2_list_v1", "parameters": [ { "name": "status", "required": false, "in": "query", "schema": { "enum": [ "issued", "settled" ], "type": "string" } }, { "name": "cursor", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "schema": { "example": 25, "type": "number" } } ], "responses": { "200": { "description": "A cursor-paginated page of your invoices.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "description": "The page of results, newest first.", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "number": { "type": "string", "pattern": "^INV-\\d{6}-\\d{4}$" }, "counterpartyId": { "type": "string", "minLength": 1 }, "periodFrom": { "type": "string", "format": "date-time" }, "periodTo": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "draft", "issued", "settled", "void" ] }, "currency": { "type": "string", "enum": [ "AUD" ] }, "lines": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "kyc", "kyb", "virtual_account", "transfer", "developer_credit", "tax" ] }, "description": { "type": "string", "minLength": 1 }, "count": { "type": "integer", "minimum": 0, "exclusiveMinimum": false }, "amount": { "type": "string", "pattern": "^-?\\d+(\\.\\d+)?$" }, "amountMinor": { "type": "string", "pattern": "^-?\\d+$" } }, "required": [ "type", "description", "count", "amount", "amountMinor" ] } }, "platformFeesDue": { "type": "string", "pattern": "^-?\\d+(\\.\\d+)?$" }, "platformFeesDueMinor": { "type": "string", "pattern": "^-?\\d+$" }, "developerFeesCredit": { "type": "string", "pattern": "^-?\\d+(\\.\\d+)?$" }, "developerFeesCreditMinor": { "type": "string", "pattern": "^-?\\d+$" }, "tax": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "taxMinor": { "type": "string", "pattern": "^\\d+$" }, "netDue": { "type": "string", "pattern": "^-?\\d+(\\.\\d+)?$" }, "netDueMinor": { "type": "string", "pattern": "^-?\\d+$" }, "inflowCollected": { "type": "array", "items": { "type": "object", "properties": { "asset": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "amountMinor": { "type": "string", "pattern": "^\\d+$" }, "count": { "type": "integer", "minimum": 0, "exclusiveMinimum": false } }, "required": [ "asset", "amount", "amountMinor", "count" ] } }, "generatedAt": { "type": "string", "format": "date-time" }, "generatedBy": { "type": "string", "minLength": 1 }, "issuedAt": { "type": "string", "format": "date-time" }, "issuedBy": { "type": "string", "minLength": 1 }, "settledAt": { "type": "string", "format": "date-time" }, "settledBy": { "type": "string", "minLength": 1 }, "voidedAt": { "type": "string", "format": "date-time" }, "voidedBy": { "type": "string", "minLength": 1 } }, "required": [ "id", "number", "counterpartyId", "periodFrom", "periodTo", "status", "currency", "lines", "platformFeesDue", "platformFeesDueMinor", "developerFeesCredit", "developerFeesCreditMinor", "tax", "taxMinor", "netDue", "netDueMinor", "inflowCollected", "generatedAt", "generatedBy" ] } }, "hasMore": { "type": "boolean", "description": "Whether a further page exists after this one." }, "nextCursor": { "type": "string", "nullable": true, "description": "Opaque cursor to pass as `cursor` to fetch the next page, or null at the end." } }, "required": [ "data", "hasMore", "nextCursor" ] } } } } }, "summary": "List invoices", "tags": [ "Invoices" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/invoices/list-invoices", "metadata": { "title": "List invoices", "description": "Lists invoices issued to the current tenant account." }, "content": "## What this endpoint does\n\nLists invoices issued to the current tenant account.\n\n## When to use it\n\nUse it to reconcile billing periods, platform fees, developer-fee credits, and payment status.\n\n## Before you call\n\nAuthenticate with an API key that can read fees — a scoped key must include `fees:read` (`fees:write` implies it); this family also covers revenue and invoices.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nOnly `issued` and `settled` invoices appear here — `issued` means awaiting settlement; `settled` is final. The schema’s `draft` and `void` values are internal states that are never returned on this endpoint. Open the invoice for its line-item detail.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Revenue and invoices](/console/activity) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/activity", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/invoices/{id}": { "get": { "description": "Returns line items and status for one invoice. Use it for invoice detail, accounting export, or support investigation.", "operationId": "InvoicesController2_get_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The invoice.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "number": { "type": "string", "pattern": "^INV-\\d{6}-\\d{4}$" }, "counterpartyId": { "type": "string", "minLength": 1 }, "periodFrom": { "type": "string", "format": "date-time" }, "periodTo": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "draft", "issued", "settled", "void" ] }, "currency": { "type": "string", "enum": [ "AUD" ] }, "lines": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "kyc", "kyb", "virtual_account", "transfer", "developer_credit", "tax" ] }, "description": { "type": "string", "minLength": 1 }, "count": { "type": "integer", "minimum": 0, "exclusiveMinimum": false }, "amount": { "type": "string", "pattern": "^-?\\d+(\\.\\d+)?$" }, "amountMinor": { "type": "string", "pattern": "^-?\\d+$" } }, "required": [ "type", "description", "count", "amount", "amountMinor" ] } }, "platformFeesDue": { "type": "string", "pattern": "^-?\\d+(\\.\\d+)?$" }, "platformFeesDueMinor": { "type": "string", "pattern": "^-?\\d+$" }, "developerFeesCredit": { "type": "string", "pattern": "^-?\\d+(\\.\\d+)?$" }, "developerFeesCreditMinor": { "type": "string", "pattern": "^-?\\d+$" }, "tax": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "taxMinor": { "type": "string", "pattern": "^\\d+$" }, "netDue": { "type": "string", "pattern": "^-?\\d+(\\.\\d+)?$" }, "netDueMinor": { "type": "string", "pattern": "^-?\\d+$" }, "inflowCollected": { "type": "array", "items": { "type": "object", "properties": { "asset": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "amountMinor": { "type": "string", "pattern": "^\\d+$" }, "count": { "type": "integer", "minimum": 0, "exclusiveMinimum": false } }, "required": [ "asset", "amount", "amountMinor", "count" ] } }, "generatedAt": { "type": "string", "format": "date-time" }, "generatedBy": { "type": "string", "minLength": 1 }, "issuedAt": { "type": "string", "format": "date-time" }, "issuedBy": { "type": "string", "minLength": 1 }, "settledAt": { "type": "string", "format": "date-time" }, "settledBy": { "type": "string", "minLength": 1 }, "voidedAt": { "type": "string", "format": "date-time" }, "voidedBy": { "type": "string", "minLength": 1 } }, "required": [ "id", "number", "counterpartyId", "periodFrom", "periodTo", "status", "currency", "lines", "platformFeesDue", "platformFeesDueMinor", "developerFeesCredit", "developerFeesCreditMinor", "tax", "taxMinor", "netDue", "netDueMinor", "inflowCollected", "generatedAt", "generatedBy" ] } } } }, "404": { "description": "No such invoice for this account." } }, "summary": "Get an invoice", "tags": [ "Invoices" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/invoices/get-an-invoice", "metadata": { "title": "Get an invoice", "description": "Returns line items and status for one invoice." }, "content": "## What this endpoint does\n\nReturns line items and status for one invoice.\n\n## When to use it\n\nUse it for invoice detail, accounting export, or support investigation.\n\n## Before you call\n\nAuthenticate with an API key that can read fees — a scoped key must include `fees:read` (`fees:write` implies it); this family also covers revenue and invoices — and pass an invoice ID owned by the same tenant account.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nUse the invoice status and amounts as returned; a listed invoice is not necessarily settled.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Revenue and invoices](/console/activity) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/activity", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/revenue": { "get": { "description": "Returns developer-fee revenue earned by the current tenant account. Use it to build fee-revenue reporting: group by `period` (`day`, `week`, or `month`; default `day`), and optionally bound the window with `from`/`to` or filter by `asset`. Amounts are decimal strings with an explicit asset code. Pair it with `GET /v1/invoices` to reconcile the developer-fee credits netted off each invoice.", "operationId": "RevenueController2_revenue__v1", "parameters": [ { "name": "period", "required": false, "in": "query", "schema": { "enum": [ "day", "week", "month" ], "type": "string" } }, { "name": "from", "required": false, "in": "query", "schema": { "format": "date-time", "type": "string" } }, { "name": "to", "required": false, "in": "query", "schema": { "format": "date-time", "type": "string" } }, { "name": "asset", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "counterpartyId", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The revenue report for the requested window.", "content": { "application/json": { "schema": { "type": "object", "properties": { "period": { "type": "string", "enum": [ "day", "week", "month" ] }, "from": { "type": "string", "nullable": true }, "to": { "type": "string", "nullable": true }, "scope": { "type": "string", "enum": [ "admin", "counterparty" ] }, "totals": { "type": "array", "items": { "type": "object", "properties": { "asset": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "amountMinor": { "type": "string", "pattern": "^\\d+$" }, "transferCount": { "type": "integer", "minimum": 0, "exclusiveMinimum": false } }, "required": [ "asset", "amount", "amountMinor", "transferCount" ] } }, "byAsset": { "type": "array", "items": { "type": "object", "properties": { "asset": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "amountMinor": { "type": "string", "pattern": "^\\d+$" }, "transferCount": { "type": "integer", "minimum": 0, "exclusiveMinimum": false } }, "required": [ "asset", "amount", "amountMinor", "transferCount" ] } }, "byCounterparty": { "type": "array", "items": { "type": "object", "properties": { "counterpartyId": { "type": "string", "minLength": 1 }, "amounts": { "type": "array", "items": { "type": "object", "properties": { "asset": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "amountMinor": { "type": "string", "pattern": "^\\d+$" }, "transferCount": { "type": "integer", "minimum": 0, "exclusiveMinimum": false } }, "required": [ "asset", "amount", "amountMinor", "transferCount" ] } } }, "required": [ "counterpartyId", "amounts" ] } }, "series": { "type": "array", "items": { "type": "object", "properties": { "periodStart": { "type": "string", "minLength": 1 }, "amounts": { "type": "array", "items": { "type": "object", "properties": { "asset": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "amountMinor": { "type": "string", "pattern": "^\\d+$" }, "transferCount": { "type": "integer", "minimum": 0, "exclusiveMinimum": false } }, "required": [ "asset", "amount", "amountMinor", "transferCount" ] } } }, "required": [ "periodStart", "amounts" ] } }, "generatedAt": { "type": "string", "format": "date-time" } }, "required": [ "period", "from", "to", "scope", "totals", "byAsset", "byCounterparty", "series", "generatedAt" ] } } } }, "400": { "description": "Invalid query parameters." } }, "summary": "Get developer-fee revenue", "tags": [ "Revenue" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/revenue/get-revenue", "metadata": { "title": "Get developer-fee revenue", "description": "Returns developer-fee revenue earned by the current tenant account." }, "content": "## What this endpoint does\n\nReturns developer-fee revenue earned by the current tenant account.\n\n## When to use it\n\nUse it to build fee-revenue reporting: group by `period` (`day`, `week`, or `month`; default `day`), and optionally bound the window with `from`/`to` or filter by `asset`. Amounts are decimal strings with an explicit asset code. Pair it with `GET /v1/invoices` to reconcile the developer-fee credits netted off each invoice.\n\n## Before you call\n\nAuthenticate with an API key that can read fees — a scoped key must include `fees:read` (`fees:write` implies it); this family also covers revenue and invoices.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nRevenue appears according to completed conversion and billing records; unsettled transfers may not yet contribute.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Revenue and invoices](/console/activity) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/activity", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/reports/revenue": { "get": { "description": "Returns the same developer-fee revenue report through the reports namespace. Use it only when your integration groups reporting endpoints under `/reports`; new integrations can use `/v1/revenue`.", "operationId": "RevenueController2_reportsRevenue_v1", "parameters": [ { "name": "period", "required": false, "in": "query", "schema": { "enum": [ "day", "week", "month" ], "type": "string" } }, { "name": "from", "required": false, "in": "query", "schema": { "format": "date-time", "type": "string" } }, { "name": "to", "required": false, "in": "query", "schema": { "format": "date-time", "type": "string" } }, { "name": "asset", "required": false, "in": "query", "schema": { "type": "string" } }, { "name": "counterpartyId", "required": false, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The revenue report for the requested window.", "content": { "application/json": { "schema": { "type": "object", "properties": { "period": { "type": "string", "enum": [ "day", "week", "month" ] }, "from": { "type": "string", "nullable": true }, "to": { "type": "string", "nullable": true }, "scope": { "type": "string", "enum": [ "admin", "counterparty" ] }, "totals": { "type": "array", "items": { "type": "object", "properties": { "asset": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "amountMinor": { "type": "string", "pattern": "^\\d+$" }, "transferCount": { "type": "integer", "minimum": 0, "exclusiveMinimum": false } }, "required": [ "asset", "amount", "amountMinor", "transferCount" ] } }, "byAsset": { "type": "array", "items": { "type": "object", "properties": { "asset": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "amountMinor": { "type": "string", "pattern": "^\\d+$" }, "transferCount": { "type": "integer", "minimum": 0, "exclusiveMinimum": false } }, "required": [ "asset", "amount", "amountMinor", "transferCount" ] } }, "byCounterparty": { "type": "array", "items": { "type": "object", "properties": { "counterpartyId": { "type": "string", "minLength": 1 }, "amounts": { "type": "array", "items": { "type": "object", "properties": { "asset": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "amountMinor": { "type": "string", "pattern": "^\\d+$" }, "transferCount": { "type": "integer", "minimum": 0, "exclusiveMinimum": false } }, "required": [ "asset", "amount", "amountMinor", "transferCount" ] } } }, "required": [ "counterpartyId", "amounts" ] } }, "series": { "type": "array", "items": { "type": "object", "properties": { "periodStart": { "type": "string", "minLength": 1 }, "amounts": { "type": "array", "items": { "type": "object", "properties": { "asset": { "type": "string", "enum": [ "AUD", "USDC", "USDT" ] }, "amount": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "amountMinor": { "type": "string", "pattern": "^\\d+$" }, "transferCount": { "type": "integer", "minimum": 0, "exclusiveMinimum": false } }, "required": [ "asset", "amount", "amountMinor", "transferCount" ] } } }, "required": [ "periodStart", "amounts" ] } }, "generatedAt": { "type": "string", "format": "date-time" } }, "required": [ "period", "from", "to", "scope", "totals", "byAsset", "byCounterparty", "series", "generatedAt" ] } } } }, "400": { "description": "Invalid query parameters." } }, "summary": "Get developer-fee revenue (alias)", "tags": [ "Revenue" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/revenue/get-revenue-alias", "metadata": { "title": "Get developer-fee revenue (alias)", "description": "Returns the same developer-fee revenue report through the reports namespace." }, "content": "## What this endpoint does\n\nReturns the same developer-fee revenue report through the reports namespace.\n\n## When to use it\n\nUse it only when your integration groups reporting endpoints under `/reports`; new integrations can use `/v1/revenue`.\n\n## Before you call\n\nAuthenticate with an API key that can read fees — a scoped key must include `fees:read` (`fees:write` implies it); this family also covers revenue and invoices.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nRevenue appears according to completed conversion and billing records; unsettled transfers may not yet contribute.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [Revenue and invoices](/console/activity) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/activity", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/api-keys": { "post": { "description": "Creates a tenant-bound API key with the requested type and access restrictions. Create a separate key for each service or integration boundary so it can be rotated independently.", "operationId": "ApiKeyController2_create_v1", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique key for this logical action. Reuse the same key and identical payload when retrying after an unknown response.", "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "example": "13bda8d7-87bd-4fa4-b7d5-e740725f9bd2" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyDto" } } } }, "responses": { "201": { "description": "The created key, including the plaintext secret (shown once).", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "counterpartyId": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "enum": [ "secret", "publishable" ] }, "name": { "type": "string", "minLength": 1 }, "maskedKey": { "type": "string", "minLength": 1 }, "lastFour": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "revoked" ] }, "createdAt": { "type": "string", "format": "date-time" }, "revokedAt": { "type": "string", "format": "date-time" }, "rotatedToId": { "type": "string", "minLength": 1 }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "customers:read", "customers:write", "routes:read", "routes:write", "transfers:read", "transfers:write", "treasury:read", "treasury:write", "rates:read", "webhooks:read", "webhooks:write", "fees:read", "fees:write", "keys:read", "keys:write", "settings:read", "settings:write", "team:read", "team:write" ] } }, "allowedIps": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 49, "pattern": "^[0-9a-fA-F:.]+(\\/\\d{1,3})?$" } }, "secret": { "type": "string", "minLength": 1 } }, "required": [ "id", "counterpartyId", "kind", "name", "maskedKey", "lastFour", "status", "createdAt", "secret" ] } } } }, "400": { "description": "Validation failed." }, "401": { "description": "Missing or invalid secret API key." }, "403": { "description": "No fresh second factor was presented (`step_up_required`)." } }, "summary": "Create an API key", "tags": [ "API keys" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/api-keys/create-an-api-key", "metadata": { "title": "Create an API key", "description": "Creates a tenant-bound API key with the requested type and access restrictions." }, "content": "## What this endpoint does\n\nCreates a tenant-bound API key with the requested type and access restrictions.\n\n## When to use it\n\nCreate a separate key for each service or integration boundary so it can be rotated independently.\n\n## Before you call\n\nCreate keys from a console session with API-key administration access and a recent second-factor (MFA) confirmation — a request authenticated only with an API key is refused with `403 step_up_required`. Grant only the access the new integration needs.\n\n## Money and balance effect\n\nThis changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.\n\n## States and completion\n\nThe full secret is returned once. Store it immediately; later reads return metadata only.\n\n## Safe retries\n\nSend a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out.\n\nRead [API keys](/console/developers) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/developers", "moneyEffect": "This changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.", "retry": "Send a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out." } }, "get": { "description": "Lists API-key metadata for the current tenant account without returning secret values. Use it to audit access, locate a key for rotation, or review its role and restrictions.", "operationId": "ApiKeyController2_list_v1", "parameters": [], "responses": { "200": { "description": "Your API keys, with secrets masked.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "counterpartyId": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "enum": [ "secret", "publishable" ] }, "name": { "type": "string", "minLength": 1 }, "maskedKey": { "type": "string", "minLength": 1 }, "lastFour": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "revoked" ] }, "createdAt": { "type": "string", "format": "date-time" }, "revokedAt": { "type": "string", "format": "date-time" }, "rotatedToId": { "type": "string", "minLength": 1 }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "customers:read", "customers:write", "routes:read", "routes:write", "transfers:read", "transfers:write", "treasury:read", "treasury:write", "rates:read", "webhooks:read", "webhooks:write", "fees:read", "fees:write", "keys:read", "keys:write", "settings:read", "settings:write", "team:read", "team:write" ] } }, "allowedIps": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 49, "pattern": "^[0-9a-fA-F:.]+(\\/\\d{1,3})?$" } } }, "required": [ "id", "counterpartyId", "kind", "name", "maskedKey", "lastFour", "status", "createdAt" ] } } }, "required": [ "data" ] } } } } }, "summary": "List API keys", "tags": [ "API keys" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/api-keys/list-api-keys", "metadata": { "title": "List API keys", "description": "Lists API-key metadata for the current tenant account without returning secret values." }, "content": "## What this endpoint does\n\nLists API-key metadata for the current tenant account without returning secret values.\n\n## When to use it\n\nUse it to audit access, locate a key for rotation, or review its role and restrictions.\n\n## Before you call\n\nAuthenticate with an API key that can read this resource. Results are restricted to the tenant account bound to that key.\n\n## Money and balance effect\n\nThis is a read-only request. It does not reserve, debit, credit, or settle money.\n\n## States and completion\n\nEach key’s `status` is `active` or `revoked`. Restrictions are reported separately in the optional `scopes` and `allowedIps` fields — a key without them has full role-implied access from any IP. Secret material is never recoverable from this endpoint.\n\n## Safe retries\n\nGET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`.\n\nRead [API keys](/console/developers) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/developers", "moneyEffect": "This is a read-only request. It does not reserve, debit, credit, or settle money.", "retry": "GET requests are read-only and may be retried with normal exponential backoff. Do not send an `Idempotency-Key`." } } }, "/v1/api-keys/{id}": { "patch": { "description": "Changes supported restrictions on an existing API key. Use it to reduce or adjust access without issuing another key.", "operationId": "ApiKeyController2_update_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateApiKeyDto" } } } }, "responses": { "200": { "description": "The updated key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "counterpartyId": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "enum": [ "secret", "publishable" ] }, "name": { "type": "string", "minLength": 1 }, "maskedKey": { "type": "string", "minLength": 1 }, "lastFour": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "revoked" ] }, "createdAt": { "type": "string", "format": "date-time" }, "revokedAt": { "type": "string", "format": "date-time" }, "rotatedToId": { "type": "string", "minLength": 1 }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "customers:read", "customers:write", "routes:read", "routes:write", "transfers:read", "transfers:write", "treasury:read", "treasury:write", "rates:read", "webhooks:read", "webhooks:write", "fees:read", "fees:write", "keys:read", "keys:write", "settings:read", "settings:write", "team:read", "team:write" ] } }, "allowedIps": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 49, "pattern": "^[0-9a-fA-F:.]+(\\/\\d{1,3})?$" } } }, "required": [ "id", "counterpartyId", "kind", "name", "maskedKey", "lastFour", "status", "createdAt" ] } } } }, "400": { "description": "Validation failed (e.g. `invalid_cidr`)." }, "403": { "description": "No fresh second factor was presented (`step_up_required`)." }, "404": { "description": "No such API key for this account." } }, "summary": "Update API-key restrictions", "tags": [ "API keys" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/api-keys/update-key-restrictions", "metadata": { "title": "Update API-key restrictions", "description": "Changes supported restrictions on an existing API key." }, "content": "## What this endpoint does\n\nChanges supported restrictions on an existing API key.\n\n## When to use it\n\nUse it to reduce or adjust access without issuing another key.\n\n## Before you call\n\nManage keys from a console session with a recent second-factor (MFA) confirmation — a request authenticated only with an API key is refused with `403 step_up_required` — and pass a key ID owned by the same tenant account.\n\n## Money and balance effect\n\nThis changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.\n\n## States and completion\n\nA successful response makes the new restrictions effective for later requests. Existing requests are not replayed.\n\n## Safe retries\n\nPATCH does not use an `Idempotency-Key`. After an unknown response, list the key and compare its restrictions before retrying the identical update.\n\nRead [API keys](/console/developers) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/developers", "moneyEffect": "This changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.", "retry": "PATCH does not use an `Idempotency-Key`. After an unknown response, list the key and compare its restrictions before retrying the identical update." } }, "delete": { "description": "Revokes an API key so it can no longer authenticate new requests. Revoke a key when an integration is retired, compromised, or replaced.", "operationId": "ApiKeyController2_revoke_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The revoked key.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "counterpartyId": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "enum": [ "secret", "publishable" ] }, "name": { "type": "string", "minLength": 1 }, "maskedKey": { "type": "string", "minLength": 1 }, "lastFour": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "revoked" ] }, "createdAt": { "type": "string", "format": "date-time" }, "revokedAt": { "type": "string", "format": "date-time" }, "rotatedToId": { "type": "string", "minLength": 1 }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "customers:read", "customers:write", "routes:read", "routes:write", "transfers:read", "transfers:write", "treasury:read", "treasury:write", "rates:read", "webhooks:read", "webhooks:write", "fees:read", "fees:write", "keys:read", "keys:write", "settings:read", "settings:write", "team:read", "team:write" ] } }, "allowedIps": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 49, "pattern": "^[0-9a-fA-F:.]+(\\/\\d{1,3})?$" } } }, "required": [ "id", "counterpartyId", "kind", "name", "maskedKey", "lastFour", "status", "createdAt" ] } } } }, "403": { "description": "No fresh second factor was presented (`step_up_required`)." }, "404": { "description": "No such API key for this account." } }, "summary": "Revoke an API key", "tags": [ "API keys" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/api-keys/revoke-an-api-key", "metadata": { "title": "Revoke an API key", "description": "Revokes an API key so it can no longer authenticate new requests." }, "content": "## What this endpoint does\n\nRevokes an API key so it can no longer authenticate new requests.\n\n## When to use it\n\nRevoke a key when an integration is retired, compromised, or replaced.\n\n## Before you call\n\nManage keys from a console session with a recent second-factor (MFA) confirmation — a request authenticated only with an API key is refused with `403 step_up_required` — and pass a key ID owned by the same tenant account. Ensure another administrator key remains available.\n\n## Money and balance effect\n\nThis changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.\n\n## States and completion\n\nRevocation is the terminal key state. It does not cancel money operations already accepted.\n\n## Safe retries\n\nDELETE does not use an `Idempotency-Key`. If the response is lost, list the key first. An already revoked or absent key means there is no active credential left to revoke.\n\nRead [API keys](/console/developers) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/developers", "moneyEffect": "This changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.", "retry": "DELETE does not use an `Idempotency-Key`. If the response is lost, list the key first. An already revoked or absent key means there is no active credential left to revoke." } } }, "/v1/api-keys/{id}/rotate": { "post": { "description": "Issues a replacement API key that inherits the retiring key’s scopes and IP allow-list. The replacement has a new key ID; the retired key becomes status `revoked` with `rotatedToId` pointing at its replacement. Rotate routinely and immediately after suspected exposure.", "operationId": "ApiKeyController2_rotate_v1", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "A unique key for this logical action. Reuse the same key and identical payload when retrying after an unknown response.", "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "example": "13bda8d7-87bd-4fa4-b7d5-e740725f9bd2" } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateApiKeyDto" } } } }, "responses": { "201": { "description": "The replacement key, including the new plaintext secret (shown once).", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "counterpartyId": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "enum": [ "secret", "publishable" ] }, "name": { "type": "string", "minLength": 1 }, "maskedKey": { "type": "string", "minLength": 1 }, "lastFour": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "revoked" ] }, "createdAt": { "type": "string", "format": "date-time" }, "revokedAt": { "type": "string", "format": "date-time" }, "rotatedToId": { "type": "string", "minLength": 1 }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "customers:read", "customers:write", "routes:read", "routes:write", "transfers:read", "transfers:write", "treasury:read", "treasury:write", "rates:read", "webhooks:read", "webhooks:write", "fees:read", "fees:write", "keys:read", "keys:write", "settings:read", "settings:write", "team:read", "team:write" ] } }, "allowedIps": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 49, "pattern": "^[0-9a-fA-F:.]+(\\/\\d{1,3})?$" } }, "secret": { "type": "string", "minLength": 1 } }, "required": [ "id", "counterpartyId", "kind", "name", "maskedKey", "lastFour", "status", "createdAt", "secret" ] } } } }, "403": { "description": "No fresh second factor was presented (`step_up_required`)." }, "404": { "description": "No such API key for this account." } }, "summary": "Rotate an API key", "tags": [ "API keys" ], "security": [ { "Bearer": [] }, { "ApiKey": [] } ], "x-mint": { "href": "/api-reference/api-keys/rotate-an-api-key", "metadata": { "title": "Rotate an API key", "description": "Issues a replacement API key that inherits the retiring key’s scopes and IP allow-list. The replacement has a new key ID; the retired key becomes status `revoked` with `rotatedToId` pointing at its replacement." }, "content": "## What this endpoint does\n\nIssues a replacement API key that inherits the retiring key’s scopes and IP allow-list. The replacement has a new key ID; the retired key becomes status `revoked` with `rotatedToId` pointing at its replacement.\n\n## When to use it\n\nRotate routinely and immediately after suspected exposure.\n\n## Before you call\n\nManage keys from a console session with a recent second-factor (MFA) confirmation — a request authenticated only with an API key is refused with `403 step_up_required` — and pass a key ID owned by the same tenant account. Prepare to update the consuming service.\n\n## Money and balance effect\n\nThis changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.\n\n## States and completion\n\nThe new secret is returned once, on this response only. The old secret stops authenticating the moment rotation succeeds — there is no grace period. Update stored key IDs as well as the secret: later update or revoke calls must target the replacement key’s ID.\n\n## Safe retries\n\nSend a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out.\n\nRead [API keys](/console/developers) for the complete workflow." }, "x-wayex-explainer": { "guide": "/console/developers", "moneyEffect": "This changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.", "retry": "Send a unique `Idempotency-Key` for the logical action. If the response is lost, retry the same payload with the same key; never create a new key merely because the first response timed out." } } } }, "info": { "title": "Wayex API", "description": "Wayex APIs for direct customer payment routes and isolated, prefunded Treasury accounts. Each API key is bound to one tenant account and its own wallet, settings, webhooks, and reporting.", "version": "1.0.0", "contact": {} }, "tags": [ { "name": "Treasury", "description": "Prefunded AUD and stablecoin wallets for one isolated tenant account. Fund, pay, convert, withdraw, track, and reconcile without selecting another account." }, { "name": "Customers", "description": "Onboard end customers, run verification, and manage each customer's entitlements." }, { "name": "Payment routes", "description": "Standing deposit instructions per customer. When a customer funds a route, Wayex auto-converts at the live rate and pays out/sends — no quote, no lock." }, { "name": "Transfers", "description": "Read the conversion records produced when customers fund payment routes — the live activity feed and per-conversion lifecycle timeline." }, { "name": "Rates", "description": "The live indicative AUD↔stablecoin rate right now — the all-in rate Wayex quotes. Indicative only; the binding price is struck when a route's funds land." }, { "name": "Revenue", "description": "Your developer-fee revenue over time." }, { "name": "Invoices", "description": "Your monthly invoices — Wayex platform fees due, net of your accrued developer-fee credit." }, { "name": "Webhooks", "description": "Subscribe to HMAC-signed event webhooks and inspect deliveries." }, { "name": "API keys", "description": "Create, list, and rotate API keys for programmatic access." }, { "name": "Fees", "description": "Configure your developer fee — the markup withheld from each conversion and credited against your monthly invoice." }, { "name": "Invitations", "description": "Accept a team invitation and activate your account." }, { "name": "Team", "description": "Manage your own team — list members and send console invitations." }, { "name": "Notification settings", "description": "Manage whether Wayex sends customer-facing notification emails on your behalf." } ], "servers": [ { "url": "https://api.sandbox.rails.wayex.com", "description": "Sandbox — fully simulated providers, no real funds move" }, { "url": "https://api.rails.wayex.com", "description": "Production — live rails, real funds move" } ], "components": { "securitySchemes": { "ApiKey": { "type": "apiKey", "in": "header", "name": "X-Api-Key", "description": "A Wayex API key. Use a secret key (`sk_…`) — it works on every endpoint. Publishable keys (`pk_…`) are accepted only on a small set of read endpoints: `GET /v1/rates`, `GET /v1/activity`, `GET /v1/developer-fees`, `GET /v1/revenue`, and `GET /v1/reports/revenue`." }, "Bearer": { "type": "http", "scheme": "bearer", "bearerFormat": "Wayex API key", "description": "Send the same Wayex API key as `Authorization: Bearer `." } }, "schemas": { "SubscribeWebhookDto": { "type": "object", "properties": { "url": { "description": "The HTTPS endpoint Wayex POSTs signed event deliveries to. Must be https and must resolve to a public address — private, loopback, link-local and metadata destinations are refused.", "type": "string", "format": "uri" }, "eventTypes": { "description": "The event types this subscription receives.", "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "counterparty.created", "counterparty.invited", "counterparty.activated", "customer.created", "kyc.updated", "payment_route.created", "payment_route.activity.created", "rate.updated", "quote.created", "transfer.created", "transfer.updated", "transfer.completed", "treasury.wallet.updated", "treasury.payin.updated", "treasury.deposit.updated", "treasury.payout.updated", "treasury.withdrawal.updated", "treasury.conversion.updated", "approval.created", "approval.resolved" ] } }, "secret": { "description": "The HMAC signing secret; stored encrypted and never returned in any response.", "type": "string", "minLength": 8 } }, "required": [ "url", "eventTypes", "secret" ] }, "CompleteInviteDto": { "type": "object", "properties": { "password": { "type": "string", "minLength": 12, "maxLength": 256 } }, "required": [ "password" ] }, "PatchCustomerDto": { "type": "object", "properties": { "contact": { "type": "object", "properties": { "email": { "description": "The customer's contact email address.", "type": "string", "format": "email" }, "name": { "description": "Optional display name for the customer.", "type": "string", "minLength": 1 } } }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SetDeveloperFeesDto": { "type": "object", "properties": { "transfer": { "type": "object", "properties": { "flatAud": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$" }, "bps": { "type": "integer", "minimum": 0, "exclusiveMinimum": false, "maximum": 10000, "exclusiveMaximum": false } } } } }, "CreateApiKeyDto": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "secret", "publishable" ] }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "scopes": { "type": "array", "minItems": 1, "maxItems": 21, "items": { "type": "string", "enum": [ "customers:read", "customers:write", "routes:read", "routes:write", "transfers:read", "transfers:write", "treasury:read", "treasury:write", "rates:read", "webhooks:read", "webhooks:write", "fees:read", "fees:write", "keys:read", "keys:write", "settings:read", "settings:write", "team:read", "team:write" ] } }, "allowedIps": { "type": "array", "minItems": 1, "maxItems": 50, "items": { "type": "string", "minLength": 1, "maxLength": 49, "pattern": "^[0-9a-fA-F:.]+(\\/\\d{1,3})?$" } } }, "required": [ "kind", "name" ] }, "UpdateApiKeyDto": { "type": "object", "properties": { "scopes": { "type": "array", "minItems": 1, "maxItems": 21, "items": { "type": "string", "enum": [ "customers:read", "customers:write", "routes:read", "routes:write", "transfers:read", "transfers:write", "treasury:read", "treasury:write", "rates:read", "webhooks:read", "webhooks:write", "fees:read", "fees:write", "keys:read", "keys:write", "settings:read", "settings:write", "team:read", "team:write" ] }, "nullable": true }, "allowedIps": { "type": "array", "minItems": 1, "maxItems": 50, "items": { "type": "string", "minLength": 1, "maxLength": 49, "pattern": "^[0-9a-fA-F:.]+(\\/\\d{1,3})?$" }, "nullable": true } } } } }, "security": [ { "Bearer": [] }, { "ApiKey": [] } ] }