menu
Note: Api urls , clientid , client sceret ,sample users and default currency can be diffrent. Claim from your technical contact.

API Documnetation

High Level Technical Document
Updated on : 1st October 2018

i: General Account & Service Information

Test User Name apitest@hostname.com
Test Password Password+12345
Scopes USER_FINANCIAL USER_COMPLIANCE USER_REGISTRATION PUBLIC_DATA TRUSTED EXTERNAL_FINANCIAL EXTERNAL_COMPLIANCE2
Authorization Grant Types password client_credentials authorization_code
EndPoint http://testapi.hostname.com:8182
Authorization Server Url http://testapi.hostname.com:8182/PaymixWS_Auth/oauth/token
Resource Server Url http://testapi.hostname.com:8182/PaymixWS_Resource
Client Id Client
Client Secret Client

ii: Allowed HTTPs Requests

  • POST:  Update resource
  • GET:  Get a resource or list of resources

iii: Glossary of Terms

  • KYC:  Know Your Customer
  • CDD:  Customer Due Diligence
  • ATM:  Automated teller machine
  • AUTH:  Authorization

iv: Description of Usual Server Responses

  • 0 OK:  the request was successful
  • 200 OK:  the request was successful
  • 400 Bad Request:  the request could not be understood or was missing required parameters.
  • 401 Unauthorized:  authentication failed or user doesn't have permissions for requested operation.
  • 403 Forbidden:  access denied.
  • 404 Not Found:  resource was not found.
  • 405 Method Not Allowed:  requested method is not supported for resource.

a: Error Messages

  • 101:  MANDATORY_FIELD
  • 102:  INVALID_VALUE_LENGHT
  • 103:  BAD_SIGNATURE
  • 104:  MANDATORY_CUSTOMER_NAME

b: Application Errors

  • 201:  CUSTOMER_NOT_FOUND
  • 202:  CUSTOMER_BAD_CREDENTIALS
  • 203:  MERCHANT_NOT_FOUND
  • 204:  BLOCKED_CUSTOMER
  • 205:  BLOCKED_CUSTOMER_ACCOUNT
  • 206:  CUSTOMER_NOT_ABLE_TO_RECEIVE_OR_SEND_FUNDS
  • 207:  TOKEN_NOT_FOUND
  • 208:  EXPIRED_TOKEN
  • 209:  WRONG_OTP
  • 210:  MERCHANT_NOT_ENABLED
  • 211:  MERCHANT_NOT_ABLE_TO_RECEIVE_OR_SEND_FUNDS
  • 212:  CUSTOMER_INSUFFICIENT_FUNDS
  • 213:  MERCHANT_INSUFFICIENT_FUNDS
  • 214:  DUPLICATE_MERCHANT_TRANSACTION_ID
  • 215:  WRONG_CUSTOMER_NAME
  • 216:  PAYMENT_ALREADY_PROCESSED
  • 217:  TRANSFER_NOT_FOUND
  • 218:  PENDING_PAYMENT
  • 219:  MERCHANT_NOT_CURRENCY
  • 220:  CUSTOMER_NOT_CURRENCY

c: Rest Errors

  • 301:  DATABASE_EXCEPTION
  • 302:  NOT_FOUND_EXCEPTION
  • 303:  NUMBER_FORMAT_EXCEPTION
  • 304:  INVALID_PARAMETER_EXCEPTION
  • 305:  EWALLET_NOT_FOUND
  • 306:  PASSWORD_STRENGTH_EXCEPTION
  • 307:  SMS_EXCEPTION
  • 308:  MULTIPLE_CHANGE_NOT_ALLOWED
  • 999:  UNEXPECTED_ERROR

1: Get Account Summary

Service getCustomerAccountSummary
Method Type GET
Scope EXTERNAL_FINANCIAL
Auth. Grant Type authorization_code, password
Method Url /Cobrander/Account
Full Url http://testapi.hostname.com:8182/PaymixWS_Resource/Cobrander/Account?userName=apitest@hostname.com

Parameters Key Value Parameter Type Description
userName apitest@hostname.com string  

Response
{
"resultCode":0,
"errorMessage":null,
"requestId":0,
"responseId":2410,
"responseBody": [
{
"accountType": "E",
"accountNumber": "195110100001",
"currencyCode": "EUR"
}
]
}

2: Get Customer Balance

Service getCustomerBalance
Method Type GET
Scope EXTERNAL_FINANCIAL
Auth. Grant Type authorization_code, password
Method Url /Cobrander/Account/Balance
Full Url http://testapi.hostname.com:8182/PaymixWS_Resource/Cobrander/Account/Balance?accountNumber=195110100001

Parameters Key Value Parameter Type Description
accountNumber 195110100001 string  

Response
{
"resultCode":0,
"errorMessage":null,
"requestId":0,
"responseId":2411,
"responseBody": [
{
"balance": 883.5,
"availableBalance": 820.5
}
]
}

