# search payments

Endpoint responsible for searching payments by PaymentWebQuery model and returning the latest n(number set on the 'limit' parameter) payments, starting from the 'offset' payment(set in 'offset' parameter).
By default the latest 10 payments (sorted by creation date descending) are returned per request


Endpoint: POST /v3/payments/search
Version: 3.6.3
Security: api_key_payment_profile, JWS-Request-Signature-Payment

## Query parameters:

  - `page` (integer)
    zero-based page index in list requests.

  - `size` (integer)
    the size of the page to be returned in list requests.

## Request fields (application/json):

  - `from` (string)
    default is today - 1day (yesterday)

  - `to` (string)

  - `paymentStatuses` (array)
    Enum: "PENDING", "IDENTIFIED", "AUTHORIZED", "AUTHORIZATION_FAILED", "SUCCEEDED", "FAILED", "CANCELLED", "EXPIRED", "PENDING_MERCHANT_ACKNOWLEDGEMENT", "VOIDED"

  - `reference` (string)
    Merchant payment reference, used to reference Bancontact Payconiq Company payment in merchant system. The characters used must comply with the [SEPA Requirements for an Extended Character Set (UNICODE Subset) - Best Practices | European Payments Council](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best).

## Response 200 fields (application/json):

  - `size` (integer, required)
    Size of the elements returned in current page

  - `totalPages` (integer, required)
    Total number of pages in the backend for the list requested

  - `totalElements` (integer, required)
    Total number of elements in the list requested

  - `number` (integer, required)
    Current page number

  - `details` (array)

  - `details.paymentId` (string, required)
    id of the payment

  - `details.createdAt` (string, required)
    the creation time of the payment

  - `details.expireAt` (string, required)
    the time from which the payment will be expired

  - `details.succeededAt` (string)
    if the payment is SUCCEEDED, then this field represents the date-time on which the payment was SUCCEEDED

  - `details.currency` (string, required)
    Currency code. Only EUR is supported [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217)
    Enum: "EUR"

  - `details.status` (string, required)
    | Status | Description |
|--------|-------------|
| PENDING | The merchant has created the payment and and is pending to proceed with identify step. |
| IDENTIFIED | The user has scanned the payment's QR code with the Payconiq By Bancontact APP. |
| AUTHORIZED | The user has confirmed the payment and the bank authorized it. |
| AUTHORIZATION_FAILED | The authorization with the bank failed. |
| FAILED | Something went wrong during the payment process(e.g authorization failed). |
| SUCCEEDED | The payment has succeeded. |
| CANCELLED | When the payment has been canceled after the user has scanned it, or the merchant has cancelled the payment.|
| EXPIRED | The payment has expired. |
| PENDING_MERCHANT_ACKNOWLEDGEMENT | The payment is waiting for the merchant to acknowledge. |
| VOIDED | The payment has been voided |
    Enum: "PENDING", "IDENTIFIED", "AUTHORIZED", "AUTHORIZATION_FAILED", "SUCCEEDED", "FAILED", "CANCELLED", "EXPIRED", "PENDING_MERCHANT_ACKNOWLEDGEMENT", "VOIDED"

  - `details.creditor` (object, required)
    Creditor account set to receive the payment

  - `details.creditor.profileId` (string)
    The configuration ID of the Merchant

  - `details.creditor.merchantId` (string)
    the Id of the merchant

  - `details.creditor.name` (string)
    Merchant's company name that will be shown to the debtor

  - `details.creditor.iban` (string)
    Creditor's Bank Account Iban to where the money will be sent to for this current payment

  - `details.creditor.identifyCallbackUrl` (string)
    callbackUrl to which the merchant will be notified about the payment identification

  - `details.creditor.callbackUrl` (string)
    callbackUrl to which the merchant will be notified about the payment payout

  - `details.debtor` (object)

  - `details.debtor.name` (string)
    First name of Debtor

  - `details.debtor.iban` (string)
    IBAN of Debtor masked

  - `details.amount` (integer, required)
    Amount in cents originally requested. If no amount was requested by creditor, this will be 0

  - `details.description` (string)
    merchant's description of the payment

  - `details.message` (string)
    debtor's message of the payment

  - `details.reference` (string)
    Merchant payment reference, used to reference the Bancontact Payconiq Company payment. The characters used must comply with the [SEPA Requirements for an Extended Character Set (UNICODE Subset) - Best Practices | European Payments Council](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/sepa-requirements-extended-character-set-unicode-subset-best). in the merchant's system

  - `details.bulkId` (string)
    Field used to reference a bulk batch, so the merchant can choose how to bulk the payments. Mandatory if  merchant profile does have bulking enabled, otherwise will miss from the response. If it's not set in the create call it will default to the value configured in the profile if it exists, otherwise its value will be defaulted by the application.

  - `details._links` (object)
    Provides information to navigate to our REST interfaces dynamically, by including hypermedia links to them. Note that for some links inclusion depends on the status of the payment (e.g. cancel link will be available on PENDING and refund on SUCCEEDED)

  - `details._links.self` (object, required)

  - `details._links.self.href` (string, required)

  - `details._links.deeplink` (object, required)

  - `details._links.qrcode` (object, required)

  - `details._links.cancel` (object)

  - `details._links.refund` (object)

  - `details._links.checkout` (object)