Xsolla-logo
  • 문서화
  • 계정 생성

결제Webhook POST

사용자가 결제를 완료하면 엑솔라는 payment 유형이 포함된 웹훅의 결제 세부 정보를 웹훅 URL로 전송합니다.

5xx 코드가 포함된 응답을 수신하면 엑솔라는 수신자가 수신을 확인할 때까지 시간 간격을 늘려가며 웹훅을 재전송합니다. 최대 재시도 횟수는 12회입니다.

Request
Request Body schema: application/json
notification_type
required
string

알림 유형입니다.

required
object

트랜잭션 데이터 관련 값입니다.

agreement
integer

계약 ID입니다.

dry_run
integer

테스트 트랜잭션(거래). 테스트 트랜잭션의 경우 매개변수는 1개 값을 갖습니다. 또는, 트랜잭션(거래)이 실제로 이루어지는 경우 매개변수가 전송되지 않습니다.

external_id
string

트랜잭션 외부 ID 입니다.

id
integer

트랜잭션 ID.

payment_date
string

결제 날짜입니다.

payment_method
integer

결제 수단의 ID입니다.

payment_method_name
string

결제 방식 이름.

payment_method_order_id
string

결제 시스템의 결제 ID.

required
object

결제 내역 관련 값입니다.

object

직접 원천징수세.

amount
integer <float>

총계.

currency
string

통화. ISO 4217에 따른 3자리 통화 코드입니다.

percent
integer <float>

직접 원천징수세율

object

게임유저 결제 데이터 관련 값입니다.

amount
integer <float>

총계.

currency
string

통화. ISO 4217에 따른 3자리 통화 코드입니다.

object

결제 방식 수수료율입니다.

amount
integer <float>

총계.

currency
string

통화. ISO 4217에 따른 3자리 통화 코드입니다.

object

결제 방법에서 청구된 금액에 대한 데이터가 포함된 값입니다.

amount
integer <float>

총계.

currency
string

통화. ISO 4217에 따른 3자리 통화 코드입니다.

object

지급 내역 관련 값입니다.

amount
integer <float>

총계.

currency
string

통화. ISO 4217에 따른 3자리 통화 코드입니다.

payout_currency_rate
string <float>

결제 통화를 지급 통화로 환전할 때의 환율입니다.

object

본국 송금 비용에 대한 데이터가 있는 오브젝트. 타사가 엑솔라에 부과.

amount
integer <float>

총계.

currency
string

통화. ISO 4217에 따른 3자리 통화 코드입니다.

object

판매세(대상; 미국과 캐나다만).

amount
integer <float>

총계.

currency
string

통화. ISO 4217에 따른 3자리 통화 코드입니다.

percent
integer <float>

판매세율.

object

VAT 세율입니다(유럽연합만 해당).

amount
integer <float>

총계.

currency
string

통화. ISO 4217에 따른 3자리 통화 코드입니다.

percent
integer <float>

부가가치세율.

object

엑솔라 잔액에서 청구된 금액에 대한 데이터가 포함된 값입니다.

amount
integer <float>

총계.

currency
string

통화. ISO 4217에 따른 3자리 통화 코드입니다.

object

엑솔라 수수료 요율입니다.

amount
integer <float>

총계.

currency
string

통화. ISO 4217에 따른 3자리 통화 코드입니다.

custom_parameters
object

사용자 정의 매개 변수입니다.

object

구매 데이터 관련 값입니다.

required
object

구매 총 가격 데이터와 관련된 값입니다.

amount
integer <float>

총 구매 금액입니다.

currency
string

통화. ISO 4217에 따른 3자리 통화 코드입니다.

object

결제 파라미터 데이터와 관련된 값입니다.

amount
integer <float>

구매 금액입니다.

currency
string

통화. ISO 4217에 따른 3자리 통화 코드입니다.

object

쿠폰 데이터 관련 값입니다(이 트랜잭션에 쿠폰이 사용된 경우).

campaign_code
string

쿠폰 캠페인 코드입니다.

coupon_code
string

쿠폰 코드.

object

기프트에 대한 데이터를 포함하고 있는 객체입니다.

giver_id
string

제공자 ID.

hide_giver_from_receiver
string

수신자에서 제공자 ID를 숨길지 여부.

message
string

제공자로부터 전송된 메시지.

receiver_email
string

기프트 수령인 이메일.

receiver_id
string

기프트 수령인 ID.

object

주문에 대한 정보가 포함된 객체입니다. 이 정보는 기본적으로 웹훅에 전달되지 않습니다. 이 기능을 활성화하려면 계정 관리자에게 문의하거나 am@xsolla.com 으로 이메일을 보내주시기 바랍니다.

id
integer

주문 아이디.

object

아이템에 대한 정보가 포함된 개체입니다.

object

아이템 가격에 대한 정보가 포함된 개체입니다.

