API docs by Redocly

Inyo API (1.0.0)

Download OpenAPI specification:

Getting Started

Authentication

Before you can start, ensure you have your Tenant API key. This key is essential for accessing the API.

All endpoints requires the Tenant API key to be passed as X-API-KEY header.

Creating an Agent

  1. Create a Company: Use the create company endpoint to create a company.
  2. Create an Agent: Once the company is created, use the create agent endpoint. This will return an agent id and agent api key. Save this agent id and key, as it is necessary for authenticating to some endpoints.
  3. Approval: The agent must be approved by the compliance team before it can make transactions. Before approval, attempts to authenticate using the agent id and key will fail with 403 response.

Creating the Sender and Receiver

Every transaction must have a participant which can be a Person or a Company and created using the create person endpoint or create company endpoint. The participant can be the same Person/Company, in this case, you can use the same participant id for both 'senderId' and 'receiverId' when creating the transaction.

To use a participant as Sender, it must have at least compliance level 1.

Compliance level is dynamically based on provided fields, participant type and tenant. Every tenant has its own configuration, which means the required fields and compliance levels will vary accordingly.

The default values for required fields are the following:

Compliance level Required fields 24h limit 30 days limit 180 days limit
1 name, last name, address, phone number $ $ $
2 ssn, occupation, documentId $ $ $
3 proof of sources of funds $ $ $

By following these steps, you can successfully create agents and perform transactions using the API.

Transaction Resource

Get participant transaction usage limits

Authorizations:
AgentAPIKey
path Parameters
participantId
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "oneDayLimit": {
    },
  • "thirtyDaysLimit": {
    },
  • "oneHundredAndEightyDaysLimit": {
    },
  • "complianceLevel": {
    }
}

List transactions by filters

Authorizations:
TenantAPIKey
query Parameters
complianceStatus
string or null
from
string or null
page
integer or null <int32>
payoutStatus
string or null
receiverName
string or null
senderName
string or null
size
integer or null <int32>
to
string or null
type
string or null
Enum: "FX" "TOP_UP" "BILLPAY"

Transaction type to be filtered

Responses

Response samples

Content type
application/json
{
  • "total": 3,
  • "size": 3,
  • "page": 0,
  • "numberOfPages": 1,
  • "items": [
    ]
}

Register a transaction

Register a transaction

Authorizations:
AgentAPIKey
path Parameters
tenant
required
string
Request Body schema: application/json
required

Request a transaction

externalId
string or null <uuid>

External Id

senderId
required
string or null <uuid>

Sender Id

receiverId
required
string or null <uuid>

Receiver Id

fundingAccountId
required
string or null <uuid>

Funding account Id

recipientAccountId
required
string or null <uuid>

Recipient account Id

quoteId
required
string or null <uuid>

Quote Id

required
(fx_API_MonetaryAmountPayload (object or null)) or (object or null)

Amount

(fx_API_MonetaryAmountPayload (object or null)) or (object or null)

Fee

(fx_API_DeviceDataPayload (object or null)) or (object or null)

Device data

required
object

additional data

Responses

Request samples

Content type
application/json
{
  • "senderId": "422a55b2-78c3-4509-8654-16e7375d3e40",
  • "receiverId": "4b9dcb4e-2e2a-4e96-b2a9-fcd868b2f4ed",
  • "fundingAccountId": "3fe5f23f-65d3-41b6-b34c-33db3c4d8ef9",
  • "recipientAccountId": "67203d69-dc48-41d4-b2ac-52682d39b032",
  • "quoteId": "30bf05d2-b416-4e71-b8e8-1ef158a2b414",
  • "amount": {
    },
  • "additionalData": {
    },
  • "deviceData": {
    }
}

Response samples

Content type
application/json
Example
{
  • "id": "e4668be7-cf30-4ec8-8026-1a0286487c95",
  • "sender": {
    },
  • "receiver": {
    },
  • "tenantId": "master",
  • "externalId": null,
  • "agentId": "d12d8d86-9f7a-4a6f-a712-f2b8f6c1a787",
  • "createdAt": "2025-05-08T12:31:42.797785",
  • "anchorCurrencyAmount": "102.53",
  • "complianceStatus": "Approved",
  • "payoutStatus": "Pending",
  • "quoteId": "b189e950-7f58-4ab2-b5ef-b682d881d8ed",
  • "fundingAccountId": "2ad02613-36fe-477e-a096-63e5d2dc55db",
  • "recipientAccountId": "5ffae5fe-3eb0-4e87-a81f-0f540deb3684",
  • "exchangeRate": "5.63197488",
  • "totalAmount": "102.53",
  • "receivingAmount": "577.4463844464",
  • "fee": "0",
  • "conversionAmount": "102.53",
  • "originExchangeRate": {
    },
  • "destinationExchangeRate": {
    },
  • "type": "FX",
  • "senderId": "510ad931-e582-4b55-89ad-4ec91fa99560",
  • "receiverId": "ac7f2060-5b2b-4797-8c8a-35a77a0ed4a7"
}

Get transaction schema by country code (ISO 3166-1 alpha-2)

Authorizations:
TenantAPIKey
query Parameters
countryCode
string or null

Country ISO 3166-1 alpha-2 code

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get transaction by id

Authorizations:
TenantAPIKey
path Parameters
transactionId
required
string or null

Responses

Response samples

Content type
application/json
{
  • "id": "9035ee18-052b-4176-a940-ccfe599a1829",
  • "sender": {
    },
  • "receiver": {
    },
  • "tenantId": "altour",
  • "externalId": null,
  • "agentId": "41f55211-1eea-4747-9a03-68e99f07ede5",
  • "createdAt": "2025-05-29T17:26:27.264312",
  • "anchorCurrencyAmount": "102.530000000000000",
  • "complianceStatus": "Approved",
  • "payoutStatus": "Pending",
  • "quoteId": "af2d55d8-1d40-426a-8d4a-7454ccdcbe8a",
  • "fundingAccountId": "61bc14a1-b3a2-40b4-b395-0496e4f554a1",
  • "recipientAccountId": "4fbc57a6-f673-44ba-88aa-c6e71eb9181b",
  • "exchangeRate": "5.571062480000000",
  • "totalAmount": "102.530000000000000",
  • "receivingAmount": "571.201036074400000",
  • "fee": 0,
  • "conversionAmount": "102.530000000000000",
  • "originExchangeRate": {
    },
  • "destinationExchangeRate": {
    },
  • "type": "FX",
  • "senderId": "ce06773d-6472-4c93-bdf5-8eb68ab01c7f",
  • "receiverId": "156675d5-1d1b-4b4d-997e-5c15ae129b82"
}

