Skip to main content
API docs by Redocly

octagon (1.0)

Download OpenAPI specification:Download

License: MIT

accounts

Account management endpoints.

get_accounts

Responses

Response samples

Content type
application/json
[
  • {
    }
]

account_me

Responses

Response samples

Content type
application/json
{
  • "brandId": "string",
  • "createdAt": 0,
  • "id": "string",
  • "referrerAccountId": "string",
  • "referrerAffiliateId": "string",
  • "status": "inactive",
  • "tenantId": "string",
  • "type": "personal"
}

get_account_by_id

path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "brandId": "string",
  • "createdAt": 0,
  • "id": "string",
  • "referrerAccountId": "string",
  • "referrerAffiliateId": "string",
  • "status": "inactive",
  • "tenantId": "string",
  • "type": "personal"
}

update_account_status

path Parameters
uuid
required
string
Request Body schema: application/json
required
status
required
string (AccountStatusDto)
Enum: "inactive" "active" "inReview" "awaitingOnboardingApproval"

Responses

Request samples

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

Response samples

Content type
application/json
null

tenants

Tenant management endpoints.

get_tenants

query Parameters
brandId
string or null

Responses

Response samples

Content type
application/json
[
  • {
    }
]

create_tenant

Request Body schema: application/json
required
brandId
required
string
name
required
string
referrerAffiliateId
string or null
status
required
string (TenantStatusDto)
Enum: "inactive" "active"

Responses

Request samples

Content type
application/json
{
  • "brandId": "string",
  • "name": "string",
  • "referrerAffiliateId": "string",
  • "status": "inactive"
}

Response samples

Content type
application/json
{
  • "brandId": "string",
  • "createdAt": 0,
  • "id": "string",
  • "name": "string",
  • "referrerAffiliateId": "string",
  • "status": "inactive"
}

get_tenant_by_id

path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "brandId": "string",
  • "createdAt": 0,
  • "id": "string",
  • "name": "string",
  • "referrerAffiliateId": "string",
  • "status": "inactive"
}

update_tenant

path Parameters
uuid
required
string
Request Body schema: application/json
required
brandId
required
string
name
required
string
referrerAffiliateId
string or null
status
required
string (TenantStatusDto)
Enum: "inactive" "active"

Responses

Request samples

Content type
application/json
{
  • "brandId": "string",
  • "name": "string",
  • "referrerAffiliateId": "string",
  • "status": "inactive"
}

Response samples

Content type
application/json
{
  • "brandId": "string",
  • "createdAt": 0,
  • "id": "string",
  • "name": "string",
  • "referrerAffiliateId": "string",
  • "status": "inactive"
}

delete_tenant_by_id

path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_code": { }
}

brands

Brand management endpoints.

get_brands

Responses

Response samples

Content type
application/json
[
  • {
    }
]

create_brand

Request Body schema: application/json
required
domainName
required
string
logoUrl
required
string
name
required
string
senderEmailAddress
required
string
status
required
string (BrandStatusDto)
Enum: "inactive" "active"
themePrimary
required
string
themeSecondary
string or null
themeTertiary
string or null
twilioSenderNumber
required
string

Responses

Request samples

Content type
application/json
{
  • "domainName": "string",
  • "logoUrl": "string",
  • "name": "string",
  • "senderEmailAddress": "string",
  • "status": "inactive",
  • "themePrimary": "string",
  • "themeSecondary": "string",
  • "themeTertiary": "string",
  • "twilioSenderNumber": "string"
}

Response samples

Content type
application/json
{
  • "createdAt": 0,
  • "domainName": "string",
  • "id": "string",
  • "logoUrl": "string",
  • "name": "string",
  • "senderEmailAddress": "string",
  • "status": "inactive",
  • "themePrimary": "string",
  • "themeSecondary": "string",
  • "themeTertiary": "string",
  • "twilioSenderNumber": "string"
}

get_all_customer_services

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get_customer_service

path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "brandId": "string",
  • "email": "string",
  • "faq": [
    ],
  • "mainQuestion": "string",
  • "phone": "string",
  • "questionText": "string",
  • "suggestion": "string",
  • "topics": [
    ]
}

set_customer_service

