Account

Add bank account

POST
/account.external.bank.add

Request Body

application/jsonRequired
bodyRequiredAUD_NPP | USD_ACH | USD_WIRE | USD_SWIFT | SGD_SWIFT | HKD_SWIFT | HKD_FPS | HKD_CHATS | CNY_SWIFT | MXN_SPEI | MXN_SWIFT | COP_SWIFT | BRL_PIX | BRL_SWIFT | GBP_FPS | EUR_SEPA | EUR_SWIFT | INR_IMPS | INR_SWIFT | AED_SWIFT | IDR_SWIFT

Response Body

Successful response

TypeScript Definitions

Use the response body type in TypeScript.

dataRequiredBANK_ACCOUNT

Error response

TypeScript Definitions

Use the response body type in TypeScript.

errorRequiredobject
curl -X POST "/v1/account.external.bank.add" \
  -H "Content-Type: application/json" \
  -d '{
    "account_name": "string",
    "account_number": "string",
    "national_clearing_code": "string",
    "type": "AUD_NPP",
    "nickname": "string",
    "bank": "string",
    "is_hidden": true,
    "has_transactions": true,
    "declared_at": "string",
    "recipient_id": "string"
  }'
const body = JSON.stringify({
  "account_name": "string",
  "account_number": "string",
  "national_clearing_code": "string",
  "type": "AUD_NPP",
  "nickname": "string",
  "bank": "string",
  "is_hidden": true,
  "has_transactions": true,
  "declared_at": "string",
  "recipient_id": "string"
})

fetch("/v1/account.external.bank.add", {
  body
})
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
  "strings"
)

func main() {
  url := "/v1/account.external.bank.add"
  body := strings.NewReader(`{
    "account_name": "string",
    "account_number": "string",
    "national_clearing_code": "string",
    "type": "AUD_NPP",
    "nickname": "string",
    "bank": "string",
    "is_hidden": true,
    "has_transactions": true,
    "declared_at": "string",
    "recipient_id": "string"
  }`)
  req, _ := http.NewRequest("POST", url, body)
  req.Header.Add("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}
import requests

url = "/v1/account.external.bank.add"
body = {
  "account_name": "string",
  "account_number": "string",
  "national_clearing_code": "string",
  "type": "AUD_NPP",
  "nickname": "string",
  "bank": "string",
  "is_hidden": true,
  "has_transactions": true,
  "declared_at": "string",
  "recipient_id": "string"
}
response = requests.request("POST", url, json = body, headers = {
  "Content-Type": "application/json"
})

print(response.text)
{
  "data": {
    "id": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "type": "BANK_ACCOUNT",
    "is_active": true,
    "metadata": {
      "account_name": "string",
      "account_number": "string",
      "national_clearing_code": "string",
      "type": "AUD_NPP",
      "nickname": "string",
      "bank": "string",
      "is_hidden": true,
      "has_transactions": true
    },
    "account_id": "string",
    "user_id": "string"
  }
}
{
  "error": {
    "code": "PARSE_ERROR",
    "message": "string"
  }
}