Skip to main content

Get Payout by ID

GET 
/v1/payout/:id
Tag: api-payments-gateway-get-payout-by-idDescription: Retrieve payout details by its unique ID.

Request​

Path Parameters

    id stringrequired

    Payout ID

Query Parameters

    type stringrequired

    Possible values: [BANK_TRANSFER, YAPE]

    Payment method type

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

    The product ID is a UUID (v4) used to identify the Z.ro product configuration.

    x-product-target-user-uuid string

    The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.

Responses​

Payout details retrieved successfully.

Schema
    oneOf
    id stringrequired

    Payout ID.

    operation_id string

    Operation ID associated with the transaction.

    country stringrequired

    Possible values: [BRA, ARG, CHL, PER, MEX]

    Country of the transaction.

    status stringrequired

    Possible values: [PENDING, WAITING, AUTHORIZED, REJECTED, REVERSED, PROCESSED, FAILED, ERROR]

    Status of the transaction.

    amount numberrequired

    Amount of the transaction.

    currency_tag objectrequired

    Currency of the transaction.

    third_part_name stringrequired

    Third part name.

    third_part_last_name stringrequired

    Third part last name.

    third_part_email stringrequired

    Third part email.

    third_part_phone stringrequired

    Third part phone.

    third_part_document stringrequired

    Third part document.

    third_part_document_type objectrequired

    Third part document type.

    third_part_address_zip_code stringrequired

    Third part address zip code.

    third_part_address_street stringrequired

    Third part address street.

    third_part_address_number stringrequired

    Third part address number.

    third_part_address_city stringrequired

    Third part address city.

    third_part_address_state stringrequired

    Third part address state.

    third_part_address_country stringrequired

    Third part address country.

    third_part_address_complement string

    Third part address complement.

    third_part_account_type stringrequired

    Possible values: [SA, CA, CP]

    Third part account type.

    third_part_account_number stringrequired

    Third part account number.

    third_part_bank_code stringrequired

    Third part bank code.

    third_part_bank_name string

    Third party's bank name.

    authorized_date date-timerequired

    Authorized date.

    failed_date date-timerequired

    Failed date.

    created_at date-timerequired

    Created at.

    updated_at date-timerequired

    Updated at.

Loading...