Skip to main content
PUT /api/v2/storefront/billing/payout-details Saves the bank account Interchange pays your storefront into. Payouts are made by bank transfer in your payout currency, executed by Interchange finance — there is no payment processor. Payout details on file are required for Interchange-cleared (agent) settlement. Seller-cleared settlement is not yet configurable for normal storefronts. Admin-only. Also available to agents as the set_payout_details operation, or in the UI under Settings → Billing. accountNumber accepts a bank account number or an IBAN. Exactly one bank identifier is set via the bankIdentifierType + bankIdentifierValue pair. Submitting again replaces the details on file; omitting accountNumber on a resubmit keeps the stored account number (it is write-only and never prefilled).

Request

Parameters

Response

Returns the full updated billing configuration with masked payout details:
The account number is write-only: it is encrypted at the application layer (AES-256-GCM) before storage, so the database never holds a plaintext account number, and it is never returned after save — reads expose accountNumberLast4 only. onboardingStatus is complete once payout details are on file. The same shape is returned by Get billing config and the get_billing_info operation.

Errors

  • 400 VALIDATION_ERROR — malformed accountNumber (must be 6–34 letters/digits), a bankIdentifierValue that doesn’t match its bankIdentifierType (e.g. a routing number that isn’t 9 digits), a lowercase or non-ISO countryCode/currency, or a missing required field.
See Errors for the full error contract.

Billing tasks

All billing operations

Get billing config

Confirm the masked details on file

Billing overview

How payouts work and why bank details are needed

Get readiness

The billing_setup check this satisfies