Jump to Content

Guides API Reference Discussions

Home Guides API Reference Changelog Discussions

Guides API Reference Discussions Log In

API Reference

Payment Service v3

Overview
Authentication
Error Handling
Payment Redirection Service v3
- getRedirectDatapost
- getPaymentspost
Payment Service Listener v3
- handlePaymentStateChangedNotificationpost
- handlePaymentAccountChangedNotificationpost
Payment Service v3 (Backend)
Complex Types
Simple Types

Payment Service v4

Overview
Validations and IPv6
/tokens
- Returns a new token for a given set of dataget
/merchants/{mid}/users/{uid}
- Registers a new user or update an existing userpost
/merchants/{mid}/users/{uid}/anonymizeUser
- Anonymizes user data and payment data for the given userpost
/merchants/{mid}/users/{uid}/accounts/{paid}
/merchants/{mid}/users/{uid}/accounts
- Gets multiple payment accountsget
/merchants/{mid}
- Gets a merchant for a given merchantIdget

Payment Service v5

Overview
/userEnrollments
- Registers a new user at a payment provider or updates an existing user registrationpost
/userEnrollments/{enrollmentId}/operations
- Update User Enrollment Operationpost

Payment Service v6 - Merchant Onboarding

Overview
/merchants
- Registers a new merchant.post
- Returns a list of merchants for a specific partner.get
/merchants/{merchantId}
- Returns a single merchant's data.get
/shops
- Registers a new shop related to a merchant.post
- Returns a list of shops for the specified merchant.get
/shops/{shopId}
- Returns a single shop's data.get
/related-people
- Registers a new person related to a merchant.post
- Returns a list of persons for the specified merchant.get
/related-people/{relatedPersonId}
- Returns a single related person's data.get
/related-companies
- Registers a new company related to a merchant.post
- Returns a list of companies for the specified merchant.get
/related-companies/{relatedCompanyId}
- Returns a single related company's data.get
/bank-accounts
- Registers a new bank account related to a merchant.post
- Returns a list of bank accounts for the specified merchant.get
/bank-accounts/{bankAccountId}
- Returns a single bank account's data.get
/documents
- Uploads a new document.post
/documents/{documentId}
- Returns a single document's data.get
/entity-required-documents
- Returns a list of entities with missing and assigned documents.get
/questions
- Returns a list of all required questions with text and scope.get
/questions/{questionId}
- Returns a single question with text and scope.get
/prescreen-merchants
- Uploads merchant and shop related details used for pre-screening.post
/prescreen-merchants/{preScreenMerchantId}
- Returns the result of a prescreen-merchant check.get

Payment Service v6 - Event Notifications

Overview
/events
- Handles event notifications sent by the PXP system.post

Powered by

Payment Service v3

Overview
Authentication
Error Handling
Payment Redirection Service v3
- getRedirectDatapost
- getPaymentspost
Payment Service Listener v3
- handlePaymentStateChangedNotificationpost
- handlePaymentAccountChangedNotificationpost
Payment Service v3 (Backend)
Complex Types
Simple Types

Payment Service v4

Overview
Validations and IPv6
/tokens
- Returns a new token for a given set of dataget
/merchants/{mid}/users/{uid}
- Registers a new user or update an existing userpost
/merchants/{mid}/users/{uid}/anonymizeUser
- Anonymizes user data and payment data for the given userpost
/merchants/{mid}/users/{uid}/accounts/{paid}
/merchants/{mid}/users/{uid}/accounts
- Gets multiple payment accountsget
/merchants/{mid}
- Gets a merchant for a given merchantIdget

Payment Service v5

Overview
/userEnrollments
- Registers a new user at a payment provider or updates an existing user registrationpost
/userEnrollments/{enrollmentId}/operations
- Update User Enrollment Operationpost

Payment Service v6 - Merchant Onboarding

Overview
/merchants
- Registers a new merchant.post
- Returns a list of merchants for a specific partner.get
/merchants/{merchantId}
- Returns a single merchant's data.get
/shops
- Registers a new shop related to a merchant.post
- Returns a list of shops for the specified merchant.get
/shops/{shopId}
- Returns a single shop's data.get
/related-people
- Registers a new person related to a merchant.post
- Returns a list of persons for the specified merchant.get
/related-people/{relatedPersonId}
- Returns a single related person's data.get
/related-companies
- Registers a new company related to a merchant.post
- Returns a list of companies for the specified merchant.get
/related-companies/{relatedCompanyId}
- Returns a single related company's data.get
/bank-accounts
- Registers a new bank account related to a merchant.post
- Returns a list of bank accounts for the specified merchant.get
/bank-accounts/{bankAccountId}
- Returns a single bank account's data.get
/documents
- Uploads a new document.post
/documents/{documentId}
- Returns a single document's data.get
/entity-required-documents
- Returns a list of entities with missing and assigned documents.get
/questions
- Returns a list of all required questions with text and scope.get
/questions/{questionId}
- Returns a single question with text and scope.get
/prescreen-merchants
- Uploads merchant and shop related details used for pre-screening.post
/prescreen-merchants/{preScreenMerchantId}
- Returns the result of a prescreen-merchant check.get

Payment Service v6 - Event Notifications

Overview
/events
- Handles event notifications sent by the PXP system.post

Powered by

Gets a merchant for a given merchantId

get https://api.test.kalixa.com/api/v4/merchants/{mid}

Gets a merchant for a given merchantId

Language

Click Try It! to start a request and see the response here!