Payouts

A payout sends money from your account to a recipient: a card, a bank account or a wallet. Use payouts for disbursements such as seller settlements, insurance claims or customer withdrawals.

Availability depends on the payment providers enabled for your account. Contact info@nivc.ai.

Payouts to Vietnamese bank accounts (NAPAS 247 and CITAD) depend on Vietnamese providers that are not live yet. The request format for Vietnamese bank payouts will be published here when they are available. The examples on this page use a card payout, which is one of the payout types the API supports today.

Payout flow

A payout goes through three steps. You can run them one at a time, or combine them.

Create. Create a payout with the amount, currency, recipient and payout_method_data. The payout waits in requires_confirmation (or in requires_payout_method_data if you did not send the recipient details yet).
Confirm. Confirm the payout. VNSwitch checks the details with the provider and sets up the transfer. The payout moves to requires_fulfillment.
Fulfill. Fulfill the payout to release the money. The payout moves to initiated or pending while the provider works, then to success or failed.

Two flags on the create request shorten the flow:

Flag	Effect
`confirm: true`	Create and confirm in one request.
`confirm: true` with `auto_fulfill: true`	Create, confirm and fulfill in one request. Use this when you do not need a review step before money leaves your account.

Keeping the steps separate lets you review or approve a payout (for example, a manual check of large amounts) between confirm and fulfill. Until a payout reaches a final status you can cancel it.

Payout status

Status	Meaning
`requires_payout_method_data`	Created without recipient details. Send `payout_method_data` when you confirm.
`requires_confirmation`	Created and waiting for confirm.
`requires_creation`	Confirmed and being set up with the provider.
`requires_vendor_account_creation`	The provider needs a recipient account to be set up first.
`requires_fulfillment`	Confirmed and waiting for fulfill.
`initiated`, `pending`	Sent to the provider; waiting for the result.
`success`	The money was sent. Final.
`failed`	The payout did not go through. See `error_code` and `error_message`. Final.
`cancelled`	You cancelled the payout. Final.
`expired`	The payout was not completed in time. Final.
`reversed`	The provider reversed a payout that had been sent. Final.
`ineligible`	The provider found the recipient or payout method ineligible.
`not_permitted`	The provider refused the payout, for example because the recipient details could not be verified. Final.

VNSwitch sends a webhook when a payout reaches initiated, success, failed, cancelled, expired, reversed or not_permitted. The event_type values are payout_initiated, payout_success, payout_failed, payout_cancelled, payout_expired, payout_reversed and payout_not_permitted. The other statuses do not send a webhook. See Webhooks.

Payout method data

payout_type says what kind of recipient you are paying, and payout_method_data holds the recipient details under a key with the same name.

`payout_type`	`payout_method_data`	Required fields
`card`	`{ "card": { … } }`	`card_number`, `expiry_month`, `expiry_year`, `card_holder_name`
`bank`	`{ "bank": { … } }`	Depends on the bank scheme. For example SEPA needs `iban` and `bic`; ACH needs `bank_account_number` and `bank_routing_number`. `account_holder_name`, `bank_name` and `bank_country_code` are optional.
`wallet`	`{ "wallet": { … } }`	Depends on the wallet. For example `{ "paypal": { "email", "telephone_number", "paypal_id" } }` or `{ "venmo": { "telephone_number" } }`.

Card numbers and bank account details are sensitive. Send them only from your servers, over the API, and do not store them in your own logs.

Create a payout

Creates a payout. With the default flags it only records the payout; nothing is sent until you confirm and fulfill it.

POST /payouts/create

Authentication: secret API key (api-key header).

Body parameters