Update transaction metadata

Authorizations:
TenantAPIKey
path Parameters
transactionId
required
string
Request Body schema: application/json
required
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

List transactions status

Authorizations:
TenantAPIKey
path Parameters
transactionId
required
string

Responses

Response samples

Content type
application/json
Example
[
  • {
    }
]

Cancel the transaction

Marked a transaction to be confirmed, status must be Created, Hold, Authorized, or Transmitted

Authorizations:
TenantAPIKey
path Parameters
tenant
required
string
transactionId
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "Transaction state Transmitted is not cancellable"
}

Refund the transaction

Marked a transaction to be confirmed, status must be Paid

Authorizations:
TenantAPIKey
path Parameters
tenant
required
string
transactionId
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "Transaction payout state Pending is not refundable"
}

Wallet Resource

List participant wallets

Retrieves a paginated list of wallets associated with a specific participant.The response includes wallet details such as ID, agent name, beneficiary name, asset and others.

Authorizations:
TenantAPIKey
path Parameters
participantId
required
string
Examples: a5aa93bc-e0c7-4db6-bb22-05447405a2d1

The unique identifier of the participant.

tenant
required
string
Examples: master

The unique identifier of the tenant.

query Parameters
page
integer or null <int32>
Default: 0
Examples: page=0

The page number for pagination (0-indexed)

size
integer or null <int32>
Default: 10
Examples: size=10

The number of items to return per page (page size).

Responses

Response samples

Content type
application/json
{
  • "total": 2,
  • "size": 2,
  • "page": 0,
  • "numberOfPages": 1,
  • "items": [
    ]
}

Create a wallet

Create a wallet

Authorizations:
AgentAPIKey
path Parameters
tenant
required
string
Request Body schema: application/json
required

Create a wallet for a company

companyId
required
string or null <= 255 characters

Company id to create wallet for

Responses

Request samples

Content type
application/json
{
  • "companyId": "e3eaea38-5cd5-4ecc-abcb-ec720fd016ee"
}

Response samples

Content type
application/json
{
  • "id": "0c1787dd-115b-4ef1-bcfb-525ad2a320c5",
  • "asset": "USD",
  • "fundingAccountId": "bde7ff93-bef8-4f60-81f8-5aadc13dce8c",
  • "beneficiaryId": "3f6be631-4ca0-41b8-a61f-b27d394afdd6",
  • "beneficiaryName": "Quantum Ledger Dynamics",
  • "agentId": "924c75b2-d498-444e-9eb3-d72d95a8d924",
  • "agentName": "Agent company",
  • "status": "Pending",
  • "createdAt": "2025-06-13T16:50:33.393563"
}

Get wallet

Get wallet

Authorizations:
AgentAPIKey
path Parameters
tenant
required
string
walletId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "5249999a-16ca-4a9e-92f1-1040da2c8f22",
  • "asset": "USD",
  • "fundingAccountId": "82807198-63f1-42aa-8a6e-1e92d35c65fe",
  • "beneficiaryId": "e2e2fc85-d319-45f8-a828-8fb0d7cae3d8",
  • "beneficiaryName": "Quantum Ledger Dynamics",
  • "agentId": "b30a105e-4ab3-4689-8ac5-a914d29d0528",
  • "agentName": "Agent company",
  • "status": "Pending",
  • "createdAt": "2025-07-22T13:20:23.551524"
}

Gets the current wallet balance

Gets the current wallet balance

Authorizations:
AgentAPIKey
path Parameters
tenant
required
string
walletId
required
string

Responses

Response samples

Content type
application/json
{
  • "walletId": "3280e10a-bea9-45c4-983e-9047109a64ed",
  • "balance": "190.55",
  • "asset": "USD"
}

Gets the wallet statement

Gets the wallet statement

Authorizations:
AgentAPIKey
path Parameters
tenant
required
string
walletId
required
string
query Parameters
from
string or null
Examples: from=yyyy-mm-dd

From

page
integer or null <int32>
Default: 0
Examples: page=0

Page number

size
integer or null <int32>
Default: 10
Examples: size=10

Page size

to
string or null
Examples: to=yyyy-mm-dd

to

Responses

Response samples

Content type
application/json
{
  • "total": 2,
  • "size": 2,
  • "page": 0,
  • "numberOfPages": 1,
  • "items": [
    ]
}

Transaction Batch Resource

Register external transaction batch

Register an external transaction batch to analyzed by the compliance team

Authorizations:
TenantAPIKey
path Parameters
tenant
required
string
Request Body schema: application/jsonlines
required

Transaction batch to be inserted

string or null

Responses

Request samples

Content type
application/jsonlines
Example
{
  • "timestamp": 1726054659,
  • "agentId": "7b479e42-de5d-4f9f-830d-b9b704dbd021",
  • "externalId": "000002",
  • "productData": {
    },
  • "firstName": "John",
  • "lastName": "doe",
  • "address": {
    }
}

Retry a failed batch transaction with the given id

Queues the same transaction to be executed again, it's generate a new transaction id

Authorizations:
TenantAPIKey
path Parameters
transactionId
required
string or null

Responses

Person Resource

Create a person

This endpoint allows you to create a person who can be used as a sender, receiver, or company owner in transactions. Note:

  • No fields are required to create a person using this endpoint.
  • However, compliance level is dynamically based on provided fields and tenant .* To use a person as a sender in a transaction, it must have at least compliance Level 1.
  • To check person current level of compliance: get person details endpoint.

Default Minimal Required Fields for Level 1 Compliance:

  • First Name
  • Last Name
  • Phone Number
  • Address

Address Verification:

  • By default, addresses from the USA are validated through USPS APIs.
  • If automatic address verification fails, the user's transactions will be put on hold until the compliance team manually verifies the address.

Additional Information:

Authorizations:
TenantAPIKey
Request Body schema: application/json
required

Person to be created

firstName
string or null <= 255 characters