3: Get Customer Documents

Service getCustomerDocuments
Method Type GET
Scope EXTERNAL_COMPLIANCE2, TRUSTED
Auth. Grant Type password, client_credentials, authorization_code
Method Url /Cobrander/Customer/Document
Full Url http://testapi.hostname.com:8182/PaymixWS_Resource/Cobrander/Customer/Document?userName=apitest@hostname.com

Parameters Key Value Parameter Type Description
userName apitest@hostname.com string  

Response
{
"resultCode":0,
"errorMessage":null,
"requestId":0,
"responseId":2456,
"responseBody": [
{
"documentType": "document_card",
"generic_blob_entity_id":3321
},
{
"documentType": "utility_bill",
"generic_blob_entity_id":3322
}
]
}

4: Get Customer KYC

Service getCustomerKYC
Method Type GET
Scope EXTERNAL_COMPLIANCE2
Auth. Grant Type authorization_code, password
Method Url /Cobrander/Customer/KYC
Full Url http://testapi.hostname.com:8182/PaymixWS_Resource/Cobrander/Customer/KYC?userName=apitest@hostname.com

Parameters Key Value Parameter Type Description
userName apitest@hostname.com string  

Response
{
"resultCode":0,
"errorMessage":null,
"requestId":0,
"responseId":2456,
"responseBody": []
}

5: Get Balance

Service getBalance
Method Type GET
Scope USER_FINANCIAL
Auth. Grant Type authorization_code, password
Method Url /Members/Account/Balance
Full Url http://testapi.hostname.com:8182/PaymixWS_Resource/Members/Account/Balance?accountNumber=195110100001

Parameters Key Value Parameter Type Description
accountNumber 195110100001 string  

Response
{
"resultCode":0,
"errorMessage":null,
"requestId":0,
"responseId":2418,
"responseBody": [
{
"balance": 883.5,
"availableBalance": 820.5
}
]
}

6: Get Account Summary Trusted

Service getAccountSummaryATM
Method Type GET
Scope TRUSTED
Auth. Grant Type client_credentials
Method Url /Members/Account
Full Url http://testapi.hostname.com:8182/PaymixWS_Resource/Members/Account?userName=apitest@hostname.com

Parameters Key Value Parameter Type Description
userName apitest@hostname.com string  

Response
{
"resultCode":0,
"errorMessage":null,
"requestId":0,
"responseId":2419,
"responseBody": [
{
"accountType": "E",
"accountNumber": "195110100001",
"currencyCode": "EUR"
}
]
}

7: Get Account Summary

Service getAccountSummary
Method Type GET
Scope USER_FINANCIAL
Auth. Grant Type authorization_code, password
Method Url /Members/Account
Full Url http://testapi.hostname.com:8182/PaymixWS_Resource/Members/Account

Response
{
"resultCode":0,
"errorMessage":null,
"requestId":0,
"responseId":2420,
"responseBody": [
{
"accountType": "E",
"accountNumber": "195110100001",
"currencyCode": "EUR"
}
]
}

8: Get Account Statement

Service getAccountStatement
Method Type GET
Scope USER_FINANCIAL
Auth. Grant Type authorization_code, password
Method Url /Members/Statement
Full Url http://testapi.hostname.com:8182/PaymixWS_Resource/Members/Statement?accountNumber=195110100001&beginDate=01/09/2018&endDate=30/09/2018

Parameters Key Value Parameter Type Description
accountNumber 195110100001 string  
beginDate 01/09/2018 string  
endDate 30/09/2018 string  

Response
{
"resultCode":0,
"errorMessage":null,
"requestId":0,
"responseId":2422,
"responseBody": [
{
"id": 71105,
"currency": "EUR",
"amount": 15,
"credit": 15,
"debit": 0,
"balance": 100000,
"blockedAmount": 0,
"availableBalance": 100000,
"description": "tstettest",
"date": [
2018,
9,
6,
16,
13,
8,
741000000
]
}
]
}

9: Get Account Statement Trusted

Service getAccountStatementATM
Method Type POST
Scope TRUSTED
Auth. Grant Type client_credentials
Method Url /Members/Statement
Full Url http://testapi.hostname.com:8182/PaymixWS_Resource/Members/Statement?accountNumber=195110100001&beginDate=01/09/2018&endDate=30/09/2018

Parameters Key Value Parameter Type Description
accountNumber 195110100001 string  
beginDate 01/09/2018 string  
endDate 30/09/2018 string  

Response
{
"resultCode":0,
"errorMessage":null,
"requestId":0,
"responseId":2423,
"responseBody": [
{
"id": 71105,
"currency": "EUR",
"amount": 15,
"credit": 15,
"debit": 0,
"balance": 100000,
"blockedAmount": 0,
"availableBalance": 100000,
"description": "tstettest",
"date": [
2018,
9,
6,
16,
13,
8,
741000000
]
}
]
}

10: Send Funds to Merchant

