Create a US Bank Account

POST /v2.01/{ClientId}/users/{UserId}/bankaccounts/us

REST

{
    "OwnerAddress": {
        "AddressLine1": "The Oasis",
        "AddressLine2": "Rue des plantes",
        "City": "Paris",
        "Region": "Ile de France",
        "PostalCode": "75009",
        "Country": "FR"
    },
    "AccountNumber": "11696419",
    "ABA": "071000288",
    "DepositAccountType": "CHECKING",
    "OwnerName": "John Doe",
    "Tag": "custom meta",
}
  

<?php 

require_once 'vendor/autoload.php';

use MangoPay\MangoPayApi;
use MangoPay\Libraries\ResponseException as MGPResponseException;
use MangoPay\Libraries\Exception as MGPException;

$api = new MangoPayApi();

$api->Config->ClientId = 'your-client-id';
$api->Config->ClientPassword = 'your-api-key';
$api->Config->TemporaryFolder = 'tmp/';

try {
    $userId = '146476890';

    $bankAccount = new \MangoPay\BankAccount();

    $address = new \MangoPay\Address();
    $address->AddressLine1 = 'Address line 1';
    $address->AddressLine2 = 'Address line 2';
    $address->City = 'Paris';
    $address->Country = 'FR';
    $address->PostalCode = '75000';
    $address->Region = 'Region';

    $details = new \MangoPay\BankAccountDetailsUS();
    $details->AccountNumber = '11696419';
    $details->ABA = '071000288';
    $details->DepositAcountType = 'CHECKING';

    $bankAccount->OwnerAddress = $address;
    $bankAccount->OwnerName = 'Alex Smith';
    $bankAccount->Tag = 'Created using Mangopay PHP SDK';
    $bankAccount->Type = 'IBAN';
    $bankAccount->Details = $details;

    $response = $api->Users->CreateBankAccount($userId, $bankAccount);

    print_r($response);
} catch(MGPResponseException $e) {
    print_r($e);
} catch(MGPException $e) {
    print_r($e);
}  

const mangopayInstance = require('mangopay4-nodejs-sdk')
const mangopay = new mangopayInstance({
  clientId: 'your-client-id',
  clientApiKey: 'your-api-key',
})

let user = {
  Id: '165863393',
  Address: {
    AddressLine1: 'Edgewood Road',
    AddressLine2: null,
    City: 'Little Rock',
    Region: 'IDF',
    PostalCode: '75000',
    Country: 'FR',
  },
  FirstName: 'John',
  LastName: 'Doe',
}

let bankAccount = {
  Type: 'US',
  OwnerName: user.FirstName + '' + user.LastName,
  OwnerAddress: user.Address,
  AccountNumber: '11696419',
  ABA: '071000288',
  DepositAccountType: 'CHECKING',
  Tag: 'Created using Mangopay NodeJS SDK',
}

const createBankAccount = async (userId, bankAccount) => {
  return await mangopay.Users.createBankAccount(userId, bankAccount)
    .then((response) => {
      console.info(response)
      return response
    })
    .catch((err) => {
      console.log(err)
      return false
    })
}

createBankAccount(user.Id, bankAccount)  

require 'mangopay'

MangoPay.configure do |client|
    client.preproduction = true
    client.client_id = 'your-client-id'
    client.client_apiKey = 'your-api-key'
    client.log_file = File.join(Dir.pwd, 'mangopay.log')
end

def createUsBankAccount(userId, usBankAccountObject)
    begin
        response = MangoPay::BankAccount.create(userId, usBankAccountObject)
        puts response
        return response
    rescue MangoPay::ResponseError => error
        puts "Failed to create bank account: #{error.message}"
        puts "Error details: #{error.details}"
        return false
    end
end

myUser = {
    Id: '165863393'
}

myUsBankAccount = {
    Type: 'US',
    OwnerName: 'Alex Smith',
    OwnerAddress: {
        AddressLine1: 'Edgewood Road',
        AddressLine2: 'Address line 2',
        City: 'Little Rock',
        Region: 'IDF',
        PostalCode: '75000',
        Country: 'FR'
    },
    AccountNumber: '11696419',
    ABA: '071000288',
    DepositAccountType: 'CHECKING',
    Tag: 'Created using Mangopay Ruby SDK'
  }

