POST
/
externalAccounts
Create a new external bank account
curl --request POST \
  --url https://api.paygentic.io/v0/externalAccounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "organizationId": "<string>",
  "countryCode": "<string>",
  "bankName": "<string>",
  "currency": "<string>",
  "accountNumber": "<string>",
  "routingNumber": "<string>",
  "accountHolderName": "<string>",
  "accountHolderType": "individual",
  "metadata": {}
}'
{
  "id": "<string>",
  "object": "externalBankAccount",
  "organizationId": "<string>",
  "countryCode": "<string>",
  "bankName": "<string>",
  "currency": "<string>",
  "last4": "<string>",
  "accountHolderName": "<string>",
  "accountHolderType": "individual",
  "status": "new",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

API key authentication

Body

application/json
organizationId
string
required

Unique identifier for an organization

countryCode
string
required

ISO 3166-1 alpha-2 country code

bankName
string
required

Name of the bank

currency
string
required

Currency code for the account

accountNumber
string
required

Bank account number

routingNumber
string
required

Bank routing number

accountHolderName
string
required

Name of the account holder

accountHolderType
enum<string>
required

Type of account holder

Available options:
individual,
company
metadata
object

Additional metadata for the account

Response

External bank account created successfully

id
string
required

Unique identifier for the external bank account

object
enum<string>
required

Object type identifier

Available options:
externalBankAccount
organizationId
string
required

Unique identifier for an organization

countryCode
string
required

ISO 3166-1 alpha-2 country code

bankName
string
required

Name of the bank

currency
string
required

Currency code for the account

last4
string
required

Last 4 digits of the account number

accountHolderName
string
required

Name of the account holder

accountHolderType
enum<string>
required

Type of account holder

Available options:
individual,
company
status
enum<string>
required

Status of the external bank account

Available options:
new,
verified,
errored
createdAt
string<date-time>
required

Timestamp when the account was created

updatedAt
string<date-time>
required

Timestamp when the account was last updated

metadata
object

Additional metadata for the account