amount
float

선택한 통화로 표시된 아이템의 총 가격입니다.

currency
string

아이템 가격의 통화입니다.

quantity
integer

아이템 수량입니다.

sku
string

아이템 SKU.

Array of objects

이 트랜잭션에 적용되어 있는 프로모션입니다.

Array
id
integer

프로모션 ID입니다.

technical_name
string

프로모션의 기술명입니다.

object

정기결제 세부 정보(오브젝트).

amount
integer <float>

구매 금액입니다.

currency
string

통화. ISO 4217에 따른 3자리 통화 코드입니다.

date_create
string

정기결제 생성 날짜입니다. ISO 8601에 따른 날짜 및 시간입니다.

date_next_charge
string

다음 충전 날짜입니다. ISO 8601에 따른 날짜 및 시간입니다.

plan_id
string

요금제 ID(API를 통해 생성된 경우, 외부 ID).

product_id
string

상품 ID(액세스 토큰으로 보낸 경우)입니다.

subscription_id
integer

엑솔라 시스템 내의 정기결제 ID입니다.

tags
Array of strings

플랜 태그.

object

사용자 정의 프로젝트 설정(개체)입니다.

merchant_id
integer

판매자 ID입니다.

project_id
integer

프로젝트 ID. 이 매개 변수는 관리자 페이지의 프로젝트 이름 옆에서 확인할 수 있습니다.

object

사용자 세부 사항(개체)입니다.

id
required
string

사용자 ID.

country
string

사용자의 국가. ISO 3166-1 alpha-2 standard에 따른 2자로 된 국가 코드를 사용합니다.

email
string

사용자 이메일.

ip
string

유저 IP 주소입니다.

name
string

사용자 이름.

phone
string

유저 전화 번호입니다(국제 형식).

zip
string

우편번호.

Responses
204

성공적인 처리 표시를 반환합니다.

400

제공된 정보에 오류가 있는 경우 반환됩니다(예: 필수 매개변수 누락, 인증 실패 등). 이 경우 사용자의 돈은 인출되지만 구매는 실패합니다. 환불을 진행하려면 support@xsolla.com으로 엑솔라 고객 지원에 문의해 주세요.

500

서버에 일시적인 오류가 있음을 표시하려면 돌아가세요.

Request samples
curl -v 'https://your.hostname/your/uri' \
-X POST \
-d '{
    "notification_type": "payment",
    "settings": {
      "project_id": 18404,
      "merchant_id": 2340
    },
    "purchase": {
        "subscription": {
            "plan_id": "b5dac9c8",
            "subscription_id": "10",
            "product_id": "Demo Product",
            "date_create": "2014-09-22T19:25:25+04:00",
            "date_next_charge": "2014-10-22T19:25:25+04:00",
            "currency": "USD",
            "amount": 9.99
        },
        "checkout": {
            "currency": "USD",
            "amount": 50
        },
        "total": {
            "currency": "USD",
            "amount": 200
        },
        "promotions": [{
            "technical_name": "Demo Promotion",
            "id": 853
        }],
        "coupon": {
            "coupon_code": "ICvj45S4FUOyy",
            "campaign_code": "1507"
        },
        "order": {
          "id": 1234
          "lineitems": [
          {
            "sku": "test_1",
            "quantity": 1,
            "price": {
              "currency": "EUR",
              "amount": 6.5
              }
          }
          ]
          }
    },
    "user": {
        "ip": "127.0.0.1",
        "phone": "18777976552",
        "email": "email@example.com",
        "id": "1234567",
        "name": "John Smith",
        "country": "US"
    },
    "transaction": {
        "id": 1,
        "external_id": 1,
        "payment_date": "2014-09-24T20:38:16+04:00",
        "payment_method": 1,
        "payment_method_name": "PayPal",
        "payment_method_order_id": 1234567890123456789,
        "dry_run": 1,
        "agreement": 1
    },
    "payment_details": {
        "payment": {
            "currency": "USD",
            "amount": 230
        },
        "vat": {
            "currency": "USD",
            "amount": 0,
            "percent": 20
        },
        "sales_tax": {
            "currency": "USD",
            "amount": 0,
            "percent": 0
        },
        "direct_wht": {
            "currency": "USD",
            "amount": 0,
            "percent": 0
        },
        "payout_currency_rate": "1",
        "payout": {
            "currency": "USD",
            "amount": 200
        },
        "xsolla_fee": {
            "currency": "USD",
            "amount": 10
        },
        "payment_method_fee": {
            "currency": "USD",
            "amount": 20
        },
        "repatriation_commission": {
            "currency": "USD",
            "amount": "10"
        }
    },
    "custom_parameters": {
        "parameter1": "value1",
        "parameter2": "value2"
    }
}'
Response samples
application/json
{
  • "error": {
    }
}