API docs by Redocly

VET Docs (1.0)

Download OpenAPI specification:

Build Information

Branch: main

SHA: 00104529

Property Tags

For resources that have been published, the following additional tags found on properties can be used to determine if and how a properties values might change.

Tag Description
Immutable The property cannot be modified once set.
Additive The property array may only have additional values or objects appended. Existing values will not be removed however existing objects may be partially updated. Refer to the property specific description for more information.

Client

Get client collection

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get client

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "servicecloud_id": "0000WO1Zi",
  • "servicecloud_identifiers": [
    ],
  • "legal_name": "Apruve, Inc.",
  • "trading_name": "Apruve",
  • "metadata": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Client Draft

Get client draft

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "servicecloud_id": "0000WO1Zi",
  • "servicecloud_identifiers": [
    ],
  • "legal_name": "Apruve, Inc.",
  • "trading_name": "Apruve",
  • "metadata": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update client draft

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Request Body schema: application/json
legal_name
required
string [ 1 .. 256 ] characters

The legal name of this client.

string or null
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "legal_name": "Apruve, Inc.",
  • "trading_name": "Apruve"
}

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "servicecloud_id": "0000WO1Zi",
  • "servicecloud_identifiers": [
    ],
  • "legal_name": "Apruve, Inc.",
  • "trading_name": "Apruve",
  • "metadata": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Submit client draft

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "servicecloud_id": "0000WO1Zi",
  • "servicecloud_identifiers": [
    ],
  • "legal_name": "Apruve, Inc.",
  • "trading_name": "Apruve",
  • "metadata": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Program

Get program collection

Immutable and Additive tags are provided for properties where applicable. Programs with an onboarding_status of Created are considered not published so do not adhere to tag rules.

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get program

Immutable and Additive tags are provided for properties where applicable. Programs with a status of Created are considered not published so do not adhere to tag rules.

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "onboarding_type": "Default",
  • "onboarding_status": "Created",
  • "client_id": "e1b31b7b-4025-4445-b3d6-251128c7484d",
  • "client_legal_name": "Apruve, Inc.",
  • "servicecloud_id": "0000WO1Zi",
  • "servicecloud_name": "string",
  • "servicecloud_identifiers": [
    ],
  • "name": "Apruve",
  • "product_type": "SMB",
  • "program_type": "Sandbox",
  • "business_country": "US",
  • "business_operating_countries": "US",
  • "contract_country": "US",
  • "api_version": "v1",
  • "merchant_of_record": "Client",
  • "is_marketplace": true,
  • "is_cashier_model": true,
  • "is_customer_portal_enabled": true,
  • "is_seller_portal_enabled": true,
  • "is_individual_spending_limits_enabled": true,
  • "is_withhold_seller_amount_enabled": true,
  • "is_recourse_enabled": true,
  • "is_purchase_policies_enabled": true,
  • "is_pricing_enabled": true,
  • "pricing_levels": 10,
  • "pricing_default_level": 10,
  • "pricing_groups": [
    ],
  • "is_trade_credit_insurance_enabled": true,
  • "is_trade_credit_insurance_fraud_check_enabled": true,
  • "is_standalone_credit_enabled": true,
  • "is_cobranding_enabled": true,
  • "web_logo_url": "string",
  • "email_logo_url": "string",
  • "client_support_phone": "string",
  • "client_support_email": "string",
  • "dispute_eligibility_days": 1,
  • "dispute_timeout_days": 1,
  • "client_support_url": "string",
  • "customer_countries": "US",
  • "seller_countries": "US",
  • "currencies": "USD",
  • "system_currency": "USD",
  • "client_currency": "USD",
  • "program_currency": "USD",
  • "support_phone": "string",
  • "support_url": "string",
  • "online_payment_url": "string",
  • "customer_portal_subdomain_name": "string",
  • "customer_portal_domain_name": "string",
  • "customer_portal_custom_domain_name": "string",
  • "sender_email": "string",
  • "reply_to_email": "string",
  • "dispute_email": "string",
  • "accounts_receivable_email": "string",
  • "customer_success_team_email": "string",
  • "l1_support_email": "string",
  • "webhook_error_email": "string",
  • "aml_compliance_email": "string",
  • "support_email": "string",
  • "underwriting_email": "string",
  • "remittance_email": "string",
  • "fraud_email": "string",
  • "project_abbreviation": "SMB",
  • "unipay_customer_network_code": "C1",
  • "unipay_seller_network_code": "T1",
  • "sphere_payer_code": "MSTSSMB",
  • "sphere_processor_code": "MSTSSMB",
  • "customer_default_locale": "en-US",
  • "customer_locales": [
    ],
  • "seller_default_locale": "en-US",
  • "seller_locales": [
    ],
  • "financial_partner": {
    },
  • "remittance_bank_accounts": [
    ],
  • "remittance_addresses": [
    ],
  • "payment_terms": [
    ],
  • "status": "Created",
  • "version": "string",
  • "metadata": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "updated_by": "Lauren Brandon",
  • "activated_at": "2019-08-24T14:15:22Z",
  • "activated_by": "Robert Kentish",
  • "has_draft": true,
  • "is_program_fee_service_fee_customer_groups_enabled": true,
  • "program_fee_service_fee_customer_groups": [
    ],
  • "customer_onboarding_groups": [
    ],
  • "seller_agreement": {
    }
}

Update program status

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Request Body schema: application/json
status
required
any
Enum: "Created" "Active" "Inactive" "Terminated" "Archived"
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "status": "Created"
}

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "onboarding_type": "Default",
  • "onboarding_status": "Created",
  • "client_id": "e1b31b7b-4025-4445-b3d6-251128c7484d",
  • "client_legal_name": "Apruve, Inc.",
  • "servicecloud_id": "0000WO1Zi",
  • "servicecloud_name": "string",
  • "servicecloud_identifiers": [
    ],
  • "name": "Apruve",
  • "product_type": "SMB",
  • "program_type": "Sandbox",
  • "business_country": "US",
  • "business_operating_countries": "US",
  • "contract_country": "US",
  • "api_version": "v1",
  • "merchant_of_record": "Client",
  • "is_marketplace": true,
  • "is_cashier_model": true,
  • "is_customer_portal_enabled": true,
  • "is_seller_portal_enabled": true,
  • "is_individual_spending_limits_enabled": true,
  • "is_withhold_seller_amount_enabled": true,
  • "is_recourse_enabled": true,
  • "is_purchase_policies_enabled": true,
  • "is_pricing_enabled": true,
  • "pricing_levels": 10,
  • "pricing_default_level": 10,
  • "pricing_groups": [
    ],
  • "is_trade_credit_insurance_enabled": true,
  • "is_trade_credit_insurance_fraud_check_enabled": true,
  • "is_standalone_credit_enabled": true,
  • "is_cobranding_enabled": true,
  • "web_logo_url": "string",
  • "email_logo_url": "string",
  • "client_support_phone": "string",
  • "client_support_email": "string",
  • "dispute_eligibility_days": 1,
  • "dispute_timeout_days": 1,
  • "client_support_url": "string",
  • "customer_countries": "US",
  • "seller_countries": "US",
  • "currencies": "USD",
  • "system_currency": "USD",
  • "client_currency": "USD",
  • "program_currency": "USD",
  • "support_phone": "string",
  • "support_url": "string",
  • "online_payment_url": "string",
  • "customer_portal_subdomain_name": "string",
  • "customer_portal_domain_name": "string",
  • "customer_portal_custom_domain_name": "string",
  • "support_email": "string",
  • "fraud_email": "string",
  • "underwriting_email": "string",
  • "remittance_email": "string",
  • "accounts_receivable_email": "string",
  • "sender_email": "string",
  • "reply_to_email": "string",
  • "customer_success_team_email": "string",
  • "l1_support_email": "string",
  • "webhook_error_email": "string",
  • "aml_compliance_email": "string",
  • "dispute_email": "string",
  • "project_abbreviation": "SMB",
  • "unipay_customer_network_code": "C1",
  • "unipay_seller_network_code": "T1",
  • "sphere_payer_code": "MSTSSMB",
  • "sphere_processor_code": "MSTSSMB",
  • "customer_default_locale": "en-US",
  • "customer_locales": [
    ],
  • "seller_default_locale": "en-US",
  • "seller_locales": [
    ],
  • "financial_partner": {
    },
  • "remittance_bank_accounts": [
    ],
  • "remittance_addresses": [
    ],
  • "payment_terms": [
    ],
  • "status": "Created",
  • "version": "string",
  • "metadata": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "updated_by": "Lauren Brandon",
  • "activated_at": "2019-08-24T14:15:22Z",
  • "activated_by": "Robert Kentish",
  • "is_program_fee_service_fee_customer_groups_enabled": true,
  • "program_fee_service_fee_customer_groups": [
    ],
  • "customer_onboarding_groups": [
    ],
  • "seller_agreement": {
    }
}

Validate program

Validates the existing program configuration. When invalid will return errors.

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Search programs

Immutable and Additive tags are provided for properties where applicable. Programs with an onboarding_status of Created are considered not published so do not adhere to tag rules.

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Program Draft

Delete program draft

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Request Body schema: application/json
version
string

The record version

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "version": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get program draft

