---
title: "Get payment agreement"
method: GET
path: "/statements/v4/accounts/{accountId}/installment-payments/{id}"
tags: ["Refinancing"]
---

# Get payment agreement

`GET /statements/v4/accounts/{accountId}/installment-payments/{id}`

## Request

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

Get a payment agreement by account ID and payment agreement ID.

**Note:** This endpoint requires an account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a **401 Unauthorized** message.

## Path parameters

- `accountId` integer, required
- `id` string, required

## Headers

- `Authorization` string, required

## Response `200`

Ok

- object
  - `id` integer: Payment agreement ID
  - `statement_agreement` boolean: Is the generated agreement a statement agreement (`true`) or an installment agreement (`false`)?
  - `compulsory` boolean: Is the generated agreement a compulsory agreement (`true`) or not (`false`)?
  - `status` 'PENDING' | 'PROCESSED' | 'CANCELED' | 'ERROR': Payment agreement's status
  - `split_iof` boolean: Should IOF be split? If `true`, the Pismo platform generates a separate transaction for the IOF tax.
  - `created_at` string: Creation date/time. Format = yyyy-mm-ddThh:mm:ss.
  - `credit_transaction` CreditTransaction
    - `amount` number, float: Credit transaction amount
    - `transaction_id` integer: Transaction ID
    - `transaction_type` integer: Credit transaction type ID
    - `statement_id` integer: Statement ID
  - `payment_datetime` string, date-time: Date/time of the down payment. Format = YYYY-MM-DDThr:mm:ss. This field may represent the payment date for the down payment. When provided, this date is used as the transaction event date for credit and installments.
  - `agreement_amount` number, float: Agreement amount. The total amount that the user has agreed to pay.
  - `agreement_balance` number, float: Agreement balance. The amount that the user has left to pay.
  - `error_message` string: Payment agreement processing error message
  - `iof_transactions` object[]
    - `amount` number, float: IOF transaction amount
    - `transaction_id` integer: Transaction ID
    - `transaction_type` integer: IOF (Brazilian tax) transaction type ID
    - `statement_id` integer: Statement ID
  - `installments` object[]
    - `instalment` integer: Ordered installment number
    - `amount` number, float: Sum of installment's principal amount with its interest and fees.
    - `transaction_id` integer: Transaction ID
    - `transaction_type` integer: IOF (Brazilian tax) transaction type ID
    - `interest_amount` number, float: Interest amount. Maximum of 2 digits allowed after the decimal place.
    - `interest_rate` number, float: Installment's interest rate
    - `iof_amount` number, float: IOF (Brazilian tax) amount. Maximum of 2 digits allowed after the decimal place.
    - `statement_id` integer: Statement ID
  - `custom_transactions` object[]
    - `amount` number, float: Transaction amount
    - `transaction_id` integer: Transaction ID
    - `transaction_type` integer: IOF (Brazilian tax) transaction type ID
    - `statement_id` integer: Statement ID
    - `instalment` integer: Ordered installment number

## Other responses

- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/pismo/apis/revolving-credit-statements.md) - [All operations](https://skmtc.dev/pismo/apis/revolving-credit-statements/llms.txt) - [OpenAPI document](https://skmtc.dev/pismo/apis/revolving-credit-statements/revisions/09f552b0f850?raw)