출금 신청

post

https://api.testnet.octet.im/2.0/wallets/{walletIdx}/withdrawals

지갑이 가지고 있는 주소에서 출금을 신청합니다. 대표 주소, 자식 주소, 수수료 주소에서의 출금이 가능합니다. 중앙화 지갑일 경우엔 자식 주소에서의 출금이 불가합니다. 정상적으로 신청 완료 시 출금 트랜잭션의 uuid를 반환합니다.

MPC 키 관리 방식 주소에서의 출금은 응답의 mpc 정보(token, mpcSigningTargets)로 고객사 서버에 설치된 MPC 에이전트에 서명을 요청해야 합니다. 신청 시점부터 2분(120초, 정확한 시각은 응답의 mpc.expiredDate) 내에 MPC 서명이 완료되지 않으면 서명 요청이 만료(EXPIRED)되고 해당 출금은 실패(FAILED) 처리됩니다. 만료된 출금은 별도의 취소 요청 없이 실패 처리되므로, 재시도가 필요하면 출금을 새로 신청해야힙니다.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

walletIdx

number

required

지갑 번호

Body Params

symbol

string

required

출금할 자산의 심볼. 심볼은 영문으로 입력해야 하며, 대소문자를 구분하지 않습니다.

contractAddress

string

토큰의 컨트랙트 주소. 코인이 아닌 토큰일 경우 반드시 입력해야 합니다.

requestId

string

required

출금 신청 시 입력할 수 있는 고유한 ID. 요청에 중복된 requestId가 존재할 경우, 해당 요청을 실패 처리 합니다.

amount

string

required

출금 수량

senderAddress

string

required

보내는 주소. 지갑 내 주소여야만 합니다.

receiverAddress

string

required

받는 주소.
이더리움, 카이아 계열의 플랫폼의 경우 prefix가 '0x'이고 소문자 주소와 체크섬 주소만 가능합니다.

receiverMemo

string

출금 트랜잭션의 메모. EOS, Ripple과 같이 송금 시 memo가 필수인 경우에만 사용합니다.

description

string

출금 신청 시 입력할 수 있는 출금에 대한 설명. 블록체인과 무관하며 옥텟 측 데이터베이스에 기록됩니다.

useFeeDelegation

boolean

수수료 대납 트랜잭션을 생성할지를 결정. true일 경우, 지갑의 수수료주소에서 트랜잭션의 수수료를 부담합니다. 수수료 대납을 지원하는 플랫폼(e.g., Kaia)에서만 적용되며 보내는 주소가 수수료 주소일 경우엔 대납을 하지 않습니다.

string

보내는 주소의 PIN. 보내는 주소가 PIN을 사용하는 자식주소라면 필수로 입력해야 합니다.

encryptedUserKey

string

유저 키(User Key)를 RSA 공개 키로 암호화한 값입니다. 아래 조건을 만족하는 경우 필수 항목입니다.

'senderAddress'의 키관리 방식이 '공동관리'인 경우

(단, 'autoSigning' 옵션이 false인 경우에는 입력하지 않아도 됩니다.)

RSA 공개 키는 옥텟 콘솔의 [개발자 도구] 메뉴에서 확인할 수 있습니다.

autoSigning

boolean

옥텟에서 트랜잭션 서명 및 전파를 자동으로 처리할지 여부를 결정합니다. 이 옵션은 senderAddress의 키 관리 타입에 따라 다음과 같이 동작합니다.

공동 관리: 기본값은 true입니다. 값을 생략하거나 true로 설정하면 트랜잭션 생성부터 서명, 전파까지 자동으로 처리됩니다. false로 설정하면 트랜잭션 생성 단계까지만 수행하며, 고객이 직접 서명해야 합니다. 서명 완료 후 '서명된 출금 트랜잭션 전송 API'를 통해 출금을 완료할 수 있습니다. 출금 상태가 AWAITING_SIGNING인 경우 '출금 정보 조회 API'를 통해 serializedUnsignedTransaction을 확인할 수 있습니다.
MPC: 반드시 false로 설정해야 합니다. 출금 신청 후 응답값에 포함된 MPC 정보를 활용하여 서명을 진행할 수 있습니다.

serializedUnsignedTransaction

string

서명 대상 트랜잭션 데이터입니다. 16진수(Hexadecimal) 문자열로 직렬화된 값을 허용합니다.

MPC 키 관리 타입에서는 필수 항목입니다.

이 값을 직접 생성하는 방법은 트랜잭션 빌드 가이드에서 플랫폼별 예제 코드와 함께 확인하실 수 있습니다.

Headers

Authorization

string

required

Defaults to Bearer

API token

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Success