Immutable and Additive tags are provided for properties where applicable. Programs with a status of Created are considered not published so do not adhere to tag rules.

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "onboarding_type": "Default",
  • "onboarding_status": "Created",
  • "client_id": "e1b31b7b-4025-4445-b3d6-251128c7484d",
  • "client_legal_name": "Apruve, Inc.",
  • "name": "Apruve",
  • "product_type": "SMB",
  • "program_type": "Sandbox",
  • "contract_country": "US",
  • "api_version": "v1",
  • "merchant_of_record": "Client",
  • "is_marketplace": true,
  • "is_cashier_model": true,
  • "is_customer_portal_enabled": true,
  • "is_seller_portal_enabled": true,
  • "is_individual_spending_limits_enabled": true,
  • "is_withhold_seller_amount_enabled": true,
  • "is_recourse_enabled": true,
  • "is_purchase_policies_enabled": true,
  • "is_pricing_enabled": true,
  • "pricing_levels": 10,
  • "pricing_default_level": 10,
  • "pricing_groups": [
    ],
  • "is_trade_credit_insurance_enabled": true,
  • "is_trade_credit_insurance_fraud_check_enabled": true,
  • "is_standalone_credit_enabled": true,
  • "is_cobranding_enabled": true,
  • "web_logo_url": "string",
  • "email_logo_url": "string",
  • "client_support_phone": "string",
  • "client_support_email": "string",
  • "dispute_eligibility_days": 1,
  • "dispute_timeout_days": 1,
  • "client_support_url": "string",
  • "customer_countries": "US",
  • "seller_countries": "US",
  • "currencies": "USD",
  • "system_currency": "USD",
  • "client_currency": "USD",
  • "program_currency": "USD",
  • "support_phone": "string",
  • "support_url": "string",
  • "online_payment_url": "string",
  • "customer_portal_subdomain_name": "string",
  • "customer_portal_domain_name": "string",
  • "customer_portal_custom_domain_name": "string",
  • "support_email": "string",
  • "fraud_email": "string",
  • "underwriting_email": "string",
  • "remittance_email": "string",
  • "accounts_receivable_email": "string",
  • "sender_email": "string",
  • "reply_to_email": "string",
  • "customer_success_team_email": "string",
  • "l1_support_email": "string",
  • "webhook_error_email": "string",
  • "aml_compliance_email": "string",
  • "dispute_email": "string",
  • "project_abbreviation": "SMB",
  • "unipay_customer_network_code": "C1",
  • "unipay_seller_network_code": "T1",
  • "sphere_payer_code": "MSTSSMB",
  • "sphere_processor_code": "MSTSSMB",
  • "customer_default_locale": "en-US",
  • "customer_locales": [
    ],
  • "seller_default_locale": "en-US",
  • "seller_locales": [
    ],
  • "version": "string",
  • "financial_partner": {
    },
  • "is_program_fee_service_fee_customer_groups_enabled": true,
  • "program_fee_service_fee_customer_groups": [
    ],
  • "customer_onboarding_groups": [
    ],
  • "remittance_bank_accounts": [
    ],
  • "remittance_addresses": [
    ],
  • "seller_agreement": {
    },
  • "payment_terms": [
    ],
  • "status": "Created",
  • "metadata": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "updated_by": "Lauren Brandon",
  • "activated_at": "2019-08-24T14:15:22Z",
  • "activated_by": "Robert Kentish"
}

Update program draft

Immutable and Additive tags are provided for properties where applicable. Programs with a status of Created are considered not published so do not adhere to tag rules.

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Request Body schema: application/json
name
string [ 1 .. 256 ] characters

The name of the program.

api_version
any
Enum: "v1" "v2"

API version that client integrations are allowed to access.

contract_country
string <iso-3166-2> = 2 characters ^[A-Z]{2}$

ISO 3166-2 country

merchant_of_record
any
Enum: "Client" "Seller"
is_marketplace
boolean
client_currency
string <iso-4217> ^[A-Z]{3}$

Internal TreviPay client reporting currency. Must exist within the currencies property values. Will default to the system_currency property value if the program_type is Sandbox.

program_currency
string <iso-4217> ^[A-Z]{3}$

Internal TreviPay client program reporting currency. Must exist within the currencies property values. Will default to the system_currency property value if the program_type is Sandbox.

customer_portal_subdomain_name
string <= 100 characters

Customer portal subdomain name. Required when customer_portal_domain_name is specified. Not allowed when customer_portal_custom_domain_name is specified.

customer_portal_domain_name
string <= 100 characters

Customer portal domain name. Required when customer_portal_subdomain_name is specified. Not allowed when customer_portal_custom_domain_name is specified.

customer_portal_custom_domain_name
string <= 100 characters

Customer portal custom domain name. Required when customer_portal_domain_name and customer_portal_subdomain_name is not specified. Not allowed when customer_portal_domain_name and customer_portal_subdomain_name is specified.

is_cashier_model
boolean

Whether the client issues the invoice while we issue a statement.

is_customer_portal_enabled
boolean

Whether the customer portal is enabled.

is_seller_portal_enabled
boolean

Whether the seller portal is enabled.

is_individual_spending_limits_enabled
boolean

Whether individual buyer spending limits is enabled. This may only be true when api_version is v2. Once enabled for an active program this feature cannot be disabled.

is_withhold_seller_amount_enabled
boolean

Immutable
Whether specifying a withheld amount from seller payments is enabled. This may only be true when merchant_of_record is Seller and api_version is v2.

is_recourse_enabled
boolean

Whether the program has the recourse feature enabled to allow clients to underwrite customers when they are initially denied credit or the client specifically chooses to. Once published, this flag may not be changed to disabled.

is_purchase_policies_enabled
boolean

Whether the validation of customer purchasing policies is enabled. This may only be true when api_version is v2.

is_pricing_enabled
boolean

Whether pricing checks are enabled for this program. Requires further configuration in the Enterprise Pricing Service. This may only be true when api_version is v2.

pricing_levels
integer [ 0 .. 10 ]

The number of pricing levels available in the program.

pricing_default_level
integer [ 0 .. 10 ]

The default pricing level to apply to customers when one is not supplied as part of the customer onboarding process.

Array of objects [ 1 .. 11 ] items

Pricing groups allow a client friendly name to be associated with a price level. A single pricing group will be created for every pricing level in order to allow the association of a name with the level.

is_trade_credit_insurance_enabled
boolean

Enables Trade Credit Insurance options for customers during onboarding and purchasing.

is_trade_credit_insurance_fraud_check_enabled
boolean

Enables extra verification of customers when trade credit is required.

is_standalone_credit_enabled
boolean

Enables clients and sellers to create a credit that is not associated with a previous transaction. Limits on credit values are imposed and usage should be approved before enabling.

is_cobranding_enabled
boolean

Co-Branding adjusts various aspects of the system (user interfaces, invoices and others) to make it clearer to the user that financing is being provided by TreviPay. It works in conjunction with the Client Support Phone and Email in the Support section to direct users back to the client for issues other than finance related ones.

web_logo_url
string <= 500 characters ^$|^https://.*.svg$

The URL of the logo to be used throughout the customer, client and seller portals.

email_logo_url
string <= 500 characters ^$|^https://.*.png$

The URL of the logo to be used in customer, client and seller communications.

client_support_phone
string <= 100 characters

The Client Support Phone Number is used throughout the system to provide a contact point for non-finance related questions.

client_support_email
string <= 200 characters ^$|^.*@.*..*$

The Client Support Email is used throughout the system to provide a contact point for non-finance related questions.

dispute_eligibility_days
integer [ 1 .. 180 ]

The period of time after a charge is created that it may be disputed.

dispute_timeout_days
integer [ 1 .. 180 ]

The period of time a client has to action a dispute once it has been raised by a customer.

client_support_url
string <= 500 characters ^$|^https://.+

Support URL displayed throughout the customer experience for non-program related support.

customer_countries
Array of strings <iso-3166-2> [ items <iso-3166-2 > = 2 characters ^[A-Z]{2}$ ]
seller_countries
Array of strings <iso-3166-2> [ items <iso-3166-2 > = 2 characters ^[A-Z]{2}$ ]
currencies
Array of strings <iso-4217> [ items <iso-4217 > = 3 characters ^[A-Z]{3}$ ]
support_phone
string <= 100 characters

Support phone number.

support_url
string <= 500 characters ^$|^https://.+

Support URL.

online_payment_url
string <= 500 characters ^$|^https://.+

Online payment URL.

sender_email
string <= 200 characters ^$|^.*@.*..*$

Sender email.

reply_to_email
string <= 200 characters ^$|^.*@.*..*$

Reply to email.

customer_success_team_email
string <= 200 characters ^$|^.*@.*..*$

Customer success email.

l1_support_email
string <= 200 characters ^$|^.*@.*..*$

Level 1 support email.

webhook_error_email
string <= 200 characters ^$|^.*@.*..*$

Webhook error email.

aml_compliance_email
string <= 200 characters ^$|^.*@.*..*$

AML compliance email.

dispute_email
string <= 200 characters ^$|^.*@.*..*$

Dispute email.

customer_default_locale
string <IETF BCP 47> [ 2 .. 10 ] characters ^[a-z]{2,3}(-[A-Z][a-z]{4})?(-[A-Z]{2})?$

