Skip to content
Gowd Platform

Get a batch by id - V1

GET
/order/v1/batch/{id}

Get the detail of a batch by its id.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

The batch ID (UUID)

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The resource was returned successfully

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
transactions
required
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 ”

The request is not valid

Array<string>

403

Section titled “403 ”

Unauthorized Request

Array<string>

404

Section titled “404 ”

Resource not found

Array<string>

500

Section titled “500 ”

An unexpected error occurred inside the server

Array<string>