PIpismo
Refinancing

List payment agreements

List payment agreements for a specified account.

get/statements/v4/accounts/{accountId}/installment-payments

Request

  • Base URL
    https://sandbox.pismolabs.io
  • URL
    https://sandbox.pismolabs.io/statements/v4/accounts/{accountId}/installment-payments
  • Auth
    HTTP bearer

Path parameters

accountIdinteger required
Example:101

Account ID

Query parameters

pageinteger
Example:1

Page number

perPageinteger
Example:10

Items per page. Default is 10.

Headers

Authorizationstring required

Account token, not a regular access token. Account tokens are encoded with an account ID. Tokens can expire quickly, which can result in an Unauthorized message.

Response

Ok

pagesinteger

Number of pages

current_pageinteger

Current page

per_pageinteger

Items per page

total_itemsinteger

Number of items found

Example response

{
  "pages": 4,
  "current_page": 2,
  "per_page": 50,
  "total_items": 100,
  "items": [
    {
      "id": 1000,
      "statement_agreement": true,
      "compulsory": true,
      "status": "PROCESSED",
      "created_at": "2021-08-10T00:00:00",
      "credit_transaction": {
        "amount": 40,
        "transaction_id": 77489,
        "transaction_type": 712,
        "statement_id": 9497889
      },
      "payment_datetime": "2021-04-14T12:00:00-03:00",
      "error_message": "Authorization Error",
      "iof_transactions": [
        {
          "amount": 5.12,
          "transaction_id": 77489,
          "transaction_type": 715,
          "statement_id": 9497889
        }
      ],
      "installments": [
        {
          "instalment": 1,
          "amount": 40,
          "transaction_id": 77489,
          "transaction_type": 715,
          "interest_amount": 12.35,
          "interest_rate": 0.1,
          "iof_amount": 1.35,
          "statement_id": 9497889
        }
      ],
      "custom_transactions": [
        {
          "amount": 150,
          "transaction_id": 77489,
          "transaction_type": 715,
          "statement_id": 9497889,
          "instalment": 1
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.