The default locale for customers.

seller_default_locale
string <IETF BCP 47> [ 2 .. 10 ] characters ^[a-z]{2,3}(-[A-Z][a-z]{4})?(-[A-Z]{2})?$

The default locale for sellers.

project_abbreviation
string^[a-zA-Z0-9]{3}$

This is the 3-letter project abbreviation, primarily used by ServiceCloud.

unipay_customer_network_code
string^[a-zA-Z0-9]{2}$

This is the buyer network prefix for this client. This is used primarily for backwards compatibility. All new SMB clients have the buyer_network_abbreviation of "C2". All Digital River clients/programs have the same network_abbreviation of "D2".

unipay_seller_network_code
string^[a-zA-Z0-9]{2}$

This is the seller network prefix for this client. This is used solely to help Sphere generate merchant payout reports. All new SMB clients have the network_abbreviation of "C1". All Digital River clients/programs have the same network_abbreviation of "D1".

sphere_payer_code
string <= 100 characters ^[a-zA-Z0-9]*$

The code used by Accounting to report payments to entities to the IRS. SMB has the payer_code of "MSTSSMB". Digital River has the payer_code of "MSTSDigitalRiver". This is field SPHERE.SP_PAYER.MNUEMONIC.

sphere_processor_code
string <= 100 characters ^[a-zA-Z0-9]*$

This code is used by Sphere. SMB has the processor_code of "MSTSSMB" (the UPPER of the Mnuemonic). Digital River has the processor_code of "MSTSDIGITALRIVER". This is field SPHERE.SP_PAYER.PROCESSOR_CODE. This is the code that is entered into OneSource. This field would be owned by Sphere (Core Services).

version
string

The record version

object
is_program_fee_service_fee_customer_groups_enabled
boolean

This indicates whether the program has enabled program fee service fee customer group.

Array of objects >= 0 items

Program fee service fee customer groups.

Array of objects >= 0 items

Customer onboarding groups.

object
Array of objects >= 0 items
Array of objects >= 0 items
Array of objects >= 0 items
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "name": "Apruve",
  • "api_version": "v1",
  • "contract_country": "US",
  • "merchant_of_record": "Client",
  • "is_marketplace": true,
  • "client_currency": "USD",
  • "program_currency": "USD",
  • "customer_portal_subdomain_name": "string",
  • "customer_portal_domain_name": "string",
  • "customer_portal_custom_domain_name": "string",
  • "is_cashier_model": true,
  • "is_customer_portal_enabled": true,
  • "is_seller_portal_enabled": true,
  • "is_individual_spending_limits_enabled": true,
  • "is_withhold_seller_amount_enabled": true,
  • "is_recourse_enabled": true,
  • "is_purchase_policies_enabled": true,
  • "is_pricing_enabled": true,
  • "pricing_levels": 10,
  • "pricing_default_level": 10,
  • "pricing_groups": [
    ],
  • "is_trade_credit_insurance_enabled": true,
  • "is_trade_credit_insurance_fraud_check_enabled": true,
  • "is_standalone_credit_enabled": true,
  • "is_cobranding_enabled": true,
  • "web_logo_url": "string",
  • "email_logo_url": "string",
  • "client_support_phone": "string",
  • "client_support_email": "string",
  • "dispute_eligibility_days": 1,
  • "dispute_timeout_days": 1,
  • "client_support_url": "string",
  • "customer_countries": "US",
  • "seller_countries": "US",
  • "currencies": "USD",
  • "support_phone": "string",
  • "support_url": "string",
  • "online_payment_url": "string",
  • "sender_email": "string",
  • "reply_to_email": "string",
  • "customer_success_team_email": "string",
  • "l1_support_email": "string",
  • "webhook_error_email": "string",
  • "aml_compliance_email": "string",
  • "dispute_email": "string",
  • "customer_default_locale": "en-US",
  • "seller_default_locale": "en-US",
  • "project_abbreviation": "SMB",
  • "unipay_customer_network_code": "C1",
  • "unipay_seller_network_code": "T1",
  • "sphere_payer_code": "MSTSSMB",
  • "sphere_processor_code": "MSTSSMB",
  • "version": "string",
  • "financial_partner": {
    },
  • "is_program_fee_service_fee_customer_groups_enabled": true,
  • "program_fee_service_fee_customer_groups": [
    ],
  • "customer_onboarding_groups": [
    ],
  • "seller_agreement": {
    },
  • "remittance_bank_accounts": [
    ],
  • "remittance_addresses": [
    ],
  • "payment_terms": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "onboarding_type": "Default",
  • "onboarding_status": "Created",
  • "client_id": "e1b31b7b-4025-4445-b3d6-251128c7484d",
  • "client_legal_name": "Apruve, Inc.",
  • "name": "Apruve",
  • "product_type": "SMB",
  • "program_type": "Sandbox",
  • "contract_country": "US",
  • "api_version": "v1",
  • "merchant_of_record": "Client",
  • "is_marketplace": true,
  • "is_cashier_model": true,
  • "is_customer_portal_enabled": true,
  • "is_seller_portal_enabled": true,
  • "is_individual_spending_limits_enabled": true,
  • "is_withhold_seller_amount_enabled": true,
  • "is_recourse_enabled": true,
  • "is_purchase_policies_enabled": true,
  • "is_pricing_enabled": true,
  • "pricing_levels": 10,
  • "pricing_default_level": 10,
  • "pricing_groups": [
    ],
  • "is_trade_credit_insurance_enabled": true,
  • "is_trade_credit_insurance_fraud_check_enabled": true,
  • "is_standalone_credit_enabled": true,
  • "is_cobranding_enabled": true,
  • "web_logo_url": "string",
  • "email_logo_url": "string",
  • "client_support_phone": "string",
  • "client_support_email": "string",
  • "dispute_eligibility_days": 1,
  • "dispute_timeout_days": 1,
  • "client_support_url": "string",
  • "customer_countries": "US",
  • "seller_countries": "US",
  • "currencies": "USD",
  • "system_currency": "USD",
  • "client_currency": "USD",
  • "program_currency": "USD",
  • "support_phone": "string",
  • "support_url": "string",
  • "online_payment_url": "string",
  • "customer_portal_subdomain_name": "string",
  • "customer_portal_domain_name": "string",
  • "customer_portal_custom_domain_name": "string",
  • "support_email": "string",
  • "fraud_email": "string",
  • "underwriting_email": "string",
  • "remittance_email": "string",
  • "accounts_receivable_email": "string",
  • "sender_email": "string",
  • "reply_to_email": "string",
  • "customer_success_team_email": "string",
  • "l1_support_email": "string",
  • "webhook_error_email": "string",
  • "aml_compliance_email": "string",
  • "dispute_email": "string",
  • "project_abbreviation": "SMB",
  • "unipay_customer_network_code": "C1",
  • "unipay_seller_network_code": "T1",
  • "sphere_payer_code": "MSTSSMB",
  • "sphere_processor_code": "MSTSSMB",
  • "customer_default_locale": "en-US",
  • "customer_locales": [
    ],
  • "seller_default_locale": "en-US",
  • "seller_locales": [
    ],
  • "version": "string",
  • "financial_partner": {
    },
  • "is_program_fee_service_fee_customer_groups_enabled": true,
  • "program_fee_service_fee_customer_groups": [
    ],
  • "customer_onboarding_groups": [
    ],
  • "remittance_bank_accounts": [
    ],
  • "remittance_addresses": [
    ],
  • "seller_agreement": {
    },
  • "payment_terms": [
    ],
  • "status": "Created",
  • "metadata": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "updated_by": "Lauren Brandon",
  • "activated_at": "2019-08-24T14:15:22Z",
  • "activated_by": "Robert Kentish"
}

Get program draft diff

Get the different of the draft from the origin program record

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
{
  • "client": {
    },
  • "program_from": {
    },
  • "program_to": {
    },
  • "program_diffs": [
    ],
  • "program_general_group_diffs": [
    ],
  • "program_domain_group_diffs": [
    ],
  • "program_integration_group_diffs": [
    ],
  • "program_branding_diffs": [
    ],
  • "program_support_group_diffs": [
    ],
  • "program_feature_group_diffs": [
    ],
  • "program_service_cloud_group_diffs": [
    ],
  • "customer_locales_from": [
    ],
  • "customer_locales_to": [
    ],
  • "seller_locales_from": [
    ],
  • "seller_locales_to": [
    ],
  • "program_country_locale_group_diff_data": {
    },
  • "program_currency_group_diff_data": {
    },
  • "financial_partner_from": {
    },
  • "financial_partner_to": {
    },
  • "financial_partner_diffs": [
    ],
  • "remittance_bank_accounts_from": [
    ],
  • "remittance_bank_accounts_to": [
    ],
  • "remittance_bank_account_diff_data": {
    },
  • "remittance_addresses_from": [
    ],
  • "remittance_addresses_to": [
    ],
  • "remittance_address_diff_data": {
    },
  • "payment_terms_from": [
    ],
  • "payment_terms_to": [
    ],
  • "payment_term_diff_data": {
    },
  • "program_fee_service_fee_customer_groups_from": [
    ],
  • "program_fee_service_fee_customer_groups_to": [
    ],
  • "program_fee_service_fee_customer_group_diff_data": {
    },
  • "customer_onboarding_group_diff_data": {
    },
  • "pricing_groups_from": [
    ],
  • "pricing_groups_to": [
    ],
  • "pricing_group_diff_data": {
    },
  • "seller_agreement_document_from": {
    },
  • "seller_agreement_document_to": {
    },
  • "seller_agreement_document_diffs": [
    ]
}