First name of the person

lastName
string or null <= 255 characters

Last name of the person

phoneNumber
string or null <= 255 characters

Required for us person

email
string or null <= 255 characters

Required for us person

gender
string or null
Enum: "Male" "Female" "Other"

Gender, Required for us person

birthDate
string or null

Formatted as yyyy-MM-dd, Required for US person

externalId
string or null <= 255 characters

External ID for the person

(account_API_Address (object or null)) or (object or null)

Person address

(account_API_Address (object or null)) or (object or null)

Person Place of Birth address

occupation
string or null <= 255 characters

Person Occupation

Array of objects or null (account_API_Document1)

Person documents, for: US [SSN, ITIN] / BR [CPF]

employerName
string or null <= 255 characters

Employer Name

(account_API_Address (object or null)) or (object or null)

Employer address

Responses

Request samples

Content type
application/json
Example
{
  • "firstName": "Bob",
  • "lastName": "Danilo",
  • "phoneNumber": "+1 123 456435",
  • "email": "Danilo@gmail.com",
  • "birthDate": "2015-08-04",
  • "gender": "Male",
  • "externalId": "Sender_12345",
  • "address": {
    }
}

Response samples

Content type
application/json
Example
{
  • "id": "48066496-9445-41b7-acbe-85e069a77cb7",
  • "firstName": "Bob",
  • "lastName": "Danilo",
  • "mainAddressId": "9c2ea7e5-51a2-4ea1-83cf-8948754486f8",
  • "placeOfBirthId": null,
  • "phoneNumber": "+1 123 456435",
  • "email": "Danilo@gmail.com",
  • "gender": "Male",
  • "birthDate": "2015-08-04",
  • "externalId": "Sender_12345",
  • "updatedAt": "2023-01-01T12:00:00",
  • "documents": null,
  • "occupation": null,
  • "documentId": null,
  • "sourceOfFundsId": null,
  • "employerName": null,
  • "employerAddressId": null
}

Update person

Update a person. All fields that are not explicitly sent in payload or are sent with null values will not be altered

Authorizations:
TenantAPIKey
path Parameters
personId
required
string or null
Request Body schema: application/json
required

Person to be updated

firstName
string or null <= 255 characters

First name of the person

lastName
string or null <= 255 characters

Last name of the person

phoneNumber
string or null <= 255 characters

Phone number of the person

email
string or null <= 255 characters

E-mail of the person

gender
string or null
Enum: "Male" "Female" "Other"

Gender of the person

birthDate
string or null

Birth date of the person, formatted as yyyy-MM-dd

externalId
string or null <= 255 characters

External ID for the person

occupation
string or null <= 255 characters

Person Occupation

Array of objects or null (account_API_Document1)

Person documents, for: US [SSN, ITIN] / BR [CPF]

Responses

Request samples

Content type
application/json
Example
{
  • "firstName": "Paulo"
}

Response samples

Content type
application/json
{
  • "id": "0537fb55-f06e-407f-90b3-a6f04cb0f7b2",
  • "firstName": "Paulo",
  • "lastName": "Frei",
  • "mainAddressId": "bdb8a94b-7ad0-4f60-919c-0c64ddbf80df",
  • "placeOfBirthId": null,
  • "externalId": "Sender_12345",
  • "phoneNumber": "+1 231 456435",
  • "email": "frei@gmail.com",
  • "gender": "Male",
  • "birthDate": "1990-08-04",
  • "updatedAt": "2023-01-01T12:00:00",
  • "documents": [
    ],
  • "occupation": "Developer",
  • "documentId": "e33cc352-1d42-4332-b7c5-14e64e62045b",
  • "sourceOfFundsId": "e33cc352-1d42-4332-b7c5-14e64e62045b",
  • "employerName": null,
  • "employerAddressId": null
}

Get person by id

Authorizations:
TenantAPIKey
path Parameters
personId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "1f6b64bd-874d-4d90-97e5-fbcf4adcaf14",
  • "firstName": "Bob",
  • "lastName": "Danilo",
  • "mainAddressId": "0235435d-27c8-47c4-ad64-12e3f8c98c49",
  • "placeOfBirthId": "dcb1723c-c0fe-4671-af76-1ff86b9aba4a",
  • "externalId": "Sender_12345",
  • "updatedAt": "2024-03-01T07:14:13.831798",
  • "phoneNumber": "+1 123 456435",
  • "email": "Danilo@gmail.com",
  • "gender": "Male",
  • "birthDate": "2015-08-04",
  • "documents": [
    ],
  • "occupation": "Consultant",
  • "documentId": null,
  • "sourceOfFundsId": null,
  • "employerName": "Employer Name",
  • "employerAddressId": "41868f6d-35af-48bf-a5e3-961439646ce7"
}

Update person Address

Update a person Address

Authorizations:
TenantAPIKey
path Parameters
personId
required
string or null
Request Body schema: application/json
required

Address to be updated

countryCode
string or null = 2 characters

The two letter iso country code

stateCode
string or null

The stateCode, required for US residents

city
string or null <= 255 characters

The city name

line1
string or null <= 255 characters

Address line 1

line2
string or null <= 255 characters

Address line 2

zipcode
string or null

Zip code

Responses

Request samples

Content type
application/json
{
  • "countryCode": "US",
  • "stateCode": "CA",
  • "city": "LAKEWOOD",
  • "line1": "4429 CANDLEWOOD ST",
  • "line2": "Some line 2 address",
  • "zipcode": "90712"
}

Response samples

Content type
application/json
{
  • "id": "ed092aa8-7acf-43ad-9787-8af4dc61e5c1",
  • "firstName": "Bob",
  • "lastName": "Danilo",
  • "mainAddressId": "99554e99-0a0e-4fef-9885-35db23cf3507",
  • "placeOfBirthId": null,
  • "externalId": "Sender_12345",
  • "phoneNumber": "+1 123 456435",
  • "email": "Danilo@gmail.com",
  • "gender": "Male",
  • "birthDate": "2015-08-04",
  • "updatedAt": "2023-12-21T02:24:43.3191053",
  • "documents": null,
  • "occupation": null,
  • "documentId": null,
  • "sourceOfFundsId": null,
  • "employerName": null,
  • "employerAddressId": null
}

Get person with details by id

