Skip to main content

Create Bank Billet Payment

POST 
/banking/billet-payments
Tag: api-paas-post-banking-billet-paymentDescription: Create a new bank billet payment by providing the required information in the request body and executing the operation.

Request​

Header Parameters

    x-include-replay-protection-schema string

    The replay-protection-schema allows the user to choose between 3 options:

    • If there's no value: The default protection checks that the values in this request are equal: { method, params, path, query, body, userId }. This means that if a request repeats the same values, it will be blocked.
    • 'nonce': The nonce and { method, params, path, query, body, userId } value are checked. When the protection schema is this, requests will be OK if this nonce value is different in each request.
    • 'x-transaction-uuid': The transactionId and { method, params, path, query, body, userId } value are checked. Requests will be OK if this x-transaction-uuid value is different in each request.
    • 'x-transaction-uuid&nonce' or 'nonce&x-transaction-uuid': The nonce, transactionId value and { method, params, path, query, body, userId } are checked, i.e. if requests are repeated the same value in both fields, they will be blocked. But if any field has a different value, the request is OK.

    x-transaction-uuid stringrequired

    The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.

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

    Decoded bank billet ID.

    amount numberrequired

    Amount specified in Brazilian Real (R$) cents.

    payment_date date

    Specify a date to schedule the payment. If not provided, the payment will be processed immediately. Format: 'YYYY-MM-DD'.

Responses​

Banking billet payment created.

Schema
    id stringrequired

    Bank billet payment ID.

    scheduled_banking_billet_payment_id string

    Scheduled bank billet payment ID.

    operation_id stringrequired

    Bank billet payment operation ID.

    status stringrequired

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

    Bank billet payment status.

    amount numberrequired

    Amount specified in Brazilian Real (R$) cents.

    payment_date date-timerequired

    Payment date.

    created_at date-timerequired

    Creation date.

Loading...