Submit program draft

Immutable and Additive tags are provided for properties where applicable. Programs with a status of Created are considered not published so do not adhere to tag rules.

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Request Body schema: application/json
version
string

The record version

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "onboarding_type": "Default",
  • "onboarding_status": "Created",
  • "client_id": "e1b31b7b-4025-4445-b3d6-251128c7484d",
  • "client_legal_name": "Apruve, Inc.",
  • "servicecloud_id": "0000WO1Zi",
  • "servicecloud_name": "string",
  • "servicecloud_identifiers": [
    ],
  • "name": "Apruve",
  • "product_type": "SMB",
  • "program_type": "Sandbox",
  • "business_country": "US",
  • "business_operating_countries": "US",
  • "contract_country": "US",
  • "api_version": "v1",
  • "merchant_of_record": "Client",
  • "is_marketplace": true,
  • "is_cashier_model": true,
  • "is_customer_portal_enabled": true,
  • "is_seller_portal_enabled": true,
  • "is_individual_spending_limits_enabled": true,
  • "is_withhold_seller_amount_enabled": true,
  • "is_recourse_enabled": true,
  • "is_purchase_policies_enabled": true,
  • "is_pricing_enabled": true,
  • "pricing_levels": 10,
  • "pricing_default_level": 10,
  • "pricing_groups": [
    ],
  • "is_trade_credit_insurance_enabled": true,
  • "is_trade_credit_insurance_fraud_check_enabled": true,
  • "is_standalone_credit_enabled": true,
  • "is_cobranding_enabled": true,
  • "web_logo_url": "string",
  • "email_logo_url": "string",
  • "client_support_phone": "string",
  • "client_support_email": "string",
  • "dispute_eligibility_days": 1,
  • "dispute_timeout_days": 1,
  • "client_support_url": "string",
  • "customer_countries": "US",
  • "seller_countries": "US",
  • "currencies": "USD",
  • "system_currency": "USD",
  • "client_currency": "USD",
  • "program_currency": "USD",
  • "support_phone": "string",
  • "support_url": "string",
  • "online_payment_url": "string",
  • "customer_portal_subdomain_name": "string",
  • "customer_portal_domain_name": "string",
  • "customer_portal_custom_domain_name": "string",
  • "support_email": "string",
  • "fraud_email": "string",
  • "underwriting_email": "string",
  • "remittance_email": "string",
  • "accounts_receivable_email": "string",
  • "sender_email": "string",
  • "reply_to_email": "string",
  • "customer_success_team_email": "string",
  • "l1_support_email": "string",
  • "webhook_error_email": "string",
  • "aml_compliance_email": "string",
  • "dispute_email": "string",
  • "project_abbreviation": "SMB",
  • "unipay_customer_network_code": "C1",
  • "unipay_seller_network_code": "T1",
  • "sphere_payer_code": "MSTSSMB",
  • "sphere_processor_code": "MSTSSMB",
  • "customer_default_locale": "en-US",
  • "customer_locales": [
    ],
  • "seller_default_locale": "en-US",
  • "seller_locales": [
    ],
  • "financial_partner": {
    },
  • "remittance_bank_accounts": [
    ],
  • "remittance_addresses": [
    ],
  • "payment_terms": [
    ],
  • "status": "Created",
  • "version": "string",
  • "metadata": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "updated_by": "Lauren Brandon",
  • "activated_at": "2019-08-24T14:15:22Z",
  • "activated_by": "Robert Kentish",
  • "is_program_fee_service_fee_customer_groups_enabled": true,
  • "program_fee_service_fee_customer_groups": [
    ],
  • "customer_onboarding_groups": [
    ],
  • "seller_agreement": {
    }
}

Validate program draft

Validates the existing program draft configuration. When invalid will return errors.

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Search program drafts

Immutable and Additive tags are provided for properties where applicable. Programs with an onboarding_status of Created are considered not published so do not adhere to tag rules.

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Program Draft Review

Get program draft review collection

Immutable and Additive tags are provided for properties where applicable.

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create program draft review

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Request Body schema: application/json
comment
required
string

The body of the comment.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "program_id": "e1b31b7b-4025-4445-b3d6-251128c7484d",
  • "draft_program_id": "e1b31b7b-4025-4445-b3d6-251128c7484d",
  • "history_program_id": "e1b31b7b-4025-4445-b3d6-251128c7484d",
  • "status": "Requested",
  • "comments": [
    ],
  • "requested_at": "2019-08-24T14:15:22Z",
  • "requested_by": "Robert Kentish",
  • "requested_by_email": "user@trevipay.com",
  • "cancelled_at": "2019-08-24T14:15:22Z",
  • "cancelled_by": "Robert Kentish",
  • "cancelled_by_email": "user@trevipay.com",
  • "accepted_at": "2019-08-24T14:15:22Z",
  • "accepted_by": "Robert Kentish",
  • "accepted_by_email": "user@trevipay.com",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get program draft review

Immutable and Additive tags are provided for properties where applicable.

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "program_id": "e1b31b7b-4025-4445-b3d6-251128c7484d",
  • "draft_program_id": "e1b31b7b-4025-4445-b3d6-251128c7484d",
  • "history_program_id": "e1b31b7b-4025-4445-b3d6-251128c7484d",
  • "status": "Requested",
  • "comments": [
    ],
  • "requested_at": "2019-08-24T14:15:22Z",
  • "requested_by": "Robert Kentish",
  • "requested_by_email": "user@trevipay.com",
  • "cancelled_at": "2019-08-24T14:15:22Z",
  • "cancelled_by": "Robert Kentish",
  • "cancelled_by_email": "user@trevipay.com",
  • "accepted_at": "2019-08-24T14:15:22Z",
  • "accepted_by": "Robert Kentish",
  • "accepted_by_email": "user@trevipay.com",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Accept program draft review

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Request Body schema: application/json
comment
string

The body of the comment.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "program_id": "e1b31b7b-4025-4445-b3d6-251128c7484d",
  • "draft_program_id": "e1b31b7b-4025-4445-b3d6-251128c7484d",
  • "history_program_id": "e1b31b7b-4025-4445-b3d6-251128c7484d",
  • "status": "Requested",
  • "comments": [
    ],
  • "requested_at": "2019-08-24T14:15:22Z",
  • "requested_by": "Robert Kentish",
  • "requested_by_email": "user@trevipay.com",
  • "cancelled_at": "2019-08-24T14:15:22Z",
  • "cancelled_by": "Robert Kentish",
  • "cancelled_by_email": "user@trevipay.com",
  • "accepted_at": "2019-08-24T14:15:22Z",
  • "accepted_by": "Robert Kentish",
  • "accepted_by_email": "user@trevipay.com",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Cancel program draft review

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Request Body schema: application/json
comment
required
string

The body of the comment.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "program_id": "e1b31b7b-4025-4445-b3d6-251128c7484d",
  • "draft_program_id": "e1b31b7b-4025-4445-b3d6-251128c7484d",
  • "history_program_id": "e1b31b7b-4025-4445-b3d6-251128c7484d",
  • "status": "Requested",
  • "comments": [
    ],
  • "requested_at": "2019-08-24T14:15:22Z",
  • "requested_by": "Robert Kentish",
  • "requested_by_email": "user@trevipay.com",
  • "cancelled_at": "2019-08-24T14:15:22Z",
  • "cancelled_by": "Robert Kentish",
  • "cancelled_by_email": "user@trevipay.com",
  • "accepted_at": "2019-08-24T14:15:22Z",
  • "accepted_by": "Robert Kentish",
  • "accepted_by_email": "user@trevipay.com",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Program History

Get program history collection

Immutable and Additive tags are provided for properties where applicable. Programs with a status of Created are considered not published so do not adhere to tag rules.

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get program history

