Skip to main content
이 페이지는 @whop/elements@1.10.0 및 @whop/elements-react@1.10.0을 다룹니다.
Since v1.0.0. Wallet 안에 마운트됩니다. accountId와 accessToken은 Wallet에서 가져옵니다. props와 콜백은 생성 옵션 또는 React props로 전달합니다. refresh()를 호출하려면 생성된 핸들 또는 React ref를 보관하세요.
이 엘리먼트는 인라인으로 마운트(create)하거나 모달 오버레이로 열 수(createOverlay) 있습니다.

예시 데이터입니다. Playground 열기.

Props

string
출금 수단 나열과 출금 생성에 사용되는 범위 지정 토큰으로, payout:withdraw_funds, payout:destination:read가 필요하며 은행을 추가하려면 payout:create_destination도 필요합니다. 생략하면 호출에 뷰어 자신의 세션이 사용되며, 이는 동일 출처에서만 응답합니다.
boolean
확정된 출금이 성공적으로 생성되었는지 여부입니다. 기본값은 false입니다.
boolean
출금 수단과 한도를 불러오는 중인지 여부입니다. 기본값은 false입니다.
WithdrawalMethod[]
현재 금액에 대한 견적이 포함된 저장된 출금 수단입니다. 기본값은 []입니다.
string
현재 화면 안에 표시할 호스트 측 오류입니다. 기본값은 ""입니다.
number
표준 출금 수단에 사용할 수 있는 정산된 잔액입니다. 기본값은 0입니다.
number
즉시 출금 수단에 사용할 수 있는 대기 중인 잔액입니다. 기본값은 0입니다.
string
출금 계정의 ISO 3166-1 alpha-2 국가 코드입니다. 기본값은 "US"입니다.
WithdrawalSupportedMethod[]
선택한 국가에서 추가할 수 있는 출금 수단으로, 필수 입력란을 포함합니다. 기본값은 []입니다.
boolean
선택한 국가에서 지원되는 출금 수단을 불러오는 중인지 여부입니다. 기본값은 false입니다.
WithdrawalLimits
실시간 표준 및 즉시 출금 한도입니다. 기본값은 {"standard":{"maxAmount":0},"instant":{"maxAmount":0}}입니다.
boolean
현재 금액의 가격을 다시 산정하는 중인지 여부입니다. 기본값은 false입니다.
boolean
이 출금이 확정 전에 제공업체가 보증하는 정확한 견적을 사용해야 하는지 여부입니다. 기본값은 false입니다.
WithdrawalPayoutQuote | null
확정에 사용할 정확한 단기 출금 견적입니다. 견적이 기기 시계가 아닌 남은 유효 시간을 기준으로 계산되도록 serverTime을 포함하세요. 선택한 수단을 바꾸지 않고 연결 흐름을 통해 더 저렴한 수단을 제안하려면 recommendedMethod를 포함하세요. 기본값은 null입니다.
boolean
정확한 출금 견적을 생성하는 중인지 여부입니다. 기본값은 false입니다.
string
현재 정확한 출금 견적 요청에서 발생한 오류입니다(있는 경우). 기본값은 ""입니다.
boolean
마지막 견적 요청의 결과가 불확실하여 같은 요청 ID로 재시도해야 하는지 여부입니다. 기본값은 false입니다.
boolean
마지막 출금 결과가 불확실하여 정확히 동일하게 재시도해야 하는지 여부입니다. 기본값은 false입니다.
WithdrawalRequest | null
엘리먼트가 다시 마운트된 후 재시도할, 해결되지 않은 정확한 출금 요청입니다. 기본값은 null입니다.
boolean
새 출금 수단을 저장하는 중인지 여부입니다. 기본값은 false입니다.
boolean
확정된 출금을 생성하는 중인지 여부입니다. 기본값은 false입니다.
boolean
은행이 예금주 이름을 확인할 수 없어 마지막 출금이 거부된 경우 true입니다. 수정 또는 확인 선택지를 표시하며, 확인하면 acknowledgeBankWarning이 설정된 상태로 withdrawalRequested가 다시 발생합니다. 각 withdrawalRequested를 처리할 때 이 값을 다시 false로 설정하세요. 선택지는 값이 true로 바뀔 때 표시되므로, 플래그를 true로 남겨 두면 이후의 모든 거부가 표시되지 않습니다. 기본값은 false입니다.
string
가장 최근에 생성된 수단으로, methods에 나타나면 선택됩니다. 기본값은 ""입니다.
boolean
결제자가 Plaid Link에서 나갔거나 Plaid Link를 여는 데 실패했을 때 설정합니다. 원래 연결이 필요한 수단에서 수동 입력을 허용합니다. 기본값은 false입니다.
boolean
은행 연결이 진행 중인지 여부입니다. Plaid 세션이 열려 있거나 연결된 수단을 저장하는 중인 경우입니다. 기본값은 false입니다.

