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:
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

200

OK

400

Bad request

401

Unauthorized

500

Internal server error

get/processorsettlementservice/v2/processorsettlements

Acceptance test

https://api.test.payments.worldline.com/api/processorsettlementservice/v2/processorsettlements

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "metaData":
    {
    },
  • "response":
    [
    ]
}

Finds processor settlement line items

Authorizations:
query Parameters
summaryId
string
Example: summaryId=1eeebde1-684b-11ea-8790-433f0cef07a4

UUID identifier for the settlement

Responses

200

OK

400

Bad request

401

Unauthorized

500

Internal server error

get/processorsettlementservice/v2/processorsettlementlineitems

Acceptance test

https://api.test.payments.worldline.com/api/processorsettlementservice/v2/processorsettlementlineitems

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "metaData":
    {
    },
  • "response":
    [
    ]
}