---
title: Create a beneficiary.
slug: fx-api/create-a-beneficiary
docTags: 
createdAt: 2025-05-30T02:39:22.451Z
---

{
  "id": "WX3I48dHsjYaxToaRg0Qa",
  "type": "api-oas-v2",
  "data": {
    "method": "POST",
    "url": "https://sand-api.monoova.com/global/v1/beneficiaries",
    "servers": [
      {
        "url": "https://sand-api.monoova.com/global/v1/beneficiaries",
        "description": "Monoova Global server"
      }
    ],
    "name": "Create a beneficiary.",
    "description": "<p>This creates a user beneficiary for making payments or withdrawals. Required fields depend on the remuneration type, country and currency, and can be found by calling retrieve beneficiary fields. Beneficiaries can be updated, or archived.</p>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json"
          ],
          "default": "application/json"
        }
      ],
      "queryParameters": [],
      "bodyDataParameters": [
        {
          "kind": "required",
          "name": "body",
          "type": "object",
          "description": "",
          "schema": [
            {
              "name": "beneficiary",
              "kind": "optional",
              "type": "object",
              "description": "",
              "example": "",
              "schema": [
                {
                  "name": "customer_id",
                  "kind": "required",
                  "type": "integer",
                  "description": ""
                },
                {
                  "name": "country_id",
                  "kind": "required",
                  "type": "integer",
                  "description": ""
                },
                {
                  "name": "country_code",
                  "kind": "optional",
                  "type": "object",
                  "description": "",
                  "modelRef": "#/components/schemas/CountryCode",
                  "customType": "CountryCode",
                  "schema": []
                },
                {
                  "name": "currency_id",
                  "kind": "required",
                  "type": "integer",
                  "description": ""
                },
                {
                  "name": "currency_code",
                  "kind": "optional",
                  "type": "object",
                  "description": "",
                  "modelRef": "#/components/schemas/CurrencyCode",
                  "customType": "CurrencyCode",
                  "schema": []
                },
                {
                  "name": "remuneration_type_id",
                  "kind": "required",
                  "type": "integer",
                  "description": ""
                },
                {
                  "name": "remuneration_type_name",
                  "kind": "optional",
                  "type": "object",
                  "description": "",
                  "modelRef": "#/components/schemas/RemunerationNames",
                  "customType": "RemunerationNames",
                  "schema": []
                },
                {
                  "name": "account_type_id",
                  "kind": "required",
                  "type": "integer",
                  "description": ""
                },
                {
                  "name": "account_type_name",
                  "kind": "optional",
                  "type": "object",
                  "description": "",
                  "modelRef": "#/components/schemas/AccountTypes",
                  "customType": "AccountTypes",
                  "schema": []
                },
                {
                  "name": "is_default",
                  "kind": "optional",
                  "type": "boolean",
                  "description": ""
                },
                {
                  "name": "owned_by_customer",
                  "kind": "optional",
                  "type": "boolean",
                  "description": ""
                },
                {
                  "name": "payout_provider_id",
                  "kind": "optional",
                  "type": "integer",
                  "description": ""
                },
                {
                  "name": "reason_for_payment",
                  "kind": "optional",
                  "type": "string",
                  "description": ""
                },
                {
                  "name": "relation_with_customer",
                  "kind": "optional",
                  "type": "string",
                  "description": ""
                },
                {
                  "name": "email",
                  "kind": "required",
                  "type": "string<email>",
                  "description": "",
                  "format": "email"
                },
                {
                  "name": "name",
                  "kind": "required",
                  "type": "object",
                  "description": "",
                  "modelRef": "#/components/schemas/Name",
                  "customType": "Name",
                  "schema": []
                },
                {
                  "name": "mobile",
                  "kind": "required",
                  "type": "object",
                  "description": "",
                  "modelRef": "#/components/schemas/Phone",
                  "customType": "Phone",
                  "schema": []
                },
                {
                  "name": "address",
                  "kind": "required",
                  "type": "object",
                  "description": "",
                  "modelRef": "#/components/schemas/Address",
                  "customType": "Address",
                  "schema": []
                },
                {
                  "name": "bank_details",
                  "kind": "required",
                  "type": "object",
                  "description": "",
                  "modelRef": "#/components/schemas/BankDetails",
                  "customType": "BankDetails",
                  "schema": []
                },
                {
                  "name": "card_details",
                  "kind": "optional",
                  "type": "object",
                  "description": "",
                  "modelRef": "#/components/schemas/PayoutCard",
                  "customType": "PayoutCard",
                  "schema": []
                }
              ]
            }
          ],
          "isExpanded": true
        }
      ],
      "formDataParameters": [],
      "oAuthParameters": [],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "A beneficiary.",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "schema": [
              {
                "name": "beneficiary",
                "kind": "optional",
                "type": "object",
                "description": "",
                "modelRef": "#/components/schemas/Beneficiary",
                "customType": "Beneficiary",
                "schema": []
              }
            ],
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "gzYQWQATU2YXWRdf9lr-0",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request POST \\\n     --url https://sand-api.monoova.com/global/v1/beneficiaries \\\n     --header 'accept: application/json' \\\n     --header 'content-type: application/json' \\\n     --data '{\n     \"beneficiary\": {\n     \"customer_id\": \"\",\n     \"country_id\": \"\",\n     \"currency_id\": \"\",\n     \"remuneration_type_id\": \"\",\n     \"account_type_id\": \"\",\n     \"email\": \"\",\n     \"name\": \"\",\n     \"mobile\": \"\",\n     \"address\": \"\",\n     \"bank_details\": \"\"\n     }\n     }'"
        },
        {
          "id": "5vSJo0ZYlu2Baq5y6WUyX",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n   \"beneficiary\": {\n      \"customer_id\": \"\",\n      \"country_id\": \"\",\n      \"currency_id\": \"\",\n      \"remuneration_type_id\": \"\",\n      \"account_type_id\": \"\",\n      \"email\": \"\",\n      \"name\": \"\",\n      \"mobile\": \"\",\n      \"address\": \"\",\n      \"bank_details\": \"\"\n   }\n});\n\nvar requestOptions = {\n   method: 'POST',\n   headers: myHeaders,\n   body: raw,\n   redirect: 'follow'\n};\n\nfetch(\"https://sand-api.monoova.com/global/v1/beneficiaries\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "vlcpBMuVtX060-BVCcTbc",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://sand-api.monoova.com/global/v1/beneficiaries\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n   \"beneficiary\": {\n      \"customer_id\": \"\",\n      \"country_id\": \"\",\n      \"currency_id\": \"\",\n      \"remuneration_type_id\": \"\",\n      \"account_type_id\": \"\",\n      \"email\": \"\",\n      \"name\": \"\",\n      \"mobile\": \"\",\n      \"address\": \"\",\n      \"bank_details\": \"\"\n   }\n})\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "rCBo5h_QpFvuC2TolRV0g",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://sand-api.monoova.com/global/v1/beneficiaries\"\n\npayload = json.dumps({\n   \"beneficiary\": {\n      \"customer_id\": \"\",\n      \"country_id\": \"\",\n      \"currency_id\": \"\",\n      \"remuneration_type_id\": \"\",\n      \"account_type_id\": \"\",\n      \"email\": \"\",\n      \"name\": \"\",\n      \"mobile\": \"\",\n      \"address\": \"\",\n      \"bank_details\": \"\"\n   }\n})\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "gzYQWQATU2YXWRdf9lr-0"
    },
    "results": {
      "languages": [
        {
          "id": "qmwvG_0b5VYOiCHEJameH",
          "language": "200",
          "code": "// A beneficiary.\n{\n  \"beneficiary\": {}\n}"
        }
      ],
      "selectedLanguageId": "qmwvG_0b5VYOiCHEJameH"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}