Skip to main content

Get Banking Billet Payment by ID

GET 
/v1/banking/billet-payments/:id
Tag: api-baas-get-banking-billet-payment-by-idDescription: Get detailed information about a banking billet payment by its ID, including decoded billet data when available.

Request​

Path Parameters

    id stringrequired

    Banking billet 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-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​

Banking billet payment found.

Schema
    id stringrequired

    Banking billet payment ID.

    status stringrequired

    Possible values: [PENDING, WAITING, WAITING_CMP, CONFIRMED, FAILED, CANCELED]

    Banking billet payment status.

    amount numberrequired

    Amount specified in Brazilian Real (R$) cents.

    created_at date-timerequired

    Creation date.

    confirmed_at date-time

    Confirmation date.

    operation_id string

    Operation ID.

    typeable_line string

    Typeable line of the banking billet.

    barcode string

    Barcode of the banking billet.

    due_date date-time

    Due date of the banking billet.

    nominal_value number

    Nominal value of the banking billet in Brazilian Real (R$) cents.

    beneficiary_bank_name string

    Beneficiary bank name.

    beneficiary_bank_ispb string

    Beneficiary bank ISPB.

    beneficiary_full_name string

    Beneficiary full name.

    beneficiary_document string

    Beneficiary document.

Loading...