Skip to main content

Get Automatic Pix Authorization by ID

GET 
/v1/pix/scheduled-payments/automatic-authorizations/:id
Tag: api-baas-get-by-id-pix-automatic-authorizationDescription: Retrieve the details of a pix automatic authorization by providing its ID.

Request​

Path Parameters

    id stringrequired

    Authorization ID.

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-lang string

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

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

    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.

Responses​

Automatic pix authorization retrieved successfully.

Schema
    id stringrequired

    Authorization ID.

    journey stringrequired

    Possible values: [JOURNEY_1, JOURNEY_2, JOURNEY_3, JOURNEY_4]

    Authorization journey

    frequency stringrequired

    Possible values: [WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY]

    Authorization frequency

    start_date YYYY-MM-DDrequired

    Authorization start date

    end_date YYYY-MM-DD

    Authorization end date

    value number

    Authorization value

    floor_max_value number

    Authorization floor max value

    beneficiary_ispb stringrequired

    Authorization beneficiary ISPB

    beneficiary_document stringrequired

    Authorization beneficiary document

    beneficiary_name stringrequired

    Authorization beneficiary name

    owner_document stringrequired

    Authorization owner (payer) document

    debtor_document string

    Authorization debtor document

    debtor_name string

    Authorization debtor name

    contract_number stringrequired

    Authorization contract number

    contract_description stringrequired

    Authorization contract description

    request_expiration_date date-timerequired

    Authorization request expiration date

    status stringrequired

    Possible values: [PENDING, WAITING_APPROVAL, WAITING_REJECTION, APPROVED, REJECTED, WAITING_CANCELLATION, CANCELED, FINISHED]

    Authorization status

    payment_max_value number

    Authorization payment max value (defined by payer)

    created_at date-time

    Authorization creation date.

    updated_at date-time

    Authorization update date.

Loading...