Recipes
Creating a new beneficiary Sequence
a new beneficiary can be created at any time it is essential to ensure that all beneficiary details, especially banking information, are accurately entered to facilitate seamless risk and compliance screening and prevent any processing delays step 1 data lookup to facilitate the creation of a new beneficiary, certain fields will require selection from existing data sources retrieve countries docid 7wct1lz9ruo1vg7edsxk9 this data source contains a list of countries, identified by either 'country code' or 'country id', that are currently supported for beneficiary setup it also displays the available currencies within each country, using 'currency code' and 'currency id' both the country and currency source are required for step 2 if any necessary countries are missing from the list, please reach out to us for further assistance { "id" 10004, "name" "australia", "can" { "create beneficiaries" true, "create customers" true }, "country code" "aus", "default currency" { "id" 10004, "name" "australian dollar", "currency code" "aud" }, "available currencies" \[ { "id" 10001, "name" "us dollar", "currency code" "usd" }, { "id" 10004, "name" "australian dollar", "currency code" "aud" }, { "id" 10002, "name" "euro", "currency code" "eur" }, { "id" 10032, "name" "hong kong dollar", "currency code" "hkd" }, { "id" 10221, "name" "chinese yuan hong kong", "currency code" "cnh" } ] }, retrieve currencies docid\ nqvzxzxiskckwa1hgh3no this data source offers a list of supported currencies for step 2, you may use either the 'currency code' or 'currency id' the response indicates whether each currency can be bought or sold if any required currencies are missing, please contact us for further assistance { "currencies" \[ { "id" 10001, "name" "us dollar", "currency code" "usd", "can" \[ "sell", "buy" ] }, { "id" 10004, "name" "australian dollar", "currency code" "aud", "can" \[ "sell", "buy" ] }, { "id" 10002, "name" "euro", "currency code" "eur", "can" \[ "sell", "buy" ] }, retrieve a remuneration type docid 3hpglkccpbvsmfnyppc2c there are 2 types of remuneration, "priority" (international via swift) or "local" (via payid) { "remuneration types" \[ { "id" 4, "name" "priority", "label" "international" } ], "pagination" { "item count" 1, "page" 1, "page size" 20 } } retrieve transaction reasons docid\ mwyscy45cvxfgsdh7ejp2 this data source offers a list of transaction reasons to choose from, depending on the selected country each country may have different transaction reasons or none at all { "transaction reasons" \[ { "id" 10451, "name" "goods trade", "user input required" false, "countries" \[ { "id" 10131, "name" "united states", "country code" "us" } ] }, { "id" 10033, "name" "in or outward remittance ", "user input required" false, "countries" \[ { "id" 10131, "name" "united states", "country code" "us" } ] }, { "id" 10320, "name" "paying and invoice", "user input required" false, "countries" \[ { "id" 10131, "name" "united states", "country code" "us" } ] }, { "id" 10120, "name" "payment for services", "user input required" false, "countries" \[ { "id" 10131, "name" "united states", "country code" "us" } ] } ], "pagination" { "item count" 4, "page" 1, "page size" 20 } } step 2 create a new beneficiary to create a beneficiary docid pv36acbrfknmrlefpvs , it is essential to ensure all details are entered accurately bank/swift codes are automatically validated, and country codes are mandatory for all phone numbers email addresses are not validated, hence it's crucial to double check their accuracy, as email is the primary method of communication for beneficiaries based in australia, "local code" "062692" (known as the bsb number) is a required field once the beneficiary is successfully created, an "id" will be generated and made available for immediate use { "beneficiary" { "id" 24509, //"name" { //"first name" "white", //"middle name" null, //"last name" "rabbit" }, // "status" "approved by client", // "country" { // "id" 10004, // "name" "australia", // "country code" "aus" }, // "currency" { // "id" 10004, // "name" "australian dollar", // "currency code" "aud" }, "account type" { // "id" 10001, // "name" "individual" }, // "mobile" { // "isd" "614", // "number" "040000000" }, // "email" null, // "address" { // "address line 1" "123 test street", // "address line 2" "", // "suburb" "null", // "city" "sydney", // "province" "australia", // "postcode" "00501", // "country code" "aus" }, // "remuneration type" { // "id" 3, // "name" "local", // "label" "local" }, // "reason for payment" "test", // "relation with customer" "friend testing", // "bank details" { // "bank name" "cba", // "bank code" null, // "branch code" null, // "branch name" "test branch", // "account name" null, // "account number" "123456", // "local code" "062692", // "international code" "", // "address line 1" "123 test street", // "address line 2" null, // "country" { // "id" 10004, // "name" "australia", // "country code" "aus" } }, // "created date" "2025 10 08t15 00 38+11 00", // "updated date" "2025 10 08t15 00 38+11 00" } }