OK.
Pay Station API (2.0)
- 버전: 2.0.0
- 서버:
https://api.xsolla.com/api
페이 스테이션을 통해 파트너가 사용자에게 게임 스토어에서 인게임 구매를 결제하도록 돕는 편리한 UI를 제공하고 수익을 창출할 수 있습니다. 결제 UI를 열도록 설정하려면 다음 지침을 참조해 주세요.
페이 스테이션 API는 다음과 같은 호출 그룹을 제공합니다.
- 토큰 - 결제 UI를 통해 추후 결제 처리에 사용하는 임의 사용자 매개 변수로 토큰을 생성하는 API 호출을 포함합니다.
- 토큰화 - 결제 UI를 열지 않고 사용자의 개입이 없어도 안전하게 결제를 처리하는 API 호출을 포함합니다.
- 보고서 - 사용자 트랜잭션 데이터를 반환하고, 보고서를 생성하고, 통화별 지급액 내역을 확인할 수 있는 API 호출을 포함합니다.
- 환불 - 전액 및 부분 환불을 요청하는 API 호출을 포함합니다.
- 테스트 - 지불 거절 프로세스를 테스트하는 API 호출을 포함합니다.
결제 UI 구성에 대한 자세한 정보는 결제 솔루션 연동 가이드에서 확인할 수 있습니다.
참고
또한 포스트맨 컬렉션의 Xsolla Base API 섹션을 참조하여 연동에 사용되는 API 호출을 테스트할 수 있습니다.
- Mock serverhttps://xsolla.redocly.app/_mock/ko/api/pay-station/merchants/{merchant_id}/reports
- https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/reports
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/ko/api/pay-station/merchants/{merchant_id}/reports?datetime_from=2023-02-08&datetime_to=2023-03-08'[ { "agreement_document_id": "Organization Inc_RUB", "currency": "RUB", "is_direct_payout": false, "is_draft_by_agreement": true, "month": "January", "report_id": 57613, "year": 2019 }, { "agreement_document_id": "Organization Inc_EUR", "currency": "USD", "is_direct_payout": false, "is_draft_by_agreement": true, "month": "January", "report_id": 57619, "year": 2019 } ]
기간은 YYYY-MM-DD 형식으로 시작합니다. 다음 매개 변수 중 하나 이상이 전달되는 경우 필요하지 않습니다:
transfer_idreport_id
기간은 YYYY-MM-DD 형식으로 끝납니다. 다음 매개 변수 중 하나 이상이 전달되는 경우 필요하지 않습니다:
transfer_idreport_id
datetime_from와(과) datetime_to 사이의 차이는 92일을 초과할 수 없습니다.모든 재무 데이터를 지급 통화로 변환합니다(기본적으로 지급 통화가 사용됨). 다음 매개 변수 중 하나 이상이 전달되는 경우 필요하지 않습니다:
transfer_idreport_id
머천트 오브 레코드. xsolla 혹은 merchant 이거나 명시되지 않음. merchant인 경우, 파트너의 게이트웨이를 통한 거래를 반환합니다. xsolla인 경우에는, 파트너의 게이트웨이를 거치지 않은 거래를 반환합니다. 명시되지 않은 경우에는, 모든 거래를 반환합니다.
| 열거형 값 | 설명 |
|---|---|
| merchant | 파트너의 게이트웨이를 통한 거래를 반환합니다. |
| xsolla | 파트너의 게이트웨이를 거치지 않은 거래를 반환합니다. |
- Mock serverhttps://xsolla.redocly.app/_mock/ko/api/pay-station/merchants/{merchant_id}/reports/transactions/registry.{format}
- https://api.xsolla.com/merchant/v3/merchants/{merchant_id}/reports/transactions/registry.{format}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/ko/api/pay-station/merchants/{merchant_id}/reports/transactions/registry.{format}?datetime_from=2023-02-08&datetime_to=2023-03-08&in_transfer_currency=0&show_total=true&merchant_of_records=xsolla&project_id=0&show_dry_run=true&transfer_id=0&report_id=0&offset=0&limit=0&status=done'[ { "payment_details": { … }, "purchase": { … }, "transaction": { … }, "user": { … }, "user_balance": { … } } ]
요청
특정 검색 매개 변수를 기준으로 트랜잭션 목록을 반환합니다. 이에 대한 응답으로 성공적으로 완료되지 않았더라도 게임에서 이루어진 모든 결제에 대한 데이터를 얻을 수 있습니다. 트랜잭션 기간뿐만 아니라 특정 사용자 또는 특정 결제 상태의 거래를 검색하는 등 다른 매개 변수도 지정할 수 있습니다. JSON 또는 CSV 형식으로 목록을 가져올 수 있습니다.
주의
이 API 호출에는 project_id 경로 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 인증을 설정해야 합니다.
검색 결과에 표시되는 거래 유형:
| 열거형 값 | 설명 |
|---|---|
| all | 모든 거래. |
| canceled | 취소된 거래(테스트 거래 제외). |
| test | 테스트 거래. |
| transferred | 성공한 거래(테스트 거래 제외). |
귀하 측에 저장된 게임 내 고유 사용자 ID입니다. 기존 사용자 ID여야 합니다. 오류가 발생하면 자주 묻는 질문에 대한 답변을 참조해 주세요.
트랜잭션 상태입니다.
| 열거형 값 | 설명 |
|---|---|
| awaitingRefund | 트랜잭션 환불 결정을 기다리고 있습니다. 사용자가 환불을 요청하면 엑솔라 고객 지원팀에서 요청을 수동으로 처리하고 환불을 결정합니다. |
| canceled | 가능한 사례는 다음과 같습니다.
|
| created | 사용자가 트랜잭션을 시작했지만 아직 처리되지 않았습니다. |
| done | 트랜잭션을 성공적으로 처리했습니다. |
| error | 트랜잭션을 처리하는 동안 오류가 발생했습니다. 오류가 발생한 결제 금액은 엑솔라 고객 지원팀에 연락하여 환불받을 수 있습니다. |
| partiallyRefunded | 사용자가 부분 환불을 받았습니다. |
| processing | 트랜잭션을 처리하고 있습니다. |
| refunded | 사용자의 엑솔라 잔액으로 환불이 이루어졌습니다. |
| review | 부정 결제 방지 시스템에 의해 트랜잭션 처리가 일시 중지되었으며 현재 추가로 거래를 확인하고 있습니다. |
- Mock serverhttps://xsolla.redocly.app/_mock/ko/api/pay-station/merchants/{merchant_id}/reports/transactions/search.{format}
- https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/reports/transactions/search.{format}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/ko/api/pay-station/merchants/{merchant_id}/reports/transactions/search.{format}?datetime_from=string&datetime_to=string&project_id=0&transaction_id=0&type=all&phone=string&user_id=string&user_name=string&user_custom=string&email=string&external_id=string&order_id=1234&offset=0&limit=0&status=created'[ { "payment_details": { … }, "payment_system": { … }, "purchase": { … }, "transaction": { … }, "user": { … } } ]
요청
몇 초 내에 특정 검색 매개변수를 기반으로 트랜잭션 목록을 구합니다. 이는 모든 트랜잭션 검색 API 호출을 대체할 수 있는 기능으로 JSON, CSV 또는 XLS 형식으로 데이터를 반환합니다.
주의
이 API 호출에는 project_id 경로 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 인증을 설정해야 합니다.
- Mock serverhttps://xsolla.redocly.app/_mock/ko/api/pay-station/merchants/{merchant_id}/reports/transactions/simple_search
- https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/reports/transactions/simple_search
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/ko/api/pay-station/merchants/{merchant_id}/reports/transactions/simple_search?transaction_id=0&external_id=string'[ { "payment_details": { … }, "transaction": { … }, "user": { … } } ]
- Mock serverhttps://xsolla.redocly.app/_mock/ko/api/pay-station/merchants/{merchant_id}/reports/transactions/summary/transfer
- https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/reports/transactions/summary/transfer
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/ko/api/pay-station/merchants/{merchant_id}/reports/transactions/summary/transfer?datetime_from=string&datetime_to=string&legal_entity_id=0&status=done'[ { "DirectTaxesOfPayments": 0.46, "IsoCurrency": "RUB", "PaymentsAmount": 223679.84, "SumCommissionAgent": 11329.58, "SumCommissionUserTaxes": 153.67, "SumItems": 571325.13, "SumNominalSum": 214792.98, "SumOutProject": 551096.13, "SumPayoutSum": 193316.71, "TaxesOfPayments": 171.56 }, { "DirectTaxesOfPayments": 0.14, "IsoCurrency": "USD", "PaymentsAmount": 482.58, "SumCommissionAgent": 77.51, "SumCommissionUserTaxes": 0.07, "SumItems": 243777.62, "SumNominalSum": 493.09, "SumOutProject": 241787.62, "SumPayoutSum": 462.62, "TaxesOfPayments": 0.14 }, { "DirectTaxesOfPayments": 0.07, "IsoCurrency": "EUR", "PaymentsAmount": 608.2, "SumCommissionAgent": 55.71, "SumCommissionUserTaxes": 90.94, "SumItems": 156238.62, "SumNominalSum": 607.26, "SumOutProject": 156158.62, "SumPayoutSum": 460.8, "TaxesOfPayments": 90.94 } ]
- Mock serverhttps://xsolla.redocly.app/_mock/ko/api/pay-station/merchants/{merchant_id}/reports/transactions/{transaction_id}/details
- https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/reports/transactions/{transaction_id}/details
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/ko/api/pay-station/merchants/{merchant_id}/reports/transactions/{transaction_id}/details'[ { "customer_details": { … }, "finance_details": { … }, "payment_details": { … }, "subscription_details": { … }, "transaction_details": { … } } ]
- Mock serverhttps://xsolla.redocly.app/_mock/ko/api/pay-station/merchants/{merchant_id}/reports/transfers
- https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/reports/transfers
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/ko/api/pay-station/merchants/{merchant_id}/reports/transfers?datetime_from=string&datetime_to=string&legal_entity_id=0&status=hold'[ { "canceled": 0, "payout": { … }, "rate": 1, "transfer": { … } } ]