Parameter	Type	Required	Description
`amount`	integer	Yes	Amount to pay out, in the minor unit of the currency (for VND, whole dong: `150000` is 150,000 VND).
`currency`	string	Yes	ISO 4217 currency code, for example `VND`.
`payout_type`	string	No	`card`, `bank`, `wallet` or `bank_redirect`. See Payout method data.
`payout_method_data`	object	No	Recipient details. Required before the payout can be confirmed, either here or in the confirm request.
`customer`	object	No	The recipient as a customer: `id`, `name`, `email`, `phone`, `phone_country_code`. If you leave out `id`, VNSwitch can create a customer for you.
`confirm`	boolean	No	`true` confirms the payout in the same request. Default `false`.
`auto_fulfill`	boolean	No	`true` fulfills the payout right after it is confirmed. Default `false`.
`merchant_order_reference_id`	string	No	Your own reference for this payout, up to 255 characters. Useful for reconciliation.
`description`	string	No	A description of the payout.
`entity_type`	string	No	Who receives the money, for example `Individual` (default) or `Company`.
`priority`	string	No	Requested speed, if the provider supports it: `instant`, `fast`, `regular`, `wire`, `cross_border` or `internal`.
`billing`	object	No	The recipient’s billing address. Some providers require it.
`metadata`	object	No	Your own key-value data. Up to 50 keys; key names up to 40 characters, values up to 500 characters.

Example request

curl -X POST https://sandbox.api.vnswitch.nivc.ai/payouts/create \
  -H "Content-Type: application/json" \
  -H "api-key: <YOUR_API_KEY>" \
  -d '{
    "amount": 150000,
    "currency": "VND",
    "payout_type": "card",
    "payout_method_data": {
      "card": {
        "card_number": "4242424242424242",
        "expiry_month": "12",
        "expiry_year": "2030",
        "card_holder_name": "NGUYEN VAN AN"
      }
    },
    "customer": {
      "id": "cus_demo_001",
      "name": "Nguyễn Văn An",
      "email": "an.nguyen@example.vn",
      "phone": "912345678",
      "phone_country_code": "+84"
    },
    "merchant_order_reference_id": "WD-2026-0042",
    "description": "Wallet withdrawal",
    "confirm": false,
    "auto_fulfill": false
  }'

const res = await fetch("https://sandbox.api.vnswitch.nivc.ai/payouts/create", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "api-key": process.env.VNSWITCH_API_KEY,
  },
  body: JSON.stringify({
    amount: 150000,
    currency: "VND",
    payout_type: "card",
    payout_method_data: {
      card: {
        card_number: "4242424242424242",
        expiry_month: "12",
        expiry_year: "2030",
        card_holder_name: "NGUYEN VAN AN",
      },
    },
    customer: {
      id: "cus_demo_001",
      name: "Nguyễn Văn An",
      email: "an.nguyen@example.vn",
      phone: "912345678",
      phone_country_code: "+84",
    },
    merchant_order_reference_id: "WD-2026-0042",
    description: "Wallet withdrawal",
    confirm: false,
    auto_fulfill: false,
  }),
});
console.log(await res.json());

import os
import requests

resp = requests.post(
    "https://sandbox.api.vnswitch.nivc.ai/payouts/create",
    headers={"api-key": os.environ["VNSWITCH_API_KEY"]},
    json={
        "amount": 150000,
        "currency": "VND",
        "payout_type": "card",
        "payout_method_data": {
            "card": {
                "card_number": "4242424242424242",
                "expiry_month": "12",
                "expiry_year": "2030",
                "card_holder_name": "NGUYEN VAN AN",
            }
        },
        "customer": {
            "id": "cus_demo_001",
            "name": "Nguyễn Văn An",
            "email": "an.nguyen@example.vn",
            "phone": "912345678",
            "phone_country_code": "+84",
        },
        "merchant_order_reference_id": "WD-2026-0042",
        "description": "Wallet withdrawal",
        "confirm": False,
        "auto_fulfill": False,
    },
)
print(resp.json())

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

String body = """
    {
      "amount": 150000,
      "currency": "VND",
      "payout_type": "card",
      "payout_method_data": {
        "card": {
          "card_number": "4242424242424242",
          "expiry_month": "12",
          "expiry_year": "2030",
          "card_holder_name": "NGUYEN VAN AN"
        }
      },
      "customer": {
        "id": "cus_demo_001",
        "name": "Nguyễn Văn An",
        "email": "an.nguyen@example.vn",
        "phone": "912345678",
        "phone_country_code": "+84"
      },
      "merchant_order_reference_id": "WD-2026-0042",
      "description": "Wallet withdrawal",
      "confirm": false,
      "auto_fulfill": false
    }
    """;
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://sandbox.api.vnswitch.nivc.ai/payouts/create"))
    .header("Content-Type", "application/json; charset=utf-8")
    .header("api-key", System.getenv("VNSWITCH_API_KEY"))
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();
HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response

