Processor Settlements V2 API (1.0.0)

Download OpenAPI specification:Download

Fetch processor settlement summaries and settlement line items

Authentication

bearerAuth

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer
Bearer format	"bearer-token"

Processor Settlements

Finds processor settlements

Authorizations:

bearerAuth

query Parameters

id	string Example: id=1eeebde1-684b-11ea-8790-433f0cef07a4 UUID identifier for the settlement
settledDate	string Example: settledDate=2020-01-01T00:00:00.000Z Date the settlement was conducted
processor	string Example: processor=Worldline WOPA Processor of the transaction
fromRegistrationTimeUtc	string Example: fromRegistrationTimeUtc=2020-01-01T00:00:00.000Z Time the data was registered in Worldline system.
toRegistrationTimeUtc	string Example: toRegistrationTimeUtc=2020-01-01T00:00:00.000Z Time the data was registered in Worldline system.
settlementCurrency	string Example: settlementCurrency=EUR Settlement currency code as per ISO 4217 standards, can be alphabetic code(e.g. EUR) or numeric code(e.g. 978)

Responses

Response samples

200

Content type

application/json

{"metaData": {"total": 10500,
"offset": 10000,
"max": 1000,
"query": "ExternalSummarySearch [ids=[8a4232e3-a309-4d73-b42f-147c5bd07a53]]",
"executionTimeMs": 123123412,
"logTraceId": "123abc",
"host": "dc12",
"isCached": false,
"found": 500
},
"response": [{"uuid": "1eeebde1-684b-11ea-8790-433f0cef07a4",
"debitProcessingAmount": 12.34,
"creditProcessingAmount": 123.456,
"disputeDebitProcessingAmount": 123.456,
"disputeCreditProcessingAmount": 123.456,
"grossSettlementAmount": 123.456,
"netSettlementAmount": 123.456,
"registrationTimeUtc": "2020-04-07T00:26:56.273Z",
"settlementCurrency": "EUR",
"settledDate": "2020-01-01T00:00:00.000Z",
"feeAmount": 123.456,
"commissionAmount": 123.456,
"correctionAmount": 123.456,
"heldRetentionAmount": 123.456,
"releasedRetentionAmount": 123.456,
"taxAmount": 123.456,
"merchantIds": [[1122334455,
5544332211
]
],
"processor": "Barclays",
"debitCount": 123,
"creditCount": 123,
"disputeDebitCount": 123,
"disputeCreditCount": 123,
"settlementPeriodStart": "2020-04-05T10:34:01.485Z",
"settlementPeriodEnd": "2020-04-05T10:34:01.485Z",
"processorSettlementReference": 6213885503
}
]
}

Finds processor settlement line items

Authorizations:

bearerAuth

query Parameters

summaryId

string

Example: summaryId=1eeebde1-684b-11ea-8790-433f0cef07a4

UUID identifier for the settlement

Responses

Response samples

200

Content type

application/json

{"metaData": {"total": 10500,
"offset": 10000,
"max": 1000,
"query": "ExternalSummarySearch [ids=[8a4232e3-a309-4d73-b42f-147c5bd07a53]]",
"executionTimeMs": 123123412,
"logTraceId": "123abc",
"host": "dc12",
"isCached": false,
"found": 500
},
"response": [{"transactionId": 1234567891,
"orderId": "order123",
"orderDescription": "order123 voucher#123",
"merchantId": 1234567891,
"merchantName": "ACME INC.",
"grossSettlementAmount": 123.456,
"netSettlementAmount": 123.456,
"exchangeRate": 123.456,
"settlementCurrency": "EUR",
"processingAmount": 123.456,
"processingCurrency": "EUR",
"commissionAmount": 123.456,
"commissionCurrency": "EUR",
"posId": "ACME_UK",
"paymentMethod": "VISA/Master Card",
"settlementId": "1eeebde1-684b-11ea-8790-433f0cef07a4",
"subMerchantId": "ACME Submerchant",
"processor": "Barclays",
"lineItemType": "TRANSACTION",
"id": "ad529396-cc5b-42d4-b01d-6ac24bb2889b",
"serviceName": "Ebanx credit card",
"transactionType": "Debit",
"transactionTime": "2020-04-05T10:34:01.485Z",
"settledDate": "2020-03-01T00:00:00.000Z",
"bankRefId": "ACME Transaction 123",
"processorMerchantId": "ACME Inc.",
"installmentNumber": 1,
"totalInstallments": 12
}
]
}