Authorizations:
TenantAPIKey
path Parameters
personId
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "person": {
    },
  • "employerAddress": null,
  • "placeOfBirth": null,
  • "address": {
    },
  • "complianceLevel": {
    },
  • "documentId": null
}

Update person employer address

Update person employer address

Authorizations:
TenantAPIKey
path Parameters
personId
required
string or null
Request Body schema: application/json
required

Address to be updated

countryCode
string or null = 2 characters

The two letter iso country code

stateCode
string or null

The stateCode, required for US residents

city
string or null <= 255 characters

The city name

line1
string or null <= 255 characters

Address line 1

line2
string or null <= 255 characters

Address line 2

zipcode
string or null

Zip code

Responses

Request samples

Content type
application/json
{
  • "countryCode": "US",
  • "stateCode": "CA",
  • "city": "LAKEWOOD",
  • "line1": "4429 CANDLEWOOD ST",
  • "line2": "Some line 2 address",
  • "zipcode": "90712"
}

Response samples

Content type
application/json
{
  • "id": "ed092aa8-7acf-43ad-9787-8af4dc61e5c1",
  • "firstName": "Bob",
  • "lastName": "Danilo",
  • "mainAddressId": "99554e99-0a0e-4fef-9885-35db23cf3507",
  • "placeOfBirthId": null,
  • "externalId": "Sender_12345",
  • "phoneNumber": "+1 123 456435",
  • "email": "Danilo@gmail.com",
  • "gender": "Male",
  • "birthDate": "2015-08-04",
  • "updatedAt": "2023-12-21T02:24:43.3191053",
  • "documents": null,
  • "occupation": null,
  • "documentId": null,
  • "sourceOfFundsId": null,
  • "employerName": null,
  • "employerAddressId": "3fc2948b-9359-4378-a37e-eb4092dd4dd6"
}

Update person place of birth

Update person place of birth

Authorizations:
TenantAPIKey
path Parameters
personId
required
string or null
Request Body schema: application/json
required

Address to be updated

countryCode
string or null = 2 characters

The two letter iso country code

stateCode
string or null

The stateCode, required for US residents

city
string or null <= 255 characters

The city name

line1
string or null <= 255 characters

Address line 1

line2
string or null <= 255 characters

Address line 2

zipcode
string or null

Zip code

Responses

Request samples

Content type
application/json
{
  • "countryCode": "US",
  • "stateCode": "CA",
  • "city": "LAKEWOOD",
  • "line1": "4429 CANDLEWOOD ST",
  • "line2": "Some line 2 address",
  • "zipcode": "90712"
}

Response samples

Content type
application/json
{
  • "id": "ed092aa8-7acf-43ad-9787-8af4dc61e5c1",
  • "firstName": "Bob",
  • "lastName": "Danilo",
  • "mainAddressId": "99554e99-0a0e-4fef-9885-35db23cf3507",
  • "placeOfBirthId": null,
  • "externalId": "Sender_12345",
  • "phoneNumber": "+1 123 456435",
  • "email": "Danilo@gmail.com",
  • "gender": "Male",
  • "birthDate": "2015-08-04",
  • "updatedAt": "2023-12-21T02:24:43.3191053",
  • "documents": null,
  • "occupation": null,
  • "documentId": null,
  • "sourceOfFundsId": null,
  • "employerName": null,
  • "employerAddressId": null
}

City Resource

Get city by id

path Parameters
cityId
required
integer <int32>

The city Id

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Country Resource

Search countries by name

query Parameters
countryName
required
string
Default: ""

Country name to search. Note that case and accents are not ignored.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Get country by country code

path Parameters
code
required
string

Country ISO 3166-1 alpha-2 code

Responses

Response samples

Content type
application/json
{
  • "id": 31,
  • "name": "Brazil",
  • "code": "BR",
  • "currency": "BRL",
  • "currencyName": "Brazilian real",
  • "currencySymbol": "R$",
  • "emoji": "🇧🇷"
}

Get states cities country code

path Parameters
countryCode
required
string

Country ISO 3166-1 alpha-2 code

query Parameters
cityName
required
string
Default: ""

City name to search. Note that case and accents are not ignored.

Responses

Response samples

Content type
application/json
Example
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Get states by country code

path Parameters
countryCode
required
string

Country ISO 3166-1 alpha-2 code

Responses

Response samples

Content type
application/json
Example
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Address Resource

Get check if the address is okay

Authorizations:
TenantAPIKey
query Parameters
city
required
string
Default: ""

City name to check. Note that case and accents are not ignored.

countryCode
required
string
Default: ""
line1
required
string
Default: ""
line2
required
string
Default: ""
stateCode
required
string
Default: ""

The stateCode, required for US residents, to check. Note that case and accents are not ignored.

zipCode
required
string
Default: ""

City name to check. Note that case and accents are not ignored.

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Agent Resource

Create an agent

This endpoint allows you to create an agent who can be used to make transactions. Note:

This will return an Agent ID and an Agent API key. Save these fields, as it is necessary for authenticating to some endpoints.

The Agent must be approved by the compliance team before it can make transactions. Before approval, attempts to authenticate using the Agent ID and Agent API key will fail with 403 response

Authorizations:
TenantAPIKey
path Parameters
tenant
required
string
Request Body schema: application/json
required

Agent to be created

externalId
string or null <= 255 characters
email
required
string or null <= 255 characters
companyId
required
string or null

Company ID

account_API_AddressInput (object) or object

Agent address

businessName
string or null

Agent business name

Responses

Request samples

Content type
application/json
Example
{
  • "externalId": "Agent_12345",
  • "email": "test@test.com",
  • "companyId": "${companyId}",
  • "businessName": "Bkt Services Corporation",
  • "mainAddress": {
    }
}

Response samples

Content type
application/json
Example
{
  • "id": "2aa3cbab-0e94-42fc-849f-3d467b2b4f3b",
  • "externalId": "Agent_12345",
  • "email": "test@test.com",
  • "orgName": "master",
  • "companyId": "1db8fbd4-6f77-45d9-9449-018ee94372b6",
  • "status": "Pending",
  • "apiKey": "5734a303-9bf0-42ef-9e24-6505d49395d2",
  • "businessName": "Bkt Services Corporation",
  • "mainAddress": {
    }
}

List agent document types

Responses