{
  "payout_id": "payout_7c1e4b9a2f",
  "merchant_id": "merchant_demo",
  "merchant_order_reference_id": "WD-2026-0042",
  "amount": 150000,
  "currency": "VND",
  "payout_type": "card",
  "status": "requires_confirmation",
  "connector": null,
  "auto_fulfill": false,
  "customer_id": "cus_demo_001",
  "customer": {
    "id": "cus_demo_001",
    "name": "Nguyễn Văn An",
    "email": "an.nguyen@example.vn",
    "phone": "912345678",
    "phone_country_code": "+84"
  },
  "client_secret": "payout_payout_7c1e4b9a2f_secret_<RANDOM>",
  "return_url": null,
  "business_country": null,
  "entity_type": "Individual",
  "recurring": false,
  "description": "Wallet withdrawal",
  "profile_id": "pro_demo_001",
  "error_code": null,
  "error_message": null,
  "created": "2026-11-01T09:30:00.000Z"
}

Response

A payout object. Key fields:

Field	Description
`payout_id`	The payout ID. Use it in the other payout operations.
`status`	See Payout status.
`amount`, `currency`	The payout amount and currency.
`payout_type`	The payout type.
`connector`	The payment provider handling the payout, once one is chosen.
`auto_fulfill`	Whether the payout is fulfilled automatically after confirm.
`customer`	The recipient.
`client_secret`	Only for client-side calls made with a publishable key. Do not send it from your server.
`error_code`, `error_message`	Set when the payout failed.
`created`	ISO 8601 creation time.

Retrieve a payout

Returns the current state of a payout.

GET /payouts/{payout_id}

Authentication: secret API key (api-key header).

Path parameters

Parameter	Type	Required	Description
`payout_id`	string	Yes	The payout ID.

Query parameters

Parameter	Type	Required	Description
`force_sync`	boolean	No	`true` asks the provider for the latest status before responding. Default `false`. Use it only when a payout has stayed `initiated` or `pending` longer than expected; otherwise wait for the webhook.

Example request

curl -X GET "https://sandbox.api.vnswitch.nivc.ai/payouts/payout_7c1e4b9a2f?force_sync=true" \
  -H "api-key: <YOUR_API_KEY>"

const res = await fetch(
  "https://sandbox.api.vnswitch.nivc.ai/payouts/payout_7c1e4b9a2f?force_sync=true",
  { headers: { "api-key": process.env.VNSWITCH_API_KEY } },
);
console.log(await res.json());

import os
import requests

resp = requests.get(
    "https://sandbox.api.vnswitch.nivc.ai/payouts/payout_7c1e4b9a2f",
    headers={"api-key": os.environ["VNSWITCH_API_KEY"]},
    params={"force_sync": "true"},
)
print(resp.json())

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://sandbox.api.vnswitch.nivc.ai/payouts/payout_7c1e4b9a2f?force_sync=true"))
    .header("api-key", System.getenv("VNSWITCH_API_KEY"))
    .GET()
    .build();
HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response

{
  "payout_id": "payout_7c1e4b9a2f",
  "merchant_id": "merchant_demo",
  "merchant_order_reference_id": "WD-2026-0042",
  "amount": 150000,
  "currency": "VND",
  "payout_type": "card",
  "status": "success",
  "connector": "<PROVIDER>",
  "auto_fulfill": false,
  "customer_id": "cus_demo_001",
  "client_secret": "payout_payout_7c1e4b9a2f_secret_<RANDOM>",
  "return_url": null,
  "business_country": null,
  "entity_type": "Individual",
  "recurring": false,
  "profile_id": "pro_demo_001",
  "connector_transaction_id": "<PROVIDER_REFERENCE>",
  "error_code": null,
  "error_message": null,
  "created": "2026-11-01T09:30:00.000Z"
}

