Create a payout ( B2P Mode )

POST

/v1/payouts

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 *****************

Header Params

Body Params application/json

Example

{
    "payment_currency": "SGD",
    "payment_amount": 10000,
    "source_currency": "SGD",
    "beneficiary_data": {
        "destination_data": {
            "destination_type": "bank_account",
            "bank_account": {
                "account_number": "01288811111222",
                "account_holder_name": "TAK YEE LI",
                "account_holder_type": "individual",
                "phone_number": "1-142091111",
                "bank_name": "HANG SENG BANK LIMITED",
                "bank_code": "HASEHKHH",
                "country": "SG",
                "billing_address": {
                    "city": "California"
                }
            }
        }
    },
    "payer_data": {
        "payer_type": "business",
        "business": {
            "business_legal_name": "sample business",
            "email": "info@test.com",
            "phone_number": "1-2142091111",
            "business_scope": "corporation",
            "purpose": "Employee Compensation",
            "source_of_income": "Salary",
            "certificate": {
                "certificate_type": "business_license",
                "certificate_number": "231234511111",
                "issue_date": "2001-09-26",
                "expiry_date": "2033-09-26"
            },
            "address": {
                "country": "SG",
                "line1": "25 alton' road",
                "city": "Hong Kong"
            }
        }
    }
}
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://apitest.wooshpay.com/v1/payouts' \
--header 'Accept: application/json' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "payment_currency": "SGD",
    "payment_amount": 10000,
    "source_currency": "SGD",
    "beneficiary_data": {
        "destination_data": {
            "destination_type": "bank_account",
            "bank_account": {
                "account_number": "01288811111222",
                "account_holder_name": "TAK YEE LI",
                "account_holder_type": "individual",
                "phone_number": "1-142091111",
                "bank_name": "HANG SENG BANK LIMITED",
                "bank_code": "HASEHKHH",
                "country": "SG",
                "billing_address": {
                    "city": "California"
                }
            }
        }
    },
    "payer_data": {
        "payer_type": "business",
        "business": {
            "business_legal_name": "sample business",
            "email": "info@test.com",
            "phone_number": "1-2142091111",
            "business_scope": "corporation",
            "purpose": "Employee Compensation",
            "source_of_income": "Salary",
            "certificate": {
                "certificate_type": "business_license",
                "certificate_number": "231234511111",
                "issue_date": "2001-09-26",
                "expiry_date": "2033-09-26"
            },
            "address": {
                "country": "SG",
                "line1": "25 alton'\'' road",
                "city": "Hong Kong"
            }
        }
    }
}
}'

Responses

🟢200OK

application/json

Bodyapplication/json

Example

{
    "id": "po_2087829006450688000",
    "object": "payout",
    "created": 1786612202000,
    "livemode": false,
    "status": "in_transit",
    "beneficiary_data": {
        "id": "bf_2087828687733915648",
        "object": "beneficiary",
        "created": 1786612122000,
        "livemode": false,
        "destination_data": {
            "destination_type": "bank_account",
            "bank_account": {
                "id": "ba_2087828678204456960",
                "object": "bank_account",
                "created": 1786612124000,
                "livemode": false,
                "country": "SG",
                "currency": "SGD",
                "last4": "1222",
                "bankCode": "HASEHKHH",
                "account_holder_name": "TAK YEE LI",
                "account_holder_type": "individual",
                "bank_name": "HANG SENG BANK LIMITED",
                "account_number": "01288811111222",
                "phone_umber": "1-142091111",
                "billing_address": {
                    "city": "California"
                }
            }
        }
    },
    "payment_amount": 10000,
    "payment_currency": "SGD",
    "source_amount": 10700,
    "source_currency": "SGD",
    "payer_data": {
        "business": {
            "address": {
                "country": "SG",
                "line1": "25 alton' road",
                "city": "Hong Kong"
            },
            "certificate": {
                "certificate_type": "business_license",
                "certificate_number": "231234511111",
                "issue_date": "2001-09-26",
                "expiry_date": "2033-09-26"
            },
            "email": "info@test.com",
            "business_legal_name": "sample business",
            "purpose": "Employee Compensation",
            "phone_number": "1-2142091111",
            "business_scope": "corporation",
            "source_of_income": "Salary"
        },
        "payer_type": "business"
    }
}

Modified at 2026-08-14 03:45:17

Create a payout ( Standard Mode )

Retrieve a Payout