Skip to main content

List Split Payment History

GET 
/v1/split-payments/pix/history
Tag: api-baas-get-all-split-payments-pix-historyDescription: Retrieve a list of split payment history records. Use optional filter parameters to refine your search.

Request​

Query Parameters

    page number

    Default value: 1

    Page number.

    size number

    Possible values: <= 100

    Default value: 20

    Page size. Max size is 100.

    sort string

    Possible values: [created_at]

    Page sort attribute.

    order string

    Possible values: [asc, desc]

    Default value: asc

    Page order.

    state string

    Possible values: [PENDING, PROCESSING, READY, FAILED]

    Filter by split payment state.

    deposit_end_to_end_id string

    Filter by deposit end-to-end ID.

    split_end_to_end_id string

    Filter by split end-to-end ID.

    deposit_id string

    Filter by deposit ID.

    split_operation_id string

    Filter by split operation ID.

    txid string

    Filter by transaction ID (txId) from QR Code.

Header Parameters

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-product-uuid string

    UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

    x-product-target-user-uuid string

    UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

Responses​

The split payment history returned successfully.

Schema
    page numberrequired

    Page number.

    page_size numberrequired

    Page size.

    page_total numberrequired

    Page total.

    total numberrequired

    Total of elements.

    data object[]required

    Split payment history data.

  • Array [
    • id stringrequired

    Split payment history ID.

    deposit_id stringrequired

    Original deposit ID.

    deposit_end_to_end_id stringrequired

    Deposit end-to-end ID.

    split_end_to_end_id string

    Split payment end-to-end ID.

    split_operation_id string

    Split operation ID.

    txid stringrequired

    Transaction ID from QR Code.

    payer_name string

    Payer name.

    payer_person_type string

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Payer person type.

    payer_document string

    Payer document (CPF/CNPJ).

    payer_branch string

    Payer branch.

    payer_account_number string

    Payer account number.

    payer_account_type string

    Possible values: [CACC, CASH, CHAR, CISH, COMM, CPAC, LLSV, LOAN, MGLD, MOMA, NREX, ODFT, ONDP, OTHR, SACC, SLRY, SVGS, TAXE, TRAN, TRAS, CC, PG, CD, CG, CI, PP, PI]

    Payer account type.

    payer_bank_ispb string

    Payer bank ISPB.

    recipient_person_type stringrequired

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    Recipient person type.

    recipient_name stringrequired

    Recipient name.

    recipient_document stringrequired

    Recipient document (CPF/CNPJ).

    recipient_bank_ispb stringrequired

    Recipient bank ISPB.

    recipient_branch stringrequired

    Recipient branch.

    recipient_account_number stringrequired

    Recipient account number.

    recipient_account_type stringrequired

    Possible values: [CACC, CASH, CHAR, CISH, COMM, CPAC, LLSV, LOAN, MGLD, MOMA, NREX, ODFT, ONDP, OTHR, SACC, SLRY, SVGS, TAXE, TRAN, TRAS, CC, PG, CD, CG, CI, PP, PI]

    Recipient account type.

    total_deposit_amount numberrequired

    Total deposit amount in R$ cents.

    split_amount numberrequired

    Split amount in R$ cents.

    split_type stringrequired

    Possible values: [PERCENTUAL, ABSOLUTE]

    Split type.

    split_value numberrequired

    Split value (percentage or absolute cents).

    state stringrequired

    Possible values: [PENDING, PROCESSING, READY, FAILED]

    Split payment state.

    failed_message stringnullable

    Error returned when split payment failed.

    failed_code stringnullable

    Code error returned when split payment failed.

    created_at date-timerequired

    Split pix payments history creation date.

    updated_at date-timerequired

    Split pix payments history last update date.

  • ]
Loading...