WooshPay OpenAPI
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Back to WooshPay Website
  1. Payouts
  • API Introduction
  • Error Code
  • Payment Intents
    • Create a PaymentIntent
      POST
    • Update a PaymentIntent
      POST
    • Cancel a PaymentIntent
      POST
    • Capture a PaymentIntent
      POST
    • Confirm a PaymentIntent
      POST
    • Retrieve a PaymentIntent
      GET
    • List all PaymentIntents
      GET
    • Search PaymentIntents
      GET
  • Charges
    • Retrieve a charge
      GET
    • List all charges
      GET
  • Payment Methods
    • Create a PaymentMethod
      POST
    • Retrieve a PaymentMethod
      GET
    • Retrieve a Customer's PaymentMethod
      GET
    • Update a PaymentMethod
      POST
    • List PaymentMethods
      GET
    • List a Customer's PaymentMethods
      GET
    • Attach a PaymentMethod to a Customer
      POST
    • Detach a PaymentMethod from a Customer
      POST
  • Refunds
    • Create a refund
    • Retrieve a refund
  • Webhooks
    • Create a Webhook
    • List All Webhooks
    • Retrieve a Webhook
    • Delete a Webhook
    • Update a Webhook
  • Events
    • Types of events
    • Retrieve an event
  • Files
    • Files
    • Create a file
    • Retrieve a file
  • Disputes
    • Retrieve a dispute
    • Update a dispute
    • Close a dispute
    • List all disputes
  • Payouts
    • Beneficiary
      • Create a beneficiary
      • Retrieve a beneficiary
      • List all beneficiaries
      • Update a beneficiary
      • Delete a beneficiary
    • Payouts
      • Create a payout
        POST
      • Retrieve a Payout
        GET
      • Update a Payout
        POST
      • List All Payouts
        GET
  • Balance
    • Get balance
  • Products
    • Create a Product
    • Retrieve a product
    • Update a product
    • List all products
  • Prices
    • Create a price
    • Retrieve a price
    • Update a price
  • Payment Links
    • Create a payment link
    • Update a payment link
    • Retrieve payment link
    • List all payment links
    • Retrieve a payment link's line items
  • Checkout
    • Create a Session
    • Expire a Session
    • Retreive a Session
    • List All Checkout Sessions
    • Retrieve a Checkout Session's line items
  • Customers
    • Create a customer
    • Retrieve a customer
    • Update a customer
  • Invoices
    • Setup Intents
      • Create a SetupIntent
      • Retrieve a SetupIntent
      • Cancel a SetupIntent
      • List all SetupIntents
      • List all SetupAttempts
      • Update a SetupIntent
      • Confirm a SetupIntent
    • Create an invoice
    • Retrieve an invoice
    • Finalize an invoice
    • Send an invoice for manual payment
    • Delete a draft invoice
    • Void an invoice
    • List all invoices
    • Pay an invoice
  • Invoice Items
    • Create an invoice item
    • Retrieve an invoice item
  • Invoice Line Item
    • Bulk add invoice line items
  • Subscriptions
    • Create a subscription
    • Retrieve a subscription
    • Update a subscription
    • Cancel a subscription
    • List subscriptions
  • Subscription Items
    • Create a subscription item
    • Retrieve a subscription item
    • Delete a subscription item
  • Issuing
    • Authorizations
      • Retrieve an authorization
      • List all authorization
    • Cardholders
      • Create a cardholder
      • Update a cardholder
      • Retrieve a cardholder
      • List all cardholders
    • Cards
      • Create a card
      • Update a card
      • Retrieve a card
      • List all cards
      • Retrieve card remaining limits
    • Transactions
      • Update a transaction
      • Retrieve a transaction
      • List all transactions
  • Coupons
    • Create a Coupon
    • Retrieve a coupon
    • Delete a coupon
  • Promotion Code
    • Create a promotion code
    • Update a promotion code
  • Accounts
    • Retrieve account's paymentmethods
  • Fx Quote
    • Create an FX Quote
  1. Payouts

Update a Payout

POST
/v1/payouts/{id}

Request

Authorization
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:password
Example:
Authorization: Basic *****************
Path Params
id
string 
required
Header Params
Accept
string 
required
Default:
application/json
Content-Type
string 
required
Default:
application/json
Body Params application/json
metadata
string 
optional
Set of key-value pairs that you can attach to an object.
Example
{
  "metadata": {
    "key1": "value1"
  }
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://apitest.wooshpay.com/v1/payouts/' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
  "metadata": {
    "key1": "value1"
  }
}'

Responses

🟢200OK
application/json
Body
id
string 
optional
Unique identifier for the object, "po_XXXX"
object
string 
optional
"payout"
created
integer 
optional
Time at which the object was created. Measured in seconds since the Unix epoch.
payment_currency
string 
optional
Three-letter ISO currency code, in uppercase.
payment_amount
integer 
optional
Conditional required.Amount (in cents) to be transferred to your bank account or debit card.
source_currency
string 
optional
Source currency, i.e. the currency that the Payer uses to fund the payment
source_amount
integer 
optional
Conditional required. Source amount in source_currency
description
string 
optional
An arbitrary string attached to the object. Often useful for displaying to users.
metadata
object 
optional
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.
status
string 
optional
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
boolean 
optional
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
beneficiary_data
object 
optional
The entiry who receives the payout. Conditional required: one of beneficiary and beneficiary_data are required.
id
string 
optional
Unique identifier for the object, "bn_xxxxx".
object
string 
optional
"beneficiary"
created
integer 
optional
The time at which the object was created. Measured in seconds since the Unix epoch.
destination_data
object 
required
Create a new card or bank account for payouts was sent to. Condtional requried, one of destination and destination is required.
nickname
string 
optional
Nickname of beneficiary for quickly retrieving
metadata
object 
optional
Set of key-value pairs attaching to an object. This can be a channel for customers that provides additional material about the beneficiary
livemode
boolean 
optional
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
beneficiary
string 
optional
ID of the beneficiary the payout was sent to. Conditional required: one of beneficiary and beneficiary_data are required.
failure_code
enum<string> 
optional
Error code explaining reason for payout failure if available.
Allowed values:
account_closedaccount_frozenbank_account_restrictedbank_ownership_changedcould_not_processdebit_not_authorizeddeclinedinsufficient_fundsinvalid_account_numberincorrect_account_holder_nameincorrect_account_holder_addressincorrect_account_holder_tax_idinvalid_currencyno_accountunsupported_card
failure_message
string 
optional
Message to user further explaining reason for payout failure if available.
payer_data
object (Payer) 
optional
payer_type
enum<string> 
optional
Allowed values:
individualbusiness
individual
object 
optional
business
object 
optional
payment_intents_id
array[string]
optional
A list of payment intent id attached to this payout object as the payouts was sent to China.
method
enum<string> 
optional
(未实现)The method used to send this payout, which can be standard or instant.
Allowed values:
standardinstant
balance_transaction
string 
optional
(未实现)ID of the balance transaction that describes the impact of this payout on your account balance.
failure_balance_transaction
string 
optional
(未实现)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
string 
optional
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
}
Previous
Retrieve a Payout
Next
List All Payouts
Built with