Person-To-Person (P2P) Payee
| Name | Description | Introduced In |
|---|---|---|
| createP2PPayee | This API creates and stores a P2P payee for an authorized user | 2020.04 |
| deleteP2PPayee | This API deletes the P2P payee based on the ID provided by the authorized logged in user. | 2020.04 |
| editP2PPayee | This API edits the P2P payee for an authorized user. | 2020.04 |
| updateP2PPayee | This API updates P2P Payee by changing nickname. | 2021.10 |
| P2PTransferDelete | This API Cancel transfer/ stop recurring transfer to P2P payee. | 2021.10 |
| getP2PPayees | This API retrieves all the P2P Payee details. | 2020.04 |
| getTransfers | This API fetch the recipient activity. | 2021.07 |
| updateTransfer | This API updates the transfer details. | 2021.07 |
| createTransfer | This API can create transfer/ setup recurring transfer/ Repeat transfer/ amend recurring transfer to P2P payee | 2021.10 |
| Object Data Models | This Object Data Model describes the parameter name and other attribute details for P2P Payee. |
| Description: | This API creates and stores a P2P payee for an authorized user |
| Method: | POST |
| URL: | {base_url}/services/data/v1/DigitalTransfer /operations/Payee_P2P/createP2PPayee |
| Security Level: | Authenticated App Users |
| Header Request: |
X-Kony-Authorization |
| Body Request: |
Parameters name (Mandatory) Specifies the name typed by the user on the screen. nickName (Mandatory) Specifies the nick name typed by the user on the screen. phone (Mandatory) Specifies the phone number typed by the user on the screen. email (Mandatory) Specifies the email ID typed by the user on the screen. nationalID (Mandatory) Specifies the unique nationalID. primaryContactForSending (Mandatory) Specifies either the phone number or email ID that the user has set as primary. contractId (Mandatory) Specifies the unique contractId. coreCustomerId (Mandatory) Specifies the unique coreCustomerId. {
"name": "payee",
"nickName": "",
"phone": "",
"email": "ghj@gmail.com",
"nationalID": "",
"primaryContactForSending": "ghj@gmail.com",
"cif": "[{\"contractId\":\"6803408029\",\"coreCustomerId\":\"666666\"}]”
}
|
| Response: |
Parameters PayPersonId Specifies the unique ID of the P2P payee that gets created. {
"PayPersonId": "08116916",
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): |
|
| Enterprise Provider: | Temenos Digital |
| Enterprise API: |
{base_url}/services/dbpPayeeServices/createP2PPayee |
Field Mapping
|
UI API field |
Experience API field |
MS API field |
Transact API field |
|---|---|---|---|
|
PayPersonId |
PayPersonId |
NA |
NA |
|
name |
name |
NA |
NA |
|
|
|
NA |
NA |
|
primaryContactForSending |
primaryContactForSending |
NA |
NA |
|
contractId |
contractId |
NA |
NA |
|
coreCustomerId |
coreCustomerId |
NA |
NA |
| Description: | This API deletes the P2P payee based on the ID provided by the authorized logged in user. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/DigitalTransfer /operations/Payee_P2P/deleteP2PPayee |
| Security Level: | Authenticated App Users |
| Header Request: |
X-Kony-Authorization |
| Body Request: |
Parameters PayPersonId Specifies the unique ID of the payee that must be deleted. {
"PayPersonId": "56509742"
}
|
| Response: |
Parameters PayPersonId Specifies the unique ID of the P2P payee. {
"PayPersonId": "56509742",
"deletedRecords": 1,
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): |
|
| Enterprise Provider: | Temenos Digital |
| Enterprise API: |
{base_url}/services/dbpPayeeServices/deleteP2PPayee |
Field Mapping
|
UI API field |
Experience API field |
MS API field |
Transact API field |
|---|---|---|---|
|
PayPersonId |
amount |
NA |
NA |
|
deletedRecords |
amountTransferedTillNow |
NA |
NA |
| Description: | Edits the P2P payee for an authorized user. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/DigitalTransfer /operations/Payee_P2P/editP2PPayee |
| Security Level: | Authenticated App Users |
| Header Request: |
X-Kony-Authorization |
| Body Request: |
Parameters name Specifies the name typed by the user on the screen. nickName Specifies the nick name typed by the user on the screen. phone Specifies the phone number typed by the user on the screen. Specifies the email ID typed by the user on the screen. primaryContactForSending Specifies either the phone number or email ID that the user has set as primary. PayPersonId (Mandatory) Specifies the unique ID of the P2P payee whose details must be edited. {
"name":"John2",
"nickName":"kim12",
"phone":"1111111112",
"primaryContactForSending":"1111111112",
"PayPersonId":"1486"
}
|
| Response: |
Parameters PayPersonId Specifies the unique ID of the P2P payee. {
"PayPersonId":1486,
"opstatus":0,
"httpStatusCode":0
}
|
| Error Code(s): |
|
| Enterprise Provider: | Temenos Digital |
| Enterprise API: |
NA |
| Description: | This API update P2P Payee by changing nickname. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/DigitalTransfer/operations/Payee_P2P/updateP2PPayee |
| Security Level: | Authenticated App Users |
| Header Request: |
X-Kony-Authorization |
| Body Request: |
Parameters name(Mandatory) Specifies the name typed by the user on the screen. nickName Specifies the nick name typed by the user on the screen. primaryContactForSending Specifies either the phone number or email ID that the user has set as primary. PayPersonId (Mandatory) Specifies the unique ID of the P2P payee whose details must be edited. Specifies the email ID typed by the user on the screen. contractId(Mandatory) Specifies the unique contractId. coreCustomerId(Mandatory) Specifies the unique coreCustomerId. {
"email": "ghj@gmail.com",
"name": "payee1",
"nickName": "VPay1",
"PayPersonId": "26831269",
"phone": "",
"primaryContactForSending": "ghj@gmail.com"
}
|
| Response: |
Parameters PayPersonId(Mandatory) Specifies the unique PayPersonId.updatedRecords (Mandatory) Specifies the total count of updated records. {
"updatedRecords": 1,
"opstatus": 0,
"httpStatusCode": 0
} |
| Error Code(s): |
|
| Enterprise Provider: | Temenos Digital |
| Enterprise API: |
{base_url}/services/dbpPayeeServices/editP2PPayee |
Field Mapping
|
UI API field |
Experience API field |
MS API field |
Transact API field |
|---|---|---|---|
|
PayPersonId |
PayPersonId |
NA |
NA |
|
updatedRecords |
updatedRecords |
NA |
NA |
|
|
|
NA |
NA |
|
name |
name |
NA |
NA |
|
nickName |
nickName |
NA |
NA |
|
phone |
phone |
NA |
NA |
|
primaryContactForSending |
primaryContactForSending |
NA |
NA |
| Description: | This API Cancel transfer/ stop recurring transfer to P2P payee. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/TransactionObjects/operations/Transaction/P2PTransferDelete |
| Security Level: | Authenticated App Users |
| Header Request: |
X-Kony-Authorization |
| Body Request: |
Parameters transactionId Specifies the unique transactionId. frequencyType Specifies the type of frequency. {
"transactionId":"21623",
"frequencyType":"Once"
}
|
| Response: |
Parameters referenceId Specifies the unique referenceId.{
"referenceId": "21655",
"opstatus": 0,
"httpStatusCode": 0
} |
| Error Code(s): |
|
| Enterprise Provider: | Temenos Digital |
| Enterprise API: |
{base_url}/services/dbpTransactionServices/DeleteP2PTransaction |
Field Mapping
|
UI API field |
Experience API field |
MS API field |
Transact API field |
|---|---|---|---|
|
referenceId |
referenceId |
NA |
NA |
|
frequencyType |
frequencyType |
NA |
NA |
|
transactionId |
transactionId |
NA |
NA |
| Description: | Retrieves all the P2P Payee details |
| Method: | POST |
| URL: | {base_url}/services/data/v1/DigitalTransfer /operations/Payee_P2P/getP2PPayees |
| Security Level: | Authenticated App Users |
| Header Request: |
X-Kony-Authorization |
| Body Request: | {}
|
| Response: |
Parameters email(Mandatory) Specifies the email ID of the payee.name(Mandatory) Specifies the name of the payee. nickName Specifies the nick name of the payee.PayPersonId(Mandatory) Specifies the unique Id of the payee.phone Specifies the phone number typed by the user on the screen. primaryContactForSending (Mandatory) Specifies either the phone number or email ID that the user has set as primary. contractId (Mandatory) Specifies the unique contractId. coreCustomerId (Mandatory) Specifies the unique coreCustomerId. {
"records": [
{
"email": "peter@gmail.com",
"firstName": "Peter",
"name": "Peter Jackson",
"nickName": "Peter J",
"PayPersonId": "1470",
"primaryContactForSending": "peter@gmail.com",
"secondaryEmail": "JacksonP@yahoo.com"
},
{
"firstName": "Arthur",
"name": "Arthur Miller",
"nickName": "Miller",
"PayPersonId": "1468",
"phone": "5638294057",
"primaryContactForSending": "6565178276"
},
{
"email": "judy.blume@gmail.com",
"firstName": "Judy",
"name": "Judy Blume",
"nickName": "Judy",
"PayPersonId": "1467",
"phone": "8790146356",
"primaryContactForSending": "8790146356",
"secondaryEmail": "jblume@gmail.com"
},
{
"email": "francis@gmail.com",
"firstName": "Francis",
"name": "Francis Ford",
"nickName": "Francis F",
"PayPersonId": "1469",
"primaryContactForSending": "fordfrancis@gmail.com"
},
{
"email": "tytg@temenos.com",
"name": "otto",
"nickName": "ep",
"PayPersonId": "1483",
"phone": "6780285629",
"primaryContactForSending": "otto@gmail.com",
"secondaryEmail": "otto@gmail.com",
"secondaryEmail2": "",
"secondaryPhoneNumber2": "264736473"
}
],
"opstatus": 0,
"httpStatusCode": 0
} |
| Error Code(s): |
|
| Enterprise Provider: | Temenos Digital |
| Enterprise API: |
NA |
| Description: | This API fetches the recipient activity. |
| Method: | GET |
| URL: | {base_url}services/data/v1/DigitalTransfer/operations/Payment_P2PList/getTransfers |
| Security Level: | Authenticated App Users |
| Header Request: |
X-Kony-Authorization |
| Body Request: |
Parameters personID (Mandatory) Specifies the unique ID of the person limit Specifies the max character limit. sortBy (Mandatory) Specifies the sorting criteria for the response, such as payeeNickName or payeeID. By default, the payees will be sorted according to their payee name. order (Mandatory) Specifies the sorting order for the response (Ascending/Descending). By default, the order is set to ascending. {
"personId": "43831389",
"offset": 0,
"limit": 10,
"sortBy": "createdDate",
"order": "desc"
}
|
| Response: |
Parameters Transactions amount(Mandatory) Specifies the amount transferred. amountTransferredTillNow(Mandatory) Specifies the amount transferred until the current date. fromAccountBalance(Mandatory) Specifies the account balance in the From Account. fromAccountName(Mandatory) Specifies the account name of the sender. fromNickName Specifies the nick name of the sender. fromAccountNumber(Mandatory) Specifies the account number of the From Account. statusDescription Specifies the status of the transaction. transactionCurrency(Mandatory) Specifies the name of the currency of the transferred amount. transactionDate(Mandatory) Specifies the date of the transaction. fee Specifies the fee applied for the transfer. {
"Payment_P2PList": [{
"amount": "1.00",
"amountTransferedTillNow": "1.00",
"fromAccountBalance": "59188.18",
"fromAccountName": "Current Account",
"fromNickName": "",
"statusDescription": "Successful",
"transactionDate": "2021-11-16T19:46:21Z",
"fee": "0.00",
"transactionCurrency": "USD",
"fromAccountNumber": "121975"
}],
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): |
|
| Enterprise Provider: | Temenos Digital |
| Enterprise API: |
{base_url}/services/InfinityTransactionServices/getPayPersonHistory |
Field Mapping
|
UI API field |
Experience API field |
MS API field |
Transact API field |
|---|---|---|---|
|
amount |
amount |
NA |
NA |
|
amountTransferedTillNow |
amountTransferedTillNow |
NA |
NA |
|
fromAccountBalance |
fromAccountBalance |
NA |
NA |
|
fromAccountName |
fromAccountName |
NA |
NA |
|
transactionDate |
transactionDate |
NA |
NA |
|
transactionCurrency |
transactionCurrency |
NA |
NA |
|
fromAccountNumber |
fromAccountNumber |
NA |
NA |
|
fee |
fee |
NA |
NA |
| Description: | This API updates the transaction details. |
| Method: | GET |
| URL: | {base_url}/services/data/v1/DigitalTransfer/operations/Payment_P2PList/updateTransfer |
| Security Level: | Authenticated App Users |
| Header Request: |
X-Kony-Authorization |
| Body Request: |
Parameters frequencyType Specifies the frequency of the transaction. transactionID Specifies the unique ID of the transaction. transactionType Specifies the type of the transaction. {
"frequencyType": "once",
"transactionId": 20247,
"transactionType": ”PayAPerson”
}
|
| Response: |
Parameters transactionID Specifies the unique ID of the transaction referenceID Specifies the reference ID of the transaction {
transactionID: 20247
referenceId: 12678
}
|
| Error Code(s): |
|
| Enterprise Provider: | Temenos Digital |
| Enterprise API: |
{base_url}/services/dbpTransactionServices/CreateP2PTransaction |
Field Mapping
| Description: | This API can create transfer/ setup recurring transfer/ Repeat transfer/ amend recurring transfer to P2P payee |
| Method: | POST |
| URL: | {base_url}/services/data/v1/DigitalTransfer/operations/Payment_P2P/createTransfer |
| Security Level: | Authenticated App Users |
| Header Request: |
X-Kony-Authorization |
| Body Request: |
Parameters ExternalAccountNumber (Mandatory) Specifies the account number of external party. amount (Mandatory) Specifies the amount to send. beneficiaryId Specifies the unique beneficiaryId. frequencyEndDate Specifies the last date of the frequency. frequencyStartDate (Mandatory) Specifies the beginning date of frequency. frequencyType (Mandatory) Specifies the type of frequency(once/Multiple). isScheduled Specifies if the transaction is scheduled or not. paidBy Specifies by whom transaction charges to be paid. scheduledDate (Mandatory) Specifies the scheduled date for the transaction. transactionType (Mandatory) Specifies the type of transaction. transactionsNotes Specifies the transaction notes. toAccountCurrency (Mandatory) Specifies the receivers currency. fromAccountCurrency (Mandatory) Specifies the senders currency. transactionCurrency (Mandatory) Specifies the transaction currency. uploadedattachments Specifies the attachments that are uploaded. transactionAmount (Mandatory) Specifies the amount of transaction. numberOfRecurrences Specifies the total number of occurrences. personId (Mandatory) Specifies the unique personId. beneficiaryName (Mandatory) Specifies the name of the beneficiary. beneficiaryPhone Specifies the beneficiary phone number. beneficiaryEmail (Mandatory) Specifies email of the beneficiary. {
"amount": "1.00",
"beneficiaryId": "",
"frequencyStartDate": "2021-04-15T00:00:00.000Z",
"frequencyEndDate": "",
"frequencyType": "Once",
"fromAccountNumber": "131652",
"isScheduled": "0",
"scheduledDate": "2021-04-15T00:00:00.000Z",
"paidBy": "OUR",
"transactionsNotes": "notes",
"transactionType": "P2P",
"transactionCurrency": "EUR",
"fromAccountCurrency": "USD",
"toAccountCurrency": "EUR",
"uploadedattachments": "",
"numberOfRecurrences": "",
"ExternalAccountNumber": "",
"transactionAmount": "1.00",
"personId": "00131221",
"beneficiaryName": "gfdfdfd",
"beneficiaryPhone": "",
"beneficiaryEmail": "abc@gmail.com"
}
|
| Response: |
Parameters referenceId (Mandatory) Specifies the unique referenceId. amount (Mandatory) Specifies the amount to send. frequencyType (Mandatory) Specifies the type of transaction. fromAccountNumber (Mandatory) Specifies the from account number. isScheduled Specifies if the transaction is scheduled or not. paidBy Specifies by whom transaction charges to be paid. scheduledDate (Mandatory) Specifies the scheduled date for the transaction. transactionType (Mandatory) Specifies the type of transaction. transactionsNotes Specifies the notes for this transaction. fromAccountCurrency (Mandatory) Specifies the senders currency. transactionCurrency (Mandatory) Specifies currency for this transaction. transactionAmount (Mandatory) Specifies the amount for the transaction. personId (Mandatory) Specifies the unqiue personId. serviceName (Mandatory) Specifies the name of the service.serviceCharge (Mandatory) Specifies the service charge for the transaction. {
"referenceId": "20487",
"opstatus": 0,
"httpStatusCode": 0,
"status": "Sent",
"message": "Success! Your transaction has been completed",
"amount": "1",
"frequencyType": "Once",
"fromAccountCurrency": "USD",
"fromAccountNumber": "131652",
"isScheduled": "0",
"personId": "00131221",
"scheduledDate": "2021-04-15T00:00:00Z",
"transactionCurrency": "EUR",
"transactionsNotes": "notes",
"transactionType": "P2P",
"serviceName": "P2P_CREATE",
"serviceCharge": "0.0",
"transactionAmount": "1.00",
"paidBy": "OUR"
} |
| Error Code(s): |
|
| Enterprise Provider: | SRMS or Temenos Digital |
| Enterprise API: |
{base_url}/services/dbpTransactionServices/CreateP2PTransaction |
Field Mapping
|
UI API field |
Experience API field |
MS API field |
Transact API field |
|---|---|---|---|
|
referenceId |
referenceId |
NA |
NA |
|
frequencyType |
frequencyType |
NA |
NA |
|
fromAccountCurrency |
fromAccountCurrency |
NA |
NA |
|
fromAccountNumber |
fromAccountNumber |
NA |
NA |
|
personId |
personId |
NA |
NA |
|
scheduledDate |
scheduledDate |
NA |
NA |
|
transactionCurrency |
transactionCurrency |
NA |
NA |
|
transactionsNotes |
transactionsNotes |
NA |
NA |
|
transactionType |
transactionType |
NA |
NA |
|
serviceName |
serviceName |
NA |
NA |
|
serviceCharge |
serviceCharge |
NA |
NA |
|
transactionAmount |
transactionAmount |
NA |
NA |
|
paidBy |
paidBy |
NA |
NA |
|
amount |
amount |
NA |
NA |
| Parameter Name | DataType | Optional/Mandatory | Description |
|---|---|---|---|
|
ExternalAccountNumber |
String |
Mandatory |
It is account Number |
|
amount |
String |
Mandatory |
Credited amount value |
|
beneficiaryId |
String |
Mandatory |
Beneficiary Id |
|
frequencyEndDate |
String |
Mandatory |
End date for a transaction |
|
frequencyStartDate |
String |
Mandatory |
Start date for a transaction |
|
frequencyType |
String |
Mandatory |
Period of a transaction |
|
fromAccountNumber |
String |
Mandatory |
from Account Number |
|
isScheduled |
String |
Optional |
Transaction time is defined |
|
paidBy |
String |
Mandatory |
Person who paid amount |
|
scheduledDate |
String |
Mandatory |
Date at which transaction occurs |
|
transactionCurrency |
String |
Mandatory |
Transaction currency type |
|
transactionType |
String |
Mandatory |
Type of transaction |
|
transactionsNotes |
String |
Optional |
Notes |
|
fromAccountCurrency |
String |
Mandatory |
Type of from account number currency |
|
toAccountCurrency |
String |
Mandatory |
Type of credited account currency |
|
numberOfRecurrences |
String |
Optional |
Number of recurrences |
|
uploadedattachments |
|
Optional |
attachments |
|
beneficiaryEmail |
String |
Optional |
Email id |
|
beneficiaryPhone |
String |
Optional |
Phone number |
|
personId |
String |
Mandatory |
Person Id |
|
beneficiaryName |
String |
Mandatory |
beneficiary name |
|
transactionAmount |
String |
Mandatory |
Transaction Amount |
|
serviceCharge |
string |
Mandatory |
Service Charge |
|
message |
string |
Mandatory |
message |
|
status |
string |
Mandatory |
status |
|
referenceId |
string |
Mandatory |
Reference Id |
|
serviceName |
string |
Mandatory |
Service name |
| Parameter Name | DataType | Optional/Mandatory | Description |
|---|---|---|---|
|
name |
string |
Mandatory |
from account number |
|
nickName |
string |
Optional |
scheduled date |
|
phone |
string |
Mandatory |
phone number |
|
|
string |
Mandatory |
Email Id |
|
nationalID |
string |
Mandatory |
National Id |
|
primaryContactForSending |
string |
Mandatory |
Primary contact for sending |
|
contractId |
string |
Mandatory |
Contract Id |
|
coreCustomerId |
string |
Mandatory |
Core customer ID |
|
PayPersonId |
string |
Mandatory |
Pay person Id |
|
noOfCustomersLinked |
string |
Mandatory |
Number of customers linked |
|
updatedRecords |
string |
Mandatory |
Update Records |
| Parameter Name | DataType | Optional/Mandatory | Description |
|---|---|---|---|
|
personId |
string |
Mandatory |
Id of a person |
|
offset |
string |
Optional |
offset |
|
limit |
string |
Optional |
limit |
|
sortBy |
string |
Mandatory |
sort by |
|
order |
string |
Mandatory |
order |
|
amount |
string |
Mandatory |
amount |
|
amountTransferedTillNow |
string |
Mandatory |
amount transferred till now |
|
fromAccountBalance |
string |
Mandatory |
from account balance |
|
fromAccountName |
string |
Mandatory |
from account name |
|
fromNickName |
string |
Optional |
from nick name |
|
statusDescription |
string |
Optional |
status description |
|
transactionDate |
string |
Mandatory |
transaction date |
|
fee |
string |
Optional |
fee |
|
transactionCurrency |
string |
Mandatory |
transaction currency |
|
fromAccountNumber |
string |
Mandatory |
from account number |
In this topic