Fetch payment links list

GET/v1/payment-links

It enables fetching a list of available PBLs (not all payment methods) where the ID represents a specific PBL from the list previously added by the Merchant.

Fetching the list of available PBLs can be used, for example, to present them on the Merchant's website for the user.

Request

Query Params

customerEmail

string <email>

optional

Customer email

status

enum<string>

optional

Payment link status

Allowed values:

NEWREGISTEREDEXPIREDPAYMENT_STARTEDPAYMENT_PROCESSEDPAYMENT_REJECTED

currency

string

optional

Currency

>= 3 characters<= 3 characters

Example:

PLN

Match pattern:

^[A-Z]+$

creationDateFrom

string <date-time>

optional

Payment link date range

creationDateTo

string <date-time>

optional

Payment link date range

showHidden

string

optional

Payment link show hidden

Example:

true, false

itemsPerPage

string

optional

Limit of results

Default:

Match pattern:

^[1-9][0-9]*$

page

string

optional

Page of results

Default:

Match pattern:

^[1-9][0-9]*$

Header Params

request-id

string

required

A unique identifier generated by requesting client

>= 38 characters<= 1024 characters

Example:

|us04oqdnzFQVr0rITD9/c9OvDRE2sXVfwerv.

Match pattern:

^[a-zA-Z0-9?&:_|\-\/=+.,#\s]+$

Request samples

Responses

OK(200)

HTTP Code: 200

Content Type : JSONapplication/json

data

array[object (PaymentLink) {10}]

required

string <uuid>

optional

url

string <uri>

optional

amount

object

optional

customer

object

optional

items

array [object {3}]

optional

merchant

object

optional

expirationDate

string <date-time>

optional

status

string

optional

createdAt

string

optional

hidden

boolean

optional

Meta

required

itemsPerPage

string

optional

Default:

Match pattern:

^[1-9][0-9]*$

page

string

optional

Default:

Match pattern:

^[1-9][0-9]*$

direction

enum<string>

optional

Allowed values:

ascdesc

Default:

asc

sortBy

enum<string>

optional

Allowed value:

createdAt

Default:

createdAt

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "url": "http://example.com",
      "amount": {
        "currency": "string",
        "value": 0
      },
      "customer": {
        "firstName": "string",
        "lastName": "string",
        "email": "string"
      },
      "items": [
        {
          "name": "string",
          "price": 0,
          "quantity": 0
        }
      ],
      "merchant": {
        "uuid": "string",
        "shopUuid": "string",
        "terminalUuid": "string",
        "transactionId": "string",
        "terminalId": "string"
      },
      "expirationDate": "2019-08-24T14:15:22.123Z",
      "status": "string",
      "createdAt": "string",
      "hidden": true
    }
  ],
  "meta": {
    "itemsPerPage": "10",
    "page": "1",
    "direction": "asc",
    "sortBy": "createdAt"
  }
}

Modified at 10 days ago