Skip to main content

settlementList

settlementsobject[]

An array of Settlements.

meta object

Contains meta info for the pagination APIs

numberOfRecordsnumber

This is the number of records returned in the lookup.

Example: 1
limitnumber

This is the number of records returned per page.

Example: 10
pagenumber

This is the page of records on which the lookup starts.

Example: 1
settlementList
{
"settlements": [
{
"id": "25f6dadf-176a-415f-95c9-6ff39ff697ba",
"paymentType": "CARD",
"availableToRefund": 0,
"childAccountNum": "1234567898",
"txnTime": "2024-07-29T15:51:28.071Z",
"status": "RECEIVED",
"error": {
"code": "5068",
"message": "Field error(s)",
"details": [
"Either you submitted a request that is missing a mandatory field or the value of a field does not match the format expected."
],
"fieldErrors": [
{
"field": "accountId",
"error": "AccountId is missing in the request. If multiple accounts are registered with same currency, accountId is mandatory."
}
]
},
"riskReasonCode": [
0
],
"gatewayResponse": {
"id": "string",
"processor": "string",
"code": "string",
"responseCode": "string",
"avsCode": "string",
"avsResponse": "MATCH",
"balanceResponse": "string",
"mid": "string",
"terminalId": "string",
"batchNumber": "string",
"seqNumber": "string",
"effectiveDate": "string",
"financingType": "string",
"plan": "string",
"gracePeriod": "string",
"term": "string",
"responseId": "string",
"requestId": "string",
"description": "string",
"authCode": "string",
"txnDateTime": "string",
"referenceNbr": "string",
"responseReasonCode": "string",
"cvvVerification": "MATCH",
"cvv2Result": "string",
"status": "string",
"orderId": "string",
"profile": {
"id": "string",
"status": "string",
"merchantCustomerId": "string",
"locale": "en_US",
"firstName": "Venkata Suresh",
"lastName": "Chagalamarri",
"email": "paysafe@gmail.com",
"phone": "1234567891",
"dateOfBirth": {
"day": 6,
"month": 5,
"year": 1998
},
"mobile": "9846573804",
"gender": "M",
"nationality": "Indian",
"identityDocuments": [
{
"identityDocuments": [
{
"type": "SOCIAL_SECURITY",
"documentNumber": "SSN123456"
},
{
"type": "PASSPORT",
"documentNumber": "1234567",
"issuingCountry": "USA",
"issuingCountrySubdvision": "SA",
"expiryDate": {
"month": 12,
"year": 2022
}
}
]
}
]
}
},
"gatewayReconciliationId": "a5c80e61-e747-455f-843d-2b9526f9963e",
"liveMode": true,
"updatedTime": "2023-01-19T10:48:04Z",
"statusTime": "2023-01-19T10:48:04Z",
"merchantRefNum": "string",
"amount": 0,
"dupCheck": true,
"splitpay": [
{
"linkedAccount": "123124124",
"amount": 505,
"percent": 5
}
],
"airlineTravelDetails": {
"passengerName": "Venkata Suresh",
"departureDate": "2022-12-20",
"origin": "SXF",
"computerizedReservationSystem": "DATS",
"ticket": {
"ticketNumber": "1234567891011",
"isRestrictedTicket": true
},
"customerReferenceNumber": "10987654321",
"travelAgency": {
"code": "MY AGENT",
"name": "MYAGENT347"
},
"tripLegs": {
"leg1": {
"flight": {
"carrierCode": "LH",
"flightNumber": "0799"
},
"serviceClass": "F",
"isStopOverAllowed": true,
"destination": "SOF",
"fareBasis": "VMAY",
"departureDate": "2022-12-20"
},
"leg2": {
"flight": {
"carrierCode": "LH",
"flightNumber": "0799"
},
"serviceClass": "F",
"isStopOverAllowed": true,
"destination": "SOF",
"fareBasis": "VMAY",
"departureDate": "2022-12-20"
},
"leg3": {
"flight": {
"carrierCode": "LH",
"flightNumber": "0799"
},
"serviceClass": "F",
"isStopOverAllowed": true,
"destination": "SOF",
"fareBasis": "VMAY",
"departureDate": "2022-12-20"
},
"leg4": {
"flight": {
"carrierCode": "LH",
"flightNumber": "0799"
},
"serviceClass": "F",
"isStopOverAllowed": true,
"destination": "SOF",
"fareBasis": "VMAY",
"departureDate": "2022-12-20"
}
},
"passengerNameRecord": "ABCDE12345",
"additionalBookingReference": "string",
"totalFare": 0,
"totalFee": 0,
"totalTaxes": 0,
"passengers": "string"
}
}
],
"meta": {
"numberOfRecords": 1,
"limit": 10,
"page": 1
}
}