Response samples

Content type
application/json
[
  • "achAuthorizationFormWithAVoidCheckAttached",
  • "additionalAuthorizedLocationsForm",
  • "addressChangeDocument",
  • "agencyCommissionSchedule",
  • "agencyPreApprovalApplication",
  • "agentCheckCashingLicense",
  • "agreementForm",
  • "articlesOfCorporationOrganizationOrPartnershipAgreement",
  • "auditedFinancialStatementsLastTwoYears",
  • "bankAgreementForm",
  • "businessAndLitigationHistory",
  • "businessRegistration",
  • "certificateOfIncorporation",
  • "certificateOfOwnership",
  • "certificateOfResale",
  • "companyOrganizationChart",
  • "completedDueDiligenceForm",
  • "complianceAddendumToAgencyAgreement",
  • "complianceManual",
  • "complianceOfficerAssign",
  • "complianceSurvey",
  • "complianceTrainingAcknowledgement",
  • "complianceTrainingQuiz",
  • "complianceTrainingRenewal",
  • "complianceVisit",
  • "complianceVisit2016",
  • "complianceVisit2016Certificate",
  • "complianceVisit2017",
  • "complianceVisit2019",
  • "complianceVisit2020",
  • "contactList",
  • "contract",
  • "copyOfBusinessLicenseSellersPermit",
  • "copyOfEinIrsLetter",
  • "courtesyVisit2015",
  • "courtesyVisit2016",
  • "creditAndBackgroundCheckReportComplianceOnly",
  • "directDepositAgreement",
  • "equipmentResponsibility",
  • "gmtCertificate",
  • "invoice",
  • "listOfAuthorizedSignatories",
  • "listOfShareholders",
  • "listOfShareholders100PercentOfShares",
  • "monthlyAudit",
  • "mysteryShopping",
  • "negativeNewsSearch",
  • "ofacVerification",
  • "onboardingZip",
  • "other",
  • "pepVerification",
  • "phoneRechargeContract",
  • "photosOfApplicantsStoreFront",
  • "proofOfAddress",
  • "proofOfDbaFiling",
  • "rdcAgreement",
  • "releaseOfLiability",
  • "summaryOfDataProtectionAndCyberSecurityPoliciesAndProcedures",
  • "terminationChecklist",
  • "terminationLetter",
  • "tosAndDisclosuresPlacement",
  • "userComplianceTraining",
  • "usernameAssignmentForm",
  • "validPhotoId",
  • "visitDocumentsDisplay",
  • "visitReport",
  • "voidedCheck",
  • "w9",
  • "wpDeclarationLetter",
  • "wpVideoVerification2019"
]

Company Resource

Get companies by filters

Get companies by filters

Authorizations:
TenantAPIKey
query Parameters
fein
string or null
Examples: fein=12-3456789

Federal Employer Identification Number

legalName
string or null

Legal name

page
integer or null <int32>
Default: 0
Examples: page=0

Page number

phoneNumber
string or null

Phone number

size
integer or null <int32>
Default: 10
Examples: size=10

Page size

sort
required
object
Examples: sort=createdAt,DESC

Sort by field and order. Each item should be in the format 'field,order' where 'field' is one of ['createdAt'] and 'order' is either ASC or DESC.

Responses

Response samples

Content type
application/json
Example
{
  • "total": 3,
  • "size": 2,
  • "page": 0,
  • "numberOfPages": 2,
  • "items": [
    ]
}

Create a company

This endpoint allows you to create a new company.

The request body must include essential company details such as legal name, trade name, phone number, incorporation country, business type, document, address and bank account information.

Optionally, you can include ownership details. Each owner must be a valid person (create person endpoint) and you must provide an ownership percentage.

If ownership details are provided, the sum of all ownership percentages must equal 1.0.

Authorizations:
TenantAPIKey
Request Body schema: application/json
required

Company to be created

legalName
required
string or null <= 255 characters

Legal name

tradeName
required
string or null <= 255 characters

Trade name

incorporationCountry
required
string or null
Enum: "US" "BR"

Incorporation country

businessType
required
string or null

A business type by incorporation country, for:

US [LLC, CORP, INC, PARTNERSHIP, SOLE_PROPRIETORSHIP, NONPROFIT, LLP, PLC, LTD, S_CORP, C_CORP, COOPERATIVE, JOINT_VENTURE, FRANCHISE, ASSOCIATION, TRUST, PRIVATE_COMPANY, PUBLIC_COMPANY, PROFESSIONAL_CORPORATION, BENEFIT_CORPORATION, OTHER]

BR [MEI, ME, EI, EIRELI, EPP, SLU, LTDA, SA, SS, COOPERATIVA, OTHER]

document
required
string or null

A document by incorporation country, for: US [FEIN] / BR [CNPJ]

fein
string or null^\d{2}-\d{7}$
Deprecated

Federal Employer Identification Number (FEIN) in the format of XX-XXXXXXX

phoneNumber
required
string or null^\+[1-9]\d{1,14}$

Phone number in E.164 format

Array of objects or null (account_API_OwnerPayload)

List of the company owners

required
(account_API_AddressInput (object or null)) or (object or null)

Address

required
(account_API_BankAccountInput (object or null)) or (object or null)

Bank account

Responses

Request samples

Content type
application/json
Example
{
  • "legalName": "My Company",
  • "tradeName": "Very cool company",
  • "phoneNumber": "+1123456435",
  • "businessType": "LLC",
  • "fein": "12-3456789",
  • "owners": [
    ],
  • "address": {
    },
  • "bankAccount": {
    }
}

Response samples

Content type
application/json
Example
{
  • "id": "70f77430-98ec-4ea5-a642-c3cef0115ee8",
  • "legalName": "My Company",
  • "tradeName": "Very cool company",
  • "businessType": "LLC",
  • "phoneNumber": "+1123456435",
  • "incorporationCountry": "US",
  • "document": "12-3456789",
  • "fein": "12-3456789",
  • "createdAt": "2024-06-10T14:20:30.08097",
  • "updatedAt": "2024-06-10T14:20:30.08097",
  • "address": {
    },
  • "bankAccount": {
    },
  • "owners": [
    ]
}

List company document types

Authorizations:
TenantAPIKey

Responses

Response samples

