# List bank slip receipt

Retrieve bank slip payment receipts with filtering options.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Banking - Integrated payments",
    "version": "1.0",
    "description": "API responsible for handling and processing integrated payments",
    "contact": {
      "name": "API Support",
      "url": "https://developers.pismo.io/support/"
    },
    "license": {
      "name": "Copyright Pismo"
    }
  },
  "servers": [
    {
      "url": "https://sandbox.pismolabs.io/integrated-payments",
      "description": "Sandbox API server for testing"
    }
  ],
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "Bank slip",
      "description": "Operations related to pay and get information about a bank slips"
    }
  ],
  "components": {
    "parameters": {
      "lastEvaluatedPaymentDatetimeQuery": {
        "name": "lastEvaluatedPaymentDatetimeQuery",
        "in": "query",
        "description": "Last payment datetime evaluated. This is the last_evaluated_payment_datetime field returned in the response and is used to find and return additional results. ISO 8601 format - `yyyy-MM-ddTHH:mm:ss.SSSSSSSSSZ`.\n",
        "schema": {
          "type": "string",
          "format": "datetime"
        },
        "example": "2024-09-11T18:01:44Z"
      },
      "authorizationIdQuery": {
        "name": "authorizationId",
        "in": "query",
        "description": "Authorization ID filter used for searching fund transfers.",
        "schema": {
          "type": "string"
        },
        "example": "1234"
      },
      "perPageQuery": {
        "name": "perPage",
        "in": "query",
        "description": "Receipts per page. Min=1, max=100, default=20.",
        "schema": {
          "type": "string",
          "default": "20",
          "minLength": 1,
          "maxLength": 100
        },
        "example": "100"
      },
      "orderQuery": {
        "name": "order",
        "in": "query",
        "description": "Result ordering is done on bank slip creation datetime. Default is `desc`.",
        "schema": {
          "type": "string",
          "enum": [
            "asc",
            "desc"
          ]
        },
        "example": "desc"
      },
      "beginDatetimeQuery": {
        "name": "beginDatetime",
        "in": "query",
        "description": "Begin datetime filter. ISO 8601 format - `yyyy-MM-ddTHH:mm:ss.SSSSSSSSSZ`.\n",
        "schema": {
          "type": "string",
          "format": "datetime"
        },
        "example": "2024-09-11T18:01:44Z"
      },
      "endDatetimeQuery": {
        "name": "endDatetime",
        "in": "query",
        "description": "End datetime filter. ISO 8601 format - `syyyy-MM-ddTHH:mm:ss.SSSSSSSSSZ`.\n",
        "schema": {
          "type": "string",
          "format": "datetime"
        },
        "example": "2024-09-11T18:01:44.000Z"
      }
    },
    "schemas": {
      "bankslips.bankslipReceipt": {
        "type": "object",
        "properties": {
          "account_id": {
            "description": "Pismo account ID.",
            "type": "integer"
          },
          "amount": {
            "type": "number"
          },
          "authorization_id": {
            "description": "Authorization ID.",
            "type": "integer"
          },
          "beneficiary_document_number": {
            "description": "A government document number, such as a CPF (Brazil) - Cadastro de Pessoas Fisicas (Indiviual Taxpayer Registry) number, CNPJ (Brazil) - Cadastro Nacional de Pessoa Juridica (National Registry of Legal Entities) number - unique ID for legal entities, such as companies and organizations.\n",
            "type": "string"
          },
          "beneficiary_name": {
            "description": "Beneficiary name.",
            "type": "string"
          },
          "client_request_id": {
            "type": "string",
            "description": "Client request ID."
          },
          "currency_code": {
            "type": "string",
            "description": "ISO 4217 currency code. Can be either numeric or alphabetic."
          },
          "customer_name": {
            "description": "Customer name.",
            "type": "string"
          },
          "description": {
            "description": "Bank slip description.",
            "type": "string"
          },
          "digitable_line": {
            "description": "Digitable line.",
            "type": "string"
          },
          "discount": {
            "description": "Discount displayed in percentage granted to this bank slips if paid until the due datetime specified in `due_datetime`.",
            "type": "number"
          },
          "document_number": {
            "description": "Document number related to the owner of bank slips.",
            "type": "string"
          },
          "due_datetime": {
            "description": "Due datetime. ISO 8601 format - `yyyy-MM-ddTHH:mm:ss.SSSSSSSSSZ`.",
            "type": "string",
            "format": "date-time"
          },
          "external_id": {
            "type": "string",
            "description": "External provider transaction ID."
          },
          "fine": {
            "description": "Fine applied to the bank slip amount in case of overdue.",
            "type": "number"
          },
          "interest": {
            "description": "Interest applied to the bank slip amount when overdue.",
            "type": "number"
          },
          "payment_datetime": {
            "description": "Date on which payment is made.",
            "type": "string",
            "format": "date-time"
          },
          "settlement_partner": {
            "description": "Settlement partner.",
            "type": "string"
          },
          "status": {
            "description": "Bank slip status. Possible values are `CREATED`, `REGISTERED`, and `CANCELLED`.",
            "type": "string"
          },
          "additional_info": {
            "type": "string",
            "description": "Additional information about the bank slip payment, including provider-specific details.\n",
            "example": "NumCtrl = 123456"
          }
        }
      },
      "bankslips.GetbankslipsReceiptsResponse": {
        "type": "object",
        "properties": {
          "begin_datetime": {
            "description": "Begin datetime. ISO 8601 format - `yyyy-MM-ddTHH:mm:ss.SSSSSSSSSZ`.",
            "type": "string",
            "format": "date-time"
          },
          "end_datetime": {
            "description": "End datetime. ISO 8601 format - `yyyy-MM-ddTHH:mm:ss.SSSSSSSSSZ`.",
            "type": "string",
            "format": "date-time"
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/bankslips.bankslipReceipt"
            }
          },
          "last_evaluated_payment_datetime": {
            "description": "Last evaluated payment datetime.",
            "type": "string",
            "format": "date-time"
          },
          "per_page": {
            "description": "Number of results per page.",
            "type": "integer",
            "example": 10
          },
          "total_items": {
            "description": "Total items matching the filtering criteria.",
            "type": "integer",
            "example": 100
          }
        }
      },
      "domain.Error": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Error type code.",
            "example": "EIP0001"
          },
          "details": {
            "type": "string",
            "description": "Error details.",
            "example": "Error details"
          },
          "message": {
            "type": "string",
            "description": "Error message describing the error.",
            "example": "error"
          }
        }
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "paths": {
    "/v1/bankslips/receipts": {
      "get": {
        "tags": [
          "Bank slip"
        ],
        "summary": "List bank slip receipt",
        "description": "Retrieve bank slip payment receipts with filtering options.",
        "operationId": "get-integrated-payments-api-v1-bankslips-receipts",
        "parameters": [
          {
            "$ref": "#/components/parameters/lastEvaluatedPaymentDatetimeQuery"
          },
          {
            "$ref": "#/components/parameters/authorizationIdQuery"
          },
          {
            "$ref": "#/components/parameters/perPageQuery"
          },
          {
            "$ref": "#/components/parameters/orderQuery"
          },
          {
            "$ref": "#/components/parameters/beginDatetimeQuery"
          },
          {
            "$ref": "#/components/parameters/endDatetimeQuery"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "headers": {
              "x-cid": {
                "description": "Request tracking identifier.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/bankslips.GetbankslipsReceiptsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "headers": {
              "x-cid": {
                "description": "Request tracking identifier.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/domain.Error"
                },
                "examples": {
                  "EIP0010": {
                    "summary": "Unmarshal error",
                    "value": {
                      "code": "EIP0010",
                      "message": "Unmarshal error"
                    }
                  },
                  "EIP0012": {
                    "summary": "Account not found",
                    "value": {
                      "code": "EIP0012",
                      "message": "Account not found"
                    }
                  },
                  "EIP0013": {
                    "summary": "Accounts - API returned 4xx error",
                    "value": {
                      "code": "EIP0013",
                      "message": "Accounts - API returned 4xx error"
                    }
                  },
                  "EIP0045": {
                    "summary": "Invalid query param",
                    "value": {
                      "code": "EIP0045",
                      "message": "Invalid value for query param {value}"
                    }
                  },
                  "EIP0046": {
                    "summary": "Invalid datetime query param",
                    "value": {
                      "code": "EIP0046",
                      "message": "Invalid value for datetime query parameter. RFC3339 format must be used"
                    }
                  },
                  "EIP0047": {
                    "summary": "Invalid query param",
                    "value": {
                      "code": "EIP0047",
                      "message": "Invalid value for query param {value}"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Bad Request",
            "headers": {
              "x-cid": {
                "description": "Request tracking identifier.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/domain.Error"
                },
                "examples": {
                  "EIP0005": {
                    "summary": "Missing header",
                    "value": {
                      "code": "EIP0005",
                      "message": "Missing required header {x-tenant}"
                    }
                  },
                  "EIP0006": {
                    "summary": "Missing header",
                    "value": {
                      "code": "EIP0006",
                      "message": "Missing account-id header {x-account-id}"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "headers": {
              "x-cid": {
                "description": "Request tracking identifier.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/domain.Error"
                },
                "examples": {
                  "EIP0004": {
                    "summary": "HTTP request error",
                    "value": {
                      "code": "EIP0004",
                      "message": "HTTP request error"
                    }
                  },
                  "EIP0011": {
                    "summary": "Accounts API timeout error",
                    "value": {
                      "code": "EIP0011",
                      "message": "Accounts API timeout error"
                    }
                  },
                  "EIP0041": {
                    "summary": "Bank slip database error",
                    "value": {
                      "code": "EIP0041",
                      "message": "Bank slip database error"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```