Skip to content

Commit

Permalink
Removes balances/top_up_margin endpoint since this is not live on the…
Browse files Browse the repository at this point in the history
… back end yet
  • Loading branch information
jonathancouchman committed Jan 23, 2020
1 parent ce5a466 commit bfad504
Showing 1 changed file with 0 additions and 210 deletions.
210 changes: 0 additions & 210 deletions src/reference.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1969,142 +1969,6 @@ paths:
X-Request-Id:
type: string
description: A unique reference for the request.
/balances/top_up_margin:
post:
tags:
- Balances
x-api-group: manage
summary: Top Up Margin Balance
description: >-
Tops up the Margin Balance
operationId: TopUpMarginBalance
consumes:
- multipart/form-data
produces:
- application/json
parameters:
- name: X-Auth-Token
in: header
required: true
type: string
description: Authentication token.
- name: currency
in: formData
required: true
type: string
description: Currency to top up.
- name: amount
in: formData
required: true
type: string
description: Amount to top up.
- name: on_behalf_of
in: formData
required: false
type: string
description: Contact UUID.
responses:
'200':
description: Success.
schema:
$ref: '#/definitions/TopUpMarginBalance'
headers:
X-Request-Id:
type: string
description: A unique reference for the request.
'400':
description: Client error.
x-errors:
- code: currency_is_required
category: currency
message: currency is required
params: ''
- code: currency_is_in_invalid_format
category: currency
message: currency is in invalid format
params: '{ "type" => "currency" }'
- code: amount_is_required
category: amount
message: amount is required
params: ''
- code: amount_type_is_wrong
category: amount
message: amount should be of numeric_greater_than_zero type
params: '{ "type" => "numeric_greater_than_zero" }'
- code: on_behalf_of_self
category: on_behalf_of
message: You cannot act on behalf of your own Contact
params: ''
- code: contact_not_found
category: on_behalf_of
message: Contact was not found for this id
params: ''
- code: on_behalf_of_is_not_valid_uuid
category: on_behalf_of
message: on_behalf_of should be in UUID format
params: ''
schema:
$ref: '#/definitions/TopUpMarginBalanceError'
headers:
X-Request-Id:
type: string
description: A unique reference for the request.
'401':
description: Unauthorized.
x-errors:
- code: invalid_supplied_credentials
category: username
message: Authentication failed with the supplied credentials
params: ''
schema:
$ref: '#/definitions/UnauthorizedError'
headers:
X-Request-Id:
type: string
description: A unique reference for the request.
'429':
description: Too many requests.
x-errors:
- code: too_many_requests
category: base
message: >-
Too many requests have been made to the api. Please refer to the
Developer Center for more information
params: ''
schema:
$ref: '#/definitions/RateLimitError'
headers:
X-Request-Id:
type: string
description: A unique reference for the request.
'500':
description: Internal server error
x-errors:
- code: internal_server_error
category: base
message: Internal server error
params: ''
headers:
X-Request-Id:
type: string
description: A unique reference for the request.
'503':
description: Service is temporary unavailable
x-errors:
- code: service_unavailable
category: base
message: Service is temporary unavailable
params: ''
headers:
X-Request-Id:
type: string
description: A unique reference for the request.
default:
description: Unexpected error.
headers:
X-Request-Id:
type: string
description: A unique reference for the request.
/beneficiaries/find:
get:
tags:
Expand Down Expand Up @@ -19684,80 +19548,6 @@ definitions:
routing_code_value_1: '200605'
routing_code_type_2: ''
routing_code_value_2: ''
TopUpMarginBalance:
type: object
description: Bank Details.
required:
- account_id
- currency
- transferred_amount
- transfer_completed_at
additionalProperties: false
properties:
account_id:
type: string
description: account identifier.
currency:
type: string
description: Currency of transfer.
transferred_amount:
type: string
description: amount of transfer.
transfer_completed_at:
type: string
format: date-time
description: Transfer completion datetime
example:
account_id: 6c046c51-2387-4004-8e87-4bf97102e36d
currency: EUR
transferred_amount: 100.0
transfer_completed_at: '2007-11-19T08:37:48-06:00'
TopUpMarginBalanceError:
type: object
description: >
Client error information for the Top Up Margin Balance
endpoint.
required:
- error_code
- error_messages
properties:
error_code:
type: string
description: A high-level error code for the whole request.
error_messages:
type: object
description: >-
Detailed error information for individual input parameters that failed
validation. Object keys are the names of the invalid input parameters.
Each parameter may have one or more reasons why it failed.
additionalProperties:
type: array
items:
type: object
description: >-
An object that represents one of the reasons why the input
parameter failed.
required:
- code
- message
properties:
code:
type: string
description: >-
A unique code that identifies this error. It can be used for
translations.
message:
type: string
description: An explanation of the error in English.
params:
type: object
default: {}
description: >-
Relevant validation rules that failed. This can be used for
translations.
example:
minlength: 1
maxlength: 255
Transaction:
type: object
description: Transaction.
Expand Down

0 comments on commit bfad504

Please sign in to comment.