вернуть оплату по счету

POST 
/invoices/:invoice_id/refunds

создать возврат

Request

Path Parameters

invoice_id uuidrequired

внутренний номер инвойса

application/json

Body

amount floatrequired

Possible values: >= 1

сумма к возврату в валюте счета

reason string

причина возврата

refund_ext_id string

идентификатор возврата во внешней системе

split_data

object[]

данные о возврате по сплитованному платежу

Array [

order_id string

Possible values: <= 64 characters

номер заказа на стороне поставщика

amount floatrequired

Possible values: >= 1

сумма к возврату в валюте

comment string

Possible values: non-empty and <= 128 characters

комментарий

merchant_id stringrequired

идентификатор участника сплита

]

Responses

201

Created

application/json

Schema

Schema

decline_code decline codes (string)

Possible values: [insufficient_funds, unknown_error_code, operation_declined, foreign_card_operation_is_unavailable, payment_is_blocked, payment_is_blocked_as_potential_fraud, payment_declined, 3ds_authorisation_error, limit_exceeded, card_has_expired, invalid_card_number]

message string

описание результата, стоит обращать внимание при ошибке

info string
id uuidrequired

uuid сущности

created_at date-timerequired

время создания

status stringrequired

Possible values: [progress]

статус сущности

amount floatrequired

Possible values: >= 1

сумма к возврату в валюте

reason string

причина возврата

refund_ext_id string

идентификатор возврата во внешней системе

split_data

object[]

данные о возврате по сплитованному платежу

Array [

order_id string

Possible values: <= 64 characters

номер заказа на стороне поставщика

amount floatrequired

Possible values: >= 1

сумма к возврату в валюте

comment string

Possible values: non-empty and <= 128 characters

комментарий

merchant_id stringrequired

идентификатор участника сплита

]

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_at": "2024-08-06T11:28:58.915Z",
  "status": "progress",
  "amount": 100,
  "reason": "бракованный товар",
  "refund_ext_id": "string",
  "split_data": [
    {
      "order_id": "my-order-01",
      "amount": 100,
      "comment": "возврат части заказа #123",
      "merchant_id": "12345"
    }
  ],
  "decline_code": "insufficient_funds",
  "message": "string",
  "info": "string"
}

In Progress

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2019-08-24T14:15:22Z",
  "status": "progress",
  "amount": 100,
  "reason": "Заявление на возврат #23 от 10.01.2020"
}

400

Bad Request

application/json

Schema

Schema

error_code error codes (string)required

Possible values: [internal_server_error, too_many_requests, request_is_not_valid, invalid_token, no_permissions, unauthorized, bad_request, not_found, reference_not_found, duplicate, not_unique, not_null_or_unique, not_allowed, not_allowed_for_archived, try_later, operation_cannot_be_performed, wrong_service_id_or_api_key, missing_required_request_parameter, resource_not_found, invalid_parameter_value, unknown_error_code]

message string
status string

Example (from schema)

{
  "error_code": "internal_server_error",
  "message": "string",
  "status": "string"
}

BadRequest

{
  "code": "missing_required_request_parameter",
  "message": "Отсутствует обязательный параметр запроса"
}

InvalidParameterValue

{
  "code": "invalid_parameter_value",
  "message": "Некорректный параметр запроса"
}

401

Unauthorized

application/json

Schema

Schema

error_code error codes (string)required

Possible values: [internal_server_error, too_many_requests, request_is_not_valid, invalid_token, no_permissions, unauthorized, bad_request, not_found, reference_not_found, duplicate, not_unique, not_null_or_unique, not_allowed, not_allowed_for_archived, try_later, operation_cannot_be_performed, wrong_service_id_or_api_key, missing_required_request_parameter, resource_not_found, invalid_parameter_value, unknown_error_code]

message string
status string

Example (from schema)

{
  "error_code": "internal_server_error",
  "message": "string",
  "status": "string"
}

Unauthorized

{
  "code": "unauthorized",
  "message": "Ошибка аутентификации"
}

404

Not Found

application/json

Schema

Schema

error_code error codes (string)required

Possible values: [internal_server_error, too_many_requests, request_is_not_valid, invalid_token, no_permissions, unauthorized, bad_request, not_found, reference_not_found, duplicate, not_unique, not_null_or_unique, not_allowed, not_allowed_for_archived, try_later, operation_cannot_be_performed, wrong_service_id_or_api_key, missing_required_request_parameter, resource_not_found, invalid_parameter_value, unknown_error_code]

message string
status string

Example (from schema)

{
  "error_code": "internal_server_error",
  "message": "string",
  "status": "string"
}

NotFound

{
  "code": "resource_not_found",
  "message": "Запрашиваемая информация не найдена"
}

429

Too Many Requests

application/json

Schema

Schema

error_code error codes (string)required

Possible values: [internal_server_error, too_many_requests, request_is_not_valid, invalid_token, no_permissions, unauthorized, bad_request, not_found, reference_not_found, duplicate, not_unique, not_null_or_unique, not_allowed, not_allowed_for_archived, try_later, operation_cannot_be_performed, wrong_service_id_or_api_key, missing_required_request_parameter, resource_not_found, invalid_parameter_value, unknown_error_code]

message string
status string

Example (from schema)

{
  "error_code": "internal_server_error",
  "message": "string",
  "status": "string"
}

Too Many Requests

{
  "code": "too_many_requests",
  "message": "Превышено ограничение на количество запросов в секунду"
}

498

Invalid Token

application/json

Schema

Schema

error_code error codes (string)required

Possible values: [internal_server_error, too_many_requests, request_is_not_valid, invalid_token, no_permissions, unauthorized, bad_request, not_found, reference_not_found, duplicate, not_unique, not_null_or_unique, not_allowed, not_allowed_for_archived, try_later, operation_cannot_be_performed, wrong_service_id_or_api_key, missing_required_request_parameter, resource_not_found, invalid_parameter_value, unknown_error_code]

message string
status string

Example (from schema)

{
  "error_code": "internal_server_error",
  "message": "string",
  "status": "string"
}

Bad Invoice Id

{
  "code": "invalid_token",
  "message": "Ошибка JWT Token. Вы не можете проводить операцию для этого invoice_id",
  "info": "Invoice in JWT token doesn't match invoice from URL"
}

No Service Id

{
  "code": "invalid_token",
  "message": "Ошибка JWT Token. Идентификатор service_id в теле токена не может быть пустым",
  "info": "JWT token must contain service_id"
}

Loading...