> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xendit.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Payout

> Create a Payout. Send payouts to anyone, anywhere, instantly.

## OpenAPI

````json POST /v3/payouts
{
  "openapi": "3.0.3",
  "info": {
    "title": "Payouts",
    "version": "1.0",
    "description": "This Payouts API can be used to send money at scale to all bank accounts & E-Wallets in Indonesia, Philippines, Thailand, Malaysia and Vietnam by using just a single endpoint."
  },
  "servers": [
    {
      "url": "https://api.xendit.co",
      "description": "Xendit API"
    }
  ],
  "paths": {
    "/v3/payouts": {
      "post": {
        "operationId": "Payouts_create",
        "summary": "Create Payout",
        "description": "Create a Payout. Send payouts to anyone, anywhere, instantly.",
        "parameters": [
          {
            "name": "api-version",
            "in": "header",
            "required": "true",
            "description": "The version of the API. Value: \"2025-09-09\"",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "idempotency-key",
            "in": "header",
            "required": "false",
            "description": "Unique reference assigned to the payout for idempotency.\n\nWhen it comes to sending money, one risk that often arises is double transaction due to Timeout or any communication problem during the request. The Idempotency Key is the main differentiator for each Payout submitted to the Xendit system.\n\nBehaviors:\n- Same Idempotency Key + different request body → `DUPLICATE_ERROR`\n- Same Idempotency Key + same request body → returns the initial Payout Object from the first attempt\n\nThe Idempotency Key is scoped per business ID — two merchants can safely use the same key without conflict.\nIf left blank, Xendit will assign a random UUID.",
            "schema": {
              "type": "string",
              "maxLength": "100"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Payouts_v3_Payout"
                },
                "examples": {
                  "Create Domestic Payout to Wallet": {
                    "summary": "Create Domestic Payout to Wallet",
                    "value": {
                      "payout_id": "po-b2c3d4e5-f6a7-8901-bcde-f23456789012",
                      "status": "ACCEPTED",
                      "reference_id": "payout-ref-002",
                      "type": "B2C",
                      "source_currency": "PHP",
                      "source_amount": "50000",
                      "destination_currency": "PHP",
                      "destination_amount": "50000",
                      "sender": {
                        "type": "BUSINESS",
                        "business_name": "Acme Corp"
                      },
                      "recipient": {
                        "type": "INDIVIDUAL",
                        "given_name": "Maria",
                        "surname": "Santos",
                        "relationship": "CUSTOMER",
                        "account_details": {
                          "currency": "PHP",
                          "account_country": "PH",
                          "account_holder_name": "Maria Santos",
                          "account_number": "09171234567",
                          "routing_type_1": "wallet",
                          "routing_value_1": "GCASH"
                        }
                      },
                      "source_of_fund": "BUSINESS_REVENUE",
                      "purpose_code": "SALARY",
                      "description": "Freelancer payment",
                      "created": "2025-06-11T08:00:00Z",
                      "updated": "2025-06-11T08:00:00Z",
                      "estimated_arrival_time": "2025-06-11T08:05:00Z",
                      "business_id": "6018306aa16ad90cb3c43ba7"
                    }
                  },
                  "Create Cross-Border Payout": {
                    "summary": "Create Cross-Border Payout",
                    "value": {
                      "payout_id": "po-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
                      "status": "ACCEPTED",
                      "reference_id": "payout-ref-001",
                      "type": "B2C",
                      "source_currency": "IDR",
                      "source_amount": "1000000",
                      "destination_currency": "USD",
                      "destination_amount": "63",
                      "sender": {
                        "type": "BUSINESS",
                        "business_name": "Acme Corp"
                      },
                      "recipient": {
                        "type": "INDIVIDUAL",
                        "given_name": "John",
                        "surname": "Doe",
                        "relationship": "CUSTOMER",
                        "account_details": {
                          "currency": "USD",
                          "account_country": "US",
                          "account_holder_name": "John Doe",
                          "account_number": "1234567890",
                          "routing_type_1": "aba",
                          "routing_value_1": "021000021"
                        }
                      },
                      "source_of_fund": "BUSINESS_REVENUE",
                      "purpose_code": "SALARY",
                      "description": "Monthly salary payment",
                      "created": "2025-06-10T10:30:00Z",
                      "updated": "2025-06-10T10:30:00Z",
                      "estimated_arrival_time": "2025-06-10T12:00:00Z",
                      "business_id": "6018306aa16ad90cb3c43ba7"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Payouts_v3_CreatePayout400Body"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Payouts_v3_Http401InvalidApiKey"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Payouts_v3_CreatePayout403Body"
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Payouts_v3_Http404DataNotFound_QuoteId"
                }
              }
            }
          },
          "409": {
            "description": "Conflict",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Payouts_v3_Http409DuplicateError"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Payouts_v3_Http500ServerError"
                }
              }
            }
          }
        },
        "tags": [
          "Payout v3 (Beta)"
        ],
        "requestBody": {
          "required": "true",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Payouts_v3_CreatePayoutRequest"
              },
              "examples": {
                "Create Domestic Payout to Wallet": {
                  "summary": "Create Domestic Payout to Wallet",
                  "value": {
                    "reference_id": "payout-ref-002",
                    "recipient": {
                      "type": "INDIVIDUAL",
                      "given_name": "Maria",
                      "surname": "Santos",
                      "relationship": "CUSTOMER",
                      "account_details": {
                        "currency": "PHP",
                        "account_country": "PH",
                        "account_holder_name": "Maria Santos",
                        "account_number": "09171234567",
                        "routing_type_1": "wallet",
                        "routing_value_1": "GCASH"
                      }
                    },
                    "payout_details": {
                      "source_currency": "PHP",
                      "source_amount": "50000",
                      "destination_currency": "PHP"
                    },
                    "source_of_fund": "BUSINESS_REVENUE",
                    "purpose_code": "SALARY",
                    "description": "Freelancer payment"
                  }
                },
                "Create Cross-Border Payout": {
                  "summary": "Create Cross-Border Payout",
                  "value": {
                    "reference_id": "payout-ref-001",
                    "recipient": {
                      "type": "INDIVIDUAL",
                      "given_name": "John",
                      "surname": "Doe",
                      "relationship": "CUSTOMER",
                      "details": {
                        "nationality": "US",
                        "date_of_birth": "1990-05-15"
                      },
                      "account_details": {
                        "currency": "USD",
                        "account_country": "US",
                        "account_holder_name": "John Doe",
                        "account_number": "1234567890",
                        "routing_type_1": "aba",
                        "routing_value_1": "021000021"
                      }
                    },
                    "payout_details": {
                      "source_currency": "IDR",
                      "source_amount": "1000000",
                      "destination_currency": "USD"
                    },
                    "source_of_fund": "BUSINESS_REVENUE",
                    "purpose_code": "SALARY",
                    "description": "Monthly salary payment"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "Payouts_v3_SecretApiKeyAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "Payouts_v3_Payout": {
        "type": "object",
        "required": [
          "payout_id",
          "status",
          "reference_id",
          "type",
          "destination_currency",
          "destination_amount",
          "sender",
          "recipient",
          "created",
          "updated",
          "business_id"
        ],
        "properties": {
          "payout_id": {
            "type": "string",
            "description": "Unique payout id in UUID format, prefixed with po-"
          },
          "status": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_PayoutStatus"
              }
            ],
            "description": "Status of the payout. See [Payout Status Lifecycle](https://docs.xendit.co/docs/payout-status-lifecycle)"
          },
          "reference_id": {
            "type": "string",
            "description": "ID provided by merchant to identify the request"
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_PayoutType"
              }
            ],
            "description": "Payout type"
          },
          "processor_reference": {
            "type": "string",
            "description": "Payout reference from Xendit's processor"
          },
          "source_currency": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_PayoutCurrency"
              }
            ],
            "description": "Origin currency of the Payout"
          },
          "source_amount": {
            "type": "integer",
            "description": "Origin amount of the Payout in minor units.\n\nA minor unit is the smallest unit of a currency. Most currencies have 2 decimals, others have 0.\nExamples: PHP 10.00 → `1000`, IDR 10 → `10`."
          },
          "destination_currency": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_PayoutCurrency"
              }
            ],
            "description": "Destination currency of the Payout"
          },
          "destination_amount": {
            "type": "integer",
            "description": "Destination amount of the Payout in minor units.\n\nA minor unit is the smallest unit of a currency. Most currencies have 2 decimals, others have 0.\nExamples: PHP 10.00 → `1000`, IDR 10 → `10`."
          },
          "sender": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_Sender"
              }
            ],
            "description": "Contains sender information"
          },
          "recipient": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_Recipient"
              }
            ],
            "description": "Contains recipient information"
          },
          "source_of_fund": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_SourceOfFund"
              }
            ],
            "description": "Source of fund of the payout"
          },
          "purpose_code": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_PurposeCode"
              }
            ],
            "description": "Purpose of the payout"
          },
          "description": {
            "type": "string",
            "maxLength": "100",
            "description": "Free text description shown in recipient's bank statement, if supported"
          },
          "underlying_documents": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Payouts_v3_UnderlyingDocument"
            },
            "description": "Underlying document attachments"
          },
          "created": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp when the payout was made. Format: ISO 8601, UTC+0"
          },
          "updated": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp when the payout was last updated. Format: ISO 8601, UTC+0"
          },
          "estimated_arrival_time": {
            "type": "string",
            "format": "date-time",
            "description": "Estimated time of arrival of funds in destination account. UTC+0"
          },
          "failure_code": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_FailureCode"
              }
            ],
            "description": "Failure reason of the Payout. See [Payout Status Lifecycle](https://docs.xendit.co/docs/payout-status-lifecycle)"
          },
          "business_id": {
            "type": "string",
            "description": "Your Xendit Business ID"
          },
          "metadata": {
            "type": "object",
            "additionalProperties": {},
            "description": "Object of additional information the merchant may use"
          }
        },
        "description": "Payout Object"
      },
      "Payouts_v3_CreatePayout400Body": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/Payouts_v3_Http400ApiValidationError"
          },
          {
            "$ref": "#/components/schemas/Payouts_v3_Http400ApiValidationError_BothAmounts"
          },
          {
            "$ref": "#/components/schemas/Payouts_v3_Http400InvalidValueError_UnsupportedSourceCurrency"
          },
          {
            "$ref": "#/components/schemas/Payouts_v3_Http400InvalidValueError_UnsupportedDestinationCurrency"
          },
          {
            "$ref": "#/components/schemas/Payouts_v3_Http400InvalidValueError_AmountTooLow"
          },
          {
            "$ref": "#/components/schemas/Payouts_v3_Http400InvalidValueError_AmountTooHigh"
          },
          {
            "$ref": "#/components/schemas/Payouts_v3_Http400InvalidQuote"
          }
        ]
      },
      "Payouts_v3_Http401InvalidApiKey": {
        "type": "object",
        "required": [
          "error_code",
          "message"
        ],
        "properties": {
          "error_code": {
            "type": "string",
            "enum": [
              "INVALID_API_KEY"
            ]
          },
          "message": {
            "type": "string",
            "enum": [
              "API key format is invalid"
            ]
          }
        }
      },
      "Payouts_v3_CreatePayout403Body": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/Payouts_v3_Http403RequestForbiddenError"
          },
          {
            "$ref": "#/components/schemas/Payouts_v3_Http403RequestForbiddenError_Account"
          },
          {
            "$ref": "#/components/schemas/Payouts_v3_Http403InvalidMerchantSettings_Payout"
          }
        ]
      },
      "Payouts_v3_Http404DataNotFound_QuoteId": {
        "type": "object",
        "required": [
          "error_code",
          "message"
        ],
        "properties": {
          "error_code": {
            "type": "string",
            "enum": [
              "DATA_NOT_FOUND"
            ]
          },
          "message": {
            "type": "string",
            "enum": [
              "The Quote ID specified cannot be found"
            ]
          }
        }
      },
      "Payouts_v3_Http409DuplicateError": {
        "type": "object",
        "required": [
          "error_code",
          "message"
        ],
        "properties": {
          "error_code": {
            "type": "string",
            "enum": [
              "DUPLICATE_ERROR"
            ]
          },
          "message": {
            "type": "string",
            "enum": [
              "A payout with this idempotency key already exists. If you meant to execute a different request, please use another idempotency key."
            ]
          }
        }
      },
      "Payouts_v3_Http500ServerError": {
        "type": "object",
        "required": [
          "error_code",
          "message"
        ],
        "properties": {
          "error_code": {
            "type": "string",
            "enum": [
              "SERVER_ERROR"
            ]
          },
          "message": {
            "type": "string",
            "enum": [
              "An unexpected error occurred"
            ]
          }
        }
      },
      "Payouts_v3_CreatePayoutRequest": {
        "type": "object",
        "required": [
          "reference_id",
          "recipient",
          "payout_details",
          "source_of_fund",
          "purpose_code"
        ],
        "properties": {
          "reference_id": {
            "type": "string",
            "maxLength": "255",
            "description": "ID provided by merchant to identify the request"
          },
          "sender": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_Sender"
              }
            ],
            "description": "Contains sender information. Only allowed for FIs (Financial Institutions)"
          },
          "recipient": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_Recipient"
              }
            ],
            "description": "Contains recipient information"
          },
          "payout_details": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_PayoutDetails"
              }
            ],
            "description": "Detailed information about the payout"
          },
          "source_of_fund": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_SourceOfFund"
              }
            ],
            "description": "Source of fund of the payout"
          },
          "purpose_code": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_PurposeCode"
              }
            ],
            "description": "Purpose of the payout"
          },
          "description": {
            "type": "string",
            "maxLength": "100",
            "description": "Free text description shown in recipient's bank statement, if supported"
          },
          "underlying_documents": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Payouts_v3_UnderlyingDocument"
            },
            "description": "Underlying document attachments"
          },
          "metadata": {
            "type": "object",
            "additionalProperties": {},
            "description": "Object of additional information the merchant may use"
          }
        }
      },
      "Payouts_v3_PayoutStatus": {
        "type": "string",
        "enum": [
          "ACCEPTED",
          "PENDING_COMPLIANCE_REVIEW",
          "REJECTED",
          "ROUTING",
          "REQUESTED",
          "READY",
          "LOCKED",
          "EXPIRED",
          "FAILED",
          "SUCCEEDED",
          "CANCELLED",
          "REVERSED"
        ]
      },
      "Payouts_v3_PayoutType": {
        "type": "string",
        "enum": [
          "B2B",
          "B2C",
          "C2C",
          "C2B"
        ]
      },
      "Payouts_v3_PayoutCurrency": {
        "type": "string",
        "enum": [
          "USD",
          "SGD",
          "IDR",
          "PHP",
          "MYR",
          "THB",
          "VND",
          "HKD",
          "MXN",
          "CNY",
          "KRW",
          "AUD",
          "EUR"
        ]
      },
      "Payouts_v3_Sender": {
        "type": "object",
        "required": [
          "type"
        ],
        "properties": {
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_EntityType"
              }
            ],
            "description": "Entity type of the sender"
          },
          "business_name": {
            "type": "string",
            "maxLength": "50",
            "description": "Name of the business sender. Required if type is BUSINESS"
          },
          "given_name": {
            "type": "string",
            "maxLength": "50",
            "description": "First name of the sender. Required if type is INDIVIDUAL"
          },
          "surname": {
            "type": "string",
            "maxLength": "50",
            "description": "Last name of the sender. Required if type is INDIVIDUAL"
          },
          "given_name_non_roman": {
            "type": "string",
            "maxLength": "50",
            "description": "First non-roman name of the sender"
          },
          "surname_non_roman": {
            "type": "string",
            "maxLength": "50",
            "description": "Last non-roman name of the sender"
          },
          "details": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_SenderDetails"
              }
            ],
            "description": "Details of the sender"
          },
          "address": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_Address"
              }
            ],
            "description": "Address details of the sender"
          }
        },
        "description": "Contains sender information. Only allowed for FIs (Financial Institutions)."
      },
      "Payouts_v3_Recipient": {
        "type": "object",
        "required": [
          "type",
          "relationship",
          "account_details"
        ],
        "properties": {
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_EntityType"
              }
            ],
            "description": "Entity type of the recipient"
          },
          "business_name": {
            "type": "string",
            "maxLength": "50",
            "description": "Name of the business recipient. Required if type is BUSINESS"
          },
          "given_name": {
            "type": "string",
            "maxLength": "50",
            "description": "First name of the recipient. Required if type is INDIVIDUAL"
          },
          "surname": {
            "type": "string",
            "maxLength": "50",
            "description": "Last name of the recipient. Required if type is INDIVIDUAL"
          },
          "given_name_non_roman": {
            "type": "string",
            "maxLength": "50",
            "description": "First non-roman name of the recipient"
          },
          "surname_non_roman": {
            "type": "string",
            "maxLength": "50",
            "description": "Last non-roman name of the recipient"
          },
          "relationship": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_Relationship"
              }
            ],
            "description": "Recipient's relationship to the sender in the context of the transaction"
          },
          "details": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_RecipientDetails"
              }
            ],
            "description": "Details of the recipient"
          },
          "account_details": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_RecipientAccountDetails"
              }
            ],
            "description": "Recipient's account details where the payment will be credited"
          },
          "address": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_Address"
              }
            ],
            "description": "Address details of the recipient"
          }
        },
        "description": "Contains recipient information"
      },
      "Payouts_v3_SourceOfFund": {
        "type": "string",
        "enum": [
          "INVESTMENT",
          "PERSONAL_SAVINGS",
          "BUSINESS_REVENUE",
          "LEGACY",
          "BUSINESS_ARRANGEMENT",
          "LOAN",
          "SALARY",
          "OTHER"
        ]
      },
      "Payouts_v3_PurposeCode": {
        "type": "string",
        "enum": [
          "SELF",
          "FAMILY",
          "EDUCATION",
          "MEDICAL",
          "HOTEL",
          "TRAVEL",
          "UTILITIES",
          "LOAN_REPAYMENT",
          "TAX_PAYMENT",
          "RESIDENCE_PURCHASE",
          "RESIDENCE_RENT",
          "INSURANCE",
          "MUTUAL_FUND",
          "SHARES_INVESTMENT",
          "DONATION",
          "ADVERTISING",
          "ROYALTY_FEES",
          "BROKER_FEES",
          "ADVISORS",
          "OFFICE",
          "CONSTRUCTION",
          "SHIPMENT",
          "EXPORT",
          "DELIVERY",
          "TRADES",
          "SALARY",
          "REFUND",
          "OTHER"
        ]
      },
      "Payouts_v3_UnderlyingDocument": {
        "type": "object",
        "properties": {
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_UnderlyingDocumentType"
              }
            ],
            "description": "Type of the document"
          },
          "reference_no": {
            "type": "string",
            "maxLength": "100",
            "description": "Reference number of the document"
          },
          "file_id": {
            "type": "string",
            "description": "File ID of the document"
          }
        }
      },
      "Payouts_v3_FailureCode": {
        "type": "string",
        "enum": [
          "INSUFFICIENT_BALANCE",
          "INVALID_DESTINATION",
          "DESTINATION_MAXIMUM_LIMIT",
          "ACCOUNT_NAME_MISMATCH",
          "REJECTED_BY_CHANNEL",
          "TEMPORARY_TRANSFER_ERROR",
          "TRANSFER_ERROR",
          "SLS_SENDER",
          "SLS_RECIPIENT"
        ]
      },
      "Payouts_v3_Http400ApiValidationError": {
        "type": "object",
        "required": [
          "error_code",
          "message"
        ],
        "properties": {
          "error_code": {
            "type": "string",
            "enum": [
              "API_VALIDATION_ERROR"
            ]
          },
          "message": {
            "type": "string",
            "enum": [
              "Inputs are failing validation. The errors field contains details about which fields are violating validation."
            ]
          }
        }
      },
      "Payouts_v3_Http400ApiValidationError_BothAmounts": {
        "type": "object",
        "required": [
          "error_code",
          "message"
        ],
        "properties": {
          "error_code": {
            "type": "string",
            "enum": [
              "API_VALIDATION_ERROR"
            ]
          },
          "message": {
            "type": "string",
            "enum": [
              "Both source and destination amounts were specified. Please input only one of these amounts."
            ]
          }
        }
      },
      "Payouts_v3_Http400InvalidValueError_UnsupportedSourceCurrency": {
        "type": "object",
        "required": [
          "error_code",
          "message"
        ],
        "properties": {
          "error_code": {
            "type": "string",
            "enum": [
              "INVALID_VALUE_ERROR"
            ]
          },
          "message": {
            "type": "string",
            "enum": [
              "The source currency specified in the request is not supported. Please check our documentation for currencies available."
            ]
          }
        }
      },
      "Payouts_v3_Http400InvalidValueError_UnsupportedDestinationCurrency": {
        "type": "object",
        "required": [
          "error_code",
          "message"
        ],
        "properties": {
          "error_code": {
            "type": "string",
            "enum": [
              "INVALID_VALUE_ERROR"
            ]
          },
          "message": {
            "type": "string",
            "enum": [
              "The destination currency specified in the request is not supported. Please check our documentation for currencies available."
            ]
          }
        }
      },
      "Payouts_v3_Http400InvalidValueError_AmountTooLow": {
        "type": "object",
        "required": [
          "error_code",
          "message"
        ],
        "properties": {
          "error_code": {
            "type": "string",
            "enum": [
              "INVALID_VALUE_ERROR"
            ]
          },
          "message": {
            "type": "string",
            "enum": [
              "The transfer amount requested is lower than the prescribed minimum for the region. Amend the transfer amount before retrying."
            ]
          }
        }
      },
      "Payouts_v3_Http400InvalidValueError_AmountTooHigh": {
        "type": "object",
        "required": [
          "error_code",
          "message"
        ],
        "properties": {
          "error_code": {
            "type": "string",
            "enum": [
              "INVALID_VALUE_ERROR"
            ]
          },
          "message": {
            "type": "string",
            "enum": [
              "The transfer amount requested is higher than the prescribed maximum for the region. Amend the transfer amount before retrying."
            ]
          }
        }
      },
      "Payouts_v3_Http400InvalidQuote": {
        "type": "object",
        "required": [
          "error_code",
          "message"
        ],
        "properties": {
          "error_code": {
            "type": "string",
            "enum": [
              "INVALID_QUOTE"
            ]
          },
          "message": {
            "type": "string",
            "enum": [
              "This quote was created for a different transaction type. Please create a new Quote with the correct transaction type."
            ]
          }
        }
      },
      "Payouts_v3_Http403RequestForbiddenError": {
        "type": "object",
        "required": [
          "error_code",
          "message"
        ],
        "properties": {
          "error_code": {
            "type": "string",
            "enum": [
              "REQUEST_FORBIDDEN_ERROR"
            ]
          },
          "message": {
            "type": "string",
            "enum": [
              "The API key is forbidden to perform this request"
            ]
          }
        }
      },
      "Payouts_v3_Http403RequestForbiddenError_Account": {
        "type": "object",
        "required": [
          "error_code",
          "message"
        ],
        "properties": {
          "error_code": {
            "type": "string",
            "enum": [
              "REQUEST_FORBIDDEN_ERROR"
            ]
          },
          "message": {
            "type": "string",
            "enum": [
              "Your account is forbidden to perform this request"
            ]
          }
        }
      },
      "Payouts_v3_Http403InvalidMerchantSettings_Payout": {
        "type": "object",
        "required": [
          "error_code",
          "message"
        ],
        "properties": {
          "error_code": {
            "type": "string",
            "enum": [
              "INVALID_MERCHANT_SETTINGS"
            ]
          },
          "message": {
            "type": "string",
            "enum": [
              "Payout failed because the source currency has not been activated. Please reach out to Xendit to activate this currency before retrying."
            ]
          }
        }
      },
      "Payouts_v3_PayoutDetails": {
        "type": "object",
        "properties": {
          "quote_id": {
            "type": "string",
            "description": "Quote ID received from Create Quote API"
          },
          "source_currency": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_PayoutCurrency"
              }
            ],
            "description": "Origin currency of the Payout. Required if quote_id is not provided"
          },
          "source_amount": {
            "type": "integer",
            "description": "Source amount in source currency, in minor units. Must be empty if destination_amount is filled.\n\nA minor unit is the smallest unit of a currency. Most currencies have 2 decimals, others have 0.\nExamples: PHP 10.00 → `1000`, IDR 10 → `10`."
          },
          "destination_currency": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_PayoutCurrency"
              }
            ],
            "description": "Destination currency of the Payout. Required if quote_id is not provided"
          },
          "destination_amount": {
            "type": "integer",
            "description": "Payout amount in destination currency, in minor units. Must be empty if source_amount is filled.\n\nA minor unit is the smallest unit of a currency. Most currencies have 2 decimals, others have 0.\nExamples: PHP 10.00 → `1000`, IDR 10 → `10`."
          }
        },
        "description": "Detailed information about the payout"
      },
      "Payouts_v3_EntityType": {
        "type": "string",
        "enum": [
          "INDIVIDUAL",
          "BUSINESS"
        ]
      },
      "Payouts_v3_SenderDetails": {
        "type": "object",
        "properties": {
          "date_of_birth": {
            "type": "string",
            "format": "date",
            "description": "Date of birth"
          },
          "country_of_birth": {
            "type": "string",
            "description": "Country of birth. Format: ISO 3166-2 Country Code"
          },
          "nationality": {
            "type": "string",
            "description": "Nationality. Format: ISO 3166-2 Country Code"
          },
          "personal_id_type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_PersonalIdType"
              }
            ],
            "description": "Personal ID type"
          },
          "personal_id_value": {
            "type": "string",
            "maxLength": "255",
            "description": "Personal ID value"
          },
          "personal_id_expiration_date": {
            "type": "string",
            "format": "date",
            "description": "Personal ID expiration date"
          },
          "personal_id_country": {
            "type": "string",
            "description": "Personal ID country of issuance. Format: ISO 3166-2 Country Code"
          },
          "personal_email": {
            "type": "string",
            "maxLength": "50",
            "format": "email",
            "description": "Personal email"
          },
          "personal_mobile_number": {
            "type": "string",
            "minLength": "7",
            "maxLength": "15",
            "description": "Personal mobile number. Supports E.164 international format and local formats"
          },
          "gender": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_Gender"
              }
            ],
            "description": "Gender"
          },
          "occupation": {
            "type": "string",
            "maxLength": "50",
            "description": "Occupation"
          },
          "date_of_incorporation": {
            "type": "string",
            "format": "date",
            "description": "Date of incorporation of the business sender"
          },
          "registration_number": {
            "type": "string",
            "maxLength": "50",
            "description": "Registration number of the business sender"
          },
          "business_phone_number": {
            "type": "string",
            "minLength": "7",
            "maxLength": "15",
            "description": "Phone number of the business sender"
          },
          "nature_of_business": {
            "type": "string",
            "maxLength": "50",
            "description": "Nature of business"
          }
        }
      },
      "Payouts_v3_Address": {
        "type": "object",
        "properties": {
          "country": {
            "type": "string",
            "description": "Country. Format: ISO 3166-2 Country Code"
          },
          "province_state": {
            "type": "string",
            "maxLength": "255",
            "description": "Province, state or region"
          },
          "city": {
            "type": "string",
            "maxLength": "255",
            "description": "City, village or town"
          },
          "street_line1": {
            "type": "string",
            "maxLength": "255",
            "description": "Line 1 of street address e.g., building name and apartment number"
          },
          "street_line2": {
            "type": "string",
            "maxLength": "255",
            "description": "Line 2 of street address e.g., street number and name"
          },
          "postal_code": {
            "type": "string",
            "maxLength": "255",
            "description": "ZIP/Postal Code"
          }
        }
      },
      "Payouts_v3_Relationship": {
        "type": "string",
        "enum": [
          "BRANCH_REPRESENTATIVE_OFFICE",
          "BUSINESS_PARTNER",
          "CHILDREN",
          "CREDITOR",
          "CUSTOMER",
          "DEBTOR",
          "EMPLOYEE",
          "EX_SPOUSE",
          "FRANCHISEE_FRANCHISOR",
          "GRANDPARENTS",
          "HOLDING_COMPANY",
          "MAID",
          "OWNSELF",
          "PARENTS",
          "RELATIVE",
          "SIBLING",
          "SPOUSE",
          "SUBSIDIARY_COMPANY",
          "SUPPLIER",
          "FRIEND",
          "GOVERNMENT_BODY",
          "EDUCATION_INSTITUTION",
          "NON_GOVERNMENT_BODY",
          "OTHER"
        ]
      },
      "Payouts_v3_RecipientDetails": {
        "type": "object",
        "properties": {
          "date_of_birth": {
            "type": "string",
            "format": "date",
            "description": "Date of birth"
          },
          "country_of_birth": {
            "type": "string",
            "description": "Country of birth. Format: ISO 3166-2 Country Code"
          },
          "nationality": {
            "type": "string",
            "description": "Nationality. Format: ISO 3166-2 Country Code"
          },
          "personal_id_type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_PersonalIdType"
              }
            ],
            "description": "Personal ID type"
          },
          "personal_id_value": {
            "type": "string",
            "maxLength": "255",
            "description": "Personal ID value"
          },
          "personal_id_expiration_date": {
            "type": "string",
            "format": "date",
            "description": "Personal ID expiration date"
          },
          "personal_id_country": {
            "type": "string",
            "description": "Personal ID country of issuance. Format: ISO 3166-2 Country Code"
          },
          "personal_email": {
            "type": "string",
            "maxLength": "50",
            "format": "email",
            "description": "Personal email"
          },
          "personal_mobile_number": {
            "type": "string",
            "minLength": "7",
            "maxLength": "15",
            "description": "Personal mobile number. Supports E.164 international format and local formats"
          },
          "gender": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_Gender"
              }
            ],
            "description": "Gender"
          },
          "occupation": {
            "type": "string",
            "maxLength": "50",
            "description": "Occupation"
          },
          "date_of_incorporation": {
            "type": "string",
            "format": "date",
            "description": "Date of incorporation of the business recipient"
          },
          "registration_number": {
            "type": "string",
            "maxLength": "50",
            "description": "Registration number of the business recipient"
          },
          "business_phone_number": {
            "type": "string",
            "minLength": "7",
            "maxLength": "15",
            "description": "Phone number of the business recipient"
          },
          "nature_of_business": {
            "type": "string",
            "maxLength": "50",
            "description": "Nature of business"
          }
        }
      },
      "Payouts_v3_RecipientAccountDetails": {
        "type": "object",
        "required": [
          "currency",
          "account_country",
          "account_holder_name",
          "account_number",
          "routing_type_1",
          "routing_value_1"
        ],
        "properties": {
          "currency": {
            "type": "string",
            "description": "Currency of the account. Format: ISO 4217 Currency Code"
          },
          "account_country": {
            "type": "string",
            "description": "Account country code. Format: ISO 3166-2 Country Code"
          },
          "account_holder_name": {
            "type": "string",
            "maxLength": "255",
            "description": "Account name of the recipient's account"
          },
          "account_number": {
            "type": "string",
            "description": "Account number"
          },
          "routing_type_1": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_RoutingType1"
              }
            ],
            "description": "Routing code type"
          },
          "routing_value_1": {
            "type": "string",
            "description": "Routing type value"
          },
          "routing_type_2": {
            "type": "string",
            "description": "Routing code subtype (reserved for future supported corridors)"
          },
          "routing_value_2": {
            "type": "string",
            "description": "Routing subtype value"
          },
          "account_type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Payouts_v3_AccountType"
              }
            ],
            "description": "Account type"
          }
        }
      },
      "Payouts_v3_UnderlyingDocumentType": {
        "type": "string",
        "enum": [
          "INVOICE",
          "PURCHASE_ORDER",
          "CONTRACT",
          "DELIVERY_SLIP",
          "CUSTOMS_DECLARATION",
          "BILL_OF_LADING",
          "OTHERS"
        ]
      },
      "Payouts_v3_PersonalIdType": {
        "type": "string",
        "enum": [
          "BIRTH_CERTIFICATE",
          "BANK_STATEMENT",
          "DRIVING_LICENSE",
          "IDENTITY_CARD",
          "PASSPORT",
          "VISA",
          "BUSINESS_REGISTRATION",
          "BUSINESS_LICENSE"
        ]
      },
      "Payouts_v3_Gender": {
        "type": "string",
        "enum": [
          "MALE",
          "FEMALE",
          "OTHER"
        ]
      },
      "Payouts_v3_RoutingType1": {
        "type": "string",
        "enum": [
          "swift_code",
          "iban",
          "sort_code",
          "aba",
          "bsb",
          "wallet",
          "clabe"
        ]
      },
      "Payouts_v3_AccountType": {
        "type": "string",
        "enum": [
          "CHECKING",
          "SAVINGS"
        ]
      }
    }
  }
}
````