Service sendFundstoMerchant
Method Type POST
Scope USER_FINANCIAL, TRUSTED
Auth. Grant Type password, client_credentials, authorization_code
Method Url /Members/Transfer/Merchant
Full Url http://testapi.hostname.com:8182/PaymixWS_Resource/Members/Transfer/Merchant

Request Body
{
"merchantCode":"PRP_MER",
"customerUserName": "apitest@hostname.com",
"checkCustomerName":false,
"customerName":null,
"amount": "10.00",
"currency": "EUR",
"description": "test",
"merchantCustomerId": "9999996",
"merchantTransactionId": "0001"
}
Response
{
"resultCode":0,
"errorMessage":null,
"requestId":1445,
"responseId":2458,
"responseBody": [
{
"d7d9fcb8-6d8c-4b22-8f62-d3079c78adff"
}
]
}

Note:
User Financial scope customerUserName not necessary.
You have to increment merchantTransactionId for every request.


11: Send Funds to EWallet

Service sendFundstoEWallet
Method Type POST
Scope USER_FINANCIAL, TRUSTED
Auth. Grant Type password, client_credentials, authorization_code
Method Url /Members/Transfer/Ewallet
Full Url http://testapi.hostname.com:8182/PaymixWS_Resource/Members/Transfer/Ewallet

Request Body
{
"sourceEmail": "test1@hostname.com",
"targetEmail": "test2@hostname.com",,
"customerName":null,
"amount": "10.00",
"currency": "EUR",
"description": "test"
}
Response
{
"resultCode":0,
"errorMessage":null,
"requestId":0,
"responseId":2424,
"responseBody": [
{
"date":{
"dayOfWeek": "TUESDAY",
"hour":15,
"month": "OCTOBER",
"year":2018,
"dayOfYear": 282,
"dayOfMonth": 9,
"monthValue": 10,
"nano": 968000000,
"chronology": {
"calendarType": "iso8601",
"id": "ISO"
},
"minute": 54,
"second": 44
},
"amount": "10.00"},
"descirption": "test"},
"creditTransaction": "71249"},
"currency": "EUR"},
"debitTransaction": "71247"},
"requestStatus": "Settled"
}
]
}

12: Get Profile

Service getProfile
Method Type GET
Scope USER_COMPLIANCE
Auth. Grant Type authorization_code, password
Method Url /Members/Profile
Full Url http://testapi.hostname.com:8182/PaymixWS_Resource/Members/Profile

Response
{
"resultCode":0,
"errorMessage": null,
"requestId": 0,
"responseId": 2436,
"responseBody": [
{
"userName": "apitest@hostname.com",
"cid": "PRP",
"otp": null,
"id": 1951,
"email": "apitest@hostname.com",
"password":null,
"mobilePrefix": "MLT",
"mobile": "99119934",
"homePrefix": "MLT",
"phone": null,
"name": "Melik",
"surname": "İİİİİ",
"title": "Dear",
"gender": "N",
"midname": "sadaserw1",
"dateOfBirth": "27-04-1979",
"cityOfBirth": "NON",
"countryOfBirth": {
"isoAlpha3": "NON",
"isoAlpha2": "NO",
"isoNumeric": "000",
"name": "NON",
"notAllowed": false,
"phonePrefix": {
"countryIso": "NON",
"prefix": "000"
}
},
"documentExpireDate": "26-04-2018",
"taxNumber": "1234123421131234",
"taxResidence": {
"isoAlpha3": "NON",
"isoAlpha2": "NO",
"isoNumeric": "000",
"name": "NON",
"notAllowed": false,
"phonePrefix": {
"countryIso": "NON",
"prefix": "000"
}
},
"residentialAddress": {
"id": 3742,
"alias": "Registration",
"address": "malta",
"address2": null,
"city": "msida",
"postCode": null,
"state": null,
"primaryAddress": true,
"country": {
"isoAlpha3": "MLT",
"isoAlpha2": "MT",
"isoNumeric": "470",
"name": "Malta",
"notAllowed": false,
"phonePrefix": {
"countryIso": "MLT",
"prefix": "356"
}
}
},
"preferredAddress": {
"id": null,
"alias": null,
"address": null,
"address2": null,
"city": null,
"postCode": null,
"state": null,
"primaryAddress": false,
"country": null
},
"currentCddLevel": 3,
"askedCddLevel": 3,
"statusCdd": "ACCEPTED",
"documentType": "Identity Card",
"docNumber": "dadadada23rwer",
"productLimit": null,
"productName": "Hostname Consumer eWallet Gold",
"documentCardName": "1(704).png",
"documentBillName": "1(100).png",
"nationality": {
"isoAlpha3": "MLT",
"isoAlpha2": "MT",
"isoNumeric": "470",
"name": "Malta",
"notAllowed": false,
"phonePrefix": {
"countryIso": "MLT",
"prefix": "356"
}
},
"otherNationality": null,
"language": "en",
"securityQuestion_first_name": null,
"securityQuestion_second_name": null,
"securityAnswer_first": null,
"securityAnswer_second": null,
"username": null,
"listQuestionCDD1": [],
"listQuestionCDD2": [],
"listQuestionCDD3": [],
"listQuestion1": [],
"listTermsAndCondition":[],
"listPEP": []
}
]
}

