Home
API Reference

Get Instant Payment List

get
https://sb-api.xpollens.com/api/v3.0/sepa-instant-payments

Description


This endpoint allows to consult the operations list of Instant payments.



Prerequisite


  • To access this endpoint, authentication is required. Credentials are to be provided in the request headers as part of the authentication process.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Description

This endpoint allows to consult the operations list of Instant payments.

Prerequisite

  • To access this endpoint, authentication is required.
  • Credentials are to be provided in the request headers as part of the authentication process.
Query Params
string

For pagination purposes, use with the previous field in the response body. Non inclusive cursor. (SepaCreditTransferId expected).

string

For pagination purposes, use with the next field in the response body. Non inclusive cursor. (SepaCreditTransferId expected).

string

Id of the user account / partner account

string

Creditor or debtor Iban

uuid

Id of the Beneficiary (beneficiary can be created through the POST Create a beneficiary endpoint).

string

Instant payment status (possible values: Created, Approved, Completed, Rejected, Canceled).

ValueDescription
CreatedOperation created in the Payment System database.
ApprovedTransaction authorized by the Payment System (with or without authorization balance updated), accounting balance is not impacted yet.
CompletedTransaction settled : accounting balance (and possibly authorization balance) is impacted.
RejectedTransaction refused by the Payment System (limit reached, account statuts, insufficient funds, etc.) or a "Payment Service Provider". Authorization and accounting balance not impacted.
CanceledTransaction cancelled. Authorization and accounting balance possibly impacted.
string

Debit for an Instant payment from a Xpollens account, Credit for a Instant payment to a Xpollens account (possible values: Credit, Debit). If null, all Instant payment (credit, debit) are returned.

ValueDescription
CreditTo an Xpollens account
DebitFrom an Xpollens account
date-time

Inclusive start date for the query. Cannot be after endCreationDate. ISO-8601 format. Date should be UTC.

date-time

Inclusive end date for the query. Cannot be before startCreationDate. ISO-8601 format. Date should be UTC.

int32

Number of Instant payment operations per page. The maximum number of operations per page is limited to 500. Default: 100.

Headers
string
Defaults to 3a2f5a70-112b-4799-8ba2-2c2442908207

Correlation Id

Responses

Updated 8 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago

Did this page help you?