Skip to content
This repository has been archived by the owner on Jul 20, 2023. It is now read-only.

Latest commit

 

History

History
340 lines (237 loc) · 8.68 KB

GpaOrdersApi.md

File metadata and controls

340 lines (237 loc) · 8.68 KB
Raw

Marqeta::GpaOrdersApi

All URIs are relative to http://localhost/v3

Method HTTP request Description
get_gpaorders_token GET /gpaorders/{token} Returns a GPA order
get_gpaorders_unloads GET /gpaorders/unloads Lists all GPA returns
get_gpaorders_unloads_unloadtoken GET /gpaorders/unloads/{unload_token} Returns a specific GPA return
post_gpaorders POST /gpaorders Funds a user's GPA account
post_gpaorders_unloads POST /gpaorders/unloads Returns a GPA order

get_gpaorders_token

get_gpaorders_token(token)

Returns a GPA order

Examples

require 'time'
require 'marqeta'

api_instance = Marqeta::GpaOrdersApi.new
token = 'token_example' # String | 

begin
  # Returns a GPA order
  result = api_instance.get_gpaorders_token(token)
  p result
rescue Marqeta::ApiError => e
  puts "Error when calling GpaOrdersApi->get_gpaorders_token: #{e}"
end

Using the get_gpaorders_token_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_gpaorders_token_with_http_info(token)

begin
  # Returns a GPA order
  data, status_code, headers = api_instance.get_gpaorders_token_with_http_info(token)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <GpaResponse>
rescue Marqeta::ApiError => e
  puts "Error when calling GpaOrdersApi->get_gpaorders_token_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
token String

Return type

GpaResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_gpaorders_unloads

get_gpaorders_unloads(opts)

Lists all GPA returns

Examples

require 'time'
require 'marqeta'

api_instance = Marqeta::GpaOrdersApi.new
opts = {
  count: 56, # Integer | Number of GPA unloads to retrieve
  start_index: 56, # Integer | Start index
  fields: 'fields_example', # String | Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields.
  sort_by: 'sort_by_example', # String | Sort order
  user_token: 'user_token_example', # String | User token
  business_token: 'business_token_example', # String | Business token
  original_order_token: 'original_order_token_example' # String | Original order token
}

begin
  # Lists all GPA returns
  result = api_instance.get_gpaorders_unloads(opts)
  p result
rescue Marqeta::ApiError => e
  puts "Error when calling GpaOrdersApi->get_gpaorders_unloads: #{e}"
end

Using the get_gpaorders_unloads_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_gpaorders_unloads_with_http_info(opts)

begin
  # Lists all GPA returns
  data, status_code, headers = api_instance.get_gpaorders_unloads_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <GPAUnloadListResponse>
rescue Marqeta::ApiError => e
  puts "Error when calling GpaOrdersApi->get_gpaorders_unloads_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
count Integer Number of GPA unloads to retrieve [optional][default to 5]
start_index Integer Start index [optional][default to 0]
fields String Comma-delimited list of fields to return (e.g. field_1,field_2,..). Leave blank to return all fields. [optional]
sort_by String Sort order [optional][default to '-lastModifiedTime']
user_token String User token [optional]
business_token String Business token [optional]
original_order_token String Original order token [optional]

Return type

GPAUnloadListResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_gpaorders_unloads_unloadtoken

get_gpaorders_unloads_unloadtoken(unload_token)

Returns a specific GPA return

Examples

require 'time'
require 'marqeta'

api_instance = Marqeta::GpaOrdersApi.new
unload_token = 'unload_token_example' # String | Unload token

begin
  # Returns a specific GPA return
  result = api_instance.get_gpaorders_unloads_unloadtoken(unload_token)
  p result
rescue Marqeta::ApiError => e
  puts "Error when calling GpaOrdersApi->get_gpaorders_unloads_unloadtoken: #{e}"
end

Using the get_gpaorders_unloads_unloadtoken_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_gpaorders_unloads_unloadtoken_with_http_info(unload_token)

begin
  # Returns a specific GPA return
  data, status_code, headers = api_instance.get_gpaorders_unloads_unloadtoken_with_http_info(unload_token)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <GpaReturns>
rescue Marqeta::ApiError => e
  puts "Error when calling GpaOrdersApi->get_gpaorders_unloads_unloadtoken_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
unload_token String Unload token

Return type

GpaReturns

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

post_gpaorders

post_gpaorders(opts)

Funds a user's GPA account

Examples

require 'time'
require 'marqeta'

api_instance = Marqeta::GpaOrdersApi.new
opts = {
  body: Marqeta::GpaRequest.new({amount: 3.56, currency_code: 'currency_code_example', funding_source_token: 'funding_source_token_example'}) # GpaRequest | 
}

begin
  # Funds a user's GPA account
  result = api_instance.post_gpaorders(opts)
  p result
rescue Marqeta::ApiError => e
  puts "Error when calling GpaOrdersApi->post_gpaorders: #{e}"
end

Using the post_gpaorders_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> post_gpaorders_with_http_info(opts)

begin
  # Funds a user's GPA account
  data, status_code, headers = api_instance.post_gpaorders_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <GpaResponse>
rescue Marqeta::ApiError => e
  puts "Error when calling GpaOrdersApi->post_gpaorders_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
body GpaRequest [optional]

Return type

GpaResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

post_gpaorders_unloads

post_gpaorders_unloads(opts)

Returns a GPA order

Examples

require 'time'
require 'marqeta'

api_instance = Marqeta::GpaOrdersApi.new
opts = {
  body: Marqeta::UnloadRequestModel.new({original_order_token: 'original_order_token_example', amount: 3.56}) # UnloadRequestModel | 
}

begin
  # Returns a GPA order
  result = api_instance.post_gpaorders_unloads(opts)
  p result
rescue Marqeta::ApiError => e
  puts "Error when calling GpaOrdersApi->post_gpaorders_unloads: #{e}"
end

Using the post_gpaorders_unloads_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> post_gpaorders_unloads_with_http_info(opts)

begin
  # Returns a GPA order
  data, status_code, headers = api_instance.post_gpaorders_unloads_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <GpaReturns>
rescue Marqeta::ApiError => e
  puts "Error when calling GpaOrdersApi->post_gpaorders_unloads_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
body UnloadRequestModel [optional]

Return type

GpaReturns

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json