# Update a Payout ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /v1/payouts/{id}: post: summary: Update a Payout deprecated: false description: '' tags: - API Reference/Payouts/Payouts parameters: - name: id in: path description: '' required: true schema: type: string - name: Accept in: header description: '' required: true example: application/json schema: type: string - name: Content-Type in: header description: '' required: true example: application/json schema: type: string requestBody: content: application/json: schema: type: object properties: metadata: type: string description: 'Set of key-value pairs that you can attach to an object. ' x-apifox-orders: - metadata x-apifox-ignore-properties: [] example: metadata: key1: value1 responses: '200': description: '' content: application/json: schema: type: object x-apifox-refs: 01GK13YBWJ1EHMA84X20DYSKT1: $ref: '#/components/schemas/Payout' x-apifox-overrides: statement_descriptor: null source_type: null reversed_by: null original_payout: null arrival_date: null automatic: null x-apifox-orders: - 01GK13YBWJ1EHMA84X20DYSKT1 properties: id: type: string description: Unique identifier for the object, "po_XXXX" object: type: string description: '"payout"' created: type: integer description: >- Time at which the object was created. Measured in seconds since the Unix epoch. payment_currency: type: string description: Three-letter ISO currency code, in uppercase. payment_amount: type: integer description: >- Conditional required.Amount (in cents) to be transferred to your bank account or debit card. source_currency: type: string description: >- Source currency, i.e. the currency that the Payer uses to fund the payment source_amount: type: integer description: Conditional required. Source amount in source_currency description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. metadata: type: object properties: {} x-apifox-orders: [] description: >- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. x-apifox-ignore-properties: [] status: type: string description: >- Current status of the payout: paid, pending, in_transit, canceled or failed. A payout is pending until it is submitted to the bank, when it becomes in_transit. The status then changes to paid if the transaction goes through, or to failed or canceled (within 5 business days). livemode: type: boolean description: >- Has the value true if the object exists in live mode or the value false if the object exists in test mode. beneficiary_data: description: >- The entiry who receives the payout. Conditional required: one of beneficiary and beneficiary_data are required. type: object x-apifox-refs: 01JC0GB8CXY6973YAV89V0XNA5: &ref_2 $ref: '#/components/schemas/Beneficiary' x-apifox-overrides: {} x-apifox-orders: - 01JC0GB8CXY6973YAV89V0XNA5 properties: id: type: string description: Unique identifier for the object, "bn_xxxxx". object: type: string description: '"beneficiary"' created: type: integer description: >- The time at which the object was created. Measured in seconds since the Unix epoch. destination_data: type: object properties: destination_type: type: string description: Payment method enum: - bank_account - card - carrier_billing - alipay x-apifox-enum: - value: bank_account name: '' description: '' - value: card name: '' description: '' - value: carrier_billing name: '' description: '' - value: alipay name: '' description: '' bank_account: description: Condtional requried type: object x-apifox-refs: {} x-apifox-orders: - account_number - iban - account_holder_name - account_holder_type - phone_number - email - country - swift - dob - gender - certificate - bank_name - metadata - routing_number - routing_type - description properties: account_number: type: string description: The number of the bank account iban: type: string description: >- International bank account number, mostly for european countries account_holder_name: type: string description: >- The name of the person or business that owns the bank account. If the account holder is Chinese, this field should be in Chinese characters. account_holder_type: type: string description: >- The type of entity that holds the account. This can be either individual or company. enum: - individual - company x-apifox-enum: - value: individual name: '' description: '' - value: company name: '' description: '' phone_number: type: string description: >- The phone number of the beneficiary. The format of phone number should be like regioncode-phonenumber. e.g.1-123456. email: type: string description: The email of the beneficiary country: type: string description: >- Two-letter ISO code representing the country the bank account is located in. swift: type: string description: The swift code of this bank account. dob: type: object properties: day: type: string description: The day of birth, between 1 and 31. month: type: string description: The month of birth, between 1 and 12. year: type: string description: The four-digit year of birth. x-apifox-orders: - day - month - year required: - day - month - year description: >- When the beneficiary is a person, the person’s date of birth. x-apifox-ignore-properties: [] gender: type: string description: >- The person’s gender (International regulations require either “male” or “female”). enum: - male - female x-apifox-enum: - value: male name: '' description: '' - value: female name: '' description: '' certificate: type: object properties: certificate_type: type: string enum: - id_card - national_id - driving_license - social_security - tax_id - resident_card - alien_registration - employer_id x-apifox-enum: - value: id_card name: '' description: '' - value: national_id name: '' description: '' - value: driving_license name: '' description: '' - value: social_security name: '' description: '' - value: tax_id name: '' description: '' - value: resident_card name: '' description: '' - value: alien_registration name: '' description: '' - value: employer_id name: '' description: '' certificate_number: type: string x-apifox-orders: - certificate_type - certificate_number description: Condtional requried x-apifox-ignore-properties: [] bank_name: type: string description: >- Name of the bank associated with the routing number metadata: type: object properties: {} description: >- Set of key-value pairs that you can attach to an object. x-apifox-orders: [] x-apifox-ignore-properties: [] routing_number: type: string description: >- The routing transit number for the bank account. routing_type: type: string description: The routing transit type for the bank account. enum: - aba - sort_code - cc - bsb - zengin - biller_code x-apifox-enum: - value: aba name: '' description: '' - value: sort_code name: '' description: '' - value: cc name: '' description: '' - value: bsb name: '' description: '' - value: zengin name: '' description: '' - value: biller_code name: '' description: '' description: type: string description: >- It can be used as a merchant order number or a transfer note. required: - account_number - account_holder_name - account_holder_type - phone_number - country - swift x-apifox-ignore-properties: [] card: description: Condtional requried type: object x-apifox-refs: {} x-apifox-orders: - name - number - description - billing_address - metadata properties: name: type: string description: Cardholder name. number: type: string description: Card number description: type: string description: >- Condtional requried. It can be used as a merchant order number or a transfer note. billing_address: type: object x-apifox-refs: 01JCYZV2FZ407X0Q0F4GGGV10R: &ref_1 $ref: '#/components/schemas/Billing%20Details' x-apifox-overrides: name: null phone: null email: null x-apifox-orders: - 01JCYZV2FZ407X0Q0F4GGGV10R properties: address: &ref_0 $ref: '#/components/schemas/Address' x-apifox-ignore-properties: - address metadata: type: object properties: {} x-apifox-orders: [] description: >- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. x-apifox-ignore-properties: [] required: - name - number x-apifox-ignore-properties: [] carrier_billing: type: object properties: carrier: type: string description: The telecom carrier of the mobile. enum: - megafon - tmobile - beeline - mts - tele2 - yota x-apifox-enum: - value: megafon name: '' description: Megafon - value: tmobile name: '' description: T-Mobile - value: beeline name: '' description: Beeline - value: mts name: '' description: MTS - value: tele2 name: '' description: Tele2 - value: yota name: '' description: Yota phone_number: type: string description: >- The format of phone number should be like regioncode-phonenumber. e.g.86-123456. country: type: string description: type: string description: >- It can be used as a merchant order number or a transfer note. x-apifox-orders: - carrier - phone_number - country - description description: Condtional requried required: - carrier - phone_number - country x-apifox-ignore-properties: [] alipay: type: object properties: user_id: type: string description: >- This is unique ID registered by beneficiary in Alipay+ with a phone number or email address. The format of phone number should be like regioncode-phonenumber. e.g.86-123456. first_name: type: string description: >- The given name of a person. Only support Chinese Pinyin last_name: type: string description: >- The surname or family name of a person. Only support Chinese Pinyin x-apifox-orders: - user_id - first_name - last_name required: - user_id - first_name - last_name description: Condtional requried x-apifox-ignore-properties: [] imps: type: object properties: account_number: type: string description: Account number of the beneficairy of IMPS phone_number: type: string description: >- The phone number of the beneficiary. The format of phone number should be like regioncode-phonenumber. e.g.1-123456. email: type: string description: The format of email. e.g.XXX@XXX.XXX name: type: string description: The full name of a person. bank_code: type: string description: >- Bank code under the IFSC (Indian Financial System Code). Format: fixed length of 11 characters, XXXX0XXXXXX – consisting of 4 letters + 0 + 6 digits x-apifox-orders: - account_number - phone_number - email - name - bank_code required: - account_number - phone_number - email - name - bank_code description: Condtional requried x-apifox-ignore-properties: [] upi: type: object properties: vpa: type: string description: >- Email ID of VPA（Virtual Payment Address）. e.g.XXX@XXX.XXX phone_number: type: string description: >- The phone number of the beneficiary. The format of phone number should be like regioncode-phonenumber. e.g.1-123456. x-apifox-orders: - vpa - phone_number description: Condtional requried required: - vpa - phone_number x-apifox-ignore-properties: [] jazzcash: type: object properties: account_number: type: string name: type: string phone_number: type: string email: type: string dob: type: string gender: type: string x-apifox-orders: - account_number - name - phone_number - email - dob - gender description: Condtional requried x-apifox-ignore-properties: [] easypaisa: type: object properties: account_number: type: string name: type: string phone_number: type: string email: type: string dob: type: string gender: type: string certificate: type: object properties: certificate_type: type: string enum: - cnic x-apifox-enum: - value: cnic name: '' description: '' certificate_number: type: string x-apifox-orders: - certificate_type - certificate_number x-apifox-ignore-properties: [] x-apifox-orders: - account_number - name - phone_number - email - dob - gender - certificate description: Condtional requried x-apifox-ignore-properties: [] x-apifox-orders: - destination_type - bank_account - card - carrier_billing - alipay - imps - upi - jazzcash - easypaisa description: >- Create a new card or bank account for payouts was sent to. Condtional requried, one of destination and destination is required. required: - destination_type x-apifox-ignore-properties: [] nickname: type: string description: Nickname of beneficiary for quickly retrieving metadata: type: object properties: {} x-apifox-orders: [] description: >- Set of key-value pairs attaching to an object. This can be a channel for customers that provides additional material about the beneficiary x-apifox-ignore-properties: [] livemode: type: boolean description: >- Has the value true if the object exists in live mode or the value false if the object exists in test mode. required: - destination_data x-apifox-ignore-properties: - id - object - created - destination_data - nickname - metadata - livemode beneficiary: type: string description: >- ID of the beneficiary the payout was sent to. Conditional required: one of beneficiary and beneficiary_data are required. failure_code: type: string description: >- Error code explaining reason for payout failure if available. enum: - account_closed - account_frozen - bank_account_restricted - bank_ownership_changed - could_not_process - debit_not_authorized - declined - insufficient_funds - invalid_account_number - incorrect_account_holder_name - incorrect_account_holder_address - incorrect_account_holder_tax_id - invalid_currency - no_account - unsupported_card x-apifox-enum: - value: account_closed name: '' description: The bank account has been closed. - value: account_frozen name: '' description: The bank account has been frozen. - value: bank_account_restricted name: '' description: >- The bank account has restrictions on either the type, or the number, of payouts allowed. This normally indicates that the bank account is a savings or other non-checking account. - value: bank_ownership_changed name: '' description: >- The destination bank account is no longer valid because its branch has changed ownership. - value: could_not_process name: '' description: The bank could not process this payout. - value: debit_not_authorized name: '' description: >- Debit transactions are not approved on the bank account. - value: declined name: '' description: >- The bank has declined this transfer. Please contact the bank before retrying. - value: insufficient_funds name: '' description: >- Your account has insufficient funds to cover the payout. - value: invalid_account_number name: '' description: >- The routing number seems correct, but the account number is invalid. - value: incorrect_account_holder_name name: '' description: >- Your bank notified us that the bank account holder name on file is incorrect. - value: incorrect_account_holder_address name: '' description: >- Your bank notified us that the bank account holder address on file is incorrect. - value: incorrect_account_holder_tax_id name: '' description: >- Your bank notified us that the bank account holder tax ID on file is incorrect. - value: invalid_currency name: '' description: >- The bank was unable to process this payout because of its currency. This is probably because the bank account cannot accept payments in that currency. - value: no_account name: '' description: >- The bank account details on file are probably incorrect. No bank account could be located with those details. - value: unsupported_card name: '' description: The bank no longer supports payouts to this card. failure_message: type: string description: >- Message to user further explaining reason for payout failure if available. payer_data: &ref_77 $ref: '#/components/schemas/Payer' payment_intents_id: type: array items: type: string description: >- A list of payment intent id attached to this payout object as the payouts was sent to China. method: type: string description: >- (未实现)The method used to send this payout, which can be standard or instant. enum: - standard - instant x-apifox-enum: - value: standard name: '' description: '' - value: instant name: '' description: '' balance_transaction: type: string description: >- (未实现)ID of the balance transaction that describes the impact of this payout on your account balance. failure_balance_transaction: type: string description: >- (未实现)If the payout failed or was canceled, this will be the ID of the balance transaction that reversed the initial balance transaction, and puts the funds from the failed payout back in your balance. merchant_payout_id: type: string x-apifox-ignore-properties: - id - object - created - payment_currency - payment_amount - source_currency - source_amount - description - metadata - status - livemode - beneficiary_data - beneficiary - failure_code - failure_message - payer_data - payment_intents_id - method - balance_transaction - failure_balance_transaction - merchant_payout_id example: id: po_1597440940476203008 object: payout created: 1669694576000 currency: CNY amount: 666 description: You can add description here metadata: null status: pending destination: id: ba_1597440945916215296 object: bank_account created: 1669694575000 country: CN currency: CNY customer: null fingerprint: eb5b68642b4eabe8c8adb110240150e5386cacea last4: '0002' metadata: null swift: null account_holder_name: xxxx ltd account_holder_type: company bank_name: null routing_number: null livemode: false type: bank_account method: standard beneficiary: id: bf_1597440940492980224 object: beneficiary type: business business: address: city: Beijing country: CN line1: Block 3A line2: XX Park state: Beijing postal_code: '323111' company_registered_name: XXX ltd additional_info: business_area: null business_phone_number: null business_registration_number: 32342353535334234MCA4 legal_rep_first_name: Ming legal_rep_last_name: Zhang legal_rep_id_type: NATIONAL_ID legal_rep_id_number: 233923874838920238X legal_rep_email: xxx@email.com legal_rep_phone: '13727282938' payee: null balance_transaction: null failure_balance_transaction: null failure_code: null failure_message: null payment_intents_id: - pi_1577840204872417280 currency_account: null headers: {} x-apifox-name: OK security: - basic: [] x-apifox-folder: API Reference/Payouts/Payouts x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/1296482/apis/api-42648519-run components: schemas: Payer: type: object properties: payer_type: type: string enum: - individual - business x-apifox-enum: - value: individual name: '' description: '' - value: business name: '' description: '' individual: type: object properties: first_name: type: string description: The given name of a person last_name: type: string description: 'The surname or family name of a person. ' certificate: type: object properties: certificate_type: type: string enum: - national_id - driving_license - social_security - tax_id - resident_card - alien_registration - employer_id x-apifox-enum: - value: national_id name: '' description: '' - value: driving_license name: '' description: '' - value: social_security name: '' description: '' - value: tax_id name: '' description: '' - value: resident_card name: '' description: '' - value: alien_registration name: '' description: '' - value: employer_id name: '' description: '' certificate_number: type: string description: >- The person’s ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. x-apifox-orders: - certificate_type - certificate_number description: Condtional requried required: - certificate_number x-apifox-ignore-properties: [] address: type: object x-apifox-refs: {} x-apifox-orders: - country - line1 - state - city - line2 - postal_code properties: country: type: string description: Two-letter country code (ISO 3166-1 alpha-2 ). line1: type: string description: Address line 1 (e.g., street, PO Box, or company name). state: type: string description: State, county, province, or region. city: type: string description: City, district, suburb, town, or village. line2: type: string description: Address line 2 (e.g., apartment, suite, unit, or building). postal_code: type: string description: ZIP or postal code. required: - country - line1 x-apifox-ignore-properties: [] x-apifox-orders: - first_name - last_name - certificate - address required: - first_name - last_name - certificate - address x-apifox-ignore-properties: [] business: type: object properties: business_legal_name: type: string address: type: object properties: country: type: string description: Two-letter country/region code (ISO 3166-1 alpha-2 ). line1: type: string description: Address line 1 (e.g., street, PO Box, or company name). city: type: string description: City, district, suburb, town, or village. line2: type: string description: Address line 2 (e.g., apartment, suite, unit, or building). postal_code: type: string description: ZIP or postal code. state: type: string description: State, county, province, or region. x-apifox-refs: {} x-apifox-orders: - country - line1 - city - line2 - postal_code - state required: - country - line1 description: Business registration address x-apifox-ignore-properties: [] certificate: type: object properties: certificate_type: type: string enum: - business_license x-apifox-enum: - value: business_license name: '' description: '' certificate_number: type: string description: business registration number x-apifox-orders: - certificate_type - certificate_number description: Condtional requried required: - certificate_number x-apifox-ignore-properties: [] business_scope: type: string enum: - corp x-apifox-enum: - value: corp name: '' description: '' x-apifox-orders: - business_legal_name - address - certificate - business_scope required: - business_legal_name - address - certificate - business_scope x-apifox-ignore-properties: [] x-apifox-orders: - payer_type - individual - business x-apifox-ignore-properties: [] x-apifox-folder: '' Address: type: object properties: city: type: string description: City, district, suburb, town, or village. country: type: string description: Two-letter country code (ISO 3166-1 alpha-2 ). line1: type: string description: Address line 1 (e.g., street, PO Box, or company name). line2: type: string description: Address line 2 (e.g., apartment, suite, unit, or building). postal_code: type: string description: ZIP or postal code. state: type: string description: State, county, province, or region. x-apifox-orders: - city - country - line1 - line2 - postal_code - state x-apifox-ignore-properties: [] x-apifox-folder: '' Billing Details: type: object properties: address: *ref_0 email: type: string description: Email address. name: type: string description: 'Full name. ' phone: type: string description: Billing phone number (including extension). x-apifox-orders: - address - email - name - phone x-apifox-ignore-properties: [] x-apifox-folder: '' Beneficiary: type: object properties: id: &ref_3 type: string description: Unique identifier for the object, "bn_xxxxx". object: &ref_4 type: string description: '"beneficiary"' created: &ref_5 type: integer description: >- The time at which the object was created. Measured in seconds since the Unix epoch. destination_data: type: object properties: destination_type: type: string description: Payment method enum: &ref_6 - bank_account - card - carrier_billing - alipay x-apifox-enum: - value: bank_account name: '' description: '' - value: card name: '' description: '' - value: carrier_billing name: '' description: '' - value: alipay name: '' description: '' bank_account: description: Condtional requried type: object x-apifox-refs: &ref_7 {} x-apifox-orders: &ref_8 - account_number - iban - account_holder_name - account_holder_type - phone_number - email - country - swift - dob - gender - certificate - bank_name - metadata - routing_number - routing_type - description properties: account_number: &ref_9 type: string description: The number of the bank account iban: &ref_10 type: string description: >- International bank account number, mostly for european countries account_holder_name: &ref_11 type: string description: >- The name of the person or business that owns the bank account. If the account holder is Chinese, this field should be in Chinese characters. account_holder_type: type: string description: >- The type of entity that holds the account. This can be either individual or company. enum: &ref_12 - individual - company x-apifox-enum: - value: individual name: '' description: '' - value: company name: '' description: '' phone_number: &ref_13 type: string description: >- The phone number of the beneficiary. The format of phone number should be like regioncode-phonenumber. e.g.1-123456. email: &ref_14 type: string description: The email of the beneficiary country: &ref_15 type: string description: >- Two-letter ISO code representing the country the bank account is located in. swift: &ref_16 type: string description: The swift code of this bank account. dob: type: object properties: day: &ref_17 type: string description: The day of birth, between 1 and 31. month: &ref_18 type: string description: The month of birth, between 1 and 12. year: &ref_19 type: string description: The four-digit year of birth. x-apifox-orders: &ref_20 - day - month - year required: - day - month - year description: >- When the beneficiary is a person, the person’s date of birth. x-apifox-ignore-properties: [] gender: type: string description: >- The person’s gender (International regulations require either “male” or “female”). enum: &ref_21 - male - female x-apifox-enum: - value: male name: '' description: '' - value: female name: '' description: '' certificate: type: object properties: certificate_type: type: string enum: &ref_22 - id_card - national_id - driving_license - social_security - tax_id - resident_card - alien_registration - employer_id x-apifox-enum: - value: id_card name: '' description: '' - value: national_id name: '' description: '' - value: driving_license name: '' description: '' - value: social_security name: '' description: '' - value: tax_id name: '' description: '' - value: resident_card name: '' description: '' - value: alien_registration name: '' description: '' - value: employer_id name: '' description: '' certificate_number: &ref_23 type: string x-apifox-orders: &ref_24 - certificate_type - certificate_number description: Condtional requried x-apifox-ignore-properties: [] bank_name: &ref_25 type: string description: Name of the bank associated with the routing number metadata: type: object properties: {} description: Set of key-value pairs that you can attach to an object. x-apifox-orders: &ref_26 [] x-apifox-ignore-properties: [] routing_number: &ref_27 type: string description: The routing transit number for the bank account. routing_type: type: string description: The routing transit type for the bank account. enum: &ref_28 - aba - sort_code - cc - bsb - zengin - biller_code x-apifox-enum: - value: aba name: '' description: '' - value: sort_code name: '' description: '' - value: cc name: '' description: '' - value: bsb name: '' description: '' - value: zengin name: '' description: '' - value: biller_code name: '' description: '' description: &ref_29 type: string description: >- It can be used as a merchant order number or a transfer note. required: - account_number - account_holder_name - account_holder_type - phone_number - country - swift x-apifox-ignore-properties: [] card: description: Condtional requried type: object x-apifox-refs: &ref_30 {} x-apifox-orders: &ref_31 - name - number - description - billing_address - metadata properties: name: &ref_32 type: string description: Cardholder name. number: &ref_33 type: string description: Card number description: &ref_34 type: string description: >- Condtional requried. It can be used as a merchant order number or a transfer note. billing_address: type: object x-apifox-refs: &ref_35 01JCYZV2FZ407X0Q0F4GGGV10R: *ref_1 x-apifox-orders: &ref_36 - 01JCYZV2FZ407X0Q0F4GGGV10R properties: address: *ref_0 x-apifox-ignore-properties: - address metadata: type: object properties: {} x-apifox-orders: &ref_37 [] description: >- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. x-apifox-ignore-properties: [] required: - name - number x-apifox-ignore-properties: [] carrier_billing: type: object properties: carrier: type: string description: The telecom carrier of the mobile. enum: &ref_38 - megafon - tmobile - beeline - mts - tele2 - yota x-apifox-enum: - value: megafon name: '' description: Megafon - value: tmobile name: '' description: T-Mobile - value: beeline name: '' description: Beeline - value: mts name: '' description: MTS - value: tele2 name: '' description: Tele2 - value: yota name: '' description: Yota phone_number: &ref_39 type: string description: >- The format of phone number should be like regioncode-phonenumber. e.g.86-123456. country: &ref_40 type: string description: &ref_41 type: string description: >- It can be used as a merchant order number or a transfer note. x-apifox-orders: &ref_42 - carrier - phone_number - country - description description: Condtional requried required: - carrier - phone_number - country x-apifox-ignore-properties: [] alipay: type: object properties: user_id: &ref_43 type: string description: >- This is unique ID registered by beneficiary in Alipay+ with a phone number or email address. The format of phone number should be like regioncode-phonenumber. e.g.86-123456. first_name: &ref_44 type: string description: The given name of a person. Only support Chinese Pinyin last_name: &ref_45 type: string description: >- The surname or family name of a person. Only support Chinese Pinyin x-apifox-orders: &ref_46 - user_id - first_name - last_name required: - user_id - first_name - last_name description: Condtional requried x-apifox-ignore-properties: [] imps: type: object properties: account_number: &ref_47 type: string description: Account number of the beneficairy of IMPS phone_number: &ref_48 type: string description: >- The phone number of the beneficiary. The format of phone number should be like regioncode-phonenumber. e.g.1-123456. email: &ref_49 type: string description: The format of email. e.g.XXX@XXX.XXX name: &ref_50 type: string description: The full name of a person. bank_code: &ref_51 type: string description: >- Bank code under the IFSC (Indian Financial System Code). Format: fixed length of 11 characters, XXXX0XXXXXX – consisting of 4 letters + 0 + 6 digits x-apifox-orders: &ref_52 - account_number - phone_number - email - name - bank_code required: - account_number - phone_number - email - name - bank_code description: Condtional requried x-apifox-ignore-properties: [] upi: type: object properties: vpa: &ref_53 type: string description: Email ID of VPA（Virtual Payment Address）. e.g.XXX@XXX.XXX phone_number: &ref_54 type: string description: >- The phone number of the beneficiary. The format of phone number should be like regioncode-phonenumber. e.g.1-123456. x-apifox-orders: &ref_55 - vpa - phone_number description: Condtional requried required: - vpa - phone_number x-apifox-ignore-properties: [] jazzcash: type: object properties: account_number: &ref_56 type: string name: &ref_57 type: string phone_number: &ref_58 type: string email: &ref_59 type: string dob: &ref_60 type: string gender: &ref_61 type: string x-apifox-orders: &ref_62 - account_number - name - phone_number - email - dob - gender description: Condtional requried x-apifox-ignore-properties: [] easypaisa: type: object properties: account_number: &ref_63 type: string name: &ref_64 type: string phone_number: &ref_65 type: string email: &ref_66 type: string dob: &ref_67 type: string gender: &ref_68 type: string certificate: type: object properties: certificate_type: type: string enum: &ref_69 - cnic x-apifox-enum: - value: cnic name: '' description: '' certificate_number: &ref_70 type: string x-apifox-orders: &ref_71 - certificate_type - certificate_number x-apifox-ignore-properties: [] x-apifox-orders: &ref_72 - account_number - name - phone_number - email - dob - gender - certificate description: Condtional requried x-apifox-ignore-properties: [] x-apifox-orders: &ref_73 - destination_type - bank_account - card - carrier_billing - alipay - imps - upi - jazzcash - easypaisa description: >- Create a new card or bank account for payouts was sent to. Condtional requried, one of destination and destination is required. required: - destination_type x-apifox-ignore-properties: [] nickname: &ref_74 type: string description: Nickname of beneficiary for quickly retrieving metadata: type: object properties: {} x-apifox-orders: &ref_75 [] description: >- Set of key-value pairs attaching to an object. This can be a channel for customers that provides additional material about the beneficiary x-apifox-ignore-properties: [] livemode: &ref_76 type: boolean description: >- Has the value true if the object exists in live mode or the value false if the object exists in test mode. x-apifox-orders: - id - object - created - destination_data - nickname - metadata - livemode required: - destination_data x-apifox-ignore-properties: [] x-apifox-folder: '' Payout: type: object properties: id: type: string description: Unique identifier for the object, "po_XXXX" object: type: string description: '"payout"' created: type: integer description: >- Time at which the object was created. Measured in seconds since the Unix epoch. payment_currency: type: string description: Three-letter ISO currency code, in uppercase. payment_amount: type: integer description: >- Conditional required.Amount (in cents) to be transferred to your bank account or debit card. source_currency: type: string description: >- Source currency, i.e. the currency that the Payer uses to fund the payment source_amount: type: integer description: Conditional required. Source amount in source_currency description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. metadata: type: object properties: {} x-apifox-orders: [] description: >- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. x-apifox-ignore-properties: [] status: type: string description: >- Current status of the payout: paid, pending, in_transit, canceled or failed. A payout is pending until it is submitted to the bank, when it becomes in_transit. The status then changes to paid if the transaction goes through, or to failed or canceled (within 5 business days). livemode: type: boolean description: >- Has the value true if the object exists in live mode or the value false if the object exists in test mode. beneficiary_data: description: >- The entiry who receives the payout. Conditional required: one of beneficiary and beneficiary_data are required. type: object x-apifox-refs: 01JC0GB8CXY6973YAV89V0XNA5: *ref_2 x-apifox-orders: - 01JC0GB8CXY6973YAV89V0XNA5 properties: id: *ref_3 object: *ref_4 created: *ref_5 destination_data: type: object properties: destination_type: type: string description: Payment method enum: *ref_6 x-apifox-enum: - value: bank_account name: '' description: '' - value: card name: '' description: '' - value: carrier_billing name: '' description: '' - value: alipay name: '' description: '' bank_account: description: Condtional requried type: object x-apifox-refs: *ref_7 x-apifox-orders: *ref_8 properties: account_number: *ref_9 iban: *ref_10 account_holder_name: *ref_11 account_holder_type: type: string description: >- The type of entity that holds the account. This can be either individual or company. enum: *ref_12 x-apifox-enum: - value: individual name: '' description: '' - value: company name: '' description: '' phone_number: *ref_13 email: *ref_14 country: *ref_15 swift: *ref_16 dob: type: object properties: day: *ref_17 month: *ref_18 year: *ref_19 x-apifox-orders: *ref_20 required: - day - month - year description: >- When the beneficiary is a person, the person’s date of birth. x-apifox-ignore-properties: [] gender: type: string description: >- The person’s gender (International regulations require either “male” or “female”). enum: *ref_21 x-apifox-enum: - value: male name: '' description: '' - value: female name: '' description: '' certificate: type: object properties: certificate_type: type: string enum: *ref_22 x-apifox-enum: - value: id_card name: '' description: '' - value: national_id name: '' description: '' - value: driving_license name: '' description: '' - value: social_security name: '' description: '' - value: tax_id name: '' description: '' - value: resident_card name: '' description: '' - value: alien_registration name: '' description: '' - value: employer_id name: '' description: '' certificate_number: *ref_23 x-apifox-orders: *ref_24 description: Condtional requried x-apifox-ignore-properties: [] bank_name: *ref_25 metadata: type: object properties: {} description: Set of key-value pairs that you can attach to an object. x-apifox-orders: *ref_26 x-apifox-ignore-properties: [] routing_number: *ref_27 routing_type: type: string description: The routing transit type for the bank account. enum: *ref_28 x-apifox-enum: - value: aba name: '' description: '' - value: sort_code name: '' description: '' - value: cc name: '' description: '' - value: bsb name: '' description: '' - value: zengin name: '' description: '' - value: biller_code name: '' description: '' description: *ref_29 required: - account_number - account_holder_name - account_holder_type - phone_number - country - swift x-apifox-ignore-properties: [] card: description: Condtional requried type: object x-apifox-refs: *ref_30 x-apifox-orders: *ref_31 properties: name: *ref_32 number: *ref_33 description: *ref_34 billing_address: type: object x-apifox-refs: *ref_35 x-apifox-orders: *ref_36 properties: address: *ref_0 x-apifox-ignore-properties: - address metadata: type: object properties: {} x-apifox-orders: *ref_37 description: >- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. x-apifox-ignore-properties: [] required: - name - number x-apifox-ignore-properties: [] carrier_billing: type: object properties: carrier: type: string description: The telecom carrier of the mobile. enum: *ref_38 x-apifox-enum: - value: megafon name: '' description: Megafon - value: tmobile name: '' description: T-Mobile - value: beeline name: '' description: Beeline - value: mts name: '' description: MTS - value: tele2 name: '' description: Tele2 - value: yota name: '' description: Yota phone_number: *ref_39 country: *ref_40 description: *ref_41 x-apifox-orders: *ref_42 description: Condtional requried required: - carrier - phone_number - country x-apifox-ignore-properties: [] alipay: type: object properties: user_id: *ref_43 first_name: *ref_44 last_name: *ref_45 x-apifox-orders: *ref_46 required: - user_id - first_name - last_name description: Condtional requried x-apifox-ignore-properties: [] imps: type: object properties: account_number: *ref_47 phone_number: *ref_48 email: *ref_49 name: *ref_50 bank_code: *ref_51 x-apifox-orders: *ref_52 required: - account_number - phone_number - email - name - bank_code description: Condtional requried x-apifox-ignore-properties: [] upi: type: object properties: vpa: *ref_53 phone_number: *ref_54 x-apifox-orders: *ref_55 description: Condtional requried required: - vpa - phone_number x-apifox-ignore-properties: [] jazzcash: type: object properties: account_number: *ref_56 name: *ref_57 phone_number: *ref_58 email: *ref_59 dob: *ref_60 gender: *ref_61 x-apifox-orders: *ref_62 description: Condtional requried x-apifox-ignore-properties: [] easypaisa: type: object properties: account_number: *ref_63 name: *ref_64 phone_number: *ref_65 email: *ref_66 dob: *ref_67 gender: *ref_68 certificate: type: object properties: certificate_type: type: string enum: *ref_69 x-apifox-enum: - value: cnic name: '' description: '' certificate_number: *ref_70 x-apifox-orders: *ref_71 x-apifox-ignore-properties: [] x-apifox-orders: *ref_72 description: Condtional requried x-apifox-ignore-properties: [] x-apifox-orders: *ref_73 description: >- Create a new card or bank account for payouts was sent to. Condtional requried, one of destination and destination is required. required: - destination_type x-apifox-ignore-properties: [] nickname: *ref_74 metadata: type: object properties: {} x-apifox-orders: *ref_75 description: >- Set of key-value pairs attaching to an object. This can be a channel for customers that provides additional material about the beneficiary x-apifox-ignore-properties: [] livemode: *ref_76 required: - destination_data x-apifox-ignore-properties: - id - object - created - destination_data - nickname - metadata - livemode beneficiary: type: string description: >- ID of the beneficiary the payout was sent to. Conditional required: one of beneficiary and beneficiary_data are required. failure_code: type: string description: 'Error code explaining reason for payout failure if available. ' enum: - account_closed - account_frozen - bank_account_restricted - bank_ownership_changed - could_not_process - debit_not_authorized - declined - insufficient_funds - invalid_account_number - incorrect_account_holder_name - incorrect_account_holder_address - incorrect_account_holder_tax_id - invalid_currency - no_account - unsupported_card x-apifox-enum: - value: account_closed name: '' description: The bank account has been closed. - value: account_frozen name: '' description: The bank account has been frozen. - value: bank_account_restricted name: '' description: >- The bank account has restrictions on either the type, or the number, of payouts allowed. This normally indicates that the bank account is a savings or other non-checking account. - value: bank_ownership_changed name: '' description: >- The destination bank account is no longer valid because its branch has changed ownership. - value: could_not_process name: '' description: The bank could not process this payout. - value: debit_not_authorized name: '' description: 'Debit transactions are not approved on the bank account. ' - value: declined name: '' description: >- The bank has declined this transfer. Please contact the bank before retrying. - value: insufficient_funds name: '' description: Your account has insufficient funds to cover the payout. - value: invalid_account_number name: '' description: >- The routing number seems correct, but the account number is invalid. - value: incorrect_account_holder_name name: '' description: >- Your bank notified us that the bank account holder name on file is incorrect. - value: incorrect_account_holder_address name: '' description: >- Your bank notified us that the bank account holder address on file is incorrect. - value: incorrect_account_holder_tax_id name: '' description: >- Your bank notified us that the bank account holder tax ID on file is incorrect. - value: invalid_currency name: '' description: >- The bank was unable to process this payout because of its currency. This is probably because the bank account cannot accept payments in that currency. - value: no_account name: '' description: >- The bank account details on file are probably incorrect. No bank account could be located with those details. - value: unsupported_card name: '' description: The bank no longer supports payouts to this card. failure_message: type: string description: >- Message to user further explaining reason for payout failure if available. payer_data: *ref_77 payment_intents_id: type: array items: type: string description: >- A list of payment intent id attached to this payout object as the payouts was sent to China. method: type: string description: >- (未实现)The method used to send this payout, which can be standard or instant. enum: - standard - instant x-apifox-enum: - value: standard name: '' description: '' - value: instant name: '' description: '' automatic: type: boolean description: >- (未实现)Returns true if the payout was created by an automated payout schedule, and false if it was requested manually. arrival_date: type: integer description: >- (未实现)Date the payout is expected to arrive in the bank. This factors in delays like weekends or bank holidays. original_payout: type: string description: >- (未实现)If the payout reverses another, this is the ID of the original payout. reversed_by: type: string description: >- (未实现)If the payout was reversed, this is the ID of the payout that reverses this payout. source_type: type: string description: >- (未实现)The source balance this payout came from. One of card, fpx, or bank_account. statement_descriptor: type: string description: >- (未实现)Extra information about a payout to be displayed on the user’s bank statement. balance_transaction: type: string description: >- (未实现)ID of the balance transaction that describes the impact of this payout on your account balance. failure_balance_transaction: type: string description: >- (未实现)If the payout failed or was canceled, this will be the ID of the balance transaction that reversed the initial balance transaction, and puts the funds from the failed payout back in your balance. merchant_payout_id: type: string x-apifox-orders: - id - object - created - payment_currency - payment_amount - source_currency - source_amount - description - metadata - status - livemode - beneficiary_data - beneficiary - failure_code - failure_message - payer_data - payment_intents_id - method - automatic - arrival_date - original_payout - reversed_by - source_type - statement_descriptor - balance_transaction - failure_balance_transaction - merchant_payout_id x-apifox-ignore-properties: [] x-apifox-folder: '' securitySchemes: basic: type: http scheme: basic servers: - url: https://apitest.wooshpay.com description: 官网测试 security: - basic: [] ```