openapi: 3.0.3 info: title: PortOne B2b Paymentwall API version: 1.16.0 servers: - url: https://api.portone.io description: 운영환경 서버 tags: - name: Paymentwall paths: /paymentwall/delivery/confirm: post: summary: 페이먼트월 배송 정보 등록 description: '페이먼트월 배송 정보 등록 배송 정보를 페이먼트월에 등록합니다. 등록된 배송 정보는 차지백 발생 시 고객사의 상품 배송 완료 증빙 자료로 활용되므로, 반드시 연동해야 합니다.' operationId: confirmPaymentwallDelivery requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfirmPaymentwallDeliveryBody' required: true responses: '200': description: 성공 응답 content: application/json: schema: $ref: '#/components/schemas/ConfirmPaymentwallDeliveryResponse' x-portone-title: 성공 응답 '400': description: '* `InvalidRequestError`: 요청된 입력 정보가 유효하지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/ConfirmPaymentwallDeliveryError' '401': description: '* `UnauthorizedError`: 인증 정보가 올바르지 않은 경우' content: application/json: schema: $ref: '#/components/schemas/ConfirmPaymentwallDeliveryError' '404': description: '* `PaymentNotFoundError`: 결제 건이 존재하지 않는 경우' content: application/json: schema: $ref: '#/components/schemas/ConfirmPaymentwallDeliveryError' security: - bearerJwt: [] - portOne: [] x-portone-category: pgSpecific x-portone-title: 페이먼트월 배송 정보 등록 x-portone-description: '배송 정보를 페이먼트월에 등록합니다. 등록된 배송 정보는 차지백 발생 시 고객사의 상품 배송 완료 증빙 자료로 활용되므로, 반드시 연동해야 합니다.' x-portone-error: $ref: '#/components/schemas/ConfirmPaymentwallDeliveryError' tags: - Paymentwall components: schemas: PaymentwallDeliveryType: title: 페이먼트월 배송 유형 description: 페이먼트월 배송 유형 type: string enum: - DIGITAL - PHYSICAL x-portone-title: 페이먼트월 배송 유형 x-portone-enum: DIGITAL: title: 디지털 PHYSICAL: title: 실물 ConfirmPaymentwallDeliveryError: title: ConfirmPaymentwallDeliveryError oneOf: - $ref: '#/components/schemas/InvalidRequestError' - $ref: '#/components/schemas/PaymentNotFoundError' - $ref: '#/components/schemas/UnauthorizedError' discriminator: propertyName: type mapping: INVALID_REQUEST: '#/components/schemas/InvalidRequestError' PAYMENT_NOT_FOUND: '#/components/schemas/PaymentNotFoundError' UNAUTHORIZED: '#/components/schemas/UnauthorizedError' InvalidRequestError: title: 요청된 입력 정보가 유효하지 않은 경우 description: '요청된 입력 정보가 유효하지 않은 경우 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.' type: object required: - type properties: type: type: string message: type: string x-portone-title: 요청된 입력 정보가 유효하지 않은 경우 x-portone-description: 허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다. x-portone-status-code: 400 ConfirmPaymentwallDeliveryResponse: title: 페이먼트월 배송 정보 등록 성공 응답 description: 페이먼트월 배송 정보 등록 성공 응답 type: object x-portone-title: 페이먼트월 배송 정보 등록 성공 응답 PaymentwallDeliveryStatus: title: 페이먼트월 배송 상태 description: 페이먼트월 배송 상태 type: string enum: - ORDER_PLACED - ORDER_SHIPPED - DELIVERED x-portone-title: 페이먼트월 배송 상태 x-portone-enum: ORDER_PLACED: title: 주문 접수 ORDER_SHIPPED: title: 배송 중 DELIVERED: title: 배송 완료 Country: title: 국가 description: 국가 type: string enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW x-portone-title: 국가 x-portone-enum: CV: title: Cabo Verde MA: title: Morocco AO: title: Angola VN: title: Viet Nam IN: title: India KW: title: Kuwait ML: title: Mali ID: title: Indonesia JE: title: Jersey HM: title: Heard Island and McDonald Islands EG: title: Egypt BG: title: Bulgaria SG: title: Singapore SV: title: El Salvador BD: title: Bangladesh TC: title: Turks and Caicos Islands (the) TH: title: Thailand AT: title: Austria GQ: title: Equatorial Guinea TR: title: Türkiye HT: title: Haiti UM: title: United States Minor Outlying Islands (the) MH: title: Marshall Islands (the) MY: title: Malaysia RU: title: Russian Federation (the) NI: title: Nicaragua BZ: title: Belize KP: title: Korea (the Democratic People's Republic of) VE: title: Venezuela (Bolivarian Republic of) IL: title: Israel GD: title: Grenada GI: title: Gibraltar TN: title: Tunisia DM: title: Dominica MO: title: Macao PR: title: Puerto Rico NF: title: Norfolk Island TW: title: Taiwan (Province of China) KN: title: Saint Kitts and Nevis PH: title: Philippines (the) WF: title: Wallis and Futuna JO: title: Jordan ME: title: Montenegro ES: title: Spain AZ: title: Azerbaijan MR: title: Mauritania SM: title: San Marino BL: title: Saint Barthélemy PK: title: Pakistan NZ: title: New Zealand GP: title: Guadeloupe NA: title: Namibia JM: title: Jamaica AX: title: Åland Islands CM: title: Cameroon US: title: United States of America (the) GU: title: Guam SB: title: Solomon Islands MV: title: Maldives SI: title: Slovenia CW: title: Curaçao BH: title: Bahrain VG: title: Virgin Islands (British) HK: title: Hong Kong SD: title: Sudan (the) AD: title: Andorra RO: title: Romania LU: title: Luxembourg VC: title: Saint Vincent and the Grenadines FO: title: Faroe Islands (the) GL: title: Greenland BW: title: Botswana CF: title: Central African Republic (the) CI: title: Côte d'Ivoire KG: title: Kyrgyzstan BV: title: Bouvet Island KY: title: Cayman Islands (the) LY: title: Libya MM: title: Myanmar MZ: title: Mozambique IR: title: Iran (Islamic Republic of) EH: title: Western Sahara IQ: title: Iraq BB: title: Barbados SZ: title: Eswatini IE: title: Ireland FK: title: Falkland Islands (the) [Malvinas] NP: title: Nepal BE: title: Belgium AU: title: Australia TZ: title: Tanzania, the United Republic of UY: title: Uruguay SA: title: Saudi Arabia ZW: title: Zimbabwe MD: title: Moldova (the Republic of) HU: title: Hungary PG: title: Papua New Guinea AF: title: Afghanistan MU: title: Mauritius SL: title: Sierra Leone GT: title: Guatemala BO: title: Bolivia (Plurinational State of) TM: title: Turkmenistan NE: title: Niger (the) CL: title: Chile FI: title: Finland MN: title: Mongolia 'NO': title: Norway GG: title: Guernsey EE: title: Estonia KM: title: Comoros (the) LT: title: Lithuania ER: title: Eritrea SH: title: Saint Helena, Ascension and Tristan da Cunha SY: title: Syrian Arab Republic (the) LC: title: Saint Lucia CC: title: Cocos (Keeling) Islands (the) PL: title: Poland CH: title: Switzerland ST: title: Sao Tome and Principe NG: title: Nigeria TF: title: French Southern Territories (the) KI: title: Kiribati LV: title: Latvia UG: title: Uganda CY: title: Cyprus MW: title: Malawi CG: title: Congo (the) MF: title: Saint Martin (French part) PM: title: Saint Pierre and Miquelon IS: title: Iceland BI: title: Burundi TK: title: Tokelau SE: title: Sweden AE: title: United Arab Emirates (the) KZ: title: Kazakhstan LB: title: Lebanon AR: title: Argentina GS: title: South Georgia and the South Sandwich Islands BF: title: Burkina Faso DJ: title: Djibouti BA: title: Bosnia and Herzegovina SJ: title: Svalbard and Jan Mayen FR: title: France GM: title: Gambia (the) HR: title: Croatia BS: title: Bahamas (the) RS: title: Serbia WS: title: Samoa GB: title: United Kingdom of Great Britain and Northern Ireland (the) LS: title: Lesotho UZ: title: Uzbekistan PF: title: French Polynesia AG: title: Antigua and Barbuda GW: title: Guinea-Bissau FJ: title: Fiji CO: title: Colombia ZM: title: Zambia AQ: title: Antarctica GF: title: French Guiana NU: title: Niue BN: title: Brunei Darussalam RW: title: Rwanda PT: title: Portugal SO: title: Somalia MT: title: Malta PW: title: Palau KH: title: Cambodia SX: title: Sint Maarten (Dutch part) TJ: title: Tajikistan KR: title: Korea (the Republic of) SS: title: South Sudan PY: title: Paraguay AM: title: Armenia MC: title: Monaco CX: title: Christmas Island TT: title: Trinidad and Tobago UA: title: Ukraine LI: title: Liechtenstein BR: title: Brazil PA: title: Panama MQ: title: Martinique NR: title: Nauru PN: title: Pitcairn GA: title: Gabon TG: title: Togo FM: title: Micronesia (Federated States of) GN: title: Guinea YT: title: Mayotte CD: title: Congo (the Democratic Republic of the) MG: title: Madagascar AI: title: Anguilla YE: title: Yemen HN: title: Honduras IT: title: Italy RE: title: Réunion DO: title: Dominican Republic (the) IO: title: British Indian Ocean Territory (the) GR: title: Greece AS: title: American Samoa ZA: title: South Africa GY: title: Guyana BY: title: Belarus LK: title: Sri Lanka BT: title: Bhutan OM: title: Oman CK: title: Cook Islands (the) KE: title: Kenya CZ: title: Czechia GH: title: Ghana MX: title: Mexico SK: title: Slovakia MK: title: North Macedonia DZ: title: Algeria QA: title: Qatar CU: title: Cuba BJ: title: Benin LA: title: Lao People's Democratic Republic (the) TL: title: Timor-Leste DK: title: Denmark VI: title: Virgin Islands (U.S.) NL: title: Netherlands (Kingdom of the) CA: title: Canada BM: title: Bermuda JP: title: Japan AW: title: Aruba TO: title: Tonga CN: title: China VU: title: Vanuatu AL: title: Albania ET: title: Ethiopia IM: title: Isle of Man SN: title: Senegal PE: title: Peru BQ: title: Bonaire, Sint Eustatius and Saba NC: title: New Caledonia MP: title: Northern Mariana Islands (the) GE: title: Georgia CR: title: Costa Rica VA: title: Holy See (the) PS: title: Palestine, State of EC: title: Ecuador TV: title: Tuvalu LR: title: Liberia MS: title: Montserrat TD: title: Chad SC: title: Seychelles DE: title: Germany SR: title: Suriname UnauthorizedError: title: 인증 정보가 올바르지 않은 경우 description: 인증 정보가 올바르지 않은 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 인증 정보가 올바르지 않은 경우 x-portone-status-code: 401 ConfirmPaymentwallDeliveryBody: title: 페이먼트월 배송 정보 등록 입력 정보 description: 페이먼트월 배송 정보 등록 입력 정보 type: object required: - transactionId - deliveryType - deliveryStatus - estimatedDeliveryDatetime - estimatedUpdateDatetime - refundable - details - shippingAddressEmail properties: transactionId: type: string title: 결제 건 포트원 채번 아이디 deliveryType: $ref: '#/components/schemas/PaymentwallDeliveryType' title: 배송 유형 deliveryStatus: $ref: '#/components/schemas/PaymentwallDeliveryStatus' title: 배송 상태 estimatedDeliveryDatetime: type: string format: date-time title: 배송 완료 예상 일시 description: 배송 유형이 DIGITAL인 경우 현재 시각을 입력해도 무방합니다. estimatedUpdateDatetime: type: string format: date-time title: 배송 상태 업데이트 예정 일시 description: 배송 유형이 DIGITAL인 경우 현재 시각을 입력해도 무방합니다. reason: type: string title: 상태 변경 사유 refundable: type: boolean title: 환불 가능 여부 details: type: string title: 상세 설명 shippingAddressEmail: type: string title: 고객 이메일 주소 carrierTrackingId: type: string title: 운송장 번호 description: 배송 유형이 PHYSICAL인 경우 필수입니다. carrierType: type: string title: 운송사 이름 description: 배송 유형이 PHYSICAL인 경우 필수입니다. shippingAddressCountry: $ref: '#/components/schemas/Country' title: 수신자 국가 description: 배송 유형이 PHYSICAL인 경우 필수입니다. shippingAddressCity: type: string title: 수신자 도시 description: 배송 유형이 PHYSICAL인 경우 필수입니다. shippingAddressZip: type: string title: 수신자 우편번호 description: 배송 유형이 PHYSICAL인 경우 필수입니다. shippingAddressState: type: string title: 수신자 주 description: 배송 유형이 PHYSICAL인 경우 필수입니다. shippingAddressStreet: type: string title: 수신자 도로명 주소 description: 배송 유형이 PHYSICAL인 경우 필수입니다. shippingAddressPhone: type: string title: 수신자 전화번호 description: 배송 유형이 PHYSICAL인 경우 필수입니다. shippingAddressFirstname: type: string title: 수신자 이름 description: 배송 유형이 PHYSICAL인 경우 필수입니다. shippingAddressLastname: type: string title: 수신자 성 description: 배송 유형이 PHYSICAL인 경우 필수입니다. attachments: type: array items: type: string title: 배송 증빙 첨부 파일 URL 목록 description: 배송 증빙 자료의 URL(이미지 등)을 입력합니다. 증빙 자료를 제공하기 어려운 경우 생략할 수 있습니다. x-portone-title: 페이먼트월 배송 정보 등록 입력 정보 PaymentNotFoundError: title: 결제 건이 존재하지 않는 경우 description: 결제 건이 존재하지 않는 경우 type: object required: - type properties: type: type: string message: type: string x-portone-title: 결제 건이 존재하지 않는 경우 x-portone-status-code: 404 securitySchemes: bearerJwt: type: http description: 'Authorization: Bearer `엑세스 토큰`' scheme: bearer portOne: type: http description: 'Authorization: PortOne `발급된 API 시크릿`' scheme: portone x-portone-categories: - id: payment title: 결제 관련 API description: 결제와 관련된 API 기능을 제공합니다. children: - id: payment.paymentSchedule title: 결제 예약 관련 API description: 결제 예약과 관련된 API 기능을 제공합니다. - id: payment.billingKey title: 빌링키 관련 API description: 빌링키와 관련된 API 기능을 제공합니다. - id: payment.cashReceipt title: 현금 영수증 관련 API description: 현금 영수증과 관련된 API 기능을 제공합니다. - id: payment.promotion title: 프로모션 관련 API description: 프로모션과 관련된 API 기능을 제공합니다. - id: payment.additionalFeature title: 결제 부가기능 관련 API description: 결제 부가기능과 관련된 API 기능을 제공합니다. - id: identityVerification title: 본인인증 관련 API description: 본인인증과 관련된 API 기능을 제공합니다. - id: pgSpecific title: 특정 PG사 관련 API description: 특정 PG사에 국한된 API 기능을 제공합니다. - id: reconciliation title: 대사 서비스 API description: 거래 대사 및 정산 대사 관련 API 기능을 제공합니다. - id: b2b title: 세금계산서 API description: 세금계산서 API 기능을 제공합니다. children: - id: b2b.counterparty title: 거래처 관련 API description: 거래처 관련 API 기능을 제공합니다. - id: b2b.taxInvoice title: 세금계산서 발행 관련 API description: 세금계산서 발행 관련 API 기능을 제공합니다. - id: platform title: 파트너 정산 관련 API description: 파트너 정산 서비스 API 기능을 제공합니다. children: - id: platform.policy title: 정책 관련 API description: 파트너 정산에 적용할 정책에 관한 API 입니다. - id: platform.partner title: 파트너 관련 API description: 파트너 정산에 적용할 파트너에 관한 API 입니다. - id: platform.transfer title: 정산 상세내역 관련 API description: 파트너 정산 서비스의 정산 상세내역과 관련된 API 입니다. - id: platform.account title: 계좌 관련 API description: 파트너 정산 서비스의 계좌와 관련된 API 입니다. - id: platform.partnerSettlement title: 정산 내역 관련 API description: 파트너 정산 서비스의 정산 내역과 관련된 API 입니다. - id: platform.payout title: 지급 내역 관련 API description: 파트너 정산 서비스의 지급 내역과 관련된 API 입니다. - id: platform.bulkPayout title: 일괄 지급 내역 관련 API description: 파트너 정산 서비스의 일괄 지급 내역과 관련된 API 입니다. - id: platform.accountTransfer title: 이체 내역 관련 API description: 파트너 정산 서비스의 이체 내역과 관련된 API 입니다. - id: platform.bulkAccountTransfer title: 일괄 이체 내역 관련 API description: 파트너 정산 서비스의 일괄 이체 내역과 관련된 API 입니다. - id: platform.company title: 사업자 관련 API description: 파트너 정산 서비스의 사업자와 관련된 API 입니다. - id: auth title: 인증 관련 API description: '인증과 관련된 API 기능을 제공합니다. 접근 토큰 방식으로 인증하기를 원하는 경우, API 시크릿을 통해 토큰을 발급받은 후 Authorization 헤더에 `Bearer ACCESS_TOKEN` 형식으로 전달합니다.' - id: paymentSession title: 결제 세션 API description: 결제 세션 생성 및 관리 API. 호스티드 체크아웃에 사용됩니다. - id: checkoutProfile title: 체크아웃 프로필 API description: 체크아웃 프로필에서 결제 수단 목록을 조회하기 위한 API. - id: ap title: AP API description: AP 기능을 제공합니다. - id: common title: 공통 API description: 공통 API 기능을 제공합니다.