Returns a cursor paged list of payments

get

https://sepaexpress-prod-fx.azurewebsites.net/api/services/v2/Payments

Returns a cursor paged list of payments.

Query Params

ids

array of strings

Return only objects that match the specified ids. Optional.

ids

after

string

length between 32 and 32

Return only objects after this cursor id. Optional.

before

string

length between 32 and 32

Return only objects before this cursor id. Optional.

limit

int32 | null

1 to 500

Upper bound for the number of objects to be returned. Defaults to 50. Maximum of 500. Optional.

createdFrom

date-time | null

Return only objects which were created from this timestamp on. Optional.
Note: Do not use timestamps for the paging of search results as there can be multiple objects with the same timestamp.

createdUntil

date-time | null

Return only objects which were created until this timestamp. Optional.
Note: Do not use timestamps for the paging of search results as there can be multiple objects with the same timestamp.

lastModifiedFrom

date-time | null

Return only objects which were last modified from this timestamp on. Optional.
Note: Do not use timestamps for the paging of search results as there can be multiple objects with the same timestamp.

lastModifiedUntil

date-time | null

Return only objects which were last modified until this timestamp. Optional.
Note: Do not use timestamps for the paging of search results as there can be multiple objects with the same timestamp.

state

string

length between 0 and 32

Return only objects with this state. Optional.

merchantId

string

Return only objects with this merchant id. Optional.

connectorId

string

Return only objects with this connector id. Optional.

customerId

string

Return only objects with this customer id. Optional.

bankAccountId

string

Return only objects with this bank account id. Optional.

mandateId

string

Return only objects with this mandate id. Optional.

reference

string

Return only objects with this payment reference. Optional.

currencyCode

string

Return only objects with this currency code. Optional.

includeCustomer

boolean | null

Indicates whether the full customer object should be included. Optional.

includeBankAccount

boolean | null

Indicates whether the full bank account object should be included. Optional.

includeMandate

boolean | null

Indicates whether the full mandate object should be included. Optional.

includeConnector

boolean | null

Indicates whether the full connector object should be included. Optional.

includeMerchant

boolean | null

Indicates whether the full merchant object should be included. Optional.

includeHostedPage

boolean | null

Indicates whether the full hosted page object should be included. Optional.

submittedUntil

date-time | null

Return only objects which were submitted at this timestamp.

custom1

string

Custom1 for free use by the PSP.

custom2

string

Custom2 for free use by the PSP.

custom3

string

Custom3 for free use by the PSP.

custom4

string

Custom4 for free use by the PSP.

custom5

string

Custom5 for free use by the PSP.

Responses

200Ok. Standard response for successful HTTP requests.

400Bad Request. The request could not be understood by the server, usually due to malformed syntax.

401Unauthorized. The client did not provide a valid authentication HTTP header or the user making the request has been disabled.

403Forbidden. The client provided a valid authentication header, but does not have permission to access this resource.

429Too many requests. A rate limit has been reached.