API Reference
Client PortalAPI StatusWebsite

Get payments

get
https://www.bankingcircleconnect.com/api/v1/payments/singles

This endpoint is used to read a collection of single payments. The below parameters can be used for filtering the returned payments. If all fields are left blank, the 50 latest payments will be returned. The endpoint returns relevant information about the payments – including the payment status.

Query Params
uuid

Payment identifier of your payment

Criteria: Exact match of Payment.PaymentId; all other search parameters will be ignored.

uuid

Payment bulk identifier of your payment bulk

Criteria: Exact match of Payment.DebtorInformation.PaymentBulkId; can be used with ValueDate(From/To), Amount(From/To), InstructedDate(From/To), PartialPartyName, PartyAccount, Status, DebtorReference. Any other search parameter will be ignored.

uuid

Account Id

Criteria: Exact match any of

  • Payment.DebtorInformation.AccountId
  • Payment.CreditorInformation.AccountId
string

Your reference

Criteria: Exact match of Payment.DebtorInformation.Instruction.DebtorReference

string

IBAN representation of your viban

Criteria: Exact match any of

  • Payment.DebtorInformation.Viban.Account
  • Payment.CreditorInformation.Viban.Account
string
enum

Classification of payment

Criteria: Exact match

Allowed:
string

Comma-separated list of payment statuses.

If the field LastChangedTimestampFrom is used this field is mandatory. For additional information see LastChangedTimestampFrom.

Criteria: Exact match

date-time

Date on which your payment instruction was delivered to Banking Circle

InstructedDateFrom and InstructedDateTo form a date range

Criteria: Payment.DebtorInformation.InstructedDate must be equal or later

Format: ISO 8601 | YYYY-MM-DD

date-time

Date on which your payment instruction was delivered to Banking Circle

InstructedDateFrom and InstructedDateTo form a date range

Criteria: Payment.DebtorInformation.InstructedDate must be equal or earlier

Format: ISO 8601 | YYYY-MM-DD

date-time

Requested execution date of your payment instruction

RequestedExecutionDateFrom and RequestedExecutionDateTo form a date range

Criteria: Payment.DebtorInformation.Instruction.RequestedExecutionDate must be equal or later

Format: ISO 8601 | YYYY-MM-DD

date-time

Requested execution date of your payment instruction

RequestedExecutionDateFrom and RequestedExecutionDateTo form a date range

Criteria: Payment.DebtorInformation.Instruction.RequestedExecutionDate must be equal or earlier

Format: ISO 8601 | YYYY-MM-DD

date-time

Value date on account booking

ValueDateFrom and ValueDateTo form a date range

When ValueDateFrom is not provided a default of 6 months before ValueDateTo is enforced. - If ValueDateTo is not provided either

a default of 6 months before Today's date is enforced.

Criteria: Payment.DebtorInformation.DebitValueDate or Payment.CreditorInformation.CreditValueDate must be equal or later

Format: ISO 8601 | YYYY-MM-DD

date-time

Value date on account booking(s)

ValueDateFrom and ValueDateTo form a date range

Criteria: Payment.DebtorInformation.DebitValueDate or Payment.CreditorInformation.CreditValueDate must be equal or earlier

Format: ISO 8601 | YYYY-MM-DD

double

Amounts on payment

AmountFrom and AmountTo form an amount range

Criteria: Payment.DebtorInformation.DebitAmount.Amount or Payment.CreditorInformation.CreditAmount.Amount or Payment.Transfer.Amount.Amount must be equal or larger

Value can be negative to locate reversals

double

Amounts on payment

AmountFrom and AmountTo form an amount range

Criteria: Payment.DebtorInformation.DebitAmount.Amount or Payment.CreditorInformation.CreditAmount.Amount or Payment.Transfer.Amount.Amount must be equal or smaller

Value can be negative to locate reversals

date-time
deprecated

This Parameter has been deprecated. Please use InstructedDateFrom instead.

        When did the last change occur on the payment

        Criteria: Payment.LastChangedTimestamp must be equal or larger.

        Condition: Conditional - To search with LastChangedTimestamp, one or more of the following statuses must be provided in the Status filter.

         * Rejected
         * MissingFunding
         * DeclinedByApprover
         * DeclinedByAuthorizer

Note that this parameter, when combined with status(es), allows searching for data only within the past 30 days.

Also note that this parameter will be ignored when used alone, i.e. without 'Status' parameter and the result set will contain 50 (default PageSize) recent payments.

string

Part of line one of the remittance information

Criteria: Payment.Transfer.RemittanceInformation.Line1 must contain - case insensitive

string

Filter on bookings that contain the entered information in the debtorName or CreditorName.

Criteria: Payment.Transfer.DebtorName or Payment.

Transfer.CreditorName must contain - case insensitive.

If this parameter is used without ValueDate(From/To), the search result will contain payments where ValueDate is between (Now - 3 months) to (Now + 1 months)

string

Account of the involved parties

Criteria: Exact match one or more of

  • Payment.DebtorInformation.Account.Account
  • Payment.CreditorInformation.Account.Account
  • Payment.Transfer.DebtorAccount.Account
  • Payment.Transfer.CreditorAccount.Account

If this parameter is used without ValueDate(From/To), the search result will contain payments where ValueDate is between (Now - 3 months) to (Now + 1 months)

int32
1 to 2147483647
Defaults to 1

Number of pages returned.

Condition: Valid page number(1 to n)

int32
1 to 5000
Defaults to 50

No. of items returned per page.

Condition: Valid page number(1 to 5000)

Responses

Updated 7 months ago

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json

Updated 7 months ago