> ## Documentation Index > Fetch the complete documentation index at: https://docs.augustus.com/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Treat the published Augustus OpenAPI specification (https://app.stainless.com/api/spec/documented/augustus/openapi.documented.yml) and the current API-reference pages as the source of truth for endpoints, request/response schemas, enum values, webhook event names, and required headers. > Prefer the 2026-05-01 Banking API and @augustusbank/typescript-sdk for all new integrations. The 2023-01-01 API is a separate, older surface covering two products — Open Banking (instant bank transfer) checkout and refunds, and Manual Bank Transfer (MBT); use it only when one of those products is specifically required. > Cite or link the relevant docs.augustus.com page when answering integration questions. > Do not infer support for currencies, networks, scopes, account types, or operations that are not present in the current documentation. > Use the sandbox base URL (https://api.sandbox.augustus.com) and placeholder credentials in examples. Never include or request a real API key. > The Augustus docs MCP server (https://docs.augustus.com/mcp) provides documentation search and retrieval only; it does not execute authenticated Augustus API actions. # Create a payout > Create a payout for a merchant. ## OpenAPI ````yaml https://app.stainless.com/api/spec/documented/getivy/openapi.documented.yml post /api/service/payout/create openapi: 3.0.0 info: title: Ivy API description: Ivy API schema version: '1.0' contact: name: Ivy url: https://www.getivy.io email: help@getivy.io servers: - url: https://api.getivy.de description: Production - url: https://api.sand.getivy.de description: Sandbox security: [] tags: [] paths: /api/service/payout/create: post: tags: - Payout summary: Create a payout description: Create a payout for a merchant. operationId: PayoutController_create parameters: - name: Idempotency-Key in: header description: >- Idempotency key for safe retries. Reusing a key with an identical request body returns the cached response. Reusing a key with a different body returns 409. required: false schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreatePayoutDto' responses: '200': description: Create a payout content: application/json: schema: $ref: '#/components/schemas/CreatePayoutResponseDto' security: - ApiKeyAuth: [] x-codeSamples: - lang: JavaScript source: |- import Ivy from '@getivy/node-sdk'; const client = new Ivy({ apiKey: process.env['IVY_API_KEY'], // This is the default and can be omitted }); const payout = await client.payouts.create({ amount: 1.01, currency: 'EUR', destination: {}, }); console.log(payout.id); components: schemas: CreatePayoutDto: type: object properties: amount: description: The payout amount in decimal format. The minimum amount is 0.01. type: number minimum: 0.01 exclusiveMinimum: false currency: type: string enum: - EUR - GBP - USDC - USD destination: type: object properties: type: description: >- Beneficiary is a payout to an account owned by the merchant. Customer is a payout to an external customer account. type: string enum: - beneficiary - customer default: customer orderId: type: string financialAddress: type: object properties: type: type: string enum: - iban - sort_code - bank_code - bban - wallet - aba x-enumNames: - IBAN - SORT_CODE - BANK_CODE - BBAN - WALLET - ABA iban: type: object properties: accountHolderName: type: string minLength: 1 iban: type: string bic: type: string required: - accountHolderName - iban aba: type: object properties: accountHolderName: type: string minLength: 1 routingNumber: type: string pattern: ^[0-9]+$ accountNumber: type: string pattern: ^[0-9]+$ required: - accountHolderName - routingNumber - accountNumber sortCode: type: object properties: accountHolderName: type: string minLength: 1 sortCode: type: string pattern: ^[0-9]+$ accountNumber: type: string pattern: ^[0-9]+$ maxLength: 8 required: - accountHolderName - sortCode - accountNumber bankCode: type: object properties: accountHolderName: type: string minLength: 1 code: type: string accountNumber: type: string required: - accountHolderName - code - accountNumber bban: type: object properties: accountHolderName: type: string minLength: 1 bban: type: string bic: type: string required: - accountHolderName - bban wallet: type: object properties: address: description: The blockchain wallet address type: string blockchain: description: The blockchain network type: string enum: - BTC - BTC-TESTNET4 - ETH - ETH-SEPOLIA - SOL - SOL-DEVNET - MATIC - MATIC-AMOY required: - address - blockchain required: - type nullable: true default: null address: description: Physical postal address of the payout counterparty. type: object properties: line1: description: Primary street address line. type: string minLength: 1 line2: description: Secondary street address line. type: string minLength: 1 city: description: City or locality. type: string minLength: 1 postalCode: description: Postal or ZIP code. type: string minLength: 1 state: description: State, province, or region. type: string minLength: 1 countryCode: description: ISO 3166-1 alpha-2 country code. type: string enum: - AF - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BA - BW - BV - BR - IO - BN - BG - BF - BI - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IL - IT - JM - JP - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - MS - MA - MZ - MM - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - MP - MK - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - SH - KN - LC - PM - VC - WS - SM - ST - SA - SN - SC - SL - SG - SK - SI - SB - SO - ZA - GS - ES - LK - SD - SR - SJ - SZ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW - AX - BQ - CW - GG - IM - JE - ME - BL - MF - RS - SX - SS - XK required: - city - countryCode rail: description: The payment rail or blockchain used for the payout type: string enum: - SEPA_INSTANT - FASTER_PAYMENTS - SEPA - ELIXIR - EXPRESS_ELIXIR - SEK_ACCOUNT_TO_ACCOUNT - SUMCLEARING - STRAKSCLEARING - SWIFT - INTERNAL - TARGET - ACH - FEDWIRE - BTC - BTC-TESTNET4 - ETH - ETH-SEPOLIA - SOL - SOL-DEVNET - MATIC - MATIC-AMOY metadata: description: >- This can be used to store any additional information you need to associate with this payout. type: object additionalProperties: {} paymentReference: description: >- The payout payment reference. This is visible to the receiving party, if possible. type: string minLength: 1 required: - amount - currency - destination CreatePayoutResponseDto: type: object properties: id: description: The payout ID type: string type: description: The payout type type: string enum: - beneficiary - customer destination: description: The payout destination type: object properties: type: type: string enum: - iban - sort_code - bank_code - bban - wallet - aba x-enumNames: - IBAN - SORT_CODE - BANK_CODE - BBAN - WALLET - ABA iban: type: object properties: accountHolderName: type: string minLength: 1 iban: type: string bic: type: string required: - accountHolderName - iban aba: type: object properties: accountHolderName: type: string minLength: 1 routingNumber: type: string pattern: ^[0-9]+$ accountNumber: type: string pattern: ^[0-9]+$ required: - accountHolderName - routingNumber - accountNumber sortCode: type: object properties: accountHolderName: type: string minLength: 1 sortCode: type: string pattern: ^[0-9]+$ accountNumber: type: string pattern: ^[0-9]+$ maxLength: 8 required: - accountHolderName - sortCode - accountNumber bankCode: type: object properties: accountHolderName: type: string minLength: 1 code: type: string accountNumber: type: string required: - accountHolderName - code - accountNumber bban: type: object properties: accountHolderName: type: string minLength: 1 bban: type: string bic: type: string required: - accountHolderName - bban wallet: type: object properties: address: description: The blockchain wallet address type: string blockchain: description: The blockchain network type: string enum: - BTC - BTC-TESTNET4 - ETH - ETH-SEPOLIA - SOL - SOL-DEVNET - MATIC - MATIC-AMOY required: - address - blockchain required: - type status: description: The payout status type: string enum: - paid - pending - in_transit - failed - canceled x-enumNames: - Paid - Pending - InTransit - Failed - Canceled amount: description: The payout amount type: number currency: description: The payout currency type: string enum: - EUR - GBP - USDC - USD metadata: description: The payout metadata type: object additionalProperties: {} createdAt: description: The payout created at updatedAt: description: The payout updated at paymentReference: description: The payout payment reference type: string transactionId: description: The payout transaction ID type: string failure: description: Failure details. Only available if the payout failed. type: object properties: code: description: >- Failure code. Please refer to the documentation for the list of possible values. type: string enum: - account_closed - account_blocked - insufficient_funds - invalid_account_format - invalid_instruction - invalid_amount - invalid_time - duplicate_transaction - payee_verification_failed - system_error - provider_system_error - rejected_by_correspondent_bank - blocked_by_review - unknown x-enumNames: - ACCOUNT_CLOSED - ACCOUNT_BLOCKED - INSUFFICIENT_FUNDS - INVALID_ACCOUNT_FORMAT - INVALID_INSTRUCTION - INVALID_AMOUNT - INVALID_TIME - DUPLICATE_TRANSACTION - PAYEE_VERIFICATION_FAILED - SYSTEM_ERROR - PROVIDER_SYSTEM_ERROR - REJECTED_BY_CORRESPONDENT_BANK - BLOCKED_BY_REVIEW - UNKNOWN message: description: Human readable description of the failure. type: string retry: description: If true, you can safely retry. type: boolean required: - code - message - retry required: - id - type - destination - status - amount - currency - createdAt - updatedAt securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-Ivy-Api-Key description: API key for authentication ````