13: Get Customer CDD Details

Service getCustomerCDDDetails
Method Type GET
Scope EXTERNAL_COMPLIANCE2
Auth. Grant Type authorization_code, password
Method Url /Cobrander/Customer/Information
Full Url http://testapi.hostname.com:8182/PaymixWS_Resource/Cobrander/Customer/Information?userName=apitest@hostname.com

Parameters Key Value Parameter Type Description
userName apitest@hostname.com string  

Response
{
"resultCode": 0,
"errorMessage": null,
"requestId": 0,
"responseId": 2470,
"responseBody": [
{
"userName": null,
"cid": "PRP",
"otp": null,
"id":1951,
"email": "apitest@hostname.com",
"password": null,
"mobilePrefix": "MLT",
"mobile": "99119934",
"homePrefix": "MLT",
"phone": null,
"name": "Melik",
"surname": "İİİİİ",
"title": "Mr",
"gender": "N",
"midname": "sadaserw1",
"dateOfBirth": "27-04-1979",
"cityOfBirth": "NON",
"countryOfBirth": {
"isoAlpha3": "NON",
"isoAlpha2": "NO",
"isoNumeric": "000",
"name": "NON",
"notAllowed": false,
"phonePrefix": {
"countryIso": "NON",
"prefix": "000"
}
},
"documentExpireDate": "26-04-2018",
"taxNumber": "1234123421131234",
"taxResidence": {
"isoAlpha3": "NON",
"isoAlpha2": "NO",
"isoNumeric": "000",
"name": "NON",
"notAllowed": false,
"phonePrefix": {
"countryIso": "NON",
"prefix": "000"
}
},
"residentialAddress": {
"id":3742,
"alias": "Registration",
"address": "malta",
"address2": null,
"city": "msida",
"postCode": null,
"state": null,
"primaryAddress": true,
"country": {
"isoAlpha3": "MLT",
"isoAlpha2": "MT",
"isoNumeric": "470",
"name": "Malta",
"notAllowed": false,
"phonePrefix": {
"countryIso": "MLT",
"prefix": "356"
}
}
},
"preferredAddress": {
"id": null,
"alias": null,
"address": null,
"address2": null,
"city": null,
"postCode": null,
"state": null,
"primaryAddress": false,
"country": null
},
"currentCddLevel":3,
"askedCddLevel":3,
"statusCdd": "ACCEPTED",
"documentType": "Identity Card",
"docNumber": "dadadada23rwer",
"productLimit": null,
"productName": "Hostname Consumer eWallet Gold",
"documentCardName": "TestFile.jpg",
"documentBillName": "TestFile.jpg",
"nationality": {
"isoAlpha3": "MLT",
"isoAlpha2": "MT",
"isoNumeric": "470",
"name": "Malta",
"notAllowed": false,
"phonePrefix": {
"countryIso": "MLT",
"prefix": "356"
}
},
"otherNationality": null,
"language": "en",
"securityQuestion_first_name": "If you had chosen your own first name, what would it be?",
"securityQuestion_second_name": "If you were a public figure, who would you be?",
"securityAnswer_first": "sebnem",
"securityAnswer_second": "ABCD1234",
"username": null,
"listQuestionCDD1": [
{
"question": {
"version":1,
"newInstance": false,
"dateAdd": null,
"dateUpdate": null,
"toString": "Occupation",
"id":9,
"priority":1,
"name": "Occupation",
"parentQuestion": null,
"set":150,
"type": "Combo",
"trueAllowed": null,
"falseAllowed": null,
"mandatory": null,
"onlyOnSignup": false,
"key":9,
"text": false,
"checkBox": false,
"radio": false,
"combo": true,
"slider": false,
"comboKey": "com.hostname.common.domain.customer.Question-9",
"comboString": "Occupation"
},
"value": 1,
"name": "Occupation"
},
{
"question": {
"version":1,
"newInstance": false,
"dateAdd": null,
"dateUpdate": null,
"toString": "Main source of income",
"id":13,
"priority":5,
"name": "Main source of income",
"parentQuestion": null,
"set":150,
"type": "Combo",
"trueAllowed": null,
"falseAllowed": null,
"mandatory": null,
"onlyOnSignup": false,
"key":13,
"text": false,
"checkBox": false,
"radio": false,
"combo": true,
"slider": false,
"comboKey": "com.hostname.common.domain.customer.Question-13",
"comboString": "Main source of income"
},
"value": 6,
"name": "Main source of income"
}
],
"listQuestionCDD2": [
{
"question": {
"version":1,
"newInstance": false,
"dateAdd": null,
"dateUpdate": null,
"toString": "Kindly provide the total annual amount of loading you estimate to undertake on the eWallet account being applied for (the amounts are in euro):",
"id":14,
"priority": 1,
"name": "Kindly provide the total annual amount of loading you estimate to undertake on the eWallet account being applied for (the amounts are in euro):",
"parentQuestion": null,
"set":160,
"type": "Combo",
"trueAllowed": null,
"falseAllowed": null,
"mandatory": null,
"onlyOnSignup": false,
"key":14,
"text": false,
"checkBox": false,
"radio": false,
"combo": true,
"slider": false,
"comboKey": "com.hostname.common.domain.customer.Question-14",
"comboString": "Kindly provide the total annual amount of loading you estimate to undertake on the eWallet account being applied for (the amounts are in euro):"
},
"value": null,
"name": "Kindly provide the total annual amount of loading you estimate to undertake on the eWallet account being applied for (the amounts are in euro):"
}
],
"listQuestionCDD3": [
{
"question": {
"version":1,
"newInstance": false,
"dateAdd": null,
"dateUpdate": null,
"toString": "I am not a U.S. citizen or other U.S. person, including a resident alien individual.",
"id":15,
"priority":1,
"name": "I am not a U.S. citizen or other U.S. person, including a resident alien individual.",
"parentQuestion": null,
"set":170,
"type": "Radio",
"trueAllowed": true,
"falseAllowed": true,
"mandatory": null,
"onlyOnSignup": false,
"key": 15,
"text": false,
"checkBox": false,
"radio": true,
"combo": false,
"slider": false,
"comboKey": "com.hostname.common.domain.customer.Question-15",
"comboString": "I am not a U.S. citizen or other U.S. person, including a resident alien individual."
},
"value": true,
"name": "I am not a U.S. citizen or other U.S. person, including a resident alien individual."
},
{
"question": {
"version":1,
"newInstance": false,
"dateAdd": null,
"dateUpdate": null,
"toString": "My personal income is not effectively connected with the conduct of a trade or business in the United States.",
"id":16,
"priority": 2,
"name": "My personal income is not effectively connected with the conduct of a trade or business in the United States.",
"parentQuestion": null,
"set":170,
"type": "Radio",
"trueAllowed": true,
"falseAllowed": true,
"mandatory": null,
"onlyOnSignup": false,
"key":16,
"text": false,
"checkBox": false,
"radio": true,
"combo": false,
"slider": false,
"comboKey": "com.hostname.common.domain.customer.Question-16",
"comboString": "My personal income is not effectively connected with the conduct of a trade or business in the United States."
},
"value": true,
"name": "My personal income is not effectively connected with the conduct of a trade or business in the United States."
},
{
"question": {
"version":1,
"newInstance": false,
"dateAdd": null,
"dateUpdate": null,
"toString": "My personal income is not subject to taxation under an international income tax treaty.",
"id":17,
"priority":3,
"name": "My personal income is not subject to taxation under an international income tax treaty.",
"parentQuestion": null,
"set":170,
"type": "Radio",
"trueAllowed": true,
"falseAllowed": true,
"mandatory": null,
"onlyOnSignup": false,
"key":17,
"text": false,
"checkBox": false,
"radio": true,
"combo": false,
"slider": false,
"comboKey": "com.hostname.common.domain.customer.Question-17",
"comboString": "My personal income is not subject to taxation under an international income tax treaty."
},
"value": true,
"name": "My personal income is not subject to taxation under an international income tax treaty."
},
{
"question": {
"version":1,
"newInstance": false,
"dateAdd": null,
"dateUpdate": null,
"toString": "As part of my verification process, I will choose to load the first funds from a financial institution account held in my name.",
"id":52,
"priority":5,
"name": "As part of my verification process, I will choose to load the first funds from a financial institution account held in my name.",
"parentQuestion": null,
"set":170,
"type": "Radio",
"trueAllowed": true,
"falseAllowed": true,
"mandatory": true,
"onlyOnSignup": true,
"key":52,
"text": false,
"checkBox": false,
"radio": true,
"combo": false,
"slider": false,
"comboKey": "com.hostname.common.domain.customer.Question-52",
"comboString": "As part of my verification process, I will choose to load the first funds from a financial institution account held in my name."
},
"value": true,
"name": "As part of my verification process, I will choose to load the first funds from a financial institution account held in my name."
}
],
"listQuestion1": [
{
"question": {
"version":1,
"newInstance": false,
"dateAdd": null,
"dateUpdate": null,
"toString": "I confirm that the account opening is for sole use and sole interest only.",
"id":1,
"priority":1,
"name": "I confirm that the account opening is for sole use and sole interest only.",
"parentQuestion": null,
"set":100,
"type": "Radio",
"trueAllowed": false,
"falseAllowed": true,
"mandatory": null,
"onlyOnSignup": false,
"key":1,
"text": false,
"checkBox": false,
"radio": true,
"combo": false,
"slider": false,
"comboKey": "com.hostname.common.domain.customer.Question-1",
"comboString": "I confirm that the account opening is for sole use and sole interest only."
},
"value": true,
"name": "I confirm that the account opening is for sole use and sole interest only."
}
],
"listTermsAndCondition": [
{
"question": {
"version":1,
"newInstance": false,
"dateAdd": null,
"dateUpdate": null,
"toString": "the information provided by me is to the best of my knowledge correct",
"id":4,
"priority":1,
"name": "the information provided by me is to the best of my knowledge correct",
"parentQuestion": null,
"set":130,
"type": "Checkbox",
"trueAllowed": true,
"falseAllowed": false,
"mandatory": null,
"onlyOnSignup": false,
"key":4,
"text": false,
"checkBox": true,
"radio": false,
"combo": false,
"slider": false,
"comboKey": "com.hostname.common.domain.customer.Question-4",
"comboString": "the information provided by me is to the best of my knowledge correct"
},
"value": true,
"name": "the information provided by me is to the best of my knowledge correct"
},
{
"question": {
"version":1,
"newInstance": false,
"dateAdd": null,
"dateUpdate": null,
"toString": "I bind myself to inform you immediately of any changes to the information provided",
"id":5,

"priority":2,
"name": "I bind myself to inform you immediately of any changes to the information provided",
"parentQuestion": null,
"set":130,
"type": "Checkbox",
"trueAllowed": true,
"falseAllowed": false,
"mandatory": null,
"onlyOnSignup": false,
"key":5,
"text": false,
"checkBox": true,
"radio": false,
"combo": false,
"slider": false,
"comboKey": "com.hostname.common.domain.customer.Question-5",
"comboString": "I bind myself to inform you immediately of any changes to the information provided"
},
"value": true,
"name": "I bind myself to inform you immediately of any changes to the information provided"
},
{
"question": {
"version":1,
"newInstance": false,
"dateAdd": null,
"dateUpdate": null,
"toString": "I understand that any false declaration or representation or any false documentation provided constitutes a criminal offence.",
"id":6,
"priority":3,
"name": "I understand that any false declaration or representation or any false documentation provided constitutes a criminal offence.",
"parentQuestion": null,
"set":130,
"type": "Checkbox",
"trueAllowed": true,
"falseAllowed": false,
"mandatory": null,
"onlyOnSignup": false,
"key":6,
"text": false,
"checkBox": true,
"radio": false,
"combo": false,
"slider": false,
"comboKey": "com.hostname.common.domain.customer.Question-6",
"comboString": "I understand that any false declaration or representation or any false documentation provided constitutes a criminal offence."
},
"value": true,
"name": "I understand that any false declaration or representation or any false documentation provided constitutes a criminal offence."
},
{
"question": {
"version":1,
"newInstance": false,
"dateAdd": null,
"dateUpdate": null,
"toString": "I accept that the Financial Institution reserve the right to decline this application.",
"id":7,
"priority":4,
"name": "I accept that the Financial Institution reserve the right to decline this application.",
"parentQuestion": null,
"set":130,
"type": "Checkbox",
"trueAllowed": true,
"falseAllowed": false,
"mandatory": null,
"onlyOnSignup": false,
"key":7,
"text": false,
"checkBox": true,
"radio": false,
"combo": false,
"slider": false,
"comboKey": "com.hostname.common.domain.customer.Question-7",
"comboString": "I accept that the Financial Institution reserve the right to decline this application."
},
"value": true,
"name": "I accept that the Financial Institution reserve the right to decline this application."
}
],
"listPEP": [
{
"question": {
"version":1,
"newInstance": false,
"dateAdd": null,
"dateUpdate": null,
"toString": "I declare that neither myself nor any relevant members of my family falls under the definition of Politically Exposed Person (PEP).",
"id":2,
"priority":1,
"name": "I declare that neither myself nor any relevant members of my family falls under the definition of Politically Exposed Person (PEP).",
"parentQuestion": null,
"set":110,
"type": "Radio",
"trueAllowed": true,
"falseAllowed": true,
"mandatory": null,
"onlyOnSignup": false,
"key":2,
"text": false,
"checkBox": false,
"radio": true,
"combo": false,
"slider": false,
"comboKey": "com.hostname.common.domain.customer.Question-2",
"comboString": "I declare that neither myself nor any relevant members of my family falls under the definition of Politically Exposed Person (PEP)."
},
"value": true,
"name": "I declare that neither myself nor any relevant members of my family falls under the definition of Politically Exposed Person (PEP)."
}
]
}
]
}