Immutable and Additive tags are provided for properties where applicable. Programs with a status of Created are considered not published so do not adhere to tag rules.

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "onboarding_type": "Default",
  • "onboarding_status": "Created",
  • "client_id": "e1b31b7b-4025-4445-b3d6-251128c7484d",
  • "client_legal_name": "Apruve, Inc.",
  • "servicecloud_id": "0000WO1Zi",
  • "servicecloud_name": "string",
  • "servicecloud_identifiers": [
    ],
  • "name": "Apruve",
  • "product_type": "SMB",
  • "program_type": "Sandbox",
  • "business_country": "US",
  • "business_operating_countries": "US",
  • "contract_country": "US",
  • "api_version": "v1",
  • "merchant_of_record": "Client",
  • "is_marketplace": true,
  • "is_cashier_model": true,
  • "is_customer_portal_enabled": true,
  • "is_seller_portal_enabled": true,
  • "is_individual_spending_limits_enabled": true,
  • "is_withhold_seller_amount_enabled": true,
  • "is_recourse_enabled": true,
  • "is_purchase_policies_enabled": true,
  • "is_pricing_enabled": true,
  • "pricing_levels": 10,
  • "pricing_default_level": 10,
  • "pricing_groups": [
    ],
  • "is_trade_credit_insurance_enabled": true,
  • "is_trade_credit_insurance_fraud_check_enabled": true,
  • "is_standalone_credit_enabled": true,
  • "is_cobranding_enabled": true,
  • "web_logo_url": "string",
  • "email_logo_url": "string",
  • "client_support_phone": "string",
  • "client_support_email": "string",
  • "dispute_eligibility_days": 1,
  • "dispute_timeout_days": 1,
  • "client_support_url": "string",
  • "customer_countries": "US",
  • "seller_countries": "US",
  • "currencies": "USD",
  • "system_currency": "USD",
  • "client_currency": "USD",
  • "program_currency": "USD",
  • "support_phone": "string",
  • "support_url": "string",
  • "online_payment_url": "string",
  • "customer_portal_subdomain_name": "string",
  • "customer_portal_domain_name": "string",
  • "customer_portal_custom_domain_name": "string",
  • "sender_email": "string",
  • "reply_to_email": "string",
  • "dispute_email": "string",
  • "accounts_receivable_email": "string",
  • "customer_success_team_email": "string",
  • "l1_support_email": "string",
  • "webhook_error_email": "string",
  • "aml_compliance_email": "string",
  • "support_email": "string",
  • "underwriting_email": "string",
  • "remittance_email": "string",
  • "fraud_email": "string",
  • "project_abbreviation": "SMB",
  • "unipay_customer_network_code": "C1",
  • "unipay_seller_network_code": "T1",
  • "sphere_payer_code": "MSTSSMB",
  • "sphere_processor_code": "MSTSSMB",
  • "customer_default_locale": "en-US",
  • "customer_locales": [
    ],
  • "seller_default_locale": "en-US",
  • "seller_locales": [
    ],
  • "financial_partner": {
    },
  • "remittance_bank_accounts": [
    ],
  • "remittance_addresses": [
    ],
  • "payment_terms": [
    ],
  • "status": "Created",
  • "version": "string",
  • "metadata": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "updated_by": "Lauren Brandon",
  • "activated_at": "2019-08-24T14:15:22Z",
  • "activated_by": "Robert Kentish",
  • "has_draft": true,
  • "is_program_fee_service_fee_customer_groups_enabled": true,
  • "program_fee_service_fee_customer_groups": [
    ],
  • "customer_onboarding_groups": [
    ],
  • "seller_agreement": {
    }
}

UI

Get platform UI collection

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create platform UI

All platform UI's also require UI phrases with keys title and description to be functional.

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Request Body schema: application/json
platform_team_id
required
string <uuid>

The ID of the team responsible for the UI component.

name
required
string <= 100 characters ^[a-zA-Z0-9\-_]+$

The name of the UI component. Must be unique.

source_url
required
string <= 2000 characters ^(https|http)://|^/

The URL where the UI component is hosted.

help_url
string <= 2000 characters ^(https|http)://|^/|^$

Support URL is used to display a link to online help regarding this configuration section.

display_order
required
integer

UI components will be displayed in ascending order.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "platform_team_id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "name": "string",
  • "source_url": "string",
  • "help_url": "string",
  • "display_order": 0
}

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "platform_team_id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "support_email": "user@example.com",
  • "name": "string",
  • "source_url": "string",
  • "help_url": "string",
  • "display_order": 0,
  • "platform_ui_phrases": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete platform UI

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get platform UI

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "platform_team_id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "support_email": "user@example.com",
  • "name": "string",
  • "source_url": "string",
  • "help_url": "string",
  • "display_order": 0,
  • "platform_ui_phrases": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update platform UI

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Request Body schema: application/json
platform_team_id
required
string <uuid>

The ID of the team responsible for the UI component.

name
required
string <= 100 characters ^[a-zA-Z0-9\-_]+$

The name of the UI component. Must be unique.

source_url
required
string <= 2000 characters ^(https|http)://|^/

The URL where the UI component is hosted.

help_url
string <= 2000 characters ^(https|http)://|^/|^$

Support URL is used to display a link to online help regarding this configuration section.

display_order
required
integer

UI components will be displayed in ascending order.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "platform_team_id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "name": "string",
  • "source_url": "string",
  • "help_url": "string",
  • "display_order": 0
}

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "platform_team_id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "support_email": "user@example.com",
  • "name": "string",
  • "source_url": "string",
  • "help_url": "string",
  • "display_order": 0,
  • "platform_ui_phrases": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

UI Phrase

Get platform UI phrase collection

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create platform UI phrase

All platform UI's also require UI phrases with keys title and description to be functional.

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Request Body schema: application/json
locale
required
string <IETF BCP 47> [ 2 .. 10 ] characters ^[a-z]{2,3}(-[A-Z][a-z]{4})?(-[A-Z]{2})?$

IETF BCP 47: <ISO 639-1 | ISO 639-2>[-<ISO 15924>][-<ISO 3166-2>]

key
required
string <= 100 characters ^[a-zA-Z0-9\-_]+$

The key of the i18n phrase.

text
required
string [ 1 .. 1000 ] characters

The text of the i18n phrase.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "locale": "en-US",
  • "key": "string",
  • "text": "string"
}

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "platform_ui_id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "locale": "en-US",
  • "key": "string",
  • "text": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete platform UI phrase

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get platform UI phrase

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "platform_ui_id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "locale": "en-US",
  • "key": "string",
  • "text": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update platform UI phrase

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Request Body schema: application/json
locale
required
string <IETF BCP 47> [ 2 .. 10 ] characters ^[a-z]{2,3}(-[A-Z][a-z]{4})?(-[A-Z]{2})?$

IETF BCP 47: <ISO 639-1 | ISO 639-2>[-<ISO 15924>][-<ISO 3166-2>]

key
required
string <= 100 characters ^[a-zA-Z0-9\-_]+$

The key of the i18n phrase.

text
required
string [ 1 .. 1000 ] characters

The text of the i18n phrase.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "locale": "en-US",
  • "key": "string",
  • "text": "string"
}

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "platform_ui_id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "locale": "en-US",
  • "key": "string",
  • "text": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

UI Program

Get platform UI program

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "platform_ui_id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "configuration_status": "Incomplete",
  • "platform_team_id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "support_email": "user@example.com",
  • "name": "string",
  • "source_url": "string",
  • "help_url": "string",
  • "display_order": 0,
  • "platform_ui_phrases": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update platform UI program

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Request Body schema: application/json
configuration_status
required
any
Enum: "Incomplete" "Complete"

The configuration status for a program and a specific platform ui

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "configuration_status": "Incomplete"
}

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "platform_ui_id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "configuration_status": "Incomplete",
  • "platform_team_id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "support_email": "user@example.com",
  • "name": "string",
  • "source_url": "string",
  • "help_url": "string",
  • "display_order": 0,
  • "platform_ui_phrases": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get platform UI program collection

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Message

Get message collection

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get message

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "onboarding_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "client_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "status": "Published",
  • "correlation_id": "string",
  • "message_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "message_topic_arn": "string",
  • "message_group_id": "string",
  • "message_subject": "string",
  • "message": "string",
  • "message_attributes": "string",
  • "metadata": [
    ],
  • "failure_count": 0,
  • "failed_at": "2019-08-24T14:15:22Z",
  • "published_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Onboarding

Get onboarding collection

Immutable and Additive tags are provided for properties where applicable. Programs with a status of Created are considered not published so do not adhere to tag rules.

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete onboarding

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get onboarding

Immutable and Additive tags are provided for properties where applicable. Programs with a status of Created are considered not published so do not adhere to tag rules.

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "onboarding_type": "Default",
  • "client_id": "e1b31b7b-4025-4445-b3d6-251128c7484d",
  • "client": {
    },
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program": {
    },
  • "status": "Created",
  • "metadata": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Submit onboarding

Immutable and Additive tags are provided for properties where applicable. Programs with a status of Created are considered not published so do not adhere to tag rules.

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "onboarding_type": "Default",
  • "client_id": "e1b31b7b-4025-4445-b3d6-251128c7484d",
  • "client": {
    },
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "program": {
    },
  • "status": "Submitted",
  • "metadata": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Batch

Get processing batch collection

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get processing batch

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "status": "Unprocessed",
  • "error_log": "string",
  • "failure_count": 0,
  • "failed_at": "2019-08-24T14:15:22Z",
  • "processed_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Job

Get processing job collection

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get processing job

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "batch_id": "12b28244-a9c8-4590-8e38-596867d6a60a",
  • "status": "Unprocessed",
  • "type": "process_submitted_onboarding",
  • "stage": -1,
  • "onboarding_id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "program_id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "client_id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "message_id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "correlation_id": "string",
  • "error_log": "string",
  • "failure_count": 0,
  • "failed_at": "2019-08-24T14:15:22Z",
  • "processed_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Auth

Get auth role collection

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get auth role

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "name": "Admin",
  • "permissions": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get auth service cloud profile collection

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get auth service cloud profile

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "name": "MSTS CaaS Account Manager",
  • "permissions": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Auth Service Cloud Permission

Get auth service cloud permission collection

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create auth service cloud permission

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Request Body schema: application/json
name
required
string [ 1 .. 256 ] characters

The name of this service cloud permission.

required
Array of objects non-empty

