Download OpenAPI specification:Download
Url: https://api.paytrim.com/Sandbox/
CompanyIds to use in sandbox 5560572850, 8904062380, 5566808134, 5590672613
We use the 'Bearer Token' for authentication. Include the token in the header as 'Bearer
The access token will be provided by Paytrim in your onboarding process.
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.
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> |
feeBillingType required | string (FeeBillingType) Enum: "Daily" "Monthly" |
bindingDate | string or null <date-time> |
required | Array of objects (Store) |
{- "companyId": "string",
- "email": "user@example.com",
- "phone": "string",
- "signatories": [
- {
- "nationalId": "string",
- "email": "user@example.com",
- "phone": "string"
}
], - "externalAgreementNumber": "string",
- "signedDate": "2019-08-24T14:15:22Z",
- "priceListId": "19ba5d98-cd5e-43ca-bca6-332c7d2ccedc",
- "feeBillingType": "Daily",
- "bindingDate": "2019-08-24T14:15:22Z",
- "stores": [
- {
- "name": "string",
- "address": {
- "street": "string",
- "city": "string",
- "zipCode": "string"
}, - "openingHours": [
- {
- "day": "Sunday",
- "open": "15:00:00",
- "close": "15:00:00"
}
], - "seasonalVariation": true,
- "averageValuePerTransaction": "KR_0_1000",
- "averageMonthlyRevenue": "KR_0_10000",
- "mcc": "Grocery_stores_Supermarkets"
}
]
}
{- "type": "string",
- "title": "string",
- "status": 0,
- "errors": {
- "fieldName": [
- "string"
]
}, - "traceId": "string"
}
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.
companyId required | string The national id of the company using the format 555555xxxx or 934344334 |
{- "name": "string",
- "status": "Prospect",
- "onboardingStatus": "Manual_Handling",
- "bankAccountStatus": "Unknown",
- "beneficialOwners": [
- {
- "name": "string",
- "nationalId": "string",
- "status": "Unknown"
}
]
}
{- "name": "string",
- "status": "Prospect",
- "onboardingStatus": "Manual_Handling",
- "bankAccountStatus": "Unknown",
- "beneficialOwners": [
- {
- "name": "string",
- "nationalId": "string",
- "status": "Unknown"
}
]
}
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
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> |
feeBillingType required | string (FeeBillingType) Enum: "Daily" "Monthly" |
bindingDate | string or null <date-time> |
required | Array of objects (Store) |
{- "companyId": "string",
- "email": "user@example.com",
- "phone": "string",
- "signatories": [
- {
- "nationalId": "string",
- "email": "user@example.com",
- "phone": "string"
}
], - "externalAgreementNumber": "string",
- "signedDate": "2019-08-24T14:15:22Z",
- "priceListId": "19ba5d98-cd5e-43ca-bca6-332c7d2ccedc",
- "feeBillingType": "Daily",
- "bindingDate": "2019-08-24T14:15:22Z",
- "stores": [
- {
- "name": "string",
- "address": {
- "street": "string",
- "city": "string",
- "zipCode": "string"
}, - "openingHours": [
- {
- "day": "Sunday",
- "open": "15:00:00",
- "close": "15:00:00"
}
], - "seasonalVariation": true,
- "averageValuePerTransaction": "KR_0_1000",
- "averageMonthlyRevenue": "KR_0_10000",
- "mcc": "Grocery_stores_Supermarkets"
}
]
}
{- "type": "string",
- "title": "string",
- "status": 0,
- "errors": {
- "fieldName": [
- "string"
]
}, - "traceId": "string"
}
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
companyId required | string The national id of the company using the format 555555xxxx or 934344334 |
{- "name": "string",
- "status": "Prospect",
- "onboardingStatus": "Manual_Handling",
- "bankAccountStatus": "Unknown",
- "beneficialOwners": [
- {
- "name": "string",
- "nationalId": "string",
- "status": "Unknown"
}
]
}
{- "name": "string",
- "status": "Prospect",
- "onboardingStatus": "Manual_Handling",
- "bankAccountStatus": "Unknown",
- "beneficialOwners": [
- {
- "name": "string",
- "nationalId": "string",
- "status": "Unknown"
}
]
}
Returns detailed information about a merchant. Like name, address, stores, terminals, account etc. Use CompanyIds 5560572850, 8904062380, 5566808134
companyId required | string The company id. Must be 10 digits. Example: '5560572850' |
{- "legalEntityUniqueId": "6654f596-6584-4f1c-ad52-cf2619db6aec",
- "legalEntityName": "string",
- "legalEntityNationalId": "string",
- "stores": [
- {
- "storeUniqueId": "c2b6def9-3430-408d-a279-0974ab15d713",
- "storeName": "string",
- "storeMerchantId": "string",
- "storeAccountId": "99a95013-e9db-47e7-b335-0a4feb67ca21",
- "storeStatus": "Active",
- "terminals": [
- {
- "terminalUniqueId": "7447b625-2fdd-44c3-bf73-0c6751573c91",
- "terminalName": "string",
- "terminalId": "string",
- "terminalStatus": "Unknown"
}
]
}
]
}
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. Use CompanyIds 5560572850, 8904062380, 5566808134
companyId required | string The company id. Must be 10 digits. Example: '5560572850' |
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' |
{- "cardTransactions": [
- {
- "cardTransactionUniqueId": "bbfd5c41-4234-4458-a987-ba274620e5fe",
- "inputType": "IC",
- "processStatus": "AUTHORIZED",
- "lastProcessDateAndTime": "2019-08-24T14:15:22Z",
- "booked": true,
- "bookedFee": true,
- "cardTransactionTypeName": "Purchase",
- "amountFactor": 0,
- "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
- "storeMerchantId": "string",
- "storeUniqueId": "c2b6def9-3430-408d-a279-0974ab15d713",
- "terminalId": "string",
- "retrievalReferenceNumber": "string",
- "transactionDate": "2019-08-24T14:15:22Z",
- "netAmount": 0,
- "interchangeFeeAmount": 0,
- "networkTotalFeeAmount": 0,
- "paytrimTotalFeeAmount": 0,
- "processorFeeAmount": 0,
- "grossAmount": 0
}
]
}
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. Use CompanyIds 5560572850, 8904062380, 5566808134
companyId required | string The company id. Must be 10 digits. Example: '5560572850' |
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' |
{- "accountTransactions": [
- {
- "accountTransactionUniqueId": "4c5dcbe3-8d7a-4d39-9734-d1026f8adaa9",
- "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
- "accountTransactionTypeName": "Purchase",
- "created": "2019-08-24T14:15:22Z",
- "amount": 0,
- "payoutReference": "string"
}
]
}
Returns detailed information about a merchant. Like name, address, stores, terminals, account etc.
companyId required | string The company id. Must be 10 digits. Example: '5555551111' |
{- "legalEntityUniqueId": "6654f596-6584-4f1c-ad52-cf2619db6aec",
- "legalEntityName": "string",
- "legalEntityNationalId": "string",
- "stores": [
- {
- "storeUniqueId": "c2b6def9-3430-408d-a279-0974ab15d713",
- "storeName": "string",
- "storeMerchantId": "string",
- "storeAccountId": "99a95013-e9db-47e7-b335-0a4feb67ca21",
- "storeStatus": "Active",
- "terminals": [
- {
- "terminalUniqueId": "7447b625-2fdd-44c3-bf73-0c6751573c91",
- "terminalName": "string",
- "terminalId": "string",
- "terminalStatus": "Unknown"
}
]
}
]
}
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.
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' |
{- "cardTransactions": [
- {
- "cardTransactionUniqueId": "bbfd5c41-4234-4458-a987-ba274620e5fe",
- "inputType": "IC",
- "processStatus": "AUTHORIZED",
- "lastProcessDateAndTime": "2019-08-24T14:15:22Z",
- "booked": true,
- "bookedFee": true,
- "cardTransactionTypeName": "Purchase",
- "amountFactor": 0,
- "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
- "storeMerchantId": "string",
- "storeUniqueId": "c2b6def9-3430-408d-a279-0974ab15d713",
- "terminalId": "string",
- "retrievalReferenceNumber": "string",
- "transactionDate": "2019-08-24T14:15:22Z",
- "netAmount": 0,
- "interchangeFeeAmount": 0,
- "networkTotalFeeAmount": 0,
- "paytrimTotalFeeAmount": 0,
- "processorFeeAmount": 0,
- "grossAmount": 0
}
]
}
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.
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' |
{- "accountTransactions": [
- {
- "accountTransactionUniqueId": "4c5dcbe3-8d7a-4d39-9734-d1026f8adaa9",
- "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
- "accountTransactionTypeName": "Purchase",
- "created": "2019-08-24T14:15:22Z",
- "amount": 0,
- "payoutReference": "string"
}
]
}