Skip to main content

Get Automatic Pix Charge by ID

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

Request​

Path Parameters

    id stringrequired

    Charge 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​

Charge found.

Schema
    id stringrequired

    Charge ID.

    status stringrequired

    Possible values: [PENDING_WAITING, PENDING_CONFIRMED, CREATED, CREATED_FAILED, PAID, NOT_PAID, WAITING_CANCELLATION, CANCELED, CANCELED_FAILED]

    Charge status

    pix_automatic_recurrence_id stringrequired

    Pix Automatic Recurrence ID

    scheduling_purpose stringrequired

    Possible values: [SCHEDULING, NEW_ATTEMPT, RESEND]

    Scheduling purpose

    due_date YYYY-MM-DDrequired

    Due date

    value numberrequired

    Value

    cancellation_reason string

    Possible values: [ACCOUNT_CLOSED, ACCOUNT_BLOCKED, RECURRENCE_CANCELED, SETTLEMENT_FAILURE, OTHER_REASON_BY_PARTICIPANT, REQUESTED_BY_PAYER, REQUESTED_BY_RECEIVER]

    Cancellation reason

    created_at date-timerequired

    Charge creation date.

    updated_at date-timerequired

    Charge update date.

Loading...