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

status
string
Allowed values: INITIAL PENDING PAID PARTIALLY_PAID ERROR

Filter by batch status

receiverDocumentNumber
string

Filter by the receiver document number

endToEndId
string

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

startDate
string

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

endDate
string

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

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
sort

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

string
Allowed values: asc 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
hasNext
required

Indicates whether additional pages of data are available.

boolean
data
required

The array of batches

Array<object>
object
id
required
string
endToEndId
required
string
status
required
string
Allowed values: INITIAL PENDING PAID PARTIALLY_PAID ERROR
transactionsCount
required
number
paidCount
required
number
failedCount
required
number
paidAmount
required
string
pendingAmount
required
string
totalAmount
required
string
feeFix
required

Sum of feeFix across all child transactions

string
feeVar
required

Sum of feeVar across all child transactions

string
senderAccount
required
object
accountId
required
string
name
required
string
document
required
object
type
required
string
number
required
string
accountType
required
string
branchNumber
required
string
accountNumber
required
string
ispb
required
string
receiverAccount
required
object
name
required
string
document
required
object
type
required
string
number
required
string
accountType
required
string
branchNumber
required
string
accountNumber
required
string
ispb
required
string
company
required
object
id
required

Company ID.

string
name
required

Company name.

string
createdAt
required

The date and time when the batch was created.

string
updatedAt
required

The date and time when the batch was last updated.

string

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>