Content type
application/json
[
  • "achAuthorizationFormWithAVoidCheckAttached",
  • "additionalAuthorizedLocationsForm",
  • "addressChangeDocument",
  • "agencyCommissionSchedule",
  • "agencyPreApprovalApplication",
  • "agentCheckCashingLicense",
  • "agreementForm",
  • "articlesOfCorporationOrganizationOrPartnershipAgreement",
  • "auditedFinancialStatementsLastTwoYears",
  • "bankAgreementForm",
  • "businessAndLitigationHistory",
  • "businessRegistration",
  • "certificateOfIncorporation",
  • "certificateOfOwnership",
  • "certificateOfResale",
  • "companyOrganizationChart",
  • "completedDueDiligenceForm",
  • "complianceAddendumToAgencyAgreement",
  • "complianceManual",
  • "complianceOfficerAssign",
  • "complianceSurvey",
  • "complianceTrainingAcknowledgement",
  • "complianceTrainingQuiz",
  • "complianceTrainingRenewal",
  • "complianceVisit",
  • "complianceVisit2016",
  • "complianceVisit2016Certificate",
  • "complianceVisit2017",
  • "complianceVisit2019",
  • "complianceVisit2020",
  • "contactList",
  • "contract",
  • "copyOfBusinessLicenseSellersPermit",
  • "copyOfEinIrsLetter",
  • "courtesyVisit2015",
  • "courtesyVisit2016",
  • "creditAndBackgroundCheckReportComplianceOnly",
  • "directDepositAgreement",
  • "equipmentResponsibility",
  • "gmtCertificate",
  • "invoice",
  • "listOfAuthorizedSignatories",
  • "listOfShareholders",
  • "listOfShareholders100PercentOfShares",
  • "monthlyAudit",
  • "mysteryShopping",
  • "negativeNewsSearch",
  • "ofacVerification",
  • "onboardingZip",
  • "other",
  • "pepVerification",
  • "phoneRechargeContract",
  • "photosOfApplicantsStoreFront",
  • "proofOfAddress",
  • "proofOfDbaFiling",
  • "rdcAgreement",
  • "releaseOfLiability",
  • "summaryOfDataProtectionAndCyberSecurityPoliciesAndProcedures",
  • "terminationChecklist",
  • "terminationLetter",
  • "tosAndDisclosuresPlacement",
  • "userComplianceTraining",
  • "usernameAssignmentForm",
  • "validPhotoId",
  • "visitDocumentsDisplay",
  • "visitReport",
  • "voidedCheck",
  • "w9",
  • "wpDeclarationLetter",
  • "wpVideoVerification2019"
]

Update company

Update a company, all fields that are not in payload or null will not be altered

Authorizations:
TenantAPIKey
path Parameters
companyId
required
string or null
Request Body schema: application/json
required

Company to be updated

legalName
string or null <= 255 characters

Legal name

tradeName
string or null <= 255 characters

Trade name

businessType
string or null

A business type by incorporation country, for:

US [LLC, CORP, INC, PARTNERSHIP, SOLE_PROPRIETORSHIP, NONPROFIT, LLP, PLC, LTD, S_CORP, C_CORP, COOPERATIVE, JOINT_VENTURE, FRANCHISE, ASSOCIATION, TRUST, PRIVATE_COMPANY, PUBLIC_COMPANY, PROFESSIONAL_CORPORATION, BENEFIT_CORPORATION, OTHER]

BR [MEI, ME, EI, EIRELI, EPP, SLU, LTDA, SA, SS, COOPERATIVA, OTHER]

document
string or null

A document by incorporation country, for: US [FEIN] / BR [CNPJ]

fein
string or null^\d{2}-\d{7}$
Deprecated

Federal Employer Identification Number (FEIN) in the format of XX-XXXXXXX

phoneNumber
string or null^\+[1-9]\d{1,14}$

Phone number in E.164 format

Responses

Request samples

Content type
application/json
Example
{
  • "tradeName": "Cooler company"
}

Response samples

Content type
application/json
{
  • "id": "68aebdf0-6f81-4bac-8ae5-55a5d38a8dc1",
  • "legalName": "New Company Name",
  • "tradeName": "Cooler company",
  • "businessType": "INC",
  • "phoneNumber": "+1321987654",
  • "fein": "21-3456789",
  • "document": "21-3456789",
  • "incorporationCountry": "US",
  • "address": {
    },
  • "bankAccount": {
    },
  • "owners": [
    ],
  • "createdAt": "2024-02-24T06:17:04.549734",
  • "updatedAt": "2024-02-24T06:17:04.576335"
}

Gets a company by id

Authorizations:
TenantAPIKey
path Parameters
companyId
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "id": "e2e54b03-fa5f-402b-bcac-e09554208225",
  • "legalName": "My Company",
  • "tradeName": "Very cool company",
  • "businessType": "LLC",
  • "phoneNumber": "+1123456435",
  • "fein": "12-3456789",
  • "document": "12-3456789",
  • "incorporationCountry": "US",
  • "address": {
    },
  • "bankAccount": {
    },
  • "owners": [
    ],
  • "createdAt": "2024-02-24T06:17:04.549734",
  • "updatedAt": "2024-02-24T06:17:04.576335"
}

List company documents

Authorizations:
TenantAPIKey
path Parameters
companyId
required
string or null

Responses

Response samples

Content type
application/json
{
  • "documents": [
    ]
}

Upload company document

Upload company document, allowed types:

  • agreementForm
  • businessRegistration
  • businessRegistration
  • certificateOfIncorporation
  • certificateOfResale
  • releaseOfLiability
  • voidedCheck
  • w9
  • ...

Complete list can be obtained in get company document types endpoint

Authorizations:
TenantAPIKey
path Parameters
companyId
required
string or null
type
required
string or null
Request Body schema: multipart/form-data
required
expirationDate
string or null

Formatted as yyyy-MM-dd, must be a future date

file
string or null <binary>

The file to be uploaded

Responses

Response samples

Content type
application/json
{
  • "id": "bc1e5e4c-5ac2-4393-8db9-c8693dca4cc3",
  • "subtype": "businessRegistration",
  • "verificationStatus": "PENDING",
  • "expirationDate": "2031-02-02",
  • "isExpired": false,
  • "isValid": false,
  • "fileName": "deef3416-46f3-4b56-87b3-8501d87d7c44-generic-other.jpg",
  • "documentType": "generic",
  • "createdAt": "2024-07-25T14:06:32.417959"
}

