Skip to main content

Cancel Open Finance Scheduled or Pending Payment

PATCH 
/open-finance/payments/:id

Cancel a Open Finance scheduled or pending payment by ID.

Request​

Path Parameters

    id stringrequired

    Open Finance payment 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-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
    canceled_by_document stringrequired

    Canceled by document.

Responses​

The payment canceled successfully.

Schema
    id stringrequired

    Payment UUID.

    status stringrequired

    Possible values: [PENDING, WAITING, WAITING_ANALYSIS, COMPLETED, FAILED, REJECTED, SCHEDULED, PENDING_CANCEL, CANCELLED, ERROR]

    Payment status.

    created_at date-timerequired

    Payment created at.

    updated_at date-timerequired

    Payment updated at.

Loading...