Permissions assigned to this service cloud permission

Responses

Request samples

Content type
application/json
{
  • "name": "3RConfigurationProgramWrite",
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "name": "3RConfigurationProgramWrite",
  • "permissions": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete auth service cloud permission

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get auth service cloud permission

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "name": "3RConfigurationProgramWrite",
  • "permissions": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update auth service cloud permission

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Request Body schema: application/json
name
required
string [ 1 .. 256 ] characters

The name of this service cloud permission.

required
Array of objects non-empty

Permissions assigned to this service cloud permission

Responses

Request samples

Content type
application/json
{
  • "name": "3RConfigurationProgramWrite",
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "name": "3RConfigurationProgramWrite",
  • "permissions": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Country

Get country collection

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create country

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Request Body schema: application/json
id
string <iso-3166-2> = 2 characters ^[A-Z]{2}$

ISO 3166-2 country

name
required
string

The name for this country.

default_currency
string <iso-4217> = 3 characters ^[A-Z]{3}$

The default currency used by this country.

is_supported_country
required
boolean

Is this country supported on the platform.

is_supported_contract_country
required
boolean

Is this country supported as a contract country on the platform.

supported_locales
Array of strings <IETF BCP 47> >= 0 items [ items <IETF BCP 47 > [ 2 .. 10 ] characters ^[a-z]{2,3}(-[A-Z][a-z]{4})?(-[A-Z]{2})?$ ]

List of IETF BCP 47 locale codes supported by this country.

supported_currencies
Array of strings <iso-4217> >= 0 items [ items <iso-4217 > = 3 characters ^[A-Z]{3}$ ]

List of ISO 4217 currency codes supported by this country.

system_currency
string <iso-4217> = 3 characters ^[A-Z]{3}$

ISO 4217 currency code

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "id": "US",
  • "name": "United States",
  • "default_currency": "USD",
  • "is_supported_country": true,
  • "is_supported_contract_country": true,
  • "supported_locales": [
    ],
  • "supported_currencies": [
    ],
  • "system_currency": "USD"
}

Response samples

Content type
application/json
{
  • "id": "US",
  • "name": "United States",
  • "default_currency": "USD",
  • "is_supported_country": true,
  • "is_supported_contract_country": true,
  • "supported_locales": [
    ],
  • "supported_currencies": [
    ],
  • "system_currency": "USD",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete country

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get country

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
{
  • "id": "US",
  • "name": "United States",
  • "default_currency": "USD",
  • "is_supported_country": true,
  • "is_supported_contract_country": true,
  • "supported_locales": [
    ],
  • "supported_currencies": [
    ],
  • "system_currency": "USD",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update country

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Request Body schema: application/json
name
required
string

The name for this country.

default_currency
string <iso-4217> = 3 characters ^[A-Z]{3}$

The default currency used by this country.

is_supported_country
required
boolean

Is this country supported on the platform.

is_supported_contract_country
required
boolean

Is this country supported as a contract country on the platform.

supported_locales
Array of strings <IETF BCP 47> >= 0 items [ items <IETF BCP 47 > [ 2 .. 10 ] characters ^[a-z]{2,3}(-[A-Z][a-z]{4})?(-[A-Z]{2})?$ ]

List of IETF BCP 47 locale codes supported by this country.

supported_currencies
Array of strings <iso-4217> >= 0 items [ items <iso-4217 > = 3 characters ^[A-Z]{3}$ ]

List of ISO 4217 currency codes supported by this country.

system_currency
string <iso-4217> = 3 characters ^[A-Z]{3}$

ISO 4217 currency code

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "name": "United States",
  • "default_currency": "USD",
  • "is_supported_country": true,
  • "is_supported_contract_country": true,
  • "supported_locales": [
    ],
  • "supported_currencies": [
    ],
  • "system_currency": "USD"
}

Response samples

Content type
application/json
{
  • "id": "US",
  • "name": "United States",
  • "default_currency": "USD",
  • "is_supported_country": true,
  • "is_supported_contract_country": true,
  • "supported_locales": [
    ],
  • "supported_currencies": [
    ],
  • "system_currency": "USD",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Currency

Get currency collection

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create currency

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Request Body schema: application/json
id
required
string <iso-4217> = 3 characters ^[A-Z]{3}$

ISO 4217 currency code

symbol
string [ 1 .. 5 ] characters

The symbol for this currency.

is_supported
required
boolean

Is this supported on the platform.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "id": "USD",
  • "symbol": "$",
  • "is_supported": true
}

Response samples

Content type
application/json
{
  • "id": "USD",
  • "symbol": "$",
  • "is_supported": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete currency

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get currency

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
{
  • "id": "USD",
  • "symbol": "$",
  • "is_supported": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update currency

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Request Body schema: application/json
symbol
string [ 1 .. 5 ] characters

The symbol for this currency.

is_supported
required
boolean

Is this supported on the platform.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "symbol": "$",
  • "is_supported": true
}

Response samples

Content type
application/json
{
  • "id": "USD",
  • "symbol": "$",
  • "is_supported": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Financial Partner

Get financial partner collection

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create financial partner

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Request Body schema: application/json
name
required
string non-empty

The name of the financial partner.

lender_type
required
string
Enum: "Lender" "Self-Financed"

The financial partner lender type.

honors_auths_for_suspended_customers
required
boolean

Will the financial partner honor authorizations for suspended customers.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "name": "HSBC",
  • "lender_type": "Lender",
  • "honors_auths_for_suspended_customers": true
}

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "name": "HSBC",
  • "lender_type": "Lender",
  • "honors_auths_for_suspended_customers": true,
  • "processed_message_ts": "2019-01-01T23:59:59.999Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete financial partner

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get financial partner

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "name": "HSBC",
  • "lender_type": "Lender",
  • "honors_auths_for_suspended_customers": true,
  • "processed_message_ts": "2019-01-01T23:59:59.999Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update financial partner

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Request Body schema: application/json
name
required
string non-empty

The name of the financial partner.

lender_type
required
string
Enum: "Lender" "Self-Financed"

The financial partner lender type.

honors_auths_for_suspended_customers
required
boolean

Will the financial partner honor authorizations for suspended customers.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "name": "HSBC",
  • "lender_type": "Lender",
  • "honors_auths_for_suspended_customers": true
}

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "name": "HSBC",
  • "lender_type": "Lender",
  • "honors_auths_for_suspended_customers": true,
  • "processed_message_ts": "2019-01-01T23:59:59.999Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Locale

Get locale collection

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create locale

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Request Body schema: application/json
id
required
string <IETF BCP 47> [ 2 .. 10 ] characters ^[a-z]{2,3}(-[A-Z][a-z]{4})?(-[A-Z]{2})?$

IETF BCP 47: <ISO 639-1 | ISO 639-2>[-<ISO 15924>][-<ISO 3166-2>]

is_supported
required
boolean

Is this supported on the platform.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "id": "en-US",
  • "is_supported": true
}

Response samples

Content type
application/json
{
  • "id": "en-US",
  • "is_supported": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete locale

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get locale

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
{
  • "id": "en-US",
  • "is_supported": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update locale

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Request Body schema: application/json
is_supported
required
boolean

Is this supported on the platform.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "is_supported": true
}

Response samples

Content type
application/json
{
  • "id": "en-US",
  • "is_supported": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Payment Term

Get payment term collection

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create payment term

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Request Body schema: application/json
id
required
string

Payment term ID

is_supported
required
boolean

Is this payment term supported on the platform.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "is_supported": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "is_supported": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete payment term

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get payment term

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "is_supported": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update payment term

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Request Body schema: application/json
is_supported
required
boolean

Is this payment term supported on the platform.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "is_supported": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "is_supported": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Reference Data Validation

Reference Data Validation

Validates the reference data configuration. When invalid will return errors.

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Remittance Address

Get remittance address collection

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get remittance address

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "record_type": "Default",
  • "currency": "USD",
  • "country": "US",
  • "name": "string",
  • "address_line_1": "string",
  • "address_line_2": "string",
  • "address_line_3": "string",
  • "admin_area_4": "string",
  • "admin_area_3": "string",
  • "admin_area_2": "string",
  • "admin_area_1": "string",
  • "postal_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update remittance address

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Request Body schema: application/json
name
required
string <= 100 characters

Recipient or business name

address_line_1
required
string <= 100 characters

Line 1 of the Address (eg. number, street, etc).

address_line_2
string <= 100 characters

Optional line 2 of the Address (eg. suite, apt #, etc.)

address_line_3
string <= 100 characters

Optional Line 3 of the Address if needed.

admin_area_4
string <= 100 characters

May be neighborhood, ward or district.

admin_area_3
string <= 100 characters

Usually sub-locality, suburb, neighborhood, or district.

admin_area_2
string <= 100 characters

Usually city, town or village.

admin_area_1
string <= 100 characters

Usually corresponds to Province, State, or ISO-3166-2 subdivision.

postal_code
required
string <= 100 characters

Postal code, ZIP code, CEP, etc.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "address_line_1": "string",
  • "address_line_2": "string",
  • "address_line_3": "string",
  • "admin_area_4": "string",
  • "admin_area_3": "string",
  • "admin_area_2": "string",
  • "admin_area_1": "string",
  • "postal_code": "string"
}

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "record_type": "Default",
  • "currency": "USD",
  • "country": "US",
  • "name": "string",
  • "address_line_1": "string",
  • "address_line_2": "string",
  • "address_line_3": "string",
  • "admin_area_4": "string",
  • "admin_area_3": "string",
  • "admin_area_2": "string",
  • "admin_area_1": "string",
  • "postal_code": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Remittance Bank Account

Get remittance bank account collection

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create remittance bank account

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Request Body schema: application/json
currency
required
string <iso-4217> = 3 characters ^[A-Z]{3}$

ISO 4217 currency code

country
required
string <iso-3166-2> = 2 characters ^[A-Z]{2}$

ISO 3166-2 country

aba
string^\d{9}$

A Fedwire (or ABA) code is a bank code used in the United States, which identifies financial institutions.

bic
string <= 100 characters

A BIC (Bank Identifier Code) is the SWIFT Address assigned to a bank in order to send automated payments quickly and accurately to the banks concerned.

bsb
string^\d{6}$

A Bank State Branch number, or BSB number, is a 6-digit code that represents your bank, state, and branch location.

iban
string <= 100 characters

An IBAN, or international bank account number, is a standard international numbering system developed to identify an overseas bank account.

sort_code
string^\d{6}$

A sort code is a bank identifier that makes it possible for U.K. bank accounts to do domestic transfers. It identifies both the bank (first 2 digits) and the branch (last 4 digits)

swift_code
string <= 100 characters

The SWIFT code is usually required when you conduct an international money transfer and is used to identify a specific bank account in the process of verifying international transactions. It can be found as a set of 8 or 11 digits on your bank account statements.

bacs_code
string <= 100 characters

A Bacs service enabling Direct Debit Instructions (DDI) to be electronically onboarding or cancelled at paying PSP's by service users.

chaps_code
string <= 100 characters

CHAPS stands for Clearing House Automated Payment System. CHAPS is the bank-to-bank transfer system that runs through the SWIFT network.

bank_name
string <= 100 characters

Bank name

bank_number
string <= 100 characters

Secondary unique code assigned to this bank account by the bank. Requiredness depends on banking country.

bank_address_line_1
string <= 100 characters

Bank address line 1

bank_address_line_2
string <= 100 characters

Bank address line 2

routing_number
string <= 100 characters

Your routing number is a 9-digit code that will be used to identify where your bank account was opened. It may also be known as an RTN, an ABA routing number, or a routing transit number.

clabe
string^\d{18}$

CLABE stands for Clave Bancaria Estandarizada - Mexico's standardized banking code. A CLABE number is an 18 digit unique identifier which contains details of the bank brand and location, as well as the individual account number.

account_number
string <= 100 characters

Bank account number

account_name
string <= 100 characters

Bank account name

beneficiary
string <= 100 characters

Beneficiary

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "currency": "USD",
  • "country": "US",
  • "aba": "string",
  • "bic": "string",
  • "bsb": "string",
  • "iban": "string",
  • "sort_code": "string",
  • "swift_code": "string",
  • "bacs_code": "string",
  • "chaps_code": "string",
  • "bank_name": "string",
  • "bank_number": "string",
  • "bank_address_line_1": "string",
  • "bank_address_line_2": "string",
  • "routing_number": "string",
  • "clabe": "string",
  • "account_number": "string",
  • "account_name": "string",
  • "beneficiary": "string"
}

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "customer_onboarding_group_id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "record_type": "Default",
  • "currency": "USD",
  • "country": "US",
  • "aba": "string",
  • "bic": "string",
  • "bsb": "string",
  • "iban": "string",
  • "sort_code": "string",
  • "swift_code": "string",
  • "bacs_code": "string",
  • "chaps_code": "string",
  • "bank_name": "string",
  • "bank_number": "string",
  • "bank_address_line_1": "string",
  • "bank_address_line_2": "string",
  • "routing_number": "string",
  • "account_number": "string",
  • "account_name": "string",
  • "beneficiary": "string",
  • "clabe": "string",
  • "fields": "aba",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete remittance bank account

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "customer_onboarding_group_id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "record_type": "Default",
  • "currency": "USD",
  • "country": "US",
  • "aba": "string",
  • "bic": "string",
  • "bsb": "string",
  • "iban": "string",
  • "sort_code": "string",
  • "swift_code": "string",
  • "bacs_code": "string",
  • "chaps_code": "string",
  • "bank_name": "string",
  • "bank_number": "string",
  • "bank_address_line_1": "string",
  • "bank_address_line_2": "string",
  • "routing_number": "string",
  • "account_number": "string",
  • "account_name": "string",
  • "beneficiary": "string",
  • "clabe": "string",
  • "fields": "aba",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get remittance bank account

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "customer_onboarding_group_id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "record_type": "Default",
  • "currency": "USD",
  • "country": "US",
  • "aba": "string",
  • "bic": "string",
  • "bsb": "string",
  • "iban": "string",
  • "sort_code": "string",
  • "swift_code": "string",
  • "bacs_code": "string",
  • "chaps_code": "string",
  • "bank_name": "string",
  • "bank_number": "string",
  • "bank_address_line_1": "string",
  • "bank_address_line_2": "string",
  • "routing_number": "string",
  • "account_number": "string",
  • "account_name": "string",
  • "beneficiary": "string",
  • "clabe": "string",
  • "fields": "aba",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update remittance bank account

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Request Body schema: application/json
aba
string^\d{9}$

A Fedwire (or ABA) code is a bank code used in the United States, which identifies financial institutions.

bic
string <= 100 characters

A BIC (Bank Identifier Code) is the SWIFT Address assigned to a bank in order to send automated payments quickly and accurately to the banks concerned.

bsb
string^\d{6}$

A Bank State Branch number, or BSB number, is a 6-digit code that represents your bank, state, and branch location.

iban
string <= 100 characters

An IBAN, or international bank account number, is a standard international numbering system developed to identify an overseas bank account.

sort_code
string^\d{6}$

A sort code is a bank identifier that makes it possible for U.K. bank accounts to do domestic transfers. It identifies both the bank (first 2 digits) and the branch (last 4 digits)

swift_code
string <= 100 characters

The SWIFT code is usually required when you conduct an international money transfer and is used to identify a specific bank account in the process of verifying international transactions. It can be found as a set of 8 or 11 digits on your bank account statements.

bacs_code
string <= 100 characters

A Bacs service enabling Direct Debit Instructions (DDI) to be electronically onboarding or cancelled at paying PSP's by service users.

chaps_code
string <= 100 characters

CHAPS stands for Clearing House Automated Payment System. CHAPS is the bank-to-bank transfer system that runs through the SWIFT network.

bank_name
string <= 100 characters

Bank name

bank_number
string <= 100 characters

Secondary unique code assigned to this bank account by the bank. Requiredness depends on banking country.

bank_address_line_1
string <= 100 characters

Bank address line 1

bank_address_line_2
string <= 100 characters

Bank address line 2

routing_number
string <= 100 characters

Your routing number is a 9-digit code that will be used to identify where your bank account was opened. It may also be known as an RTN, an ABA routing number, or a routing transit number.

clabe
string^\d{18}$

CLABE stands for Clave Bancaria Estandarizada - Mexico's standardized banking code. A CLABE number is an 18 digit unique identifier which contains details of the bank brand and location, as well as the individual account number.

account_number
string <= 100 characters

Bank account number

account_name
string <= 100 characters

Bank account name

beneficiary
string <= 100 characters

Beneficiary

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "aba": "string",
  • "bic": "string",
  • "bsb": "string",
  • "iban": "string",
  • "sort_code": "string",
  • "swift_code": "string",
  • "bacs_code": "string",
  • "chaps_code": "string",
  • "bank_name": "string",
  • "bank_number": "string",
  • "bank_address_line_1": "string",
  • "bank_address_line_2": "string",
  • "routing_number": "string",
  • "clabe": "string",
  • "account_number": "string",
  • "account_name": "string",
  • "beneficiary": "string"
}

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "program_id": "3c87bd2b-df9a-413b-94ab-0238dcacaf68",
  • "customer_onboarding_group_id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "record_type": "Default",
  • "currency": "USD",
  • "country": "US",
  • "aba": "string",
  • "bic": "string",
  • "bsb": "string",
  • "iban": "string",
  • "sort_code": "string",
  • "swift_code": "string",
  • "bacs_code": "string",
  • "chaps_code": "string",
  • "bank_name": "string",
  • "bank_number": "string",
  • "bank_address_line_1": "string",
  • "bank_address_line_2": "string",
  • "routing_number": "string",
  • "account_number": "string",
  • "account_name": "string",
  • "beneficiary": "string",
  • "clabe": "string",
  • "fields": "aba",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Remittance Bank Account Fields

Get remittance bank account fields collection

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Remittance Bank Account Fields

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Request Body schema: application/json
currency
required
string <iso-4217> = 3 characters ^[A-Z]{3}$

ISO 4217 currency code

country
required
string <iso-3166-2> = 2 characters ^[A-Z]{2}$

ISO 3166-2 country

required
Array of objects
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "currency": "USD",
  • "country": "US",
  • "fields": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "currency": "USD",
  • "country": "US",
  • "fields": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete Remittance Bank Account Fields

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Remittance Bank Account Fields

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "currency": "USD",
  • "country": "US",
  • "fields": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update Remittance Bank Account Fields

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Request Body schema: application/json
currency
required
string <iso-4217> = 3 characters ^[A-Z]{3}$

ISO 4217 currency code

country
required
string <iso-3166-2> = 2 characters ^[A-Z]{2}$

ISO 3166-2 country

required
Array of objects
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "currency": "USD",
  • "country": "US",
  • "fields": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "currency": "USD",
  • "country": "US",
  • "fields": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Service Cloud Message

Get Service Cloud message collection

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Service Cloud message

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Authorization
required
string (Authorization Header) ^Bearer [a-zA-Z0-9-_]+\.[a-zA-Z0-9-_]+\.[a-zA...
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJJc1ZhbGlkIjp0cnVlLCJzZXJ2aWNlX2Nsb3VkX3VzZXJfaWQiOiIxMTExQTIyMTIzMUFCQ0QiLCJzZXJ2aWNlX2Nsb3VkX3Byb2ZpbGUiOiJTeXN0ZW0gQWRtaW5pc3RyYXRvciIsImlzcyI6Imh0dHBzOi8vNDI0MC0yMDItMTQ0LTE3My0yMjAubmdyb2suaW8iLCJhdWQiOlsiaHR0cHM6Ly80MjQwLTIwMi0xNDQtMTczLTIyMC5uZ3Jvay5pbyJdLCJleHAiOjQ4MDY1Njc1MDQuOTk5OTk5LCJuYmYiOjE2NTI5Njc1MDUsImlhdCI6MTY1Mjk2NzUwNSwianRpIjoiNTM1OTI0NDM3MTE2MTk1MzkzNSJ9.MA9ekkt-ACO4gQQBPqMlgK-Gd2WorLlOVayx50lyoU20JQfZu4Wg14Qz-UYG1zdBNMtFBCzi9jDKXoIhl_KTyVmJFLmE-d5rWDYYhsiGQRlpLHHJW9rk3MDu2cvoOZ3Bj5_AxbxZncJT_3aiCAefMGv_ewyR-5OP9xpLkDC4fg-PAz8EqZgt5dty70BYoqMJyHbwhFLpoKHfANqVoeK3pghYQoOPR82krw_ePQ7FAlereBA_jaB375VOHzJPr7FkxX2VkXI69OsctFsaENz-DnhTrhD9pHvEc1V3aTw0jpztOGgPx8dFKEOSpHCPGFTdedoCqrZUjCwjbwPKsl0WUA

Authenticate by JWT Bearer token.

Responses

Response samples

Content type
application/json
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "message": "string",
  • "message_type": "Create Client Program",
  • "status": "Unprocessed",
  • "correlation_id": "string",
  • "failure_count": 0,
  • "failed_at": "2019-08-24T14:15:22Z",
  • "error_log": "string",
  • "processed_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

SQS Message

Get SQS Message collection

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get SQS Message

View inlined schemas:

header Parameters
Authorization
required
string <uuid> (Authorization Header)
Example: fc401b74-590e-4996-9308-38017f25425f

Authenticate by API key.

Responses

Response samples

Content type
application/json
{
  • "id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
  • "correlation_id": "e86f4f0d-329d-42a7-be3e-f13ef305d111",
  • "queue_url": "string",
  • "group_id": "string",
  • "subject": "string",
  • "body": "string",
  • "attributes": "string",
  • "status": "Unprocessed",
  • "error_log": "string",
  • "processed_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Onboarding Created V1

This message is published once only when a new client and program onboarding has been successfully configured and processed.

View inlined schema

Source caasvet
Topic arn:aws:sns:us-east-1:434875166128:caasvet-develop-public-onboarding
Subject onboarding
Event created

Attributes

Name Type Value
event String created
version String v1.13.0
onboarding_type String Custom | Default
product_type String SMB | TreviPay-Branded | Enterprise
program_type String Live | Sandbox
id
required
string <uuid>

Unique ID for this message.

correlation_id
required
string <uuid>

When a message is triggered by a parent message that provides a correlation ID use the parent correlation ID, otherwise generate one.

environment
required
string <= 256 characters

The environment the message was published from.

source
required
any

The system or process the message was published from.

Value: "caasvet"
subject
required
any

The subject of the message.

Value: "onboarding"
event
required
any

The event that occurred to the subject that resulted in this message.

Value: "created"
version
required
string^v1.\d+\.\d+

The full semantic version of this message.

resource_url
string <= 1024 characters

The URL where the resource represented in this message can be found.

schema_url
string <= 1024 characters

The URL where the JSON schema for this message can be found.

entry_ts
required
string

The date and time this message was created.

required
object
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "correlation_id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "environment": "string",
  • "source": "caasvet",
  • "subject": "onboarding",
  • "event": "created",
  • "version": "string",
  • "resource_url": "string",
  • "schema_url": "string",
  • "entry_ts": "string",
  • "data": {
    }
}

Onboarding Created V2

This message is published once only when a new client and program onboarding has been successfully configured and processed.

View inlined schema

Source caasvet
Topic arn:aws:sns:us-east-1:434875166128:caasvet-develop-public-onboarding
Subject onboarding
Event created

Attributes

Name Type Value
event String created
version String v2.16.0
onboarding_type String Custom | Default
product_type String SMB | TreviPay-Branded | Enterprise
program_type String Live | Sandbox
id
required
string <uuid>

Unique ID for this message.

correlation_id
required
string <uuid>

When a message is triggered by a parent message that provides a correlation ID use the parent correlation ID, otherwise generate one.

environment
required
string <= 256 characters

The environment the message was published from.

source
required
any

The system or process the message was published from.

Value: "caasvet"
subject
required
any

The subject of the message.

Value: "onboarding"
event
required
any

The event that occurred to the subject that resulted in this message.

Value: "created"
version
required
string^v2.\d+\.\d+

The full semantic version of this message.

resource_url
string <= 1024 characters

The URL where the resource represented in this message can be found.

schema_url
string <= 1024 characters

The URL where the JSON schema for this message can be found.

entry_ts
required
string

The date and time this message was created.

required
object
{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "correlation_id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "environment": "string",
  • "source": "caasvet",
  • "subject": "onboarding",
  • "event": "created",
  • "version": "string",
  • "resource_url": "string",
  • "schema_url": "string",
  • "entry_ts": "string",
  • "data": {
    }
}

Program Updated V1

This message is published each time a program configuration is updated.

View inlined schema

Source caasvet
Topic arn:aws:sns:us-east-1:434875166128:caasvet-develop-public-program
Subject program
Event updated

Attributes

Name Type Value
event String updated
version String v1.15.0
product_type String SMB | TreviPay-Branded | Enterprise
program_type String Live | Sandbox
id
required
string <uuid>

Unique ID for this message.

correlation_id
required
string <uuid>

When a message is triggered by a parent message that provides a correlation ID use the parent correlation ID, otherwise generate one.

environment
required
string <= 256 characters

The environment the message was published from.

source
required
any

The system or process the message was published from.

Value: "caasvet"
subject
required
any

The subject of the message.

Value: "program"
event
required
any

The event that occurred to the subject that resulted in this message.

Value: "updated"
version
required
string^v1.\d+\.\d+

The full semantic version of this message.

resource_url
string <= 1024 characters

The URL where the resource represented in this message can be found.

schema_url
string <= 1024 characters

The URL where the JSON schema for this message can be found.

entry_ts
required
string

The date and time this message was created.

required
object

The program configuration for this onboarding.

{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "correlation_id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "environment": "string",
  • "source": "caasvet",
  • "subject": "program",
  • "event": "updated",
  • "version": "string",
  • "resource_url": "string",
  • "schema_url": "string",
  • "entry_ts": "string",
  • "data": {
    }
}

Program Updated V2

This message is published each time a program configuration is updated.

View inlined schema

Source caasvet
Topic arn:aws:sns:us-east-1:434875166128:caasvet-develop-public-program
Subject program
Event updated

Attributes

Name Type Value
event String updated
version String v2.16.0
product_type String SMB | TreviPay-Branded | Enterprise
program_type String Live | Sandbox
id
required
string <uuid>

Unique ID for this message.

correlation_id
required
string <uuid>

When a message is triggered by a parent message that provides a correlation ID use the parent correlation ID, otherwise generate one.

environment
required
string <= 256 characters

The environment the message was published from.

source
required
any

The system or process the message was published from.

Value: "caasvet"
subject
required
any

The subject of the message.

Value: "program"
event
required
any

The event that occurred to the subject that resulted in this message.

Value: "updated"
version
required
string^v2.\d+\.\d+

The full semantic version of this message.

resource_url
string <= 1024 characters

The URL where the resource represented in this message can be found.

schema_url
string <= 1024 characters

The URL where the JSON schema for this message can be found.

entry_ts
required
string

The date and time this message was created.

required
object

The program configuration for this onboarding.

{
  • "id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "correlation_id": "a87feca8-d6f0-4794-98c7-037b30219520",
  • "environment": "string",
  • "source": "caasvet",
  • "subject": "program",
  • "event": "updated",
  • "version": "string",
  • "resource_url": "string",
  • "schema_url": "string",
  • "entry_ts": "string",
  • "data": {
    }
}