PTX Account Visibility API (1.0)

Download OpenAPI specification:

PTX Account Visibility API

This is the documentation for the PTX Account Visibility 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 all the accounts for a customer; list the statements for an account by day, week, month or year; export a single MT940 statement to a zip file; list all the transactions in a specified statement; or list all the transactions in a specified account over a user-defined date range.

Authentication

The process for API authentication is used across PTX for One PTX modules and is not module specific. See Authentication for details.

List all accounts

Returns a list of the accounts for a customer. Includes links to statements for each account for each time period.

Responses

Response samples

200

Content type

application/json

[{"name": "Barclays Bank UK plc",
"bankIdentifier": 934,
"consent": null,
"accounts": [{"source": "MT940",
"iban": null,
"swift": "SWIFT202000752",
"sortCode": "623490",
"number": "20326971",
"name": "Account 2",
"currency": "GBP",
"_links": [{"rel": "DAY",
"href": "https://statements.uk.pt-x.com/api/statement/customer/accounts/113370/statements/DAY"
},
{"rel": "WEEK",
"href": "https://statements.uk.pt-x.com/api/statement/customer/accounts/113370/statements/WEEK"
},
{"rel": "MONTH",
"href": "https://statements.uk.pt-x.com/api/statement/customer/accounts/113370/statements/MONTH"
},
{"rel": "YEAR",
"href": "https://statements.uk.pt-x.com/api/statement/customer/accounts/113370/statements/YEAR"
},
{"rel": "CUSTOM",
"href": "https://statements.uk.pt-x.com/api/statement/customer/accounts/113370/transactions"
}
]
}
],
"_links": [ ]
}
]

List all statements

Returns a list of statements for an account by day, week, month or year.

path Parameters

accountId required	integer <int64> Example: 123 Bank account identifier, obtained from the List all accounts call.
period required	string Enum: "DAY" "MONTH" "WEEK" "YEAR" Example: WEEK The time period to view the statements, obtained from the List all accounts call.

Responses

Response samples

200

Content type

application/json

[{"_links": {"links": [{"deprecation": "null",
"href": "https://statements.uk.pt-x.com/api/statement/customer/accounts/1234/statements/1234/transactions",
"hreflang": "null",
"media": "null",
"rel": "WEEK",
"title": "null",
"type": "null"
}
]
},
"closingBalance": {"amount": 78.9,
"date": "2019-05-14T00:00:00.000+00:00"
},
"openingBalance": {"amount": 78.9,
"date": "2019-05-14T00:00:00.000+00:00"
},
"period": "WEEK",
"periodNumber": 20
}
]

Export MT940 statement

Exports a single MT940 statement to a zip file.

path Parameters

accountId required	integer <int64> Example: 123 The account identifier, obtained from the List all accounts call.
statementId required	integer <int64> Example: 10456 The statement identifier, obtained from the List all statements call.

Responses

List all transactions for requested statement

Returns a list of transactions in a given statement.

path Parameters

accountId required	integer <int64> Example: 123 The account identifier, obtained from the List all accounts call.
statementId required	integer <int64> Example: 10456 The statement identifier, obtained from the List all statements call.

Responses

Response samples

200

Content type

application/json

[{"balance": 1234.56,
"creditAmount": 0,
"date": "2019-05-14T00:00:00.000+00:00",
"debitAmount": 969.81,
"description": "CASH TRANSFER 07/12345",
"time": "01:02:34Z",
"transactionCode": "Payment"
}
]

List all transactions for requested account

Returns a list of transactions in a given account

path Parameters

accountId

required

integer <int64>

The account identifier, obtained from the List all accounts call.

query Parameters

page	any Results page you want to retrieve (0..N)
size	any Number of records per page.
sort	any Sorting criteria in the format: property(,asc\|desc). Default sort order is ascending. Multiple sort criteria are supported.
fromDate required	string <date> Query for transactions from this date. Format yyyy-MM-dd. Example 2023-05-14.
toDate required	string <date> Query for transactions to this date. Format yyyy-MM-dd. Example 2023-05-15.

Responses

Response samples

200

Content type

application/json

[{"content": [{"id": 59969996,
"date": "2021-12-29",
"time": "01:00Z",
"debitAmount": 510.7,
"creditAmount": null,
"balance": 24999489.3,
"description": "IWOCA 07578",
"reference": "REF zMmGFgHdzfWteSMwqTAoHwArOinGiROe",
"merchantName": null,
"merchantCategory": null,
"transactionCode": "BillPayment"
},
{"id": 59969997,
"date": "2021-12-29",
"time": "01:01Z",
"debitAmount": null,
"creditAmount": 551.5,
"balance": 25000040.8,
"description": "CASH TRANSFER 07/15541",
"reference": "REF FwORVj8D5Eyn96Kt2lSJ5bYROxVNKvX2",
"merchantName": null,
"merchantCategory": null,
"transactionCode": "ReceivedCheques"
}
],
"pageable": {"page": 0,
"size": 2,
"sort": {"orders": [{"direction": "ASC",
"property": "date",
"ignoreCase": false,
"nullHandling": "NATIVE"
},
{"direction": "ASC",
"property": "id",
"ignoreCase": false,
"nullHandling": "NATIVE"
}
]
}
},
"total": 4666
}
]