Versions Compared

Version Old Version 4 New Version Current
Changes made by

오숙영Jenny Oh

송훈일Neil

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • 채널에서 발생한 환불에 대해 AX Cloud 에 요청 합니다요청합니다.

  • 미리 정해진 환불 규정에 따라 요청할 수 있습니다.

2) Detail

  • 채널에서 정해진 환불 규정에 따라 진행된 환불 비율 정보를 포함하여 요청 합니다요청합니다.

  • 고유한 채널 코드와 유효한 API Key를 Request Header에 정해진 형식으로 입력해야만 호출 가능합니다.

2. API Spec

1) Request

Endpoint

구현 예정

product environment: https://prod.ax-cloud.com/v1/channel/orders/ticket/{ax_order_code}/tickets/{ticket_code}/refunds}

Method

POST

Description

특정 Product 의 환불을 요청 합니다

채널에서 특정 주문의 환불이 진행된 건에 대해 AX Cloud와 동기화합니다.

Content-Type

application/json

Headers > Authorization

Token {api_key

}

Headers > Channel

Code {channel_code

}

2) Body Parameter

...

Name

Required

Type

Description

price

O

String

  • 구매자에게 환불해준 가격

canceled_datetime

O

Datetime

  • 취소가 발생한 날짜

refunded_datetime

O

Datetime

  • 환불이 완료된 날짜

policy

O

Object

  • 채널의 환불 규정

  • 예시

    • {"0%": "Use date 1일 전부터는 환불 불가",
      "50%": "Use date 3일 전",
      "100%": “Use date 7일 전"}

3) Response

...

Name

Type

Description

status_code

Integer

정상 처리 시 200

Expand
titleStatus Code : 200 Response:
Code Block
4) Error Spec
...
 Expand
titleStatus Code : 403 Cause: 유효하지 않은 API Key
 Code Block
{'detail': '이 작업을 수행할 권한(permission)이 없습니다.'}
 Expand
titleStatus Code : 404 Cause: 유효하지 않은 order_code, ticket_code
 Code Block
{'detail': '찾을 수 없습니다.'}
3. Request Example
1) CURL
...
 Code Block
curl -X 'PATCH' \
  'https://prod.ax-cloud.com/v1/channel/orders/ticket/b9872ed4-12c5-4fb5-ae18-4f39b11ee912/tickets/915c1218-f41c-492b-bb0b-96177ff4d2ee/refunds' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H "Authorization: Token api_key_secret" \
  -d '{ \
  "price": "5000",
  "canceled_datetime": "2021-01-20 21:13:13",
  "refunded_datetime": "2021-01-20 23:24:29",
  "policy": {"0%": "Use date 1일 전부터는 환불 불가", "50%": "Use date 3일 전",  "100%": “Use date 7일 전"}
}'