Get Withdraw Setting Request By ID

GET 
/withdraw-setting-request/:id

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Retrieve details of a withdraw setting request by its ID.

Request

Path Parameters

id stringrequired

User withdraw setting request id.

Header Parameters

nonce stringrequired

The nonce ID is a UUID (v4) used to uniquely identify the requisition. All requisitions must have an identifier.

Responses

400

If any required params are missing or has invalid format or type.

default

User withdraw settings request returned successfully.

application/json

Schema

Schema

id stringrequired

User withdraw settings request id.

analysis_result stringrequired

Possible values: [APPROVED, REJECTED]

User withdraw setting request analysis result.

state stringrequired

Possible values: [PENDING, OPEN, CLOSED, FAILED]

User withdraw settings request state.

wallet_id stringrequired

User wallet id.

transaction_type_tag stringrequired

Transaction type tag.

pix_key_type stringrequired

Possible values: [CNPJ, CPF, PHONE, EMAIL, EVP]

Pix key type.

pix_key stringrequired

Pix key.

pix_key_document string

Pix key document related (CPF or CNPJ).

type stringrequired

Possible values: [DAILY, WEEKLY, MONTHLY, BALANCE]

Withdraw settings type.

balance numberrequired

Withdraw settings balance.

day number

Month day of withdraw (if withdraw settings type is MONTHLY).

week_day string

Possible values: [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]

Week day of withdraw (if withdraw settings type is WEEKLY).

created_at date-timerequired

User withdraw setting request creation date.

updated_at date-timerequired

User withdraw setting request update date.

closed_at date-time

User withdraw setting request close date.

Example (from schema)

{
  "id": "f6e2e084-29b9-4935-a059-5473b13033aa",
  "analysis_result": "APPROVED",
  "state": "PENDING",
  "wallet_id": "3267dfe0-73ee-4421-80e7-0c3a5372fa13",
  "transaction_type_tag": "PIXSEND",
  "pix_key_type": "CNPJ",
  "pix_key": "string",
  "pix_key_document": "00000000000",
  "type": "DAILY",
  "balance": 1000000,
  "day": 10,
  "week_day": "MONDAY",
  "created_at": "2024-12-26T10:36:25.862Z",
  "updated_at": "2024-12-26T10:36:25.862Z",
  "closed_at": "2024-12-26T10:36:25.862Z"
}

Loading...