Set payout details (admin)
Add or replace the payout bank details Scope3 uses to pay the storefront out by bank transfer: beneficiary name and address, account number or IBAN (write-only — reads return the last 4 characters), one bank identifier (Fedwire/ABA routing number, CHIPS ABA, SWIFT-BIC, or local bank code), and the payout currency. Admin-only.
Authorizations
API key or access token
Body
Legal name of the payout beneficiary — the account holder the bank pays, exactly as it appears on the bank account.
1 - 255Beneficiary street address, line 1.
1 - 255Beneficiary city.
1 - 128Beneficiary postal/ZIP code.
1 - 32Beneficiary country as an ISO 3166-1 alpha-2 code (e.g. "US", "GB").
^[A-Z]{2}$"US"
Which bank identifier system bankIdentifierValue uses: FEDWIRE_ABA (US Fedwire/ABA routing number, 9 digits), CHIPS_ABA (CHIPS ABA number, 9 digits), SWIFT_BIC (SWIFT/BIC code, 8 or 11 characters), or BANK_CODE (a local/domestic bank code for banks without a SWIFT-BIC).
FEDWIRE_ABA, CHIPS_ABA, SWIFT_BIC, BANK_CODE The bank identifier itself, matching bankIdentifierType: a 9-digit Fedwire/ABA routing number, a 9-digit CHIPS ABA number, an 8/11-character SWIFT-BIC, or a local bank code (1–34 letters/digits/dashes).
1 - 34Payout currency as a 3-letter uppercase ISO 4217 code — the currency Scope3 pays this account out in.
^[A-Z]{3}$"USD"
Beneficiary street address, line 2 (optional).
255Beneficiary state/province/region (optional).
128Bank account number OR IBAN (6–34 alphanumeric characters; spaces are stripped). Never returned in full by the API — reads expose only the last 4 characters. Required the first time payout details are set; may be omitted on later updates to keep the stored account number unchanged.
Response
Set payout details (admin)
Storefront billing configuration. Storefront billing setup is optional only for official Scope3 sales-adapter storefronts on existing downstream platform settlement agreements. Third-party sales agents and finished-product/pass-through sources are normal Interchange-cleared storefront sources and still require payout bank details. Seller-cleared settlement is not yet configurable for normal storefronts.