14: Update Profile

Service updateProfile
Method Type POST
Scope USER_COMPLIANCE, TRUSTED
Auth. Grant Type password, client_credentials, authorization_code
Method Url /Members/Profile
Full Url http://testapi.hostname.com:8182/PaymixWS_Resource/Members/Profile

Request Body
{
"cid": "PRP",
"userName": "apitest@hostname.com",
"language":"en",
"email":"apitest@hostname.com",
"name":"Paga",
"surname":"Tudo",
"midname":"Test",
"title":"Mr",
"gender":"M",
"homePrefix":"MLT",
"mobilePrefix":"MLT",
"mobile":"99119934",
"phone": "99119934",
"dateOfBirth":"12-10-1979",
"cityOfBirth":"malta",
"countryOfBirth":{
"isoAlpha3":"MLT",
"phonePrefix":{
"countryIso":"MLT"
}
},
"docNumber":"12345678",
"documentType":{
"name":"Passport",
"id": 1
},
"documentExpireDate":"12-10-2077",
"taxNumber":"40618888812",
"taxResidence": {
"isoAlpha3":"MLT",
"phonePrefix":{
"countryIso":"MLT"
}
},
"nationality": {
"isoAlpha3":"MLT",
"phonePrefix":{
"countryIso":"MLT"
}
},
"otherNationality": {
"isoAlpha3":"MLT",
"phonePrefix":{
"countryIso":"MLT"
}
},
"documentCountry": {
"isoAlpha3":"MLT",
"phonePrefix":{
"countryIso":"MLT"
}
},
"residentialAddress": {
"address":"aaaaaaa",
"address2":"bbbbb",
"city":"istanbul",
"postCode":"234555",
"state":"sfsdfsd",
"country": {
"isoAlpha3":"MLT",
"phonePrefix":{
"countryIso":"MLT"
}
}
},
"preferredAddress": {
"address":"aaaaaaa",
"address2":"bbbbb",
"city":"istanbul",
"postCode":"234555",
"state":"sfsdfsd",
"country": {
"isoAlpha3":"MLT",
"phonePrefix":{
"countryIso":"MLT"
}
}
}
}

