Skip to main content

Get Open Finance Payment Consent by ID

GET 
/v1/open-finance/payment-consent/:id

Get an open finance payment consent by id.

Request​

Path Parameters

    id stringrequired

    Payment consent UUID.

Header Parameters

    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​

Payment consent returned.

Schema
    id stringrequired

    Payment consent UUID.

    status stringrequired

    Possible values: [PENDING, WAITING, WAITING_AUTHORIZATION, AUTHORIZED, CONSUMED, REJECTED, REVOKED, EXPIRED, ERROR, FAILED]

    Payment consent status.

    amount numberrequired

    Payment amount.

    payment_type stringrequired

    Possible values: [PIX_KEY, PIX_ACCOUNT, QR_CODE_DYNAMIC, QR_CODE_STATIC]

    Payment type.

    expiration_date_time date-time

    Payment consent expiration date time.

    authorized_date date-time

    Payment consent authorized date.

    rejected_date date-time

    Payment consent rejected date.

    revoked_date date-time

    Payment consent revoked date.

    expired_date date-time

    Payment consent expired date.

    redirect_uri string

    Payment consent redirect URI.

    created_at date-timerequired

    Payment consent created at.

    updated_at date-timerequired

    Payment consent updated at.

Loading...