path Parameters
uuid
required
string
Request Body schema: application/json
required
email
required
string
required
Array of objects (FaqQuestionDto)
mainQuestion
required
string
phone
required
string
questionText
required
string
suggestion
required
string
topics
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "faq": [
    ],
  • "mainQuestion": "string",
  • "phone": "string",
  • "questionText": "string",
  • "suggestion": "string",
  • "topics": [
    ]
}

Response samples

Content type
application/json
{
  • "email": "string",
  • "faq": [
    ],
  • "mainQuestion": "string",
  • "phone": "string",
  • "questionText": "string",
  • "suggestion": "string",
  • "topics": [
    ]
}

delete_customer_service

path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_code": { }
}

get_brand_by_id

path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "createdAt": 0,
  • "domainName": "string",
  • "id": "string",
  • "logoUrl": "string",
  • "name": "string",
  • "senderEmailAddress": "string",
  • "status": "inactive",
  • "themePrimary": "string",
  • "themeSecondary": "string",
  • "themeTertiary": "string",
  • "twilioSenderNumber": "string"
}

update_brand

path Parameters
uuid
required
string
Request Body schema: application/json
required
domainName
required
string
logoUrl
required
string
name
required
string
senderEmailAddress
required
string
status
required
string (BrandStatusDto)
Enum: "inactive" "active"
themePrimary
required
string
themeSecondary
string or null
themeTertiary
string or null
twilioSenderNumber
required
string

Responses

Request samples

Content type
application/json
{
  • "domainName": "string",
  • "logoUrl": "string",
  • "name": "string",
  • "senderEmailAddress": "string",
  • "status": "inactive",
  • "themePrimary": "string",
  • "themeSecondary": "string",
  • "themeTertiary": "string",
  • "twilioSenderNumber": "string"
}

Response samples

Content type
application/json
null

delete_brand

path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_code": { }
}

customer_request

Request Body schema: application/json
required
agreement
required
boolean
description
required
string
subject
required
string
topicId
required
string

Responses

Request samples

Content type
application/json
{
  • "agreement": true,
  • "description": "string",
  • "subject": "string",
  • "topicId": "string"
}

Response samples

Content type
application/json
null

get_brand_latest_tos

path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "content": "string",
  • "timestamp": 0
}

get_brand_templates

path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "brandId": "string",
  • "verifyTemplateId": "string",
  • "welcomeTemplateId": "string"
}

set_brand_templates

path Parameters
uuid
required
string
Request Body schema: application/json
required
verificationTemplateId
required
string
welcomeTemplateId
required
string

Responses

Request samples

Content type
application/json
{
  • "verificationTemplateId": "string",
  • "welcomeTemplateId": "string"
}

Response samples

Content type
application/json
null

funding-sources

Funding Source management endpoints.

funding_sources_with_balance

Responses

Response samples

Content type
application/json
{
  • "crypto": {
    },
  • "fiat": {
    },
  • "totalBalance": {
    }
}

calculate_fee

Request Body schema: application/json
required
accountId
required
string
amount
required
number <double>
category
required
string (TransactionCategoryDto)
Enum: "etransfer" "eft" "fee"

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "amount": 0.1,
  • "category": "etransfer"
}

Response samples

Content type
application/json
{
  • "amount": "string",
  • "fee": {
    }
}

list_my_funding_sources

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get_fiat_funding_source

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "accountNumber": "string",
  • "balance": {
    },
  • "bankCountry": "string",
  • "bankNumber": "string",
  • "currency": "string",
  • "email": "string",
  • "id": "string",
  • "nickname": "string",
  • "status": "inactive",
  • "transitNumber": "string"
}

send_eft

path Parameters
funding_source_id
required
string
Request Body schema: application/json
required
amount
required
number <double>

"15.35" = 15 dollars and 35 cents

beneficiaryId
required
string
purposeCode
required
string

3 digit CPA EFT code (200 Payroll, etc)

reference
string or null

Responses

Request samples

Content type
application/json
{
  • "amount": 0.1,
  • "beneficiaryId": "string",
  • "purposeCode": "string",
  • "reference": "string"
}

Response samples