Response

The payout object, with the same fields as Create a payout. connector_transaction_id is the provider’s reference for the transfer.

Confirm a payout

Confirms a payout that is in requires_confirmation or requires_payout_method_data. VNSwitch checks the details with the provider. If auto_fulfill is true, the payout is also fulfilled.

POST /payouts/{payout_id}/confirm

Authentication: secret API key (api-key header).

Path parameters

Parameter	Type	Required	Description
`payout_id`	string	Yes	The payout to confirm.

Body parameters

All body fields are optional. Send {} to confirm the payout as created, or send fields that were missing or that you want to change before confirming.

Parameter	Type	Required	Description
`payout_type`	string	No	Payout type, if not sent at create.
`payout_method_data`	object	No	Recipient details. Required here if the payout is in `requires_payout_method_data`.
`auto_fulfill`	boolean	No	`true` fulfills the payout right after confirming it.
`amount`	integer	No	New amount in the minor unit.
`metadata`	object	No	Your own key-value data.

client_secret is only for client-side confirmation with a publishable key. When you call this endpoint from your server with the secret API key, do not send client_secret; VNSwitch rejects the request if you do.

Example request

curl -X POST https://sandbox.api.vnswitch.nivc.ai/payouts/payout_7c1e4b9a2f/confirm \
  -H "Content-Type: application/json" \
  -H "api-key: <YOUR_API_KEY>" \
  -d '{}'

const res = await fetch(
  "https://sandbox.api.vnswitch.nivc.ai/payouts/payout_7c1e4b9a2f/confirm",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "api-key": process.env.VNSWITCH_API_KEY,
    },
    body: JSON.stringify({}),
  },
);
console.log(await res.json());

import os
import requests

resp = requests.post(
    "https://sandbox.api.vnswitch.nivc.ai/payouts/payout_7c1e4b9a2f/confirm",
    headers={"api-key": os.environ["VNSWITCH_API_KEY"]},
    json={},
)
print(resp.json())

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://sandbox.api.vnswitch.nivc.ai/payouts/payout_7c1e4b9a2f/confirm"))
    .header("Content-Type", "application/json")
    .header("api-key", System.getenv("VNSWITCH_API_KEY"))
    .POST(HttpRequest.BodyPublishers.ofString("{}"))
    .build();
HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response

{
  "payout_id": "payout_7c1e4b9a2f",
  "merchant_id": "merchant_demo",
  "amount": 150000,
  "currency": "VND",
  "payout_type": "card",
  "status": "requires_fulfillment",
  "connector": "<PROVIDER>",
  "auto_fulfill": false,
  "customer_id": "cus_demo_001",
  "client_secret": "payout_payout_7c1e4b9a2f_secret_<RANDOM>",
  "return_url": null,
  "business_country": null,
  "entity_type": "Individual",
  "recurring": false,
  "profile_id": "pro_demo_001",
  "error_code": null,
  "error_message": null,
  "created": "2026-11-01T09:30:00.000Z"
}

Response

The payout object. Without auto_fulfill the status is normally requires_fulfillment.

Fulfill a payout

Releases the money for a payout in requires_fulfillment. Any other status returns an error. The result can arrive later: watch for the payout_success or payout_failed webhook.

POST /payouts/{payout_id}/fulfill

Authentication: secret API key (api-key header).

Path parameters

Parameter	Type	Required	Description
`payout_id`	string	Yes	The payout to fulfill.

Body parameters

Parameter	Type	Required	Description
`payout_id`	string	Yes	The same payout ID as in the path.

Example request

curl -X POST https://sandbox.api.vnswitch.nivc.ai/payouts/payout_7c1e4b9a2f/fulfill \
  -H "Content-Type: application/json" \
  -H "api-key: <YOUR_API_KEY>" \
  -d '{ "payout_id": "payout_7c1e4b9a2f" }'

const res = await fetch(
  "https://sandbox.api.vnswitch.nivc.ai/payouts/payout_7c1e4b9a2f/fulfill",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "api-key": process.env.VNSWITCH_API_KEY,
    },
    body: JSON.stringify({ payout_id: "payout_7c1e4b9a2f" }),
  },
);
console.log(await res.json());

