결제

결제Webhook POST

게임유저가 결제 프로세스를 완료할 때마다 트랜잭션 세부 사항을 결제 알림 스크립트에 보냅니다.

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 으로 이메일을 보내주시기 바랍니다.

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 엑솔라 시스템 내의 게임 식별자입니다. 판매자 계정 에서 확인할 수 있습니다.

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

Payload
CURL
PHP
HTTP

application/json

{"custom_parameters": { },
"notification_type": "string",
"payment_details": {"direct_wht": {"amount": 0,
"currency": "string",
"percent": 0
},
"payment": {"amount": 0,
"currency": "string"
},
"payment_method_fee": {"amount": 0,
"currency": "string"
},
"payment_method_sum": {"amount": 0,
"currency": "string"
},
"payout": {"amount": 0,
"currency": "string"
},
"payout_currency_rate": "string",
"repatriation_commission": {"amount": 0,
"currency": "string"
},
"sales_tax": {"amount": 0,
"currency": "string",
"percent": 0
},
"vat": {"amount": 0,
"currency": "string",
"percent": 0
},
"xsolla_balance_sum": {"amount": 0,
"currency": "string"
},
"xsolla_fee": {"amount": 0,
"currency": "string"
}
},
"purchase": {"checkout": {"amount": 0,
"currency": "string"
},
"coupon": {"campaign_code": "string",
"coupon_code": "string"
},
"gift": {"giver_id": "string",
"hide_giver_from_receiver": "string",
"message": "string",
"receiver_email": "string",
"receiver_id": "string"
},
"order": {"id": 0,
"lineitems": {"price": {"amount": null,
"currency": "string"
},
"quantity": 0,
"sku": "string"
}
},
"promotions": [{"id": 0,
"technical_name": "string"
}
],
"subscription": {"amount": 0,
"currency": "string",
"date_create": "string",
"date_next_charge": "string",
"plan_id": "string",
"product_id": "string",
"subscription_id": 0,
"tags": ["string"
]
},
"total": {"amount": 0,
"currency": "string"
}
},
"settings": {"merchant_id": 0,
"project_id": 0
},
"transaction": {"agreement": 0,
"dry_run": 0,
"external_id": "string",
"id": 0,
"payment_date": "string",
"payment_method": 0,
"payment_method_name": "string",
"payment_method_order_id": "string"
},
"user": {"country": "string",
"email": "string",
"id": "string",
"ip": "string",
"name": "string",
"phone": "string",
"zip": "string"
}
}

Response samples

application/json

{"error": {"code": "INCORRECT_AMOUNT",
"message": "Incorrect amount"
}
}