Content type
application/json
{
  • "amount": 0.1,
  • "beneficiaryId": "string",
  • "brandId": "string",
  • "category": "etransfer",
  • "createdAt": 0,
  • "currency": "string",
  • "description": "string",
  • "externalId": "string",
  • "fundingSourceId": "string",
  • "id": "string",
  • "lastModifiedAt": 0,
  • "ownerAccountId": "string",
  • "ownerUserId": "string",
  • "peerAccountNumber": "string",
  • "peerBankNumber": "string",
  • "peerEtransferEmail": "string",
  • "peerFullName": "string",
  • "peerTransitNumber": "string",
  • "principalTransactionId": "string",
  • "purposeCode": "string",
  • "rejectionReason": "string",
  • "status": "pending",
  • "tenantId": "string",
  • "type": "inComing"
}

send_etransfer

path Parameters
funding_source_id
required
string
Request Body schema: application/json
required
amount
required
number <double>

"15.35" = 15 dollars and 35 cents

beneficiaryId
required
string
reference
string or null
securityAnswer
string or null
securityQuestion
string or null

Responses

Request samples

Content type
application/json
{
  • "amount": 0.1,
  • "beneficiaryId": "string",
  • "reference": "string",
  • "securityAnswer": "string",
  • "securityQuestion": "string"
}

Response samples

Content type
application/json
{
  • "amount": 0.1,
  • "beneficiaryId": "string",
  • "brandId": "string",
  • "category": "etransfer",
  • "createdAt": 0,
  • "currency": "string",
  • "description": "string",
  • "externalId": "string",
  • "fundingSourceId": "string",
  • "id": "string",
  • "lastModifiedAt": 0,
  • "ownerAccountId": "string",
  • "ownerUserId": "string",
  • "peerAccountNumber": "string",
  • "peerBankNumber": "string",
  • "peerEtransferEmail": "string",
  • "peerFullName": "string",
  • "peerTransitNumber": "string",
  • "principalTransactionId": "string",
  • "purposeCode": "string",
  • "rejectionReason": "string",
  • "status": "pending",
  • "tenantId": "string",
  • "type": "inComing"
}

admins

Admin panel management endpoints.

get_admins

Responses

Response samples

Content type
application/json
[
  • {
    }
]

create_admin

Request Body schema: application/json
required
email
required
string
firstName
required
string
lastName
required
string
password
required
string
permissions
required
Array of strings (AdminPermissionDto)
Items Enum: "read" "write" "manage"
status
required
string (AdminStatusDto)
Enum: "active" "inactive"
username
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "password": "string",
  • "permissions": [
    ],
  • "status": "active",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "createdAt": 0,
  • "email": "string",
  • "firstName": "string",
  • "id": "string",
  • "lastModifiedAt": 0,
  • "lastName": "string",
  • "permissions": [
    ],
  • "status": "active",
  • "username": "string"
}

admin_login

Request Body schema: application/json
required
password
required
string
username
required
string

Responses

Request samples

Content type
application/json
{
  • "password": "string",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_code": { }
}

logged_in_admin

Responses

Response samples

Content type
application/json
{
  • "createdAt": 0,
  • "email": "string",
  • "firstName": "string",
  • "id": "string",
  • "lastModifiedAt": 0,
  • "lastName": "string",
  • "permissions": [
    ],
  • "status": "active",
  • "username": "string"
}

get_users_by_account_id

path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get_admin_by_id

path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "createdAt": 0,
  • "email": "string",
  • "firstName": "string",
  • "id": "string",
  • "lastModifiedAt": 0,
  • "lastName": "string",
  • "permissions": [
    ],
  • "status": "active",
  • "username": "string"
}

delete_admin

path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_code": { }
}

update_admin

path Parameters
uuid
required
string
Request Body schema: application/json
required
email
string or null
firstName
string or null
lastName
string or null
permissions
Array of strings or null (AdminPermissionDto)
Enum: "read" "write" "manage"
null or AdminStatusDto (string)
username
string or null

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "permissions": [
    ],
  • "status": { },
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "createdAt": 0,
  • "email": "string",
  • "firstName": "string",
  • "id": "string",
  • "lastModifiedAt": 0,
  • "lastName": "string",
  • "permissions": [
    ],
  • "status": "active",
  • "username": "string"
}

update_admin_password

path Parameters
uuid
required
string
Request Body schema: application/json
required
newPassword
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_code": { }
}

transactions

Transaction management endpoints.

search_transactions

