Getting Started with Beaver
Getting Started
Install the Package
Install the gem from the command line:
gem install apimaticcalculatortest -v 1.0.0
Or add the gem to your Gemfile and run bundle:
gem 'apimaticcalculatortest', '1.0.0'
For additional gem details, see the RubyGems page for the apimaticcalculatortest gem.
Environments
The SDK can be configured to use a different environment for making API calls. Available environments are:
Fields
| Name | Description |
|---|---|
| production | Default POC |
| environment2 | Internal Stage |
| environment3 | External Stage |
| environment4 | Production |
Initialize the API Client
The following parameters are configurable for the API Client:
| Parameter | Type | Description |
|---|---|---|
app_token |
String |
|
environment |
Environment | The API environment. Default: Environment.PRODUCTION |
timeout |
Float |
The value to use for connection timeout. Default: 60 |
max_retries |
Integer |
The number of times to retry an endpoint call if it fails. Default: 0 |
retry_interval |
Float |
Pause in seconds between retries. Default: 1 |
backoff_factor |
Float |
The amount to multiply each successive retry's interval amount by in order to provide backoff. Default: 1 |
The API client can be initialized as follows:
client = Beaver::Client.new(
app_token: 'App-Token',
environment: Environment::PRODUCTION,
)
Authorization
This API uses Custom Header Signature.
Client Class Documentation
Beaver Client
The gateway for the SDK. This class acts as a factory for the Controllers and also holds the configuration of the SDK.
Controllers
| Name | Description |
|---|---|
| api | Gets APIController |
API Reference
List of APIs
API
Overview
Get instance
An instance of the APIController class can be accessed from the API Client.
client_controller = client.client
POST Accounts
The POST /accounts call allows your platform to create a new account owned by a legal entity. The accounts resource allows your platform to create a new merchant account for each distinct business purpose.
def post_accounts(app_id,
app_token,
api_version,
body,
unique_key: nil,
we_pay_risk_token: nil,
client_ip: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
body |
AccountsRequest |
Body, Required | - |
unique_key |
String |
Header, Optional | - |
we_pay_risk_token |
String |
Header, Optional | - |
client_ip |
String |
Header, Optional | - |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
body = AccountsRequest.new
body.description = 'The Foo Bar campaign is raising money for Bar Baz.'
body.incoming_payments = IncomingPaymentsReq.new
body.incoming_payments.opted_out_methods = OptedOutMethods.new
body.incoming_payments.opted_out_methods.countries = CountriesOptedOutMethods.new
body.incoming_payments.opted_out_methods.countries.ca = CountryOptedOutMethods.new
body.incoming_payments.opted_out_methods.countries.ca.debit_cards = true
body.industry = Industry.new
body.industry.category_detail = 'Website design'
body.industry.merchant_category_code = '7333'
body.legal_entity_id = '3cd20b3c-4008-400b-b708-2b844ce7be84'
body.name = 'Foo Bar campaign'
body.payout = PayoutReq.new
body.payout.currencies = Currencies3.new
body.payout.currencies.usd = USD2.new
body.payout.currencies.usd.payout_method_id = '0102b1c6-2bc7-448a-aa1d-076b1637547c'
body.payout.currencies.usd.period = PeriodEnum::DAILY
body.statement_description = 'Thanks for your Foo Bar campaign donation'
result = client_controller.post_accounts(app_id, app_token, api_version, body, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS, UNSUPPORTED_COUNTRY, UNSUPPORTED_CURRENCY | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Accounts
The GET /accounts call allows your platform to look up a collection of accounts. The accounts resource allows your platform to create a new merchant account for each distinct business purpose.
def get_accounts(app_id,
app_token,
api_version,
unique_key: nil,
page: nil,
page_size: 10,
create_time_start: nil,
create_time_end: nil,
owner_id: nil,
beneficiary_legal_entity_id: nil,
reference_id: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
page |
String |
Query, Optional | Return elements starting from this page. If specified, no other query parameters can be specified. |
page_size |
Integer |
Query, Optional | Maximum number of items per page of results. Default: 10Constraints: >= 1, <= 50 |
create_time_start |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the start of the search window, inclusive. |
create_time_end |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the end of the search window, inclusive. |
owner_id |
String |
Query, Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
beneficiary_legal_entity_id |
String |
Query, Optional | Filter search window by elements that match the account's beneficiary legal entity. Constraints: Minimum Length: 1, Maximum Length: 255 |
reference_id |
String |
Query, Optional | Return elements having this reference_id. |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_accounts(app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Accounts-Id
The POST /accounts/id call allows your platform to update and add custom data to an account. The accounts resource allows your platform to create a new merchant account for each distinct business purpose.
def post_accounts_id(id,
app_id,
app_token,
api_version,
body,
unique_key: nil,
we_pay_risk_token: nil,
client_ip: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
body |
AccountsRequest1 |
Body, Required | - |
unique_key |
String |
Header, Optional | - |
we_pay_risk_token |
String |
Header, Optional | - |
client_ip |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
body = AccountsRequest1.new
body.description = 'The Foo Bar campaign is raising money for Bar Baz.'
body.incoming_payments = IncomingPaymentsReq.new
body.incoming_payments.opted_out_methods = OptedOutMethods.new
body.incoming_payments.opted_out_methods.countries = CountriesOptedOutMethods.new
body.incoming_payments.opted_out_methods.countries.ca = CountryOptedOutMethods.new
body.incoming_payments.opted_out_methods.countries.ca.debit_cards = true
body.industry = Industry.new
body.industry.category_detail = 'Website design'
body.industry.merchant_category_code = '7333'
body.name = 'Foo Bar campaign'
body.payout = PayoutReq.new
body.payout.currencies = Currencies3.new
body.payout.currencies.usd = USD2.new
body.payout.currencies.usd.payout_method_id = '0102b1c6-2bc7-448a-aa1d-076b1637547c'
body.payout.currencies.usd.period = PeriodEnum::DAILY
body.payout.default_currency = CurrencyEnum::USD
body.statement_description = 'Thanks for your Foo Bar campaign donation'
result = client_controller.post_accounts_id(id, app_id, app_token, api_version, body, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS, UNSUPPORTED_COUNTRY, UNSUPPORTED_CURRENCY | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 409 | RESOURCE_CONFLICT | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Accounts-Id
The GET /accounts/id call allows your platform to look up a single account. The accounts resource allows your platform to create a new merchant account for each distinct business purpose.
def get_accounts_id(id,
app_id,
app_token,
api_version,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_accounts_id(id, app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 401 | COULD_NOT_AUTHENTICATE | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Accounts-Id-Capabilities
The POST /accounts/id/capabilities call allows your platform to update an account's capabilities. The accounts resource allows your platform to create a new merchant account for each distinct business purpose.
def post_accounts_id_capabilities(id,
app_id,
app_token,
api_version,
body,
unique_key: nil,
is_expanded: true)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
body |
AccountsCapabilitiesRequest |
Body, Required | - |
unique_key |
String |
Header, Optional | - |
is_expanded |
Boolean |
Query, Optional | Return a descriptive response enumerating any unfulfilled requirements. Default: true |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
body = AccountsCapabilitiesRequest.new
body.payouts = Payouts1.new
body.payouts.application_block = ApplicationBlock4.new
body.payouts.application_block.is_blocked = true
body.payouts.application_block.reason = 'This is a sham!'
result = client_controller.post_accounts_id_capabilities(id, app_id, app_token, api_version, body, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Accounts-Id-Capabilities
The GET /accounts/id/capabilities call allows your platform to look up an account's capabilities. The accounts resource allows your platform to create a new merchant account for each distinct business purpose.
def get_accounts_id_capabilities(id,
app_id,
app_token,
api_version,
unique_key: nil,
is_expanded: true)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
is_expanded |
Boolean |
Query, Optional | Return a descriptive response enumerating any unfulfilled requirements. Default: true |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_accounts_id_capabilities(id, app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Adjustments
The GET /adjustments call allows your platform to look up a collection of adjustments. The adjustments resource notifies your platform that WePay made an adjustment to an account.
def get_adjustments(app_id,
app_token,
api_version,
unique_key: nil,
page: nil,
page_size: 10,
create_time_start: nil,
create_time_end: nil,
owner_id: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
page |
String |
Query, Optional | Return elements starting from this page. If specified, no other query parameters can be specified. |
page_size |
Integer |
Query, Optional | Maximum number of items per page of results. Default: 10Constraints: >= 1, <= 50 |
create_time_start |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the start of the search window, inclusive. |
create_time_end |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the end of the search window, inclusive. |
owner_id |
String |
Query, Optional | - |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_adjustments(app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Adjustments-Id
The GET /adjustments/id call allows your platform to look up a single adjustment. The adjustments resource notifies your platform that WePay made an adjustment to an account.
def get_adjustments_id(id,
app_id,
app_token,
api_version,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_adjustments_id(id, app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Adjustments-Id
The POST /adjustments/id call allows your platform to update and add custom data to an adjustment. The adjustments resource notifies your platform that WePay made an adjustment to an account.
def post_adjustments_id(id,
app_id,
app_token,
api_version,
body,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
body |
AdjustmentsRequest |
Body, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
body = AdjustmentsRequest.new
body.custom_data = JSON.parse('{"reference_number":43453}')
result = client_controller.post_adjustments_id(id, app_id, app_token, api_version, body, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Billing Statements
The GET /billing_statements call allows your platform to look up a collection of billing statements. Billing statements provide aggregate transaction amounts for an account in a certain time period.
def get_billing_statements(app_id,
app_token,
api_version,
unique_key: nil,
page: nil,
page_size: 10,
account_id: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
page |
String |
Query, Optional | Return elements starting from this page. If specified, no other query parameters can be specified. |
page_size |
Integer |
Query, Optional | Maximum number of items per page of results. Default: 10Constraints: >= 1, <= 500 |
account_id |
String |
Query, Optional | All billing statements owned by an account. |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_billing_statements(app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Billing Statements-Id
The GET /billing_statements/id call allows your platform to look up a single billing statement. Billing statements provide aggregate transaction amounts for an account in a certain time period.
def get_billing_statements_id(id,
app_id,
app_token,
api_version,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_billing_statements_id(id, app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Billing Statements-Id-Interchange Fees
Look up summaries of interchange fee transactions in a billing statement.
def get_billing_statements_id_interchange_fees(id,
app_id,
app_token,
api_version,
unique_key: nil,
page: nil,
page_size: 10)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
page |
String |
Query, Optional | Return elements starting from this page. If specified, no other query parameters can be specified. |
page_size |
Integer |
Query, Optional | Maximum number of items per page of results. Default: 10Constraints: >= 1, <= 500 |
Response Type
BillingStatementsInterchangeFeesResponse
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_billing_statements_id_interchange_fees(id, app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Billing Statements-Id-Transactions Summary
The GET /billing_statements/id/transactions_summary call allows your platform to look up all transactions in a single billing statement.
def get_billing_statements_id_transactions_summary(id,
app_id,
app_token,
api_version,
unique_key: nil,
page: nil,
page_size: 10)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
page |
String |
Query, Optional | Return elements starting from this page. If specified, no other query parameters can be specified. |
page_size |
Integer |
Query, Optional | Maximum number of items per page of results. Default: 10Constraints: >= 1, <= 500 |
Response Type
BillingStatementsTransactionsSummaryResponse
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_billing_statements_id_transactions_summary(id, app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Disputes
The GET /disputes call allows your platform to look up a collection of disputes. Disputes represent a conflict between a payer and merchant.
def get_disputes(app_id,
app_token,
api_version,
unique_key: nil,
page: nil,
page_size: 10,
create_time_start: nil,
create_time_end: nil,
owner_id: nil,
type: nil,
payment_id: nil,
status: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
page |
String |
Query, Optional | Return elements starting from this page. If specified, no other query parameters can be specified. |
page_size |
Integer |
Query, Optional | Maximum number of items per page of results. Default: 10Constraints: >= 1, <= 50 |
create_time_start |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the start of the search window, inclusive. |
create_time_end |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the end of the search window, inclusive. |
owner_id |
String |
Query, Optional | - |
type |
Type6Enum |
Query, Optional | The type of dispute to filter by |
payment_id |
String |
Query, Optional | - |
status |
Status5Enum |
Query, Optional | - |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_disputes(app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Disputes-Id
The GET /disputes/id call allows your platform to look up a single dispute. Disputes represent a conflict between a payer and merchant.
def get_disputes_id(id,
app_id,
app_token,
api_version,
content_type,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
content_type |
String |
Header, Required | Constraints: Pattern: application/json |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
content_type = 'Content-Type2'
result = client_controller.get_disputes_id(id, app_id, app_token, api_version, content_type, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Disputes-Id
The POST /disputes/id call allows your platform to update and add custom data to a single dispute. Disputes represent a conflict between a payer and merchant.
def post_disputes_id(id,
app_id,
app_token,
api_version,
body,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
body |
DisputesRequest |
Body, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
body = DisputesRequest.new
body.documentation = Documentation1.new
body.documentation.documents = ['docu-abc123', 'docu-efg456', 'docu-hij789']
body.documentation.explanation = 'lorem ipsum dolores umbridge'
result = client_controller.post_disputes_id(id, app_id, app_token, api_version, body, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | DISPUTE_CANNOT_BE_FURTHER_MODIFIED, INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Disputes-Id-Concede
The POST /disputes/id/concede call allows your platform to concede a dispute on behalf of your merchant. Disputes represent a conflict between a payer and merchant.
def post_disputes_id_concede(id,
app_id,
app_token,
api_version,
content_type,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
content_type |
String |
Header, Required | Constraints: Pattern: application/json |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
content_type = 'Content-Type2'
result = client_controller.post_disputes_id_concede(id, app_id, app_token, api_version, content_type, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | DISPUTE_CANNOT_BE_CONCEDED, INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Items
The POST /items call allows your platform to create a new item. Items describe an item or service for sale. For standardized merchandise, an item could be a stock keeping unit (SKU).
def post_items(app_id,
app_token,
api_version,
body,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
body |
ItemReq |
Body, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
body = ItemReq.new
body.account_id = 'd7608b20-fea5-4eb5-bd30-d3f58435e78b'
body.description = 'Classic Iron Anvil'
body.photos = []
body.price = 490
body.product_code = 'XYZ321'
body.product_details = JSON.parse('{"band":"nike"}')
body.product_name = 'Acme Anvil - 100 Lb'
body.rbits = []
body.rbits[0] = EmbeddedRbit.new
body.rbits[0].address = AddressRbit.new
body.rbits[0].address.origin_address = AddressRbits.new
body.rbits[0].address.origin_address.city = 'Sunnyvale'
body.rbits[0].address.origin_address.country = CountryCodeEnum::US
body.rbits[0].address.origin_address.line1 = '20 Main Street'
body.rbits[0].address.origin_address.postal_code = '94085'
body.rbits[0].address.origin_address.region = 'CA'
body.rbits[0].receive_time = 1367958263
body.rbits[0].source = RbitSourceEnum::PARTNER_DATABASE
body.rbits[0].type = RbitTypesEnum::ADDRESS
body.reference_number = 'abc_123456'
body. = ['regular', 'expedited']
body.terms = Terms.new
body.terms.terms_text = 'lorem ipsum...'
body.terms.terms_uri = 'https://example.com/terms_of_service'
body.uri = 'https://example.com/abc_123456'
body.weight = Weight.new
body.weight.units = UnitsEnum::POUNDS
body.weight.weight = 135.76
result = client_controller.post_items(app_id, app_token, api_version, body, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Items
The GET /items call allows your platform to look up a collection of items. Items describe an item or service for sale. For standardized merchandise, an item could be a stock keeping unit (SKU).
def get_items(app_id,
app_token,
api_version,
unique_key: nil,
page: nil,
page_size: 10,
create_time_start: nil,
create_time_end: nil,
reference_number: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
page |
String |
Query, Optional | Return elements starting from this page. If specified, no other query parameters can be specified. |
page_size |
Integer |
Query, Optional | Maximum number of items per page of results. Default: 10Constraints: >= 1, <= 50 |
create_time_start |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the start of the search window, inclusive. |
create_time_end |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the end of the search window, inclusive. |
reference_number |
String |
Query, Optional | Return elements with this reference number. |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_items(app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Items-Id
The GET /items/id call allows your platform to look up a single item. Items describe an item or service for sale. For standardized merchandise, an item could be a stock keeping unit (SKU).
def get_items_id(id,
app_id,
app_token,
api_version,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_items_id(id, app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
DELETE Items-Id
The DELETE /items/id call allows your platform to delete an item. Items describe an item or service for sale. For standardized merchandise, an item could be a stock keeping unit (SKU).
def delete_items_id(id,
app_id,
app_token,
api_version,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.delete_items_id(id, app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Items-Id
The POST /items/id call allows your platform to update and add custom data an item. Items describe an item or service for sale. For standardized merchandise, an item could be a stock keeping unit (SKU).
def post_items_id(id,
app_id,
app_token,
api_version,
body,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
body |
ItemReq |
Body, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
body = ItemReq.new
body.account_id = 'ABC123'
body.description = 'Classic Iron Anvil'
body.photos = []
body.price = 490
body.product_code = 'XYZ321'
body.product_details = JSON.parse('{"band":"nike"}')
body.product_name = 'Acme Anvil - 100 Lb'
body.rbits = []
body.rbits[0] = EmbeddedRbit.new
body.rbits[0].address = AddressRbit.new
body.rbits[0].address.origin_address = AddressRbits.new
body.rbits[0].address.origin_address.city = 'Sunnyvale'
body.rbits[0].address.origin_address.country = CountryCodeEnum::US
body.rbits[0].address.origin_address.line1 = '20 Main Street'
body.rbits[0].address.origin_address.postal_code = '94085'
body.rbits[0].address.origin_address.region = 'CA'
body.rbits[0].receive_time = 1367958263
body.rbits[0].source = RbitSourceEnum::PARTNER_DATABASE
body.rbits[0].type = RbitTypesEnum::ADDRESS
body.reference_number = 'abc_123456'
body. = ['regular', 'expedited']
body.terms = Terms.new
body.terms.terms_text = 'lorem ipsum...'
body.terms.terms_uri = 'https://example.com/terms_of_service'
body.uri = 'https://example.com/abc_123456'
body.weight = Weight.new
body.weight.units = UnitsEnum::POUNDS
body.weight.weight = 135.76
result = client_controller.post_items_id(id, app_id, app_token, api_version, body, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Legal Entities
The POST /legal_entities call allows your platform to create a new legal entity. Onboarding a merchant requires the creation of a legal entity. A legal entity may be a business, individual, nonprofit, etc., and is completely owned by a single partner application. WePay collects information about the legal entity so we can properly underwrite them when provisioning a merchant account.
def post_legal_entities(app_id,
app_token,
api_version,
body,
unique_key: nil,
we_pay_risk_token: nil,
client_ip: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
body |
LegalEntity |
Body, Required | - |
unique_key |
String |
Header, Optional | - |
we_pay_risk_token |
String |
Header, Optional | - |
client_ip |
String |
Header, Optional | - |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
body = LegalEntity.new
body.address = AddressLegalEntitiesNullable.new
body.address.city = 'San Francisco'
body.address.country = CountryCodeEnum::US
body.address.line1 = '123 Fake Street'
body.address.postal_code = '94101'
body.address.region = 'CA'
body.controller = ControllerReq.new
body.controller.address = AddressLegalEntitiesNullable.new
body.controller.address.city = 'Beverly Hills'
body.controller.address.country = CountryCodeEnum::US
body.controller.address.line1 = '456 Nocturn Alley'
body.controller.address.postal_code = '90210'
body.controller.address.region = 'CA'
body.controller.date_of_birth = DateOfBirth.new
body.controller.date_of_birth.day = 1
body.controller.date_of_birth.month = 1
body.controller.date_of_birth.year = 1900
body.controller.email = '[email protected]'
body.controller.name = HumanNameFullNullable.new
body.controller.name.first = 'Foo'
body.controller.name.last = 'Bar'
body.controller.personal_country_info = PersonalCountryInfo.new
body.controller.personal_country_info.us = US.new
body.controller.personal_country_info.us. = '012-34-5678'
body.controller.phone = PhoneLegalEntitiesNullable.new
body.controller.phone.country_code = '+1'
body.controller.phone.phone_number = '5556667777'
body.controller.job_title = 'CFO'
body.country = CountryCodeEnum::US
body.description = 'The Foo Bar Charity is very important.'
body.entity_country_info = EntityCountryInfo.new
body.entity_country_info.us = US4.new
body.entity_country_info.us.employer_identification_number = '123211230'
body.entity_name = 'Foo Bar Charity'
body.primary_url = 'http://www.example.com'
body.terms_of_service = TermsOfService.new
body.terms_of_service.acceptance_time = 1490656130
body.terms_of_service.original_ip = '12.37.161.213'
result = client_controller.post_legal_entities(app_id, app_token, api_version, body, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS, UNSUPPORTED_COUNTRY | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Legal Entities
The GET /legal_entities call allows your platform to look up a collection of legal entities. Onboarding a merchant requires the creation of a legal entity. A legal entity may be a business, individual, nonprofit, etc., and is completely owned by a single partner application. WePay collects information about the legal entity so we can properly underwrite them when provisioning a merchant account.
def get_legal_entities(app_id,
app_token,
api_version,
unique_key: nil,
page: nil,
page_size: 10,
create_time_start: nil,
create_time_end: nil,
reference_id: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
page |
String |
Query, Optional | Return elements starting from this page. If specified, no other query parameters can be specified. |
page_size |
Integer |
Query, Optional | Maximum number of items per page of results. Default: 10Constraints: >= 1, <= 50 |
create_time_start |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the start of the search window, inclusive. |
create_time_end |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the end of the search window, inclusive. |
reference_id |
String |
Query, Optional | Return elements having this reference_id. |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_legal_entities(app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Legal Entities-Id
The POST /legal_entities/id call allows your platform to update and add custom data to a legal entity. Onboarding a merchant requires the creation of a legal entity. A legal entity may be a business, individual, nonprofit, etc., and is completely owned by a single partner application. WePay collects information about the legal entity so we can properly underwrite them when provisioning a merchant account.
def post_legal_entities_id(id,
app_id,
app_token,
api_version,
body,
we_pay_risk_token: nil,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
body |
LegalEntitiesRequest |
Body, Required | - |
we_pay_risk_token |
String |
Header, Optional | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
body = LegalEntitiesRequest.new
body.address = AddressLegalEntitiesNullable.new
body.address.city = 'San Francisco'
body.address.country = CountryCodeEnum::US
body.address.line1 = '123 Fake Street'
body.address.postal_code = '94101'
body.address.region = 'CA'
body.controller = ControllerReq.new
body.controller.address = AddressLegalEntitiesNullable.new
body.controller.address.city = 'Beverly Hills'
body.controller.address.country = CountryCodeEnum::US
body.controller.address.line1 = '456 Nocturn Alley'
body.controller.address.postal_code = '90210'
body.controller.address.region = 'CA'
body.controller.date_of_birth = DateOfBirth.new
body.controller.date_of_birth.day = 1
body.controller.date_of_birth.month = 1
body.controller.date_of_birth.year = 1900
body.controller.email = '[email protected]'
body.controller.name = HumanNameFullNullable.new
body.controller.name.first = 'Foo'
body.controller.name.last = 'Bar'
body.controller.personal_country_info = PersonalCountryInfo.new
body.controller.personal_country_info.us = US.new
body.controller.personal_country_info.us. = '012-34-5678'
body.controller.phone = PhoneLegalEntitiesNullable.new
body.controller.phone.country_code = '+1'
body.controller.phone.phone_number = '5556667777'
body.controller.job_title = 'CFO'
body.description = 'The Foo Bar Charity is very important.'
body.entity_country_info = EntityCountryInfo.new
body.entity_country_info.us = US4.new
body.entity_country_info.us.employer_identification_number = '123211230'
body.entity_name = 'Foo Bar Charity'
body.primary_url = 'http://www.example.com'
result = client_controller.post_legal_entities_id(id, app_id, app_token, api_version, body, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS, UNSUPPORTED_COUNTRY | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 409 | RESOURCE_CONFLICT | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Legal Entities-Id
The GET /legal_entities/id call allows your platform to look up a single legal entity. Onboarding a merchant requires the creation of a legal entity. A legal entity may be a business, individual, nonprofit, etc., and is completely owned by a single partner application. WePay collects information about the legal entity so we can properly underwrite them when provisioning a merchant account.
def get_legal_entities_id(id,
app_id,
app_token,
api_version,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_legal_entities_id(id, app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Legal Entities-Id-Verifications
The POST /legal_entities/id/verifications call allows your platform to add and update documents to help WePay verify the identity of a legal entity. Onboarding a merchant requires the creation of a legal entity. A legal entity may be a business, individual, nonprofit, etc., and is completely owned by a single partner application. WePay collects information about the legal entity so we can properly underwrite them when provisioning a merchant account.
def post_legal_entities_id_verifications(id,
app_id,
app_token,
api_version,
body,
unique_key: nil,
is_expanded: true)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
body |
LegalEntitiesVerificationsRequest |
Body, Required | - |
unique_key |
String |
Header, Optional | - |
is_expanded |
Boolean |
Query, Optional | Return a descriptive response enumerating any unfulfilled requirements. Default: true |
Response Type
LegalEntitiesVerificationsResponse
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
body = LegalEntitiesVerificationsRequest.new
body.controller = Controller.new
body.controller.personal_verification = PersonalVerification.new
body.controller.personal_verification.documents = ['724ec0d3-2eb5-461e-b72d-a15c6b1a9970', '3838d4ba-f497-4b6f-8d22-19b90cec4f23', '242f9ec7-a309-412c-976d-cc84074a508a']
result = client_controller.post_legal_entities_id_verifications(id, app_id, app_token, api_version, body, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS, JSON_PARSE_FAILURE | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 409 | RESOURCE_CONFLICT | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Legal Entities-Id-Verifications
The GET /legal_entities/id/verifications call allows your platform to retrieve the information WePay requires to verify the identity of a legal entity. Onboarding a merchant requires the creation of a legal entity. A legal entity may be a business, individual, nonprofit, etc., and is completely owned by a single partner application. WePay collects information about the legal entity so we can properly underwrite them when provisioning a merchant account.
def get_legal_entities_id_verifications(id,
app_id,
app_token,
api_version,
unique_key: nil,
is_expanded: true,
is_synchronous: false)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
is_expanded |
Boolean |
Query, Optional | Return a descriptive response enumerating any unfulfilled requirements. Default: true |
is_synchronous |
Boolean |
Query, Optional | Delay returning until the legal entity has been assessed for risk, up to X seconds. Default: false |
Response Type
LegalEntitiesVerificationsResponse
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_legal_entities_id_verifications(id, app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Notifications
The GET /notifications call allows your platform to look up a collection of notifications. The notifications resource allows your platform to retrieve details on a specific notification or a collection of notifications. Your platform can utilize notifications to gain insight into WePay’s system, communicate with your users, monitor issues, etc.
def get_notifications(app_id,
app_token,
api_version,
unique_key: nil,
page: nil,
page_size: 10,
object_type: nil,
object_id: nil,
event_time_start: nil,
event_time_end: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
page |
String |
Query, Optional | Return elements starting from this page. If specified, no other query parameters can be specified. |
page_size |
Integer |
Query, Optional | Maximum number of items per page of results. Default: 10Constraints: >= 1, <= 50 |
object_type |
String |
Query, Optional | Scope type of a notification |
object_id |
String |
Query, Optional | Scope id of a notification |
event_time_start |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the start of the search window, inclusive. |
event_time_end |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the end of the search window, inclusive. |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_notifications(app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Notifications-Id
The GET /notifications/id call allows your platform to look up a notification. The notifications resource allows your platform to retrieve details on a specific notification or a collection of notifications. Your platform can utilize notifications to gain insight into WePay’s system, communicate with your users, monitor issues, etc.
def get_notifications_id(id,
app_id,
app_token,
api_version,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_notifications_id(id, app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Notification Preferences
The GET /notification_preferences call allows your platform to look up a collection of notification preferences. Notification preferences allow your platform to subscribe to notifications based on an event topic.
def get_notification_preferences(app_id,
app_token,
api_version,
unique_key: nil,
page: nil,
page_size: 10,
create_time_start: nil,
create_time_end: nil,
type: nil,
status: nil,
topic: nil,
callback_uri: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
page |
String |
Query, Optional | Return elements starting from this page. If specified, no other query parameters can be specified. |
page_size |
Integer |
Query, Optional | Maximum number of items per page of results. Default: 10Constraints: >= 1, <= 50 |
create_time_start |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the start of the search window, inclusive. |
create_time_end |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the end of the search window, inclusive. |
type |
Type27Enum |
Query, Optional | Type of notification preference |
status |
Status20Enum |
Query, Optional | Status of the notification preference |
topic |
TopicEnum |
Query, Optional | Topic of the notification preference to search for. |
callback_uri |
String |
Query, Optional | Callback URI of the notification preference to search for. |
Response Type
NotificationPreferencesResponse
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_notification_preferences(app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Notification Preferences
The POST /notification_preferences call allows your platform to create a new notification preference. Notification preferences allow your platform to subscribe to notifications based on an event topic.
def post_notification_preferences(app_id,
app_token,
api_version,
body,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
body |
NotificationPreferencesRequest |
Body, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
NotificationPreferencesResponse1
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
body = NotificationPreferencesRequest.new
body.callback_uri = 'https://example.com/payments'
body.topic = Topic1Enum::ENUM_PAYMENTSCOMPLETED
result = client_controller.post_notification_preferences(app_id, app_token, api_version, body, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Notification Preferences-Id
The GET /notification_preferences/id call allows your platform to look up a single notification preference. Notification preferences allow your platform to subscribe to notifications based on an event topic.
def get_notification_preferences_id(id,
app_id,
app_token,
api_version,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
NotificationPreferencesResponse2
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_notification_preferences_id(id, app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Notification Preferences-Id
The POST /notification_preferences/id call allows your platform to update a notification preference. Notification preferences allow your platform to subscribe to notifications based on an event topic.
def post_notification_preferences_id(id,
app_id,
app_token,
api_version,
body,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
body |
NotificationPreferencesRequest1 |
Body, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
NotificationPreferencesResponse1
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
body = NotificationPreferencesRequest1.new
body.callback_uri = 'https://example.com'
result = client_controller.post_notification_preferences_id(id, app_id, app_token, api_version, body, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
DELETE Notification Preferences-Id
The DELETE /notification_preferences/id call allows your platform to delete a notification preference. Notification preferences allow your platform to subscribe to notifications based on an event topic.
def delete_notification_preferences_id(id,
app_id,
app_token,
api_version,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
NotificationPreferencesResponse1
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.delete_notification_preferences_id(id, app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS, RESOURCE_PREVIOUSLY_DELETED | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Orders
The POST /orders call allows your platform to create a new order. Orders identify both the merchant and payer, and describe items sold, shipment date, prices, delivery details, and payment terms.
def post_orders(app_id,
app_token,
api_version,
body,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
body |
OrderReq |
Body, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
body = OrderReq.new
body.account_id = 'd7608b20-fea5-4eb5-bd30-d3f58435e78b'
body.alternate_tax_amount = 35
body.alternate_tax_id = '11'
body.buyer = Buyer.new
body.buyer.legal_entity_id = '1490656130'
body.buyer.type = Type12Enum::LEGAL_ENTITY_ID
body.customer_reference_number = 'cust# 1234'
body.delivery_type = DeliveryTypeEnum::POINT_OF_SALE
body.discount_amount = 0
body.duty_amount = 0
body.freight_amount = 0
body.grand_total_amount = 1000
body.line_items = []
body.line_items[0] = LineItem1.new
body.line_items[0].commodity_code = 'ABC123'
body.line_items[0].currency = CurrencyEnum::USD
body.line_items[0].description = 'Classic Iron Anvil'
body.line_items[0].discount_amount = 0
body.line_items[0].item = ItemNullableReq.new
body.line_items[0].item.account_id = 'd7608b20-fea5-4eb5-bd30-d3f58435e78b'
body.line_items[0].item.description = 'Classic Iron Anvil'
body.line_items[0].item.photos = []
body.line_items[0].item.price = 490
body.line_items[0].item.product_code = 'XYZ321'
body.line_items[0].item.product_details = JSON.parse('{"band":"nike"}')
body.line_items[0].item.product_name = 'Acme Anvil - 100 Lb'
body.line_items[0].item.reference_number = 'abc_123456'
body.line_items[0].item. = ['regular', 'expedited']
body.line_items[0].item.terms = Terms.new
body.line_items[0].item.terms.terms_text = 'lorem ipsum...'
body.line_items[0].item.terms.terms_uri = 'https://example.com/terms_of_service'
body.line_items[0].item.uri = 'https://example.com/abc_123456'
body.line_items[0].item.weight = Weight.new
body.line_items[0].item.weight.units = UnitsEnum::POUNDS
body.line_items[0].item.weight.weight = 71.77
body.line_items[0].quantity = 1
body.line_items[0].tax_amount = 5
body.line_items[0].tax_rate = 1.99
body.line_items[0].tax_type_applied = 'VAT'
body.line_items[0].total_amount = 500
body.line_items[0].unit_of_measure = 'count'
body.line_items[0].unit_price = 490
body.line_items[1] = LineItem1.new
body.line_items[1].commodity_code = 'XYZ999'
body.line_items[1].currency = CurrencyEnum::USD
body.line_items[1].description = 'Classic Catapult'
body.line_items[1].discount_amount = 0
body.line_items[1].item = ItemNullableReq.new
body.line_items[1].item.account_id = 'd7608b20-fea5-4eb5-bd30-d3f58435e78b'
body.line_items[1].item.description = 'Classic Catapult'
body.line_items[1].item.photos = ['http://imgur.com/o4Qk0AF']
body.line_items[1].item.price = 490
body.line_items[1].item.product_code = 'AAAXYZ321'
body.line_items[1].item.product_name = 'Acme Catapult'
body.line_items[1].item.reference_number = 'abc_654321'
body.line_items[1].item. = ['regular', 'expedited']
body.line_items[1].item.terms = Terms.new
body.line_items[1].item.terms.terms_text = 'lorem ipsum...'
body.line_items[1].item.terms.terms_uri = 'https://example.com/terms_of_service'
body.line_items[1].item.uri = 'https://example.com/abc_654321'
body.line_items[1].item.weight = Weight.new
body.line_items[1].item.weight.units = UnitsEnum::POUNDS
body.line_items[1].item.weight.weight = 71.78
body.line_items[1].quantity = 1
body.line_items[1].tax_amount = 5
body.line_items[1].tax_rate = 1.99
body.line_items[1].tax_type_applied = 'VAT'
body.line_items[1].total_amount = 500
body.line_items[1].unit_of_measure = 'count'
body.line_items[1].unit_price = 490
body.notes = 'urgent order'
body.rbits = []
body.rbits[0] = EmbeddedRbit.new
body.rbits[0].address = AddressRbit.new
body.rbits[0].address.origin_address = AddressRbits.new
body.rbits[0].address.origin_address.city = 'Sunnyvale'
body.rbits[0].address.origin_address.country = CountryCodeEnum::US
body.rbits[0].address.origin_address.line1 = '20 Main Street'
body.rbits[0].address.origin_address.postal_code = '94085'
body.rbits[0].address.origin_address.region = 'CA'
body.rbits[0].receive_time = 1367958263
body.rbits[0].source = RbitSourceEnum::PARTNER_DATABASE
body.rbits[0].type = RbitTypesEnum::ADDRESS
body.rbits[1] = EmbeddedRbit.new
body.rbits[1].auto_billing = AutoBilling.new
body.rbits[1].auto_billing.autobill_setup_time = 1209600
body.rbits[1].auto_billing.payment_frequency = 'monthly'
body.rbits[1].auto_billing.payment_number = 1
body.rbits[1].auto_billing.setup_by = SetupByEnum::PAYER
body.rbits[1].auto_billing.total_payments_scheduled = 5
body.rbits[1].receive_time = 1367958263
body.rbits[1].source = RbitSourceEnum::USER
body.rbits[1].type = RbitTypesEnum::AUTO_BILLING
body.reference_number = 'invoice #54321'
body.service_address = AddressPaymentsReq.new
body.service_address.city = 'San Francisco'
body.service_address.country = CountryCodeEnum::US
body.service_address.line1 = '123 Fake Street'
body.service_address.postal_code = '94101'
body.service_address.region = 'CA'
body.ship_from_address = AddressPaymentsReq.new
body.ship_from_address.city = 'San Francisco'
body.ship_from_address.country = CountryCodeEnum::US
body.ship_from_address.line1 = '123 Fake Street'
body.ship_from_address.postal_code = '94101'
body.ship_from_address.region = 'CA'
body.ship_to_address = AddressPaymentsReq.new
body.ship_to_address.city = 'San Francisco'
body.ship_to_address.country = CountryCodeEnum::US
body.ship_to_address.line1 = '123 Fake Street'
body.ship_to_address.postal_code = '94101'
body.ship_to_address.region = 'CA'
body.shipping_status = ShippingStatus1.new
body.shipping_status.carrier = 'UPS'
body.shipping_status.expected_delivery_time = 1490656130
body.shipping_status.shipping_time = 1390656130
body.shipping_status.tracking_number = '1Z34567890'
body.shipping_status.tracking_uri = 'https://example.com/ups/1Z34567890'
body.short_description = 'Donation to ABC campaign'
body.status = Status4Enum::PAID
body.tax_amount = 35
body.type = Type4Enum::GOODS
body.vat_amount = 5
body.vat_rate = 1.99
result = client_controller.post_orders(app_id, app_token, api_version, body, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Orders
The GET /orders call allows your platform to look up a collection of orders. Orders identify both the merchant and payer, and describe items sold, shipment date, prices, delivery details, and payment terms.
def get_orders(app_id,
app_token,
api_version,
unique_key: nil,
page: nil,
page_size: 10,
create_time_start: nil,
create_time_end: nil,
reference_number: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
page |
String |
Query, Optional | Return elements starting from this page. If specified, no other query parameters can be specified. |
page_size |
Integer |
Query, Optional | Maximum number of items per page of results. Default: 10Constraints: >= 1, <= 50 |
create_time_start |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the start of the search window, inclusive. |
create_time_end |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the end of the search window, inclusive. |
reference_number |
String |
Query, Optional | Return elements with this reference number. |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_orders(app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Orders-Id
The GET /orders/id call allows your platform to look up a single order. Orders identify both the merchant and payer, and describe items sold, shipment date, prices, delivery details, and payment terms.
def get_orders_id(id,
app_id,
app_token,
api_version,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_orders_id(id, app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
DELETE Orders-Id
The DELETE /orders/id call allows your platform to delete an order. Orders identify both the merchant and payer, and describe items sold, shipment date, prices, delivery details, and payment terms.
def delete_orders_id(id,
app_id,
app_token,
api_version,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.delete_orders_id(id, app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Orders-Id
The POST /orders/id call allows your platform to update and add custom data an order. Orders identify both the merchant and payer, and describe items sold, shipment date, prices, delivery details, and payment terms.
def post_orders_id(id,
app_id,
app_token,
api_version,
body,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
body |
OrderReq |
Body, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
body = OrderReq.new
body.account_id = 'd7608b20-fea5-4eb5-bd30-d3f58435e78b'
body.alternate_tax_amount = 35
body.alternate_tax_id = '11'
body.buyer = Buyer.new
body.buyer.legal_entity_id = '1490656130'
body.buyer.type = Type12Enum::LEGAL_ENTITY_ID
body.customer_reference_number = 'cust# 1234'
body.delivery_type = DeliveryTypeEnum::POINT_OF_SALE
body.discount_amount = 0
body.duty_amount = 0
body.freight_amount = 0
body.grand_total_amount = 1000
body.line_items = []
body.line_items[0] = LineItem1.new
body.line_items[0].commodity_code = 'ABC123'
body.line_items[0].currency = CurrencyEnum::USD
body.line_items[0].description = 'Classic Iron Anvil'
body.line_items[0].discount_amount = 0
body.line_items[0].item = ItemNullableReq.new
body.line_items[0].item.account_id = 'd7608b20-fea5-4eb5-bd30-d3f58435e78b'
body.line_items[0].item.description = 'Classic Iron Anvil'
body.line_items[0].item.photos = []
body.line_items[0].item.price = 490
body.line_items[0].item.product_code = 'XYZ321'
body.line_items[0].item.product_details = JSON.parse('{"band":"nike"}')
body.line_items[0].item.product_name = 'Acme Anvil - 100 Lb'
body.line_items[0].item.reference_number = 'abc_123456'
body.line_items[0].item. = ['regular', 'expedited']
body.line_items[0].item.terms = Terms.new
body.line_items[0].item.terms.terms_text = 'lorem ipsum...'
body.line_items[0].item.terms.terms_uri = 'https://example.com/terms_of_service'
body.line_items[0].item.uri = 'https://example.com/abc_123456'
body.line_items[0].item.weight = Weight.new
body.line_items[0].item.weight.units = UnitsEnum::POUNDS
body.line_items[0].item.weight.weight = 71.77
body.line_items[0].quantity = 1
body.line_items[0].tax_amount = 5
body.line_items[0].tax_rate = 1.99
body.line_items[0].tax_type_applied = 'VAT'
body.line_items[0].total_amount = 500
body.line_items[0].unit_of_measure = 'count'
body.line_items[0].unit_price = 490
body.line_items[1] = LineItem1.new
body.line_items[1].commodity_code = 'XYZ999'
body.line_items[1].currency = CurrencyEnum::USD
body.line_items[1].description = 'Classic Catapult'
body.line_items[1].discount_amount = 0
body.line_items[1].item = ItemNullableReq.new
body.line_items[1].item.account_id = 'd7608b20-fea5-4eb5-bd30-d3f58435e78b'
body.line_items[1].item.description = 'Classic Catapult'
body.line_items[1].item.photos = ['http://imgur.com/o4Qk0AF']
body.line_items[1].item.price = 490
body.line_items[1].item.product_code = 'AAAXYZ321'
body.line_items[1].item.product_name = 'Acme Catapult'
body.line_items[1].item.reference_number = 'abc_654321'
body.line_items[1].item. = ['regular', 'expedited']
body.line_items[1].item.terms = Terms.new
body.line_items[1].item.terms.terms_text = 'lorem ipsum...'
body.line_items[1].item.terms.terms_uri = 'https://example.com/terms_of_service'
body.line_items[1].item.uri = 'https://example.com/abc_654321'
body.line_items[1].item.weight = Weight.new
body.line_items[1].item.weight.units = UnitsEnum::POUNDS
body.line_items[1].item.weight.weight = 71.78
body.line_items[1].quantity = 1
body.line_items[1].tax_amount = 5
body.line_items[1].tax_rate = 1.99
body.line_items[1].tax_type_applied = 'VAT'
body.line_items[1].total_amount = 500
body.line_items[1].unit_of_measure = 'count'
body.line_items[1].unit_price = 490
body.notes = 'urgent order'
body.rbits = []
body.rbits[0] = EmbeddedRbit.new
body.rbits[0].address = AddressRbit.new
body.rbits[0].address.origin_address = AddressRbits.new
body.rbits[0].address.origin_address.city = 'Sunnyvale'
body.rbits[0].address.origin_address.country = CountryCodeEnum::US
body.rbits[0].address.origin_address.line1 = '20 Main Street'
body.rbits[0].address.origin_address.postal_code = '94085'
body.rbits[0].address.origin_address.region = 'CA'
body.rbits[0].receive_time = 1367958263
body.rbits[0].source = RbitSourceEnum::PARTNER_DATABASE
body.rbits[0].type = RbitTypesEnum::ADDRESS
body.rbits[1] = EmbeddedRbit.new
body.rbits[1].auto_billing = AutoBilling.new
body.rbits[1].auto_billing.autobill_setup_time = 1209600
body.rbits[1].auto_billing.payment_frequency = 'monthly'
body.rbits[1].auto_billing.payment_number = 1
body.rbits[1].auto_billing.setup_by = SetupByEnum::PAYER
body.rbits[1].auto_billing.total_payments_scheduled = 5
body.rbits[1].receive_time = 1367958263
body.rbits[1].source = RbitSourceEnum::USER
body.rbits[1].type = RbitTypesEnum::AUTO_BILLING
body.reference_number = 'invoice #54321'
body.service_address = AddressPaymentsReq.new
body.service_address.city = 'San Francisco'
body.service_address.country = CountryCodeEnum::US
body.service_address.line1 = '123 Fake Street'
body.service_address.postal_code = '94101'
body.service_address.region = 'CA'
body.ship_from_address = AddressPaymentsReq.new
body.ship_from_address.city = 'San Francisco'
body.ship_from_address.country = CountryCodeEnum::US
body.ship_from_address.line1 = '123 Fake Street'
body.ship_from_address.postal_code = '94101'
body.ship_from_address.region = 'CA'
body.ship_to_address = AddressPaymentsReq.new
body.ship_to_address.city = 'San Francisco'
body.ship_to_address.country = CountryCodeEnum::US
body.ship_to_address.line1 = '123 Fake Street'
body.ship_to_address.postal_code = '94101'
body.ship_to_address.region = 'CA'
body.shipping_status = ShippingStatus1.new
body.shipping_status.carrier = 'UPS'
body.shipping_status.expected_delivery_time = 1490656130
body.shipping_status.shipping_time = 1390656130
body.shipping_status.tracking_number = '1Z34567890'
body.shipping_status.tracking_uri = 'https://example.com/ups/1Z34567890'
body.short_description = 'Donation to ABC campaign'
body.status = Status4Enum::PAID
body.tax_amount = 35
body.type = Type4Enum::GOODS
body.vat_amount = 5
body.vat_rate = 1.99
result = client_controller.post_orders_id(id, app_id, app_token, api_version, body, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Payments
The POST /payments call allows your platform to create a new payment. undefined
def post_payments(app_id,
app_token,
api_version,
unique_key,
body,
we_pay_risk_token: nil,
client_ip: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Required | - |
body |
PaymentsRequest |
Body, Required | - |
we_pay_risk_token |
String |
Header, Optional | - |
client_ip |
String |
Header, Optional | - |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
unique_key = 'Unique-Key0'
body = PaymentsRequest.new
body.account_id = 'abc123'
body.amount = 1000
body.auto_capture = true
body.currency = CurrencyEnum::USD
body.custom_data = JSON.parse('{"my_key":"invoice #54321"}')
body.fee_amount = 30
body.order_id = 'ordr-3cd20b3c-4008-400b-b708-2b844ce7be84'
body.payment_method = PaymentMethodForPayments.new
body.payment_method.credit_card = CreditCard2.new
body.payment_method.credit_card.auto_update = false
body.payment_method.credit_card.card_holder = HolderReq.new
body.payment_method.credit_card.card_holder.address = AddressPaymentsReq.new
body.payment_method.credit_card.card_holder.address.city = 'Redwood City'
body.payment_method.credit_card.card_holder.address.country = CountryCodeEnum::US
body.payment_method.credit_card.card_holder.address.line1 = '350 Convention Way'
body.payment_method.credit_card.card_holder.address.postal_code = '94025'
body.payment_method.credit_card.card_holder.address.region = 'CA'
body.payment_method.credit_card.card_holder.email = '[email protected]'
body.payment_method.credit_card.card_holder.holder_name = 'John Snow'
body.payment_method.credit_card.card_number = '5496198584584769'
body.payment_method.credit_card.cvv = '007'
body.payment_method.credit_card.expiration_month = 4
body.payment_method.credit_card.expiration_year = 2030
body.payment_method.credit_card.virtual_terminal_mode = VirtualTerminalModeEnum::WEB
body.payment_method.credit_card.card_on_file = true
body.payment_method.credit_card.recurring = false
body.payment_method.custom_data = JSON.parse('{"my_key":"invoice #54321"}')
body.payment_method.type = Type9Enum::CREDIT_CARD
body.initiated_by = InitiatedByReqEnum::CUSTOMER
body.reference_id = 'dfeb052b-ae8c-4a69-b909-8d9ecdd7c742'
result = client_controller.post_payments(app_id, app_token, api_version, unique_key, body, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS, MERCHANT_ACCOUNT_CANNOT_ACCEPT_PAYMENTS, TRANSACTION_DECLINED, UNSUPPORTED_CURRENCY | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Payments
The GET /payments call allows your platform to look up a collection of payments. undefined
def get_payments(app_id,
app_token,
api_version,
unique_key: nil,
page: nil,
page_size: 10,
create_time_start: nil,
create_time_end: nil,
owner_id: nil,
payment_method_type: nil,
payment_method_id: nil,
status: nil,
reference_id: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
page |
String |
Query, Optional | Return elements starting from this page. If specified, no other query parameters can be specified. |
page_size |
Integer |
Query, Optional | Maximum number of items per page of results. Default: 10Constraints: >= 1, <= 50 |
create_time_start |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the start of the search window, inclusive. |
create_time_end |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the end of the search window, inclusive. |
owner_id |
String |
Query, Optional | - |
payment_method_type |
PaymentMethodTypeEnum |
Query, Optional | The last 4 digits of the card to search for. |
payment_method_id |
String |
Query, Optional | - |
status |
Status3Enum |
Query, Optional | - |
reference_id |
String |
Query, Optional | The reference_id to search for. |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_payments(app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Payments-Id
The GET /payments/id call allows your platform to look up a single payment. undefined
def get_payments_id(id,
app_id,
app_token,
api_version,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_payments_id(id, app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Payments-Id
The POST /payments/id call allows your platform to update and add custom data to a payment. undefined
def post_payments_id(id,
app_id,
app_token,
api_version,
body,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
body |
PaymentsRequest1 |
Body, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
body = PaymentsRequest1.new
body.custom_data = JSON.parse('{"Another Key":"some value","a_reference_number":4}')
body.reference_id = 'dfeb052b-ae8c-4a69-b909-8d9ecdd7c742'
result = client_controller.post_payments_id(id, app_id, app_token, api_version, body, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Payments-Id-Cancel
The POST /payments/id/cancel call allows your platform to cancel a payment. undefined
def post_payments_id_cancel(id,
app_id,
app_token,
api_version,
body,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
body |
PaymentsCancelRequest |
Body, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
body = PaymentsCancelRequest.new
body.cancel_reason = 'item(s) delayed - cannot fulfill order'
result = client_controller.post_payments_id_cancel(id, app_id, app_token, api_version, body, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS, PAYMENT_CANNOT_BE_CANCELED | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Payments-Id-Capture
The POST /payments/id/capture call allows your platform to capture a payment (when auto_capture is set to false). undefined
def post_payments_id_capture(id,
app_id,
app_token,
api_version,
unique_key: nil,
body: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
body |
PaymentsCaptureRequest |
Body, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
body = PaymentsCaptureRequest.new
body.amounts = CaptureAmounts.new
body.amounts.amount = 1500
body.amounts.currency = CurrencyEnum::USD
body.amounts.fee_amount = 150
result = client_controller.post_payments_id_capture(id, app_id, app_token, api_version, body: body)
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Payment Methods
The POST /payment_methods call allows your platform to create a payment method. Payment methods represent payment data like credit cards and bank accounts, and allow your platform to charge and accept money from a payer.
def post_payment_methods(app_id,
app_token,
api_version,
body,
unique_key: nil,
we_pay_risk_token: nil,
client_ip: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
body |
PaymentMethodReq |
Body, Required | - |
unique_key |
String |
Header, Optional | - |
we_pay_risk_token |
String |
Header, Optional | - |
client_ip |
String |
Header, Optional | - |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
body = PaymentMethodReq.new
body.credit_card = CreditCard2.new
body.credit_card.auto_update = false
body.credit_card.card_holder = HolderReq.new
body.credit_card.card_holder.address = AddressPaymentsReq.new
body.credit_card.card_holder.address.country = CountryCodeEnum::US
body.credit_card.card_holder.address.postal_code = '94025'
body.credit_card.card_holder.email = '[email protected]'
body.credit_card.card_holder.holder_name = 'John Snow'
body.credit_card.card_number = '5496198584584769'
body.credit_card.cvv = '007'
body.credit_card.expiration_month = 4
body.credit_card.expiration_year = 2020
body.credit_card.trigger_verification = true
body.credit_card.virtual_terminal_mode = VirtualTerminalModeEnum::MOBILE
body.credit_card.card_on_file = false
body.credit_card.recurring = false
body.custom_data = JSON.parse('{"my_key":"invoice #54321"}')
body.type = Type3Enum::CREDIT_CARD
result = client_controller.post_payment_methods(app_id, app_token, api_version, body, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS, MERCHANT_ACCOUNT_CANNOT_ACCEPT_PAYMENTS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Payment Methods
The GET /payment_methods call allows your platform to look up a collection of payment methods. Payment methods represent payment data like credit cards and bank accounts, and allow your platform to charge and accept money from a payer.
def get_payment_methods(app_id,
app_token,
api_version,
unique_key: nil,
page: nil,
page_size: 10,
create_time_start: nil,
create_time_end: nil,
card_brand: nil,
card_last_four: nil,
bank_routing_number: nil,
bank_last_four: nil,
type: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
page |
String |
Query, Optional | Return elements starting from this page. If specified, no other query parameters can be specified. |
page_size |
Integer |
Query, Optional | Maximum number of items per page of results. Default: 10Constraints: >= 1, <= 50 |
create_time_start |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the start of the search window, inclusive. |
create_time_end |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the end of the search window, inclusive. |
card_brand |
CardBrand2Enum |
Query, Optional | The brand of the card to search for. |
card_last_four |
String |
Query, Optional | The last 4 digits of the card to search for. |
bank_routing_number |
String |
Query, Optional | The routing number of the bank to search for. |
bank_last_four |
String |
Query, Optional | The last 4 of the bank account number to search for. |
type |
Type3Enum |
Query, Optional | The type of payment method to search for. Required unless page is provided |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_payment_methods(app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Payment Methods-Id
The POST /payment_methods/id call allows your platform to update and add custom data to an existing payment method. Payment methods represent payment data like credit cards and bank accounts, and allow your platform to charge and accept money from a payer.
def post_payment_methods_id(id,
app_id,
app_token,
api_version,
body,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
body |
PaymentMethodsRequest |
Body, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
body = PaymentMethodsRequest.new
body.type = Type3Enum::PAYMENT_BANK_US
result = client_controller.post_payment_methods_id(id, app_id, app_token, api_version, body, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Payment Methods-Id
The GET /payment_methods/id call allows your platform to look up a specific payment method. Payment methods represent payment data like credit cards and bank accounts, and allow your platform to charge and accept money from a payer.
def get_payment_methods_id(id,
app_id,
app_token,
api_version,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_payment_methods_id(id, app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
DELETE Payment Methods-Id
The DELETE /payment_methods/id call allows your platform to delete a single payment method. Payment methods represent payment data like credit cards and bank accounts, and allow your platform to charge and accept money from a payer.
def delete_payment_methods_id(id,
app_id,
app_token,
api_version,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.delete_payment_methods_id(id, app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS, PAYMENT_METHOD_CANNOT_BE_DELETED | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Payment Methods-Id-Verify Bank Deposits
The POST /payment_methods/id/verify_bank_deposits call allows your platform to verify a payment method. Payment methods represent payment data like credit cards and bank accounts, and allow your platform to charge and accept money from a payer.
def post_payment_methods_id_verify_bank_deposits(id,
app_id,
app_token,
api_version,
body,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
body |
PaymentMethodsVerifyBankDepositsRequest |
Body, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
body = PaymentMethodsVerifyBankDepositsRequest.new
body.microdeposits = [10, 55]
result = client_controller.post_payment_methods_id_verify_bank_deposits(id, app_id, app_token, api_version, body, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS, PAYMENT_METHOD_CANNOT_BE_VERIFIED | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Payouts
The GET /payouts call allows your platform to look up a collection of payouts. Payouts allow your merchants to receive their funds from your platform.
def get_payouts(app_id,
app_token,
api_version,
unique_key: nil,
page: nil,
page_size: 10,
create_time_start: nil,
create_time_end: nil,
owner_id: nil,
payout_method_type: nil,
payout_method_id: nil,
status: nil,
payment_id: nil,
refund_id: nil,
dispute_id: nil,
recovery_id: nil,
adjustment_id: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
page |
String |
Query, Optional | Return elements starting from this page. If specified, no other query parameters can be specified. |
page_size |
Integer |
Query, Optional | Maximum number of items per page of results. Default: 10Constraints: >= 1, <= 50 |
create_time_start |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the start of the search window, inclusive. |
create_time_end |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the end of the search window, inclusive. |
owner_id |
String |
Query, Optional | The ID of the owning entity for which to find payouts. |
payout_method_type |
PayoutMethodTypeEnum |
Query, Optional | The payout method type to search for. |
payout_method_id |
String |
Query, Optional | Search for a payout that uses this payout method ID. |
status |
StatusEnum |
Query, Optional | The status of the payout to search for. |
payment_id |
String |
Query, Optional | Search for a payout that includes funds with this payment ID. |
refund_id |
String |
Query, Optional | Search for a payout that includes funds with this refund ID. |
dispute_id |
String |
Query, Optional | Search for a payout that includes funds with this dispute ID. |
recovery_id |
String |
Query, Optional | Search for a payout that includes funds with this recovery ID. |
adjustment_id |
String |
Query, Optional | Search for a payout that includes funds with this adjustment ID. |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_payouts(app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Payouts-Id
The POST /payouts/id call allows your platform to update and add custom data to a payout. Payouts allow your merchants to receive their funds from your platform.
def post_payouts_id(id,
app_id,
app_token,
api_version,
body,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
body |
PayoutsRequest |
Body, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
body = PayoutsRequest.new
result = client_controller.post_payouts_id(id, app_id, app_token, api_version, body, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Payouts-Id
The GET /payouts/id call allows your platform to look up a single payout. Payouts allow your merchants to receive their funds from your platform.
def get_payouts_id(id,
app_id,
app_token,
content_type,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
content_type |
String |
Header, Required | Constraints: Pattern: application/json |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
content_type = 'Content-Type2'
result = client_controller.get_payouts_id(id, app_id, app_token, content_type, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Payout Methods
The POST /payout_methods call allows your platform to create a new payout method owned by a legal entity. Payout methods represent payout targets, such as bank accounts.
def post_payout_methods(app_id,
app_token,
api_version,
body,
unique_key: nil,
we_pay_risk_token: nil,
client_ip: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
body |
PayoutMethodReq |
Body, Required | - |
unique_key |
String |
Header, Optional | - |
we_pay_risk_token |
String |
Header, Optional | - |
client_ip |
String |
Header, Optional | - |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
body = PayoutMethodReq.new
body.custom_data = JSON.parse('{"my_key":"invoice #54321"}')
body.legal_entity_id = '42d2c2f1-5aeb-4929-944f-e220b4c9425b'
body.nickname = 'bofa checking 6789'
body.payout_bank_us = PayoutBankUs1.new
body.payout_bank_us.account_number = '123456789'
body.payout_bank_us.account_type = AccountTypeEnum::CHECKING
body.payout_bank_us.routing_number = '987654321'
body.type = Type2Enum::PAYOUT_BANK_US
result = client_controller.post_payout_methods(app_id, app_token, api_version, body, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS, MERCHANT_ACCOUNT_CANNOT_ACCEPT_PAYMENTS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Payout Methods
The GET /payout_methods call allows your platform to look up a collection of payout methods. Payout methods represent payout targets, such as bank accounts.
def get_payout_methods(app_id,
app_token,
api_version,
unique_key: nil,
page: nil,
page_size: 10,
create_time_start: nil,
create_time_end: nil,
owner_id: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
page |
String |
Query, Optional | Return elements starting from this page. If specified, no other query parameters can be specified. |
page_size |
Integer |
Query, Optional | Maximum number of items per page of results. Default: 10Constraints: >= 1, <= 50 |
create_time_start |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the start of the search window, inclusive. |
create_time_end |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the end of the search window, inclusive. |
owner_id |
String |
Query, Optional | The ID of the owning entity for which to find payout methods. Required unless "page" provided. |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_payout_methods(app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Payout Methods-Id
The POST /payout_methods/id call allows your platform to update and add custom data to a payout method. Payout methods represent payout targets, such as bank accounts.
def post_payout_methods_id(id,
app_id,
app_token,
api_version,
body,
unique_key: nil,
we_pay_risk_token: nil,
client_ip: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
body |
PayoutMethodsRequest |
Body, Required | - |
unique_key |
String |
Header, Optional | - |
we_pay_risk_token |
String |
Header, Optional | - |
client_ip |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
body = PayoutMethodsRequest.new
result = client_controller.post_payout_methods_id(id, app_id, app_token, api_version, body, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Payout Methods-Id
The GET /payout_methods/id call allows your platform to look up a single payout method. Payout methods represent payout targets, such as bank accounts.
def get_payout_methods_id(id,
app_id,
app_token,
api_version,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_payout_methods_id(id, app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Rbits
The POST /rbits call allows your platform to create an rbit for a user, account, or transaction. The rbits resource provides a way to communicate risk-related account and transaction level information between an application and WePay. An rbit contains risk related information about your users, their accounts, and their transactions.
def post_rbits(app_id,
app_token,
api_version,
body,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
body |
RbitsRequest |
Body, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
body = RbitsRequest.new
body.address = AddressRbit.new
body.address.origin_address = AddressRbits.new
body.address.origin_address.city = 'Palo Alto'
body.address.origin_address.country = CountryCodeEnum::US
body.address.origin_address.line1 = '380 Portage Avenue'
body.address.origin_address.postal_code = '93036'
body.address.origin_address.region = 'CA'
body.associated_resource = AssociatedResource.new
body.associated_resource.id = 'f48cd8e6-e802-4500-a0f9-3ab6228c6f23'
body.associated_resource.resource = ResourceTypesRbitEnum::ACCOUNTS
body.receive_time = 1367958263
body.source = RbitSourceEnum::GUIDESTAR
body.type = RbitTypesEnum::ADDRESS
result = client_controller.post_rbits(app_id, app_token, api_version, body, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Rbits
The GET /rbits call allows your platform to look up a collection of rbits. The rbits resource provides a way to communicate risk-related account and transaction level information between an application and WePay. An rbit contains risk related information about your users, their accounts, and their transactions.
def get_rbits(app_id,
app_token,
api_version,
unique_key: nil,
page: nil,
page_size: 10,
create_time_start: nil,
create_time_end: nil,
owner_id: nil,
owner_type: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
page |
String |
Query, Optional | Return elements starting from this page. If specified, no other query parameters can be specified. |
page_size |
Integer |
Query, Optional | Maximum number of items per page of results. Default: 10Constraints: >= 1, <= 50 |
create_time_start |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the start of the search window, inclusive. |
create_time_end |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the end of the search window, inclusive. |
owner_id |
String |
Query, Optional | The ID of the owner for which to find rbits. |
owner_type |
String |
Query, Optional | The resource type of the owner for which to find rbits. |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_rbits(app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Rbits-Id
The GET /rbits/id call allows your platform to look up a single rbit. The rbits resource provides a way to communicate risk-related account and transaction level information between an application and WePay. An rbit contains risk related information about your users, their accounts, and their transactions.
def get_rbits_id(id,
app_id,
app_token,
api_version,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_rbits_id(id, app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
DELETE Rbits-Id
The DELETE /rbits call allows you to delete an rbit. The rbits resource provides a way to communicate risk-related account and transaction level information between an application and WePay. An rbit contains risk related information about your users, their accounts, and their transactions.
def delete_rbits_id(id,
app_id,
app_token,
api_version,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.delete_rbits_id(id, app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Recoveries
The GET /recoveries call allows your platform to look up a collection of recoveries. The recovery resource notifies your platform that WePay made a recovery attempt to a merchant’s bank account in order to bring their balance up to $0.
def get_recoveries(app_id,
app_token,
api_version,
unique_key: nil,
page: nil,
page_size: 10,
create_time_start: nil,
create_time_end: nil,
owner_id: nil,
payout_method_type: nil,
payout_method_id: nil,
status: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
page |
String |
Query, Optional | Return elements starting from this page. If specified, no other query parameters can be specified. |
page_size |
Integer |
Query, Optional | Maximum number of items per page of results. Default: 10Constraints: >= 1, <= 50 |
create_time_start |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the start of the search window, inclusive. |
create_time_end |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the end of the search window, inclusive. |
owner_id |
String |
Query, Optional | The ID of the owning entity for which to find recoveries. |
payout_method_type |
PayoutMethodTypeEnum |
Query, Optional | The payout method type to filter by. |
payout_method_id |
String |
Query, Optional | The payout method id to filter by. |
status |
StatusEnum |
Query, Optional | The status of recoveries to return. |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_recoveries(app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Recoveries-Id
The GET /recoveries/id call allows your platform to look up information on a single recovery. The recovery resource notifies your platform that WePay made a recovery attempt to a merchant’s bank account in order to bring their balance up to $0.
def get_recoveries_id(id,
app_id,
app_token,
api_version,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_recoveries_id(id, app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Recoveries-Id
The POST /recoveries/id call allows your platform to update and add custom data to a recovery. The recovery resource notifies your platform that WePay made a recovery attempt to a merchant’s bank account in order to bring their balance up to $0.
def post_recoveries_id(id,
app_id,
app_token,
api_version,
body,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
body |
RecoveriesRequest |
Body, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
body = RecoveriesRequest.new
body.custom_data = JSON.parse('{"receipt_number":1258372}')
result = client_controller.post_recoveries_id(id, app_id, app_token, api_version, body, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Refunds
The GET /refunds call allows your platform to look up a collection of refunds. Refunds facilitate the return of money from the merchant to the payer.
def get_refunds(app_id,
app_token,
api_version,
unique_key: nil,
page: nil,
page_size: 10,
create_time_start: nil,
create_time_end: nil,
owner_id: nil,
payment_method_type: nil,
payment_method_id: nil,
status: nil,
payment_id: nil,
reference_id: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
page |
String |
Query, Optional | Return elements starting from this page. If specified, no other query parameters can be specified. |
page_size |
Integer |
Query, Optional | Maximum number of items per page of results. Default: 10Constraints: >= 1, <= 50 |
create_time_start |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the start of the search window, inclusive. |
create_time_end |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the end of the search window, inclusive. |
owner_id |
String |
Query, Optional | The ID of the owning entity for which to find refunds. |
payment_method_type |
PaymentMethodTypeEnum |
Query, Optional | The payment method type to filter by. |
payment_method_id |
String |
Query, Optional | The payment method id to filter by. |
status |
StatusEnum |
Query, Optional | The status of refunds to return. |
payment_id |
String |
Query, Optional | The payment id to filter by. |
reference_id |
String |
Query, Optional | The reference_id to search for. |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_refunds(app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Refunds
The POST /refunds call allows your platform to create a new refund. Refunds facilitate the return of money from the merchant to the payer.
def post_refunds(app_id,
app_token,
api_version,
unique_key,
body)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Required | - |
body |
RefundReq |
Body, Required | - |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
unique_key = 'Unique-Key0'
body = RefundReq.new
body.amounts = RefundAmounts.new
body.amounts.total_amount = 300
body.amounts.currency = CurrencyEnum::USD
body.amounts.fee_refund_amount = 50
body.order_id = 'ordr-123-abc'
body.payment_id = '18752aba-25d0-4328-aac9-a0ba7216eb67'
body.refund_reason = 'Item(s) returned'
body.reference_id = 'reference_id_0'
result = client_controller.post_refunds(app_id, app_token, api_version, unique_key, body)
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS, PAYMENT_CANNOT_BE_REFUNDED | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Refunds-Id
The GET /refunds/id call allows your platform to look up a single refund. Refunds facilitate the return of money from the merchant to the payer.
def get_refunds_id(id,
app_id,
app_token,
api_version,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_refunds_id(id, app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Refunds-Id
The POST /refunds/id call allows your platform to update and add custom data to a refund. Refunds facilitate the return of money from the merchant to the payer.
def post_refunds_id(id,
app_id,
app_token,
api_version,
body,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
body |
RefundsRequest |
Body, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
body = RefundsRequest.new
body.custom_data = JSON.parse('{"order_id":34211134828443}')
body.reference_id = 'reference_id_0'
result = client_controller.post_refunds_id(id, app_id, app_token, api_version, body, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Terminals
Onboard a Point-of-Sale terminal into the WePay system. A terminals resource represents a mechanism by which you can control the configuration and lifecycle of your terminals. You can only have one non-deleted instance of a terminals resource per physical terminal, which is uniquely identified by the model and serial number.
def post_terminals(app_id,
app_token,
api_version,
body)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
body |
TerminalsRequest |
Body, Required | - |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
body = TerminalsRequest.new
body.account_id = '0ef0dcd6-a2c6-49c4-9051-bbbe5c6c36e2'
body.serial_number = 'FA00332-1000138'
body.model = Model1Enum::VERIFONE_P400
body.reference_id = 'abc12345'
body.terminal_configuration = TerminalConfiguration1.new
body.terminal_configuration.address = AddressTerminalsReq.new
body.terminal_configuration.address.city = 'Redwood City'
body.terminal_configuration.address.country = CountryCodeEnum::US
body.terminal_configuration.address.line1 = '250 Convention Way'
body.terminal_configuration.address.line2 = 'Suite 200'
body.terminal_configuration.address.postal_code = '94063'
body.terminal_configuration.address.region = 'CA'
body.terminal_configuration.currency = CurrencyEnum::USD
body.terminal_configuration.supported_card_brands = [TerminalsSupportedCardBrandEnum::VISA, TerminalsSupportedCardBrandEnum::AMERICAN_EXPRESS, TerminalsSupportedCardBrandEnum::DISCOVER, TerminalsSupportedCardBrandEnum::MASTERCARD]
body.terminal_configuration.timezone = TimezoneEnum::ENUM_USPACIFIC
body.terminal_configuration.tip = TerminalsTip.new
body.terminal_configuration.tip.mode = ModeEnum::PROMPT_ON_TERMINAL
body.terminal_configuration.tip.terminal_display = TerminalDisplay.new
body.terminal_configuration.tip.terminal_display.amount_guide_type = AmountGuideTypeEnum::PERCENTAGE_GUIDE
body.terminal_configuration.tip.terminal_display.percentage_guide = PercentageGuide.new
body.terminal_configuration.tip.terminal_display.percentage_guide.show_amount = false
body.terminal_configuration.tip.terminal_display.percentage_guide.percentage_low = 15
body.terminal_configuration.tip.terminal_display.percentage_guide.percentage_medium = 18
body.terminal_configuration.tip.terminal_display.percentage_guide.percentage_high = 20
body.terminal_configuration.signature_required = true
body.terminal_configuration.contactless_payments = ContactlessPaymentsReq.new
body.terminal_configuration.contactless_payments.enabled = true
body.terminal_configuration.contactless_payments.credit_debit_preference = CreditDebitPreferenceEnum::CREDIT
body.terminal_configuration.quick_chip = QuickChip.new
body.terminal_configuration.quick_chip.enabled = true
body.terminal_configuration. = DeferredAuthorization.new
body.terminal_configuration..enabled = true
body.terminal_configuration..international_enabled = true
body.terminal_configuration..max_transaction_count = 20
body.terminal_configuration..max_total_amount = 250000
body.terminal_configuration..max_transaction_amount = 12500
body.terminal_configuration..supported_card_entry_modes = [SupportedCardEntryModeEnum::CHIP, SupportedCardEntryModeEnum::CONTACTLESS]
result = client_controller.post_terminals(app_id, app_token, api_version, body)
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS, ACCOUNT_CANNOT_CREATE_TERMINALS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Terminals
Look up a collection of terminals, filtered by the optional specified parameters.
def get_terminals(app_id,
app_token,
api_version,
page: nil,
page_size: 10,
create_time_start: nil,
create_time_end: nil,
account_id: nil,
reference_id: nil,
model: nil,
serial_number: nil,
status: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
page |
String |
Query, Optional | Return elements starting from this page. If specified, no other query parameters can be specified. |
page_size |
Integer |
Query, Optional | Maximum number of items per page of results. Default: 10Constraints: >= 1, <= 50 |
create_time_start |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the start of the search window, inclusive. |
create_time_end |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the end of the search window, inclusive. |
account_id |
String |
Query, Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
reference_id |
String |
Query, Optional | Filter search window by elements that match the reference ID. Constraints: Minimum Length: 1, Maximum Length: 255 |
model |
Model1Enum |
Query, Optional | Filter search window by elements that match the model. |
serial_number |
String |
Query, Optional | Filter search window by elements that match the serial_number. |
status |
TerminalsStatusEnum |
Query, Optional | Filter search window by elements that match the status. |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
serial_number = 'FA00332-1000138'
result = client_controller.get_terminals(app_id, app_token, api_version, serial_number: serial_number, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Terminals-Id
Modify a terminal's configuration. Note that changes in configuration will only be reflected on your physical terminal when it has performed an online update. You cannot modify the configuration of an inactive or deleted terminal.
def post_terminals_id(app_id,
app_token,
api_version,
body,
id)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
body |
TerminalsRequest1 |
Body, Required | - |
id |
String |
Template, Required | - |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
body = TerminalsRequest1.new
body.reference_id = 'abc12345'
body.terminal_configuration = TerminalConfiguration2.new
body.terminal_configuration.contactless_payments = ContactlessPaymentsReq.new
body.terminal_configuration.contactless_payments.enabled = true
body.terminal_configuration.contactless_payments.credit_debit_preference = CreditDebitPreferenceEnum::CREDIT
id = 'id0'
result = client_controller.post_terminals_id(app_id, app_token, api_version, body, id)
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Terminals-Id
Look up a terminal to see its current status and configuration.
def get_terminals_id(app_id,
app_token,
api_version,
id)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
id |
String |
Template, Required | - |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
id = 'id0'
result = client_controller.get_terminals_id(app_id, app_token, api_version, id)
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
DELETE Terminals-Id
Delete's the terminal from the system, marking it as deleted. The physical terminal represented by this API record will not be able to process payments until it is onboarded again.
def delete_terminals_id(app_id,
app_token,
api_version,
id)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
id |
String |
Template, Required | - |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
id = 'id0'
result = client_controller.delete_terminals_id(app_id, app_token, api_version, id)
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Terminals-Id-Activate
Activating a terminal will allow it to process payments after being deactivated. You can only activate a deactivated terminal.
def post_terminals_id_activate(app_id,
app_token,
api_version,
content_type,
id,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
content_type |
String |
Header, Required | Constraints: Pattern: application/json |
id |
String |
Template, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
content_type = 'Content-Type2'
id = 'id0'
result = client_controller.post_terminals_id_activate(app_id, app_token, api_version, content_type, id, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Terminals-Id-Deactivate
Dectivating a terminal will prevent it from processin payments after being deactivated. You can only deactivate an active terminal.
def post_terminals_id_deactivate(app_id,
app_token,
api_version,
content_type,
id,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
content_type |
String |
Header, Required | Constraints: Pattern: application/json |
id |
String |
Template, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
content_type = 'Content-Type2'
id = 'id0'
result = client_controller.post_terminals_id_deactivate(app_id, app_token, api_version, content_type, id, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
POST Tokens
Create a new token
:information_source: Note This endpoint does not require authentication.
def post_tokens(app_id,
api_version,
body,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
body |
TokensRequest |
Body, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
app_id = 'App-Id2'
api_version = 'Api-Version8'
body = TokensRequest.new
body.payment_methods = PaymentMethodReq.new
body.payment_methods.credit_card = CreditCard2.new
body.payment_methods.credit_card.auto_update = false
body.payment_methods.credit_card.card_holder = HolderReq.new
body.payment_methods.credit_card.card_holder.address = AddressPaymentsReq.new
body.payment_methods.credit_card.card_holder.address.country = CountryCodeEnum::US
body.payment_methods.credit_card.card_holder.address.postal_code = '94025'
body.payment_methods.credit_card.card_holder.email = '[email protected]'
body.payment_methods.credit_card.card_holder.holder_name = 'John Snow'
body.payment_methods.credit_card.card_number = '5496198584584769'
body.payment_methods.credit_card.cvv = '007'
body.payment_methods.credit_card.expiration_month = 4
body.payment_methods.credit_card.expiration_year = 2020
body.payment_methods.credit_card.trigger_verification = false
body.payment_methods.credit_card.virtual_terminal_mode = VirtualTerminalModeEnum::WEB
body.payment_methods.credit_card.card_on_file = false
body.payment_methods.credit_card.recurring = false
body.payment_methods.type = Type3Enum::CREDIT_CARD
body.resource = Resource2Enum::PAYMENT_METHODS
result = client_controller.post_tokens(app_id, api_version, body, )
GET Transaction Records
The GET /transaction_records call allows your platform to look up a collection of transaction records. Transactions records represent one entry (e.g. payout) and the impact to an account’s balance.
def get_transaction_records(app_id,
app_token,
api_version,
unique_key: nil,
page: nil,
page_size: 10,
create_time_start: nil,
create_time_end: nil,
account_id: nil,
payout_id: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
page |
String |
Query, Optional | Return elements starting from this page. If specified, no other query parameters can be specified. |
page_size |
Integer |
Query, Optional | Maximum number of items per page of results. Default: 10Constraints: >= 1, <= 500 |
create_time_start |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the start of the search window, inclusive. |
create_time_end |
Integer |
Query, Optional | The create time epoch timestamp (in seconds) for the end of the search window, inclusive. |
account_id |
String |
Query, Optional | All transaction records for resources owned by an account (Payments, Refunds, Adjustments, Payouts, Recoveries, Disputes). |
payout_id |
String |
Query, Optional | All transaction records for resources included in a payout (very useful for reconciliation). |
Response Type
Example Usage
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_transaction_records(app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
GET Transaction Records-Id
The GET /transaction_records/id call allows your platform to look up a single transaction record. Transactions records represent one entry (e.g. payout) and the impact to an account’s balance.
def get_transaction_records_id(id,
app_id,
app_token,
api_version,
unique_key: nil)
Parameters
| Parameter | Type | Tags | Description |
|---|---|---|---|
id |
String |
Template, Required | - |
app_id |
String |
Header, Required | - |
app_token |
String |
Header, Required | - |
api_version |
String |
Header, Required | - |
unique_key |
String |
Header, Optional | - |
Response Type
Example Usage
id = 'id0'
app_id = 'App-Id2'
app_token = 'App-Token0'
api_version = 'Api-Version8'
result = client_controller.get_transaction_records_id(id, app_id, app_token, api_version, )
Errors
| HTTP Status Code | Error Description | Exception Class |
|---|---|---|
| 400 | INVALID_PARAMS | APIException |
| 403 | NOT_AUTHORIZED | APIException |
| 500 | UNEXPECTED_ERROR | APIException |
Model Reference
Structures
- Partner Service
- Address-Rbits
- Country Opted Out Methods
- Owner of Items
- Terms
- Weight
- Phone-Legal Entities-Nullable
- Human Name-Full-Nullable
- Address-Legal Entities-Nullable
- Mfa-Rbit
- Phone-Rbit
- Person-Rbit
- Partner Service-Rbit
- Industry Code
- Fundraising Update
- Address-Rbit
- Auto Billing
- Business Description
- Business Name
- External Account
- Fundraising Event
- Transaction Details
- Address-Payments-Resp
- Pricing by Currency
- Countries Opted Out Methods
- Item-Nullable-Resp
- Additional Representative-Req
- Address-Payments-Req
- Address-Terminals-Resp
- Terminals-Tip
- Quick Chip
- Additional Representative-Resp
- Deferred Authorization
- Holder-Resp
- Opted Out Methods
- Transactions Summary Summaries
- Recovery Pending Reason
- Refund Pending Reason
- Payment Pending Reason
- Payout Pending Reason
- Transaction Record Non Expanded
- Payout Failure Reason
- Owner Is Account
- Payout Method Non Expanded
- Payment Method Non Expanded
- Order Non Expanded
- Payment Failure Reason
- Holder-Req
- Token
- Controller-Req
- Additional Representatives-Req
- Terms-Nullable
- Address-Nullable
- Owner-Legal Entities-Nullable
- Owner-Applications
- Controller-Resp
- Additional Representatives-Resp
- Recovery Failure Reason
- Dispute Reason
- Payment Non Expanded
- Pricing
- Refund-Amounts
- Payout-Resp
- Refund Failure Reason
- Owner-Legal Entities
- Incoming Payments-Resp
- Item-Nullable-Req
- Refund-Resp
- Recoveries
- Payout Method-Resp
- Payout
- Payment Method-Resp
- Payments-V 3 0
- Payment Bank Us-Req
- Legal Entity
- Order-Resp
- Address-Terminals-Req
- Contactless Payments-Req
- Terminal-Resp
- Legal Entity-Resp
- Item-Resp
- Disputes
- Transactions Summary
- Interchange Fee
- Billing Statement
- Adjustments
- Account-Resp
- Transaction Record
- Owner-Accounts
- Incoming Payments-Req
- Capture-Amounts
- Payment Method for Payments
- Payment Method-Req
- Payout-Req
- Payout Method-Req
- Capabilities-Resp
- Item-Req
- Refund-Req
- Order-Req
- Accounts Capabilities Request
- Accounts Request
- Accounts Request 1
- Accounts Response
- Additional Representatives
- Additional Representatives 1
- Adjustments Request
- Adjustments Response
- Application Block
- Application Block 4
- Associated Phone
- Associated Resource
- Balances
- Billing Statements Interchange Fees Response
- Billing Statements Response
- Billing Statements Transactions Summary Response
- Buyer
- CA
- CA1
- CA4
- CAD
- CAD1
- CAD2
- Contactless Payments
- Controller
- Controller 1
- Credit Card
- Credit Card 1
- Credit Card 2
- Credit Card 4
- Currencies
- Currencies 1
- Currencies 2
- Currencies 3
- Current Issue
- Current Issue 2
- Date of Birth
- Detail
- Detail 1
- Detail 2
- Detail 3
- Detail 4
- Detail 5
- Detail 6
- Detail 7
- Detail 8
- Detail 9
- Detail 10
- Disputes Request
- Disputes Response
- Document
- Documentation
- Documentation 1
- Embedded-Rbit
- Entity Country Info
- Entity Verification
- Entity Verification 1
- Flat Guide
- GB
- GBP
- GBP1
- GBP2
- Industry
- Interchange Plus
- Itemized Receipt
- Items Response
- Legal Entities Request
- Legal Entities Response
- Legal Entities Verifications Request
- Legal Entities Verifications Response
- Line Item
- Line Item 1
- Name
- Notification Preferences Request
- Notification Preferences Request 1
- Notification Preferences Response
- Notification Preferences Response 1
- Notification Preferences Response 2
- Notifications Response
- Notifications Response 1
- Orders Response
- Owner 3
- Owner 16
- Owner 20
- Payment Methods Request
- Payment Methods Response
- Payment Methods Verify Bank Deposits Request
- Payment Bank
- Payment Bank Us
- Payments
- Payments Cancel Request
- Payments Capture Request
- Payments Request
- Payments Request 1
- Payments Response
- Payments 1
- Payout Methods Request
- Payout Methods Response
- Payout Bank Ca
- Payout Bank Ca 1
- Payout Bank Gb
- Payout Bank Gb 1
- Payout Bank Us
- Payout Bank Us 1
- Payouts
- Payouts Request
- Payouts Response
- Payouts 1
- Percentage Guide
- Personal Country Info
- Personal Country Info 1
- Personal Verification
- Personal Verification 5
- Phone
- Phone 1
- Rbits Request
- Rbits Response
- Rbits Response 1
- Reason
- Recoveries Request
- Recoveries Response
- Refunds Request
- Refunds Response
- Reject Reason
- Representative 0
- Representative 01
- Resolution
- Result
- Result 1
- Result 2
- Shipping Info
- Shipping Status
- Shipping Status 1
- Standard
- Target
- Terminal Configuration
- Terminal Configuration 1
- Terminal Configuration 2
- Terminal Display
- Terminals Request
- Terminals Request 1
- Terminals Response
- Terms of Service
- Tokens Request
- Tokens Response
- Transaction Records Response
- Upcoming Issue
- US
- US1
- US4
- USD
- USD1
- USD2
Partner Service
Class Name
PartnerService
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
currency |
CurrencyEnum |
Optional | - |
service_monthly_cost |
Integer |
Optional | - |
service_name |
String |
Required | Constraints: Maximum Length: 1024 |
Example (as JSON)
{
"currency": null,
"service_monthly_cost": null,
"service_name": "service_name6"
}
Address-Rbits
Class Name
AddressRbits
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
city |
String |
Optional | Constraints: Maximum Length: 30 |
country |
CountryCodeEnum |
Optional | - |
line_1 |
String |
Optional | Constraints: Maximum Length: 60 |
line_2 |
String |
Optional | Constraints: Maximum Length: 60 |
postal_code |
String |
Required | Constraints: Maximum Length: 14 |
region |
String |
Optional | Constraints: Maximum Length: 30 |
Example (as JSON)
{
"city": null,
"country": null,
"line1": null,
"line2": null,
"postal_code": "postal_code2",
"region": null
}
Country Opted Out Methods
Class Name
CountryOptedOutMethods
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
debit_cards |
Boolean |
Optional | - |
Example (as JSON)
{
"debit_cards": null
}
Owner of Items
Class Name
OwnerOfItems
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
id |
String |
Required | - |
path |
String |
Required | - |
resource |
String |
Required | - |
Example (as JSON)
{
"id": null,
"path": null,
"resource": "accounts"
}
Terms
Class Name
Terms
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
terms_text |
String |
Optional | - |
terms_uri |
String |
Optional | Constraints: Maximum Length: 2063, Pattern: ^https?://.+$ |
Example (as JSON)
{
"terms_text": null,
"terms_uri": null
}
Weight
Class Name
Weight
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
units |
UnitsEnum |
Required | - |
weight |
Float |
Required | - |
Example (as JSON)
{
"units": "pounds",
"weight": 192.04
}
Phone-Legal Entities-Nullable
Class Name
PhoneLegalEntitiesNullable
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
country_code |
String |
Required | Constraints: Pattern: ^\+?[0-9]{1,3}$ |
phone_number |
String |
Required | Constraints: Pattern: ^[0-9]{1,14}$ |
Example (as JSON)
{
"country_code": "country_code0",
"phone_number": "phone_number2"
}
Human Name-Full-Nullable
Class Name
HumanNameFullNullable
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
first |
String |
Required | Constraints: Minimum Length: 2, Maximum Length: 30 |
last |
String |
Required | Constraints: Minimum Length: 2, Maximum Length: 30 |
middle |
String |
Optional | Constraints: Maximum Length: 30 |
prefix |
String |
Optional | Constraints: Maximum Length: 20 |
suffix |
String |
Optional | Constraints: Maximum Length: 20 |
Example (as JSON)
{
"first": "first6",
"last": "last0",
"middle": null,
"prefix": null,
"suffix": null
}
Address-Legal Entities-Nullable
Class Name
AddressLegalEntitiesNullable
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
city |
String |
Required | Constraints: Maximum Length: 30 |
country |
CountryCodeEnum |
Required | - |
line_1 |
String |
Required | Constraints: Maximum Length: 60 |
line_2 |
String |
Optional | Constraints: Maximum Length: 60 |
postal_code |
String |
Required | Constraints: Maximum Length: 14 |
region |
String |
Required | Constraints: Maximum Length: 30 |
Example (as JSON)
{
"city": "city0",
"country": "HK",
"line1": "line12",
"line2": null,
"postal_code": "postal_code2",
"region": "region6"
}
Mfa-Rbit
Class Name
MfaRbit
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
mfa_action |
MfaActionEnum |
Required | - |
associated_phone |
AssociatedPhone |
Required | - |
Example (as JSON)
{
"mfa_action": "activated",
"associated_phone": {
"country_code": null,
"phone_number": null
}
}
Phone-Rbit
Class Name
PhoneRbit
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
country_code |
String |
Required | Constraints: Pattern: ^\+?[0-9]{1,3}$ |
phone_number |
String |
Required | Constraints: Pattern: ^[0-9]{1,14}$ |
phone_type |
PhoneTypeEnum |
Optional | - |
Example (as JSON)
{
"country_code": "country_code0",
"phone_number": "phone_number2",
"phone_type": null
}
Person-Rbit
Class Name
PersonRbit
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
date_of_birth |
DateOfBirth |
Optional | - |
name |
Name |
Required | - |
role |
RoleEnum |
Optional | - |
Example (as JSON)
{
"date_of_birth": null,
"name": {
"first": "first6",
"last": "last0"
},
"role": null
}
Partner Service-Rbit
Class Name
PartnerServiceRbit
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
currency |
CurrencyEnum |
Optional | - |
modules_used |
Array<PartnerService> |
Optional | - |
service_monthly_cost |
Integer |
Optional | - |
service_name |
String |
Required | Constraints: Maximum Length: 1024 |
Example (as JSON)
{
"currency": null,
"modules_used": null,
"service_monthly_cost": null,
"service_name": "service_name6"
}
Industry Code
Class Name
IndustryCode
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
code |
String |
Required | Constraints: Maximum Length: 32 |
code_type |
CodeTypeEnum |
Required | - |
industry_detail |
String |
Optional | Constraints: Maximum Length: 1024 |
Example (as JSON)
{
"code": "code8",
"code_type": "north_american_industry_classification_system",
"industry_detail": null
}
Fundraising Update
Class Name
FundraisingUpdate
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
campaign_page_update |
String |
Optional | Constraints: Maximum Length: 10000 |
campaign_title_update |
String |
Optional | Constraints: Maximum Length: 255 |
Example (as JSON)
{
"campaign_page_update": null,
"campaign_title_update": null
}
Address-Rbit
Class Name
AddressRbit
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
address_type |
AddressTypeEnum |
Optional | - |
normalized_address |
AddressRbits |
Optional | - |
normalized_address_status |
String |
Optional | Constraints: Maximum Length: 255 |
normalized_source |
String |
Optional | Constraints: Maximum Length: 255 |
origin_address |
AddressRbits |
Required | - |
Example (as JSON)
{
"address_type": null,
"normalized_address": null,
"normalized_address_status": null,
"normalized_source": null,
"origin_address": {
"city": null,
"country": null,
"line1": null,
"line2": null,
"postal_code": "postal_code0",
"region": null
}
}
Auto Billing
Class Name
AutoBilling
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
autobill_setup_time |
Integer |
Optional | - |
payment_frequency |
String |
Optional | Constraints: Maximum Length: 32 |
payment_number |
Integer |
Optional | - |
setup_by |
SetupByEnum |
Optional | - |
total_payments_scheduled |
Integer |
Optional | - |
Example (as JSON)
{
"autobill_setup_time": null,
"payment_frequency": null,
"payment_number": null,
"setup_by": null,
"total_payments_scheduled": null
}
Business Description
Class Name
BusinessDescription
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
description |
String |
Required | Constraints: Maximum Length: 50000 |
number_of_employees |
Integer |
Optional | Constraints: >= 1 |
sales_tax_liability_flag |
Boolean |
Optional | - |
Example (as JSON)
{
"description": "description0",
"number_of_employees": null,
"sales_tax_liability_flag": null
}
Business Name
Class Name
BusinessName
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
name |
String |
Required | Constraints: Maximum Length: 255 |
name_type |
NameTypeEnum |
Optional | - |
Example (as JSON)
{
"name": "name0",
"name_type": null
}
External Account
Class Name
ExternalAccount
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
account_type |
String |
Required | Constraints: Maximum Length: 255 |
connections |
Integer |
Optional | - |
create_time |
Integer |
Optional | - |
feedback_average_score |
Float |
Optional | - |
feedback_score_percent_positive |
Float |
Optional | - |
feedback_scores_provided |
Integer |
Optional | - |
followers |
Integer |
Optional | - |
following |
Integer |
Optional | - |
is_partner_account |
Boolean |
Required | - |
modify_time |
Integer |
Optional | - |
uri |
String |
Optional | Constraints: Maximum Length: 2063, Pattern: ^https?://.+$ |
user_id |
String |
Optional | Constraints: Maximum Length: 255 |
Example (as JSON)
{
"account_type": "account_type4",
"connections": null,
"create_time": null,
"feedback_average_score": null,
"feedback_score_percent_positive": null,
"feedback_scores_provided": null,
"followers": null,
"following": null,
"is_partner_account": false,
"modify_time": null,
"uri": null,
"user_id": null
}
Fundraising Event
Class Name
FundraisingEvent
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
currency |
CurrencyEnum |
Optional | - |
event_time |
Integer |
Optional | - |
fundraising_goal |
Integer |
Optional | - |
giving_deadline |
Integer |
Optional | - |
name |
String |
Required | Constraints: Maximum Length: 255 |
uri |
String |
Optional | Constraints: Maximum Length: 2063, Pattern: ^https?://.+$ |
description |
String |
Optional | Constraints: Maximum Length: 64000 |
photo_uris |
Array<String> |
Optional | Constraints: Maximum Length: 2063, Pattern: ^https?://.+$ |
campaign_category |
String |
Optional | Constraints: Maximum Length: 255 |
campaign_team |
String |
Optional | Constraints: Maximum Length: 255 |
Example (as JSON)
{
"currency": null,
"event_time": null,
"fundraising_goal": null,
"giving_deadline": null,
"name": "name0",
"uri": null,
"description": null,
"photo_uris": null,
"campaign_category": null,
"campaign_team": null
}
Transaction Details
Class Name
TransactionDetails
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
discount |
String |
Optional | Constraints: Maximum Length: 2083 |
itemized_receipt |
Array<ItemizedReceipt> |
Optional | - |
note |
String |
Optional | Constraints: Maximum Length: 2083 |
purchase_order_id |
String |
Optional | Constraints: Maximum Length: 2083 |
receipt_uri |
String |
Optional | Constraints: Maximum Length: 2063, Pattern: ^https?://.+$ |
service_address |
AddressRbits |
Optional | - |
shipping_address |
AddressRbits |
Optional | - |
shipping_info |
Array<ShippingInfo> |
Optional | - |
terms_text |
String |
Optional | Constraints: Maximum Length: 2083 |
terms_uri |
String |
Optional | Constraints: Maximum Length: 2063, Pattern: ^https?://.+$ |
Example (as JSON)
{
"discount": null,
"itemized_receipt": null,
"note": null,
"purchase_order_id": null,
"receipt_uri": null,
"service_address": null,
"shipping_address": null,
"shipping_info": null,
"terms_text": null,
"terms_uri": null
}
Address-Payments-Resp
Class Name
AddressPaymentsResp
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
city |
String |
Optional | Constraints: Maximum Length: 30 |
country |
CountryCodeEnum |
Required | - |
line_1 |
String |
Optional | Constraints: Maximum Length: 60 |
line_2 |
String |
Optional | Constraints: Maximum Length: 60 |
postal_code |
String |
Required | Constraints: Maximum Length: 14 |
region |
String |
Optional | Constraints: Maximum Length: 30 |
Example (as JSON)
{
"city": null,
"country": "HK",
"line1": null,
"line2": null,
"postal_code": "postal_code2",
"region": null
}
Pricing by Currency
Class Name
PricingByCurrency
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
credit_card |
CreditCard |
Optional | - |
payment_bank |
PaymentBank |
Optional | - |
Example (as JSON)
{
"credit_card": null,
"payment_bank": null
}
Countries Opted Out Methods
Class Name
CountriesOptedOutMethods
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
ca |
CountryOptedOutMethods |
Optional | - |
Example (as JSON)
{
"CA": null
}
Item-Nullable-Resp
Class Name
ItemNullableResp
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
create_time |
Integer |
Required | - |
currency |
CurrencyEnum |
Optional | - |
description |
String |
Optional | Constraints: Maximum Length: 2047 |
id |
String |
Required | Constraints: Minimum Length: 1, Maximum Length: 255 |
owner |
OwnerOfItems |
Required | - |
path |
String |
Required | - |
photos |
Array<String> |
Optional | Constraints: Maximum Length: 2063, Pattern: ^https?://.+$ |
price |
Integer |
Optional | - |
product_code |
String |
Optional | Constraints: Maximum Length: 255 |
product_details |
Object |
Optional | - |
product_name |
String |
Required | Constraints: Maximum Length: 255 |
reference_number |
String |
Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
resource |
String |
Required | - |
shipping_options |
Array<String> |
Optional | Constraints: Unique Items Required |
state |
String |
Required | - |
terms |
Terms |
Optional | - |
uri |
String |
Optional | Constraints: Maximum Length: 2063, Pattern: ^https?://.+$ |
weight |
Weight |
Optional | - |
Example (as JSON)
{
"create_time": null,
"id": null,
"owner": {
"id": null,
"path": null,
"resource": "accounts"
},
"path": null,
"product_name": null,
"resource": "items",
"state": null
}
Additional Representative-Req
Class Name
AdditionalRepresentativeReq
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
is_auxiliary_controller |
Boolean |
Optional | - |
is_beneficial_owner |
Boolean |
Optional | - |
address |
AddressLegalEntitiesNullable |
Optional | - |
date_of_birth |
DateOfBirth |
Optional | - |
email |
String |
Optional | Constraints: Maximum Length: 254, Pattern: ^.+@.+\.[a-zA-Z]{2,}$ |
email_is_verified |
Boolean |
Optional | - |
name |
HumanNameFullNullable |
Optional | - |
personal_country_info |
PersonalCountryInfo |
Optional | - |
phone |
PhoneLegalEntitiesNullable |
Optional | - |
job_title |
String |
Optional | Constraints: Minimum Length: 2, Maximum Length: 64 |
Example (as JSON)
{
"is_auxiliary_controller": null,
"is_beneficial_owner": null,
"address": null,
"date_of_birth": null,
"email": null,
"email_is_verified": null,
"name": null,
"personal_country_info": null,
"phone": null,
"job_title": null
}
Address-Payments-Req
Class Name
AddressPaymentsReq
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
city |
String |
Optional | Constraints: Maximum Length: 30 |
country |
CountryCodeEnum |
Required | - |
line_1 |
String |
Optional | Constraints: Maximum Length: 60 |
line_2 |
String |
Optional | Constraints: Maximum Length: 60 |
postal_code |
String |
Required | Constraints: Maximum Length: 14 |
region |
String |
Optional | Constraints: Maximum Length: 30 |
Example (as JSON)
{
"city": null,
"country": "HK",
"line1": null,
"line2": null,
"postal_code": "postal_code2",
"region": null
}
Address-Terminals-Resp
Class Name
AddressTerminalsResp
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
city |
String |
Required | Constraints: Maximum Length: 30 |
country |
CountryCodeEnum |
Required | - |
line_1 |
String |
Required | Constraints: Maximum Length: 60 |
line_2 |
String |
Optional | Constraints: Maximum Length: 60 |
postal_code |
String |
Required | Constraints: Maximum Length: 14 |
region |
String |
Required | Constraints: Maximum Length: 30 |
Example (as JSON)
{
"city": "city0",
"country": "HK",
"line1": "line12",
"line2": null,
"postal_code": "postal_code2",
"region": "region6"
}
Terminals-Tip
Class Name
TerminalsTip
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
mode |
ModeEnum |
Required | The way in which tip is handled by this terminal. If "disabled", tip will not be prompted for. Otherwise, value determines if the prompt should appear on the terminal or on the receipt. Note: If set to "prompt_on_terminal" then you must provide the "terminal_display" field as well. |
terminal_display |
TerminalDisplay |
Optional | This configuration is required if the mode is "prompt_on_terminal", and is responsible for configuring how the tip guide appears on the physical terminal. |
Example (as JSON)
{
"mode": "prompt_on_terminal",
"terminal_display": {
"amount_guide_type": "percentage_guide",
"percentage_guide": {
"show_amount": false,
"percentage_low": 15,
"percentage_medium": 18,
"percentage_high": 20
}
}
}
Quick Chip
Configuration settings for quick chip functionality.
Class Name
QuickChip
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
enabled |
Boolean |
Required | Determines if quick chip functionality is enabled on the terminal. |
Example (as JSON)
{
"enabled": false
}
Additional Representative-Resp
Class Name
AdditionalRepresentativeResp
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
is_auxiliary_controller |
Boolean |
Optional | - |
is_beneficial_owner |
Boolean |
Optional | - |
address |
AddressLegalEntitiesNullable |
Optional | - |
date_of_birth_is_present |
Boolean |
Optional | - |
email |
String |
Optional | Constraints: Maximum Length: 254, Pattern: ^.+@.+\.[a-zA-Z]{2,}$ |
email_is_verified |
Boolean |
Optional | - |
name |
HumanNameFullNullable |
Optional | - |
personal_country_info |
PersonalCountryInfo1 |
Optional | - |
phone |
PhoneLegalEntitiesNullable |
Optional | - |
job_title |
String |
Optional | Constraints: Minimum Length: 2, Maximum Length: 64 |
Example (as JSON)
{
"is_auxiliary_controller": null,
"is_beneficial_owner": null,
"address": null,
"date_of_birth_is_present": null,
"email": null,
"email_is_verified": null,
"name": null,
"personal_country_info": null,
"phone": null,
"job_title": null
}
Deferred Authorization
Configuration settings for deferred authorization functionality.
Class Name
DeferredAuthorization
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
enabled |
Boolean |
Required | Determines if deferred authorization functionality is enabled. |
international_enabled |
Boolean |
Required | Determines if international payment methods are allowed for deferred authorizations. |
max_transaction_count |
Integer |
Required | The maximum number of transactions that can be processed as deferred authorizations. Once exceeded, the terminal will no longer process transactions until connectivity has been restored. Constraints: >= 0 |
max_total_amount |
Integer |
Required | The maximum total amount of transaction volume that can be processed as deferred authorizations. Once exceeded, the terminal will no longer process transactions until connectivity has been restored. Constraints: >= 0 |
max_transaction_amount |
Integer |
Required | The maximum total amount of transaction volume that can be processed as deferred authorizations. Once exceeded, the terminal will no longer process transactions until connectivity has been restored. Constraints: >= 0 |
supported_card_entry_modes |
Array<SupportedCardEntryModeEnum> |
Required | The card entry modes that are allowed in deferred authorizations. |
Example (as JSON)
{
"enabled": null,
"international_enabled": null,
"max_transaction_count": 20,
"max_total_amount": 250000,
"max_transaction_amount": 12500,
"supported_card_entry_modes": [
"chip",
"contactless"
]
}
Holder-Resp
Class Name
HolderResp
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
address |
AddressPaymentsResp |
Optional | - |
email |
String |
Optional | Constraints: Maximum Length: 254, Pattern: ^.+@.+\.[a-zA-Z]{2,}$ |
holder_name |
String |
Required | Constraints: Minimum Length: 2, Maximum Length: 134 |
phone |
Phone |
Optional | - |
Example (as JSON)
{
"address": null,
"email": null,
"holder_name": "holder_name4",
"phone": null
}
Opted Out Methods
Class Name
OptedOutMethods
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
countries |
CountriesOptedOutMethods |
Optional | - |
Example (as JSON)
{
"countries": null
}
Transactions Summary Summaries
Class Name
TransactionsSummarySummaries
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
fee_type |
FeeTypeEnum |
Required | - |
currency |
CurrencyEnum |
Required | - |
total_amount |
Integer |
Required | Constraints: >= 0 |
item_count |
Integer |
Required | Constraints: >= 0 |
Example (as JSON)
{
"fee_type": "ECHECK",
"currency": "CAD",
"total_amount": 112,
"item_count": 38
}
Recovery Pending Reason
Class Name
RecoveryPendingReason
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
details |
Array<Detail> |
Optional | - |
reason_code |
ReasonCodeEnum |
Optional | - |
reason_message |
String |
Optional | - |
Example (as JSON)
{
"details": null,
"reason_code": null,
"reason_message": null
}
Refund Pending Reason
Class Name
RefundPendingReason
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
details |
Array<Detail1> |
Optional | - |
reason_code |
ReasonCode1Enum |
Optional | - |
reason_message |
String |
Optional | - |
Example (as JSON)
{
"details": null,
"reason_code": null,
"reason_message": null
}
Payment Pending Reason
Class Name
PaymentPendingReason
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
details |
Array<Detail2> |
Optional | - |
reason_code |
ReasonCode2Enum |
Optional | - |
reason_message |
String |
Optional | - |
Example (as JSON)
{
"details": null,
"reason_code": null,
"reason_message": null
}
Payout Pending Reason
Class Name
PayoutPendingReason
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
details |
Array<Detail3> |
Optional | - |
reason_code |
ReasonCode3Enum |
Optional | - |
reason_message |
String |
Optional | - |
Example (as JSON)
{
"details": null,
"reason_code": null,
"reason_message": null
}
Transaction Record Non Expanded
Class Name
TransactionRecordNonExpanded
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
id |
String |
Required | - |
path |
String |
Required | - |
resource |
String |
Required | - |
Example (as JSON)
{
"id": null,
"path": null,
"resource": "transaction_records"
}
Payout Failure Reason
Class Name
PayoutFailureReason
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
details |
Array<Detail4> |
Optional | - |
reason_code |
ReasonCode4Enum |
Optional | - |
reason_message |
String |
Optional | - |
Example (as JSON)
{
"details": null,
"reason_code": null,
"reason_message": null
}
Owner Is Account
Owner structure to be used in any resource where an account is the owner
Class Name
OwnerIsAccount
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
id |
String |
Required | - |
path |
String |
Required | - |
resource |
String |
Required | - |
Example (as JSON)
{
"id": null,
"path": null,
"resource": "accounts"
}
Payout Method Non Expanded
Class Name
PayoutMethodNonExpanded
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
id |
String |
Required | - |
path |
String |
Required | - |
resource |
String |
Required | - |
Example (as JSON)
{
"id": null,
"path": null,
"resource": "payout_methods"
}
Payment Method Non Expanded
Class Name
PaymentMethodNonExpanded
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
id |
String |
Required | - |
path |
String |
Required | - |
resource |
String |
Required | - |
Example (as JSON)
{
"id": null,
"path": null,
"resource": "payment_methods"
}
Order Non Expanded
Class Name
OrderNonExpanded
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
id |
String |
Required | - |
path |
String |
Required | - |
resource |
String |
Required | - |
Example (as JSON)
{
"id": null,
"path": null,
"resource": "orders"
}
Payment Failure Reason
Class Name
PaymentFailureReason
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
details |
Array<Detail5> |
Optional | - |
reason_code |
ReasonCode5Enum |
Optional | - |
reason_message |
String |
Optional | - |
Example (as JSON)
{
"details": null,
"reason_code": null,
"reason_message": null
}
Holder-Req
Class Name
HolderReq
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
address |
AddressPaymentsReq |
Required | - |
email |
String |
Optional | Constraints: Maximum Length: 254, Pattern: ^.+@.+\.[a-zA-Z]{2,}$ |
holder_name |
String |
Required | The holder name as it appears on the credit card or bank account statement. Note: all printable characters accepted Constraints: Minimum Length: 3, Maximum Length: 26, Pattern: ^[^\x00-\x1f]+$ |
phone |
Phone1 |
Optional | - |
Example (as JSON)
{
"address": {
"city": null,
"country": "SI",
"line1": null,
"line2": null,
"postal_code": "postal_code8",
"region": null
},
"email": null,
"holder_name": "holder_name4",
"phone": null
}
Token
Class Name
Token
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
id |
String |
Required | Constraints: Minimum Length: 1, Maximum Length: 255 |
permissioned_fields |
Array<String> |
Optional | Constraints: Maximum Length: 1024 |
Example (as JSON)
{
"id": "id0",
"permissioned_fields": null
}
Controller-Req
Class Name
ControllerReq
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
is_beneficial_owner |
Boolean |
Optional | - |
address |
AddressLegalEntitiesNullable |
Optional | - |
date_of_birth |
DateOfBirth |
Optional | - |
email |
String |
Optional | Constraints: Maximum Length: 254, Pattern: ^.+@.+\.[a-zA-Z]{2,}$ |
email_is_verified |
Boolean |
Optional | - |
name |
HumanNameFullNullable |
Optional | - |
personal_country_info |
PersonalCountryInfo |
Optional | - |
phone |
PhoneLegalEntitiesNullable |
Optional | - |
job_title |
String |
Optional | Constraints: Minimum Length: 2, Maximum Length: 64 |
Example (as JSON)
{
"is_beneficial_owner": null,
"address": null,
"date_of_birth": null,
"email": null,
"email_is_verified": null,
"name": null,
"personal_country_info": null,
"phone": null,
"job_title": null
}
Additional Representatives-Req
Class Name
AdditionalRepresentativesReq
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
representative_0 |
AdditionalRepresentativeReq |
Optional | - |
representative_1 |
AdditionalRepresentativeReq |
Optional | - |
representative_2 |
AdditionalRepresentativeReq |
Optional | - |
representative_3 |
AdditionalRepresentativeReq |
Optional | - |
Example (as JSON)
{
"representative_0": null,
"representative_1": null,
"representative_2": null,
"representative_3": null
}
Terms-Nullable
Class Name
TermsNullable
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
terms_text |
String |
Optional | - |
terms_uri |
String |
Optional | Constraints: Maximum Length: 2063, Pattern: ^https?://.+$ |
Example (as JSON)
{
"terms_text": null,
"terms_uri": null
}
Address-Nullable
Class Name
AddressNullable
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
city |
String |
Optional | Constraints: Maximum Length: 30 |
country |
CountryCodeEnum |
Optional | - |
line_1 |
String |
Optional | Constraints: Maximum Length: 60 |
line_2 |
String |
Optional | Constraints: Maximum Length: 60 |
postal_code |
String |
Required | Constraints: Maximum Length: 14 |
region |
String |
Optional | Constraints: Maximum Length: 30 |
Example (as JSON)
{
"city": null,
"country": null,
"line1": null,
"line2": null,
"postal_code": "postal_code2",
"region": null
}
Owner-Legal Entities-Nullable
Class Name
OwnerLegalEntitiesNullable
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
id |
String |
Required | - |
path |
String |
Required | - |
resource |
String |
Required | - |
Example (as JSON)
{
"id": null,
"path": null,
"resource": "legal_entities"
}
Owner-Applications
Class Name
OwnerApplications
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
id |
String |
Required | - |
path |
String |
Optional | - |
resource |
String |
Required | - |
Example (as JSON)
{
"id": null,
"resource": "applications"
}
Controller-Resp
Class Name
ControllerResp
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
is_beneficial_owner |
Boolean |
Optional | - |
address |
AddressLegalEntitiesNullable |
Optional | - |
date_of_birth_is_present |
Boolean |
Optional | - |
email |
String |
Optional | Constraints: Maximum Length: 254, Pattern: ^.+@.+\.[a-zA-Z]{2,}$ |
email_is_verified |
Boolean |
Optional | - |
name |
HumanNameFullNullable |
Optional | - |
personal_country_info |
PersonalCountryInfo1 |
Optional | - |
phone |
PhoneLegalEntitiesNullable |
Optional | - |
job_title |
String |
Optional | Constraints: Minimum Length: 2, Maximum Length: 64 |
Example (as JSON)
{
"is_beneficial_owner": null,
"address": null,
"date_of_birth_is_present": null,
"email": null,
"email_is_verified": null,
"name": null,
"personal_country_info": null,
"phone": null,
"job_title": null
}
Additional Representatives-Resp
Class Name
AdditionalRepresentativesResp
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
representative_0 |
AdditionalRepresentativeResp |
Optional | - |
representative_1 |
AdditionalRepresentativeResp |
Optional | - |
representative_2 |
AdditionalRepresentativeResp |
Optional | - |
representative_3 |
AdditionalRepresentativeResp |
Optional | - |
Example (as JSON)
{
"representative_0": null,
"representative_1": null,
"representative_2": null,
"representative_3": null
}
Recovery Failure Reason
Class Name
RecoveryFailureReason
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
details |
Array<Detail6> |
Optional | - |
reason_code |
ReasonCode6Enum |
Optional | - |
reason_message |
String |
Optional | - |
Example (as JSON)
{
"details": null,
"reason_code": null,
"reason_message": null
}
Dispute Reason
Class Name
DisputeReason
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
reason_code |
ReasonCode7Enum |
Required | The category of dispute reason |
reason_message |
String |
Required | Dispute descriptive reason |
details |
Array<Detail7> |
Optional | - |
Example (as JSON)
{
"reason_code": "INQUIRY",
"reason_message": "reason_message2",
"details": null
}
Payment Non Expanded
Class Name
PaymentNonExpanded
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
id |
String |
Required | - |
path |
String |
Required | - |
resource |
String |
Required | - |
Example (as JSON)
{
"id": null,
"path": null,
"resource": "payments"
}
Pricing
The pricing strategy to collect payment fees for each merchant.
Class Name
Pricing
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
currencies |
Currencies |
Optional | - |
Example (as JSON)
{
"currencies": null
}
Refund-Amounts
Class Name
RefundAmounts
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
total_amount |
Integer |
Required | Constraints: >= 0 |
currency |
CurrencyEnum |
Required | - |
fee_refund_amount |
Integer |
Required | Constraints: >= 0 |
Example (as JSON)
{
"total_amount": 112,
"currency": "CAD",
"fee_refund_amount": 240
}
Payout-Resp
Class Name
PayoutResp
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
currencies |
Currencies1 |
Optional | - |
default_currency |
CurrencyEnum |
Optional | - |
Example (as JSON)
{
"currencies": null,
"default_currency": null
}
Refund Failure Reason
Class Name
RefundFailureReason
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
details |
Array<Detail8> |
Optional | - |
reason_code |
ReasonCode8Enum |
Optional | - |
reason_message |
String |
Optional | - |
Example (as JSON)
{
"details": null,
"reason_code": null,
"reason_message": null
}
Owner-Legal Entities
Class Name
OwnerLegalEntities
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
id |
String |
Required | - |
path |
String |
Required | - |
resource |
String |
Required | - |
Example (as JSON)
{
"id": null,
"path": null,
"resource": "legal_entities"
}
Incoming Payments-Resp
Class Name
IncomingPaymentsResp
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
accepted_methods |
Array<String> |
Required | Constraints: Unique Items Required, Maximum Length: 255 |
opted_out_methods |
OptedOutMethods |
Required | - |
Example (as JSON)
{
"accepted_methods": [
"accepted_methods9"
],
"opted_out_methods": {
"countries": null
}
}
Item-Nullable-Req
Class Name
ItemNullableReq
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
account_id |
String |
Required | Constraints: Minimum Length: 1, Maximum Length: 255 |
currency |
CurrencyEnum |
Optional | - |
description |
String |
Optional | Constraints: Maximum Length: 2047 |
photos |
Array<String> |
Optional | Constraints: Maximum Length: 2063, Pattern: ^https?://.+$ |
price |
Integer |
Optional | - |
product_code |
String |
Optional | Constraints: Maximum Length: 255 |
product_details |
Object |
Optional | - |
product_name |
String |
Required | Constraints: Maximum Length: 255 |
rbits |
Array<EmbeddedRbit> |
Optional | - |
reference_number |
String |
Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
shipping_options |
Array<String> |
Optional | Constraints: Unique Items Required |
terms |
Terms |
Optional | - |
uri |
String |
Optional | Constraints: Maximum Length: 2063, Pattern: ^https?://.+$ |
weight |
Weight |
Optional | - |
Example (as JSON)
{
"account_id": "account_id2",
"currency": null,
"description": null,
"photos": null,
"price": null,
"product_code": null,
"product_details": null,
"product_name": "product_name6",
"rbits": null,
"reference_number": null,
"shipping_options": null,
"terms": null,
"uri": null,
"weight": null
}
Refund-Resp
Class Name
RefundResp
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
amounts |
RefundAmounts |
Required | - |
create_time |
Integer |
Required | - |
custom_data |
Object |
Optional | - |
failure_reason |
RefundFailureReason |
Required | - |
id |
String |
Required | - |
order |
OrderNonExpanded |
Required | - |
owner |
OwnerIsAccount |
Required | Owner structure to be used in any resource where an account is the owner |
path |
String |
Required | - |
payment |
PaymentNonExpanded |
Required | - |
payment_method |
PaymentMethodNonExpanded |
Required | - |
pending_reasons |
Array<RefundPendingReason> |
Optional | - |
refund_reason |
String |
Required | - |
resource |
String |
Required | - |
status |
String |
Required | - |
txnr_app_fee_refund |
TransactionRecordNonExpanded |
Required | - |
txnr_merchant_refund |
TransactionRecordNonExpanded |
Required | - |
api_version |
String |
Optional | - |
reference_id |
String |
Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
Example (as JSON)
{
"amounts": null,
"create_time": null,
"failure_reason": null,
"id": null,
"order": {
"id": null,
"path": null,
"resource": "orders"
},
"owner": {
"id": null,
"path": null,
"resource": "accounts"
},
"path": null,
"payment": {
"id": null,
"path": null,
"resource": "payments"
},
"payment_method": {
"id": null,
"path": null,
"resource": "payment_methods"
},
"refund_reason": null,
"resource": "refunds",
"status": null,
"txnr_app_fee_refund": {
"id": null,
"path": null,
"resource": "transaction_records"
},
"txnr_merchant_refund": {
"id": null,
"path": null,
"resource": "transaction_records"
}
}
Recoveries
Class Name
Recoveries
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
amount |
Integer |
Required | - |
complete_time |
Integer |
Optional | - |
create_time |
Integer |
Required | - |
currency |
String |
Required | - |
custom_data |
Object |
Optional | - |
failure_reason |
RecoveryFailureReason |
Required | - |
id |
String |
Required | - |
owner |
OwnerIsAccount |
Required | Owner structure to be used in any resource where an account is the owner |
path |
String |
Required | - |
payout_method |
PayoutMethodNonExpanded |
Required | - |
pending_reasons |
Array<RecoveryPendingReason> |
Optional | - |
resource |
String |
Required | - |
status |
StatusEnum |
Required | - |
txnr_failure |
TransactionRecordNonExpanded |
Required | - |
txnr_recovery |
TransactionRecordNonExpanded |
Required | - |
api_version |
String |
Optional | - |
Example (as JSON)
{
"amount": null,
"create_time": null,
"currency": null,
"failure_reason": null,
"id": null,
"owner": {
"id": null,
"path": null,
"resource": "accounts"
},
"path": null,
"payout_method": {
"id": null,
"path": null,
"resource": "payout_methods"
},
"resource": "recoveries",
"status": null,
"txnr_failure": {
"id": null,
"path": null,
"resource": "transaction_records"
},
"txnr_recovery": {
"id": null,
"path": null,
"resource": "transaction_records"
}
}
Payout Method-Resp
Class Name
PayoutMethodResp
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
create_time |
Integer |
Optional | - |
custom_data |
Object |
Optional | - |
id |
String |
Required | - |
nickname |
String |
Optional | Constraints: Minimum Length: 1, Maximum Length: 64 |
owner |
OwnerOfItems |
Optional | - |
path |
String |
Required | - |
payout_bank_ca |
PayoutBankCa |
Optional | - |
payout_bank_gb |
PayoutBankGb |
Optional | - |
payout_bank_us |
PayoutBankUs |
Optional | - |
resource |
String |
Required | - |
type |
Type2Enum |
Optional | - |
api_version |
String |
Optional | - |
Example (as JSON)
{
"id": null,
"path": null,
"resource": "payout_methods"
}
Payout
Class Name
Payout
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
amount |
Integer |
Optional | - |
complete_time |
Integer |
Optional | - |
create_time |
Integer |
Optional | - |
currency |
CurrencyEnum |
Optional | - |
custom_data |
Object |
Optional | - |
failure_reason |
PayoutFailureReason |
Optional | - |
id |
String |
Required | - |
owner |
OwnerIsAccount |
Required | Owner structure to be used in any resource where an account is the owner |
path |
String |
Required | - |
payout_method |
PayoutMethodNonExpanded |
Optional | - |
pending_reasons |
Array<PayoutPendingReason> |
Optional | - |
resource |
String |
Required | - |
status |
StatusEnum |
Optional | - |
txnr_failure |
TransactionRecordNonExpanded |
Optional | - |
txnr_payout |
TransactionRecordNonExpanded |
Optional | - |
api_version |
String |
Optional | - |
Example (as JSON)
{
"id": null,
"owner": {
"id": null,
"path": null,
"resource": "accounts"
},
"path": null,
"resource": "payouts"
}
Payment Method-Resp
Class Name
PaymentMethodResp
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
create_time |
Integer |
Required | - |
credit_card |
CreditCard1 |
Optional | - |
custom_data |
Object |
Optional | - |
id |
String |
Required | - |
owner |
OwnerApplications |
Required | - |
path |
String |
Required | - |
payment_bank_us |
PaymentBankUs |
Optional | - |
resource |
String |
Required | - |
status |
Status2Enum |
Required | - |
type |
Type3Enum |
Required | - |
api_version |
String |
Optional | - |
Example (as JSON)
{
"create_time": null,
"id": null,
"owner": {
"id": null,
"resource": "applications"
},
"path": null,
"resource": "payment_methods",
"status": null,
"type": null
}
Payments-V 3 0
Class Name
PaymentsV30
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
amount |
Integer |
Required | - |
amount_refunded |
Integer |
Required | - |
amount_disputed |
Integer |
Required | - |
auto_capture |
Boolean |
Optional | - |
capture_at |
Integer |
Optional | - |
create_time |
Integer |
Required | - |
currency |
CurrencyEnum |
Required | - |
custom_data |
Object |
Optional | - |
failure_reason |
PaymentFailureReason |
Optional | - |
fee_amount |
Integer |
Optional | - |
id |
String |
Required | Constraints: Minimum Length: 1, Maximum Length: 255 |
order |
OrderNonExpanded |
Optional | - |
owner |
OwnerIsAccount |
Required | Owner structure to be used in any resource where an account is the owner |
path |
String |
Required | - |
payment_method |
PaymentMethodNonExpanded |
Required | - |
pending_reasons |
Array<PaymentPendingReason> |
Optional | - |
resource |
String |
Required | - |
status |
Status3Enum |
Required | - |
txnr_app_fee |
TransactionRecordNonExpanded |
Optional | - |
txnr_merchant |
TransactionRecordNonExpanded |
Optional | - |
initiated_by |
InitiatedByRespEnum |
Required | - |
api_version |
String |
Optional | - |
reference_id |
String |
Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
Example (as JSON)
{
"amount": null,
"amount_refunded": null,
"amount_disputed": null,
"create_time": null,
"currency": null,
"id": null,
"owner": {
"id": null,
"path": null,
"resource": "accounts"
},
"path": null,
"payment_method": {
"id": null,
"path": null,
"resource": "payment_methods"
},
"resource": "payments",
"status": null,
"initiated_by": null
}
Payment Bank Us-Req
Class Name
PaymentBankUsReq
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
account_holder |
HolderReq |
Required | - |
account_number |
String |
Required | Constraints: Pattern: ^[0-9]{3,17}$ |
account_type |
AccountTypeEnum |
Required | - |
routing_number |
String |
Required | Constraints: Pattern: ^[0-9]{9}$ |
Example (as JSON)
{
"account_holder": {
"address": {
"city": null,
"country": "SH",
"line1": null,
"line2": null,
"postal_code": "postal_code8",
"region": null
},
"email": null,
"holder_name": "holder_name6",
"phone": null
},
"account_number": "account_number0",
"account_type": "checking",
"routing_number": "routing_number4"
}
Legal Entity
Class Name
LegalEntity
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
additional_representatives |
AdditionalRepresentativesReq |
Optional | - |
address |
AddressLegalEntitiesNullable |
Optional | - |
controller |
ControllerReq |
Optional | - |
country |
CountryCodeEnum |
Required | - |
custom_data |
Object |
Optional | - |
description |
String |
Optional | Constraints: Maximum Length: 1024 |
entity_country_info |
EntityCountryInfo |
Optional | - |
entity_name |
String |
Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
phone |
PhoneLegalEntitiesNullable |
Optional | - |
primary_url |
String |
Optional | Constraints: Maximum Length: 2063, Pattern: ^https?://.+$ |
rbits |
Array<EmbeddedRbit> |
Optional | - |
terms_of_service |
TermsOfService |
Optional | - |
token |
Token |
Optional | - |
reference_id |
String |
Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
Example (as JSON)
{
"additional_representatives": null,
"address": null,
"controller": null,
"country": "HK",
"custom_data": null,
"description": null,
"entity_country_info": null,
"entity_name": null,
"phone": null,
"primary_url": null,
"rbits": null,
"terms_of_service": null,
"token": null,
"reference_id": null
}
Order-Resp
Class Name
OrderResp
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
alternate_tax_amount |
Integer |
Optional | - |
alternate_tax_id |
String |
Optional | Constraints: Maximum Length: 255 |
buyer |
OwnerLegalEntitiesNullable |
Optional | - |
create_time |
Integer |
Optional | - |
currency |
CurrencyNullableEnum |
Optional | - |
customer_reference_number |
String |
Optional | Constraints: Maximum Length: 255 |
delivery_type |
DeliveryTypeEnum |
Optional | - |
discount_amount |
Integer |
Optional | - |
duty_amount |
Integer |
Optional | - |
freight_amount |
Integer |
Optional | - |
grand_total_amount |
Integer |
Optional | - |
id |
String |
Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
line_items |
Array<LineItem> |
Optional | - |
long_description |
String |
Optional | Constraints: Maximum Length: 2047 |
notes |
String |
Optional | Constraints: Maximum Length: 2047 |
owner |
OwnerOfItems |
Optional | - |
path |
String |
Optional | - |
reference_number |
String |
Optional | Constraints: Maximum Length: 255 |
resource |
ResourceEnum |
Optional | - |
service_address |
AddressNullable |
Optional | - |
ship_from_address |
AddressNullable |
Optional | - |
ship_to_address |
AddressNullable |
Optional | - |
shipping_status |
ShippingStatus |
Optional | - |
short_description |
String |
Optional | Constraints: Maximum Length: 255 |
state |
StateEnum |
Optional | - |
status |
Status4Enum |
Optional | - |
tax_amount |
Integer |
Optional | - |
terms |
TermsNullable |
Optional | - |
type |
Type4Enum |
Optional | - |
vat_amount |
Integer |
Optional | - |
vat_rate |
Float |
Optional | - |
api_version |
String |
Optional | - |
Example (as JSON)
{
"alternate_tax_amount": null,
"alternate_tax_id": null,
"buyer": null,
"create_time": null,
"currency": null,
"customer_reference_number": null,
"delivery_type": null,
"discount_amount": null,
"duty_amount": null,
"freight_amount": null,
"grand_total_amount": null,
"id": null,
"line_items": null,
"long_description": null,
"notes": null,
"owner": null,
"path": null,
"reference_number": null,
"resource": null,
"service_address": null,
"ship_from_address": null,
"ship_to_address": null,
"shipping_status": null,
"short_description": null,
"state": null,
"status": null,
"tax_amount": null,
"terms": null,
"type": null,
"vat_amount": null,
"vat_rate": null,
"api_version": null
}
Address-Terminals-Req
Class Name
AddressTerminalsReq
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
city |
String |
Required | Constraints: Maximum Length: 30 |
country |
CountryCodeEnum |
Required | - |
line_1 |
String |
Required | Constraints: Maximum Length: 60 |
line_2 |
String |
Optional | Constraints: Maximum Length: 60 |
postal_code |
String |
Required | Constraints: Maximum Length: 14 |
region |
String |
Required | Constraints: Maximum Length: 30 |
Example (as JSON)
{
"city": "city0",
"country": "HK",
"line1": "line12",
"line2": null,
"postal_code": "postal_code2",
"region": "region6"
}
Contactless Payments-Req
The request schema for modifying contactless payments configuration settings.
Class Name
ContactlessPaymentsReq
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
enabled |
Boolean |
Required | Determines if contactless payments are enabled. |
credit_debit_preference |
CreditDebitPreferenceEnum |
Optional | Determines how the terminal should prefer to charge contactless cards. "credit" is the EMV default, selecting the highest priority application in the card (which is the credit application). Debit preferred attempts to select debit network application on the card first. |
Example (as JSON)
{
"enabled": false,
"credit_debit_preference": null
}
Terminal-Resp
Class Name
TerminalResp
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
id |
String |
Required | Constraints: Minimum Length: 1, Maximum Length: 255 |
resource |
String |
Required | - |
path |
String |
Required | - |
owner |
OwnerIsAccount |
Required | Owner structure to be used in any resource where an account is the owner |
api_version |
String |
Required | - |
status |
TerminalsStatusEnum |
Required | The status of the terminal. Active means the terminal is able to accept authorizations. Inactive means the terminal has been deactivated and is unable to accept payments (this can occur for risk and fraud related reasons). |
serial_number |
String |
Required | The serial number of the terminal. |
model |
ModelEnum |
Required | - |
reference_id |
String |
Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
last_call_home |
Integer |
Required | The epoch timestamp of the last time this terminal called home. |
terminal_application_version |
String |
Required | The version of the application running on the terminal. |
terminal_configuration |
TerminalConfiguration |
Required | - |
gateway_id |
String |
Optional | Unique identifier of the terminal used by our payment gateway Constraints: Minimum Length: 1, Maximum Length: 255 |
Example (as JSON)
{
"id": null,
"resource": "terminals",
"path": null,
"owner": {
"id": null,
"path": null,
"resource": "accounts"
},
"api_version": null,
"status": null,
"serial_number": "FA00332-1000138",
"model": null,
"last_call_home": null,
"terminal_application_version": null,
"terminal_configuration": {
"address": null,
"currency": null,
"supported_card_brands": [
"visa",
"american_express",
"discover",
"mastercard"
],
"credit_debit_preference": null,
"timezone": null,
"tip": {
"mode": "prompt_on_terminal",
"terminal_display": {
"amount_guide_type": "percentage_guide",
"percentage_guide": {
"show_amount": false,
"percentage_low": 15,
"percentage_medium": 18,
"percentage_high": 20
}
}
},
"signature_required": null,
"contactless_payments": null,
"quick_chip": null,
"deferred_authorization": {
"enabled": null,
"international_enabled": null,
"max_transaction_count": 20,
"max_total_amount": 250000,
"max_transaction_amount": 12500,
"supported_card_entry_modes": [
"chip",
"contactless"
]
}
}
}
Legal Entity-Resp
Class Name
LegalEntityResp
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
additional_representatives |
AdditionalRepresentativesResp |
Optional | - |
address |
AddressLegalEntitiesNullable |
Optional | - |
controller |
ControllerResp |
Optional | - |
country |
CountryCodeEnum |
Optional | - |
create_time |
Integer |
Required | - |
custom_data |
Object |
Optional | - |
description |
String |
Optional | Constraints: Maximum Length: 1024 |
entity_country_info |
EntityCountryInfo |
Optional | - |
entity_name |
String |
Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
id |
String |
Required | Constraints: Minimum Length: 1, Maximum Length: 255 |
owner |
OwnerApplications |
Required | - |
path |
String |
Required | - |
phone |
PhoneLegalEntitiesNullable |
Optional | - |
primary_url |
String |
Optional | Constraints: Maximum Length: 2063, Pattern: ^https?://.+$ |
resource |
String |
Required | - |
terms_of_service |
TermsOfService |
Optional | - |
api_version |
String |
Required | - |
reference_id |
String |
Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
Example (as JSON)
{
"create_time": null,
"id": null,
"owner": {
"id": null,
"resource": "applications"
},
"path": null,
"resource": "legal_entities",
"api_version": null
}
Item-Resp
Class Name
ItemResp
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
create_time |
Integer |
Required | - |
currency |
CurrencyNullableEnum |
Optional | - |
description |
String |
Optional | Constraints: Maximum Length: 2047 |
id |
String |
Required | Constraints: Minimum Length: 1, Maximum Length: 255 |
owner |
OwnerOfItems |
Required | - |
path |
String |
Required | - |
photos |
Array<String> |
Optional | Constraints: Maximum Length: 2063, Pattern: ^https?://.+$ |
price |
Integer |
Optional | - |
product_code |
String |
Optional | Constraints: Maximum Length: 255 |
product_details |
Object |
Optional | - |
product_name |
String |
Required | Constraints: Maximum Length: 255 |
reference_number |
String |
Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
resource |
String |
Required | - |
shipping_options |
Array<String> |
Optional | Constraints: Unique Items Required |
state |
StateEnum |
Required | - |
terms |
TermsNullable |
Optional | - |
uri |
String |
Optional | Constraints: Maximum Length: 2063, Pattern: ^https?://.+$ |
weight |
Weight |
Optional | - |
api_version |
String |
Optional | - |
Example (as JSON)
{
"create_time": null,
"id": null,
"owner": {
"id": null,
"path": null,
"resource": "accounts"
},
"path": null,
"product_name": null,
"resource": "items",
"state": null
}
Disputes
Class Name
Disputes
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
amount |
Integer |
Required | - |
create_time |
Integer |
Required | - |
currency |
String |
Required | - |
custom_data |
Object |
Optional | - |
documentation |
Documentation |
Required | - |
fee |
Integer |
Required | - |
id |
String |
Required | - |
owner |
OwnerIsAccount |
Required | Owner structure to be used in any resource where an account is the owner |
path |
String |
Required | - |
payment |
PaymentNonExpanded |
Required | - |
card_brand |
CardBrandEnum |
Required | - |
reason |
DisputeReason |
Required | - |
resolution |
Resolution |
Required | - |
resource |
String |
Required | - |
status |
Status5Enum |
Required | - |
txnr_chargeback_app_fees |
TransactionRecordNonExpanded |
Required | - |
txnr_chargeback_merchant |
TransactionRecordNonExpanded |
Required | - |
txnr_chargeback_reversal_app_fee |
TransactionRecordNonExpanded |
Required | - |
txnr_chargeback_reversal_merchant |
TransactionRecordNonExpanded |
Required | - |
txnr_merchant_chargeback_fee |
TransactionRecordNonExpanded |
Required | - |
type |
Type6Enum |
Required | - |
api_version |
String |
Optional | - |
Example (as JSON)
{
"amount": null,
"create_time": null,
"currency": null,
"documentation": null,
"fee": null,
"id": null,
"owner": {
"id": null,
"path": null,
"resource": "accounts"
},
"path": null,
"payment": {
"id": null,
"path": null,
"resource": "payments"
},
"card_brand": null,
"reason": null,
"resolution": null,
"resource": "disputes",
"status": null,
"txnr_chargeback_app_fees": {
"id": null,
"path": null,
"resource": "transaction_records"
},
"txnr_chargeback_merchant": {
"id": null,
"path": null,
"resource": "transaction_records"
},
"txnr_chargeback_reversal_app_fee": {
"id": null,
"path": null,
"resource": "transaction_records"
},
"txnr_chargeback_reversal_merchant": {
"id": null,
"path": null,
"resource": "transaction_records"
},
"txnr_merchant_chargeback_fee": {
"id": null,
"path": null,
"resource": "transaction_records"
},
"type": null
}
Transactions Summary
Class Name
TransactionsSummary
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
day |
Integer |
Required | Constraints: >= 1, <= 31 |
month |
Integer |
Required | Constraints: >= 1, <= 12 |
year |
Integer |
Required | Constraints: >= 0 |
currency |
CurrencyEnum |
Required | - |
total_amount |
Integer |
Required | Constraints: >= 0 |
item_count |
Integer |
Required | Constraints: >= 0 |
summaries |
Array<TransactionsSummarySummaries> |
Required | Constraints: Unique Items Required |
Example (as JSON)
{
"day": 60,
"month": 232,
"year": 248,
"currency": "CAD",
"total_amount": 112,
"item_count": 38,
"summaries": [
{
"fee_type": "DISCOVER",
"currency": "USD",
"total_amount": 138,
"item_count": 12
},
{
"fee_type": "ECHECK",
"currency": "CAD",
"total_amount": 139,
"item_count": 11
},
{
"fee_type": "CHARGEBACK",
"currency": "GBP",
"total_amount": 140,
"item_count": 10
}
]
}
Interchange Fee
Class Name
InterchangeFee
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
fee_type |
FeeTypeEnum |
Required | - |
fee_category |
String |
Required | Transaction fee category. |
currency |
CurrencyEnum |
Required | - |
total_amount |
Integer |
Required | Total transaction amount in a billing statement for the given fee type and fee category. |
item_count |
Integer |
Required | Number of transactions in a billing statement for the given fee type and fee category. |
variable_fee_bps |
Integer |
Optional | Basis points to calculate variable fee amount. |
fixed_fee_amount |
Integer |
Optional | Fixed fee amount. |
variable_fee_markup_bps |
Integer |
Optional | Basis points to calculate variable markup fee amount. |
fixed_fee_markup_amount |
Integer |
Optional | Fixed fee markup amount. |
total_interchange_fee |
Integer |
Optional | Total interchange fee amount. |
total_markup |
Integer |
Optional | Total markup fee amount. |
total_fees |
Integer |
Required | Total fee amount, sum of interchange fee amount, markup fee amount, and fee amount for other types. |
Example (as JSON)
{
"fee_type": "ECHECK",
"fee_category": "fee_category8",
"currency": "CAD",
"total_amount": 112,
"item_count": 38,
"variable_fee_bps": null,
"fixed_fee_amount": null,
"variable_fee_markup_bps": null,
"fixed_fee_markup_amount": null,
"total_interchange_fee": null,
"total_markup": null,
"total_fees": 10
}
Billing Statement
Class Name
BillingStatement
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
id |
String |
Required | - |
resource |
String |
Required | - |
path |
String |
Required | - |
owner |
OwnerIsAccount |
Required | Owner structure to be used in any resource where an account is the owner |
create_time |
Integer |
Required | - |
amount |
Integer |
Required | - |
currency |
CurrencyEnum |
Required | - |
month |
Integer |
Required | Constraints: >= 1, <= 12 |
year |
Integer |
Required | Constraints: >= 0 |
api_version |
String |
Required | - |
Example (as JSON)
{
"id": null,
"resource": "billing_statements",
"path": null,
"owner": {
"id": null,
"path": null,
"resource": "accounts"
},
"create_time": null,
"amount": null,
"currency": null,
"month": null,
"year": null,
"api_version": null
}
Adjustments
Class Name
Adjustments
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
amount |
Integer |
Required | - |
create_time |
Integer |
Required | - |
currency |
String |
Required | - |
custom_data |
Object |
Optional | - |
id |
String |
Required | - |
reason |
Reason |
Required | - |
owner |
OwnerIsAccount |
Required | Owner structure to be used in any resource where an account is the owner |
path |
String |
Required | - |
resource |
String |
Required | - |
txnr_adjustment |
TransactionRecordNonExpanded |
Required | - |
type |
Type7Enum |
Required | - |
api_version |
String |
Optional | - |
Example (as JSON)
{
"amount": null,
"create_time": null,
"currency": null,
"id": null,
"reason": null,
"owner": {
"id": null,
"path": null,
"resource": "accounts"
},
"path": null,
"resource": "adjustments",
"txnr_adjustment": {
"id": null,
"path": null,
"resource": "transaction_records"
},
"type": null
}
Account-Resp
Class Name
AccountResp
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
balances |
Balances |
Optional | - |
beneficiary |
OwnerLegalEntities |
Optional | - |
create_time |
Integer |
Required | - |
custom_data |
Object |
Optional | - |
description |
String |
Optional | Constraints: Maximum Length: 65535 |
enhanced_review |
String |
Optional | - |
id |
String |
Required | Constraints: Minimum Length: 1, Maximum Length: 255 |
incoming_payments |
IncomingPaymentsResp |
Optional | - |
industry |
Industry |
Optional | - |
name |
String |
Optional | A non-empty string that does not contain the word wepay. Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^((?![Ww][Ee][Pp][Aa][Yy]).)*$ |
owner |
OwnerLegalEntities |
Required | - |
path |
String |
Required | - |
payout |
PayoutResp |
Optional | - |
pricing |
Pricing |
Required | The pricing strategy to collect payment fees for each merchant. |
reference_id |
String |
Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
resource |
String |
Required | - |
statement_description |
String |
Optional | A non-empty ASCII printable string does not contain the word wepay that appears on the merchants’ customers’ credit card statement. Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^((?![Ww][Ee][Pp][Aa][Yy])[ -~])*$ |
api_version |
String |
Required | - |
Example (as JSON)
{
"create_time": null,
"id": null,
"owner": {
"id": null,
"path": null,
"resource": "legal_entities"
},
"path": null,
"pricing": null,
"resource": "accounts",
"api_version": null
}
Transaction Record
Class Name
TransactionRecord
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
create_time |
Integer |
Required | - |
currency |
CurrencyEnum |
Optional | - |
fee_amount |
Integer |
Optional | - |
gross_amount |
Integer |
Optional | - |
id |
String |
Required | - |
net_amount |
Integer |
Optional | - |
owner |
Owner3 |
Optional | - |
path |
String |
Required | - |
resource |
String |
Required | - |
type |
Type8Enum |
Optional | - |
api_version |
String |
Optional | - |
Example (as JSON)
{
"create_time": null,
"id": null,
"path": null,
"resource": "transaction_records"
}
Owner-Accounts
Class Name
OwnerAccounts
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
id |
String |
Required | - |
path |
String |
Required | - |
resource |
String |
Required | - |
Example (as JSON)
{
"id": null,
"path": null,
"resource": "accounts"
}
Incoming Payments-Req
Class Name
IncomingPaymentsReq
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
opted_out_methods |
OptedOutMethods |
Optional | - |
Example (as JSON)
{
"opted_out_methods": null
}
Capture-Amounts
Class Name
CaptureAmounts
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
amount |
Integer |
Required | Constraints: >= 0 |
currency |
CurrencyEnum |
Required | - |
fee_amount |
Integer |
Required | Constraints: >= 0 |
Example (as JSON)
{
"amount": 46,
"currency": "CAD",
"fee_amount": 54
}
Payment Method for Payments
Class Name
PaymentMethodForPayments
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
credit_card |
CreditCard2 |
Optional | - |
custom_data |
Object |
Optional | - |
payment_bank_us |
PaymentBankUsReq |
Optional | - |
payment_method_id |
String |
Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
token |
Token |
Optional | - |
encoded_payment_method |
String |
Optional | Encoded payment data. Currently is used for POS payment tokens but in future may be used for other types of encoded payment information Constraints: Minimum Length: 1, Maximum Length: 2048 |
type |
Type9Enum |
Required | - |
Example (as JSON)
{
"credit_card": null,
"custom_data": null,
"payment_bank_us": null,
"payment_method_id": null,
"token": null,
"encoded_payment_method": null,
"type": "payment_method_id"
}
Payment Method-Req
Class Name
PaymentMethodReq
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
credit_card |
CreditCard2 |
Optional | - |
custom_data |
Object |
Optional | - |
payment_bank_us |
PaymentBankUsReq |
Optional | - |
rbits |
Array<EmbeddedRbit> |
Optional | - |
token |
Token |
Optional | - |
type |
Type3Enum |
Required | - |
Example (as JSON)
{
"credit_card": null,
"custom_data": null,
"payment_bank_us": null,
"rbits": null,
"token": null,
"type": "credit_card"
}
Payout-Req
Class Name
PayoutReq
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
currencies |
Currencies3 |
Optional | - |
default_currency |
CurrencyEnum |
Optional | - |
Example (as JSON)
{
"currencies": null,
"default_currency": null
}
Payout Method-Req
Class Name
PayoutMethodReq
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
custom_data |
Object |
Optional | - |
legal_entity_id |
String |
Required | Constraints: Minimum Length: 1, Maximum Length: 255 |
nickname |
String |
Required | Constraints: Minimum Length: 1, Maximum Length: 64 |
payout_bank_ca |
PayoutBankCa1 |
Optional | - |
payout_bank_gb |
PayoutBankGb1 |
Optional | - |
payout_bank_us |
PayoutBankUs1 |
Optional | - |
rbits |
Array<EmbeddedRbit> |
Optional | - |
token |
Token |
Optional | - |
type |
Type2Enum |
Required | - |
Example (as JSON)
{
"custom_data": null,
"legal_entity_id": "legal_entity_id8",
"nickname": "nickname6",
"payout_bank_ca": null,
"payout_bank_gb": null,
"payout_bank_us": null,
"rbits": null,
"token": null,
"type": "payout_bank_us"
}
Capabilities-Resp
Class Name
CapabilitiesResp
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
id |
String |
Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
owner |
OwnerAccounts |
Required | - |
path |
String |
Required | - |
payments |
Payments |
Required | - |
payouts |
Payouts |
Required | - |
resource |
String |
Required | - |
api_version |
String |
Required | - |
Example (as JSON)
{
"owner": {
"id": null,
"path": null,
"resource": "accounts"
},
"path": null,
"payments": null,
"payouts": null,
"resource": "capabilities",
"api_version": null
}
Item-Req
Class Name
ItemReq
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
account_id |
String |
Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
currency |
CurrencyEnum |
Optional | - |
description |
String |
Optional | Constraints: Maximum Length: 2047 |
photos |
Array<String> |
Optional | Constraints: Maximum Length: 2063, Pattern: ^https?://.+$ |
price |
Integer |
Optional | - |
product_code |
String |
Optional | Constraints: Maximum Length: 255 |
product_details |
Object |
Optional | - |
product_name |
String |
Required | Constraints: Maximum Length: 255 |
rbits |
Array<EmbeddedRbit> |
Optional | - |
reference_number |
String |
Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
shipping_options |
Array<String> |
Optional | Constraints: Unique Items Required |
terms |
Terms |
Optional | - |
uri |
String |
Optional | Constraints: Maximum Length: 2063, Pattern: ^https?://.+$ |
weight |
Weight |
Optional | - |
Example (as JSON)
{
"account_id": null,
"currency": null,
"description": null,
"photos": null,
"price": null,
"product_code": null,
"product_details": null,
"product_name": "product_name6",
"rbits": null,
"reference_number": null,
"shipping_options": null,
"terms": null,
"uri": null,
"weight": null
}
Refund-Req
Class Name
RefundReq
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
amounts |
RefundAmounts |
Optional | - |
custom_data |
Object |
Optional | - |
order_id |
String |
Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
payment_id |
String |
Required | Constraints: Minimum Length: 1, Maximum Length: 255 |
rbits |
Array<EmbeddedRbit> |
Optional | - |
refund_reason |
String |
Required | Constraints: Minimum Length: 1, Maximum Length: 65535 |
reference_id |
String |
Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
Example (as JSON)
{
"amounts": null,
"custom_data": null,
"order_id": null,
"payment_id": "payment_id0",
"rbits": null,
"refund_reason": "refund_reason8",
"reference_id": null
}
Order-Req
Class Name
OrderReq
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
account_id |
String |
Required | Constraints: Minimum Length: 1, Maximum Length: 255 |
alternate_tax_amount |
Integer |
Optional | - |
alternate_tax_id |
String |
Optional | Constraints: Maximum Length: 255 |
buyer |
Buyer |
Optional | - |
currency |
CurrencyEnum |
Optional | - |
customer_reference_number |
String |
Optional | Constraints: Maximum Length: 255 |
delivery_type |
DeliveryTypeEnum |
Optional | - |
discount_amount |
Integer |
Optional | - |
duty_amount |
Integer |
Optional | - |
freight_amount |
Integer |
Optional | - |
grand_total_amount |
Integer |
Optional | - |
line_items |
Array<LineItem1> |
Optional | - |
long_description |
String |
Optional | Constraints: Maximum Length: 2047 |
notes |
String |
Optional | Constraints: Maximum Length: 2047 |
rbits |
Array<EmbeddedRbit> |
Optional | - |
reference_number |
String |
Optional | Constraints: Maximum Length: 255 |
service_address |
AddressPaymentsReq |
Optional | - |
ship_from_address |
AddressPaymentsReq |
Optional | - |
ship_to_address |
AddressPaymentsReq |
Optional | - |
shipping_status |
ShippingStatus1 |
Optional | - |
short_description |
String |
Optional | Constraints: Maximum Length: 255 |
status |
Status4Enum |
Optional | - |
tax_amount |
Integer |
Optional | - |
terms |
Terms |
Optional | - |
type |
Type4Enum |
Required | - |
vat_amount |
Integer |
Optional | - |
vat_rate |
Float |
Optional | - |
Example (as JSON)
{
"account_id": "account_id2",
"alternate_tax_amount": null,
"alternate_tax_id": null,
"buyer": null,
"currency": null,
"customer_reference_number": null,
"delivery_type": null,
"discount_amount": null,
"duty_amount": null,
"freight_amount": null,
"grand_total_amount": null,
"line_items": null,
"long_description": null,
"notes": null,
"rbits": null,
"reference_number": null,
"service_address": null,
"ship_from_address": null,
"ship_to_address": null,
"shipping_status": null,
"short_description": null,
"status": null,
"tax_amount": null,
"terms": null,
"type": "goods",
"vat_amount": null,
"vat_rate": null
}
Accounts Capabilities Request
Class Name
AccountsCapabilitiesRequest
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
payments |
Payments1 |
Optional | - |
payouts |
Payouts1 |
Optional | - |
Example (as JSON)
{
"payments": null,
"payouts": null
}
Accounts Request
Class Name
AccountsRequest
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
beneficiary_legal_entity_id |
String |
Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
custom_data |
Object |
Optional | - |
description |
String |
Optional | Constraints: Maximum Length: 65535 |
incoming_payments |
IncomingPaymentsReq |
Optional | - |
industry |
Industry |
Optional | - |
legal_entity_id |
String |
Required | Constraints: Minimum Length: 1, Maximum Length: 255 |
name |
String |
Optional | A non-empty string that does not contain the word wepay. Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^((?![Ww][Ee][Pp][Aa][Yy]).)*$ |
payout |
PayoutReq |
Optional | - |
pricing |
Pricing |
Optional | The pricing strategy to collect payment fees for each merchant. |
rbits |
Array<EmbeddedRbit> |
Optional | - |
reference_id |
String |
Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
statement_description |
String |
Optional | A non-empty ASCII printable string does not contain the word wepay that appears on the merchants’ customers’ credit card statement. Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^((?![Ww][Ee][Pp][Aa][Yy])[ -~])*$ |
Example (as JSON)
{
"beneficiary_legal_entity_id": null,
"custom_data": null,
"description": null,
"incoming_payments": null,
"industry": null,
"legal_entity_id": "legal_entity_id8",
"name": null,
"payout": null,
"pricing": null,
"rbits": null,
"reference_id": null,
"statement_description": null
}
Accounts Request 1
Class Name
AccountsRequest1
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
beneficiary_legal_entity_id |
String |
Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
custom_data |
Object |
Optional | - |
description |
String |
Optional | Constraints: Maximum Length: 65535 |
incoming_payments |
IncomingPaymentsReq |
Optional | - |
industry |
Industry |
Optional | - |
name |
String |
Optional | A non-empty string that does not contain the word wepay. Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^((?![Ww][Ee][Pp][Aa][Yy]).)*$ |
payout |
PayoutReq |
Optional | - |
pricing |
Pricing |
Optional | The pricing strategy to collect payment fees for each merchant. |
rbits |
Array<EmbeddedRbit> |
Optional | - |
reference_id |
String |
Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
statement_description |
String |
Optional | A non-empty ASCII printable string does not contain the word wepay that appears on the merchants’ customers’ credit card statement. Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^((?![Ww][Ee][Pp][Aa][Yy])[ -~])*$ |
Example (as JSON)
{
"beneficiary_legal_entity_id": null,
"custom_data": null,
"description": null,
"incoming_payments": null,
"industry": null,
"name": null,
"payout": null,
"pricing": null,
"rbits": null,
"reference_id": null,
"statement_description": null
}
Accounts Response
Class Name
AccountsResponse
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
mnext |
String |
Optional | - |
previous |
String |
Optional | - |
results |
Array<AccountResp> |
Required | Constraints: Unique Items Required |
api_version |
String |
Optional | - |
Example (as JSON)
{
"results": {
"create_time": null,
"id": null,
"owner": {
"id": null,
"path": null,
"resource": "legal_entities"
},
"path": null,
"pricing": null,
"resource": "accounts",
"api_version": null
}
}
Additional Representatives
Class Name
AdditionalRepresentatives
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
representative_0 |
Representative0 |
Optional | - |
representative_1 |
Representative0 |
Optional | - |
representative_2 |
Representative0 |
Optional | - |
representative_3 |
Representative0 |
Optional | - |
Example (as JSON)
{
"representative_0": null,
"representative_1": null,
"representative_2": null,
"representative_3": null
}
Additional Representatives 1
Class Name
AdditionalRepresentatives1
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
representative_0 |
Representative01 |
Optional | - |
representative_1 |
Representative01 |
Optional | - |
representative_2 |
Representative01 |
Optional | - |
representative_3 |
Representative01 |
Optional | - |
Example (as JSON)
{
"representative_0": null,
"representative_1": null,
"representative_2": null,
"representative_3": null
}
Adjustments Request
Class Name
AdjustmentsRequest
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
custom_data |
Object |
Optional | - |
rbits |
Array<EmbeddedRbit> |
Optional | - |
Example (as JSON)
{
"custom_data": null,
"rbits": null
}
Adjustments Response
Class Name
AdjustmentsResponse
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
mnext |
String |
Optional | - |
previous |
String |
Optional | - |
results |
Array<Adjustments> |
Required | Constraints: Unique Items Required |
api_version |
String |
Optional | - |
Example (as JSON)
{
"results": {
"amount": null,
"create_time": null,
"currency": null,
"id": null,
"reason": null,
"owner": {
"id": null,
"path": null,
"resource": "accounts"
},
"path": null,
"resource": "adjustments",
"txnr_adjustment": {
"id": null,
"path": null,
"resource": "transaction_records"
},
"type": null
}
}
Application Block
Class Name
ApplicationBlock
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
reason |
String |
Optional | Constraints: Maximum Length: 255 |
Example (as JSON)
{
"reason": null
}
Application Block 4
Class Name
ApplicationBlock4
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
is_blocked |
Boolean |
Required | - |
reason |
String |
Required | Constraints: Maximum Length: 255 |
Example (as JSON)
{
"is_blocked": false,
"reason": "reason4"
}
Associated Phone
Class Name
AssociatedPhone
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
country_code |
String |
Optional | Constraints: Pattern: ^\+?[0-9]{1,3}$ |
phone_number |
String |
Optional | Constraints: Pattern: ^[0-9]{1,14}$ |
Example (as JSON)
{
"country_code": null,
"phone_number": null
}
Associated Resource
Class Name
AssociatedResource
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
id |
String |
Required | Constraints: Minimum Length: 1, Maximum Length: 255 |
resource |
ResourceTypesRbitEnum |
Required | - |
Example (as JSON)
{
"id": "id0",
"resource": "payments"
}
Balances
Class Name
Balances
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
currencies |
Currencies2 |
Optional | - |
Example (as JSON)
{
"currencies": null
}
Billing Statements Interchange Fees Response
Class Name
BillingStatementsInterchangeFeesResponse
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
mnext |
String |
Optional | - |
previous |
String |
Optional | - |
results |
Array<InterchangeFee> |
Required | Constraints: Unique Items Required |
api_version |
String |
Required | - |
Example (as JSON)
{
"next": null,
"previous": null,
"results": [
{
"fee_type": "ECHECK",
"fee_category": "fee_category5",
"currency": "CAD",
"total_amount": 29,
"item_count": 121,
"variable_fee_bps": null,
"fixed_fee_amount": null,
"variable_fee_markup_bps": null,
"fixed_fee_markup_amount": null,
"total_interchange_fee": null,
"total_markup": null,
"total_fees": 183
}
],
"api_version": "api_version8"
}
Billing Statements Response
Class Name
BillingStatementsResponse
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
mnext |
String |
Optional | - |
previous |
String |
Optional | - |
results |
Array<BillingStatement> |
Required | Constraints: Unique Items Required |
api_version |
String |
Required | - |
Example (as JSON)
{
"results": {
"id": null,
"resource": "billing_statements",
"path": null,
"owner": {
"id": null,
"path": null,
"resource": "accounts"
},
"create_time": null,
"amount": null,
"currency": null,
"month": null,
"year": null,
"api_version": null
},
"api_version": null
}
Billing Statements Transactions Summary Response
Class Name
BillingStatementsTransactionsSummaryResponse
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
mnext |
String |
Optional | - |
previous |
String |
Optional | - |
results |
Array<TransactionsSummary> |
Required | Constraints: Unique Items Required |
api_version |
String |
Required | - |
Example (as JSON)
{
"next": null,
"previous": null,
"results": [
{
"day": 143,
"month": 149,
"year": 75,
"currency": "CAD",
"total_amount": 29,
"item_count": 121,
"summaries": [
{
"fee_type": "DISCOVER",
"currency": "USD",
"total_amount": 221,
"item_count": 185
},
{
"fee_type": "ECHECK",
"currency": "CAD",
"total_amount": 222,
"item_count": 184
},
{
"fee_type": "CHARGEBACK",
"currency": "GBP",
"total_amount": 223,
"item_count": 183
}
]
}
],
"api_version": "api_version8"
}
Buyer
Class Name
Buyer
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
legal_entity |
LegalEntity |
Optional | - |
legal_entity_id |
String |
Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
type |
Type12Enum |
Required | - |
Example (as JSON)
{
"legal_entity": null,
"legal_entity_id": null,
"type": "legal_entity"
}
CA
Class Name
CA
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
social_insurance_number |
String |
Optional | Constraints: Pattern: ^\d{3}[ -]?\d{3}[ -]?\d{3}$ |
Example (as JSON)
{
"social_insurance_number": null
}
CA1
Class Name
CA1
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
social_insurance_number_is_present |
Boolean |
Optional | - |
Example (as JSON)
{
"social_insurance_number_is_present": null
}
CA4
Class Name
CA4
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
business_number |
String |
Optional | Constraints: Pattern: ^\d{9}$ |
legal_form |
LegalFormEnum |
Optional | - |
Example (as JSON)
{
"business_number": null,
"legal_form": null
}
CAD
Class Name
CAD
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
next_payout_time |
Integer |
Optional | - |
payout_method_id |
String |
Optional | - |
period |
PeriodEnum |
Optional | - |
Example (as JSON)
{
"next_payout_time": null,
"payout_method_id": null,
"period": null
}
CAD1
Class Name
CAD1
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
balance |
Integer |
Optional | - |
incoming_pending |
Integer |
Optional | - |
outgoing_pending |
Integer |
Optional | - |
reserve |
Integer |
Optional | - |
Example (as JSON)
{
"balance": null,
"incoming_pending": null,
"outgoing_pending": null,
"reserve": null
}
CAD2
Class Name
CAD2
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
payout_method_id |
String |
Required | Constraints: Maximum Length: 255 |
period |
PeriodEnum |
Required | - |
Example (as JSON)
{
"payout_method_id": "payout_method_id2",
"period": "weekly"
}
Contactless Payments
The response schema for contactless payments configuration.
Class Name
ContactlessPayments
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
enabled |
Boolean |
Required | - |
credit_debit_preference |
CreditDebitPreferenceEnum |
Required | Determines how the terminal should prefer to charge contactless cards. "credit" is the EMV default, selecting the highest priority application in the card (which is the credit application). Debit preferred attempts to select debit network application on the card first. |
Example (as JSON)
{
"enabled": false,
"credit_debit_preference": "credit"
}
Controller
Class Name
Controller
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
personal_verification |
PersonalVerification |
Optional | - |
Example (as JSON)
{
"personal_verification": null
}
Controller 1
Class Name
Controller1
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
personal_verification |
PersonalVerification5 |
Required | - |
Example (as JSON)
{
"personal_verification": {
"current_issues": null,
"documents": null,
"verified": false
}
}
Credit Card
Class Name
CreditCard
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
interchange_plus |
InterchangePlus |
Optional | The interchange plus pricing model for credit cards to collect platform markup fees. |
type |
String |
Required | - |
Example (as JSON)
{
"type": "interchange_plus"
}
Credit Card 1
Class Name
CreditCard1
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
auto_update |
Boolean |
Optional | - |
backing_display_name |
String |
Optional | - |
bin |
String |
Optional | - |
card_brand |
CardBrandEnum |
Optional | - |
card_entry_type |
CardEntryTypeEnum |
Optional | - |
card_holder |
HolderResp |
Required | - |
display_name |
String |
Optional | - |
expiration_month |
Integer |
Required | - |
expiration_year |
Integer |
Required | - |
last_four |
String |
Optional | - |
virtual_terminal_mode |
VirtualTerminalModeEnum |
Optional | - |
card_on_file |
Boolean |
Required | - |
recurring |
Boolean |
Required | - |
cvv_provided |
Boolean |
Required | - |
Example (as JSON)
{
"auto_update": null,
"backing_display_name": null,
"bin": null,
"card_brand": null,
"card_entry_type": null,
"card_holder": {
"address": null,
"email": null,
"holder_name": "holder_name6",
"phone": null
},
"display_name": null,
"expiration_month": 226,
"expiration_year": 0,
"last_four": null,
"virtual_terminal_mode": null,
"card_on_file": false,
"recurring": false,
"cvv_provided": false
}
Credit Card 2
Class Name
CreditCard2
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
auto_update |
Boolean |
Optional | - |
card_holder |
HolderReq |
Required | - |
card_number |
String |
Required | Constraints: Pattern: ^[0-9]{12,19}$ |
cvv |
String |
Optional | Constraints: Pattern: ^[0-9]{3,4}$ |
expiration_month |
Integer |
Required | Constraints: >= 1, <= 12 |
expiration_year |
Integer |
Required | - |
trigger_verification |
Boolean |
Optional | - |
virtual_terminal_mode |
VirtualTerminalModeEnum |
Optional | - |
card_on_file |
Boolean |
Optional | - |
recurring |
Boolean |
Optional | - |
Example (as JSON)
{
"auto_update": null,
"card_holder": {
"address": {
"city": null,
"country": "IO",
"line1": null,
"line2": null,
"postal_code": "postal_code8",
"region": null
},
"email": null,
"holder_name": "holder_name6",
"phone": null
},
"card_number": "card_number6",
"cvv": null,
"expiration_month": 226,
"expiration_year": 0,
"trigger_verification": null,
"virtual_terminal_mode": null,
"card_on_file": null,
"recurring": null
}
Credit Card 4
Credit card structure to be used for updating credit card information.
Class Name
CreditCard4
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
card_on_file |
Boolean |
Optional | - |
recurring |
Boolean |
Optional | - |
Example (as JSON)
{
"card_on_file": null,
"recurring": null
}
Currencies
Class Name
Currencies
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
cad |
PricingByCurrency |
Optional | - |
gbp |
PricingByCurrency |
Optional | - |
usd |
PricingByCurrency |
Optional | - |
Example (as JSON)
{
"CAD": null,
"GBP": null,
"USD": null
}
Currencies 1
Class Name
Currencies1
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
cad |
CAD |
Optional | - |
gbp |
GBP |
Optional | - |
usd |
USD |
Optional | - |
Example (as JSON)
{
"CAD": null,
"GBP": null,
"USD": null
}
Currencies 2
Class Name
Currencies2
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
usd |
USD1 |
Optional | - |
cad |
CAD1 |
Optional | - |
gbp |
GBP1 |
Optional | - |
Example (as JSON)
{
"USD": null,
"CAD": null,
"GBP": null
}
Currencies 3
Class Name
Currencies3
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
cad |
CAD2 |
Optional | - |
gbp |
GBP2 |
Optional | - |
usd |
USD2 |
Optional | - |
Example (as JSON)
{
"CAD": null,
"GBP": null,
"USD": null
}
Current Issue
Class Name
CurrentIssue
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
additional_documents_required |
Array<String> |
Optional | - |
errant_fields |
Hash |
Optional | - |
in_review |
Array<String> |
Optional | - |
application_block |
ApplicationBlock |
Optional | - |
issue_type |
IssueTypeEnum |
Required | - |
target |
Target |
Required | - |
Example (as JSON)
{
"additional_documents_required": null,
"errant_fields": null,
"in_review": null,
"application_block": null,
"issue_type": "additional_documents_required",
"target": {
"id": null,
"path": null,
"resource": null
}
}
Current Issue 2
Class Name
CurrentIssue2
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
additional_documents_required |
Array<String> |
Optional | - |
errant_fields |
Hash |
Optional | - |
in_review |
Array<String> |
Optional | - |
issue_type |
IssueType4Enum |
Required | - |
target |
Target |
Required | - |
Example (as JSON)
{
"additional_documents_required": null,
"errant_fields": null,
"in_review": null,
"issue_type": "in_review",
"target": {
"id": null,
"path": null,
"resource": null
}
}
Date of Birth
Class Name
DateOfBirth
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
day |
Integer |
Required | Constraints: >= 1, <= 31 |
month |
Integer |
Required | Constraints: >= 1, <= 12 |
year |
Integer |
Required | Constraints: >= 1900 |
Example (as JSON)
{
"day": 60,
"month": 232,
"year": 248
}
Detail
Class Name
Detail
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
detail_code |
DetailCodeEnum |
Optional | - |
detail_message |
String |
Optional | - |
Example (as JSON)
{
"detail_code": null,
"detail_message": null
}
Detail 1
Class Name
Detail1
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
detail_code |
DetailCode1Enum |
Optional | - |
detail_message |
String |
Optional | - |
Example (as JSON)
{
"detail_code": null,
"detail_message": null
}
Detail 2
Class Name
Detail2
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
detail_code |
DetailCode2Enum |
Optional | - |
detail_message |
String |
Optional | - |
Example (as JSON)
{
"detail_code": null,
"detail_message": null
}
Detail 3
Class Name
Detail3
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
detail_code |
DetailCode3Enum |
Optional | - |
detail_message |
String |
Optional | - |
Example (as JSON)
{
"detail_code": null,
"detail_message": null
}
Detail 4
Class Name
Detail4
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
detail_code |
DetailCode4Enum |
Optional | - |
detail_message |
String |
Optional | - |
Example (as JSON)
{
"detail_code": null,
"detail_message": null
}
Detail 5
Class Name
Detail5
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
detail_code |
DetailCode5Enum |
Optional | - |
detail_message |
String |
Optional | - |
Example (as JSON)
{
"detail_code": null,
"detail_message": null
}
Detail 6
Class Name
Detail6
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
detail_code |
DetailCode6Enum |
Optional | - |
detail_message |
String |
Optional | - |
Example (as JSON)
{
"detail_code": null,
"detail_message": null
}
Detail 7
Class Name
Detail7
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
detail_code |
DetailCode7Enum |
Required | Chargeback code for visa, mastercard, amex, and discover cards |
detail_message |
String |
Required | The detail a chargeback is being disputed |
Example (as JSON)
{
"detail_code": "C31",
"detail_message": "detail_message8"
}
Detail 8
Class Name
Detail8
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
detail_code |
DetailCode8Enum |
Optional | - |
detail_message |
String |
Optional | - |
Example (as JSON)
{
"detail_code": null,
"detail_message": null
}
Detail 9
Class Name
Detail9
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
detail_code |
DetailCode9Enum |
Required | Adjustment detail code |
detail_message |
String |
Required | Adjustment detail message for manual adjustment |
Example (as JSON)
{
"detail_code": "cross_border",
"detail_message": "detail_message8"
}
Detail 10
Class Name
Detail10
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
detail_code |
DetailCode10Enum |
Required | - |
detail_message |
String |
Optional | - |
Example (as JSON)
{
"detail_code": "info_mismatch",
"detail_message": null
}
Disputes Request
Class Name
DisputesRequest
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
custom_data |
Object |
Optional | - |
documentation |
Documentation1 |
Optional | - |
rbits |
Array<EmbeddedRbit> |
Optional | - |
Example (as JSON)
{
"custom_data": null,
"documentation": null,
"rbits": null
}
Disputes Response
Class Name
DisputesResponse
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
mnext |
String |
Optional | - |
previous |
String |
Optional | - |
results |
Array<Disputes> |
Required | Constraints: Unique Items Required |
api_version |
String |
Optional | - |
Example (as JSON)
{
"results": {
"amount": null,
"create_time": null,
"currency": null,
"documentation": null,
"fee": null,
"id": null,
"owner": {
"id": null,
"path": null,
"resource": "accounts"
},
"path": null,
"payment": {
"id": null,
"path": null,
"resource": "payments"
},
"card_brand": null,
"reason": null,
"resolution": null,
"resource": "disputes",
"status": null,
"txnr_chargeback_app_fees": {
"id": null,
"path": null,
"resource": "transaction_records"
},
"txnr_chargeback_merchant": {
"id": null,
"path": null,
"resource": "transaction_records"
},
"txnr_chargeback_reversal_app_fee": {
"id": null,
"path": null,
"resource": "transaction_records"
},
"txnr_chargeback_reversal_merchant": {
"id": null,
"path": null,
"resource": "transaction_records"
},
"txnr_merchant_chargeback_fee": {
"id": null,
"path": null,
"resource": "transaction_records"
},
"type": null
}
}
Document
Class Name
Document
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
create_time |
Integer |
Required | - |
id |
String |
Required | Constraints: Minimum Length: 1, Maximum Length: 255 |
owner |
OwnerApplications |
Required | - |
path |
String |
Optional | - |
reject_reason |
RejectReason |
Required | - |
resource |
String |
Required | - |
status |
Status8Enum |
Required | - |
type |
Type15Enum |
Required | - |
Example (as JSON)
{
"create_time": null,
"id": null,
"owner": {
"id": null,
"resource": "applications"
},
"reject_reason": {
"details": null,
"reason_code": "failed_risk_review",
"reason_message": null
},
"resource": "documents",
"status": null,
"type": null
}
Documentation
Class Name
Documentation
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
documents |
Array<String> |
Optional | - |
explanation |
String |
Optional | - |
Example (as JSON)
{
"documents": null,
"explanation": null
}
Documentation 1
Class Name
Documentation1
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
documents |
Array<String> |
Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
explanation |
String |
Optional | Constraints: Maximum Length: 65535 |
Example (as JSON)
{
"documents": null,
"explanation": null
}
Embedded-Rbit
Class Name
EmbeddedRbit
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
address |
AddressRbit |
Optional | - |
auto_billing |
AutoBilling |
Optional | - |
business_description |
BusinessDescription |
Optional | - |
business_name |
BusinessName |
Optional | - |
external_account |
ExternalAccount |
Optional | - |
fundraising_event |
FundraisingEvent |
Optional | - |
fundraising_update |
FundraisingUpdate |
Optional | - |
industry_code |
IndustryCode |
Optional | - |
partner_service |
PartnerServiceRbit |
Optional | - |
person |
PersonRbit |
Optional | - |
phone |
PhoneRbit |
Optional | - |
mfa |
MfaRbit |
Optional | - |
receive_time |
Integer |
Required | - |
source |
RbitSourceEnum |
Required | - |
transaction_details |
TransactionDetails |
Optional | - |
type |
RbitTypesEnum |
Required | - |
Example (as JSON)
{
"address": null,
"auto_billing": null,
"business_description": null,
"business_name": null,
"external_account": null,
"fundraising_event": null,
"fundraising_update": null,
"industry_code": null,
"partner_service": null,
"person": null,
"phone": null,
"mfa": null,
"receive_time": 38,
"source": "user",
"transaction_details": null,
"type": "fundraising_event"
}
Entity Country Info
Class Name
EntityCountryInfo
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
ca |
CA4 |
Optional | - |
gb |
GB |
Optional | - |
us |
US4 |
Optional | - |
Example (as JSON)
{
"CA": null,
"GB": null,
"US": null
}
Entity Verification
Class Name
EntityVerification
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
documents |
Array<String> |
Optional | Constraints: Unique Items Required |
Example (as JSON)
{
"documents": null
}
Entity Verification 1
Class Name
EntityVerification1
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
current_issues |
Array<CurrentIssue2> |
Optional | - |
documents |
Array<Document> |
Optional | - |
verified |
Boolean |
Required | - |
Example (as JSON)
{
"current_issues": null,
"documents": null,
"verified": false
}
Flat Guide
The configuration for a flat tip guide. All three guides must be provided.
Class Name
FlatGuide
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
amount_low |
Integer |
Required | The 'low' guide. Constraints: >= 0 |
amount_medium |
Integer |
Required | The 'medium' guide. Constraints: >= 0 |
amount_high |
Integer |
Required | The 'high' guide. Constraints: >= 0 |
Example (as JSON)
{
"amount_low": 220,
"amount_medium": 60,
"amount_high": 230
}
GB
Class Name
GB
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
company_registration_number |
String |
Optional | Constraints: Pattern: ^[A-Z0-9]{2}\d{6}$ |
legal_form |
LegalForm1Enum |
Optional | - |
Example (as JSON)
{
"company_registration_number": null,
"legal_form": null
}
GBP
Class Name
GBP
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
next_payout_time |
Integer |
Optional | - |
payout_method_id |
String |
Optional | - |
period |
PeriodEnum |
Optional | - |
Example (as JSON)
{
"next_payout_time": null,
"payout_method_id": null,
"period": null
}
GBP1
Class Name
GBP1
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
balance |
Integer |
Optional | - |
incoming_pending |
Integer |
Optional | - |
outgoing_pending |
Integer |
Optional | - |
reserve |
Integer |
Optional | - |
Example (as JSON)
{
"balance": null,
"incoming_pending": null,
"outgoing_pending": null,
"reserve": null
}
GBP2
Class Name
GBP2
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
payout_method_id |
String |
Required | Constraints: Maximum Length: 255 |
period |
PeriodEnum |
Required | - |
Example (as JSON)
{
"payout_method_id": "payout_method_id2",
"period": "weekly"
}
Industry
Class Name
Industry
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
category_detail |
String |
Optional | Constraints: Maximum Length: 1024 |
merchant_category_code |
String |
Optional | Constraints: Pattern: ^\d{4}$ |
Example (as JSON)
{
"category_detail": null,
"merchant_category_code": null
}
Interchange Plus
The interchange plus pricing model for credit cards to collect platform markup fees.
Class Name
InterchangePlus
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
fixed_fee_markup_amount |
Integer |
Optional | The fixed markup fee amount. Constraints: >= 0, <= 100 |
variable_fee_markup_bps |
Integer |
Optional | The basis points to calculate variable markup fee amount. Constraints: >= 0, <= 100 |
Example (as JSON)
{
"fixed_fee_markup_amount": null,
"variable_fee_markup_bps": null
}
Itemized Receipt
Class Name
ItemizedReceipt
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
amount |
Float |
Required | - |
currency |
CurrencyEnum |
Optional | - |
description |
String |
Required | Constraints: Maximum Length: 1024 |
item_price |
Integer |
Required | - |
project_name |
String |
Optional | Constraints: Maximum Length: 1024 |
quantity |
Float |
Required | - |
service_billing_method |
ServiceBillingMethodEnum |
Optional | - |
Example (as JSON)
{
"amount": 56.78,
"currency": null,
"description": "description0",
"item_price": 22,
"project_name": null,
"quantity": 149.16,
"service_billing_method": null
}
Items Response
Class Name
ItemsResponse
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
mnext |
String |
Optional | - |
previous |
String |
Optional | - |
results |
Array<ItemResp> |
Required | - |
api_version |
String |
Optional | - |
Example (as JSON)
{
"results": {
"create_time": null,
"id": null,
"owner": {
"id": null,
"path": null,
"resource": "accounts"
},
"path": null,
"product_name": null,
"resource": "items",
"state": null
}
}
Legal Entities Request
Class Name
LegalEntitiesRequest
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
additional_representatives |
AdditionalRepresentativesReq |
Optional | - |
address |
AddressLegalEntitiesNullable |
Optional | - |
controller |
ControllerReq |
Optional | - |
custom_data |
Object |
Optional | - |
description |
String |
Optional | Constraints: Maximum Length: 1024 |
entity_country_info |
EntityCountryInfo |
Optional | - |
entity_name |
String |
Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
phone |
PhoneLegalEntitiesNullable |
Optional | - |
primary_url |
String |
Optional | Constraints: Maximum Length: 2063, Pattern: ^https?://.+$ |
rbits |
Array<EmbeddedRbit> |
Optional | - |
terms_of_service |
TermsOfService |
Optional | - |
token |
Token |
Optional | - |
reference_id |
String |
Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
Example (as JSON)
{
"additional_representatives": null,
"address": null,
"controller": null,
"custom_data": null,
"description": null,
"entity_country_info": null,
"entity_name": null,
"phone": null,
"primary_url": null,
"rbits": null,
"terms_of_service": null,
"token": null,
"reference_id": null
}
Legal Entities Response
Class Name
LegalEntitiesResponse
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
mnext |
String |
Optional | - |
previous |
String |
Optional | - |
results |
Array<LegalEntityResp> |
Required | Constraints: Unique Items Required |
api_version |
String |
Optional | - |
Example (as JSON)
{
"results": {
"create_time": null,
"id": null,
"owner": {
"id": null,
"resource": "applications"
},
"path": null,
"resource": "legal_entities",
"api_version": null
}
}
Legal Entities Verifications Request
Class Name
LegalEntitiesVerificationsRequest
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
additional_representatives |
AdditionalRepresentatives |
Optional | - |
controller |
Controller |
Optional | - |
entity_verification |
EntityVerification |
Optional | - |
Example (as JSON)
{
"additional_representatives": null,
"controller": null,
"entity_verification": null
}
Legal Entities Verifications Response
Class Name
LegalEntitiesVerificationsResponse
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
additional_representatives |
AdditionalRepresentatives1 |
Required | - |
controller |
Controller1 |
Required | - |
entity_verification |
EntityVerification1 |
Required | - |
id |
Object |
Optional | - |
owner |
OwnerLegalEntities |
Required | - |
path |
String |
Required | - |
resource |
String |
Required | - |
api_version |
String |
Required | - |
Example (as JSON)
{
"additional_representatives": null,
"controller": null,
"entity_verification": null,
"owner": {
"id": null,
"path": null,
"resource": "legal_entities"
},
"path": null,
"resource": "verifications",
"api_version": null
}
Line Item
Class Name
LineItem
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
commodity_code |
String |
Optional | Constraints: Maximum Length: 255 |
currency |
CurrencyEnum |
Required | - |
description |
String |
Optional | Constraints: Maximum Length: 2047 |
discount_amount |
Integer |
Optional | - |
discount_indicator |
String |
Optional | Constraints: Maximum Length: 255 |
gross_net_indicator |
String |
Optional | Constraints: Maximum Length: 255 |
item |
ItemNullableResp |
Optional | - |
quantity |
Integer |
Required | - |
tax_amount |
Integer |
Optional | - |
tax_rate |
Float |
Optional | - |
tax_type_applied |
String |
Optional | Constraints: Maximum Length: 255 |
total_amount |
Integer |
Required | - |
unit_of_measure |
String |
Optional | Constraints: Maximum Length: 255 |
unit_price |
Integer |
Required | - |
Example (as JSON)
{
"commodity_code": null,
"currency": "CAD",
"description": null,
"discount_amount": null,
"discount_indicator": null,
"gross_net_indicator": null,
"item": null,
"quantity": 68,
"tax_amount": null,
"tax_rate": null,
"tax_type_applied": null,
"total_amount": 112,
"unit_of_measure": null,
"unit_price": 182
}
Line Item 1
Class Name
LineItem1
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
commodity_code |
String |
Optional | Constraints: Maximum Length: 255 |
currency |
CurrencyEnum |
Required | - |
description |
String |
Optional | Constraints: Maximum Length: 2047 |
discount_amount |
Integer |
Optional | - |
discount_indicator |
String |
Optional | Constraints: Maximum Length: 255 |
gross_net_indicator |
String |
Optional | Constraints: Maximum Length: 255 |
item |
ItemNullableReq |
Optional | - |
quantity |
Integer |
Required | - |
tax_amount |
Integer |
Optional | - |
tax_rate |
Float |
Optional | - |
tax_type_applied |
String |
Optional | Constraints: Maximum Length: 255 |
total_amount |
Integer |
Required | - |
unit_of_measure |
String |
Optional | Constraints: Maximum Length: 255 |
unit_price |
Integer |
Required | - |
Example (as JSON)
{
"commodity_code": null,
"currency": "CAD",
"description": null,
"discount_amount": null,
"discount_indicator": null,
"gross_net_indicator": null,
"item": null,
"quantity": 68,
"tax_amount": null,
"tax_rate": null,
"tax_type_applied": null,
"total_amount": 112,
"unit_of_measure": null,
"unit_price": 182
}
Name
Class Name
Name
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
first |
String |
Required | Constraints: Minimum Length: 2, Maximum Length: 30 |
last |
String |
Required | Constraints: Minimum Length: 2, Maximum Length: 30 |
Example (as JSON)
{
"first": "first6",
"last": "last0"
}
Notification Preferences Request
Class Name
NotificationPreferencesRequest
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
callback_uri |
String |
Required | Constraints: Maximum Length: 2063, Pattern: ^https?://.+$ |
topic |
Topic1Enum |
Required | - |
Example (as JSON)
{
"callback_uri": "callback_uri4",
"topic": "payouts.created"
}
Notification Preferences Request 1
Class Name
NotificationPreferencesRequest1
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
callback_uri |
String |
Optional | Constraints: Maximum Length: 2063, Pattern: ^https?://.+$ |
Example (as JSON)
{
"callback_uri": null
}
Notification Preferences Response
Class Name
NotificationPreferencesResponse
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
mnext |
String |
Optional | - |
previous |
String |
Optional | - |
results |
Array<Result1> |
Required | Constraints: Unique Items Required |
api_version |
String |
Optional | - |
Example (as JSON)
{
"results": {
"callback_uri": null,
"create_time": null,
"id": null,
"path": null,
"resource": "notification_preferences",
"status": null,
"topic": null
}
}
Notification Preferences Response 1
Class Name
NotificationPreferencesResponse1
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
callback_uri |
String |
Required | - |
create_time |
Integer |
Required | - |
id |
String |
Required | - |
owner |
OwnerApplications |
Optional | - |
path |
String |
Required | - |
resource |
String |
Required | - |
status |
String |
Required | - |
topic |
String |
Required | - |
api_version |
String |
Optional | - |
Example (as JSON)
{
"callback_uri": null,
"create_time": null,
"id": null,
"path": null,
"resource": "notification_preferences",
"status": "active",
"topic": null
}
Notification Preferences Response 2
Class Name
NotificationPreferencesResponse2
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
callback_uri |
String |
Required | - |
create_time |
Integer |
Required | - |
id |
String |
Required | - |
owner |
OwnerApplications |
Optional | - |
path |
String |
Required | - |
resource |
String |
Required | - |
status |
Status20Enum |
Required | - |
topic |
String |
Required | - |
api_version |
String |
Optional | - |
Example (as JSON)
{
"callback_uri": null,
"create_time": null,
"id": null,
"path": null,
"resource": "notification_preferences",
"status": null,
"topic": null
}
Notifications Response
Class Name
NotificationsResponse
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
mnext |
String |
Optional | - |
previous |
String |
Optional | - |
results |
Array<Result> |
Required | Constraints: Unique Items Required |
api_version |
String |
Optional | - |
Example (as JSON)
{
"results": {
"event_time": null,
"id": null,
"owner": {
"id": null,
"resource": "applications"
},
"path": null,
"payload": null,
"resource": "notifications",
"topic": null
}
}
Notifications Response 1
Class Name
NotificationsResponse1
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
event_time |
Integer |
Required | - |
id |
String |
Required | Constraints: Minimum Length: 1, Maximum Length: 255 |
owner |
OwnerApplications |
Required | - |
path |
String |
Required | - |
payload |
Object |
Required | - |
resource |
String |
Required | - |
topic |
String |
Required | - |
api_version |
String |
Optional | - |
Example (as JSON)
{
"event_time": null,
"id": null,
"owner": {
"id": null,
"resource": "applications"
},
"path": null,
"payload": null,
"resource": "notifications",
"topic": null
}
Orders Response
Class Name
OrdersResponse
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
mnext |
String |
Optional | - |
previous |
String |
Optional | - |
results |
Array<OrderResp> |
Required | - |
api_version |
String |
Optional | - |
Example (as JSON)
{
"next": null,
"previous": null,
"results": [
{
"alternate_tax_amount": null,
"alternate_tax_id": null,
"buyer": null,
"create_time": null,
"currency": null,
"customer_reference_number": null,
"delivery_type": null,
"discount_amount": null,
"duty_amount": null,
"freight_amount": null,
"grand_total_amount": null,
"id": null,
"line_items": null,
"long_description": null,
"notes": null,
"owner": null,
"path": null,
"reference_number": null,
"resource": null,
"service_address": null,
"ship_from_address": null,
"ship_to_address": null,
"shipping_status": null,
"short_description": null,
"state": null,
"status": null,
"tax_amount": null,
"terms": null,
"type": null,
"vat_amount": null,
"vat_rate": null,
"api_version": null
}
],
"api_version": null
}
Owner 3
Class Name
Owner3
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
id |
String |
Required | - |
path |
String |
Required | - |
resource |
Resource1Enum |
Required | - |
Example (as JSON)
{
"id": "id0",
"path": "path6",
"resource": "adjustments"
}
Owner 16
Class Name
Owner16
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
id |
String |
Required | - |
path |
String |
Required | - |
resource |
ResourceTypesRbitEnum |
Required | - |
Example (as JSON)
{
"id": "id0",
"path": "path6",
"resource": "payments"
}
Owner 20
Owner structure to be used in any resource where an application is the owner
Class Name
Owner20
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
id |
String |
Required | - |
path |
String |
Optional | - |
resource |
String |
Required | - |
Example (as JSON)
{
"id": null,
"resource": "applications"
}
Payment Methods Request
Class Name
PaymentMethodsRequest
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
credit_card |
CreditCard4 |
Optional | Credit card structure to be used for updating credit card information. |
payment_bank_us |
Object |
Optional | Payment bank structure to be used for updating payment bank information. No field is allowed for update now. |
type |
Type3Enum |
Optional | - |
custom_data |
Object |
Optional | - |
rbits |
Array<EmbeddedRbit> |
Optional | - |
Example (as JSON)
{
"credit_card": null,
"payment_bank_us": null,
"type": null,
"custom_data": null,
"rbits": null
}
Payment Methods Response
Class Name
PaymentMethodsResponse
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
mnext |
String |
Optional | - |
previous |
String |
Optional | - |
results |
Array<PaymentMethodResp> |
Required | Constraints: Unique Items Required |
api_version |
String |
Optional | - |
Example (as JSON)
{
"results": {
"create_time": null,
"id": null,
"owner": {
"id": null,
"resource": "applications"
},
"path": null,
"resource": "payment_methods",
"status": null,
"type": null
}
}
Payment Methods Verify Bank Deposits Request
Class Name
PaymentMethodsVerifyBankDepositsRequest
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
microdeposits |
Array<Integer> |
Required | - |
Example (as JSON)
{
"microdeposits": [
170,
171,
172
]
}
Payment Bank
Class Name
PaymentBank
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
standard |
Standard |
Optional | The standard pricing model for payment banks to collect platform fees. |
type |
String |
Required | - |
Example (as JSON)
{
"type": "standard"
}
Payment Bank Us
Class Name
PaymentBankUs
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
account_holder |
HolderResp |
Required | - |
account_type |
AccountTypeEnum |
Required | - |
last_four |
String |
Required | - |
Example (as JSON)
{
"account_holder": {
"address": null,
"email": null,
"holder_name": "holder_name6",
"phone": null
},
"account_type": "checking",
"last_four": "last_four6"
}
Payments
Class Name
Payments
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
current_issues |
Array<CurrentIssue> |
Optional | - |
enabled |
Boolean |
Required | - |
upcoming_issues |
Hash |
Optional | - |
Example (as JSON)
{
"current_issues": null,
"enabled": false,
"upcoming_issues": null
}
Payments Cancel Request
Class Name
PaymentsCancelRequest
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
cancel_reason |
String |
Required | - |
rbits |
Array<EmbeddedRbit> |
Optional | - |
Example (as JSON)
{
"cancel_reason": "cancel_reason4",
"rbits": null
}
Payments Capture Request
Class Name
PaymentsCaptureRequest
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
amounts |
CaptureAmounts |
Optional | - |
Example (as JSON)
{
"amounts": null
}
Payments Request
Class Name
PaymentsRequest
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
account_id |
String |
Required | Constraints: Minimum Length: 1, Maximum Length: 255 |
amount |
Integer |
Required | Constraints: >= 0 |
auto_capture |
Boolean |
Optional | - |
capture_at |
Integer |
Optional | - |
currency |
CurrencyEnum |
Required | - |
custom_data |
Object |
Optional | - |
fee_amount |
Integer |
Optional | Constraints: >= 0 |
order_id |
String |
Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
payment_method |
PaymentMethodForPayments |
Required | - |
initiated_by |
InitiatedByReqEnum |
Optional | - |
rbits |
Array<EmbeddedRbit> |
Optional | - |
reference_id |
String |
Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
Example (as JSON)
{
"account_id": "account_id2",
"amount": 46,
"auto_capture": null,
"capture_at": null,
"currency": "CAD",
"custom_data": null,
"fee_amount": null,
"order_id": null,
"payment_method": {
"credit_card": null,
"custom_data": null,
"payment_bank_us": null,
"payment_method_id": null,
"token": null,
"encoded_payment_method": null,
"type": "credit_card"
},
"initiated_by": null,
"rbits": null,
"reference_id": null
}
Payments Request 1
Class Name
PaymentsRequest1
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
custom_data |
Object |
Optional | - |
rbits |
Array<EmbeddedRbit> |
Optional | - |
reference_id |
String |
Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
amounts |
CaptureAmounts |
Optional | - |
Example (as JSON)
{
"custom_data": null,
"rbits": null,
"reference_id": null,
"amounts": null
}
Payments Response
Class Name
PaymentsResponse
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
mnext |
String |
Optional | - |
previous |
String |
Optional | - |
results |
Array<PaymentsV30> |
Required | - |
api_version |
String |
Optional | - |
Example (as JSON)
{
"results": {
"amount": null,
"amount_refunded": null,
"amount_disputed": null,
"create_time": null,
"currency": null,
"id": null,
"owner": {
"id": null,
"path": null,
"resource": "accounts"
},
"path": null,
"payment_method": {
"id": null,
"path": null,
"resource": "payment_methods"
},
"resource": "payments",
"status": null,
"initiated_by": null
}
}
Payments 1
Class Name
Payments1
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
application_block |
ApplicationBlock4 |
Optional | - |
Example (as JSON)
{
"application_block": null
}
Payout Methods Request
Class Name
PayoutMethodsRequest
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
custom_data |
Object |
Optional | - |
rbits |
Array<EmbeddedRbit> |
Optional | - |
Example (as JSON)
{
"custom_data": null,
"rbits": null
}
Payout Methods Response
Class Name
PayoutMethodsResponse
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
mnext |
String |
Optional | - |
previous |
String |
Optional | - |
results |
Array<PayoutMethodResp> |
Required | Constraints: Unique Items Required |
api_version |
String |
Optional | - |
Example (as JSON)
{
"results": {
"id": null,
"path": null,
"resource": "payout_methods"
}
}
Payout Bank Ca
Class Name
PayoutBankCa
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
account_type |
AccountTypeEnum |
Required | - |
last_four |
String |
Required | - |
Example (as JSON)
{
"account_type": "checking",
"last_four": "last_four6"
}
Payout Bank Ca 1
Class Name
PayoutBankCa1
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
account_number |
String |
Required | Constraints: Pattern: ^[0-9]{5,17}$ |
account_type |
AccountTypeEnum |
Required | - |
institution_number |
String |
Required | Constraints: Pattern: ^[0-9]{3}$ |
transit_number |
String |
Required | Constraints: Pattern: ^[0-9]{5}$ |
Example (as JSON)
{
"account_number": "account_number0",
"account_type": "checking",
"institution_number": "institution_number2",
"transit_number": "transit_number8"
}
Payout Bank Gb
Class Name
PayoutBankGb
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
last_four |
String |
Required | - |
Example (as JSON)
{
"last_four": "last_four6"
}
Payout Bank Gb 1
Class Name
PayoutBankGb1
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
account_number |
String |
Required | Constraints: Pattern: ^[0-9]{8}$ |
sort_code |
String |
Required | Constraints: Pattern: ^[0-9]{6}$ |
Example (as JSON)
{
"account_number": "account_number0",
"sort_code": "sort_code0"
}
Payout Bank Us
Class Name
PayoutBankUs
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
account_type |
AccountTypeEnum |
Required | - |
last_four |
String |
Required | - |
Example (as JSON)
{
"account_type": "checking",
"last_four": "last_four6"
}
Payout Bank Us 1
Class Name
PayoutBankUs1
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
account_number |
String |
Required | Constraints: Pattern: ^[0-9]{3,17}$ |
account_type |
AccountTypeEnum |
Required | - |
routing_number |
String |
Required | Constraints: Pattern: ^[0-9]{9}$ |
Example (as JSON)
{
"account_number": "account_number0",
"account_type": "checking",
"routing_number": "routing_number4"
}
Payouts
Class Name
Payouts
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
current_issues |
Array<CurrentIssue> |
Optional | - |
enabled |
Boolean |
Required | - |
upcoming_issues |
Hash |
Optional | - |
Example (as JSON)
{
"current_issues": null,
"enabled": false,
"upcoming_issues": null
}
Payouts Request
Class Name
PayoutsRequest
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
custom_data |
Object |
Optional | - |
rbits |
Array<EmbeddedRbit> |
Optional | - |
Example (as JSON)
{
"custom_data": null,
"rbits": null
}
Payouts Response
Class Name
PayoutsResponse
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
mnext |
String |
Optional | - |
previous |
String |
Optional | - |
results |
Array<Payout> |
Required | Constraints: Unique Items Required |
api_version |
String |
Optional | - |
Example (as JSON)
{
"results": {
"id": null,
"owner": {
"id": null,
"path": null,
"resource": "accounts"
},
"path": null,
"resource": "payouts"
}
}
Payouts 1
Class Name
Payouts1
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
application_block |
ApplicationBlock4 |
Optional | - |
Example (as JSON)
{
"application_block": null
}
Percentage Guide
The configuration for a percentage tip guide. All three guides must be provided.
Class Name
PercentageGuide
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
show_amount |
Boolean |
Required | Whether or not to show the amount that the percentage equates to in the tip guide button. |
percentage_low |
Integer |
Required | The 'low' guide. Constraints: >= 0 |
percentage_medium |
Integer |
Required | The 'medium' guide. Constraints: >= 0 |
percentage_high |
Integer |
Required | The 'high' guide. Constraints: >= 0 |
Example (as JSON)
{
"show_amount": false,
"percentage_low": 10,
"percentage_medium": 15,
"percentage_high": 18
}
Personal Country Info
Class Name
PersonalCountryInfo
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
ca |
CA |
Optional | - |
gb |
Object |
Optional | - |
us |
US |
Optional | - |
Example (as JSON)
{
"CA": null,
"GB": null,
"US": null
}
Personal Country Info 1
Class Name
PersonalCountryInfo1
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
ca |
CA1 |
Optional | - |
gb |
Object |
Optional | - |
us |
US1 |
Optional | - |
Example (as JSON)
{
"CA": null,
"GB": null,
"US": null
}
Personal Verification
Class Name
PersonalVerification
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
documents |
Array<String> |
Optional | Constraints: Unique Items Required |
Example (as JSON)
{
"documents": null
}
Personal Verification 5
Class Name
PersonalVerification5
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
current_issues |
Array<CurrentIssue2> |
Optional | - |
documents |
Array<Document> |
Optional | - |
verified |
Boolean |
Required | - |
Example (as JSON)
{
"current_issues": null,
"documents": null,
"verified": false
}
Phone
Class Name
Phone
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
country_code |
String |
Optional | Constraints: Pattern: ^\+?[0-9]{1,3}$ |
phone_number |
String |
Optional | Constraints: Pattern: ^[0-9]{1,14}$ |
type |
TypeEnum |
Optional | - |
Example (as JSON)
{
"country_code": null,
"phone_number": null,
"type": null
}
Phone 1
Class Name
Phone1
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
country_code |
String |
Required | Constraints: Pattern: ^\+?[0-9]{1,3}$ |
phone_number |
String |
Required | Constraints: Pattern: ^[0-9]{1,14}$ |
type |
TypeEnum |
Optional | - |
Example (as JSON)
{
"country_code": "country_code0",
"phone_number": "phone_number2",
"type": null
}
Rbits Request
Class Name
RbitsRequest
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
address |
AddressRbit |
Optional | - |
associated_resource |
AssociatedResource |
Required | - |
auto_billing |
AutoBilling |
Optional | - |
business_description |
BusinessDescription |
Optional | - |
business_name |
BusinessName |
Optional | - |
external_account |
ExternalAccount |
Optional | - |
fundraising_event |
FundraisingEvent |
Optional | - |
fundraising_update |
FundraisingUpdate |
Optional | - |
industry_code |
IndustryCode |
Optional | - |
partner_service |
PartnerServiceRbit |
Optional | - |
person |
PersonRbit |
Optional | - |
phone |
PhoneRbit |
Optional | - |
mfa |
MfaRbit |
Optional | - |
receive_time |
Integer |
Required | - |
source |
RbitSourceEnum |
Required | - |
transaction_details |
TransactionDetails |
Optional | - |
type |
RbitTypesEnum |
Required | - |
Example (as JSON)
{
"address": null,
"associated_resource": {
"id": "id2",
"resource": "payout_methods"
},
"auto_billing": null,
"business_description": null,
"business_name": null,
"external_account": null,
"fundraising_event": null,
"fundraising_update": null,
"industry_code": null,
"partner_service": null,
"person": null,
"phone": null,
"mfa": null,
"receive_time": 38,
"source": "user",
"transaction_details": null,
"type": "fundraising_event"
}
Rbits Response
Class Name
RbitsResponse
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
address |
AddressRbit |
Optional | - |
auto_billing |
AutoBilling |
Optional | - |
business_description |
BusinessDescription |
Optional | - |
business_name |
BusinessName |
Optional | - |
create_time |
Integer |
Required | - |
external_account |
ExternalAccount |
Optional | - |
fundraising_event |
FundraisingEvent |
Optional | - |
fundraising_update |
FundraisingUpdate |
Optional | - |
id |
String |
Required | Constraints: Minimum Length: 1, Maximum Length: 255 |
industry_code |
IndustryCode |
Optional | - |
owner |
Owner16 |
Required | - |
partner_service |
PartnerServiceRbit |
Optional | - |
path |
String |
Required | - |
person |
PersonRbit |
Optional | - |
phone |
PhoneRbit |
Optional | - |
mfa |
MfaRbit |
Optional | - |
receive_time |
Integer |
Required | - |
resource |
String |
Required | - |
source |
RbitSourceEnum |
Required | - |
state |
StateEnum |
Required | - |
transaction_details |
TransactionDetails |
Optional | - |
type |
RbitTypesEnum |
Required | - |
api_version |
String |
Optional | - |
Example (as JSON)
{
"create_time": null,
"id": null,
"owner": null,
"path": null,
"receive_time": null,
"resource": "rbits",
"source": null,
"state": null,
"type": null
}
Rbits Response 1
Class Name
RbitsResponse1
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
mnext |
String |
Optional | - |
previous |
String |
Optional | - |
results |
Array<Result2> |
Required | - |
api_version |
String |
Optional | - |
Example (as JSON)
{
"results": {
"create_time": null,
"id": null,
"owner": null,
"path": null,
"receive_time": null,
"resource": "rbits",
"source": null,
"state": null,
"type": null
}
}
Reason
Class Name
Reason
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
reason_code |
ReasonCode9Enum |
Required | The category of adjustment reason |
reason_message |
String |
Required | Adjustment descriptive reason |
details |
Array<Detail9> |
Optional | - |
Example (as JSON)
{
"reason_code": "CROSS_BORDER",
"reason_message": "reason_message2",
"details": null
}
Recoveries Request
Class Name
RecoveriesRequest
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
custom_data |
Object |
Optional | - |
rbits |
Array<EmbeddedRbit> |
Optional | - |
Example (as JSON)
{
"custom_data": null,
"rbits": null
}
Recoveries Response
Class Name
RecoveriesResponse
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
mnext |
String |
Optional | - |
previous |
String |
Optional | - |
results |
Array<Recoveries> |
Required | - |
api_version |
String |
Optional | - |
Example (as JSON)
{
"results": {
"amount": null,
"create_time": null,
"currency": null,
"failure_reason": null,
"id": null,
"owner": {
"id": null,
"path": null,
"resource": "accounts"
},
"path": null,
"payout_method": {
"id": null,
"path": null,
"resource": "payout_methods"
},
"resource": "recoveries",
"status": null,
"txnr_failure": {
"id": null,
"path": null,
"resource": "transaction_records"
},
"txnr_recovery": {
"id": null,
"path": null,
"resource": "transaction_records"
}
}
}
Refunds Request
Class Name
RefundsRequest
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
custom_data |
Object |
Optional | - |
rbits |
Array<EmbeddedRbit> |
Optional | - |
reference_id |
String |
Optional | Constraints: Minimum Length: 1, Maximum Length: 255 |
Example (as JSON)
{
"custom_data": null,
"rbits": null,
"reference_id": null
}
Refunds Response
Class Name
RefundsResponse
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
mnext |
String |
Optional | - |
previous |
String |
Optional | - |
results |
Array<RefundResp> |
Required | - |
api_version |
String |
Optional | - |
Example (as JSON)
{
"results": {
"amounts": null,
"create_time": null,
"failure_reason": null,
"id": null,
"order": {
"id": null,
"path": null,
"resource": "orders"
},
"owner": {
"id": null,
"path": null,
"resource": "accounts"
},
"path": null,
"payment": {
"id": null,
"path": null,
"resource": "payments"
},
"payment_method": {
"id": null,
"path": null,
"resource": "payment_methods"
},
"refund_reason": null,
"resource": "refunds",
"status": null,
"txnr_app_fee_refund": {
"id": null,
"path": null,
"resource": "transaction_records"
},
"txnr_merchant_refund": {
"id": null,
"path": null,
"resource": "transaction_records"
}
}
}
Reject Reason
Class Name
RejectReason
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
details |
Array<Detail10> |
Required | Constraints: Unique Items Required |
reason_code |
String |
Required | - |
reason_message |
String |
Required | - |
Example (as JSON)
{
"details": null,
"reason_code": "failed_risk_review",
"reason_message": null
}
Representative 0
Class Name
Representative0
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
personal_verification |
PersonalVerification |
Optional | - |
Example (as JSON)
{
"personal_verification": null
}
Representative 01
Class Name
Representative01
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
personal_verification |
PersonalVerification5 |
Required | - |
Example (as JSON)
{
"personal_verification": {
"current_issues": null,
"documents": null,
"verified": false
}
}
Resolution
Class Name
Resolution
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
resolution_time |
Integer |
Optional | - |
type |
Type5Enum |
Optional | - |
Example (as JSON)
{
"resolution_time": null,
"type": null
}
Result
Class Name
Result
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
event_time |
Integer |
Required | - |
id |
String |
Required | Constraints: Minimum Length: 1, Maximum Length: 255 |
owner |
OwnerApplications |
Required | - |
path |
String |
Required | - |
payload |
Object |
Required | - |
resource |
String |
Required | - |
topic |
String |
Required | - |
api_version |
String |
Optional | - |
Example (as JSON)
{
"event_time": null,
"id": null,
"owner": {
"id": null,
"resource": "applications"
},
"path": null,
"payload": null,
"resource": "notifications",
"topic": null
}
Result 1
Class Name
Result1
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
callback_uri |
String |
Required | - |
create_time |
Integer |
Required | - |
id |
String |
Required | - |
owner |
OwnerApplications |
Optional | - |
path |
String |
Required | - |
resource |
String |
Required | - |
status |
Status20Enum |
Required | - |
topic |
String |
Required | - |
api_version |
String |
Optional | - |
Example (as JSON)
{
"callback_uri": null,
"create_time": null,
"id": null,
"path": null,
"resource": "notification_preferences",
"status": null,
"topic": null
}
Result 2
Class Name
Result2
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
address |
AddressRbit |
Optional | - |
auto_billing |
AutoBilling |
Optional | - |
business_description |
BusinessDescription |
Optional | - |
business_name |
BusinessName |
Optional | - |
create_time |
Integer |
Required | - |
external_account |
ExternalAccount |
Optional | - |
fundraising_event |
FundraisingEvent |
Optional | - |
fundraising_update |
FundraisingUpdate |
Optional | - |
id |
String |
Required | Constraints: Minimum Length: 1, Maximum Length: 255 |
industry_code |
IndustryCode |
Optional | - |
owner |
Owner16 |
Required | - |
partner_service |
PartnerServiceRbit |
Optional | - |
path |
String |
Required | - |
person |
PersonRbit |
Optional | - |
phone |
PhoneRbit |
Optional | - |
mfa |
MfaRbit |
Optional | - |
receive_time |
Integer |
Required | - |
resource |
String |
Required | - |
source |
RbitSourceEnum |
Required | - |
state |
StateEnum |
Required | - |
transaction_details |
TransactionDetails |
Optional | - |
type |
RbitTypesEnum |
Required | - |
api_version |
String |
Optional | - |
Example (as JSON)
{
"create_time": null,
"id": null,
"owner": null,
"path": null,
"receive_time": null,
"resource": "rbits",
"source": null,
"state": null,
"type": null
}
Shipping Info
Class Name
ShippingInfo
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
actual_delivery_time |
Integer |
Optional | - |
carrier |
String |
Optional | Constraints: Maximum Length: 255 |
expected_delivery_time |
Integer |
Optional | - |
shipping_time |
Integer |
Optional | - |
tracking_number |
String |
Optional | Constraints: Maximum Length: 255 |
tracking_url |
String |
Optional | Constraints: Maximum Length: 2063, Pattern: ^https?://.+$ |
Example (as JSON)
{
"actual_delivery_time": null,
"carrier": null,
"expected_delivery_time": null,
"shipping_time": null,
"tracking_number": null,
"tracking_url": null
}
Shipping Status
Class Name
ShippingStatus
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
actual_delivery_time |
Integer |
Optional | - |
carrier |
String |
Optional | Constraints: Maximum Length: 255 |
expected_delivery_time |
Integer |
Optional | - |
shipping_time |
Integer |
Optional | - |
tracking_number |
String |
Optional | Constraints: Maximum Length: 1024 |
tracking_uri |
String |
Optional | Constraints: Maximum Length: 2063, Pattern: ^https?://.+$ |
Example (as JSON)
{
"actual_delivery_time": null,
"carrier": null,
"expected_delivery_time": null,
"shipping_time": null,
"tracking_number": null,
"tracking_uri": null
}
Shipping Status 1
Class Name
ShippingStatus1
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
actual_delivery_time |
Integer |
Optional | - |
carrier |
String |
Optional | Constraints: Maximum Length: 255 |
expected_delivery_time |
Integer |
Optional | - |
shipping_time |
Integer |
Optional | - |
tracking_number |
String |
Optional | Constraints: Maximum Length: 1024 |
tracking_uri |
String |
Optional | Constraints: Maximum Length: 2063, Pattern: ^https?://.+$ |
Example (as JSON)
{
"actual_delivery_time": null,
"carrier": null,
"expected_delivery_time": null,
"shipping_time": null,
"tracking_number": null,
"tracking_uri": null
}
Standard
The standard pricing model for payment banks to collect platform fees.
Class Name
Standard
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
fixed_fee_amount |
Integer |
Optional | The fixed fee amount. Constraints: >= 0, <= 100 |
variable_fee_bps |
Integer |
Optional | The basis points to calculate variable fee amount. Constraints: >= 0, <= 100 |
max_fee_amount |
Integer |
Optional | The max value of total fee amount. Constraints: >= 0 |
min_fee_amount |
Integer |
Optional | The min value of total fee amount. Constraints: >= 0 |
Example (as JSON)
{
"fixed_fee_amount": null,
"variable_fee_bps": null,
"max_fee_amount": null,
"min_fee_amount": null
}
Target
Class Name
Target
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
id |
String |
Optional | - |
path |
String |
Optional | - |
resource |
String |
Optional | - |
Example (as JSON)
{
"id": null,
"path": null,
"resource": null
}
Terminal Configuration
Class Name
TerminalConfiguration
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
address |
AddressTerminalsResp |
Required | - |
currency |
CurrencyEnum |
Required | - |
supported_card_brands |
Array<TerminalsSupportedCardBrandEnum> |
Required | The collection of card brands that are supported by the terminal. Must provide at least one. Constraints: Minimum Items: 1, Unique Items Required |
credit_debit_preference |
CreditDebitPreference1Enum |
Required | Determines how the terminal should prefer credit vs debit when a card is dipped. "credit" indicates credit is the preferred application selection, whereas "debit" would prefer the debit application. "prompt" will perform the EMV default behavior, which is to prompt if multiple applications exist. |
sim_card_id |
String |
Optional | The identifier of the SIM card installed in the terminal. Nullable if terminal does not have a SIM card. |
timezone |
TimezoneEnum |
Required | Timezone of the terminal' |
tip |
TerminalsTip |
Required | - |
signature_required |
Boolean |
Required | Whether or not this terminal requires signature verification from payers. |
contactless_payments |
ContactlessPayments |
Required | The response schema for contactless payments configuration. |
quick_chip |
QuickChip |
Required | Configuration settings for quick chip functionality. |
deferred_authorization |
DeferredAuthorization |
Required | Configuration settings for deferred authorization functionality. |
Example (as JSON)
{
"address": null,
"currency": null,
"supported_card_brands": [
"visa",
"american_express",
"discover",
"mastercard"
],
"credit_debit_preference": null,
"timezone": null,
"tip": {
"mode": "prompt_on_terminal",
"terminal_display": {
"amount_guide_type": "percentage_guide",
"percentage_guide": {
"show_amount": false,
"percentage_low": 15,
"percentage_medium": 18,
"percentage_high": 20
}
}
},
"signature_required": null,
"contactless_payments": null,
"quick_chip": null,
"deferred_authorization": {
"enabled": null,
"international_enabled": null,
"max_transaction_count": 20,
"max_total_amount": 250000,
"max_transaction_amount": 12500,
"supported_card_entry_modes": [
"chip",
"contactless"
]
}
}
Terminal Configuration 1
Class Name
TerminalConfiguration1
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
address |
AddressTerminalsReq |
Optional | - |
currency |
CurrencyEnum |
Required | - |
supported_card_brands |
Array<TerminalsSupportedCardBrandEnum> |
Required | The collection of card brands that are supported by the terminal. Must provide at least one. Constraints: Minimum Items: 1, Unique Items Required |
credit_debit_preference |
CreditDebitPreference1Enum |
Optional | Determines how the terminal should prefer credit vs debit when a card is dipped. "credit" indicates credit is the preferred application selection, whereas "debit" would prefer the debit application. "prompt" will perform the EMV default behavior, which is to prompt if multiple applications exist. |
sim_card_id |
String |
Optional | The identifier of the SIM card installed in the terminal. Nullable if terminal does not have a SIM card. |
timezone |
TimezoneEnum |
Required | Timezone of the terminal' |
tip |
TerminalsTip |
Required | - |
signature_required |
Boolean |
Required | Whether or not this terminal requires signature verification from payers. |
contactless_payments |
ContactlessPaymentsReq |
Required | The request schema for modifying contactless payments configuration settings. |
quick_chip |
QuickChip |
Required | Configuration settings for quick chip functionality. |
deferred_authorization |
DeferredAuthorization |
Required | Configuration settings for deferred authorization functionality. |
Example (as JSON)
{
"currency": null,
"supported_card_brands": [
"visa",
"american_express",
"discover",
"mastercard"
],
"timezone": null,
"tip": {
"mode": "prompt_on_terminal",
"terminal_display": {
"amount_guide_type": "percentage_guide",
"percentage_guide": {
"show_amount": false,
"percentage_low": 15,
"percentage_medium": 18,
"percentage_high": 20
}
}
},
"signature_required": null,
"contactless_payments": null,
"quick_chip": null,
"deferred_authorization": {
"enabled": null,
"international_enabled": null,
"max_transaction_count": 20,
"max_total_amount": 250000,
"max_transaction_amount": 12500,
"supported_card_entry_modes": [
"chip",
"contactless"
]
}
}
Terminal Configuration 2
Class Name
TerminalConfiguration2
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
address |
AddressTerminalsReq |
Optional | - |
currency |
CurrencyEnum |
Optional | - |
supported_card_brands |
Array<TerminalsSupportedCardBrandEnum> |
Optional | The collection of card brands that are supported by the terminal. Must provide at least one. Constraints: Minimum Items: 1, Unique Items Required |
credit_debit_preference |
CreditDebitPreference1Enum |
Optional | Determines how the terminal should prefer credit vs debit when a card is dipped. "credit" indicates credit is the preferred application selection, whereas "debit" would prefer the debit application. "prompt" will perform the EMV default behavior, which is to prompt if multiple applications exist. |
sim_card_id |
String |
Optional | The identifier of the SIM card installed in the terminal. Nullable if terminal does not have a SIM card. |
timezone |
TimezoneEnum |
Optional | Timezone of the terminal' |
tip |
TerminalsTip |
Optional | - |
signature_required |
Boolean |
Optional | Whether or not this terminal requires signature verification from payers. |
contactless_payments |
ContactlessPaymentsReq |
Optional | The request schema for modifying contactless payments configuration settings. |
quick_chip |
QuickChip |
Optional | Configuration settings for quick chip functionality. |
deferred_authorization |
DeferredAuthorization |
Optional | Configuration settings for deferred authorization functionality. |
Example (as JSON)
{
"address": null,
"currency": null,
"supported_card_brands": null,
"credit_debit_preference": null,
"sim_card_id": null,
"timezone": null,
"tip": null,
"signature_required": null,
"contactless_payments": null,
"quick_chip": null,
"deferred_authorization": null
}
Terminal Display
This configuration is required if the mode is "prompt_on_terminal", and is responsible for configuring how the tip guide appears on the physical terminal.
Class Name
TerminalDisplay
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
amount_guide_type |
AmountGuideTypeEnum |
Required | The type of the amount guide can be either a percentage guide or a flat guide. Percentage guides will offer the payer a chance to tip with one of a few default tip percentages that are configured. Flat guides will offer the payer flat tip amounts to choose from. Both types of guides will allow the payer to manually enter a tip amount. |
percentage_guide |
PercentageGuide |
Optional | The configuration for a percentage tip guide. All three guides must be provided. |
flat_guide |
FlatGuide |
Optional | The configuration for a flat tip guide. All three guides must be provided. |
Example (as JSON)
{
"amount_guide_type": "percentage_guide",
"percentage_guide": null,
"flat_guide": null
}
Terminals Request
Class Name
TerminalsRequest
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
account_id |
String |
Required | Constraints: Minimum Length: 1, Maximum Length: 255 |
serial_number |
String |
Required | The serial number of the physical terminal. |
model |
Model1Enum |
Required | The model of the physical terminal. |
reference_id |
String |
Optional | A reference ID that can be used to identify the terminals resource in WePay's system. Searching capabilities are supported on this field. Constraints: Minimum Length: 1, Maximum Length: 255 |
terminal_configuration |
TerminalConfiguration1 |
Required | - |
Example (as JSON)
{
"account_id": null,
"serial_number": "FA00332-1000138",
"model": null,
"terminal_configuration": {
"currency": null,
"supported_card_brands": [
"visa",
"american_express",
"discover",
"mastercard"
],
"timezone": null,
"tip": {
"mode": "prompt_on_terminal",
"terminal_display": {
"amount_guide_type": "percentage_guide",
"percentage_guide": {
"show_amount": false,
"percentage_low": 15,
"percentage_medium": 18,
"percentage_high": 20
}
}
},
"signature_required": null,
"contactless_payments": null,
"quick_chip": null,
"deferred_authorization": {
"enabled": null,
"international_enabled": null,
"max_transaction_count": 20,
"max_total_amount": 250000,
"max_transaction_amount": 12500,
"supported_card_entry_modes": [
"chip",
"contactless"
]
}
}
}
Terminals Request 1
Class Name
TerminalsRequest1
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
reference_id |
String |
Optional | A reference ID that can be used to identify the terminals resource in WePay's system. Searching capabilities are supported on this field. Constraints: Minimum Length: 1, Maximum Length: 255 |
terminal_configuration |
TerminalConfiguration2 |
Optional | - |
Example (as JSON)
{
"reference_id": null,
"terminal_configuration": null
}
Terminals Response
Class Name
TerminalsResponse
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
mnext |
String |
Optional | - |
previous |
String |
Optional | - |
results |
Array<TerminalResp> |
Required | Constraints: Unique Items Required |
api_version |
String |
Required | - |
Example (as JSON)
{
"results": {
"id": null,
"resource": "terminals",
"path": null,
"owner": {
"id": null,
"path": null,
"resource": "accounts"
},
"api_version": null,
"status": null,
"serial_number": "FA00332-1000138",
"model": null,
"last_call_home": null,
"terminal_application_version": null,
"terminal_configuration": {
"address": null,
"currency": null,
"supported_card_brands": [
"visa",
"american_express",
"discover",
"mastercard"
],
"credit_debit_preference": null,
"timezone": null,
"tip": {
"mode": "prompt_on_terminal",
"terminal_display": {
"amount_guide_type": "percentage_guide",
"percentage_guide": {
"show_amount": false,
"percentage_low": 15,
"percentage_medium": 18,
"percentage_high": 20
}
}
},
"signature_required": null,
"contactless_payments": null,
"quick_chip": null,
"deferred_authorization": {
"enabled": null,
"international_enabled": null,
"max_transaction_count": 20,
"max_total_amount": 250000,
"max_transaction_amount": 12500,
"supported_card_entry_modes": [
"chip",
"contactless"
]
}
}
},
"api_version": "3.0"
}
Terms of Service
Class Name
TermsOfService
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
acceptance_time |
Integer |
Optional | - |
original_ip |
String |
Optional | Constraints: Maximum Length: 45, Pattern: ^[A-F0-9:\.]*$ |
Example (as JSON)
{
"acceptance_time": null,
"original_ip": null
}
Tokens Request
Class Name
TokensRequest
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
legal_entities |
LegalEntity |
Optional | - |
payment_methods |
PaymentMethodReq |
Optional | - |
payout_methods |
PayoutMethodReq |
Optional | - |
resource |
Resource2Enum |
Required | - |
Example (as JSON)
{
"legal_entities": null,
"payment_methods": null,
"payout_methods": null,
"resource": "legal_entities"
}
Tokens Response
Class Name
TokensResponse
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
create_time |
Integer |
Required | - |
expire_time |
Integer |
Required | - |
id |
String |
Required | The generated token id. |
owner |
Owner20 |
Required | Owner structure to be used in any resource where an application is the owner |
path |
String |
Optional | - |
resource |
String |
Required | - |
api_version |
String |
Optional | - |
Example (as JSON)
{
"create_time": null,
"expire_time": null,
"id": null,
"owner": {
"id": null,
"resource": "applications"
},
"resource": "tokens"
}
Transaction Records Response
Class Name
TransactionRecordsResponse
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
mnext |
String |
Optional | - |
previous |
String |
Optional | - |
results |
Array<TransactionRecord> |
Required | Constraints: Unique Items Required |
api_version |
String |
Optional | - |
Example (as JSON)
{
"results": {
"create_time": null,
"id": null,
"path": null,
"resource": "transaction_records"
}
}
Upcoming Issue
Class Name
UpcomingIssue
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
additional_documents_required |
Array<String> |
Optional | - |
errant_fields |
Hash |
Optional | - |
in_review |
Array<String> |
Optional | - |
application_block |
ApplicationBlock |
Optional | - |
issue_type |
IssueTypeEnum |
Required | - |
target |
Target |
Required | - |
Example (as JSON)
{
"additional_documents_required": null,
"errant_fields": null,
"in_review": null,
"application_block": null,
"issue_type": "additional_documents_required",
"target": {
"id": null,
"path": null,
"resource": null
}
}
US
Class Name
US
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
social_security_number |
String |
Optional | Constraints: Pattern: ^\d{3}[ -]?\d{2}[ -]?\d{4}$ |
social_security_number_last_four |
String |
Optional | Constraints: Pattern: ^\d{4}$ |
Example (as JSON)
{
"social_security_number": null,
"social_security_number_last_four": null
}
US1
Class Name
US1
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
social_security_number_is_present |
Boolean |
Optional | - |
social_security_number_last_four_is_present |
Boolean |
Optional | - |
Example (as JSON)
{
"social_security_number_is_present": null,
"social_security_number_last_four_is_present": null
}
US4
Class Name
US4
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
employer_identification_number |
String |
Optional | Constraints: Pattern: ^\d{9}$ |
legal_form |
LegalFormEnum |
Optional | - |
Example (as JSON)
{
"employer_identification_number": null,
"legal_form": null
}
USD
Class Name
USD
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
next_payout_time |
Integer |
Optional | - |
payout_method_id |
String |
Optional | - |
period |
PeriodEnum |
Optional | - |
Example (as JSON)
{
"next_payout_time": null,
"payout_method_id": null,
"period": null
}
USD1
Class Name
USD1
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
balance |
Integer |
Optional | - |
incoming_pending |
Integer |
Optional | - |
outgoing_pending |
Integer |
Optional | - |
reserve |
Integer |
Optional | - |
Example (as JSON)
{
"balance": null,
"incoming_pending": null,
"outgoing_pending": null,
"reserve": null
}
USD2
Class Name
USD2
Fields
| Name | Type | Tags | Description |
|---|---|---|---|
payout_method_id |
String |
Required | Constraints: Maximum Length: 255 |
period |
PeriodEnum |
Required | - |
Example (as JSON)
{
"payout_method_id": "payout_method_id2",
"period": "weekly"
}
Enumerations
- Currency
- Country Code
- Rbit-Types
- Rbit-Source
- Fee Type
- Resource-Legal Entities
- Resource Types-Rbit
- Initiated By-Resp
- Resource-Payments
- Currency-Nullable
- Resource-Notifications
- Terminals Status
- Resource-Accounts
- Resource-Verifications
- Resource-Capabilities
- Initiated By-Req
- Account Type
- Address Type
- Amount Guide Type
- Card Brand 2
- Card Brand
- Card Entry Type
- Code Type
- Credit Debit Preference
- Credit Debit Preference 1
- Delivery Type
- Detail Code
- Detail Code 1
- Detail Code 2
- Detail Code 3
- Detail Code 4
- Detail Code 5
- Detail Code 6
- Detail Code 7
- Detail Code 8
- Detail Code 9
- Detail Code 10
- Errant Field
- Issue Type
- Issue Type 4
- Legal Form
- Legal Form 1
- Mfa Action
- Mode
- Model
- Model 1
- Name Type
- Payment Method Type
- Payout Method Type
- Period
- Phone Type
- Reason Code
- Reason Code 1
- Reason Code 2
- Reason Code 3
- Reason Code 4
- Reason Code 5
- Reason Code 6
- Reason Code 7
- Reason Code 8
- Reason Code 9
- Resource
- Resource 1
- Resource 2
- Role
- Service Billing Method
- Setup By
- State
- Status
- Status 2
- Status 3
- Status 4
- Status 5
- Status 8
- Status 20
- Supported Card Entry Mode
- Terminals-Supported Card Brand
- Timezone
- Topic
- Topic 1
- Type
- Type 2
- Type 3
- Type 4
- Type 5
- Type 6
- Type 7
- Type 8
- Type 9
- Type 12
- Type 15
- Type 27
- Units
- Virtual Terminal Mode
Currency
Class Name
CurrencyEnum
Fields
| Name |
|---|
USD |
CAD |
GBP |
Country Code
Class Name
CountryCodeEnum
Fields
| Name |
|---|
AD |
AE |
AF |
AG |
AI |
AL |
AM |
AO |
AQ |
AR |
AS |
AT |
AU |
AW |
AX |
AZ |
BA |
BB |
BD |
BE |
BF |
BG |
BH |
BI |
BJ |
BL |
BM |
BN |
BO |
BQ |
BR |
BS |
BT |
BV |
BW |
BY |
BZ |
CA |
CC |
CD |
CF |
CG |
CH |
CI |
CK |
CL |
CM |
CN |
CO |
CR |
CU |
CV |
CW |
CX |
CY |
CZ |
DE |
DJ |
DK |
DM |
DO |
DZ |
EC |
EE |
EG |
EH |
ER |
ES |
ET |
FI |
FJ |
FK |
FM |
FO |
FR |
GA |
GB |
GD |
GE |
GF |
GG |
GH |
GI |
GL |
GM |
GN |
GP |
GQ |
GR |
GS |
GT |
GU |
GW |
GY |
HK |
HM |
HN |
HR |
HT |
HU |
ID |
IE |
IL |
IM |
IN |
IO |
IQ |
IR |
IS |
IT |
JE |
JM |
JO |
JP |
KE |
KG |
KH |
KI |
KM |
KN |
KP |
KR |
KW |
KY |
KZ |
LA |
LB |
LC |
LI |
LK |
LR |
LS |
LT |
LU |
LV |
LY |
MA |
MC |
MD |
ME |
MF |
MG |
MH |
MK |
ML |
MM |
MN |
MO |
MP |
MQ |
MR |
MS |
MT |
MU |
MV |
MW |
MX |
MY |
MZ |
NA |
NC |
NE |
NF |
NG |
NI |
NL |
NO |
NP |
NR |
NU |
NZ |
OM |
PA |
PE |
PF |
PG |
PH |
PK |
PL |
PM |
PN |
PR |
PS |
PT |
PW |
PY |
QA |
RE |
RO |
RS |
RU |
RW |
SA |
SB |
SC |
SD |
SE |
SG |
SH |
SI |
SJ |
SK |
SL |
SM |
SN |
SO |
SR |
SS |
ST |
SV |
SX |
SY |
SZ |
TC |
TD |
TF |
TG |
TH |
TJ |
TK |
TL |
TM |
TN |
TO |
TR |
TT |
TV |
TW |
TZ |
UA |
UG |
UM |
US |
UY |
UZ |
VA |
VC |
VE |
VG |
VI |
VN |
VU |
WF |
WS |
YE |
YT |
ZA |
ZM |
ZW |
Rbit-Types
Class Name
RbitTypesEnum
Fields
| Name |
|---|
ADDRESS |
AUTO_BILLING |
BUSINESS_DESCRIPTION |
BUSINESS_NAME |
EXTERNAL_ACCOUNT |
FUNDRAISING_EVENT |
FUNDRAISING_UPDATE |
INDUSTRY_CODE |
PARTNER_SERVICE |
PERSON |
PHONE |
TRANSACTION_DETAILS |
MFA |
Rbit-Source
Class Name
RbitSourceEnum
Fields
| Name |
|---|
USER |
GUIDESTAR |
EXPERIAN_PRECISE_ID |
EXPERIAN_BIZ_ID |
EXPERIAN_BIZ_IQ |
EQUIFAX |
SPOKEO |
WHITEPAGES |
IRS_TIN_CHECK |
PARTNER_DATABASE |
PARTNER_EMPLOYEE |
GENERIC_WEBSITE |
Fee Type
Class Name
FeeTypeEnum
Fields
| Name |
|---|
VISA |
MASTERCARD |
AMEX |
DISCOVER |
ECHECK |
CHARGEBACK |
OTHER |
Resource-Legal Entities
Class Name
ResourceLegalEntitiesEnum
Fields
| Name |
|---|
LEGAL_ENTITIES |
Resource Types-Rbit
Class Name
ResourceTypesRbitEnum
Fields
| Name |
|---|
LEGAL_ENTITIES |
ACCOUNTS |
PAYOUT_METHODS |
PAYMENT_METHODS |
PAYMENTS |
REFUNDS |
ITEMS |
ORDERS |
Initiated By-Resp
Class Name
InitiatedByRespEnum
Fields
| Name |
|---|
CUSTOMER |
MERCHANT |
NONE |
Resource-Payments
Class Name
ResourcePaymentsEnum
Fields
| Name |
|---|
PAYMENTS |
Currency-Nullable
Class Name
CurrencyNullableEnum
Fields
| Name |
|---|
USD |
CAD |
GBP |
Resource-Notifications
Class Name
ResourceNotificationsEnum
Fields
| Name |
|---|
NOTIFICATIONS |
Terminals Status
The status of the terminal. Active means the terminal is able to accept authorizations. Inactive means the terminal has been deactivated and is unable to accept payments (this can occur for risk and fraud related reasons).
Class Name
TerminalsStatusEnum
Fields
| Name |
|---|
ACTIVE |
DELETED |
INACTIVE |
Resource-Accounts
Class Name
ResourceAccountsEnum
Fields
| Name |
|---|
ACCOUNTS |
Resource-Verifications
Class Name
ResourceVerificationsEnum
Fields
| Name |
|---|
VERIFICATIONS |
Resource-Capabilities
Class Name
ResourceCapabilitiesEnum
Fields
| Name |
|---|
CAPABILITIES |
Initiated By-Req
Class Name
InitiatedByReqEnum
Fields
| Name |
|---|
CUSTOMER |
MERCHANT |
Account Type
Class Name
AccountTypeEnum
Fields
| Name |
|---|
CHECKING |
SAVINGS |
Address Type
Class Name
AddressTypeEnum
Fields
| Name |
|---|
INCORPORATION |
HEADQUARTERS |
SATELLITE |
MAIL_FORWARDING |
HOME |
Amount Guide Type
The type of the amount guide can be either a percentage guide or a flat guide. Percentage guides will offer the payer a chance to tip with one of a few default tip percentages that are configured. Flat guides will offer the payer flat tip amounts to choose from. Both types of guides will allow the payer to manually enter a tip amount.
Class Name
AmountGuideTypeEnum
Fields
| Name |
|---|
PERCENTAGE_GUIDE |
FLAT_GUIDE |
Card Brand 2
Class Name
CardBrand2Enum
Fields
| Name |
|---|
MASTERCARD |
VISA |
AMEX |
DISCOVER |
Card Brand
Class Name
CardBrandEnum
Fields
| Name |
|---|
VISA |
MASTERCARD |
DISCOVER |
AMEX |
JCB |
DINERS |
Card Entry Type
Class Name
CardEntryTypeEnum
Fields
| Name |
|---|
CARD_KEYED |
Code Type
Class Name
CodeTypeEnum
Fields
| Name |
|---|
MERCHANT_CATEGORY_CODE |
STANDARD_INDUSTRY_CODE |
NORTH_AMERICAN_INDUSTRY_CLASSIFICATION_SYSTEM |
Credit Debit Preference
Determines how the terminal should prefer to charge contactless cards. "credit" is the EMV default, selecting the highest priority application in the card (which is the credit application). Debit preferred attempts to select debit network application on the card first.
Class Name
CreditDebitPreferenceEnum
Fields
| Name |
|---|
CREDIT |
DEBIT |
Credit Debit Preference 1
Determines how the terminal should prefer credit vs debit when a card is dipped. "credit" indicates credit is the preferred application selection, whereas "debit" would prefer the debit application. "prompt" will perform the EMV default behavior, which is to prompt if multiple applications exist.
Class Name
CreditDebitPreference1Enum
Fields
| Name |
|---|
CREDIT |
DEBIT |
PROMPT |
Delivery Type
Class Name
DeliveryTypeEnum
Fields
| Name |
|---|
NONE |
FULLY_DELIVERED |
POINT_OF_SALE |
SHIPPING |
DONATION |
SUBSCRIPTION |
PARTIAL_PREPAYMENT |
FULL_PREPAYMENT |
Detail Code
Class Name
DetailCodeEnum
Fields
| Name |
|---|
PROCESSING |
UNKNOWN |
Detail Code 1
Class Name
DetailCode1Enum
Fields
| Name |
|---|
RISK_REVIEW |
PROCESSING |
UNKNOWN |
Detail Code 2
Class Name
DetailCode2Enum
Fields
| Name |
|---|
MANUAL_CAPTURE |
PROCESSING |
RISK_REVIEW |
ECHECK_SUBMISSION |
BANK_VERIFICATION |
UNKNOWN |
Detail Code 3
Class Name
DetailCode3Enum
Fields
| Name |
|---|
RISK_REVIEW |
PROCESSING |
Detail Code 4
Class Name
DetailCode4Enum
Fields
| Name |
|---|
SUSPECTED_PAYER_FRAUD |
SUSPECTED_MERCHANT_FRAUD |
ACCOUNT_COMPROMISED |
UNABLE_TO_VERIFY_CONTROLLING_OWNER |
UNABLE_TO_VERIFY_PAYER |
UNABLE_TO_VERIFY_OWNER_PAYER |
AGAINST_TOS |
ACCOUNT_CANNOT_GO_NEGATIVE |
HIGH_RISK_ACCOUNT |
NAME_MISMATCH |
ADMIN_KYC_MISMATCH |
OTHER |
UNKNOWN |
Detail Code 5
Class Name
DetailCode5Enum
Fields
| Name |
|---|
INVALID_ADDRESS |
INVALID_CARD_NUMBER |
INVALID_CARD_TYPE |
CARD_NOT_SUPPORTED |
INCORRECT_CID |
DECLINE_BANK |
DECLINE_ISSUER |
DECLINE_INSUFFICIENT_FUNDS |
DECLINE_CARD_STOLEN |
DECLINE_CARD_INACTIVE |
DECLINE_CREDIT_LIMIT |
DECLINE_BLACKLISTED |
DECLINE_GENERAL |
CARD_EXPIRED |
CARD_INVALID_DATA |
CARD_MISSING_FIELDS |
SYSTEM_FAILURE |
EXCESSIVE_AUTHORIZATIONS |
ACCOUNT_CANNOT_TRANSACT |
ABUSE |
BANK_FAILURE |
TESTING |
NO_PAYMENT_ATTEMPTED |
FAILED_PERMANENTLY |
UNEXPECTED |
UNDEFINED |
DEBIT_CARD_NOT_ACCEPTED |
EXCEEDED_TOKEN_AMOUNT_LIMIT |
TOKEN_CURRENCY_MISMATCH |
PROCESSOR_TIMED_OUT |
PROCESSOR_DECLINED |
R01 |
R02 |
R03 |
R04 |
R05 |
R06 |
R07 |
R08 |
R09 |
R10 |
R11 |
R12 |
R13 |
R14 |
R15 |
R16 |
R17 |
R18 |
R19 |
R20 |
R21 |
R22 |
R23 |
R24 |
R25 |
R26 |
R27 |
R28 |
R29 |
R30 |
R31 |
R32 |
R33 |
R34 |
R35 |
R36 |
R37 |
R38 |
R39 |
R40 |
R41 |
R42 |
R43 |
R44 |
R45 |
R46 |
R47 |
R50 |
R51 |
R52 |
R53 |
R61 |
R67 |
R68 |
R69 |
R70 |
R71 |
R72 |
R73 |
R74 |
R75 |
R76 |
R80 |
R81 |
R82 |
R83 |
R84 |
R94 |
R95 |
R97 |
R98 |
R99 |
REQUEST_EXPIRED |
RISK_REVIEW |
UNKNOWN |
Detail Code 6
Class Name
DetailCode6Enum
Fields
| Name |
|---|
INSUFFICIENT_FUNDS |
UNKNOWN |
Detail Code 7
Chargeback code for visa, mastercard, amex, and discover cards
Class Name
DetailCode7Enum
Fields
| Name |
|---|
ENUM_101 |
ENUM_102 |
ENUM_103 |
ENUM_104 |
ENUM_105 |
ENUM_111 |
ENUM_112 |
ENUM_113 |
ENUM_121 |
ENUM_122 |
ENUM_123 |
ENUM_124 |
ENUM_125 |
ENUM_126 |
ENUM_1261 |
ENUM_1262 |
ENUM_127 |
ENUM_131 |
ENUM_132 |
ENUM_133 |
ENUM_134 |
ENUM_135 |
ENUM_136 |
ENUM_137 |
ENUM_138 |
ENUM_139 |
ENUM_4807 |
ENUM_4808 |
ENUM_4812 |
ENUM_4831 |
ENUM_4834 |
ENUM_4835 |
ENUM_4837 |
ENUM_4840 |
ENUM_4841 |
ENUM_4842 |
ENUM_4846 |
ENUM_4847 |
ENUM_4849 |
ENUM_4850 |
ENUM_4853 |
ENUM_4854 |
ENUM_4855 |
ENUM_4859 |
ENUM_4860 |
ENUM_4862 |
ENUM_4863 |
ENUM_4870 |
ENUM_4871 |
ENUM_6305 |
ENUM_6321 |
C04 |
C05 |
C08 |
C28 |
C31 |
C32 |
F10 |
F14 |
F22 |
F24 |
F25 |
F29 |
FR2 |
FR4 |
FR6 |
P01 |
P03 |
P04 |
P05 |
P07 |
P08 |
P22 |
P23 |
ENUM_4534 |
ENUM_4541 |
ENUM_4542 |
ENUM_4550 |
ENUM_4553 |
ENUM_4586 |
ENUM_4752 |
ENUM_4753 |
ENUM_4754 |
ENUM_4755 |
ENUM_7010 |
ENUM_7030 |
UNKNOWN |
Detail Code 8
Class Name
DetailCode8Enum
Fields
| Name |
|---|
RISK_REVIEW |
UNKNOWN |
Detail Code 9
Adjustment detail code
Class Name
DetailCode9Enum
Fields
| Name |
|---|
CROSS_BORDER |
BALANCE_TRANSFER |
OTHER |
PARTIAL_CHARGEBACK_REVERSALS |
CHARGEBACK_FEE_REIMBURSEMENTS |
LIEN_OR_LEVY |
ESCHEATMENT |
CORRECTION_TO_FEE_SCHEDULES |
PROCESSING_FEE_REIMBURSEMENTS |
REVSHARE_DISBURSEMENTS |
INADVERTENT_REFUNDS |
BANK_OVERDRAFT_FEE |
NEGATIVE_ACCOUNT_BALANCE_RECOVERY |
NEGATIVE_ACCOUNT_BALANCE_TO_ZERO |
SYSTEM_ISSUES |
MISCELLANEOUS |
Detail Code 10
Class Name
DetailCode10Enum
Fields
| Name |
|---|
ILLEGIBLE |
CORRUPT_FILE |
INFO_MISMATCH |
DOC_UNSUPPORTED |
INCOMPLETE |
Errant Field
Class Name
ErrantFieldEnum
Fields
| Name |
|---|
IS_NULL |
IS_PO_BOX |
IS_FALSE |
Issue Type
Class Name
IssueTypeEnum
Fields
| Name |
|---|
APPLICATION_BLOCK |
ERRANT_FIELDS |
ADDITIONAL_DOCUMENTS_REQUIRED |
IN_REVIEW |
UNSUPPORTED |
FRAUD |
HIGH_RISK_CB_RATE |
REPORTED_USER |
TOS_VIOLATION |
COUNTRY_NOT_SUPPORTED |
COMPLIANCE |
CLOSED_FOR_LOSS |
Issue Type 4
Class Name
IssueType4Enum
Fields
| Name |
|---|
ERRANT_FIELDS |
ADDITIONAL_DOCUMENTS_REQUIRED |
IN_REVIEW |
Legal Form
Class Name
LegalFormEnum
Fields
| Name |
|---|
INDIVIDUAL |
SOLE_PROPRIETOR |
LIMITED_LIABILITY_COMPANY |
PARTNERSHIP |
CORPORATION |
NONPROFIT_CORPORATION |
UNINCORPORATED_ASSOCIATION |
PERSONAL_TRUST |
STATUTORY_TRUST |
GOVERNMENT_AGENCY |
Legal Form 1
Class Name
LegalForm1Enum
Fields
| Name |
|---|
INDIVIDUAL |
SOLE_TRADER |
PARTNERSHIP |
CHARITY |
LIMITED_LIABILITY_PARTNERSHIP |
PRIVATE_LIMITED_COMPANY |
PUBLIC_LIMITED_COMPANY |
Mfa Action
Class Name
MfaActionEnum
Fields
| Name |
|---|
ACTIVATED |
DISABLED |
UPDATED |
Mode
The way in which tip is handled by this terminal. If "disabled", tip will not be prompted for. Otherwise, value determines if the prompt should appear on the terminal or on the receipt. Note: If set to "prompt_on_terminal" then you must provide the "terminal_display" field as well.
Class Name
ModeEnum
Fields
| Name |
|---|
DISABLED |
PROMPT_ON_TERMINAL |
PROMPT_ON_RECEIPT |
Model
Class Name
ModelEnum
Fields
| Name |
|---|
VERIFONE_P400 |
VERIFONE_V400M |
Model 1
The model of the physical terminal.
Class Name
Model1Enum
Fields
| Name |
|---|
VERIFONE_P400 |
VERIFONE_V400M |
Name Type
Class Name
NameTypeEnum
Fields
| Name |
|---|
LEGAL |
DBA |
Payment Method Type
Class Name
PaymentMethodTypeEnum
Fields
| Name |
|---|
CREDIT_CARD |
PAYMENT_BANK_US |
Payout Method Type
Class Name
PayoutMethodTypeEnum
Fields
| Name |
|---|
PAYOUT_BANK_CA |
PAYOUT_BANK_GB |
PAYOUT_BANK_US |
Period
Class Name
PeriodEnum
Fields
| Name |
|---|
DAILY |
WEEKLY |
MONTHLY |
Phone Type
Class Name
PhoneTypeEnum
Fields
| Name |
|---|
MOBILE |
PERSONAL |
BUSINESS |
Reason Code
Class Name
ReasonCodeEnum
Fields
| Name |
|---|
PROCESSING |
UNKNOWN |
Reason Code 1
Class Name
ReasonCode1Enum
Fields
| Name |
|---|
REVIEW |
PROCESSING |
UNKNOWN |
Reason Code 2
Class Name
ReasonCode2Enum
Fields
| Name |
|---|
PENDING_CAPTURE |
PROCESSING |
REVIEW |
ECHECK_SUBMISSION |
BANK_VERIFICATION |
UNKNOWN |
Reason Code 3
Class Name
ReasonCode3Enum
Fields
| Name |
|---|
REVIEW |
PROCESSING |
Reason Code 4
Class Name
ReasonCode4Enum
Fields
| Name |
|---|
SUSPECTED_FRAUD |
VERIFICATION |
OTHER |
UNKNOWN |
Reason Code 5
Class Name
ReasonCode5Enum
Fields
| Name |
|---|
NOT_CAPTURED |
ECHECK_FRAUD |
BANK_NOT_CONFIRMED |
BANK_SYSTEM_ERROR |
PAYMENT_EXPIRED |
REVIEW |
UNKNOWN |
Reason Code 6
Class Name
ReasonCode6Enum
Fields
| Name |
|---|
BANK_REJECT |
UNKNOWN |
Reason Code 7
The category of dispute reason
Class Name
ReasonCode7Enum
Fields
| Name |
|---|
FRAUD |
RECOGNITION |
PROCESSING_ERROR |
SERVICES_NOT_PROVIDED |
NOT_AS_DESCRIBED |
INQUIRY |
UNKNOWN |
Reason Code 8
Class Name
ReasonCode8Enum
Fields
| Name |
|---|
REVIEW |
UNKNOWN |
Reason Code 9
The category of adjustment reason
Class Name
ReasonCode9Enum
Fields
| Name |
|---|
CROSS_BORDER |
BALANCE_TRANSFER |
CHARGEBACK |
ESCHEATMENT |
REIMBURSEMENTS_AND_CORRECTIONS |
MISCELLANEOUS |
Resource
Class Name
ResourceEnum
Fields
| Name |
|---|
ORDERS |
Resource 1
Class Name
Resource1Enum
Fields
| Name |
|---|
PAYMENTS |
REFUNDS |
ADJUSTMENTS |
PAYOUTS |
RECOVERIES |
DISPUTES |
Resource 2
Class Name
Resource2Enum
Fields
| Name |
|---|
PAYMENT_METHODS |
PAYOUT_METHODS |
LEGAL_ENTITIES |
Role
Class Name
RoleEnum
Fields
| Name |
|---|
EMPLOYEE |
FUNDRAISER |
FUNDRAISING_TEAM_CAPTAIN |
OTHER_THIRD_PARTY |
Service Billing Method
Class Name
ServiceBillingMethodEnum
Fields
| Name |
|---|
FREE_FORM_ENTRY |
TIMED_BILLING_AT_STAFF_RATE |
TIMED_BILLING_AT_TASK_RATE |
TIMED_BILLING_AT_PROJECT_RATE |
HOURLY_BILLING_AT_STAFF_RATE |
HOURLY_BILLING_AT_TASK_RATE |
HOURLY_BILLING_AT_PROJECT_RATE |
FLAT_PROJECT_AMOUNT |
Setup By
Class Name
SetupByEnum
Fields
| Name |
|---|
PAYER |
MERCHANT |
State
Class Name
StateEnum
Fields
| Name |
|---|
ACTIVE |
DELETED |
Status
Class Name
StatusEnum
Fields
| Name |
|---|
PENDING |
COMPLETED |
FAILED |
Status 2
Class Name
Status2Enum
Fields
| Name |
|---|
UNVERIFIED |
VERIFIED |
VERIFICATION_FAILED |
DELETED |
Status 3
Class Name
Status3Enum
Fields
| Name |
|---|
PENDING |
COMPLETED |
FAILED |
CANCELED |
Status 4
Class Name
Status4Enum
Fields
| Name |
|---|
UNPAID |
PAID |
DISPUTED |
Status 5
Class Name
Status5Enum
Fields
| Name |
|---|
AWAITING_MERCHANT_RESPONSE |
PENDING_WEPAY_REVIEW |
AWAITING_CHARGEBACK_DECISION |
RESOLVED |
Status 8
Class Name
Status8Enum
Fields
| Name |
|---|
IN_REVIEW |
VERIFIED |
REJECTED |
Status 20
Class Name
Status20Enum
Fields
| Name |
|---|
ACTIVE |
UNREACHABLE |
DELETED |
Supported Card Entry Mode
Class Name
SupportedCardEntryModeEnum
Fields
| Name |
|---|
CHIP |
MAGNETIC_STRIPE |
CONTACTLESS |
FALLBACK_TO_MAGNETIC_STRIPE |
Terminals-Supported Card Brand
Class Name
TerminalsSupportedCardBrandEnum
Fields
| Name |
|---|
VISA |
AMERICAN_EXPRESS |
DISCOVER |
MASTERCARD |
Timezone
Timezone of the terminal'
Class Name
TimezoneEnum
Fields
| Name |
|---|
ENUM_USALASKA |
ENUM_USALEUTIAN |
ENUM_USARIZONA |
ENUM_USCENTRAL |
ENUM_USEASTINDIANA |
ENUM_USEASTERN |
ENUM_USHAWAII |
ENUM_USINDIANASTARKE |
ENUM_USMICHIGAN |
ENUM_USMOUNTAIN |
ENUM_USPACIFIC |
ENUM_USPACIFICNEW |
ENUM_USSAMOA |
Topic
Class Name
TopicEnum
Fields
| Name |
|---|
ENUM_ADJUSTMENTS |
ENUM_ADJUSTMENTSCREATED |
ENUM_ACCOUNTS |
ENUM_ACCOUNTSCREATED |
ENUM_ACCOUNTSUPDATED |
ENUM_ACCOUNTSCAPABILITIES |
ENUM_ACCOUNTSCAPABILITIESUPDATED |
ENUM_ACCOUNTSNEGATIVE_BALANCE |
ENUM_LEGAL_ENTITIES |
ENUM_LEGAL_ENTITIESCREATED |
ENUM_LEGAL_ENTITIESUPDATED |
ENUM_LEGAL_ENTITIESVERIFICATIONS |
ENUM_LEGAL_ENTITIESVERIFICATIONSUPDATED |
ENUM_DISPUTES |
ENUM_DISPUTESCREATED |
ENUM_DISPUTESRESOLVED |
ENUM_DISPUTESUPDATED |
ENUM_DISPUTESFUNDS_WITHDRAWN |
ENUM_DISPUTESFUNDS_REINSTATED |
ENUM_PAYMENT_METHODS |
ENUM_PAYMENT_METHODSCREATED |
ENUM_PAYMENT_METHODSDELETED |
ENUM_PAYMENT_METHODSUPDATED |
ENUM_PAYMENT_METHODSVERIFIED |
ENUM_PAYMENT_METHODSMICRODEPOSIT_SENT |
ENUM_PAYOUT_METHODS |
ENUM_PAYOUT_METHODSCREATED |
ENUM_PAYMENTS |
ENUM_PAYMENTSCREATED |
ENUM_PAYMENTSCOMPLETED |
ENUM_PAYMENTSFAILED |
ENUM_PAYMENTSIN_REVIEW |
ENUM_PAYMENTSCANCELED |
ENUM_PAYOUTS |
ENUM_PAYOUTSCREATED |
ENUM_PAYOUTSCOMPLETED |
ENUM_PAYOUTSIN_REVIEW |
ENUM_PAYOUTSFAILED |
ENUM_RECOVERIES |
ENUM_RECOVERIESCREATED |
ENUM_RECOVERIESCOMPLETED |
ENUM_RECOVERIESFAILED |
ENUM_REFUNDS |
ENUM_REFUNDSCREATED |
ENUM_REFUNDSCOMPLETED |
ENUM_REFUNDSFAILED |
Topic 1
Class Name
Topic1Enum
Fields
| Name |
|---|
ENUM_ADJUSTMENTSCREATED |
ENUM_ACCOUNTSCREATED |
ENUM_ACCOUNTSUPDATED |
ENUM_ACCOUNTSCAPABILITIESUPDATED |
ENUM_ACCOUNTSNEGATIVE_BALANCE |
ENUM_LEGAL_ENTITIESCREATED |
ENUM_LEGAL_ENTITIESUPDATED |
ENUM_LEGAL_ENTITIESVERIFICATIONSUPDATED |
ENUM_DISPUTESCREATED |
ENUM_DISPUTESRESOLVED |
ENUM_DISPUTESUPDATED |
ENUM_DISPUTESFUNDS_WITHDRAWN |
ENUM_DISPUTESFUNDS_REINSTATED |
ENUM_PAYMENT_METHODSCREATED |
ENUM_PAYMENT_METHODSDELETED |
ENUM_PAYMENT_METHODSUPDATED |
ENUM_PAYMENT_METHODSVERIFIED |
ENUM_PAYMENT_METHODSMICRODEPOSIT_SENT |
ENUM_PAYOUT_METHODSCREATED |
ENUM_PAYMENTSCREATED |
ENUM_PAYMENTSCOMPLETED |
ENUM_PAYMENTSFAILED |
ENUM_PAYMENTSIN_REVIEW |
ENUM_PAYMENTSCANCELED |
ENUM_PAYOUTSCREATED |
ENUM_PAYOUTSCOMPLETED |
ENUM_PAYOUTSIN_REVIEW |
ENUM_PAYOUTSFAILED |
ENUM_RECOVERIESCREATED |
ENUM_RECOVERIESCOMPLETED |
ENUM_RECOVERIESFAILED |
ENUM_REFUNDSCREATED |
ENUM_REFUNDSCOMPLETED |
ENUM_REFUNDSFAILED |
Type
Class Name
TypeEnum
Fields
| Name |
|---|
MOBILE |
PERSONAL |
BUSINESS |
Type 2
Class Name
Type2Enum
Fields
| Name |
|---|
PAYOUT_BANK_CA |
PAYOUT_BANK_GB |
PAYOUT_BANK_US |
Type 3
Class Name
Type3Enum
Fields
| Name |
|---|
CREDIT_CARD |
PAYMENT_BANK_US |
Type 4
Class Name
Type4Enum
Fields
| Name |
|---|
GOODS |
SERVICE |
DONATION |
EVENT |
PERSONAL |
Type 5
Class Name
Type5Enum
Fields
| Name |
|---|
WON |
LOST |
PENDING |
Type 6
Class Name
Type6Enum
Fields
| Name |
|---|
INQUIRY |
CHARGEBACK |
Type 7
Class Name
Type7Enum
Fields
| Name |
|---|
CREDIT |
DEBIT |
Type 8
Class Name
Type8Enum
Fields
| Name |
|---|
MERCHANT_PAYMENT |
APP_FEE |
MERCHANT_PAYMENT_REFUND |
APP_FEE_REFUND |
MERCHANT_CHARGEBACK |
APP_FEE_CHARGEBACK |
MERCHANT_CHARGEBACK_FEE |
MERCHANT_CHARGEBACK_REVERSAL |
APP_FEE_CHARGEBACK_REVERSAL |
PAYOUT |
PAYOUT_RETURN |
RECOVERY |
RECOVERY_RETURN |
ADJUSTMENT |
Type 9
Class Name
Type9Enum
Fields
| Name |
|---|
CREDIT_CARD |
PAYMENT_BANK_US |
PAYMENT_METHOD_ID |
ENCODED_PAYMENT_METHOD |
Type 12
Class Name
Type12Enum
Fields
| Name |
|---|
LEGAL_ENTITY |
LEGAL_ENTITY_ID |
Type 15
Class Name
Type15Enum
Fields
| Name |
|---|
PASSPORT |
DRIVERS_LICENSE |
OTHER_GOVERNMENT_ISSUED_PHOTO_ID |
CURRENT_LEASE_CONTRACT |
CURRENT_UTILITY_BILL |
BENEFITS_CARD |
BIRTH_CERTIFICATE |
CERTIFICATE_OF_CITIZENSHIP |
CERTIFICATE_OF_NATURALIZATION |
CERTIFIED_COPY_OF_COURT_ORDER |
EMPLOYMENT_AUTHORIZATION_CARD |
PERMANENT_RESIDENT_CARD |
SOCIAL_SECURITY_CARD |
SOCIAL_INSURANCE_NUMBER_CARD |
EVIDENCE_OF_CORPORATE_REGISTRATION |
EVIDENCE_OF_NONPROFIT_REGISTRATION |
EVIDENCE_OF_AUTHORITY |
CURRENT_BANK_STATEMENT |
CURRENT_LOCAL_TAX_BILL |
MORTGAGE_STATEMENT |
ELECTORAL_REGISTER_ENTRY |
Type 27
Class Name
Type27Enum
Fields
| Name |
|---|
NOTIFICATION |
Units
Class Name
UnitsEnum
Fields
| Name |
|---|
POUNDS |
KILOGRAMS |
Virtual Terminal Mode
Class Name
VirtualTerminalModeEnum
Fields
| Name |
|---|
MOBILE |
WEB |
Utility Classes Documentation
ApiHelper Class
API utility class.
Methods
| Name | Return Type | Description |
|---|---|---|
| json_deserialize | Hash | Deserializes a JSON string to a Ruby Hash. |
| rfc3339 | DateTime | Safely converts a string into an RFC3339 DateTime object. |
Common Code Documentation
HttpResponse
Http response received.
Properties
| Name | Type | Description |
|---|---|---|
| status_code | Integer | The status code returned by the server. |
| reason_phrase | String | The reason phrase returned by the server. |
| headers | Hash | Response headers. |
| raw_body | String | Response body. |
| request | HttpRequest | The request that resulted in this response. |
HttpRequest
Represents a single Http Request.
Properties
| Name | Type | Tag | Description |
|---|---|---|---|
| http_method | HttpMethodEnum | The HTTP method of the request. | |
| query_url | String | The endpoint URL for the API request. | |
| headers | Hash | Optional | Request headers. |
| parameters | Hash | Optional | Request body. |