paymentLinks

QUERY

Returns payment links.

Arguments

query

SqlQuery

The query to filter the payment links with based on Pay Theory defined data. Detailed information about the query object can be found here

limit

Int

The number of payment links to return.

offset

String

The value of the offset item for which the list is being sorted.

direction

MoveDirection

The direction of the pagination. Makes sure the results are returned in the correct order.

Values

BACKWARDFORWARD

offset_id

String

The link_id of the offset item.

Response

PaymentLinks

items

[PaymentLink]| null

List of Payment Links.

total_row_count

Int| null

Total number of rows matching the query.

Examples

List active payment links

Lists a merchant’s active links, newest first.

SUCCESS 200

GRAPHQL

query PaymentLinks($query: SqlQuery, $limit: Int) {
  paymentLinks(query: $query, limit: $limit) {
    items {
      link_id
      link_name
      link_url
      merchant_uid
      amount
      amount_is_variable
      min_amount
      accepted_payment_methods
      account_code
      call_to_action
      created_date
      currency
      custom_success_message
      fee_mode
      is_active
      payment_name
      payment_description
      redirect_url
      require_phone
    }
  }
}