Skip to content
Gowd Platform

List batches - V1

GET
/order/v1/batch

List the batches created for your company, cursor paginated.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
limit
number
default: 20 >= 1 <= 5000

Maximum number of items returned in the current page (default 20, max 5000)

sort
string
default: desc
Allowed values: asc desc

Direction of the sort (default: desc)

cursor
string

Cursor used for pagination. Omit this field in the first request. For subsequent requests, set it to the nextCursor value returned in the previous response.

companyIds
Array<Array<a>>

Filter by multiple company ids

Example
[
  "550e8400-e29b-41d4-a716-446655440000",
  "660e8400-e29b-41d4-a716-446655440000"
]
status
string
Allowed values: INITIAL PENDING PAID PARTIALLY_PAID ERROR

Filter by batch status

Example
PAID
receiverDocumentNumber
string

Filter by the receiver document number

Example
12345678900
endToEndId
string

Filter by end-to-end id. Matches any child transaction of the batch, not just the first one.

Example
E12345678920260710120000abcd
startDate
string

Filter by creation start date, in the format YYYY-MM-DD

Example
2026-07-01
endDate
string

Filter by creation end date, in the format YYYY-MM-DD

Example
2026-07-31

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The resource was returned successfully

object
limit

The maximum number of records returned in the current page. Corresponds to the limit value provided in the request.

number
Example
20
sort

Defines the sorting direction applied to the results. Allowed values: “asc” — ascending order, “desc” — descending order (default)

string
Allowed values: asc desc
Example
desc
nextCursor

A cursor value representing the timestamp of the last item returned in the current page. This value must be provided as the cursor parameter in the next request to continue retrieving results.

string
Example
2025-01-01T10:00:00Z
hasNext
required

Indicates whether additional pages of data are available.

boolean
Example
true
data
required

The array of batches

Array<object>
object
id
required
string
Example
5160c73e-8b9b-4f1f-8c64-0edcbb97c335
endToEndId
required
string
Example
E12345678920260710120000abcd
status
required
string
Allowed values: INITIAL PENDING PAID PARTIALLY_PAID ERROR
Example
PAID
transactionsCount
required
number
Example
3
paidCount
required
number
Example
2
failedCount
required
number
Example
1
paidAmount
required
string
Example
30000.00
pendingAmount
required
string
Example
15000.00
totalAmount
required
string
Example
45000.00
feeFix
required

Sum of feeFix across all child transactions

string
Example
1
feeVar
required

Sum of feeVar across all child transactions

string
Example
1.1
senderAccount
required
object
accountId
required
string
Example
sender-account-1
name
required
string
Example
John Doe
document
required
object
type
required
string
Example
CPF
number
required
string
Example
91112680842
accountType
required
string
Example
PAYMENT_ACCOUNT
branchNumber
required
string
Example
0001
accountNumber
required
string
Example
12345-2
ispb
required
string
Example
12345678
receiverAccount
required
object
name
required
string
Example
John Doe
document
required
object
type
required
string
Example
CPF
number
required
string
Example
91112680842
accountType
required
string
Example
CHECKING
branchNumber
required
string
Example
0001
accountNumber
required
string
Example
12345-2
ispb
required
string
Example
12345678
company
required
object
id
required

Company ID.

string
Example
550e8400-e29b-41d4-a716-446655440000
name
required

Company name.

string
Example
Some company name
createdAt
required

The date and time when the batch was created.

string
Example
2023-07-10T12:00:00Z
updatedAt
required

The date and time when the batch was last updated.

string
Example
2023-07-10T12:00:00Z

400

Section titled “400 ”

The request is not valid

Array<string>

403

Section titled “403 ”

Unauthorized Request

Array<string>

500

Section titled “500 ”

An unexpected error occurred inside the server

Array<string>