Create Payout

POST

/api/v1/payout

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

account-id

string

optional

x-api-version

string

optional

Body Params application/json

beneficiary_id

string

required

payment_amount

string

required

payment_currency

string

required

payment_method

string

required

payment_date

string

required

fee_paid_by

string

required

reason

string

required

reference

string

required

request_id

string

required

source_currency

string

required

Example

{
    "beneficiary_id": "9610ad46-7c1b-47c5-8e9a-7c5cdbcebf47",
    "payment_amount": "100",
    "payment_currency": "USD",
    "payment_method": "SWIFT",
    "payment_date": "2024-07-25",
    "fee_paid_by": "BENEFICIARY",
    "reason": "Travel",
    "reference": "b10266e2-ab5b-4c47-b1a8-e94df0cb2013",
    "request_id": "7df11728-4da5-4c85-a5ca-7a306f8e49fc",
    "source_currency": "SGD"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api-sandbox.z.inc/api/v1/payout' \
--header 'account-id;' \
--header 'x-api-version;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "beneficiary_id": "9610ad46-7c1b-47c5-8e9a-7c5cdbcebf47",
    "payment_amount": "100",
    "payment_currency": "USD",
    "payment_method": "SWIFT",
    "payment_date": "2024-07-25",
    "fee_paid_by": "BENEFICIARY",
    "reason": "Travel",
    "reference": "b10266e2-ab5b-4c47-b1a8-e94df0cb2013",
    "request_id": "7df11728-4da5-4c85-a5ca-7a306f8e49fc",
    "source_currency": "SGD"
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{
    "amount_beneficiary_receives": 85.16,
    "amount_payer_pays": 134.81,
    "beneficiary": {
        "additional_info": {
            "personal_email": "fardakupsi@gufum.com"
        },
        "address": {
            "city": "xyz",
            "country_code": "IN",
            "postcode": "99501",
            "state": "US-AL",
            "street_address": "xyz"
        },
        "bank_details": {
            "account_currency": "USD",
            "account_name": "Test Account 2",
            "account_number": "79898997941",
            "bank_country_code": "US",
            "bank_name": "JPMORGAN CHASE BANK, N.A.",
            "swift_code": "CHASUS33890"
        },
        "date_of_birth": "1990-10-10",
        "entity_type": "PERSONAL"
    },
    "beneficiary_id": "9610ad46-7c1b-47c5-8e9a-7c5cdbcebf47",
    "created_at": "2024-07-25T09:46:47+0000",
    "fee_amount": 20,
    "fee_currency": "SGD",
    "fee_paid_by": "BENEFICIARY",
    "funding": {
        "status": "FUNDED"
    },
    "last_updated_at": "2024-07-25T09:46:47+0000",
    "payer": {
        "address": {
            "city": "ZYX",
            "country_code": "SG",
            "postcode": "546080",
            "state": "XYZ",
            "street_address": "200 Collins Street, 200 Collins Street"
        },
        "date_of_birth": "1990-10-10",
        "entity_type": "PERSONAL",
        "first_name": "John",
        "last_name": "Doe"
    },
    "payment_amount": 100,
    "payment_currency": "USD",
    "payment_date": "2024-07-25",
    "payment_id": "499732b2-440c-495d-a746-9a923db9eb30",
    "payment_method": "SWIFT",
    "reason": "Travel",
    "reference": "b10266e2-ab5b-4c47-b1a8-e94df0cb2013",
    "remarks": "",
    "request_id": "7df11728-4da5-4c85-a5ca-7a306f8e49fc",
    "selling": true,
    "short_reference_id": "P240725-ST123OG",
    "source_amount": 134.81,
    "source_currency": "SGD",
    "status": "SCHEDULED",
    "swift_charge_option": "SHARED",
    "underlying_conversion_id": "28c57427-4d03-4345-af7c-dac25b6a1617"
}

Modified at 2024-07-27 18:41:02

Get Currency Account Details

Get Payouts For Account