Skip to content
Gowd Platform

Account statements

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

Retrieve the account statement for the informed period.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

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

Identifier of the account

Query Parameters

Section titled “Query Parameters ”
startDate
string

Start date of the statement period in ISO 8601 format

Example
2025-10-01T00:00:00Z
endDate
string

End date of the statement period in ISO 8601 format

Example
2025-10-31T23:59:59Z
currency
required
string

Currency used for the statement (ISO 4217)

Example
BRL
limit
number
default: 500

Maximum number of records returned

Example
400
sort
string
default: desc
Allowed values: asc desc

Sorting direction for the records

Example
desc
operation
string
Allowed values: in out

Filters records by transaction direction (in or out)

Example
in
endToEndId
string

Filters records by end-to-end id. Matches the order end-to-end id and the refund end-to-end id

Example
E12345678920260710120000abcd
cursor
string

Cursor to continue pagination (use the value returned in nextCursor)

Example
2025-10-03T13:44:32.106Z
mergeBatch
boolean

When true, merges all transactions belonging to the same batch into a single entry, summing their amounts

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The resource was returned successfully

object
params
required

Parameters used to generate the statement

object
startDate

Start date of the statement period in ISO 8601 format

string
Example
2025-10-01T00:00:00Z
endDate

End date of the statement period in ISO 8601 format

string
Example
2025-10-31T23:59:59Z
currency
required

Currency used for the statement (ISO 4217)

string
Example
BRL
limit
required

Maximum number of records returned in the statement

number
Example
400
sort
required

Order of the records (asc or desc)

string
Example
desc
operation

Filters records by transaction direction (in or out)

string
Allowed values: in out
Example
in
endToEndId

Filters records by end-to-end id

string
Example
E12345678920260710120000abcd
nextCursor
required

Cursor to retrieve the next page of results

string
nullable
Example
2025-10-03T13:44:32.106Z
hasNext
required

Indicates if more records are available for pagination

boolean
Example
true
data
required

Statement items returned for the requested period

Array<object>
object
orderId
required

Identifier of the order associated with the transaction

string
Example
8b371695-3277-475a-b1e9-5e6253d7a41c
externalCode
required

External reference code of the transaction

string
Example
b917e9da-03b3-4e24-8596-e4fc927ca5b8
transactionId
required

Unique identifier of the transaction

string
Example
a4cf980e-f66d-4321-b0f2-95c7eecca7ce
transactionDate
required

Date and time of the transaction

string
Example
2025-10-03T13:44:32.106Z
endToEndId
required

End-to-end identifier of the transaction

string
Example
E69467793202510031344Je8IkFT5JQS
refundEndToEndId
required

End-to-end identifier of the refund transaction

string
Example
D69467793202510031344Je8IkFT5JQS
operationType
required

Operation type of the transaction.

string
Allowed values: PAYIN PAYOUT PAYIN_FEE PAYOUT_FEE PAYIN_REFUND PAYIN_REFUND_REVERSE PAYOUT_REFUND PAYIN_REFUND_FEE PAYOUT_REFUND_FEE
Example
PAYIN
amount
required

Transaction amount; negative values indicate debits

string
Example
-1.00
balance
required

Account balance after the transaction

string
Example
50000
counterparty
required

Counterparty information when available

object
name
required

Counterparty name

string
Example
Maria Oliveira
document
required

Counterparty document information

object
type
required

Document type of the counterparty

string
Example
CPF
number
required

Document number of the counterparty

string
Example
98765432100
ispb
required

ISPB of the counterparty financial institution

string
Example
12345678
bankName
required

Name of the counterparty financial institution

string
Example
Banco XPTO S.A.
branch
required

Branch number of the counterparty

string
Example
1234
account
required

Account number of the counterparty

string
Example
567890-1
accountType
required

Type of the counterparty account

string
Example
CHECKING_ACCOUNT
paymentMethod
required

Payment method used for the transaction

string
Allowed values: PIX TED TETHER
Example
PIX
description
required

Description of the transaction

string
Example
Pix transfer to John Doe
refundId
required

The identifier of the refund transaction

string
Example
b917e9da-03b3-4e24-8596-e4fc927ca5b8
batch

Batch information when this transaction belongs to a batch

object
id
required

Id of the batch

string
Example
5160c73e-8b9b-4f1f-8c64-0edcbb97c335
transactionsCount
required

Total number of child transactions in the batch

number
Example
3
paidCount
required

Number of child transactions already paid

number
Example
2
failedCount
required

Number of child transactions that failed

number
Example
1
pendingCount
required

Number of child transactions still pending

number
0
paidAmount
required

Amount already paid across all child transactions

string
Example
30000.00
pendingAmount
required

Amount still pending across all child transactions

string
Example
15000.00
transactions
required

Child transactions the batch was split into

Array<object>
object
id
required

Id of this child transaction

string
Example
a4cf980e-f66d-4321-b0f2-95c7eecca7ce
idempotencyKey
required

Idempotency key of this child transaction - the first child reuses the batch idempotencyKey verbatim, later ones suffix it

string
Example
bf8b0b1f-f444-40c5-b657-d236ee03e6ba-01
sequence
required

Ordering position of this child transaction within the batch

number
Example
1
amount
required

Amount of this child transaction

string
Example
15000.00
status
required

Status of this child transaction

string
Allowed values: INITIAL PENDING PAID EXPIRED ANALYSIS REFUNDED PARTIAL_REFUNDED PARTIALLY_PAID CANCELED ERROR
Example
PAID
endToEndId

End-to-end id of this child transaction

string
Example
E69467793202607101200Je8IkFT5JQS
paidAt

Date this child transaction was paid

string
Example
2026-07-10T12:01:03.000Z
errorMessage

Error message when this child transaction failed

string
Example
An unexpected error occurred

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
[]

500

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