If user does not have middle name, remove the "midname" parameter from the json string in request body
Response
{
"resultCode": 0,
"errorMessage": null,
"requestId": 0,
"responseId": 2488,
"responseBody": null
}

15: Update Profile Question Answer

Service updateProfileQuestionAnswer
Method Type POST
Scope USER_COMPLIANCE, TRUSTED
Auth. Grant Type password, client_credentials, authorization_code
Method Url /Members/Profile/QuestionAnswer
Full Url http://testapi.hostname.com:8182/PaymixWS_Resource/Members/Profile/QuestionAnswer

Request Body
{
"userName":"apitest@hostname.com",
"cid":"PRP"
"answerListQuestion" :[
{
"questionId":"1",
"questionOptionId":"1",
"booleanAnswer":"true",
"stringAnswer":"ok"
},
{
"questionId":"2",
"questionOptionId":"2",
"booleanAnswer":"false",
"stringAnswer":"ok"
}
]
}
Response
{
"resultCode": 0,
"errorMessage": null,
"requestId": 0,
"responseId": 2477,
"responseBody": null
}

16: Upgrade User CDD

Service upgradeProduct
Method Type POST
Scope USER_COMPLIANCE, TRUSTED
Auth. Grant Type password, client_credentials, authorization_code
Method Url /Members/Upgrade
Full Url http://testapi.hostname.com:8182/PaymixWS_Resource/Members/Upgrade

