Get account details

GET

/order/v1/banking/accounts/{accountId}

• Sandbox

Retrieve account details by accountId.

Authorizations

• Bearer

Parameters

Path Parameters

accountId

required

string format: uuid

Identifier of the account

Responses

200

The resource was returned successfully

object

id

required

Account identifier.

string

status

required

Account status.

string

country

required

Country in ISO-3.

string

Allowed values: AFG ALB DZA ASM AND AGO AIA ATA ATG ARG ARM ABW AUS AUT AZE BHS BHR BGD BRB BLR BEL BLZ BEN BMU BTN BOL BES BIH BWA BVT BRA IOT BRN BGR BFA BDI CPV KHM CMR CAN CYM CAF TCD CHL CHN CXR CCK COL COM COG COD COK CRI HRV CUB CUW CYP CZE DNK DJI DMA DOM ECU EGY SLV GNQ ERI EST ETH FLK FRO FJI FIN FRA GUF PYF ATF GAB GMB GEO DEU GHA GIB GRC GRL GRD GLP GUM GTM GGY GIN GNB GUY HTI HMD VAT HND HKG HUN ISL IND IDN IRN IRQ IRL IMN ISR ITA JAM JPN JEY JOR KAZ KEN KIR PRK KOR KWT KGZ LAO LVA LBN LSO LBR LBY LIE LTU LUX MAC MDG MWI MYS MDV MLI MLT MHL MTQ MRT MUS MYT MEX FSM MDA MCO MNG MNE MSR MAR MOZ MMR NAM NRU NPL NLD NCL NZL NIC NER NGA NIU NFK MNP NOR OMN PAK PLW PSE PAN PNG PRY PER PHL PCN POL PRT PRI QAT REU ROU RUS RWA BLM SHN KNA LCA MAF SPM VCT WSM SMR STP SAU SEN SRB SYC SLE SGP SXM SVK SVN SLB SOM ZAF SGS SSD ESP LKA SDN SUR SJM SWE CHE SYR TWN TJK TZA THA TLS TGO TKL TON TTO TUN TUR TKM TCA TUV UGA UKR ARE GBR USA UMI URY UZB VUT VEN VNM VGB VIR WLF ESH YEM ZMB ZWE

holderType

required

Holder type.

string

Allowed values: INDIVIDUAL ORGANIZATION

fullName

required

Full name or company name.

string

email

required

Email.

string

phone

required

Phone number.

string

birthdate

required

Birthdate or foundation date

string

document

required

Document data.

object

type

required

Document type.

string

Allowed values: CPF CNPJ RUC NATIONAL_ID PASSPORT FOREIGNER_ID CHANCERY_ID CEDULA_DE_CIUDADANIA CEDULA_DE_EXTRANJERIA NUMERO_DE_IDENTIFICACION_TRIBUTARIA OTHERS DNI CURP RFC

number

required

Document number.

string

address

required

Address data.

object

street

required

Street and number.

string

neighborhood

required

Neighborhood.

string

city

required

City.

string

state

required

State (UF).

string

zipCode

required

ZIP code.

string

complement

Address complement.

string

representatives

required

Representatives linked to the holder.

Array<object>

object

country

required

Country in ISO-3.

string

Allowed values: AFG ALB DZA ASM AND AGO AIA ATA ATG ARG ARM ABW AUS AUT AZE BHS BHR BGD BRB BLR BEL BLZ BEN BMU BTN BOL BES BIH BWA BVT BRA IOT BRN BGR BFA BDI CPV KHM CMR CAN CYM CAF TCD CHL CHN CXR CCK COL COM COG COD COK CRI HRV CUB CUW CYP CZE DNK DJI DMA DOM ECU EGY SLV GNQ ERI EST ETH FLK FRO FJI FIN FRA GUF PYF ATF GAB GMB GEO DEU GHA GIB GRC GRL GRD GLP GUM GTM GGY GIN GNB GUY HTI HMD VAT HND HKG HUN ISL IND IDN IRN IRQ IRL IMN ISR ITA JAM JPN JEY JOR KAZ KEN KIR PRK KOR KWT KGZ LAO LVA LBN LSO LBR LBY LIE LTU LUX MAC MDG MWI MYS MDV MLI MLT MHL MTQ MRT MUS MYT MEX FSM MDA MCO MNG MNE MSR MAR MOZ MMR NAM NRU NPL NLD NCL NZL NIC NER NGA NIU NFK MNP NOR OMN PAK PLW PSE PAN PNG PRY PER PHL PCN POL PRT PRI QAT REU ROU RUS RWA BLM SHN KNA LCA MAF SPM VCT WSM SMR STP SAU SEN SRB SYC SLE SGP SXM SVK SVN SLB SOM ZAF SGS SSD ESP LKA SDN SUR SJM SWE CHE SYR TWN TJK TZA THA TLS TGO TKL TON TTO TUN TUR TKM TCA TUV UGA UKR ARE GBR USA UMI URY UZB VUT VEN VNM VGB VIR WLF ESH YEM ZMB ZWE

fullName

required

Full name.

string

email

required

Email.

string

phone

required

Phone.

string

birthdate

Birthdate (YYYY-MM-DD).

string

documentNumber

required

Document number (CPF).

string

bankAccountData

required

Bank account data.

object

ispb

ISPB code.

string

branchNumber

required

Branch number.

string

accountNumber

required

Account number.

string

createdAt

Account creation date.

string

400

object

error

string

message

string

details

Array<object>

object

field

string

issue

string

description

string

401

Unauthorized Request

object

error

string

message

string

details

Array<object>

object

field

string

issue

string

description

string

403

object

error

string

message

string

details

Array<object>

object

field

string

issue

string

description

string

500

object

error

string

message

string

details

Array<object>

object

field

string

issue

string

description

string