Skip to main content
Payouts API를 사용하여 지급을 생성하고 추적하며, 저장된 지급 수단을 관리하고, Whop에서 나가는 자금의 예상 도착 정보를 표시할 수 있습니다.

엔드포인트

속성

string
필수
지급 ID로, 접두사는 wdrl_입니다.
string
필수
통화 기본 단위의 지급 금액으로, 십진수 문자열입니다.
boolean
필수
지금 POST /payouts/\{id}/cancel이 이 지급에 적용되는지 여부입니다. 지급이 in_review 상태이거나, 아직 지급 제공업체에 아무것도 제출되지 않은 processing 상태이거나, 제출된 지급을 제공업체에 아직 취소 요청할 수 있는 동안에는 true입니다. 돈이 도착했거나 지급이 이미 종료된 후에는 false입니다.
object | null
필수
지급이 전송되기 전에 잔액이 지급 통화로 환전된 방식입니다. 지급이 자체 통화의 잔액에서 전송된 경우 null입니다.

속성

string
필수
환전 시 잔액에서 차감된 금액으로, 십진수 문자열입니다.
string
필수
환전 시 금액이 차감된 잔액의 통화입니다.
number
필수
from_currency 1단위당 지급 통화 단위로 표시한 환율입니다. 모든 환전 수수료가 이 환율에 포함됩니다.
string
필수
지급이 생성된 시점입니다.
string
필수
지급 통화입니다.
string | null
필수
목적지 통화로 전달된 금액으로, 십진수 문자열입니다. 지급이 처리될 때 지정되므로 그 전과 환전 기록이 없는 지급에서는 null입니다.
string | null
필수
자금이 전달되는 통화로, 지급이 생성될 때 지급 수단에서 가져옵니다. 환전 요청으로 자금이 조달된 지급의 경우 함께 생성된 정산 지급(이 지급의 ID를 payout_request_id로 가지는 GET /payouts 행)을 따르며, 정산 지급이 없는 경우에만 null입니다.
string | null
필수
자금이 목적지 계좌에서 사용 가능해질 것으로 예상되는 시점입니다.
number | null
필수
지급 통화에서 목적지 통화로의 환율입니다. 지급이 처리될 때 지정되므로 그 전과 환율 기록이 없는 지급에서는 null입니다.
object | null
필수
지급이 지급되지 않고 종료된 이유 또는 정산 후 취소된 이유입니다. 실패, 취소, 거부, 반환된 지급에 존재하며, 그 외의 경우 null입니다.

속성

string | null
필수
관리되는 오류 카탈로그의 분류된 실패 코드입니다.
string | null
필수
자금을 잔액으로 되돌린 반환의 유효 시점입니다. 자금이 잔액을 떠난 적이 없거나 아직 반환되지 않은 경우 null입니다. 원장에서 반환이 확인된 후에만 설정되며, 원장 기입 자체는 이 시점보다 잠시 후에 반영될 수 있습니다.
string | null
필수
사람이 읽을 수 있는 실패 설명입니다. payout:destination:read를 보유한 호출자는 목적지에 맞춤화된 텍스트를 받을 수 있으며, 다른 호출자는 일반 카탈로그 메시지를 받습니다.
string
필수
지급에 부과된 수수료로, 지급 통화 기준의 십진수 문자열입니다.
string
필수
지급 수수료를 부담한 주체로, 계정 자체 또는 상위 플랫폼입니다.사용 가능한 옵션: self, platform
string
필수
제공업체 수수료에 대한 Whop의 마크업으로, 지급 통화 기준의 십진수 문자열입니다. 적용되지 않는 경우 "0.0"입니다.
object
필수
생성 시 첨부되어 모든 조회에서 그대로 반환되는 키-값 데이터입니다. 최대 50개의 키, 키 이름은 최대 40자, 문자열 값은 최대 500자까지 가능합니다.
string
필수
지급 통화 기준으로 목적지에 전달될 예정 순액입니다. fee_paid_by가 self인 경우 amount에서 fee_amount와 markup_fee를 뺀 값이며, 플랫폼이 수수료를 부담하는 경우 amount와 같습니다. 거부, 취소 또는 실패로 종료된 지급은 아무것도 전달하지 않았습니다. 대부분은 예정 금액을 유지하고 failure가 자금의 위치를 알려 주지만, 환전 요청으로 자금이 조달된 취소된 지급은 정산된 결과를 대신 보고할 수 있습니다. 이 경우 amount는 잔액에 남은 금액을 나타내고, 부과된 수수료가 없으므로 수수료는 0이며, 아무것도 전달되지 않았으므로 net_amount는 0입니다.
string | null
필수
지급 생성자가 첨부한 자유 형식 메모이며, 제공되지 않은 경우 null입니다. 최대 255자입니다.
string
필수
string | null
필수
지급을 처리하는 주체의 이름입니다.
object | null
필수
사용된 저장된 지급 수단입니다. payout:destination:read가 필요하며, 없으면 null입니다.

속성

string | null
필수
저장된 지급 수단의 별칭입니다.
object | null
필수
지원되는 지급 수단의 표시 정보입니다.

속성

string
필수
자금이 수령인에게 전달되는 방식입니다.사용 가능한 옵션: cash_pickup, bank_deposit, home_delivery, mobile_wallet, card, check, bill, cryptocurrency, unknown
string | null
필수
지원되는 지급 수단의 아이콘 URL입니다.
string | null
필수
지원되는 지급 수단의 표시 이름입니다.
string
필수
지급에 사용된 지급 수단의 종류입니다. external은 자금을 Whop 외부로 보냈습니다. whop_card는 자금을 계정 자체의 Whop Card로 옮겼습니다.사용 가능한 옵션: external, whop_card
string | null
필수
POST /payouts가 반환하는 지급 요청 ID로, 접두사는 cofr_입니다. 이 ID를 GET /payouts의 정산된 지급과 대조하세요. POST /payouts로 생성되지 않은 지급의 경우 null을 반환합니다.
string | null
필수
지급이 생성된 방식입니다. automatic은 예약된 자동 지급을 의미합니다. 지급에 기록된 출처가 없는 경우 null입니다.사용 가능한 옵션: api, dashboard, automatic
string
필수
지급 전달 속도입니다.사용 가능한 옵션: standard, instant
string | null
필수
지급과 함께 전송되는 결제 설명이며, 설정되지 않은 경우 null입니다. 설정된 경우 5~80자의 출력 가능한 ASCII 문자입니다.
string
필수
현재 지급 상태입니다.사용 가능한 옵션: requested, in_review, processing, completed, reversed, canceled, failed, denied
string
필수
status 아래의 가장 세분화된 머신 단계입니다. 예를 들어 processing 아래의 awaiting_provider_acceptance와 in_transit, 또는 requested 아래의 환전 단계가 있습니다. 참고용 어휘로, 버전 변경 없이 값이 추가될 수 있습니다. 버전이 관리되는 계약은 status입니다.
string | null
필수
이 지급의 결제 네트워크 참조로, ACH 추적 번호, RTP 또는 FedNow 엔드투엔드 ID, 전신 송금 IMAD, SWIFT UETR 등이 있습니다. 참조를 사용할 수 있을 때까지와 참조가 없는 지급에서는 null입니다.
Payout