import os
import requests

resp = requests.post(
    "https://sandbox.api.vnswitch.nivc.ai/payouts/payout_7c1e4b9a2f/fulfill",
    headers={"api-key": os.environ["VNSWITCH_API_KEY"]},
    json={"payout_id": "payout_7c1e4b9a2f"},
)
print(resp.json())

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://sandbox.api.vnswitch.nivc.ai/payouts/payout_7c1e4b9a2f/fulfill"))
    .header("Content-Type", "application/json")
    .header("api-key", System.getenv("VNSWITCH_API_KEY"))
    .POST(HttpRequest.BodyPublishers.ofString("{ \"payout_id\": \"payout_7c1e4b9a2f\" }"))
    .build();
HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response

{
  "payout_id": "payout_7c1e4b9a2f",
  "merchant_id": "merchant_demo",
  "amount": 150000,
  "currency": "VND",
  "payout_type": "card",
  "status": "initiated",
  "connector": "<PROVIDER>",
  "auto_fulfill": false,
  "customer_id": "cus_demo_001",
  "client_secret": "payout_payout_7c1e4b9a2f_secret_<RANDOM>",
  "return_url": null,
  "business_country": null,
  "entity_type": "Individual",
  "recurring": false,
  "profile_id": "pro_demo_001",
  "connector_transaction_id": "<PROVIDER_REFERENCE>",
  "error_code": null,
  "error_message": null,
  "created": "2026-11-01T09:30:00.000Z"
}

Response

The payout object, usually with status initiated, pending or success.

Cancel a payout

Cancels a payout that has not reached a final status, for example one waiting in requires_confirmation or requires_fulfillment. A payout that is already success, failed, cancelled or in another final status cannot be cancelled.

POST /payouts/{payout_id}/cancel

Authentication: secret API key (api-key header).

Path parameters

Parameter	Type	Required	Description
`payout_id`	string	Yes	The payout to cancel.

Body parameters

Parameter	Type	Required	Description
`payout_id`	string	Yes	The same payout ID as in the path.

Example request

curl -X POST https://sandbox.api.vnswitch.nivc.ai/payouts/payout_7c1e4b9a2f/cancel \
  -H "Content-Type: application/json" \
  -H "api-key: <YOUR_API_KEY>" \
  -d '{ "payout_id": "payout_7c1e4b9a2f" }'

const res = await fetch(
  "https://sandbox.api.vnswitch.nivc.ai/payouts/payout_7c1e4b9a2f/cancel",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "api-key": process.env.VNSWITCH_API_KEY,
    },
    body: JSON.stringify({ payout_id: "payout_7c1e4b9a2f" }),
  },
);
console.log(await res.json());

import os
import requests

resp = requests.post(
    "https://sandbox.api.vnswitch.nivc.ai/payouts/payout_7c1e4b9a2f/cancel",
    headers={"api-key": os.environ["VNSWITCH_API_KEY"]},
    json={"payout_id": "payout_7c1e4b9a2f"},
)
print(resp.json())

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://sandbox.api.vnswitch.nivc.ai/payouts/payout_7c1e4b9a2f/cancel"))
    .header("Content-Type", "application/json")
    .header("api-key", System.getenv("VNSWITCH_API_KEY"))
    .POST(HttpRequest.BodyPublishers.ofString("{ \"payout_id\": \"payout_7c1e4b9a2f\" }"))
    .build();
HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response

{
  "payout_id": "payout_7c1e4b9a2f",
  "merchant_id": "merchant_demo",
  "amount": 150000,
  "currency": "VND",
  "payout_type": "card",
  "status": "cancelled",
  "connector": "<PROVIDER>",
  "auto_fulfill": false,
  "customer_id": "cus_demo_001",
  "client_secret": "payout_payout_7c1e4b9a2f_secret_<RANDOM>",
  "return_url": null,
  "business_country": null,
  "entity_type": "Individual",
  "recurring": false,
  "profile_id": "pro_demo_001",
  "error_code": null,
  "error_message": null,
  "created": "2026-11-01T09:30:00.000Z"
}

