Skip to main content
POST
Create counterparty

Authorizations

Authorization
string
header
required

Bearer token for authentication with Augustus Banking API

Headers

Idempotency-Key
string
required

Idempotency key for safe retries. Reusing a key with an identical request body returns the cached response. Reusing a key with a different body returns 409.

Body

application/json

Counterparty parameters

financial_address
ABA · object
required

Financial address of the counterparty.

Example:
account_holder_id
string

ID of the account holder whose counterparties to act on. Omit for your own counterparties.

Pattern: ^[0-9a-fA-F]{24}$
Example:

"68e0a1b2c3d4e5f60718293a"

name
string

Name of the counterparty.

Example:

"Acme Sandbox Ltd."

physical_address
object

Physical address of the counterparty.

date_of_birth
string<date>

Date of birth in YYYY-MM-DD format.

Example:

"1990-01-15"

phone
string

Phone number of the counterparty. Stored for operational contact only; it is not sent with payments.

Required string length: 1 - 32
Pattern: ^\+?[ ().-]*[0-9][0-9 ().-]*$
Example:

"+55 11 91234 5678"

email
string<email>

Email address of the counterparty. Stored for operational contact only; it is not sent with payments.

Maximum string length: 254
Pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
Example:

"finance@example.com"

National tax or identity number of the counterparty, as issued in its country: CPF or CNPJ in Brazil, Cédula or NIT in Colombia, CUIL or CUIT in Argentina, DNI or RUC in Peru, RUT in Chile. Free text, up to 127 characters.

Required string length: 1 - 127
Example:

"12.345.678/0001-95"

entity_type
enum<string>
default:business

Classification of the counterparty. Defaults to business when omitted. Set individual for a personal bank account. US ACH payments to individual counterparties are sent as consumer payments.

Available options:
business,
individual,
non_profit,
sole_proprietor
is_self_owned
boolean
default:false

Whether the counterparty is self-owned. false if the counterparty is not owned by you, true if it is. Must be true for a crypto wallet.

metadata
object | null

Set of up to 50 key-value string pairs you can attach to store structured information, such as correlating this resource with an object in your own system. Keys may be up to 40 characters and values up to 500 characters.

Example:

Response

200 - application/json

The created counterparty

status
enum<string>
required

Counterparty lifecycle status. Blocking is separate.

Available options:
pending,
active,
rejected
Example:

"active"

id
string<uuid>
required

Unique identifier of the counterparty.

type
enum<string>
required

Resource type discriminator.

Available options:
counterparty
account_holder_id
string | null
required

ID of the account holder the counterparty belongs to, or null for your own counterparties.

Pattern: ^[0-9a-fA-F]{24}$
Example:

"68e0a1b2c3d4e5f60718293a"

name
string | null
required

Name of the counterparty, or null if not recorded.

Example:

"Acme Sandbox Ltd."

entity_type
enum<string>
required

Classification of the counterparty.

Available options:
business,
individual,
non_profit,
sole_proprietor
Example:

"business"

physical_address
object | null
required

Physical address of the counterparty, or null if not recorded.

financial_address
ABA · object
required

Financial address of the counterparty.

Example:
date_of_birth
string<date> | null
required

Date of birth in YYYY-MM-DD format, or null if not recorded.

Example:

"1990-01-15"

phone
string | null
required

Phone number of the counterparty, or null if not recorded.

Example:

"+55 11 91234 5678"

email
string | null
required

Email address of the counterparty, or null if not recorded.

Example:

"finance@example.com"

National tax or identity number of the counterparty, or null if not recorded.

Example:

"12.345.678/0001-95"

is_self_owned
boolean
required

Whether the counterparty is self-owned. false if the counterparty is not owned by you, true if it is.

Example:

false

blocked
boolean
required

Whether payments to or from this counterparty are currently blocked.

Example:

false

metadata
object
required

Set of up to 50 key-value string pairs you can attach to store structured information, such as correlating this resource with an object in your own system. Keys may be up to 40 characters and values up to 500 characters.

Example: