Create Payments

Overview

You can create a Payment with basic details using the POST method and use them for various CPX solution offerings.

Resource Access

POST https://<hostname>/payment/v1/pifTransactions/json

Attributes

Parameters for making a Payment through API in CPX are as given below:

Fields	Mandatory / Optional
nid	Optional
fid	Optional
buyerId	Mandatory
supplierId	Mandatory
supplierName	Mandatory
amount	Mandatory
transactionId	Mandatory
accountType	Optional
fileDate	Mandatory
checkInsert	Optional
deliveryMode	Optional
reference1	Optional
reference2	Optional
reference3	Optional
reference4	Optional
reference5	Optional
emailNotes	Optional
scheduleDate	Optional
bankRoutingNumber	Optional
bankAccountNumber	Optional
partialPaymentIndicator	Optional
paymentExpirationDate	Optional
checkRemittanceTemplateId	Optional
checkNumber	Optional
templateId	Optional
accountId	Optional
supplierAddressLine1	Optional
supplierAddressLine2	Optional
supplierCity	Optional
supplierState	Optional
supplierZip	Optional
supplierEmail	Optional
invoiceNumbers	Optional
invoiceDates	Optional
invoiceAmounts	Optional
invoiceOpenAmounts	Optional
invoiceTotalDues	Optional
invoiceDescriptions	Optional
invoiceCreditAmounts	Optional
invoiceCreditNumbers	Optional
invoiceCreditMemoNotes	Optional
invoiceDiscountAmounts	Optional
invoiceLocations	Optional
invoiceAttachments	Optional
poNumbers	Optional
poDates	Optional
udf1-50	Optional

Example Request


{
  [
   {
       "nid": "8699952968",
       "fid": "8699952968",
       "buyerId": "8699952968", 
       "supplierId": "61616161", 
       "supplierName": "johnMultiSupplier", 
       "amount": 25, 
       "transactionId": "Trrso9ahbcts0NNSsnn2345765432312", 
       "accountType": "VCN",
       "fileDate": "2022-12-13",
        "checkInsert": {
                "base64Content": "JVBERi0xLjQKJdPr6eEKMSAwIG9iago8PC9DcmVhdG9yIChNb3ppbGxhLzUuMCBcKE1hY2ludG9zaDsgSW50ZWwgTWFjIE9TIFggMTBfMTVfN1wpIEFwcGxlV2ViS2l0LzUzNy4zNiBcKEtIVE1MLCBsaWtlIEdlY2tvXCkgQ2hyb21lLzExOS4wLjAuMCBTYWZhcmkvNTM3LjM2KQovUHJvZHVjZXIgKFNraWEvUERGIG0xMTkpCi9DcmVhdGlvbkRhdGUgKEQ6MjAyNDAxMDUxMDE5MDIrMDAnMDAnKQovTW9kRGF0ZSAoRDoyMDI0MDEwNTEwMTkwMiswMCcwMCcpPj4KZW5kb2JqCjMgMCBvYmoKPDwvY2EgMQovQk0gL05vcm1hbD4+CmVuZG9iagoxMSAwIG9iago8PC9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9JbWFnZQovV2lkdGggMTY2Ci9IZWlnaHQgMTY2Ci9Db2xvclNwYWNlIC9EZXZpY2VSR0IKL1NNYXNrIDEyIDAgUgovQml0c1BlckNvbXBvbmVudCA4Ci9GaWx0ZXIgL0ZsYXRlRGVjb2RlCi9MZW5ndGggMjQ4MTQ+PiBzdHJlYW0KeJzsvXdYXEe2L9r/vO/+",
                "fileName": "Rapidash sandbox (1).pdf",
                "printType": "black_white", 
                "attachmentId": "60fd95b9-1e22-5c82-8aea-979fe2c56431"
            },
       "reference1": "ref1",
       "reference2": "ref2",
       "reference3": "ref3",
       "reference4": "ref4",
       "reference5": "ref5",
       "emailNotes": "emailNotes12",
       "scheduleDate": "2024-03-29",
       "bankRoutingNumber": "121000248", 
       "bankAccountNumber": "1234567890123456", 
       "partialPaymentIndicator": "Y", 
       "paymentExpirationDate": "2024-04-30",
       "checkRemittanceTemplateId": "123456789",
       "checkNumber": "123",
"deliveryMode" : "TWODAY",
       "templateId": "0231952299944155", 
       "accountId": "a37f98718a6f35c3b8f154db7aa4990d3215a31c8317f551453718d5fca319f4",            "supplierAddressLine1": "SupplierAddressLine1",
       "supplierAddressLine2": "SupplierAddressLine2",
       "supplierCity": "Test City",
       "supplierState": "Kansas",
       "supplierZip": "66102",
       "supplierEmail": "[email protected]",
       "invoiceNumbers": [
           "1234",
           "12345",
           "12",
           "123456"
       ],
       "invoiceDates": [
           "2022-12-13",
           "2022-12-14"
       ],
       "invoiceAmounts": [
           12.9,
           12.2,
           34.4,
           45.55
       ],
       "invoiceOpenAmounts": [
           12.9,
           12.2,
           34.4,
           45.55
       ],
       "invoiceTotalDues": [
           12.9,
           12.2,
           34.4,
           45.55
       ],
       "invoiceDescriptions": [
           "desc1",
           "desc2",
           "desc3",
           "desc4"
       ],
       "invoiceCreditAmounts": [
           12.9,
           12.2,
           34.4,
           45.55
       ],
       "invoiceCreditNumbers": [
           "1234",
           "12345",
           "12",
           "123456"
       ],
       "invoiceCreditMemoNotes": [
           "memo1",
           "memo2",
           "memo3",
           "memo4"
       ],
       "invoiceDiscountAmounts": [
           12.9,
           12.2,
           34.4,
           45.55
       ],
       "invoiceLocations": [
           "loc1",
           "loc2",
           "loc3",
           "loc4"
       ],
       "invoiceAttachments": [
           "c5221a79-7f47-57c4-a1b4-ba362089e437"
       ],
       "poNumbers": [
           "1A",
           "2B",
           "33",
           "44F"
       ],
       "poDates": [
           "2022-12-13",
           "2022-12-14",
           "2022-12-15"
       ],
       "udf1": ["1", "2", "3", "4"],
       "udf2": ["u1", "u2", "u3", "u4"]
   }
]

Example Response


{
   "fileInfo": {
       "fileId": "d64580196943724443b5f1ec90e3d779c144b456",
       "fileName": "johnNetwork.johnInstitution.pif.WEB_20240902060051.csv"
   },
   "rec": [
       {
           "id": "a6ca0e94-bbe7-58b3-824b-495e47636a8e",
           "originalAmount": 250,
           "paymentAuthMessage": null,
           "paymentMethod": "ACH",
           "paymentStatus": "Pending",
           "transactionId": "Trrso9ahbcts0NNSs9nn23djj4576543231673721",
           "paymentType": "ACH",
           "accountType": "ACH",
           "achTransactionType": "credit",
           "isProxyPay": false,
           "institution": {
               "id": "51a5f28f-fb9b-5a2f-b770-2270cda175f1",
               "fid": "johnInstitution"
           },
           "network": {
               "id": "67e80876-69a2-5702-9fc2-5c2999389548",
               "nid": "johnNetwork"
           },
           "buyer": {
               "id": "2523a2a6-3e9a-5127-b792-7d19c151805c",
               "bid": "johnachTestbuyer"
           },
           "supplier": {
               "id": "c309bc69-e3df-58a5-857a-49953328a640",
               "sid": "testsuppach"
           }
       }
   ]
}