Sign in

v1

latestOpenAPI 3.0.02026-07-242035712.0 MB
Account

Get Statement

Allows for retrieval of statement based on input of token/account and a time range.

post/pws/pws_get_statement/

Request body

api_call_unique_identifierstring required

Unique number that must be passed at each API request. Identifier to make each API request unique

client_idinteger required

Unique identifier for the client which Paymentology will provide at outset

input_idinteger required

Public token / account number.Pass public token when input type is t./Pass account number when input type is a.

input_typestring required
<p>Input Type :</p> <ul> <li class="docBullet">a ==&gt; account</li> <li class="docBullet">t ==&gt; Token</li> </ul>
user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Remarks for API request

date_fromstring

From Date,accepted format yyyy-mm-dd hh:mm:ss.

date_tostring

To Date,accepted format yyyy-mm-dd hh:mm:ss

statement_typeinteger
<ul> <li class="docBullet">statement_type =1 returns statement for this account.</li> <li class="docBullet"><del>statement_type =2 returns statement for this account AND all accounts below it, keeping each account in its billing currency.</del></li> <li class="docBullet"><del>statement_type =3 returns statement for this account, returning all rows in billing currency of main account.</del></li> <li class="docBullet">Note : statement_type 2 & 3 is not implemented and these options will be removed in future </li> </ul>

Example request

{
  "api_call_unique_identifier": "438574845790657485",
  "client_id": 760131,
  "input_id": 479823917,
  "input_type": "a",
  "date_from": "2020-01-24 13:13:08",
  "date_to": "2025-10-24 13:13:08",
  "statement_type": 1
}

Response

Successful Response

Example response

{
  "header": {
    "error_desc": "success"
  },
  "body": [
    {
      "txn_id": 91191931,
      "token": 545398123,
      "type": "Load",
      "type_detail": 1,
      "status": "Approved & Settled",
      "ac_id": 117079743,
      "description": "Paymentology",
      "spend_ccy": "GBP",
      "spend_sym": "£",
      "spend_amt": 53.89,
      "card_ccy": "400",
      "card_sym": "$",
      "txn_amt": 1190.25,
      "aval": 1190,
      "note": "debit/credit note",
      "is_debit": 1
    }
  ]
}