Request Body
{
"cid": "PRP",
"userName": "apitest@hostname.com"
}
Response
{
"resultCode": 0,
"errorMessage": null,
"requestId": 0,
"responseId": 2476,
"responseBody": null
}

17: Get Documents

Service getDocuments
Method Type GET
Scope USER_COMPLIANCE, TRUSTED
Auth. Grant Type password, client_credentials, authorization_code
Method Url /Members/Document/Info
Full Url http://testapi.hostname.com:8182/PaymixWS_Resource/Members/Document/Info?userName=apitest@hostname.com

Parameters Key Value Parameter Type Description
userName apitest@hostname.com string  

Response
{
"resultCode": 0,
"errorMessage": null,
"requestId": 0,
"responseId": 2439,
"responseBody": [
{
"documentType": "document_card",
"generic_blob_entity_id": 3246
},
{
"documentType": "document_card",
"generic_blob_entity_id": 3247
},
{
"documentType": "document_card",
"generic_blob_entity_id": 3248
},
{
"documentType": "document_card",
"generic_blob_entity_id": 3249
},
{
"documentType": "utility_bill",
"generic_blob_entity_id": 3250
},
{
"documentType": "utility_bill",
"generic_blob_entity_id": 3251
}
]
}

18: Update Security Questions

Service updateSecurity
Method Type POST
Scope USER_COMPLIANCE, TRUSTED
Auth. Grant Type password, client_credentials, authorization_code
Method Url /Members/UpdateSecurity
Full Url http://testapi.hostname.com:8182/PaymixWS_Resource/Members/UpdateSecurity

