Skip to main content

Get Pix Payment by ID

GET 
/v4/pix/payments/:id

Retrieve the state and details of a pix payment by providing its ID.

Request​

Path Parameters

    id stringrequired

    Payment UUID.

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 requisition. All requisitions must have an identifier.

Responses​

Payment received.

Schema
    id stringrequired

    Payment UUID.

    operation_id string

    Operation UUID. Used to get receipt and track the transaction. This will not be returned if the payment has been scheduled.

    state stringrequired

    Possible values: [PENDING, WAITING, CONFIRMED, ERROR, FAILED, CANCELED, SCHEDULED]

    Payment state.

    end_to_end_id stringrequired

    End to end id.

    txid string

    Payment txid identifier.

    amount numberrequired

    Value in R$ cents.

    owner_name string

    The payment owner name.

    owner_person_type stringrequired

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    The payment owner person type.

    owner_document string

    The payment owner document.

    beneficiary_name string

    The payment beneficiary name.

    beneficiary_person_type stringrequired

    Possible values: [NATURAL_PERSON, LEGAL_PERSON]

    The payment beneficiary person type.

    beneficiary_document string

    The payment beneficiary document.

    beneficiary_bank_name stringrequired

    The payment beneficiary bank name.

    beneficiary_bank_ispb string

    The payment beneficiary bank ispb.

    payment_date date-timenullable

    Schedule a day to execute payment. Use null to send payment right now.

    description stringnullable

    User defined payment description.

    failed_code stringnullable

    Error code returned when payment is reverted.

    failed_message stringnullable

    Error description returned when payment is reverted.

    created_at date-timerequired

    Payment created date.

Loading...