Document Resource

List document verification status history by document id

Authorizations:
TenantAPIKey
path Parameters
documentId
required
string or null

Responses

Response samples

Content type
application/json
Example
{
  • "documentId": "97b8786c-c120-40c2-aff9-eeabd21096f9",
  • "expirationDate": "2031-02-02",
  • "isExpired": false,
  • "isValid": false,
  • "verificationStatus": [
    ]
}

Get current document verification status

Authorizations:
TenantAPIKey
path Parameters
documentId
required
string or null

Responses

Response samples

Content type
application/json
Example
{
  • "documentId": "97b8786c-c120-40c2-aff9-eeabd21096f9",
  • "status": "PENDING",
  • "message": "",
  • "expirationDate": "2031-02-02",
  • "isExpired": false,
  • "isValid": false,
  • "createdAt": "2024-06-19T14:08:31.889101"
}

Participant Resource

Get the participant compliance levels

Get the participant compliance levels. A participant can be either a Person or a Company

Authorizations:
AgentAPIKey
path Parameters
participantId
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "participantId": "93714eaa-2f6b-417c-bce1-5930b8e6a344",
  • "currentComplianceLevel": {
    },
  • "nextComplianceLevel": {
    },
  • "missingFieldsForNextComplianceLevel": [
    ]
}

List participant pending verifications

Authorizations:
AgentAPIKey
path Parameters
participantId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Person Documents Resource

List person documents by status

Authorizations:
TenantAPIKey
path Parameters
personId
required
string
query Parameters
documentSubtype
string or null
documentType
string or null
status
string or null

Responses

Response samples

Content type
application/json
{
  • "documents": [
    ]
}

Upload Document Identification

Upload Document Identification.

Additional Information:

  • Allowed subtypes: nationalId, passport, driversLicense, stateId
  • Expiration date format: yyyy-MM-dd
  • Allowed file types: pdf, png
  • Max file size: 20MB
Authorizations:
TenantAPIKey
path Parameters
personId
required
string or null
subtype
required
string or null
Enum: "nationalId" "passport" "driversLicense" "stateId"

Document subtype

Request Body schema: multipart/form-data
required
issuer
string or null <= 255 characters

Document Issuer

idNumber
string or null

Document Identification number

expirationDate
string or null

Formatted as yyyy-MM-dd, Required for US person

file
string or null <binary>

Responses

Response samples

Content type
application/json
Example
{
  • "id": "5f115bed-8cac-4465-ae3c-45c29238f3ea",
  • "subtype": "nationalId",
  • "verificationStatus": "PENDING",
  • "expirationDate": "2031-02-02",
  • "isExpired": false,
  • "isValid": false,
  • "fileName": "132a1051-24c0-47ba-ae86-ce8d2045de30-documentId-nationalId.png",
  • "documentType": "documentId",
  • "issuer": "CA",
  • "idNumber": "321313",
  • "createdAt": "2024-07-25T14:06:32.417959"
}

Upload Source of funds Document

Upload Source of funds document

Additional information's:

  • Allowed subtypes: savings, bankAccount, settlement, businessSale, houseSale, salary, other
  • Expiration date format: yyyy-MM-dd
  • Allowed file types: pdf, png
  • Max file size: 20MB
Authorizations:
TenantAPIKey
path Parameters
personId
required
string or null
subtype
required
string or null
Enum: "savings" "bankAccount" "settlement" "businessSale" "houseSale" "salary" "other"

Source of funds subtype

Request Body schema: multipart/form-data
required
expirationDate
string or null

Formatted as yyyy-MM-dd, Required for US person

file
string or null <binary>

Responses

Response samples

Content type
application/json
Example
{
  • "id": "5f115bed-8cac-4465-ae3c-45c29238f3ea",
  • "subtype": "savings",
  • "verificationStatus": "PENDING",
  • "expirationDate": "2031-02-02",
  • "isExpired": false,
  • "isValid": false,
  • "fileName": "132a1051-24c0-47ba-ae86-ce8d2045de30-documentId-nationalId.png",
  • "documentType": "sourceOfFunds",
  • "createdAt": "2024-07-25T14:06:32.417959"
}

State Resource

Search cities from state

path Parameters
stateId
required
integer <int32>

The state Id

query Parameters
cityName
required
string
Default: ""

City name to search. Note that case and accents are not ignored.

Responses

Response samples

Content type
application/json
Example
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Funding Account Resource

Register a company's gateway funding account

Register a company's gateway funding account

Authorizations:
AgentAPIKey
path Parameters
companyId
required
string
tenant
required
string
Request Body schema: application/json
required

Gateway company funding account fields to be registered

externalId
required
string or null

External Id

asset
object (payout_API_FundingAccountInputAsset)
Enum: "USD" "BRL" "MXN" "PHP" "INR" "COP"
nickname
string or null

Nickname

Responses

Request samples

Content type
application/json
{
  • "asset": "USD",
  • "nickname": "My USD wallet"
}

Response samples

Content type
application/json
{
  • "id": "45ce1c49-219a-47de-8b85-3c2dbe71922b",
  • "createdAt": "2025-03-31T20:29:44.515044",
  • "asset": "USD",
  • "nickname": "My USD wallet",
  • "walletId": "2e3d1db8-b63d-42df-a103-af62556526e5",
  • "beneficiaryId": "7793dc18-5bf4-4367-9bbf-925aae64dd12",
  • "beneficiaryName": "My Company",
  • "agentId": "03c8e401-cfc6-4e4b-8750-e765058e7129",
  • "agentName": "My Company",
  • "type": "INYO_WALLET",
  • "status": "Pending",
  • "externalId": null,
  • "tenantId": "test",
  • "representative": {
    }
}

Get funding account

Get funding account

Authorizations:
AgentAPIKey
path Parameters
fundingAccountId
required
string

Responses

Response samples

