SettlementBatches

Get settlement batches

SecurityBearer or Bearer or Bearer or Bearer

Request

query Parameters

page	integer <int32>
pageSize	integer <int32>
orderBy	string
asc	boolean
dateFrom	string <date-time>
dateTo	string <date-time>
batchIds	Array of strings <uuid>
paymentProcessorIds	Array of strings <uuid>
statusId	integer <int32> (PaymentGateway.Contracts.Enums.SettlementBatchStatus) Possible values: 1 - Open: 2 - Settled: Enum: 1 2

Responses

200

Success

get/pay-api/v1/settlements/batches

Request samples

curl

curl -i -X GET \
  'https://api.uat.arise.risewithaurora.com/pay-api/v1/settlements/batches?page=0&pageSize=0&orderBy=string&asc=true&dateFrom=2019-08-24T14%3A15%3A22Z&dateTo=2019-08-24T14%3A15%3A22Z&batchIds=497f6eca-6276-4993-bfeb-53cbbbba6f08&paymentProcessorIds=497f6eca-6276-4993-bfeb-53cbbbba6f08&statusId=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Response samples

application/json

{"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"paymentProcessorId": "a7699db0-1e16-4616-b2cf-4e8d4a5320cb",
"paymentProcessorName": "string",
"externalBatchId": "string",
"batchDateTime": "2019-08-24T14:15:22Z",
"transactionCount": 0,
"netAmount": 0,
"refundsAmount": 0,
"salesAmount": 0,
"statusId": 0,
"statusName": "string"
}
],
"total": 0
}

➔ Next to Transactions