Skip to main content

Create Decoded Bank Billet

POST 
/v1/banking/billet-payments/decode
Tag: api-baas-post-create-decoded-banking-billetDescription: This endpoint generates a new Decoded Bank Billet ID to facilitate payments via bank billet. Provide the bank billet's information in the request body, including the typeable line. Upon successful execution, the endpoint returns a unique ID that is required for processing bank billet payments.

Request​

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
    typeable_line stringrequired

    Typeable line.

Responses​

Decoded bank billet created.

Schema
    id stringrequired

    Unique decoded UUID.

    barcode stringrequired

    Barcode.

    typeable_line stringrequired

    Typeable line.

    original_amount numberrequired

    Original amount.

    charged_amount numberrequired

    Charged amount.

    charged_rebate_amount numberrequired

    Charged rebate amount.

    charged_interest_amount numberrequired

    Charged interest amount.

    charged_fine_amount numberrequired

    Charged fine amount.

    charged_discount_amount numberrequired

    Charged discount amount.

    due_date date-time

    Due date.

    limit_due_date date-time

    Limit due date.

    charged_amount_due_date date-time

    Charged amount due date.

    beneficiary_name stringrequired

    Beneficiary name.

    beneficiary_bank_name stringrequired

    Beneficiary bank name.

    divergent_amount_type stringrequired

    Possible values: [ANY_AMOUNT, BETWEEN_MINIMUM_AND_MAXIMUM, DO_NOT_ACCEPT_DIVERGENT_AMOUNT_PAYMENT, ONLY_MINIMUM_AMOUNT]

    Divergent amount type.

    min_amount number

    Minimum payable amount.

    max_amount number

    Maximum payable amount.

Loading...