query Parameters
timestampFrom
integer or null <int64>
timestampUntil
integer or null <int64>
amountFrom
number or null <double>
amountUntil
number or null <double>
null or Sorting (string)
beneficiaryId
string or null
null or TransactionCategoryDto (string)
pageSize
integer or null <int64> >= 0
page
integer or null <int64> >= 0

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "pageSize": 0,
  • "totalCount": 0,
  • "totalPages": 0,
  • "transactions": [
    ]
}

get_my_transactions

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get_my_templates

Responses

Response samples

Content type
application/json
[
  • {
    }
]

update_transaction

path Parameters
uuid
required
string
Request Body schema: application/json
required
rejectionReason
string or null
status
required
string (TransactionStatusDto)
Enum: "pending" "canceled" "inProgress" "rejected" "completed"

Responses

Request samples

Content type
application/json
{
  • "rejectionReason": "string",
  • "status": "pending"
}

Response samples

Content type
application/json
{
  • "amount": 0.1,
  • "beneficiaryId": "string",
  • "brandId": "string",
  • "category": "etransfer",
  • "createdAt": 0,
  • "currency": "string",
  • "description": "string",
  • "externalId": "string",
  • "fundingSourceId": "string",
  • "id": "string",
  • "lastModifiedAt": 0,
  • "ownerAccountId": "string",
  • "ownerUserId": "string",
  • "peerAccountNumber": "string",
  • "peerBankNumber": "string",
  • "peerEtransferEmail": "string",
  • "peerFullName": "string",
  • "peerTransitNumber": "string",
  • "principalTransactionId": "string",
  • "purposeCode": "string",
  • "rejectionReason": "string",
  • "status": "pending",
  • "tenantId": "string",
  • "type": "inComing"
}

users

User endpoints.

accept_latest_tos

Responses

Response samples

Content type
application/json
null

get_users_for_my_account

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get_user_details

path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "brandId": "string",
  • "email": "string",
  • "firstName": "string",
  • "id": "string",
  • "isPep": true,
  • "isUsPerson": true,
  • "lastName": "string",
  • "phoneNumber": "string",
  • "status": "active",
  • "tenantId": "string",
  • "tosLastAcceptedAt": 0,
  • "username": "string",
  • "verificationData": null
}

get_referrer_info

path Parameters
uuid
required
string

User Id

Responses

Response samples

Content type
application/json
{
  • "accountId": "string",
  • "brandName": "string",
  • "firstName": "string",
  • "lastName": "string"
}

get_users

Responses

Response samples

Content type
application/json
[
  • {
    }
]

user_login

header Parameters
x-brand-id
required
string

Brand Id

Request Body schema: application/json
required
password
required
string
user
required
string

Responses

Request samples

Content type
application/json
{
  • "password": "string",
  • "user": "string"
}

Response samples

Content type
application/json
{
  • "type": "user",
  • "user": {
    }
}

user_logout

Responses

Response samples

Content type
application/json
null

me

header Parameters
x-brand-id
required
string

Brand Id

Responses

Response samples

Content type
application/json
{
  • "type": "user",
  • "user": {
    }
}

generate_api_key

Responses

Response samples

Content type
application/json
{
  • "api_key": "string",
  • "api_secret": "string",
  • "created_at": 0,
  • "user_id": "string"
}

get_potential_users

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get_potential_users_for_my_account

Responses

Response samples

Content type
application/json
[
  • {
    }
]

referral_page_info

Responses

Response samples

Content type
application/json
{
  • "cardInfo": {
    },
  • "moneyEarned": "string",
  • "numberOfReferrals": "string",
  • "since": "string"
}

create_potential_user

header Parameters
x-brand-id
required
string

Brand Id

x-tenant-id
required
string

Tenant Id

Request Body schema: application/json
required
email
required
string
isPep
required
boolean
isUsPerson
required
boolean
password
required
string
referrerAccountId
string or null
referrerAffiliateId
string or null
type
required
string (PotentialUserTypeDto)
Enum: "personal" "corporate" "moneyServicesBusiness"
username
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "isPep": true,
  • "isUsPerson": true,
  • "password": "string",
  • "referrerAccountId": "string",
  • "referrerAffiliateId": "string",
  • "type": "personal",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "accountId": "string",
  • "brandId": "string",
  • "email": "string",
  • "id": "string",
  • "isPep": true,
  • "isUsPerson": true,
  • "phoneNumber": "string",
  • "referrerAccountId": "string",
  • "referrerAffiliateId": "string",
  • "roles": [
    ],
  • "status": "pendingEmailVerification",
  • "tenantId": "string",
  • "type": "personal",
  • "username": "string"
}

