SingleView ERP Integration API's Payment service allows you to make payments to a single or multiple accounts by sending a payment request.

Process a payment

Try in API Reference ➜

Endpoint details

Endpoint URL	Method	Authentication requirements
`v1/api/erp/svPaymentService`	POST	1. `clientid` 2. `clientsecret` 3. `signature`

A request in the following format should be posted to the above mentioned Endpoint with valid authentication details:

curl --location --request POST 'https://servicesuat.onesingleview.com/v1/api/erp/svPaymentService' \
--header 'clientid: Enter_Client_ID' \
--header 'clientsecret: Enter_Client_Secret' \
--header 'signature: Enter_Signature' \
--header 'Content-Type: application/json' \
--data-raw '{
  "svPaymentServiceRQ": {
    "company": [
      {
        "companyCode": "Enter_Company_Code",
        "payment": [
          {
            "userName": "Enter_Username",
            "payId": "Enter_Payment_ID",
            "transferType": "Enter_Transfer_Type_Code",
            "ownAccTxnType": "Enter_Own_Account_Transaction Type",
            "amount": 00.00,
            "currency": "Enter_Currency",
            "acERPcode": "Enter_Account_ERP_Code",
            "benERPcode": "Enter_Beneficiary_ERP_Code",
            "description": "Enter_Description",
            "iv": [
              {
                "supplierCode": "Enter_Supplier_Code",
                "createdDate": "YYYY-MM-DDTHH:MM:SSZ",
                "payDate": "YYYY-MM-DDTHH:MM:SSZ",
                "userId": "Enter_User_ID",
                "ivNumber": "Enter_IV_Number",
                "amount": 00.00,
                "approvers": "Enter_Last_Approver_ID",
                "description": "Enter_Description",
                "modeOfPay": "Enter_Mode_of_Payment",
                "ledgerRef": "Enter_Ledger_Referenece",
                "po": [
                    {
                     "supplierCode": "Enter_Supplier_Code",
                     "createdDate": "YYYY-MM-DDTHH:MM:SSZ",
                     "payDate": "YYYY-MM-DDTHH:MM:SSZ",
                     "userId": "Enter_User_ID",
                     "amount": 00.00,
                     "approvers": "Enter_Last_Approver_ID",
                     "description": "Enter_Description",
                     "modeOfPay": "Enter_Mode_of_Payment",
                     "ledgerRef": "Enter_Ledger_Referenece",
                      "items": [
                       {
                        "item": "Enter_Item_Code",
                        "createdDate": "YYYY-MM-DDTHH:MM:SSZ",
                        "description": "Enter_Description",
                        "quantity": 00,
                        "unitPrice": 00.00,
                        "discount": 00,
                        "discountPercentage": 00%,
                        "amount": 00.00,
                        "salesTaxInclude": 00.00,
                        "salesTaxPercentage": 00%,
                        "reason": "Enter_Reason"
                      },
                      {
                        "item": "Enter_Item_Code",
                        "createdDate": "YYYY-MM-DDTHH:MM:SSZ",
                        "description": "Enter_Description",
                        "quantity": 00,
                        "unitPrice": 00.00,
                        "discount": 00,
                        "discountPercentage": 00%,
                        "amount": 00.00,
                        "salesTaxInclude": 00.00,
                        "salesTaxPercentage": 00%,
                        "reason": "Enter_Reason"
                      }
                    ],
                    "poNumber": "Enter_PO_Number"
                  }
                ],
                "items": [
                  {
                    "item": "Enter_Item_Code",
                    "createdDate": "YYYY-MM-DDTHH:MM:SSZ",
                    "description": "Enter_Description",
                    "quantity": 00,
                    "unitPrice": 00.00,
                    "discount": 00,
                    "discountPercentage": 00%,
                    "amount": 00.00,
                    "salesTaxInclude": 00.00,
                    "salesTaxPercentage": 00%,
                    "reason": "Enter_Reason"
                  }
                ]
              }
            ]
          },
          {
            "payId": "Enter_Payment_ID",
            "userName": "Enter_Username",
            "transferType": "Enter_Transfer_Type",
            "amount": 00.00,
            "currency": "Enter_Currency",
            "acERPcode": "Enter_Account_ERP_Code",
            "benERPcode": "Enter_Beneficiary_ERP_Code",
            "description": "Enter_Description",
            "iv": [
              {
                "supplierCode": "Enter_Supplier_Code",
                "createdDate": "YYYY-MM-DDTHH:MM:SSZ",
                "payDate": "YYYY-MM-DDTHH:MM:SSZ",
                "userId": "Enter_User_ID",
                "ivNumber": "Enter_IV_Number",
                "amount": 00.00,
                "approvers": "Enter_Last_Approver_ID",
                "description": "Enter_Description",
                "modeOfPay": "Enter_Mode_of_Payment",
                "ledgerRef": "Enter_Ledger_Referenece",
                "po": [
                    {
                     "supplierCode": "Enter_Supplier_Code",
                     "createdDate": "YYYY-MM-DDTHH:MM:SSZ",
                     "payDate": "YYYY-MM-DDTHH:MM:SSZ",
                     "userId": "Enter_User_ID",
                     "amount": 00.00,
                     "approvers": "Enter_Last_Approver_ID",
                     "description": "Enter_Description",
                     "modeOfPay": "Enter_Mode_of_Payment",
                     "ledgerRef": "Enter_Ledger_Referenece",
                      "items": [
                       {
                        "item": "Enter_Item_Code",
                        "createdDate": "YYYY-MM-DDTHH:MM:SSZ",
                        "description": "Enter_Description",
                        "quantity": 00,
                        "unitPrice": 00.00,
                        "discount": 00,
                        "discountPercentage": 00%,
                        "amount": 00.00,
                        "salesTaxInclude": 00.00,
                        "salesTaxPercentage": 00%,
                        "reason": "Enter_Reason"
                      },
                      {
                        "item": "Enter_Item_Code",
                        "createdDate": "YYYY-MM-DDTHH:MM:SSZ",
                        "description": "Enter_Description",
                        "quantity": 00,
                        "unitPrice": 00.00,
                        "discount": 00,
                        "discountPercentage": 00%,
                        "amount": 00.00,
                        "salesTaxInclude": 00.00,
                        "salesTaxPercentage": 00%,
                        "reason": "Enter_Reason"
                      }
                    ],
                    "poNumber": "Enter_PO_Number"
                  }
                ],
                "items": [
                  {
                    "item": "Enter_Item_Code",
                    "createdDate": "YYYY-MM-DDTHH:MM:SSZ",
                    "description": "Enter_Description",
                    "quantity": 00,
                    "unitPrice": 00.00,
                    "discount": 00,
                    "discountPercentage": 00%,
                    "amount": 00.00,
                    "salesTaxInclude": 00.00,
                    "salesTaxPercentage": 00%,
                    "reason": "Enter_Reason"
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}'

Request details:

JSON Tag	Description	Data type
clientid Mandatory	Client ID	String
clientsecret Mandatory	Client Code	String
signature Mandatory	Signature	String
svPaymentServiceRQ Mandatory	Create payment request tag	Object
company Mandatory	Array of companies	Array
companyCode Mandatory	Unique company code	String
payment Mandatory	Array of payments	Array
userName Mandatory	Singleview Username	String
payId Mandatory	Unique reference id toward payment request from ERP	String
transferType Mandatory	Whether the transfer is: 0-OWN ACCOUNT 1-INTERBANK 2-SARIE 3-SWIFT	Number
ownAccTxnType Mandatory for own account transfers (In-house Bank Account Transfers)	Whether the transfer is: 0-OWNACC 1-INTERBANK 2-SARIE 3-SWIFT	Number
amount Mandatory	Total amount spent on PO	Number
currency Mandatory	Currency	String
acERPCode Mandatory	Account from which the amount will be deducted and is the mapping account ERP code for the bank	String
benERPCode Mandatory	Account where the money will be transferred to and is the mapping Beneficiary ERP code for the bank account	String
description Mandatory	Description pertaining to the PO raised and/or the approver comments	String
iv Optional	Array of invoices	Array
supplierCode Optional	Unique code for the supplier	String
createdDate Optional	Date on which Invoice was created	String
payDate Optional	By when the PO should be cleared	String
userId Optional	PO Raised by the user	String
ivNumber Optional	Invoice number or ID	String
amount Optional	Total amount for which transaction was made	Number
approvers Optional	Last approver who approved the PO, USER ID	String
description Optional	Description related to payment that includes an array of invoice references; in case a payment has more than one invoice	String
modeOfPay Optional	Cash/Cheque/Online	String
ledgerRef Optional	Unique reference for the PO in ledger	String
po Optional	Array of purchase orders	Array
poNumber Optional	PO Number	String
supplierCode Optional	Unique supplier code	String
createdDate Optional	Date on which PO was created	String
payDate Optional	By when the PO should be cleared	String
userId Optional	User who raised the PO	String
ivNumber Optional	Invoice ID	String
amount Optional	Total amount for which transaction was made	String
approvers Optional	Last approver who approved the PO, USER ID	String
description Optional	Description related to payment Will include an array of invoice references , in case a payment has more than one invoice	String
modeOfPay Optional	Cash/Cheque/Online	String
ledgerRef Optional	Unique reference for the PO in ledger	String
items Optional	Array of items	Array
item Optional	Item added to the invoice	String
createdDate Optional	Date of invoice creation	String
description Optional	Description of the item	String
quantity Optional	Number of units pertaining to the item	Number
unitPrice Optional	Price of each unit of item	Number
discount Optional	Value of the discount	Number
discountPercentage Optional	% discount	Number
amount Optional	Cost of total invoiced item	Number
salesTaxInclude Optional	Sales tax towards the invoiced item	Number
salesTaxPercentage Optional	Percentage of sales tax towards invoice	Number
reason Optional	Reason	String

Upon processing of the request and finding of valid authentication details, you'll get the following success response:

{
  "svPaymentServiceRS": {
    "company": [
      {
        "companyCode": "Company_Code",
        "userName": "Username",
        "payment": [
          {
            "authId": "OSV_Payment_ID",
            "status": Status_Code,
            "message": "Process/Status_Message",
          },
          {
            "payId": "Payment_ID",//In case of error
            "status": Status_Code,
            "message": "Process/Status_Code",
            "errorCode" : "Error_Code"
          }
        ]
      }
    ]
  }
}

Response description:

JSON Tag	Description	Data type
svPaymentServiceRS	Add payment services Response Tag	Object
company	Array of companies	Array
companyCode	Unique company code	String
userName	Singleview username	String
payment	Array of payments	Array
authId	Singleview Payment ID	String
payId	Unique reference id toward payment request from ERP	String
status	Status code	Numerical
message	Process display message	String
errorCode	Error code	String