Skip to main content

List Transaction Approval Requests

GET 
/v1/permissions/transaction-approval-requests
Tag: api-baas-get-permissions-transaction-approval-requestsDescription: Retrieve a list of the transaction approval requests. 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, APPROVED, CANCELED, EXPIRED]

    Transaction approval request state.

    transaction_type_tag string

    Possible values: [P2PBT, WITHDRAW, PIXCHANGE, PIXDEVREC, PIXDEVSEND, PIXREC, PIXREFUND, PIXREFUNDDEV, PIXSEND, PIXSENDAUTOMATIC, PIXSENDSELF, TED, CONV, BTCSEND, BTCRECEIVE, BBP, BBD, DEPORECEIVE, TEDRECEIVE, DEBITTRANSACTION, DEBITCBK, TEDFAILURE, TEDUNDO, TEDRECCBK, DEPRECCBK, DOCRECEIVE, PIXRECEIVE, WITHDRAWCBK, CASHBACK, CASHBACKCBK, FORFEITURE, DBTCARDCRED, ACTCLOSURE, REFREWARD, EXTRACREDIT, SALECREDCARD, SALEDEBTCARD, PIXWITHDRAWAL, ADMCRYPTOSEND, ADMCRYPTOREC, P2PBTCTP, P2PBTCTC, P2PTP, P2PTC, CBK, P2MTP, SP, TEDTRANSFERSELF, TEDDEVREC, PIXSENDRESTRICTED, CASHREC, BANKTRANSFERREC, BANKTRANSFERSEND_ARG, BANKTRANSFERDEV_ARG, BANKTRANSFERSEND_CHL, BANKTRANSFERDEV_CHL, BANKTRANSFERSEND_PER, BANKTRANSFERDEV_PER, DEBITCARDREC, CREDITCARDREC, CREDITDEBITCARDREC, YAPEWALLETREC, YAPEWALLETDEV, QRREC, PIXREFUNDCBK]

    Transaction type tag.

Header Parameters

    x-wallet-uuid string

    Sender Wallet UUID (if empty, your default Wallet UUID will be settled)

    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 transaction approval requests 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

    Transaction approval requests data.

  • Array [
    • id stringrequired

    Transaction approval request id.

    user_name stringrequired

    User name.

    transaction_approval_setting_id stringrequired

    Transaction approval setting id.

    render_request_body objectrequired

    Render request body.

    amount numberrequired

    Amount.

    transaction_type_tag stringrequired

    Possible values: [P2PBT, WITHDRAW, PIXCHANGE, PIXDEVREC, PIXDEVSEND, PIXREC, PIXREFUND, PIXREFUNDDEV, PIXSEND, PIXSENDAUTOMATIC, PIXSENDSELF, TED, CONV, BTCSEND, BTCRECEIVE, BBP, BBD, DEPORECEIVE, TEDRECEIVE, DEBITTRANSACTION, DEBITCBK, TEDFAILURE, TEDUNDO, TEDRECCBK, DEPRECCBK, DOCRECEIVE, PIXRECEIVE, WITHDRAWCBK, CASHBACK, CASHBACKCBK, FORFEITURE, DBTCARDCRED, ACTCLOSURE, REFREWARD, EXTRACREDIT, SALECREDCARD, SALEDEBTCARD, PIXWITHDRAWAL, ADMCRYPTOSEND, ADMCRYPTOREC, P2PBTCTP, P2PBTCTC, P2PTP, P2PTC, CBK, P2MTP, SP, TEDTRANSFERSELF, TEDDEVREC, PIXSENDRESTRICTED, CASHREC, BANKTRANSFERREC, BANKTRANSFERSEND_ARG, BANKTRANSFERDEV_ARG, BANKTRANSFERSEND_CHL, BANKTRANSFERDEV_CHL, BANKTRANSFERSEND_PER, BANKTRANSFERDEV_PER, DEBITCARDREC, CREDITCARDREC, CREDITDEBITCARDREC, YAPEWALLETREC, YAPEWALLETDEV, QRREC, PIXREFUNDCBK]

    Transaction type tag.

    state stringrequired

    Possible values: [PENDING, APPROVED, CANCELED, EXPIRED]

    Transaction approval request state.

    votes numberrequired

    Transaction approval votes.

    approvers_quantity numberrequired

    Number of approvers required for approval.

    created_at date-timerequired

    Transaction approval request created at.

  • ]
Loading...