이벤트

생성 옵션 또는 React props로 콜백을 전달합니다.

onAmountChanged

금액이 변경되어 가격을 다시 산정해야 합니다.
object

onCountryChanged

수단 추가 국가가 변경되어 지원되는 수단을 새로 고쳐야 합니다.
object

onSupportedMethodChanged

지원되는 출금 수단이 선택되어 정확한 필수 입력란을 불러와야 합니다.
object

onAddMethodRequested

결제자가 동적 출금 수단 추가 양식을 제출했습니다.
WithdrawalCreateMethodInput

onPlaidLinkRequested

결제자가 세부 정보를 입력하는 대신 Plaid를 통해 은행을 연결하기로 선택했습니다. 이벤트를 받으면 Plaid Link를 여세요.
object

onMethodVerificationCompleted

새로 추가된 출금 수단의 인증 단계가 완료되었습니다.

onRenameMethodRequested

결제자가 저장된 출금 수단의 이름 변경을 요청했습니다.
object

onRemoveMethodRequested

결제자가 저장된 출금 수단의 삭제를 요청했습니다.
object

onPayoutQuoteRequested

결제자가 출금을 확정하기 전에 정확한 단기 견적을 요청했습니다.
WithdrawalPayoutQuoteRequest

onWithdrawalRequested

결제자가 출금을 확정했습니다. 호스트가 흐름을 제어하는 경우 이벤트를 받으면 출금을 생성하세요. 엘리먼트가 출금을 생성한 경우에는 성공 후 발생하므로 호스트가 잔액을 새로 고칠 수 있습니다. 두 번째 출금을 생성하지 마세요.
WithdrawalRequest

onDone

결제자가 성공한 출금의 확인을 마쳤습니다.

onLoaderStart

로딩 스켈레톤이 처음 그려진 후, onReady 전에 실행됩니다.

onReady

엘리먼트가 처음으로 완전히 그려진 후 실행됩니다.

onError

엘리먼트가 로드에 실패하거나 충돌할 때 실행됩니다. 대체 화면은 계속 표시됩니다. 프로그래밍 방식으로 처리하려면 code를 사용하세요. sourceKey는 실패한 호스트 상태 소스를 식별합니다.
object

메서드

create가 반환한 핸들에서, 또는 React ref를 통해 호출합니다.

refresh

저장된 출금 수단과 한도를 다시 가져옵니다. 계정이 출금할 수 있는 대상을 바꾸는 변경이 있은 후 호출하세요. 반환값 Promise<void>

mount

target에 엘리먼트를 마운트하고 로딩을 시작합니다. React 컴포넌트는 자동으로 마운트됩니다. 매개변수
string | HTMLElement
필수

destroy

엘리먼트를 제거하고 프레임과 구독을 해제합니다. 여러 번 호출해도 됩니다. React는 엘리먼트를 자동으로 제거합니다.

update

마운트된 엘리먼트에 새 props를 병합합니다. React에서는 대신 컴포넌트 props를 변경하세요. 매개변수
Partial<WithdrawElementProps>
필수

스타일링

이 엘리먼트는 스타일링용 클래스 이름을 노출하지 않습니다. 스타일을 변경하려면 appearance(테마, 강조 색상, 변수)를 사용하세요.