Update Beneficiary
curl --request PATCH \
--url https://api.rolla.xyz/api/v1/external/beneficiaries/{beneficiaryId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"currency": "NGN",
"label": "<string>",
"account_name": "JOHN DOE",
"account_number": "0123456789",
"bank_name": "Access Bank",
"bank_code": "000014",
"bank_address": {
"street": "270 Park Ave",
"city": "New York",
"state": "NY",
"postalCode": "10017",
"country": "US"
},
"swift_code": "<string>",
"email": "jsmith@example.com",
"contact_person": "<string>",
"beneficiary_address": {
"street": "123 Main St",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "US"
},
"routing_number": "<string>",
"wallet_address": "<string>",
"wallet_chain": "<string>",
"intermediary_bank_name": "<string>",
"intermediary_bank_routing_number": "<string>",
"recipient_business_id": "d4e5f6a7-b8c9-0123-defa-456789012345",
"account_owner_type": "business",
"account_category": "checking"
}
'import requests
url = "https://api.rolla.xyz/api/v1/external/beneficiaries/{beneficiaryId}"
payload = {
"currency": "NGN",
"label": "<string>",
"account_name": "JOHN DOE",
"account_number": "0123456789",
"bank_name": "Access Bank",
"bank_code": "000014",
"bank_address": {
"street": "270 Park Ave",
"city": "New York",
"state": "NY",
"postalCode": "10017",
"country": "US"
},
"swift_code": "<string>",
"email": "jsmith@example.com",
"contact_person": "<string>",
"beneficiary_address": {
"street": "123 Main St",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "US"
},
"routing_number": "<string>",
"wallet_address": "<string>",
"wallet_chain": "<string>",
"intermediary_bank_name": "<string>",
"intermediary_bank_routing_number": "<string>",
"recipient_business_id": "d4e5f6a7-b8c9-0123-defa-456789012345",
"account_owner_type": "business",
"account_category": "checking"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
currency: 'NGN',
label: '<string>',
account_name: 'JOHN DOE',
account_number: '0123456789',
bank_name: 'Access Bank',
bank_code: '000014',
bank_address: {
street: '270 Park Ave',
city: 'New York',
state: 'NY',
postalCode: '10017',
country: 'US'
},
swift_code: '<string>',
email: 'jsmith@example.com',
contact_person: '<string>',
beneficiary_address: {
street: '123 Main St',
city: 'New York',
state: 'NY',
postalCode: '10001',
country: 'US'
},
routing_number: '<string>',
wallet_address: '<string>',
wallet_chain: '<string>',
intermediary_bank_name: '<string>',
intermediary_bank_routing_number: '<string>',
recipient_business_id: 'd4e5f6a7-b8c9-0123-defa-456789012345',
account_owner_type: 'business',
account_category: 'checking'
})
};
fetch('https://api.rolla.xyz/api/v1/external/beneficiaries/{beneficiaryId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.rolla.xyz/api/v1/external/beneficiaries/{beneficiaryId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'currency' => 'NGN',
'label' => '<string>',
'account_name' => 'JOHN DOE',
'account_number' => '0123456789',
'bank_name' => 'Access Bank',
'bank_code' => '000014',
'bank_address' => [
'street' => '270 Park Ave',
'city' => 'New York',
'state' => 'NY',
'postalCode' => '10017',
'country' => 'US'
],
'swift_code' => '<string>',
'email' => 'jsmith@example.com',
'contact_person' => '<string>',
'beneficiary_address' => [
'street' => '123 Main St',
'city' => 'New York',
'state' => 'NY',
'postalCode' => '10001',
'country' => 'US'
],
'routing_number' => '<string>',
'wallet_address' => '<string>',
'wallet_chain' => '<string>',
'intermediary_bank_name' => '<string>',
'intermediary_bank_routing_number' => '<string>',
'recipient_business_id' => 'd4e5f6a7-b8c9-0123-defa-456789012345',
'account_owner_type' => 'business',
'account_category' => 'checking'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.rolla.xyz/api/v1/external/beneficiaries/{beneficiaryId}"
payload := strings.NewReader("{\n \"currency\": \"NGN\",\n \"label\": \"<string>\",\n \"account_name\": \"JOHN DOE\",\n \"account_number\": \"0123456789\",\n \"bank_name\": \"Access Bank\",\n \"bank_code\": \"000014\",\n \"bank_address\": {\n \"street\": \"270 Park Ave\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"postalCode\": \"10017\",\n \"country\": \"US\"\n },\n \"swift_code\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"contact_person\": \"<string>\",\n \"beneficiary_address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"postalCode\": \"10001\",\n \"country\": \"US\"\n },\n \"routing_number\": \"<string>\",\n \"wallet_address\": \"<string>\",\n \"wallet_chain\": \"<string>\",\n \"intermediary_bank_name\": \"<string>\",\n \"intermediary_bank_routing_number\": \"<string>\",\n \"recipient_business_id\": \"d4e5f6a7-b8c9-0123-defa-456789012345\",\n \"account_owner_type\": \"business\",\n \"account_category\": \"checking\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.rolla.xyz/api/v1/external/beneficiaries/{beneficiaryId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"currency\": \"NGN\",\n \"label\": \"<string>\",\n \"account_name\": \"JOHN DOE\",\n \"account_number\": \"0123456789\",\n \"bank_name\": \"Access Bank\",\n \"bank_code\": \"000014\",\n \"bank_address\": {\n \"street\": \"270 Park Ave\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"postalCode\": \"10017\",\n \"country\": \"US\"\n },\n \"swift_code\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"contact_person\": \"<string>\",\n \"beneficiary_address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"postalCode\": \"10001\",\n \"country\": \"US\"\n },\n \"routing_number\": \"<string>\",\n \"wallet_address\": \"<string>\",\n \"wallet_chain\": \"<string>\",\n \"intermediary_bank_name\": \"<string>\",\n \"intermediary_bank_routing_number\": \"<string>\",\n \"recipient_business_id\": \"d4e5f6a7-b8c9-0123-defa-456789012345\",\n \"account_owner_type\": \"business\",\n \"account_category\": \"checking\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rolla.xyz/api/v1/external/beneficiaries/{beneficiaryId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"currency\": \"NGN\",\n \"label\": \"<string>\",\n \"account_name\": \"JOHN DOE\",\n \"account_number\": \"0123456789\",\n \"bank_name\": \"Access Bank\",\n \"bank_code\": \"000014\",\n \"bank_address\": {\n \"street\": \"270 Park Ave\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"postalCode\": \"10017\",\n \"country\": \"US\"\n },\n \"swift_code\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"contact_person\": \"<string>\",\n \"beneficiary_address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"postalCode\": \"10001\",\n \"country\": \"US\"\n },\n \"routing_number\": \"<string>\",\n \"wallet_address\": \"<string>\",\n \"wallet_chain\": \"<string>\",\n \"intermediary_bank_name\": \"<string>\",\n \"intermediary_bank_routing_number\": \"<string>\",\n \"recipient_business_id\": \"d4e5f6a7-b8c9-0123-defa-456789012345\",\n \"account_owner_type\": \"business\",\n \"account_category\": \"checking\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Beneficiary updated successfully",
"data": {
"beneficiary": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"currency": "NGN",
"label": "Office rent",
"account_name": "JOHN DOE",
"account_number": "0123456789",
"bank_name": "Access Bank",
"bank_code": "000014",
"bank_address": "<string>",
"swift_code": "<string>",
"email": "jsmith@example.com",
"contact_person": "<string>",
"beneficiary_address": "<string>",
"withdrawal_method": "domestic_wire",
"routing_number": "<string>",
"wallet_address": "<string>",
"wallet_chain": "<string>",
"intermediary_bank_name": "<string>",
"intermediary_bank_routing_number": "<string>",
"recipient_business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_owner_type": "business",
"account_category": "checking",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
}{
"success": false,
"message": "<string>"
}{
"success": false,
"message": "<string>"
}{
"success": false,
"message": "<string>"
}Beneficiaries
Update Beneficiary
Updates an existing beneficiary’s details. Also used to backfill the account_owner_type and account_category classification fields on beneficiaries created before those fields existed.
PATCH
/
beneficiaries
/
{beneficiaryId}
Update Beneficiary
curl --request PATCH \
--url https://api.rolla.xyz/api/v1/external/beneficiaries/{beneficiaryId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"currency": "NGN",
"label": "<string>",
"account_name": "JOHN DOE",
"account_number": "0123456789",
"bank_name": "Access Bank",
"bank_code": "000014",
"bank_address": {
"street": "270 Park Ave",
"city": "New York",
"state": "NY",
"postalCode": "10017",
"country": "US"
},
"swift_code": "<string>",
"email": "jsmith@example.com",
"contact_person": "<string>",
"beneficiary_address": {
"street": "123 Main St",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "US"
},
"routing_number": "<string>",
"wallet_address": "<string>",
"wallet_chain": "<string>",
"intermediary_bank_name": "<string>",
"intermediary_bank_routing_number": "<string>",
"recipient_business_id": "d4e5f6a7-b8c9-0123-defa-456789012345",
"account_owner_type": "business",
"account_category": "checking"
}
'import requests
url = "https://api.rolla.xyz/api/v1/external/beneficiaries/{beneficiaryId}"
payload = {
"currency": "NGN",
"label": "<string>",
"account_name": "JOHN DOE",
"account_number": "0123456789",
"bank_name": "Access Bank",
"bank_code": "000014",
"bank_address": {
"street": "270 Park Ave",
"city": "New York",
"state": "NY",
"postalCode": "10017",
"country": "US"
},
"swift_code": "<string>",
"email": "jsmith@example.com",
"contact_person": "<string>",
"beneficiary_address": {
"street": "123 Main St",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "US"
},
"routing_number": "<string>",
"wallet_address": "<string>",
"wallet_chain": "<string>",
"intermediary_bank_name": "<string>",
"intermediary_bank_routing_number": "<string>",
"recipient_business_id": "d4e5f6a7-b8c9-0123-defa-456789012345",
"account_owner_type": "business",
"account_category": "checking"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
currency: 'NGN',
label: '<string>',
account_name: 'JOHN DOE',
account_number: '0123456789',
bank_name: 'Access Bank',
bank_code: '000014',
bank_address: {
street: '270 Park Ave',
city: 'New York',
state: 'NY',
postalCode: '10017',
country: 'US'
},
swift_code: '<string>',
email: 'jsmith@example.com',
contact_person: '<string>',
beneficiary_address: {
street: '123 Main St',
city: 'New York',
state: 'NY',
postalCode: '10001',
country: 'US'
},
routing_number: '<string>',
wallet_address: '<string>',
wallet_chain: '<string>',
intermediary_bank_name: '<string>',
intermediary_bank_routing_number: '<string>',
recipient_business_id: 'd4e5f6a7-b8c9-0123-defa-456789012345',
account_owner_type: 'business',
account_category: 'checking'
})
};
fetch('https://api.rolla.xyz/api/v1/external/beneficiaries/{beneficiaryId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.rolla.xyz/api/v1/external/beneficiaries/{beneficiaryId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'currency' => 'NGN',
'label' => '<string>',
'account_name' => 'JOHN DOE',
'account_number' => '0123456789',
'bank_name' => 'Access Bank',
'bank_code' => '000014',
'bank_address' => [
'street' => '270 Park Ave',
'city' => 'New York',
'state' => 'NY',
'postalCode' => '10017',
'country' => 'US'
],
'swift_code' => '<string>',
'email' => 'jsmith@example.com',
'contact_person' => '<string>',
'beneficiary_address' => [
'street' => '123 Main St',
'city' => 'New York',
'state' => 'NY',
'postalCode' => '10001',
'country' => 'US'
],
'routing_number' => '<string>',
'wallet_address' => '<string>',
'wallet_chain' => '<string>',
'intermediary_bank_name' => '<string>',
'intermediary_bank_routing_number' => '<string>',
'recipient_business_id' => 'd4e5f6a7-b8c9-0123-defa-456789012345',
'account_owner_type' => 'business',
'account_category' => 'checking'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.rolla.xyz/api/v1/external/beneficiaries/{beneficiaryId}"
payload := strings.NewReader("{\n \"currency\": \"NGN\",\n \"label\": \"<string>\",\n \"account_name\": \"JOHN DOE\",\n \"account_number\": \"0123456789\",\n \"bank_name\": \"Access Bank\",\n \"bank_code\": \"000014\",\n \"bank_address\": {\n \"street\": \"270 Park Ave\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"postalCode\": \"10017\",\n \"country\": \"US\"\n },\n \"swift_code\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"contact_person\": \"<string>\",\n \"beneficiary_address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"postalCode\": \"10001\",\n \"country\": \"US\"\n },\n \"routing_number\": \"<string>\",\n \"wallet_address\": \"<string>\",\n \"wallet_chain\": \"<string>\",\n \"intermediary_bank_name\": \"<string>\",\n \"intermediary_bank_routing_number\": \"<string>\",\n \"recipient_business_id\": \"d4e5f6a7-b8c9-0123-defa-456789012345\",\n \"account_owner_type\": \"business\",\n \"account_category\": \"checking\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.rolla.xyz/api/v1/external/beneficiaries/{beneficiaryId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"currency\": \"NGN\",\n \"label\": \"<string>\",\n \"account_name\": \"JOHN DOE\",\n \"account_number\": \"0123456789\",\n \"bank_name\": \"Access Bank\",\n \"bank_code\": \"000014\",\n \"bank_address\": {\n \"street\": \"270 Park Ave\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"postalCode\": \"10017\",\n \"country\": \"US\"\n },\n \"swift_code\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"contact_person\": \"<string>\",\n \"beneficiary_address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"postalCode\": \"10001\",\n \"country\": \"US\"\n },\n \"routing_number\": \"<string>\",\n \"wallet_address\": \"<string>\",\n \"wallet_chain\": \"<string>\",\n \"intermediary_bank_name\": \"<string>\",\n \"intermediary_bank_routing_number\": \"<string>\",\n \"recipient_business_id\": \"d4e5f6a7-b8c9-0123-defa-456789012345\",\n \"account_owner_type\": \"business\",\n \"account_category\": \"checking\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rolla.xyz/api/v1/external/beneficiaries/{beneficiaryId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"currency\": \"NGN\",\n \"label\": \"<string>\",\n \"account_name\": \"JOHN DOE\",\n \"account_number\": \"0123456789\",\n \"bank_name\": \"Access Bank\",\n \"bank_code\": \"000014\",\n \"bank_address\": {\n \"street\": \"270 Park Ave\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"postalCode\": \"10017\",\n \"country\": \"US\"\n },\n \"swift_code\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"contact_person\": \"<string>\",\n \"beneficiary_address\": {\n \"street\": \"123 Main St\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"postalCode\": \"10001\",\n \"country\": \"US\"\n },\n \"routing_number\": \"<string>\",\n \"wallet_address\": \"<string>\",\n \"wallet_chain\": \"<string>\",\n \"intermediary_bank_name\": \"<string>\",\n \"intermediary_bank_routing_number\": \"<string>\",\n \"recipient_business_id\": \"d4e5f6a7-b8c9-0123-defa-456789012345\",\n \"account_owner_type\": \"business\",\n \"account_category\": \"checking\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Beneficiary updated successfully",
"data": {
"beneficiary": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"currency": "NGN",
"label": "Office rent",
"account_name": "JOHN DOE",
"account_number": "0123456789",
"bank_name": "Access Bank",
"bank_code": "000014",
"bank_address": "<string>",
"swift_code": "<string>",
"email": "jsmith@example.com",
"contact_person": "<string>",
"beneficiary_address": "<string>",
"withdrawal_method": "domestic_wire",
"routing_number": "<string>",
"wallet_address": "<string>",
"wallet_chain": "<string>",
"intermediary_bank_name": "<string>",
"intermediary_bank_routing_number": "<string>",
"recipient_business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_owner_type": "business",
"account_category": "checking",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
}{
"success": false,
"message": "<string>"
}{
"success": false,
"message": "<string>"
}{
"success": false,
"message": "<string>"
}Update the details of an existing saved beneficiary.
PATCH is the current update verb. PUT /beneficiaries/{beneficiaryId} remains supported as a
backward-compatible alias with identical behaviour, but new integrations should use PATCH.Example Request
curl -X PATCH "https://api.rolla.xyz/api/v1/external/beneficiaries/c3d4e5f6-a7b8-9012-cdef-123456789012" \
-H "X-API-Key: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"currency": "NGN",
"label": "Updated label",
"account_name": "JOHN DOE",
"account_number": "0123456789",
"bank_name": "Access Bank",
"bank_code": "000014",
"account_owner_type": "business",
"email": "john.updated@example.com"
}'
PATCH/PUT is also how you backfill the new classification fields on an existing
beneficiary that predates them — send account_owner_type (and account_category for USD)
to bring a legacy record into compliance.Example Response
{
"status": 200,
"success": true,
"message": "Beneficiary updated successfully",
"data": {
"id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"currency": "NGN",
"label": "Updated label",
"account_name": "JOHN DOE",
"account_number": "0123456789",
"bank_name": "Access Bank",
"bank_code": "000014",
"withdrawal_method": null,
"account_owner_type": "business",
"email": "john.updated@example.com",
"created_at": "2024-01-10T08:00:00.000Z",
"updated_at": "2024-01-15T12:00:00.000Z"
}
}
The same validation rules apply as when creating a beneficiary, including the new
account_owner_type and account_category fields and their grace-period behaviour. See the
Create Beneficiary endpoint for required
fields by withdrawal method, and the
Beneficiary Account Fields migration guide.The body is validated as a whole, not as a partial patch — send the method’s full required
field set, not just the fields you are changing. In particular, a beneficiary on
"withdrawal_method": "ach" or "domestic_wire" must include routing_number in the same
request, now that it is enforced for both rails.Authorizations
Your Rolla API key
Path Parameters
Beneficiary UUID
Body
application/json
Currency code (e.g., NGN, USD)
Example:
"NGN"
Friendly label for the beneficiary
Account holder name
Maximum string length:
100Example:
"JOHN DOE"
Bank account number
Maximum string length:
50Example:
"0123456789"
Bank name
Maximum string length:
100Example:
"Access Bank"
Bank code (required for NGN beneficiaries)
Maximum string length:
20Example:
"000014"
Bank's physical address. Required for USD domestic and international wire transfers.
Show child attributes
Show child attributes
SWIFT/BIC code (required for international wire)
Maximum string length:
20Beneficiary email
Maximum string length:
100Contact person name
Maximum string length:
100Beneficiary's physical address. Required for USD domestic and international wire transfers.
Show child attributes
Show child attributes
Withdrawal method
Available options:
domestic_wire, international_wire, ach, crypto_usdt, crypto_usdc, rolla_transfer 9-digit ABA routing number. Required for USD ach and domestic_wire.
Maximum string length:
20Crypto wallet address (for crypto withdrawals)
Blockchain network (for crypto withdrawals)
Maximum string length:
50Intermediary bank name
Maximum string length:
255Intermediary bank routing number
Maximum string length:
50Required for rolla_transfer. The UUID of the destination Rolla business.
Example:
"d4e5f6a7-b8c9-0123-defa-456789012345"
Whether the account is held by an individual or a business. Required for every bank-account beneficiary (any fiat method that is not crypto or rolla_transfer, including NGN bank transfer, domestic_wire, and international_wire). Not applicable to crypto_usdt, crypto_usdc, or rolla_transfer. During the deprecation grace period, requests that omit this field still succeed but return a deprecation_warning object; after the enforcement date the request is rejected with a 400. See the Beneficiary Account Fields migration guide.
Available options:
individual, business Example:
"business"
Whether a USD account is checking or savings. Required only when currency is USD. If you are not sure, use "checking". Subject to the same grace-period behaviour as account_owner_type.
Available options:
checking, savings Example:
"checking"
⌘I