Content type
application/json
{
  • "externalId": "7a7c31e3-50f0-447b-abfe-2c06c3976c88",
  • "id": "29dc45f1-af75-4326-b9e8-837076239a41",
  • "createdAt": "2025-03-31T20:29:42.243942",
  • "asset": "USD",
  • "nickname": "My USD wallet",
  • "walletId": "2e3d1db8-b63d-42df-a103-af62556526e5",
  • "beneficiaryId": "0780e142-065a-42fd-aec4-c570e4e14ef9",
  • "beneficiaryName": "My Company",
  • "agentId": "73851d8e-7773-4aa5-b6d7-bea090618e07",
  • "agentName": "My Company",
  • "type": "INYO_WALLET",
  • "status": "Pending",
  • "tenantId": "test",
  • "representative": {
    }
}

List participant funding accounts

List participant funding accounts

Authorizations:
TenantAPIKey
path Parameters
participantId
required
string
tenant
required
string
query Parameters
page
integer or null <int32>
Default: 0
Examples: page=0

Page number

size
integer or null <int32>
Default: 10
Examples: size=10

Page size

sort
required
object
Examples: sort=createdAt,DESC

Sort by field and order. Each item should be in the format 'field,order' where 'field' is one of ['createdAt'] and 'order' is either ASC or DESC.

type
string or null
Value: "INYO_WALLET"
Examples: type=INYO_WALLET

Funding account type

Responses

Response samples

Content type
application/json
{
  • "total": 2,
  • "size": 2,
  • "page": 0,
  • "numberOfPages": 1,
  • "items": [
    ]
}

Payin Resource

Get payment methods by country

Get payment methods by country

Authorizations:
AgentAPIKey
path Parameters
destinationCountryIso2
required
any
Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "SS" "ES" "LK" "SD" "SR" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"

Country destination in 'ISO 3166-1 alpha-2' format

Responses

Response samples

Content type
application/json
Example
{
  • "paymentMethods": [
    ]
}

Payout Resource

Get recipient account schema by country code

Get recipient account schema by country code (ISO 3166-1 alpha-2)

Authorizations:
AgentAPIKey
path Parameters
sourceCountryIso2
required
string or null

Country ISO 3166-1 alpha-2 code

Responses

Get recipient schema by country code

Get recipient schema by country code (ISO 3166-1 alpha-2)

Authorizations:
AgentAPIKey
path Parameters
sourceCountryIso2
required
string or null

Country ISO 3166-1 alpha-2 code

Responses

Get all available banks in a given country

Get all available banks in a given country

Authorizations:
AgentAPIKey
path Parameters
countryIso2
required
string or null
Examples: BR, MX, CO

Country code iso 2

query Parameters
page
integer or null <int32>
Default: 0
Examples: page=0

Page number

size
integer or null <int32>
Default: 10
Examples: size=10

Page size

Responses

Response samples

Content type
application/json
Example
{
  • "total": 441,
  • "size": 2,
  • "page": 0,
  • "numberOfPages": 45,
  • "items": [
    ]
}

Get all available destination countries from a given source country

Get all available destination countries from a given source country

Authorizations:
AgentAPIKey
path Parameters
sourceCountryIso2
required
any
Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "CV" "KH" "CM" "CA" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "SZ" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MK" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "SS" "ES" "LK" "SD" "SR" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW"

Country source in 'ISO 3166-1 alpha-2' format

Responses

Response samples

Content type
application/json
Example
{
  • "countryDestinations": [
    ]
}

Recipient Account Resource

Register a participant's gateway recipient account

Register a participant's gateway recipient account

Authorizations:
AgentAPIKey
path Parameters
participantId
required
string
Request Body schema: application/json
required

Gateway participant recipient account fields to be registered

externalId
string or null

External Id

asset
required
object (payout_API_RecipientAccountInputAsset)
Enum: "BRL" "MXN" "PHP" "INR" "COP"
nickname
string or null
required
object (payout_API_PayoutMethodPayload)

Payout method payload

Responses

Request samples

Content type
application/json
Example
{
  • "externalId": "45146379-6360-41dc-8ad7-d863983167e4",
  • "asset": "BRL",
  • "payoutMethod": {
    }
}

Response samples

Content type
application/json
{
  • "type": "INYO_BANK_DEPOSIT",
  • "id": "0bbb1313-add5-48f4-980a-487586884e15",
  • "createdAt": "2025-02-03T15:01:04.443806",
  • "asset": "BRL",
  • "countryCode": "BR",
  • "bankCode": "001",
  • "routingNumber": "1234",
  • "accountNumber": "19238123",
  • "accountType": "CHECKING",
  • "nickname": null,
  • "externalId": null,
  • "tenantId": "test",
  • "representative": {
    },
  • "additionalData": null
}

Get recipient account

Get recipient account

Authorizations:
AgentAPIKey
path Parameters
recipientAccountId
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "type": "INYO_BANK_DEPOSIT",
  • "id": "d20c50e9-8150-45c8-a17a-9ee49dfc6f35",
  • "createdAt": "2025-02-03T14:55:33.94861",
  • "asset": "BRL",
  • "countryCode": "BR",
  • "bankCode": "001",
  • "routingNumber": "1234",
  • "accountNumber": "19238123",
  • "accountType": "CHECKING",
  • "nickname": null,
  • "externalId": null,
  • "tenantId": "test",
  • "representative": {
    },
  • "additionalData": null
}

Delete recipient account

Delete recipient account

Authorizations:
AgentAPIKey
path Parameters
recipientAccountId
required
string

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Quote Resource

Request all available quotes "from" currency "to" currency

Request all available quotes "from" currency "to" currency

Authorizations:
AgentAPIKey
path Parameters
fromCurrency
required
string
toCurrency
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "quotes": [
    ]
}

Get quote by id

Get quote by id

Authorizations:
AgentAPIKey
path Parameters
quoteId
required
string or null

Responses

Response samples

Content type
application/json
{
  • "id": "9c80c73d-64b3-4855-9cf9-9fba1f405b0c",
  • "payerId": "36fa52e2-05c8-471d-83b3-e639487636c0",
  • "agentId": "2ec82937-952a-4f13-b3cf-4482e9f128d8",
  • "fromAsset": "USD",
  • "toAsset": "BRL",
  • "rate": 5.9424624,
  • "feeRate": 0,
  • "expireAt": "2025-04-10T15:15:17Z",
  • "createdAt": "2025-04-10T14:45:17.000745Z",
  • "paymentMethodId": "cbd7c578-8326-4a97-a80d-c87c36f1fccd"
}