Refinancing

Get payment agreement

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.

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

Path parameters

accountIdinteger required

Example:101

Account ID

idstring required

Example:4101

Payment agreement ID

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

idinteger

Payment agreement ID

statement_agreementboolean

Is the generated agreement a statement agreement (true) or an installment agreement (false)?

compulsoryboolean

Is the generated agreement a compulsory agreement (true) or not (false)?

status'PENDING' | 'PROCESSED' | 'CANCELED' | 'ERROR'

Payment agreement's status

split_iofboolean

Should IOF be split? If true, the Pismo platform generates a separate transaction for the IOF tax.

created_atstring

Creation date/time. Format = yyyy-mm-ddThh:mm:ss.

payment_datetimestring 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_amountnumber float

Agreement amount. The total amount that the user has agreed to pay.

agreement_balancenumber float

Agreement balance. The amount that the user has left to pay.

error_messagestring

Payment agreement processing error message

Example response

{
  "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",
  "agreement_amount": 4111.56,
  "agreement_balance": 2055.89,
  "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.