Skip to content
Gowd Platform Production

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
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
transactions
required
Array<object>
object
id
required

Id of this child transaction

string
idempotencyKey
required

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

string
sequence
required

Ordering position of this child transaction within the batch

number
amount
required

Amount of this child transaction

string
status
required

Status of this child transaction

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

End-to-end id of this child transaction

string
paidAt

Date this child transaction was paid

string
errorMessage

Error message when this child transaction failed

string

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>