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

Header Params

Body Params application/json

Example

{
  "metadata": {
    "key1": "value1"
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

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
}

Modified at 2024-02-27 07:35:52

Retrieve a Payout

List All Payouts