createUsBankAccount(myUser[:Id], myUsBankAccount)  

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.mangopay.MangoPayApi;
import com.mangopay.core.Address;
import com.mangopay.core.enumerations.BankAccountType;
import com.mangopay.core.enumerations.CountryIso;
import com.mangopay.core.enumerations.DepositAccountType;
import com.mangopay.entities.BankAccount;
import com.mangopay.entities.subentities.BankAccountDetailsUS;

public class CreateUSBankAccount {
    
    public static void main(String[] args) throws Exception {
        MangoPayApi mangopay = new MangoPayApi();
        mangopay.getConfig().setClientId("your-client-id");
        mangopay.getConfig().setClientPassword("your-api-key");

        var userId = "user_m_01J29D5XMKKNPX72AR5HRV804X";

        BankAccountDetailsUS bankAccountDetails = new BankAccountDetailsUS();
        bankAccountDetails.setAba("071000288");
        bankAccountDetails.setAccountNumber("11696419");
        bankAccountDetails.setDepositAccountType(DepositAccountType.CHECKING);

        Address address = new Address();
        address.setAddressLine1("Rue des plantes");
        address.setAddressLine2("The Oasis");
        address.setCity("FR");
        address.setRegion("Ile de France");
        address.setPostalCode("75001");
        address.setCountry(CountryIso.FR);
        
        BankAccount bankAccount = new BankAccount();
        bankAccount.setOwnerName("John Doe");
        bankAccount.setDetails(bankAccountDetails);
        bankAccount.setOwnerAddress(address);
        bankAccount.setType(BankAccountType.US);
        bankAccount.setTag("Created using the Mangopay Java SDK");

        BankAccount createBankAccount = mangopay.getUserApi().createBankAccount(userId, bankAccount);

        Gson prettyPrint = new GsonBuilder().setPrettyPrinting().create();
        String prettyJson = prettyPrint.toJson(createBankAccount);

        System.out.println(prettyJson);
    }
}

from pprint import pprint
import mangopay

mangopay.client_id='your-client-id'
mangopay.apikey='your-api-key'

from mangopay.api import APIRequest
handler = APIRequest(sandbox=True)

from mangopay.resources import NaturalUser, BankAccount
from mangopay.utils import Address

natural_user = NaturalUser.get('213753890')

us_bank_account = BankAccount(
    user_id = natural_user.id,
    owner_name = f'{natural_user.first_name} {natural_user.last_name}',
    owner_address = Address(
        address_line_1 = natural_user.address.address_line_1,
        address_line_2 = natural_user.address.address_line_2,
        city = natural_user.address.city,
        region = natural_user.address.region,
        postal_code = natural_user.address.postal_code,
        country = natural_user.address.country,
    ),
    account_number = '11696419',
    aba = '071000288',
    type = 'US',
    deposit_account_type = 'CHECKING',
    tag = 'Created using the Mangopay Python SDK',
)

create_us_bank_account = us_bank_account.save()

pprint(create_us_bank_account)  

using MangoPay.SDK;
using MangoPay.SDK.Entities.GET;
using MangoPay.SDK.Entities.POST;
using MangoPay.SDK.Core.Enumerations;
using Newtonsoft.Json;

class Program
{
    static async Task Main(string[] args)
    {
        MangoPayApi api = new MangoPayApi();

        api.Config.ClientId = "your-client-id";
        api.Config.ClientPassword = "your-api-key";

        var user = await api.Users.GetNaturalAsync("user_m_01J2TZ261WZNDM0ZDRWGDYA4GN");
        var accountNumber = "11696419";
        var aba = "071000288";

        var UsBankAccount = new BankAccountUsPostDTO(
            user.FirstName + " " + user.LastName, 
            user.Address,
            accountNumber,
            aba
        ) {
            DepositAccountType = DepositAccountType.CHECKING,
            Tag = "Created using the Mangopay .NET SDK"
        };

        BankAccountDTO createUsBankAccount = await api.Users.CreateBankAccountUsAsync(user.Id, UsBankAccount);

        string prettyPrint = JsonConvert.SerializeObject(createUsBankAccount, Formatting.Indented);
        Console.WriteLine(prettyPrint);
	}
}

200

