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.

For archived content, access the previous documentation here or the previous API reference here.

Create Payout

Prev Next
Post
/v3/payouts

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

Security
HTTP
Type Basic

Secret API Key authentication. Required permission: MONEY-OUT

Header parameters
api-version
stringRequired

The version of the API. Value: "2025-09-09"

idempotency-key
string

Unique reference assigned to the payout for idempotency.

When 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.

Behaviors:

  • Same Idempotency Key + different request body → DUPLICATE_ERROR
  • Same Idempotency Key + same request body → returns the initial Payout Object from the first attempt

The Idempotency Key is scoped per business ID — two merchants can safely use the same key without conflict. If left blank, Xendit will assign a random UUID.

Max length100
Body parameters
Create Domestic Payout to Wallet

Create Domestic Payout to Wallet

{
  "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

Create Cross-Border Payout

{
  "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"
}
Expand All
object
reference_id
string Required

ID provided by merchant to identify the request

Max length255
sender
object

Contains sender information. Only allowed for FIs (Financial Institutions)

type
string Required

Entity type of the sender

Valid values[ "INDIVIDUAL", "BUSINESS" ]
business_name
string

Name of the business sender. Required if type is BUSINESS

Max length50
given_name
string

First name of the sender. Required if type is INDIVIDUAL

Max length50
surname
string

Last name of the sender. Required if type is INDIVIDUAL

Max length50
given_name_non_roman
string

First non-roman name of the sender

Max length50
surname_non_roman
string

Last non-roman name of the sender

Max length50
details
object

Details of the sender

date_of_birth
string (date)

Date of birth

country_of_birth
string

Country of birth. Format: ISO 3166-2 Country Code

nationality
string

Nationality. Format: ISO 3166-2 Country Code

personal_id_type
string

Personal ID type

Valid values[ "BIRTH_CERTIFICATE", "BANK_STATEMENT", "DRIVING_LICENSE", "IDENTITY_CARD", "PASSPORT", "VISA", "BUSINESS_REGISTRATION", "BUSINESS_LICENSE" ]
personal_id_value
string

Personal ID value

Max length255
personal_id_expiration_date
string (date)

Personal ID expiration date

personal_id_country
string

Personal ID country of issuance. Format: ISO 3166-2 Country Code

personal_email
string (email)

Personal email

Max length50
personal_mobile_number
string

Personal mobile number. Supports E.164 international format and local formats

Min length7
Max length15
gender
string

Gender

Valid values[ "MALE", "FEMALE", "OTHER" ]
occupation
string

Occupation

Max length50
date_of_incorporation
string (date)

Date of incorporation of the business sender

registration_number
string

Registration number of the business sender

Max length50
business_phone_number
string

Phone number of the business sender

Min length7
Max length15
nature_of_business
string

Nature of business

Max length50
address
object

Address details of the sender

country
string

Country. Format: ISO 3166-2 Country Code

province_state
string

Province, state or region

Max length255
city
string

City, village or town

Max length255
street_line1
string

Line 1 of street address e.g., building name and apartment number

Max length255
street_line2
string

Line 2 of street address e.g., street number and name

Max length255
postal_code
string

ZIP/Postal Code

Max length255
recipient
object Required

Contains recipient information

type
string Required

Entity type of the recipient

Valid values[ "INDIVIDUAL", "BUSINESS" ]
business_name
string

Name of the business recipient. Required if type is BUSINESS

Max length50
given_name
string

First name of the recipient. Required if type is INDIVIDUAL

Max length50
surname
string

Last name of the recipient. Required if type is INDIVIDUAL

Max length50
given_name_non_roman
string

First non-roman name of the recipient

Max length50
surname_non_roman
string

Last non-roman name of the recipient

Max length50
relationship
string Required

Recipient's relationship to the sender in the context of the transaction

Valid values[ "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" ]
details
object

Details of the recipient

date_of_birth
string (date)

Date of birth

country_of_birth
string

Country of birth. Format: ISO 3166-2 Country Code

nationality
string

Nationality. Format: ISO 3166-2 Country Code

personal_id_type
string

Personal ID type

Valid values[ "BIRTH_CERTIFICATE", "BANK_STATEMENT", "DRIVING_LICENSE", "IDENTITY_CARD", "PASSPORT", "VISA", "BUSINESS_REGISTRATION", "BUSINESS_LICENSE" ]
personal_id_value
string

Personal ID value

Max length255
personal_id_expiration_date
string (date)

Personal ID expiration date

personal_id_country
string

Personal ID country of issuance. Format: ISO 3166-2 Country Code

personal_email
string (email)

Personal email

Max length50
personal_mobile_number
string

Personal mobile number. Supports E.164 international format and local formats

Min length7
Max length15
gender
string

Gender

Valid values[ "MALE", "FEMALE", "OTHER" ]
occupation
string

Occupation

Max length50
date_of_incorporation
string (date)

Date of incorporation of the business recipient

registration_number
string

Registration number of the business recipient

Max length50
business_phone_number
string

Phone number of the business recipient

Min length7
Max length15
nature_of_business
string

Nature of business

Max length50
account_details
object Required

Recipient's account details where the payment will be credited

currency
string Required

Currency of the account. Format: ISO 4217 Currency Code

account_country
string Required

Account country code. Format: ISO 3166-2 Country Code

account_holder_name
string Required

Account name of the recipient's account

Max length255
account_number
string Required

Account number

routing_type_1
string Required

Routing code type

Valid values[ "swift_code", "iban", "sort_code", "aba", "bsb", "wallet", "clabe" ]
routing_value_1
string Required

Routing type value

routing_type_2
string

Routing code subtype (reserved for future supported corridors)

routing_value_2
string

Routing subtype value

account_type
string

Account type

Valid values[ "CHECKING", "SAVINGS" ]
address
object

Address details of the recipient

country
string

Country. Format: ISO 3166-2 Country Code

province_state
string

Province, state or region

Max length255
city
string

City, village or town

Max length255
street_line1
string

Line 1 of street address e.g., building name and apartment number

Max length255
street_line2
string

Line 2 of street address e.g., street number and name

Max length255
postal_code
string

ZIP/Postal Code

Max length255
payout_details
object Required

Detailed information about the payout

quote_id
string

Quote ID received from Create Quote API

source_currency
string

Origin currency of the Payout. Required if quote_id is not provided

Valid values[ "USD", "SGD", "IDR", "PHP", "MYR", "THB", "VND", "HKD", "MXN", "CNY", "KRW", "AUD", "EUR" ]
source_amount
integer

Source amount in source currency, in minor units. Must be empty if destination_amount is filled.

A minor unit is the smallest unit of a currency. Most currencies have 2 decimals, others have 0. Examples: PHP 10.00 → 1000, IDR 10 → 10.

destination_currency
string

Destination currency of the Payout. Required if quote_id is not provided

Valid values[ "USD", "SGD", "IDR", "PHP", "MYR", "THB", "VND", "HKD", "MXN", "CNY", "KRW", "AUD", "EUR" ]
destination_amount
integer

Payout amount in destination currency, in minor units. Must be empty if source_amount is filled.

A minor unit is the smallest unit of a currency. Most currencies have 2 decimals, others have 0. Examples: PHP 10.00 → 1000, IDR 10 → 10.

source_of_fund
string Required

Source of fund of the payout

Valid values[ "INVESTMENT", "PERSONAL_SAVINGS", "BUSINESS_REVENUE", "LEGACY", "BUSINESS_ARRANGEMENT", "LOAN", "SALARY", "OTHER" ]
purpose_code
string Required

Purpose of the payout

Valid values[ "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" ]
description
string

Free text description shown in recipient's bank statement, if supported

Max length100
underlying_documents
Array of object (Payouts_v3_UnderlyingDocument)

Underlying document attachments

object
type
string

Type of the document

Valid values[ "INVOICE", "PURCHASE_ORDER", "CONTRACT", "DELIVERY_SLIP", "CUSTOMS_DECLARATION", "BILL_OF_LADING", "OTHERS" ]
reference_no
string

Reference number of the document

Max length100
file_id
string

File ID of the document

metadata
object

Object of additional information the merchant may use

property*
Responses
200

The request has succeeded.

Create Domestic Payout to Wallet

Create Domestic Payout to Wallet

{
  "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

Create Cross-Border Payout

{
  "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"
}
Expand All
object

Payout Object

payout_id
string

Unique payout id in UUID format, prefixed with po-

status
string

Status of the payout. See Payout Status Lifecycle

Valid values[ "ACCEPTED", "PENDING_COMPLIANCE_REVIEW", "REJECTED", "ROUTING", "REQUESTED", "READY", "LOCKED", "EXPIRED", "FAILED", "SUCCEEDED", "CANCELLED", "REVERSED" ]
reference_id
string

ID provided by merchant to identify the request

type
string

Payout type

Valid values[ "B2B", "B2C", "C2C", "C2B" ]
processor_reference
string

Payout reference from Xendit's processor

source_currency
string

Origin currency of the Payout

Valid values[ "USD", "SGD", "IDR", "PHP", "MYR", "THB", "VND", "HKD", "MXN", "CNY", "KRW", "AUD", "EUR" ]
source_amount
integer

Origin amount of the Payout in minor units.

A minor unit is the smallest unit of a currency. Most currencies have 2 decimals, others have 0. Examples: PHP 10.00 → 1000, IDR 10 → 10.

destination_currency
string

Destination currency of the Payout

Valid values[ "USD", "SGD", "IDR", "PHP", "MYR", "THB", "VND", "HKD", "MXN", "CNY", "KRW", "AUD", "EUR" ]
destination_amount
integer

Destination amount of the Payout in minor units.

A minor unit is the smallest unit of a currency. Most currencies have 2 decimals, others have 0. Examples: PHP 10.00 → 1000, IDR 10 → 10.

sender
object

Contains sender information

type
string

Entity type of the sender

Valid values[ "INDIVIDUAL", "BUSINESS" ]
business_name
string

Name of the business sender. Required if type is BUSINESS

Max length50
given_name
string

First name of the sender. Required if type is INDIVIDUAL

Max length50
surname
string

Last name of the sender. Required if type is INDIVIDUAL

Max length50
given_name_non_roman
string

First non-roman name of the sender

Max length50
surname_non_roman
string

Last non-roman name of the sender

Max length50
details
object

Details of the sender

date_of_birth
string (date)

Date of birth

country_of_birth
string

Country of birth. Format: ISO 3166-2 Country Code

nationality
string

Nationality. Format: ISO 3166-2 Country Code

personal_id_type
string

Personal ID type

Valid values[ "BIRTH_CERTIFICATE", "BANK_STATEMENT", "DRIVING_LICENSE", "IDENTITY_CARD", "PASSPORT", "VISA", "BUSINESS_REGISTRATION", "BUSINESS_LICENSE" ]
personal_id_value
string

Personal ID value

Max length255
personal_id_expiration_date
string (date)

Personal ID expiration date

personal_id_country
string

Personal ID country of issuance. Format: ISO 3166-2 Country Code

personal_email
string (email)

Personal email

Max length50
personal_mobile_number
string

Personal mobile number. Supports E.164 international format and local formats

Min length7
Max length15
gender
string

Gender

Valid values[ "MALE", "FEMALE", "OTHER" ]
occupation
string

Occupation

Max length50
date_of_incorporation
string (date)

Date of incorporation of the business sender

registration_number
string

Registration number of the business sender

Max length50
business_phone_number
string

Phone number of the business sender

Min length7
Max length15
nature_of_business
string

Nature of business

Max length50
address
object

Address details of the sender

country
string

Country. Format: ISO 3166-2 Country Code

province_state
string

Province, state or region

Max length255
city
string

City, village or town

Max length255
street_line1
string

Line 1 of street address e.g., building name and apartment number

Max length255
street_line2
string

Line 2 of street address e.g., street number and name

Max length255
postal_code
string

ZIP/Postal Code

Max length255
recipient
object

Contains recipient information

type
string

Entity type of the recipient

Valid values[ "INDIVIDUAL", "BUSINESS" ]
business_name
string

Name of the business recipient. Required if type is BUSINESS

Max length50
given_name
string

First name of the recipient. Required if type is INDIVIDUAL

Max length50
surname
string

Last name of the recipient. Required if type is INDIVIDUAL

Max length50
given_name_non_roman
string

First non-roman name of the recipient

Max length50
surname_non_roman
string

Last non-roman name of the recipient

Max length50
relationship
string

Recipient's relationship to the sender in the context of the transaction

Valid values[ "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" ]
details
object

Details of the recipient

date_of_birth
string (date)

Date of birth

country_of_birth
string

Country of birth. Format: ISO 3166-2 Country Code

nationality
string

Nationality. Format: ISO 3166-2 Country Code

personal_id_type
string

Personal ID type

Valid values[ "BIRTH_CERTIFICATE", "BANK_STATEMENT", "DRIVING_LICENSE", "IDENTITY_CARD", "PASSPORT", "VISA", "BUSINESS_REGISTRATION", "BUSINESS_LICENSE" ]
personal_id_value
string

Personal ID value

Max length255
personal_id_expiration_date
string (date)

Personal ID expiration date

personal_id_country
string

Personal ID country of issuance. Format: ISO 3166-2 Country Code

personal_email
string (email)

Personal email

Max length50
personal_mobile_number
string

Personal mobile number. Supports E.164 international format and local formats

Min length7
Max length15
gender
string

Gender

Valid values[ "MALE", "FEMALE", "OTHER" ]
occupation
string

Occupation

Max length50
date_of_incorporation
string (date)

Date of incorporation of the business recipient

registration_number
string

Registration number of the business recipient

Max length50
business_phone_number
string

Phone number of the business recipient

Min length7
Max length15
nature_of_business
string

Nature of business

Max length50
account_details
object

Recipient's account details where the payment will be credited

currency
string

Currency of the account. Format: ISO 4217 Currency Code

account_country
string

Account country code. Format: ISO 3166-2 Country Code

account_holder_name
string

Account name of the recipient's account

Max length255
account_number
string

Account number

routing_type_1
string

Routing code type

Valid values[ "swift_code", "iban", "sort_code", "aba", "bsb", "wallet", "clabe" ]
routing_value_1
string

Routing type value

routing_type_2
string

Routing code subtype (reserved for future supported corridors)

routing_value_2
string

Routing subtype value

account_type
string

Account type

Valid values[ "CHECKING", "SAVINGS" ]
address
object

Address details of the recipient

country
string

Country. Format: ISO 3166-2 Country Code

province_state
string

Province, state or region

Max length255
city
string

City, village or town

Max length255
street_line1
string

Line 1 of street address e.g., building name and apartment number

Max length255
street_line2
string

Line 2 of street address e.g., street number and name

Max length255
postal_code
string

ZIP/Postal Code

Max length255
source_of_fund
string

Source of fund of the payout

Valid values[ "INVESTMENT", "PERSONAL_SAVINGS", "BUSINESS_REVENUE", "LEGACY", "BUSINESS_ARRANGEMENT", "LOAN", "SALARY", "OTHER" ]
purpose_code
string

Purpose of the payout

Valid values[ "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" ]
description
string

Free text description shown in recipient's bank statement, if supported

Max length100
underlying_documents
Array of object (Payouts_v3_UnderlyingDocument)

Underlying document attachments

object
type
string

Type of the document

Valid values[ "INVOICE", "PURCHASE_ORDER", "CONTRACT", "DELIVERY_SLIP", "CUSTOMS_DECLARATION", "BILL_OF_LADING", "OTHERS" ]
reference_no
string

Reference number of the document

Max length100
file_id
string

File ID of the document

created
string (date-time)

Timestamp when the payout was made. Format: ISO 8601, UTC+0

updated
string (date-time)

Timestamp when the payout was last updated. Format: ISO 8601, UTC+0

estimated_arrival_time
string (date-time)

Estimated time of arrival of funds in destination account. UTC+0

failure_code
string

Failure reason of the Payout. See Payout Status Lifecycle

Valid values[ "INSUFFICIENT_BALANCE", "INVALID_DESTINATION", "DESTINATION_MAXIMUM_LIMIT", "ACCOUNT_NAME_MISMATCH", "REJECTED_BY_CHANNEL", "TEMPORARY_TRANSFER_ERROR", "TRANSFER_ERROR", "SLS_SENDER", "SLS_RECIPIENT" ]
business_id
string

Your Xendit Business ID

metadata
object

Object of additional information the merchant may use

property*
400

Bad request

OneOf
Payouts_v3_Http400ApiValidationError
object (Payouts_v3_Http400ApiValidationError)
error_code
string
Valid values[ "API_VALIDATION_ERROR" ]
message
string
Valid values[ "Inputs are failing validation. The errors field contains details about which fields are violating validation." ]
Payouts_v3_Http400ApiValidationError_BothAmounts
object (Payouts_v3_Http400ApiValidationError_BothAmounts)
error_code
string
Valid values[ "API_VALIDATION_ERROR" ]
message
string
Valid values[ "Both source and destination amounts were specified. Please input only one of these amounts." ]
Payouts_v3_Http400InvalidValueError_UnsupportedSourceCurrency
object (Payouts_v3_Http400InvalidValueError_UnsupportedSourceCurrency)
error_code
string
Valid values[ "INVALID_VALUE_ERROR" ]
message
string
Valid values[ "The source currency specified in the request is not supported. Please check our documentation for currencies available." ]
Payouts_v3_Http400InvalidValueError_UnsupportedDestinationCurrency
object (Payouts_v3_Http400InvalidValueError_UnsupportedDestinationCurrency)
error_code
string
Valid values[ "INVALID_VALUE_ERROR" ]
message
string
Valid values[ "The destination currency specified in the request is not supported. Please check our documentation for currencies available." ]
Payouts_v3_Http400InvalidValueError_AmountTooLow
object (Payouts_v3_Http400InvalidValueError_AmountTooLow)
error_code
string
Valid values[ "INVALID_VALUE_ERROR" ]
message
string
Valid values[ "The transfer amount requested is lower than the prescribed minimum for the region. Amend the transfer amount before retrying." ]
Payouts_v3_Http400InvalidValueError_AmountTooHigh
object (Payouts_v3_Http400InvalidValueError_AmountTooHigh)
error_code
string
Valid values[ "INVALID_VALUE_ERROR" ]
message
string
Valid values[ "The transfer amount requested is higher than the prescribed maximum for the region. Amend the transfer amount before retrying." ]
Payouts_v3_Http400InvalidQuote
object (Payouts_v3_Http400InvalidQuote)
error_code
string
Valid values[ "INVALID_QUOTE" ]
message
string
Valid values[ "This quote was created for a different transaction type. Please create a new Quote with the correct transaction type." ]
401

Unauthorized

object
error_code
string
Valid values[ "INVALID_API_KEY" ]
message
string
Valid values[ "API key format is invalid" ]
403

Forbidden

OneOf
Payouts_v3_Http403RequestForbiddenError
object (Payouts_v3_Http403RequestForbiddenError)
error_code
string
Valid values[ "REQUEST_FORBIDDEN_ERROR" ]
message
string
Valid values[ "The API key is forbidden to perform this request" ]
Payouts_v3_Http403RequestForbiddenError_Account
object (Payouts_v3_Http403RequestForbiddenError_Account)
error_code
string
Valid values[ "REQUEST_FORBIDDEN_ERROR" ]
message
string
Valid values[ "Your account is forbidden to perform this request" ]
Payouts_v3_Http403InvalidMerchantSettings_Payout
object (Payouts_v3_Http403InvalidMerchantSettings_Payout)
error_code
string
Valid values[ "INVALID_MERCHANT_SETTINGS" ]
message
string
Valid values[ "Payout failed because the source currency has not been activated. Please reach out to Xendit to activate this currency before retrying." ]
404

Not found

object
error_code
string
Valid values[ "DATA_NOT_FOUND" ]
message
string
Valid values[ "The Quote ID specified cannot be found" ]
409

Conflict

object
error_code
string
Valid values[ "DUPLICATE_ERROR" ]
message
string
Valid values[ "A payout with this idempotency key already exists. If you meant to execute a different request, please use another idempotency key." ]
500

Internal server error

object
error_code
string
Valid values[ "SERVER_ERROR" ]
message
string
Valid values[ "An unexpected error occurred" ]