Skip to content
Gowd Platform

Get account details

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

Retrieve account details by accountId.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
accountId
required
string format: uuid

Identifier of the account

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The resource was returned successfully

object
id
required

Account identifier.

string
Example
f288ae0d-47fd-4207-aee4-0a384888bd96
status
required

Account status.

string
Example
ACTIVE
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
Example
BRA
holderType
required

Holder type.

string
Allowed values: INDIVIDUAL ORGANIZATION
Example
ORGANIZATION
fullName
required

Full name or company name.

string
Example
Company LTDA
email
required

Email.

string
Example
contato@company.com
phone
required

Phone number.

string
Example
+5511912345678
birthdate
required

Birthdate or foundation date

string
Example
1990-01-01
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
Example
[
  {
    "country": "BRA",
    "fullName": "Jane Representative",
    "email": "jane.rep@mail.com",
    "phone": "+5511911111111",
    "birthdate": "1985-05-10",
    "documentNumber": "12345678901"
  }
]
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
Example
{
  "ispb": "12345678",
  "branchNumber": "0001",
  "accountNumber": "123456",
  "createdAt": "2024-01-01T00:00:00Z"
}

400

Section titled “400 ”
object
error
string
Example
INVALID_REQUEST
message
string
details
Array<object>
object
field
string
issue
string
description
string
Example
[
  {
    "field": "field_name",
    "issue": "INVALID",
    "description": "Field is invalid"
  }
]

401

Section titled “401 ”

Unauthorized Request

object
error
string
Example
UNAUTHORIZED
message
string
Example
Unauthorized Request
details
Array<object>
object
field
string
issue
string
description
string
Example
[]

403

Section titled “403 ”
object
error
string
Example
FORBIDDEN_ERROR
message
string
details
Array<object>
object
field
string
issue
string
description
string
Example
[]

500

Section titled “500 ”
object
error
string
Example
INTERNAL_ERROR
message
string
details
Array<object>
object
field
string
issue
string
description
string
Example
[]