API docs by Redocly

ExternalApi (v1)

Download OpenAPI specification:Download

Paytrim API Service

This API provides you, our partner, the capability to:

  • Initiate the onboarding process for a merchant
  • Verify the current status of the merchant's onboarding
  • Retrieve detailed information about a merchant and its structure, like stores, terminals and accounts
  • Retrieve a merchant's card transaction history
  • Access a merchant's account transaction history

Sandbox Environment

Url: https://partner-portal.paytopus.net/swagger

Authentication

We use the 'Bearer Token' for authentication. Include the token in the header as 'Bearer '. Treat your token as sensitive data and secure it appropriately.

How to get access

The access token will be provided by Paytrim in your onboarding process.

Onboarding

Onboard a new merchant with stores

This initiates the onboarding process for a new merchant along with their stores. If the request is accepted, an HTTP 202 (Accepted) response is returned. Since the onboarding process is asynchronous, the onboarding status can be verified through the status endpoint.

Authorizations:
Bearer
Request Body schema: application/json
required
companyId
required
string non-empty
email
required
string <email> non-empty
phone
required
string non-empty
required
Array of objects (Person)
externalAgreementNumber
required
string non-empty
signedDate
required
string <date-time>
priceListId
required
string <uuid>
required
Array of objects (Store)

Responses

Request samples

Content type
application/json
{
  • "companyId": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "signatories": [
    ],
  • "externalAgreementNumber": "string",
  • "signedDate": "2019-08-24T14:15:22Z",
  • "priceListId": "19ba5d98-cd5e-43ca-bca6-332c7d2ccedc",
  • "stores": [
    ]
}

Merchant onboarding status

This returns the status of each onboarding step required for activating a merchant. It includes statuses for: the overall condition of the legal entity, bank account, and beneficial owner.

Authorizations:
Bearer
path Parameters
companyId
required
string

The national id of the company using the format 555555xxxx or 934344334

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "status": "Prospect",
  • "bankAccountStatus": "Unknown",
  • "beneficialOwners": [
    ]
}

SandboxOnboarding

Onboard a new merchant with stores

This initiates the onboarding process for a new merchant along with their stores. If the request is accepted, an HTTP 202 (Accepted) response is returned. Since the onboarding process is asynchronous, the onboarding status can be verified through the status endpoint.

Use CompanyId 5560572850 OK, 8904062380 Already Exist, 5566808134 Signatories Missing ,5590672613 NotFound

Authorizations:
Bearer
Request Body schema: application/json
required
companyId
required
string non-empty
email
required
string <email> non-empty
phone
required
string non-empty
required
Array of objects (Person)
externalAgreementNumber
required
string non-empty
signedDate
required
string <date-time>
priceListId
required
string <uuid>
required
Array of objects (Store)

Responses

Request samples

Content type
application/json
{
  • "companyId": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "signatories": [
    ],
  • "externalAgreementNumber": "string",
  • "signedDate": "2019-08-24T14:15:22Z",
  • "priceListId": "19ba5d98-cd5e-43ca-bca6-332c7d2ccedc",
  • "stores": [
    ]
}

Merchant onboarding status

This returns the status of each onboarding step required for activating a merchant. It includes statuses for: the overall condition of the legal entity, bank account, and beneficial owner.

Use CompanyId 5560572850 Pending, 8904062380 No BeneficialOwners, 5566808134 OK ,5590672613 NotFound

Authorizations:
Bearer
path Parameters
companyId
required
string

The national id of the company using the format 555555xxxx or 934344334

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "status": "Prospect",
  • "bankAccountStatus": "Unknown",
  • "beneficialOwners": [
    ]
}

SandboxTransactions

Merchant information

Returns detailed information about a merchant. Like name, address, stores, terminals, account etc.

Authorizations:
Bearer
path Parameters
companyId
required
string

The company id. Must be 10 digits. Example: '5555551111'

Responses

Response samples

Content type
application/json
{
  • "legalEntityUniqueId": "6654f596-6584-4f1c-ad52-cf2619db6aec",
  • "legalEntityName": "string",
  • "legalEntityNationalId": "string",
  • "stores": [
    ]
}

Merchant Card transaction history

Returns a list of a merchant's card transactions between two dates. Card transactions are the transactions that are made at the merchant's card terminals. For example purchases, refunds, etc.

Authorizations:
Bearer
path Parameters
companyId
required
string

The company id. Must be 10 digits. Example: '5555551111'

fromDateTime
required
string

The start date formatted like: '2021-01-01' or '2021-01-01 00:00:00'

toDateTime
required
string

The end date formatted like: '2021-01-01' or '2021-01-01 00:00:00'

Responses

Response samples

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

Merchant Account Transaction History

Returns a list of a merchant's account transactions between two dates. Account transactions are the transactions that are made on the merchant's account. For example aggregated purchases, refunds, daily fees, monthly fees, etc.

Authorizations:
Bearer
path Parameters
companyId
required
string

The company id. Must be 10 digits. Example: '5555551111'

fromDateTime
required
string

The start date formatted like: '2021-01-01' or '2021-01-01 00:00:00'

toDateTime
required
string

The end date formatted like: '2021-01-01' or '2021-01-01 00:00:00'

Responses

Response samples

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

Transactions

Merchant information

Returns detailed information about a merchant. Like name, address, stores, terminals, account etc.

Authorizations:
Bearer
path Parameters
companyId
required
string

The company id. Must be 10 digits. Example: '5555551111'

Responses

Response samples

Content type
application/json
{
  • "legalEntityUniqueId": "6654f596-6584-4f1c-ad52-cf2619db6aec",
  • "legalEntityName": "string",
  • "legalEntityNationalId": "string",
  • "stores": [
    ]
}

Merchant Card transaction history

Returns a list of a merchant's card transactions between two dates. Card transactions are the transactions that are made at the merchant's card terminals. For example purchases, refunds, etc.

Authorizations:
Bearer
path Parameters
companyId
required
string

The company id. Must be 10 digits. Example: '5555551111'

fromDateTime
required
string

The start date formatted like: '2021-01-01' or '2021-01-01 00:00:00'

toDateTime
required
string

The end date formatted like: '2021-01-01' or '2021-01-01 00:00:00'

Responses

Response samples

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

Merchant Account Transaction History

Returns a list of a merchant's account transactions between two dates. Account transactions are the transactions that are made on the merchant's account. For example aggregated purchases, refunds, daily fees, monthly fees, etc.

Authorizations:
Bearer
path Parameters
companyId
required
string

The company id. Must be 10 digits. Example: '5555551111'

fromDateTime
required
string

The start date formatted like: '2021-01-01' or '2021-01-01 00:00:00'

toDateTime
required
string

The end date formatted like: '2021-01-01' or '2021-01-01 00:00:00'

Responses

Response samples

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