{
    "OwnerAddress": {
        "AddressLine1": "The Oasis",
        "AddressLine2": "Rue des plantes",
        "City": "Paris",
        "Region": "Ile de France",
        "PostalCode": "75009",
        "Country": "FR"
    },
    "AccountNumber": "11696419",
    "ABA": "071000288",
    "DepositAccountType": "CHECKING",
    "UserId": "142036728",
    "OwnerName": "John Doe",
    "Type": "US",
    "Id": "150294885",
    "Tag": null,
    "CreationDate": 1661864955,
    "Active": true
}

Caution - Payouts refused to Bank Accounts created after April 30, 2026

Bank Account objects created after April 30, 2026, will not be usable for payouts. External accounts must be registered using the Recipient endpoints and authenticated using SCA.

Payouts to Bank Accounts created after May 1, 2026, will fail with the ResultCode 121018. To resolve this, register the external account using POST Create a Recipient and retry the payout.

Note – Replaced by Recipients feature

The Bank Account object and endpoints have been replaced by the Recipients feature, which all platforms should integrate instead.

Legacy active Bank Accounts (Active is true) have been migrated to the new feature and their data is retrievable via the GET View a Recipient endpoint using the same BankAccountId. Read more about legacy bank account migration.

Path parameters

UserId · string · required

The unique identifier of the User (natural or legal) who owns the bank account.

Body parameters

OwnerAddress · object · required

Information about the address of residence of the bank account owner.

Show properties

AddressLine1 · string · required

Max. length: 255 characters

The first line of the address.

AddressLine2 · string

Max. length: 255 characters

The second line of the address.

City · string · required

Max. length: 255 characters

The city of the address.

Region · string

Max. length: 255 characters

The region of the address. This field is optional except if the Country is US, CA, or MX.

PostalCode · string

Max. length: 255 characters

The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.

Country · string · required

The country of the address.

AccountNumber · string · required

Format: Digits only

The unique set of digits of the bank account.

ABA · string · required

Length: 9 characters

The American Banking Association (ABA) routing number for US-type bank accounts.

DepositAccountType · string

Allowed values: CHECKING, SAVINGS

The deposit type for US-type bank accounts.

OwnerName · string · required

Max. length: 255 characters

The full name of the owner of the bank account. (Format: FirstName LastName)

Tag · string

Max. length: 255 characters

Custom data that you can add to this object.
For bank accounts, you can use this parameter to identify the bank account by currency or usage (personal or professional for instance).

Responses

200

OwnerAddress · object

Information about the address of residence of the bank account owner.

Show properties

AddressLine1 · string

Max. length: 255 characters

The first line of the address.

AddressLine2 · string

Max. length: 255 characters

The second line of the address.

City · string

Max. length: 255 characters

The city of the address.

Region · string

Max. length: 255 characters

The region of the address. This field is optional except if the Country is US, CA, or MX.

PostalCode · string

Max. length: 255 characters

The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.

Country · string

Format: Two-letter country code (ISO 3166-1 alpha-2 format)

The country of the address.

AccountNumber · string

Format: Digits only

The unique set of digits of the bank account.

ABA · string

Length: 9 characters

The American Banking Association (ABA) routing number for US-type bank accounts.

DepositAccountType · string

Returned values: CHECKING, SAVINGS

The deposit type for US-type bank accounts.

UserId · string

The unique identifier of the User (natural or legal) who owns the bank account.

OwnerName · string

Max. length: 255 characters

The full name of the owner of the bank account. (Format: FirstName LastName)

Type · string

Returned values: IBAN, US, CA, GB, OTHER

The type of the bank account, indicating the country where the real-life account is registered
The values are:

• IBAN – For accounts registered in countries that use IBAN 
• US – For accounts registered in the United States 
• CA – For accounts registered in Canada
• GB – For accounts registered in the United Kingdom
• OTHER – For accounts registered in countries that do not use IBAN (and are not US, CA, GB)

Id · string

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

Tag · string

Max. length: 255 characters

Custom data that you can add to this object.
For bank accounts, you can use this parameter to identify the bank account by currency or usage (personal or professional for instance).

CreationDate · Unix timestamp

The date and time at which the object was created.

Active · boolean

Whether or not the Bank Account is active. Mangopay automatically sets this parameter to false if the bank account is closed or does not exist anymore.

200