send_verification_email

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_code": { }
}

verify_email

Request Body schema: application/json
required
otpCode
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_code": { }
}

init_identity_verification

Responses

Response samples

Content type
application/json
{
  • "token": "string",
  • "userId": "string"
}

add_phone_number

Request Body schema: application/json
required
phoneNumber
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "accountId": "string",
  • "brandId": "string",
  • "email": "string",
  • "id": "string",
  • "isPep": true,
  • "isUsPerson": true,
  • "phoneNumber": "string",
  • "referrerAccountId": "string",
  • "referrerAffiliateId": "string",
  • "roles": [
    ],
  • "status": "pendingEmailVerification",
  • "tenantId": "string",
  • "type": "personal",
  • "username": "string"
}

send_verification_sms

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_code": { }
}

verify_phone_number

Request Body schema: application/json
required
otpCode
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_code": { }
}

update_user_status

path Parameters
uuid
required
string
Request Body schema: application/json
required
status
required
string (UserStatusDto)
Enum: "active" "inactive"

Responses

Request samples

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

Response samples

Content type
application/json
null

affiliates

get_all

Responses

Response samples

Content type
application/json
[
  • {
    }
]

create_affiliate

Request Body schema: application/json
required
name
required
string
referrerAffiliateId
string or null
status
required
string (AffiliateStatusDto)
Enum: "active" "inactive"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "referrerAffiliateId": "string",
  • "status": "active"
}

Response samples

Content type
application/json
{
  • "createdAt": 0,
  • "id": "string",
  • "name": "string",
  • "referrerAffiliateId": "string",
  • "status": "active"
}

get_affiliate_by_id

path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "createdAt": 0,
  • "id": "string",
  • "name": "string",
  • "referrerAffiliateId": "string",
  • "status": "active"
}

update_affiliate

path Parameters
uuid
required
string
Request Body schema: application/json
required
name
required
string
referrerAffiliateId
string or null
status
required
string (AffiliateStatusDto)
Enum: "active" "inactive"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "referrerAffiliateId": "string",
  • "status": "active"
}

Response samples

Content type
application/json
{
  • "createdAt": 0,
  • "id": "string",
  • "name": "string",
  • "referrerAffiliateId": "string",
  • "status": "active"
}

delete_affiliate

path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
null

frontend

get_bank_branches

path Parameters
bank_number
required
integer <int64>
transit_number
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "bank": {
    },
  • "branch": {
    }
}

has_etransfer_autodeposit

query Parameters
email
required
string

Responses

Response samples

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

get_home_page_data

Responses

Response samples

Content type
application/json
{
  • "beneficiaries": [
    ],
  • "fundingSources": {
    },
  • "inviteCard": {
    },
  • "transactions": {
    }
}

get_transaction_purpose_codes

Responses

Response samples

Content type
application/json
[
  • {
    }
]

beneficiaries

get_my_beneficiaries

Responses

Response samples

Content type
application/json
[
  • {
    }
]

create_beneficiary

Request Body schema: application/json
required
accountNumber
string or null
bankNumber
string or null
companyName
string or null
etransferEmail
string or null
firstName
required
string
lastName
required
string
middleName
string or null
nickname
string or null
purposeCode
string or null
transitNumber
string or null
type
required
string (BeneficiaryTypeDto)
Enum: "customer" "business"

Responses

Request samples

Content type
application/json
{
  • "accountNumber": "string",
  • "bankNumber": "string",
  • "companyName": "string",
  • "etransferEmail": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "middleName": "string",
  • "nickname": "string",
  • "purposeCode": "string",
  • "transitNumber": "string",
  • "type": "customer"
}

Response samples

Content type
application/json
{
  • "accountNumber": "string",
  • "bankNumber": "string",
  • "companyName": "string",
  • "createdAt": 0,
  • "etransferEmail": "string",
  • "firstName": "string",
  • "id": "string",
  • "lastModifiedAt": 0,
  • "lastName": "string",
  • "middleName": "string",
  • "nickname": "string",
  • "purposeCode": "string",
  • "transitNumber": "string",
  • "type": "customer"
}