Response

The payout object with status cancelled. If the provider has already started the transfer, the cancellation is passed to the provider and the final result can arrive as a webhook.

List payouts

Returns your payouts, filtered by the query parameters. All parameters are optional.

GET /payouts/list

Authentication: secret API key (api-key header).

Query parameters

Parameter	Type	Required	Description
`customer_id`	string	No	Only payouts to this customer.
`limit`	integer	No	Number of payouts to return, 1 to 100. Default 10.
`starting_after`	string	No	A payout ID. Returns the payouts after it, for the next page.
`ending_before`	string	No	A payout ID. Returns the payouts before it, for the previous page.
`created`	string	No	ISO 8601 date-time. Only payouts created at this time.
`start_time`	string	No	ISO 8601 date-time. Only payouts created at or after this time.
`end_time`	string	No	ISO 8601 date-time. Only payouts created up to this time. Defaults to now. Use it together with `start_time`.

Example request

curl -X GET "https://sandbox.api.vnswitch.nivc.ai/payouts/list?customer_id=cus_demo_001&limit=10" \
  -H "api-key: <YOUR_API_KEY>"

const params = new URLSearchParams({ customer_id: "cus_demo_001", limit: "10" });
const res = await fetch(
  `https://sandbox.api.vnswitch.nivc.ai/payouts/list?${params}`,
  { headers: { "api-key": process.env.VNSWITCH_API_KEY } },
);
console.log(await res.json());

import os
import requests

resp = requests.get(
    "https://sandbox.api.vnswitch.nivc.ai/payouts/list",
    headers={"api-key": os.environ["VNSWITCH_API_KEY"]},
    params={"customer_id": "cus_demo_001", "limit": 10},
)
print(resp.json())

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://sandbox.api.vnswitch.nivc.ai/payouts/list?customer_id=cus_demo_001&limit=10"))
    .header("api-key", System.getenv("VNSWITCH_API_KEY"))
    .GET()
    .build();
HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response

{
  "size": 1,
  "total_count": 1,
  "data": [
    {
      "payout_id": "payout_7c1e4b9a2f",
      "merchant_id": "merchant_demo",
      "amount": 150000,
      "currency": "VND",
      "payout_type": "card",
      "status": "success",
      "connector": "<PROVIDER>",
      "auto_fulfill": false,
      "customer_id": "cus_demo_001",
      "client_secret": "payout_payout_7c1e4b9a2f_secret_<RANDOM>",
      "return_url": null,
      "business_country": null,
      "entity_type": "Individual",
      "recurring": false,
      "profile_id": "pro_demo_001",
      "created": "2026-11-01T09:30:00.000Z"
    }
  ]
}

Response

Field	Description
`size`	Number of payouts in this response.
`total_count`	Number of payouts that match the filters.
`data`	Array of payout objects.

Saved payment methods and recurring payments

Webhooks

Docs

VNSwitch Docs

Title here

Payouts

Payout flow

Payout status

Payout method data

Create a payout

Body parameters

Response

Retrieve a payout

Path parameters

Query parameters

Response

Confirm a payout

Path parameters

Body parameters

Response

Fulfill a payout

Path parameters

Body parameters

Response

Cancel a payout

Path parameters

Body parameters

Response

List payouts

Query parameters

Response

Payouts

Payout flow#

Payout status#

Payout method data#

Create a payout#

Body parameters#

Response#

Retrieve a payout#

Path parameters#

Query parameters#

Response#

Confirm a payout#

Path parameters#

Body parameters#

Response#

Fulfill a payout#

Path parameters#

Body parameters#

Response#

Cancel a payout#

Path parameters#

Body parameters#

Response#

List payouts#

Query parameters#

Response#

Payout flow

Payout status

Payout method data

Create a payout

Body parameters

Response

Retrieve a payout

Path parameters

Query parameters

Response

Confirm a payout

Path parameters

Body parameters

Response

Fulfill a payout

Path parameters

Body parameters

Response

Cancel a payout

Path parameters

Body parameters

Response

List payouts

Query parameters

Response