{
    "OwnerAddress": {
        "AddressLine1": "The Oasis",
        "AddressLine2": "Rue des plantes",
        "City": "Paris",
        "Region": "Ile de France",
        "PostalCode": "75009",
        "Country": "FR"
    },
    "AccountNumber": "11696419",
    "ABA": "071000288",
    "DepositAccountType": "CHECKING",
    "UserId": "142036728",
    "OwnerName": "John Doe",
    "Type": "US",
    "Id": "150294885",
    "Tag": null,
    "CreationDate": 1661864955,
    "Active": true
}

REST

{
    "OwnerAddress": {
        "AddressLine1": "The Oasis",
        "AddressLine2": "Rue des plantes",
        "City": "Paris",
        "Region": "Ile de France",
        "PostalCode": "75009",
        "Country": "FR"
    },
    "AccountNumber": "11696419",
    "ABA": "071000288",
    "DepositAccountType": "CHECKING",
    "OwnerName": "John Doe",
    "Tag": "custom meta",
}
  

<?php 

require_once 'vendor/autoload.php';

use MangoPay\MangoPayApi;
use MangoPay\Libraries\ResponseException as MGPResponseException;
use MangoPay\Libraries\Exception as MGPException;

$api = new MangoPayApi();

$api->Config->ClientId = 'your-client-id';
$api->Config->ClientPassword = 'your-api-key';
$api->Config->TemporaryFolder = 'tmp/';

try {
    $userId = '146476890';

    $bankAccount = new \MangoPay\BankAccount();

    $address = new \MangoPay\Address();
    $address->AddressLine1 = 'Address line 1';
    $address->AddressLine2 = 'Address line 2';
    $address->City = 'Paris';
    $address->Country = 'FR';
    $address->PostalCode = '75000';
    $address->Region = 'Region';

    $details = new \MangoPay\BankAccountDetailsUS();
    $details->AccountNumber = '11696419';
    $details->ABA = '071000288';
    $details->DepositAcountType = 'CHECKING';

    $bankAccount->OwnerAddress = $address;
    $bankAccount->OwnerName = 'Alex Smith';
    $bankAccount->Tag = 'Created using Mangopay PHP SDK';
    $bankAccount->Type = 'IBAN';
    $bankAccount->Details = $details;

    $response = $api->Users->CreateBankAccount($userId, $bankAccount);

    print_r($response);
} catch(MGPResponseException $e) {
    print_r($e);
} catch(MGPException $e) {
    print_r($e);
}  

const mangopayInstance = require('mangopay4-nodejs-sdk')
const mangopay = new mangopayInstance({
  clientId: 'your-client-id',
  clientApiKey: 'your-api-key',
})

let user = {
  Id: '165863393',
  Address: {
    AddressLine1: 'Edgewood Road',
    AddressLine2: null,
    City: 'Little Rock',
    Region: 'IDF',
    PostalCode: '75000',
    Country: 'FR',
  },
  FirstName: 'John',
  LastName: 'Doe',
}

let bankAccount = {
  Type: 'US',
  OwnerName: user.FirstName + '' + user.LastName,
  OwnerAddress: user.Address,
  AccountNumber: '11696419',
  ABA: '071000288',
  DepositAccountType: 'CHECKING',
  Tag: 'Created using Mangopay NodeJS SDK',
}

const createBankAccount = async (userId, bankAccount) => {
  return await mangopay.Users.createBankAccount(userId, bankAccount)
    .then((response) => {
      console.info(response)
      return response
    })
    .catch((err) => {
      console.log(err)
      return false
    })
}

createBankAccount(user.Id, bankAccount)  

require 'mangopay'

MangoPay.configure do |client|
    client.preproduction = true
    client.client_id = 'your-client-id'
    client.client_apiKey = 'your-api-key'
    client.log_file = File.join(Dir.pwd, 'mangopay.log')
end

def createUsBankAccount(userId, usBankAccountObject)
    begin
        response = MangoPay::BankAccount.create(userId, usBankAccountObject)
        puts response
        return response
    rescue MangoPay::ResponseError => error
        puts "Failed to create bank account: #{error.message}"
        puts "Error details: #{error.details}"
        return false
    end
end

myUser = {
    Id: '165863393'
}

myUsBankAccount = {
    Type: 'US',
    OwnerName: 'Alex Smith',
    OwnerAddress: {
        AddressLine1: 'Edgewood Road',
        AddressLine2: 'Address line 2',
        City: 'Little Rock',
        Region: 'IDF',
        PostalCode: '75000',
        Country: 'FR'
    },
    AccountNumber: '11696419',
    ABA: '071000288',
    DepositAccountType: 'CHECKING',
    Tag: 'Created using Mangopay Ruby SDK'
  }

