Bottomline PTX
API docs by Redocly

PCL API (1.0.0)

Download OpenAPI specification:

Introduction

This is the documentation for the PTX Web Forms API.

The API is organized REST and uses standard REST features such as resource orientated URLs and HTTP response codes to indicate API errors. The API allows you to list Web Forms transactions, as well as search transactions based on the filters provided. The data received can then be fed into your own external systems.

Refunds

Payment requests are used to securely collect and check bank account details before making a Bacs or Faster Payments.

The API allows you to search for payment request transactions (refunds). Data can then be fed into your own external systems ensuring they are kept up to date.

Search for refund transactions

Authorizations:
oAuth2Password
query Parameters
page
integer
Example: page=1

Page to retrieve, defaults to first page (1).Only used when Paged is set to true, otherwise this parameter is ignored.

Request Body schema: application/json
index
integer <int64>

Number of records to skip before fetching data, used only when Paged is set to false.

size
integer <int64>
Default: 50

Number of records to return per request/page. Maximum limit for this is set to be 250 records. If set to a value greater than 250, size will reset to 250.

object

All filters are optional and are used to refine the transactions displayed.

orderBy
string
Default: "created"

Result is ordered based on the properties listed in this field. This field can accept comma separated properties.

sortOrder
string
Default: "DESC"

This field determines the order in which data is sorted, and is either set to be ASC or DESC (i.e. ascending/descending).

paged
boolean
Default: false

If set to true then the result is paged, otherwise non-paged data is sent in the response.

Responses

Request samples

Content type
application/json
{
  • "index": 0,
  • "size": 50,
  • "filters": {
    },
  • "orderBy": "created,stage",
  • "sortOrder": "DESC",
  • "paged": "false"
}

Response samples

Content type
application/json
{
  • "links": {},
  • "recordTotal": 3897,
  • "data": [
    ],
  • "hasErrors": false
}

Pay Direct

Pay Direct enables a payer to initiate a payment directly from their bank account using the payment initiation service enabled by UK Open Banking, with the funds being transferred via a Faster Payment.

The API allows you to search for Pay Direct transactions. Data can then be fed into your own external systems ensuring they are kept up to date.

Search for Pay Direct transactions

Authorizations:
oAuth2Password
query Parameters
page
integer
Example: page=1

Page to retrieve, defaults to first page (1).Only used when Paged is set to true, otherwise this parameter is ignored.

Request Body schema: application/json
index
integer <int64>

Number of records to skip before fetching data, used only when Paged is set to false.

size
integer <int64>
Default: 50

Number of records to return per request/page. Maximum limit for this is set to be 250 records. If set to a value greater than 250, size will reset to 250.

object

All filters are optional and are used to refine the transactions displayed.

orderBy
string
Default: "created"

Result is ordered based on the properties listed in this field. This field can accept comma separated properties.

sortOrder
string
Default: "DESC"

This field determines the order in which data is sorted, and is either set to be ASC or DESC (i.e. ascending/descending).

paged
boolean
Default: false

If set to true then the result is paged, otherwise non-paged data is sent in the response.

Responses

Request samples

Content type
application/json
{
  • "index": 0,
  • "size": 50,
  • "filters": {
    },
  • "orderBy": "created,stage",
  • "sortOrder": "DESC",
  • "paged": "false"
}

Response samples

Content type
application/json
{}

Alternative Payments

Alternative payments enable a payer to make a payment via their Card or PayPal account.

The API allows you to search for alternative payment transactions. Data can then be fed into your own external systems ensuring they are kept up to date.

Search for alternative payment transactions

Authorizations:
oAuth2Password
query Parameters
page
integer
Example: page=1

Page to retrieve, defaults to first page (1).Only used when Paged is set to true, otherwise this parameter is ignored.

Request Body schema: application/json
index
integer <int64>

Number of records to skip before fetching data, used only when Paged is set to false.

size
integer <int64>
Default: 50

Number of records to return per request/page. Maximum limit for this is set to be 250 records. If set to a value greater than 250, size will reset to 250.

object

All filters are optional and are used to refine the transactions displayed.

orderBy
string
Default: "created"

Result is ordered based on the properties listed in this field. This field can accept comma separated properties.

sortOrder
string
Default: "DESC"

This field determines the order in which data is sorted, and is either set to be ASC or DESC (i.e. ascending/descending).

paged
boolean
Default: false

If set to true then the result is paged, otherwise non-paged data is sent in the response.

Responses

Request samples

Content type
application/json
{
  • "index": 0,
  • "size": 50,
  • "filters": {
    },
  • "orderBy": "created,stage",
  • "sortOrder": "DESC",
  • "paged": "false"
}

Response samples

Content type
application/json
{}

Direct Debits

Direct Debits are used to securely fetch and check bank account details before making scheduled or ad hoc Bacs payments.

The API allows you to search for Direct Debit transactions. Data can then be fed into your own external systems ensuring they are kept up to date.

Search for Direct Debit transactions

Authorizations:
oAuth2Password
query Parameters
page
integer
Example: page=1

Page to retrieve, defaults to first page (1).Only used when Paged is set to true, otherwise this parameter is ignored.

Request Body schema: application/json
index
integer <int64>

Number of records to skip before fetching data, used only when Paged is set to false.

size
integer <int64>
Default: 50

Number of records to return per request/page. Maximum limit for this is set to be 250 records. If set to a value greater than 250, size will reset to 250.

object

All filters are optional and are used to refine the transactions displayed.

orderBy
string
Default: "created"

Result is ordered based on the properties listed in this field. This field can accept comma separated properties.

sortOrder
string
Default: "DESC"

This field determines the order in which data is sorted, and is either set to be ASC or DESC (i.e. ascending/descending).

paged
boolean
Default: false

If set to true then the result is paged, otherwise non-paged data is sent in the response.

Responses

Request samples

Content type
application/json
{
  • "index": 0,
  • "size": 50,
  • "filters": {
    },
  • "orderBy": "created,stage",
  • "sortOrder": "DESC",
  • "paged": "false"
}

Response samples

Content type
application/json
{
  • "links": {},
  • "recordTotal": 3897,
  • "data": [
    ],
  • "hasErrors": false
}