update_beneficiary

path Parameters
uuid
required
string
Request Body schema: application/json
required
accountNumber
string or null
bankNumber
string or null
companyName
string or null
etransferEmail
string or null
firstName
required
string
lastName
required
string
middleName
string or null
nickname
string or null
purposeCode
string or null
transitNumber
string or null
type
required
string (BeneficiaryTypeDto)
Enum: "customer" "business"

Responses

Request samples

Content type
application/json
{
  • "accountNumber": "string",
  • "bankNumber": "string",
  • "companyName": "string",
  • "etransferEmail": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "middleName": "string",
  • "nickname": "string",
  • "purposeCode": "string",
  • "transitNumber": "string",
  • "type": "customer"
}

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_code": { }
}

delete_beneficiary

path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_code": { }
}

Health

health

Responses

invitations

accept_invitation

path Parameters
id
required
string
email
required
string

Responses

Response samples

Content type
application/json
null

create_invitation

Request Body schema: application/json
required
email
required
string
firstName
required
string
lastName
required
string
roles
required
Array of strings (UserRolesDto)
Items Enum: "owner" "audit"

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "brandId": "string",
  • "createdAt": 0,
  • "email": "string",
  • "expiresAt": 0,
  • "firstName": "string",
  • "hasAccepted": true,
  • "id": "string",
  • "inviterUserId": "string",
  • "lastName": "string",
  • "roles": [
    ],
  • "tenantId": "string"
}

delete_invitation

path Parameters
id
required
string
email
required
string

Responses

Response samples

Content type
application/json
null

get_invitation

path Parameters
id
required
string
email
required
string

Responses

Response samples

Content type
application/json
{
  • "invitation": {
    },
  • "message": "string"
}

metrics

metrics_handler

Responses

Response samples

Content type
application/json
null

sumsub

webhook_handler

Responses

Response samples

Content type
application/json
null

tariffs

get_tariffs

Responses

Response samples

Content type
application/json
[
  • {
    }
]

create_tariff

Request Body schema: application/json
required
brandId
required
string
description
required
string
required
object (FeesAndFeatures)
level
required
integer <int32>
monthlyReferralCommission
required
string
name
required
string
segment
required
string (AccountTypeDto)
Enum: "personal" "corporate" "moneyServicesBusiness"
tariffUtilization
required
string

Responses

Request samples

Content type
application/json
{
  • "brandId": "string",
  • "description": "string",
  • "feesAndFeatures": {
    },
  • "level": 0,
  • "monthlyReferralCommission": "string",
  • "name": "string",
  • "segment": "personal",
  • "tariffUtilization": "string"
}

Response samples

Content type
application/json
{
  • "brandId": "string",
  • "createdAt": 0,
  • "description": "string",
  • "feesAndFeatures": {
    },
  • "id": "string",
  • "name": "string",
  • "segment": "personal"
}

get_brand_tariffs_tabular

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get_tariff_by_id

path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "brandId": "string",
  • "createdAt": 0,
  • "description": "string",
  • "feesAndFeatures": {
    },
  • "id": "string",
  • "name": "string",
  • "segment": "personal"
}

update_tariff

path Parameters
uuid
required
string
Request Body schema: application/json
required
brandId
required
string
description
required
string
required
object (FeesAndFeatures)
level
required
integer <int32>
monthlyReferralCommission
required
string
name
required
string
segment
required
string (AccountTypeDto)
Enum: "personal" "corporate" "moneyServicesBusiness"
tariffUtilization
required
string

Responses

Request samples

Content type
application/json
{
  • "brandId": "string",
  • "description": "string",
  • "feesAndFeatures": {
    },
  • "level": 0,
  • "monthlyReferralCommission": "string",
  • "name": "string",
  • "segment": "personal",
  • "tariffUtilization": "string"
}

Response samples

Content type
application/json
{
  • "brandId": "string",
  • "createdAt": 0,
  • "description": "string",
  • "feesAndFeatures": {
    },
  • "id": "string",
  • "name": "string",
  • "segment": "personal"
}

delete_tariff_plan

path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "brandId": "string",
  • "createdAt": 0,
  • "description": "string",
  • "feesAndFeatures": {
    },
  • "id": "string",
  • "name": "string",
  • "segment": "personal"
}