createUsBankAccount(myUser[:Id], myUsBankAccount)  

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.mangopay.MangoPayApi;
import com.mangopay.core.Address;
import com.mangopay.core.enumerations.BankAccountType;
import com.mangopay.core.enumerations.CountryIso;
import com.mangopay.core.enumerations.DepositAccountType;
import com.mangopay.entities.BankAccount;
import com.mangopay.entities.subentities.BankAccountDetailsUS;

public class CreateUSBankAccount {
    
    public static void main(String[] args) throws Exception {
        MangoPayApi mangopay = new MangoPayApi();
        mangopay.getConfig().setClientId("your-client-id");
        mangopay.getConfig().setClientPassword("your-api-key");

        var userId = "user_m_01J29D5XMKKNPX72AR5HRV804X";

        BankAccountDetailsUS bankAccountDetails = new BankAccountDetailsUS();
        bankAccountDetails.setAba("071000288");
        bankAccountDetails.setAccountNumber("11696419");
        bankAccountDetails.setDepositAccountType(DepositAccountType.CHECKING);

        Address address = new Address();
        address.setAddressLine1("Rue des plantes");
        address.setAddressLine2("The Oasis");
        address.setCity("FR");
        address.setRegion("Ile de France");
        address.setPostalCode("75001");
        address.setCountry(CountryIso.FR);
        
        BankAccount bankAccount = new BankAccount();
        bankAccount.setOwnerName("John Doe");
        bankAccount.setDetails(bankAccountDetails);
        bankAccount.setOwnerAddress(address);
        bankAccount.setType(BankAccountType.US);
        bankAccount.setTag("Created using the Mangopay Java SDK");

        BankAccount createBankAccount = mangopay.getUserApi().createBankAccount(userId, bankAccount);

        Gson prettyPrint = new GsonBuilder().setPrettyPrinting().create();
        String prettyJson = prettyPrint.toJson(createBankAccount);

        System.out.println(prettyJson);
    }
}

from pprint import pprint
import mangopay

mangopay.client_id='your-client-id'
mangopay.apikey='your-api-key'

from mangopay.api import APIRequest
handler = APIRequest(sandbox=True)

from mangopay.resources import NaturalUser, BankAccount
from mangopay.utils import Address

natural_user = NaturalUser.get('213753890')

us_bank_account = BankAccount(
    user_id = natural_user.id,
    owner_name = f'{natural_user.first_name} {natural_user.last_name}',
    owner_address = Address(
        address_line_1 = natural_user.address.address_line_1,
        address_line_2 = natural_user.address.address_line_2,
        city = natural_user.address.city,
        region = natural_user.address.region,
        postal_code = natural_user.address.postal_code,
        country = natural_user.address.country,
    ),
    account_number = '11696419',
    aba = '071000288',
    type = 'US',
    deposit_account_type = 'CHECKING',
    tag = 'Created using the Mangopay Python SDK',
)

create_us_bank_account = us_bank_account.save()

pprint(create_us_bank_account)  

using MangoPay.SDK;
using MangoPay.SDK.Entities.GET;
using MangoPay.SDK.Entities.POST;
using MangoPay.SDK.Core.Enumerations;
using Newtonsoft.Json;

class Program
{
    static async Task Main(string[] args)
    {
        MangoPayApi api = new MangoPayApi();

        api.Config.ClientId = "your-client-id";
        api.Config.ClientPassword = "your-api-key";

        var user = await api.Users.GetNaturalAsync("user_m_01J2TZ261WZNDM0ZDRWGDYA4GN");
        var accountNumber = "11696419";
        var aba = "071000288";

        var UsBankAccount = new BankAccountUsPostDTO(
            user.FirstName + " " + user.LastName, 
            user.Address,
            accountNumber,
            aba
        ) {
            DepositAccountType = DepositAccountType.CHECKING,
            Tag = "Created using the Mangopay .NET SDK"
        };

        BankAccountDTO createUsBankAccount = await api.Users.CreateBankAccountUsAsync(user.Id, UsBankAccount);

        string prettyPrint = JsonConvert.SerializeObject(createUsBankAccount, Formatting.Indented);
        Console.WriteLine(prettyPrint);
	}
}