정산 내역 조회

GET

/api/core/organization/{organizationId}/settlements

curl --request GET \
  --url https://www.easterad.com/api/core/organization/example/settlements \
  --header 'Authorization: Bearer <token>'

• Production

Authorizations

• bearerAuth

Parameters

Path Parameters

organizationId

required

string

/^[0-9a-fA-F]{24}$/

Query Parameters

after

string

/^[0-9a-fA-F]{24}$/

limit

integer

>= 1 <= 100

Responses

200

성공

Media typeapplication/json

object

settlements

required

Array<object>

object

_id

required

string

recipientOrganizationId

string

delegatedToParentId

string

currency

required

Any of:

string

string

Allowed value: CURRENCY_KRW

string

string

Allowed value: CURRENCY_USD

periodStart

required

string

/^[0-9]{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12][0-9]|3[01])T(?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](?:\.[0-9]{1,9})?(?:Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])$/

periodEnd

required

string

/^[0-9]{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12][0-9]|3[01])T(?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](?:\.[0-9]{1,9})?(?:Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])$/

amountMicros

required

string

organizationAmounts

required

Array<object>

object

organizationId

required

string

amountMicros

required

string

status

required

Any of:

string

string

Allowed value: SETTLEMENT_STATUS_CONFIRMED

string

string

Allowed value: SETTLEMENT_STATUS_PROCESSING

string

string

Allowed value: SETTLEMENT_STATUS_COMPLETED

string

string

Allowed value: SETTLEMENT_STATUS_CANCELLED

method

Any of:

string

string

Allowed value: SETTLEMENT_METHOD_BANK

string

string

Allowed value: SETTLEMENT_METHOD_INTERNAL

account

object

accountOwnerName

required

string

accountBankName

required

string

accountNumber

required

string

confirmedAt

required

string

/^[0-9]{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12][0-9]|3[01])T(?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](?:\.[0-9]{1,9})?(?:Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])$/

confirmedBy

string

processingBy

string

processingAt

string

/^[0-9]{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12][0-9]|3[01])T(?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](?:\.[0-9]{1,9})?(?:Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])$/

completedBy

string

completedAt

string

/^[0-9]{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12][0-9]|3[01])T(?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](?:\.[0-9]{1,9})?(?:Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])$/

paymentReference

string

evidence

string

cancelledBy

string

cancelledAt

string

/^[0-9]{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12][0-9]|3[01])T(?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](?:\.[0-9]{1,9})?(?:Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])$/

cancellationReason

string

nextCursor

string

Example

{
  "settlements": [
    {
      "currency": "CURRENCY_KRW",
      "status": "SETTLEMENT_STATUS_CONFIRMED",
      "method": "SETTLEMENT_METHOD_BANK"
    }
  ]
}

default

오류 — 공통 오류 응답. 인증 단계 오류 코드는 문서의 “인증” 페이지를 참조.

Media typeapplication/json

object

statusCode

required

number

code

required

BadRequest | Unauthorized | Forbidden | NotFound | Conflict | TooManyRequests | InternalServerError | ServiceUnavailable

string

message

required

string

reason

선택 상세 사유. 예: CREATIVE_NOT_READY

string

assetId

관련 소재 ID (선택)

string

authorization

object

reason

required

Any of:

number

number

0

number

number

Allowed value: 1

number

number

Allowed value: 2

condition

required

Any of:

number

number

0

number

number

Allowed value: 1

number

number

Allowed value: 2

permissions

required

Array<object>

object

statement

required

string

label

required

string

Example

{
  "authorization": {
    "reason": 0,
    "condition": 0
  }
}