Skip to main content

Create a New Transaction Approval Request

POST 
/v1/permissions/transaction-approval-requests/pix-payment-by-key
Tag: api-baas-post-permissions-transaction-approval-requests-pix-payment-by-keyDescription: To create a new transaction approval request.

Request​

Header Parameters

    x-transaction-uuid stringrequired

    The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.

    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.

Body

required
    decoded_pix_key_id stringrequired

    Decoded pix key ID.

    value numberrequired

    Value in R$ cents.

    payment_date date

    Payment date.

    description string

    User defined payment description.

Responses​

The transaction approval request created successfully.

Schema
    id stringrequired

    Transaction approval request id.

    render_request_body objectrequired

    Render request body.

    state stringrequired

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

    Transaction approval request state.

    created_at date-timerequired

    Transaction approval request created at.

Loading...