Create external beneficiary

creates an external beneficiary record (wallet + beneficiary details) for a given account this external beneficiary can then be used by partners as a payment destination on supported blockchains { "name" "endpoint v1/accounts/{accountnumber}/external addresses", "method" "post", "url" "{sandbox url}/v1/accounts/{accountnumber}/external addresses", "description" "", "tab" "examples", "examples" { "languages" \[ { "id" "gvbyb xxxg8aaahk3ybhl", "language" "curl", "code" "/v1/accounts/2917000057/external addresses\n\n{\n \\"title\\" \\"john's meta mask\\",\n \\"blockchain\\" \\"ethereum\\",\n \\"address\\" \\"0x0e6f76783822826ed173fee6265bdbbdfed4a0f5\\",\n \\"tag\\" \\"john eth\\",\n \\"beneficiary\\" {\n \\"name\\" \\"john doe\\",\n \\"addressline1\\" \\"2115 linwood\\",\n \\"addressline2\\" \\"ave\\",\n \\"city\\" \\"fort lee\\",\n \\"stateprovince\\" \\"nj\\",\n \\"countrycode\\" \\"us\\",\n \\"postalcode\\" \\"07024\\"\n }\n}", "customlabel" "" } ], "selectedlanguageid" "gvbyb xxxg8aaahk3ybhl" }, "results" { "languages" \[ { "id" "vvw eg1cazm9nswdn62ez", "language" "200", "code" "{\n \\"id\\" \\"6d5a90a0 4967 44ba 8380 b39d011abba0\\",\n \\"accountnumber\\" \\"2917000057\\",\n \\"partnerid\\" \\"7712a77c 60a7 49c5 9f08 b1a1012d253f\\",\n \\"title\\" \\"john's meta mask\\",\n \\"blockchain\\" \\"ethereum\\",\n \\"address\\" \\"0x0e6f76783822826ed173fee6265bdbbdfed4a0f5\\",\n \\"tag\\" \\"john eth\\",\n \\"beneficiary\\" {\n \\"name\\" \\"john doe\\",\n \\"addressline1\\" \\"2115 linwood\\",\n \\"addressline2\\" \\"ave\\",\n \\"city\\" \\"fort lee\\",\n \\"stateprovince\\" \\"nj\\",\n \\"countrycode\\" \\"us\\",\n \\"postalcode\\" \\"07024\\"\n },\n \\"lastmodifiedat\\" \\"2025 11 22t17 09 23 9971536z\\"\n}", "customlabel" "" } ], "selectedlanguageid" "vvw eg1cazm9nswdn62ez" }, "request" { "pathparameters" \[ { "name" "accountnumber", "kind" "required", "type" "string", "description" "unique identifier of the account whose wallet addresses will be retrieved", "" "unique identifier of the account whose wallet addresses will be retrieved" } ], "queryparameters" \[], "headerparameters" \[], "bodydataparameters" \[ { "name" "title", "kind" "required", "type" "string", "description" "human readable label for the external wallet (e g , “john’s metamask wallet”) max length 255", "" "human readable label for the external wallet (e g , “john’s metamask wallet”) max length 255" }, { "name" "blockchain", "kind" "required", "type" "string", "description" "blockchain network where payments will be sent (e g , solana, ethereum) max length 20", "" "blockchain network where payments will be sent (e g , solana, ethereum) max length 20" }, { "name" "address", "kind" "required", "type" "string", "description" "blockchain wallet address of the beneficiary max length 255", "" "blockchain wallet address of the beneficiary max length 255" }, { "name" "tag", "kind" "optional", "type" "string", "description" "optional memo/tag/destination tag if required by the blockchain (e g , for xrp, stellar) max length 255", "" "optional memo/tag/destination tag if required by the blockchain (e g , for xrp, stellar) max length 255" }, { "name" "beneficiary", "kind" "required", "type" "object", "description" "beneficiary details including name and address information", "" "required", "children" \[ { "name" "name", "kind" "required", "type" "string", "description" "full legal name of the beneficiary max length 200" }, { "name" "addressline1", "kind" "required", "type" "string", "description" "first line of the beneficiary’s physical address max length 80" }, { "name" "addressline2", "kind" "optional", "type" "string", "description" "second line of the beneficiary’s physical address (optional) max length 80" }, { "name" "city", "kind" "required", "type" "string", "description" "city where the beneficiary resides max length 40" }, { "name" "stateprovince", "kind" "required", "type" "string", "description" "state or province of the beneficiary max length 2" }, { "name" "countrycode", "kind" "required", "type" "string", "description" "iso 3166 1 alpha 2 country code of the beneficiary max length 2" }, { "name" "postalcode", "kind" "required", "type" "string", "description" "postal/zip code of the beneficiary max length 20" } ], "schema" \[ { "name" "name", "kind" "required", "type" "string", "description" "full legal name of the beneficiary max length 200" }, { "name" "addressline1", "kind" "required", "type" "string", "description" "first line of the beneficiary’s physical address max length 80" }, { "name" "addressline2", "kind" "optional", "type" "string", "description" "second line of the beneficiary’s physical address (optional) max length 80" }, { "name" "city", "kind" "required", "type" "string", "description" "city where the beneficiary resides max length 40" }, { "name" "stateprovince", "kind" "required", "type" "string", "description" "state or province of the beneficiary max length 2" }, { "name" "countrycode", "kind" "required", "type" "string", "description" "iso 3166 1 alpha 2 country code of the beneficiary max length 2" }, { "name" "postalcode", "kind" "required", "type" "string", "description" "postal/zip code of the beneficiary max length 20" } ] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "hastryitout" false, "response" \[ { "name" "id", "kind" "optional", "type" "string", "description" "unique identifier of the external beneficiary record" }, { "name" "accountnumber", "kind" "optional", "type" "string", "description" "account number associated with the beneficiary", "children" \[] }, { "name" "partnerid", "kind" "optional", "type" "string", "description" "identifier of the partner creating/owning this beneficiary record", "children" \[] }, { "name" "title", "kind" "optional", "type" "string", "description" "human readable label for the wallet (e g , eth, sol, ethereum)", "children" \[] }, { "name" "blockchain", "kind" "optional", "type" "string", "description" "blockchain network name", "children" \[] }, { "name" "address", "kind" "optional", "type" "string", "description" "blockchain wallet address of the beneficiary", "children" \[] }, { "name" "tag", "kind" "optional", "type" "string", "description" "tag/memo/destination tag if applicable", "children" \[] }, { "name" "beneficiary", "kind" "optional", "type" "object", "description" "beneficiary details", "children" \[ { "name" "name", "kind" "optional", "type" "string", "description" "full legal name of the beneficiary" }, { "name" "addressline1", "kind" "optional", "type" "string", "description" "first line of the beneficiary’s physical address" }, { "name" "addressline2", "kind" "optional", "type" "string", "description" "second line of the beneficiary’s physical address (nullable)" }, { "name" "city", "kind" "optional", "type" "string", "description" "city where the beneficiary resides" }, { "name" "stateprovince", "kind" "optional", "type" "string", "description" "state or province" }, { "name" "countrycode", "kind" "optional", "type" "string", "description" "iso 3166 1 alpha 2 country code" }, { "name" "postalcode", "kind" "optional", "type" "string", "description" "postal/zip code" } ] }, { "name" "lastmodifiedat", "kind" "optional", "type" "string", "description" "iso 8601 timestamp of last modification", "children" \[] } ] }