> ## Documentation Index > Fetch the complete documentation index at: https://docs.caratuva.com/llms.txt > Use this file to discover all available pages before exploring further. # Register a seller's PIX payout destination > Register a seller end client's PIX payout destination at the settlement partner. The settlement partner infers the PIX key type from its format and returns an opaque bank-account id; Caratuva persists only that id — the raw PIX key is never stored. Sellers only, and the account must be `approved` first (a receiver is required). Configuring this can flip the seller to `readyToCollect`. ## OpenAPI ````yaml https://api.caratuva.com/docs-json post /v1/accounts/{id}/payout-config openapi: 3.0.0 info: title: Caratuva API description: >- Cross-border B2B payments. Fiat on-ramp → USDC → PIX off-ramp. Every request runs in **test** or **live** mode on this single host — there is no separate sandbox URL. API keys carry the mode in their prefix (`pk_test_…` / `pk_live_…`); dashboard JWTs start in test and re-mint via `POST /v1/auth/switch-mode`. Test mode runs the full pipeline against a sandbox payment instance (KYB/KYC auto-approve, no real money); live runs on real rails and requires approved KYB. Test and live data are fully isolated. Check readiness with `GET /v1/onboarding/status`. version: 1.0.0 contact: {} servers: [] security: [] tags: - name: Invoices description: Create and manage invoices that collect for one of your sellers. - name: Payments description: Create a payment (keep your own checkout), fetch it, or cancel it. - name: Accounts description: >- Onboard and manage your sellers, buyers, and your own (self) account at the settlement partner. - name: Webhooks description: Subscribe to outbound event notifications and manage signing secrets. - name: API keys description: Issue, list, and revoke the API keys that authenticate your integration. - name: Access description: Request and check production (live-mode) access for your organization. - name: Reports description: Pull settlement and transfer-pricing reports. paths: /v1/accounts/{id}/payout-config: post: tags: - Accounts summary: Register a seller's PIX payout destination description: >- Register a seller end client's PIX payout destination at the settlement partner. The settlement partner infers the PIX key type from its format and returns an opaque bank-account id; Caratuva persists only that id — the raw PIX key is never stored. Sellers only, and the account must be `approved` first (a receiver is required). Configuring this can flip the seller to `readyToCollect`. operationId: ConnectedAccountsController_payoutConfig parameters: - name: id required: true in: path schema: type: string requestBody: required: true content: application/json: schema: anyOf: - type: object properties: pixKey: type: string minLength: 1 maxLength: 200 accountHolderName: type: string minLength: 1 maxLength: 200 name: type: string minLength: 1 maxLength: 120 required: - pixKey additionalProperties: false - anyOf: - type: object properties: type: type: string enum: - pix name: type: string minLength: 1 maxLength: 120 pixKey: type: string minLength: 1 maxLength: 200 required: - type - pixKey additionalProperties: false - type: object properties: type: type: string enum: - international_swift name: type: string minLength: 1 maxLength: 120 accountClass: type: string minLength: 1 swiftCodeBic: type: string minLength: 1 swiftAccountHolderName: type: string minLength: 1 swiftAccountNumberIban: type: string minLength: 1 swiftBeneficiaryAddressLine1: type: string minLength: 1 swiftBeneficiaryCountry: type: string minLength: 2 maxLength: 2 swiftBeneficiaryCity: type: string minLength: 1 swiftBeneficiaryStateProvinceRegion: type: string minLength: 1 swiftBeneficiaryPostalCode: type: string minLength: 1 swiftBankName: type: string minLength: 1 swiftBankAddressLine1: type: string minLength: 1 swiftBankAddressLine2: type: string swiftBankCountry: type: string minLength: 2 maxLength: 2 swiftBankCity: type: string minLength: 1 swiftBankStateProvinceRegion: type: string minLength: 1 swiftBankPostalCode: type: string minLength: 1 recipientRelationship: type: string minLength: 1 swiftPaymentCode: type: string businessIndustry: type: string taxId: type: string phoneNumber: type: string required: - type - accountClass - swiftCodeBic - swiftAccountHolderName - swiftAccountNumberIban - swiftBeneficiaryAddressLine1 - swiftBeneficiaryCountry - swiftBeneficiaryCity - swiftBeneficiaryStateProvinceRegion - swiftBeneficiaryPostalCode - swiftBankName - swiftBankAddressLine1 - swiftBankCountry - swiftBankCity - swiftBankStateProvinceRegion - swiftBankPostalCode - recipientRelationship additionalProperties: false - type: object properties: type: type: string enum: - ach name: type: string minLength: 1 maxLength: 120 beneficiaryName: type: string minLength: 1 routingNumber: type: string minLength: 1 accountNumber: type: string minLength: 1 accountType: type: string minLength: 1 accountClass: type: string minLength: 1 addressLine1: type: string minLength: 1 addressLine2: type: string city: type: string minLength: 1 stateProvinceRegion: type: string minLength: 1 country: type: string minLength: 2 maxLength: 2 postalCode: type: string minLength: 1 recipientRelationship: type: string minLength: 1 required: - type - beneficiaryName - routingNumber - accountNumber - accountType - accountClass - addressLine1 - city - stateProvinceRegion - country - postalCode - recipientRelationship additionalProperties: false - type: object properties: type: type: string enum: - wire name: type: string minLength: 1 maxLength: 120 beneficiaryName: type: string minLength: 1 routingNumber: type: string minLength: 1 accountNumber: type: string minLength: 1 accountClass: type: string minLength: 1 addressLine1: type: string minLength: 1 addressLine2: type: string city: type: string minLength: 1 stateProvinceRegion: type: string minLength: 1 country: type: string minLength: 2 maxLength: 2 postalCode: type: string minLength: 1 recipientRelationship: type: string minLength: 1 required: - type - beneficiaryName - routingNumber - accountNumber - accountClass - addressLine1 - city - stateProvinceRegion - country - postalCode - recipientRelationship additionalProperties: false - type: object properties: type: type: string enum: - rtp name: type: string minLength: 1 maxLength: 120 beneficiaryName: type: string minLength: 1 routingNumber: type: string minLength: 1 accountNumber: type: string minLength: 1 accountClass: type: string minLength: 1 addressLine1: type: string minLength: 1 addressLine2: type: string city: type: string minLength: 1 stateProvinceRegion: type: string minLength: 1 country: type: string minLength: 2 maxLength: 2 postalCode: type: string minLength: 1 recipientRelationship: type: string minLength: 1 required: - type - beneficiaryName - routingNumber - accountNumber - accountClass - addressLine1 - city - stateProvinceRegion - country - postalCode - recipientRelationship additionalProperties: false - type: object properties: type: type: string enum: - spei_bitso name: type: string minLength: 1 maxLength: 120 beneficiaryName: type: string minLength: 1 speiProtocol: type: string minLength: 1 speiInstitutionCode: type: string minLength: 1 speiClabe: type: string minLength: 1 required: - type - beneficiaryName - speiProtocol - speiInstitutionCode - speiClabe additionalProperties: false - type: object properties: type: type: string enum: - ach_cop_bitso name: type: string minLength: 1 maxLength: 120 accountType: type: string minLength: 1 achCopBeneficiaryFirstName: type: string minLength: 1 achCopBeneficiaryLastName: type: string minLength: 1 achCopDocumentId: type: string minLength: 1 achCopDocumentType: type: string minLength: 1 achCopEmail: type: string minLength: 1 achCopBankCode: type: string minLength: 1 achCopBankAccount: type: string minLength: 1 required: - type - accountType - achCopBeneficiaryFirstName - achCopBeneficiaryLastName - achCopDocumentId - achCopDocumentType - achCopEmail - achCopBankCode - achCopBankAccount additionalProperties: false - type: object properties: type: type: string enum: - transfers_bitso name: type: string minLength: 1 maxLength: 120 beneficiaryName: type: string minLength: 1 transfersType: type: string minLength: 1 transfersAccount: type: string minLength: 1 required: - type - beneficiaryName - transfersType - transfersAccount additionalProperties: false examples: default: value: pixKey: acme@pix.example.com accountHolderName: Fazenda Boa Vista Café LTDA responses: '201': description: Payout destination configured content: application/json: schema: type: object properties: connectedAccountId: type: string configured: type: boolean required: - connectedAccountId - configured additionalProperties: false examples: default: value: connectedAccountId: ckacc042 configured: true '400': description: >- ConnectedAccountNotApproved — Connected account must be approved before configuring a payout destination (also: PayoutConfigSellerOnly when the account is not a seller). content: application/json: schema: type: object properties: statusCode: type: integer example: 400 error: type: string example: ConnectedAccountNotApproved message: type: string example: >- Connected account must be approved before configuring a payout destination (also: PayoutConfigSellerOnly when the account is not a seller). security: - apiKey: [] - bearer: [] components: securitySchemes: apiKey: type: apiKey in: header name: X-API-Key bearer: scheme: bearer bearerFormat: JWT type: http ````