Request Body
{
"newPassord" : "Password+123456",
"username":"apitest@hostname.com",
"firstSecurityQuestionId": "2",
"firstSecurityQuestionAnswer": "any answer 2",
"secondSecurityQuestionId": "3",
"secondSecurityQuestionAnswer": "any answer 3"
}
Response
{
"resultCode": 0,
"errorMessage": null,
"requestId": 0,
"responseId": 2490,
"responseBody": null
}

19: Forgot Password

Service forgotPassword
Method Type POST, GET
Scope USER_COMPLIANCE, USER_REGISTRATION, TRUSTED
Auth. Grant Type password, client_credentials, authorization_code
Method Url /Members/Password
Full Url http://testapi.hostname.com:8182/PaymixWS_Resource/Members/Password

Request Body
{
"username" : "apitest@hostname.com"
}
Response
{
"resultCode": 200,
"errorMessage": null,
"requestId": 0,
"responseId": 0,
"responseBody": null
}

20: Sign Up

Service signup
Method Type POST
Scope USER_REGISTRATION
Auth. Grant Type client_credentials
Method Url /Members/Signup
Full Url http://testapi.hostname.com:8182/PaymixWS_Resource/Members/Signup?lang=en

Parameters Key Value Parameter Type Description
lang en string  

Request Body
{
"password" : "Hostname!123456",
"repeatPassword" : "Hostname!123456" ,
"consumer" : {
"name" :"Test Hostname" ,
"surname" : "Test Hostname",
"mobilePrefix": {
"countryIso": "MLT",
"prefix" : "356"
},
"mobileNumber" : "99070071",
"email" : "hostname@mailinator.com"
},
"consumerResidentialAddress" : {
"country" : {
"isoAlpha3" : "MLT"
}
}
}
Response
{
"resultCode": 200,
"errorMessage": null,
"requestId": 0,
"responseId": 0,
"responseBody": null
}

21: Change Password

Service changePassword
Method Type POST
Scope USER_COMPLIANCE
Auth. Grant Type authorization_code, password
Method Url /Members/ChangePassword
Full Url http://testapi.hostname.com:8182/PaymixWS_Resource/Members/ChangePassword

Request Body
{
"password" : "Password+12345",
"newPassword" : "Password+123456"
}
Response
{
"resultCode": 0,
"errorMessage": null,
"requestId": 0,
"responseId": 2480,
"responseBody": null
}

22: Send Document

Service sendDocuments
Method Type POST
Scope USER_COMPLIANCE, TRUSTED
Auth. Grant Type client_credentials, password
Method Url /Members/Document
Full Url http://testapi.hostname.com:8182/PaymixWS_Resource/Members/Document

Request Body
{
"documentType": "image/jpeg", ,
"username": "apitest@hostname.com", ,
"file":"/tmp/client-id-proof.jpg"
}
Response
{
"resultCode": 0,
"errorMessage": null,
"requestId": 0,
"responseId": 2654,
"responseBody": null
}

23: Send Funds To Customer

Service sendFundstoCustomer
Method Type POST
Scope EXTERNAL_FINANCIAL
Auth. Grant Type client_credentials password authorization_code
Method Url /Cobrander/Transfer/Customer
Full Url http://testapi.hostname.com:8182/PaymixWS_Resource/Cobrander/Transfer/Customer

Request Body
{
"merchantCode": "PRP_MER",
"customerUserName": "apitest@hostname.com",
"checkCustomerName": false,
"amount": "10.00",
"currency": "EUR",
"description": "test",
"merchantCustomerId": "9999996",
"merchantTransactionId": "0001"
}
Response
{
"resultCode": 0,
"errorMessage": null,
"requestId": 1445,
"responseId": 2458,
"responseBody": [
"d7d9fcb8-6d8c-4b22-8f62-d3079c78adff"
]
}

24: Get Metadata Service

Service getMetadata
Method Type GET
Scope PUBLIC_DATA
Auth. Grant Type client_credentials password authorization_code
Method Url /Members/Metadata?lang=en&name=securityQuestion
Full Url http://testapi.hostname.com:8182/PaymixWS_Resource/Cobrander/Transfer/Customer

Parameters Key Value Parameter Type Description
lang en string Language ISO Code(en,es,tr,pt,ru)
name documentType
securityQuestion
companyType
companyActivity
companySubActivity
string  

Response
{
"resultCode": 200,
"errorMessage": null,
"requestId": 0,
"responseId": 0,
"responseBody": [
{
"name": "Where were you when you first heard about 9/11?",
"id": 2
},
{
"name": "If you had chosen your own first name, what would it be?",
"id": 3
},
{
"name": "Where were you New Year's 2000?",
"id": 4
},
{
"name": "If you were a public figure, who would you be?",
"id": 5
},
{
"name": "Where did you spend the honeymoon of your first marriage?",
"id": 6
},
{
"name": "What is the make and model of your first car?",
"id": 7
},
{
"name": "What was your childhood dream job?",
"id": 8
},
{
"name": "What was your favourite subject at school?",
"id": 9
}
]
}