Errors
Payment Link Services Errors
| Error Code | Label | Description | Context | Status |
|---|---|---|---|---|
| merchantNotFound | Merchant not found. | Check the cFiMerchantId to make sure it is valid and exists. Context: cFiMerchantId - The merchant ID in connectFi |
{ |
400 |
| merchantIsArchive | Merchant is in an archive | Merchant is in an archive | { |
400 |
| merchantDetails | Merchant details are not full | Merchant details are not full | { |
400 |
| paymentNotFound | Payment not found. | Payment not found. | { |
400 |
| refundNotFound | Refund not found. | Refund not found. | { |
400 |
| paymentValidateFields | Payment validate fields error | Payment validate fields error | { |
400 |
| paymentStatus | Wrong Payment status | Wrong Payment status | { |
400 |
| paymentNotificationStatus | Payment status must be Sent | Payment status must be Sent | { |
400 |
| paymentAvailableType | Wrong Payment type | Wrong payment type | { |
400 |
| paymentNotificationType | Wrong notification type | Wrong notification type | { |
400 |
| paymentDuplicateReminder | You cannot sent more than one reminder per day. | You cannot sent more than one reminder per day. | { |
400 |
| paymentPlaidAccount | Payment Plaid Account Not Found | Payment Plaid Account Not Found | { |
400 |
| unavailableAmount | Unavailable Amount | Unavailable Amount | 400 | |
| formNotFound | Payment form not found. | Check the form if to make sure it is valid and exists. Context: id - The payment form ID in connectFi |
{ |
400 |
| plaid | Plaid err | Plaid err | {} |
400 |
| plaidAccessToken | Plaid Access Token not found | Plaid Access Token not found | { |
400 |
| plaidUnavailable | Plaid Unavailable for the merchant | Plaid Unavailable | {} |
400 |
| logoNotFound | Logo not found. | Check the logo to make sure it is valid and exists. Context: logoId - The logo ID in connectFi |
{ |
400 |
| fileNotFound | File not found. | File not found. | undefined | 400 |
| invoiceNotFound | Invoice not found. | Check the cFiInvoiceId to make sure it is valid and exists. Context: cFiInvoiceId - The Invoice ID in connectFi |
{ |
400 |
| invoiceExists | Invoice found for provided transaction. | Check the cFiTransaction to make sure that valid and invoice not attached to it. Context: cFiTransactionId - The payment id in connectFi |
{ |
400 |
| invalidReminderDate | Payment remindDate cannot be prior to current date. |
Use a valid remindDate. Context: remindDate - The payment reminder date |
{ |
400 |
| reminderNotFound | Payment reminder not found. | Check the cFiReminderId to make sure it is valid and exists. Context: cFiReminderId - The reminder ID in connectFi |
{ |
400 |
Error Examples
| Error Description | Parameters/Request Body | Response Body |
|---|---|---|
| 400 payment-link/merchant/create Error Response - referenceExists | REQUEST BODY { "reference": "3", "name": "Merchant3", "isArchived": false, "email": "abc.test@email.test", "phone": "5556667777", "address": "123 Main Street", "city": "Oklahoma City", "stateCode": "OK", "postalCode": "12345", "availablePaymentType": [ "ach", "card" ], "usePlaid": true } |
RESPONSE BODY { "requestId": "c1f6c450540111efacdc860d03bdc411", "code": "referenceExists", "context": { "reference": "3", "entityId": "5MWzSxWGVxUaR74rHvgkVA" }, "message": "Reference already exists." } |
| 400 payment-link/merchant/create requestValidateError Missing required property | REQUEST BODY { "name": "Merchant3", "isArchived": false, "email": "abc.test@email.test", "phone": "5556667777", "address": "123 Main Street", "city": "Oklahoma City", "stateCode": "OK", "postalCode": "12345", "availablePaymentType": [ "ach", "card" ], "usePlaid": true } |
RESPONSE BODY { "requestId": "37aaeba0540611efacdc860d03bdc411", "code": "requestValidateError", "context": [ { "instancePath": "", "schemaPath": "#/$merge/required", "keyword": "required", "params": { "missingProperty": "reference" }, "message": "must have required property 'reference'" }, { "instancePath": "", "schemaPath": "#/$merge", "keyword": "$merge", "params": {}, "message": "must pass \"$merge\" keyword validation" } ] } |
| 400 payment-link/merchant/create requestValidateError Invalid property format | REQUEST BODY { "reference": "8", "name": "Merchant8", "isArchived": false, "email": "InvalidEmailFormat", "phone": "5556667777", "address": "123 Main Street", "city": "Oklahoma City", "stateCode": "OK", "postalCode": "12345", "availablePaymentType": [ "ach", "card" ], "usePlaid": true } |
RESPONSE BODY { "requestId": "4c35f1d0540811efacdc860d03bdc411", "code": "requestValidateError", "context": [ { "instancePath": "/email", "schemaPath": "customer#/definitions/email/format", "keyword": "format", "params": { "format": "email" }, "message": "must match format \"email\"" }, { "instancePath": "", "schemaPath": "#/$merge", "keyword": "$merge", "params": {}, "message": "must pass \"$merge\" keyword validation" } ] } |
| 400 payment-link/merchant/create requestValidateError Must be an allowed value | REQUEST BODY { "reference": "1", "name": "Merchant1", "isArchived": false, "email": "abc.test@email.test", "phone": "5556667777", "address": "123 Main Street", "city": "Oklahoma City", "stateCode": "OK", "postalCode": "12345", "availablePaymentType": [ "UNKNOWN_PAYMENT_TYPE" ], "usePlaid": true } |
RESPONSE BODY { "requestId": "859538d0540a11efacdc860d03bdc411", "code": "requestValidateError", "context": [ { "instancePath": "/availablePaymentType/0", "schemaPath": "#/$merge/properties/availablePaymentTyp e/items/enum", "keyword": "enum", "params": { "allowedValues": [ "card", "ach" ] }, "message": "must be equal to one of the allowed values" }, { "instancePath": "", "schemaPath": "#/$merge", "keyword": "$merge", "params": {}, "message": "must pass \"$merge\" keyword validation" } ] } |
| 400 payment-link/merchant/update Error Response - merchantNotFound | REQUEST BODY { "cFiMerchantId": "UNKNOWN_MERCHANT_ID", "name": "Merchant1", "email": "def123.test@email.test", "phone": "5555555555", "address": "1346 Pleasant Ave", "city": "New York", "stateCode": "NY", "postalCode": "12345", "isArchived": false, "availablePaymentType": [ "ach", "card" ], "usePlaid": true } |
RESPONSE BODY { "requestId": "dfc80040540911efacdc860d03bdc411", "code": "merchantNotFound", "context": { "cFiMerchantId": "UNKNOWN_MERCHANT_ID" }, "message": "Merchant not found." } |
| 400 payment-link/merchant/update requestValidateError Must be an allowed value | REQUEST BODY { "cFiMerchantId": "2Bc0QW0VYJe7VhTyXXEYNQ", "name": "Merchant1", "email": "def123.test@email.test", "phone": "5555555555", "address": "1346 Pleasant Ave", "city": "New York", "stateCode": "NY", "postalCode": "12345", "isArchived": false, "availablePaymentType": [ "UNKNOWN_PAYMENT_TYPE" ], "usePlaid": true } |
RESPONSE BODY { "requestId": "1f2b6b00540a11efacdc860d03bdc411", "code": "requestValidateError", "context": [ { "instancePath": "/availablePaymentType/0", "schemaPath": "#/$merge/properties/availablePaymentTyp e/items/enum", "keyword": "enum", "params": { "allowedValues": [ "card", "ach" ] }, "message": "must be equal to one of the allowed values" }, { "instancePath": "", "schemaPath": "#/$merge", "keyword": "$merge", "params": {}, "message": "must pass \"$merge\" keyword validation" } ] } |
| 400 payment-link/merchant/get-token Error Response - merchantNotFound | REQUEST BODY { "cFiMerchantId": "UNKNOWN_MERCHANT_ID" } |
RESPONSE BODY { "requestId": "b7d41370540a11efacdc860d03bdc411", "code": "merchantNotFound", "context": { "cFiMerchantId": "UNKNOWN_MERCHANT_ID" }, "message": "Merchant not found." } |
| 400 payment-link/merchant/get-token requestValidateError Missing required property | REQUEST BODY { } |
RESPONSE BODY { "requestId": "ef6a4520540a11efacdc860d03bdc411", "code": "requestValidateError", "context": [ { "instancePath": "", "schemaPath": "#/required", "keyword": "required", "params": { "missingProperty": "cFiMerchantId" }, "message": "must have required property 'cFiMerchantId'" } ] } |
| 400 payment-link/merchant/get-token Error Response - merchantNotFound | REQUEST BODY { "cFiMerchantId": "UNKNOWN_MERCHANT_ID" } |
RESPONSE BODY { "requestId": "b7d41370540a11efacdc860d03bdc411", "code": "merchantNotFound", "context": { "cFiMerchantId": "UNKNOWN_MERCHANT_ID" }, "message": "Merchant not found." } |
| 400 payment-link/merchant/details requestValidateError Missing required property | REQUEST BODY { } |
RESPONSE BODY { "requestId": "ef6a4520540a11efacdc860d03bdc411", "code": "requestValidateError", "context": [ { "instancePath": "", "schemaPath": "#/required", "keyword": "required", "params": { "missingProperty": "cFiMerchantId" }, "message": "must have required property 'cFiMerchantId'" } ] } |
| 400 payment-link/merchant/list requestValidateError Must be an allowed value | REQUEST BODY { "availablePaymentType": [ "UNKNOWN_PAYMENT_TYPE" ], "numberOfRecords": 10, "skipRecords": 0 } |
RESPONSE BODY { "requestId": "57b5fce0540c11efacdc860d03bdc411", "code": "requestValidateError", "context": [ { "instancePath": "/availablePaymentType/0", "schemaPath": "#/properties/availablePaymentType/items /enum", "keyword": "enum", "params": { "allowedValues": [ "card", "ach" ] }, "message": "must be equal to one of the allowed values" } ] } |
| 400 payment-link/merchant/:cFiMerchantId/logo/upload/:type Error Response - fileNotFound | PARAMETERS cFiMerchantId:2Bc0QW0VYJe7VhTyXXEYNQ type:light1 |
RESPONSE BODY { "requestId": "718a1ec0540d11efacdc860d03bdc411", "code": "fileNotFound", "message": "File not found." } |
| 400 payment-link/merchant/:cFiMerchantId/logo/upload/:type Error Response - merchantNotFound | PARAMETERS cFiMerchantId:UNKNOWN_MERCHANT_ID type:light1 |
RESPONSE BODY { "requestId": "d2e58560540d11efacdc860d03bdc411", "code": "merchantNotFound", "context": { "cFiMerchantId": "UNKNOWN_MERCHANT_ID" }, "message": "Merchant not found." } |
| 400 payment-link/merchant/:cFiMerchantId/logo/upload/:type Error Response - merchantIsArchive | PARAMETERS cFiMerchantId:2Bc0QW0VYJe7VhTyXXEYNQ type:light1 |
RESPONSE BODY { "requestId": "5c972a9054b111efacdc860d03bdc411", "code": "merchantIsArchive", "context": { "cFiMerchantId": "2sApBBEQbR7DA6FBxRoiaK" }, "message": "Merchant is in an archive" } |
| 400 payment-link/merchant/logo/:logoId Error Response - logoNotFound | PARAMETERS logoId:UNKNOWN_LOGO_ID |
RESPONSE BODY { "requestId": "3fa862d0540e11efacdc860d03bdc411", "code": "logoNotFound", "context": { "logoId": "UNKNOWN_LOGO_ID" }, "message": "Logo not found." } |
| 400 payment-link/merchant/remove/logo Error Response - logoNotFound | REQUEST BODY { "logoId": "Unknown", "cFiMerchantId": "7MYoRiCN2XuAxJxWr82n6I" } |
RESPONSE BODY { "requestId": "5ee16a3092e211efb50456da8a8633f0", "code": "logoNotFound", "context": { "logoId": "Unknown" }, "message": "Logo not found." } |
| 400 payment-link/merchant/remove/logo Error Response - merchantNotFound | REQUEST BODY { "logoId": "5zW5IKxa4x4w8Yu8yJLi1O", "cFiMerchantId": "unknown" } |
RESPONSE BODY { "requestId": "bc55d2a092e211efb50456da8a8633f0", "code": "merchantNotFound", "context": { "cFiMerchantId": "unknown" }, "message": "Merchant not found." } |
| 400 payment-link/payment/list requestValidateError Invalid property format | REQUEST BODY { "dateCreateFrom": "2024/07/28", "dateCreateTo": "2024-08-01", "amountFrom": 0, "amountTo": 100, "skipRecords": 0, "numberOfRecords": 10 } |
RESPONSE BODY { "requestId": "232fd0b0541411efacdc860d03bdc411", "code": "requestValidateError", "context": [ { "instancePath": "/dateCreateFrom", "schemaPath": "#/$merge/properties/dateCreateFrom/form at", "keyword": "format", "params": { "format": "dateISO" }, "message": "must match format \"dateISO\"" }, { "instancePath": "", "schemaPath": "#/$merge", "keyword": "$merge", "params": {}, "message": "must pass \"$merge\" keyword validation" } ] } |
| 400 payment-link/payment/export Error Response - invalidDateRange | REQUEST BODY { "amountFrom": 0, "amountTo": 100, "dateCreateFrom": "2024-05-01T10:45:58.779+00:00", "dateCreateTo": "2024-08-02T10:45:58.779+00:00" } |
RESPONSE BODY { "requestId": "17f98cf0541d11efacdc860d03bdc411", "code": "invalidDateRange", "context": { "amountFrom": 0, "amountTo": 100, "maxDateRange": 3 //months }, "message": "Date range is too great." } |
| 400 payment-link/payment/cancel Error Response - paymentStatus | REQUEST BODY { "cFiTransactionId": "yJ6pRvSIsp26qbbLgMVX3" } |
RESPONSE BODY { "requestId": "bdedd680541211efacdc860d03bdc411", "code": "paymentStatus", "context": { "entityId": "yJ6pRvSIsp26qbbLgMVX3" }, "message": "Wrong Payment status" //Transaction does not have a cancellable current status } |
| 400 payment-link/payment/cancel Error Response - paymentNotFound | REQUEST BODY { "cFiTransactionId": "UNKNOWN_TRANSACTION_ID" } |
RESPONSE BODY { "requestId": "1d7e8f40541311efacdc860d03bdc411", "code": "paymentNotFound", "context": { "cFiTransactionId": "UNKNOWN_TRANSACTION_ID" }, "message": "Payment not found." } |
| 400 payment-link/payment/set-status Error Response - paymentStatus | REQUEST BODY { "cFiTransactionId": "29ljhq5Apu1YfdtU3wN7yx", "status": "Completed", "description": "Attempt to change Initiated to Completed manually", "manualStatus": true } |
RESPONSE BODY { "requestId": "24844480541111efacdc860d03bdc411", "code": "paymentStatus", "context": { "entityId": "29ljhq5Apu1YfdtU3wN7yx" }, "message": "Wrong Payment status" } |
| 400 payment-link/payment/set-status Error Response - paymentNotFound | REQUEST BODY { "cFiTransactionId": "UNKNOWN_TRANSACTION_ID", "status": "Completed", "description": "Non-existant payment link", "manualStatus": true } |
RESPONSE BODY { "requestId": "6839aed0541211efacdc860d03bdc411", "code": "paymentNotFound", "context": { "cFiTransactionId": "UNKNOWN_TRANSACTION_ID" }, "message": "Payment not found." } |
| 400 payment-link/payment/set-status requestValidateError Missing required property | REQUEST BODY { "cFiTransactionId": "29ljhq5Apu1YfdtU3wN7yx", "description": "Missing required property", "manualStatus": true } |
RESPONSE BODY { "requestId": "2de372c0541211efacdc860d03bdc411", "code": "requestValidateError", "context": [ { "instancePath": "", "schemaPath": "#/required", "keyword": "required", "params": { "missingProperty": "status" }, "message": "must have required property 'status'" } ] } |
| 400 payment-link/payment/reminder/list requestValidateError - Missing required property | REQUEST BODY { } |
RESPONSE BODY { "requestId": "a92154a0a5cc11efa1c705d40488b012", "code": "requestValidateError", "context": [ { "instancePath": "", "schemaPath": "#/$merge/required", "keyword": "required", "params": { "missingProperty": "cFiTransactionId" }, "message": "must have required property 'cFiTransactionId'" }, { "instancePath": "", "schemaPath": "#/$merge", "keyword": "$merge", "params": {}, "message": "must pass \"$merge\" keyword validation" } ] } |
| 400 payment-link/payment/refund-list requestValidateError Must be an allowed value | REQUEST BODY { "cFiTransactionIds": [], "dateCreateFrom": "2024-08-30T18:03:46.637Z", "dateCreateTo": "2024-10-30T18:03:46.637Z", "status": "UnknownStatus" } |
RESPONSE BODY { "requestId": "24b0caa092fa11ef893705725acd1211", "code": "requestValidateError", "context": [ { "instancePath": "/status", "schemaPath": "#/properties/status/enum", "keyword": "enum", "params": { "allowedValues": [ "Initiated", "Sent", "Cancelled", "Rejected", "Error", "Expired", "Processing", "SentToPay", "Completed", "Settled", "Returned", "Declined" ] }, "message": "must be equal to one of the allowed values" } ] } |
| 400 payment-link/payment/refund-details Error Response - refundNotFound | REQUEST BODY { "cFiTransactionId": "UnknownId" } |
RESPONSE BODY { "requestId": "817b5e8092fa11efbfe134d6d15a4812", "code": "refundNotFound", "context": { "cFiTransactionId": "UnknownId" }, "message": "Refund not found." } |
| 400 payment-link/payment/refund-set-status requestValidateError Must be an allowed value | REQUEST BODY { "cFiTransactionId": "2RR2QHRIVjm3GfOJCOOmf7", "status": "UnknownStatus", "description": "Manual status set test" } |
RESPONSE BODY { "requestId": "1b75662092fb11efbfe134d6d15a4812", "code": "requestValidateError", "context": [ { "instancePath": "/status", "schemaPath": "#/properties/status/enum", "keyword": "enum", "params": { "allowedValues": [ "Initiated", "Sent", "Cancelled", "Rejected", "Error", "Expired", "Processing", "SentToPay", "Completed", "Settled", "Returned", "Declined" ] }, "message": "must be equal to one of the allowed values" } ] } |
| 400 payment-link/payment/refund-set-status requestValidateError Missing required property | REQUEST BODY { "cFiTransactionId": "2RR2QHRIVjm3GfOJCOOmf7", "description": "Manual status set test" } |
RESPONSE BODY { "requestId": "42d88f3092fb11efbfe134d6d15a4812", "code": "requestValidateError", "context": [ { "instancePath": "", "schemaPath": "#/required", "keyword": "required", "params": { "missingProperty": "status" }, "message": "must have required property 'status'" } ] } |
| 400 payment-link/merchant/invoice/list Error Response - paymentNotFound | REQUEST BODY { "cFiTransactionId": "UNKNOWN_TRANSACTION_ID" } |
RESPONSE BODY { "requestId": "b30158e0540e11efacdc860d03bdc411", "code": "paymentNotFound", "context": { "cFiTransactionId": "UNKNOWN_TRANSACTION_ID" }, "message": "Payment not found." } |
| 400 payment-link/merchant/invoice/file/:cFiInvoiceId Error Response - invoiceNotFound | PARAMETERS cFiInvoiceId:UNKNOWN_INVOICE_ID |
RESPONSE BODY { "requestId": "980e6ea0540f11efacdc860d03bdc411", "code": "invoiceNotFound", "context": { "cFiInvoiceId": "UNKNOWN_INVOICE_ID" }, "message": "Invoice not found." } |
| 400 public/merchant/payment/create requestValidateError Missing required field | REQUEST BODY { "invoiceNumber": "11126", "amount": 1.50, "currency": "USD", "dueDate": "2024-08-29", "description": "test description", "availablePaymentType": [ "card", "ach" ] } |
RESPONSE BODY { "requestId": "4e7fe400541711efb9c8eca582d34911", "code": "requestValidateError", "context": [ { "instancePath": "", "schemaPath": "#/required", "keyword": "required", "params": { "missingProperty": "fields" }, "message": "must have required property 'fields'" } ] } |
| 400 public/merchant/payment/create requestValidateError Cannot be less than minimum | REQUEST BODY { "fields": [ { "index": 1, "code": "firstName", "label": "First Name", "value": "John" }, { "index": 2, "code": "lastName", "label": "Last Name", "value": "Doe" }, { "index": 3, "code": "email", "label": "Email", "value": "customer_email@email.test" }, { "index": 4, "code": "phone", "label": "Phone", "value": "15555555555" } ], "invoiceNumber": "11124", "amount": -10, "currency": "USD", "dueDate": "2024-08-29", "description": "test description", "availablePaymentType": [ "card", "ach" ] } |
RESPONSE BODY { "requestId": "84962c70541711efb9c8eca582d34911", "code": "requestValidateError", "context": [ { "instancePath": "/amount", "schemaPath": "common#/definitions/amount/exclusiveMin imum", "keyword": "exclusiveMinimum", "params": { "comparison": ">", "limit": 0 }, "message": "must be > 0" } ] } |
| 400 public/merchant/payment/create requestValidateError Must be allowed value | REQUEST BODY { "fields": [ { "index": 1, "code": "firstName", "label": "First Name", "value": "John" }, { "index": 2, "code": "lastName", "label": "Last Name", "value": "Doe" }, { "index": 3, "code": "email", "label": "Email", "value": "customer_email@email.test" }, { "index": 4, "code": "phone", "label": "Phone", "value": "15555555555" } ], "invoiceNumber": "11124", "amount": 10, "currency": "USD", "dueDate": "2024-08-29", "description": "test description", "availablePaymentType": [ "UNKNOWN_PAYMENT_TYPE" ] } |
RESPONSE BODY { "requestId": "b4fa0580541711efb9c8eca582d34911", "code": "requestValidateError", "context": [ { "instancePath": "/availablePaymentType/0", "schemaPath": "#/properties/availablePaymentType/items /enum", "keyword": "enum", "params": { "allowedValues": [ "card", "ach" ] }, "message": "must be equal to one of the allowed values" } ] } |
| 400 public/merchant/payment/update requestValidateError Missing required property | REQUEST BODY { "fields": [ { "index": 1, "code": "firstName", "label": "First Name", "value": "John" }, { "index": 2, "code": "lastName", "label": "Last Name", "value": "Doe" }, { "index": 3, "code": "email", "label": "Email", "value": "customer_email@email.test" }, { "index": 4, "code": "phone", "label": "Phone", "value": "15556667777" } ], "invoiceNumber": "11123", "amount": 22.50, "currency": "USD" } |
RESPONSE BODY { "requestId": "991679b0541811efb9c8eca582d34911", "code": "requestValidateError", "context": [ { "instancePath": "", "schemaPath": "#/$merge/required", "keyword": "required", "params": { "missingProperty": "cFiTransactionId" }, "message": "must have required property 'cFiTransactionId'" }, { "instancePath": "", "schemaPath": "#/$merge", "keyword": "$merge", "params": {}, "message": "must pass \"$merge\" keyword validation" } ] } |
| 400 public/merchant/payment/update requestValidateError Cannot be less than minimum | REQUEST BODY { "cFiTransactionId": "FvuOBABxhupaLH4x2hn33", "fields": [ { "index": 1, "code": "firstName", "label": "First Name", "value": "John" }, { "index": 2, "code": "lastName", "label": "Last Name", "value": "Doe" }, { "index": 3, "code": "email", "label": "Email", "value": "customer_email@email.test" }, { "index": 4, "code": "phone", "label": "Phone", "value": "15556667777" } ], "invoiceNumber": "11123", "amount": -22.50, "currency": "USD" } |
RESPONSE BODY { "requestId": "b8685bd0541811efb9c8eca582d34911", "code": "requestValidateError", "context": [ { "instancePath": "/amount", "schemaPath": "common#/definitions/amount/exclusiveMin imum", "keyword": "exclusiveMinimum", "params": { "comparison": ">", "limit": 0 }, "message": "must be > 0" }, { "instancePath": "", "schemaPath": "#/$merge", "keyword": "$merge", "params": {}, "message": "must pass \"$merge\" keyword validation" } ] } |
| 400 public/merchant/payment/details Error Response - paymentNotFound | REQUEST BODY { "cFiTransactionId": "UNKNOWN_TRANSACTION_ID" } |
RESPONSE BODY { "requestId": "2885fd00541911efb9c8eca582d34911", "code": "paymentNotFound", "context": { "cFiTransactionId": "UNKNOWN_TRANSACTION_ID" }, "message": "Payment not found." } |
| 400 public/merchant/payment/details requestValidateError - Missing required property | REQUEST BODY { } |
RESPONSE BODY { "requestId": "6d311c80541b11efacdc860d03bdc411", "code": "requestValidateError", "context": [ { "instancePath": "", "schemaPath": "#/required", "keyword": "required", "params": { "missingProperty": "cFiMerchantId" }, "message": "must have required property 'cFiMerchantId'" } ] } |
| 400 public/merchant/payment/cancel requestValidateError - Missing required property | REQUEST BODY { } |
RESPONSE BODY { "requestId": "6d311c80541b11efacdc860d03bdc411", "code": "requestValidateError", "context": [ { "instancePath": "", "schemaPath": "#/required", "keyword": "required", "params": { "missingProperty": "cFiMerchantId" }, "message": "must have required property 'cFiMerchantId'" } ] } |
| 400 public/merchant/payment/cancel Error Response - paymentNotFound | REQUEST BODY { "cFiTransactionId": "UNKNOWN_TRANSACTION_ID" } |
RESPONSE BODY { "requestId": "2885fd00541911efb9c8eca582d34911", "code": "paymentNotFound", "context": { "cFiTransactionId": "UNKNOWN_TRANSACTION_ID" }, "message": "Payment not found." } |
| 400 public/merchant/payment/cancel Error Response - paymentStatus | REQUEST BODY { "cFiTransactionId": "FvuOBABxhupaLH4x2hn33" } |
RESPONSE BODY { "requestId": "bdedd680541211efacdc860d03bdc411", "code": "paymentStatus", "context": { "entityId": "yJ6pRvSIsp26qbbLgMVX3" }, "message": "Wrong Payment status" //Transaction does not have a cancellable current status } |
| 400 public/merchant/payment/send Error Response - paymentNotFound | REQUEST BODY { "cFiTransactionId": "UNKNOWN_TRANSACTION_ID" } |
RESPONSE BODY { "requestId": "5fc02c00541911efb9c8eca582d34911", "code": "paymentNotFound", "context": { "cFiTransactionId": "UNKNOWN_TRANSACTION_ID" }, "message": "Payment not found." } |
| 400 public/merchant/payment/send Error Response - paymentValidateFields | REQUEST BODY { "cFiTransactionId": "7l7TrL0ZukBQR4H4W2fsvT" } |
RESPONSE BODY { "requestId": "a62bf930541911efb9c8eca582d34911", "code": "paymentValidateFields", "context": { "entityId": "3iCpkXToGiNRgG62IRsTbr", //This payment link has invalid fields for sending. Correct invalid fields using /public/merchant/payment/update before sending "errors": [ "field: \"currency\" |
| 400 public/merchant/payment/send Error Response - paymentStatus | REQUEST BODY { "cFiTransactionId": "7l7TrL0ZukBQR4H4W2fsvT" } |
RESPONSE BODY { "requestId": "de064b7054ab11efb9c8eca582d34911", "code": "paymentStatus", "context": { "entityId": "4IuiHmOom7GfH6FG5nSbjH" }, "message": "Wrong Payment status" //Payment does not have a valid status for sending } |
| 400 public/merchant/payment/list requestValidateError - Invalid property format | REQUEST BODY { "dateCreateFrom": "2024/07/28", "dateCreateTo": "2024-08-01", "amountFrom": 0, "amountTo": 100, "skipRecords": 0, "numberOfRecords": 10 } |
RESPONSE BODY { "requestId": "7806d010541a11efb9c8eca582d34911", "code": "requestValidateError", "context": [ { "instancePath": "/dateCreateFrom", "schemaPath": "#/properties/dateCreateFrom/format", "keyword": "format", "params": { "format": "dateISO" }, "message": "must match format \"dateISO\"" } ] } |
| 400 public/merchant/payment/export-list Error Response - invalidDateRange | REQUEST BODY { "cFiTransactionIds": [], "dateCreateFrom": "2024-05-29T18:03:46.637Z", "dateCreateTo": "2024-08-30T18:03:46.637Z", "amountFrom": 0, "amountTo": 100, "payerName": "Doe John" } |
RESPONSE BODY { "requestId": "85a8f7d0541e11efb9c8eca582d34911", "code": "invalidDateRange", "context": { "cFiTransactionIds": [], "dateCreateFrom": "2024-05-29T18:03:46.637Z", "dateCreateTo": "2024-08-30T18:03:46.637Z", "amountFrom": 0, "amountTo": 100, "payerName": "Doe John", "maxDateRange": 3 //months }, "message": "Date range is too great." } |
| 400 public/merchant/logo/:logoId Error Response - logoNotFound | PARAMETERS logoId:3MPbtqzn0pB62JiNUNF6c9 |
RESPONSE BODY { "requestId": "aaa263b054a911efb9c8eca582d34911", "code": "logoNotFound", "context": { "logoId": "3MPbtqzn0pB62JiNUNF6c9" }, "message": "Logo not found." } |
| 400 public/merchant/remove/logo Error Response - logoNotFound | REQUEST BODY { "logoId": "UnknownId" } |
RESPONSE BODY { "requestId": "0aa1cf3092e411ef96cf56da8a860d70", "code": "logoNotFound", "context": { "logoId": "UnknownId" }, "message": "Logo not found." } |
| 400 public/merchant/invoice/upload Error Response - paymentStatus | RESPONSE BODY { "requestId": "b09d7fa04f2911ef92543a54d404e711", "code": "paymentStatus", "context": { "entityId": "7l7TrL0ZukBQR4H4W2fsvT" }, "message": "Wrong Payment status" //Current status must be Initiated in order to upload an invoice } |
|
| 400 public/merchant/invoice/upload Error Response - invoiceExists | RESPONSE BODY { "requestId": "487eadd0541611efb9c8eca582d34911", "code": "invoiceExists", "context": { "cFiTransactionId": "1dQrGr7fKM1H2wSQ6RiwY9" }, "message": "Invoice found for provided transaction." } |
|
| 400 public/merchant/invoice/upload Error Response - paymentNotFound | RESPONSE BODY { "requestId": "89f679a0541611efb9c8eca582d34911", "code": "paymentNotFound", "context": { "cFiTransactionId": "UNKNOWN_TRANSACTION_ID" }, "message": "Payment not found." } |
|
| 400 public/merchant/invoice/upload Error Response - fileNotFound | RESPONSE BODY { "requestId": "718a1ec0540d11efacdc860d03bdc411", "code": "fileNotFound", "message": "File not found." } |
|
| 400 public/merchant/invoice/list Error Response - paymentNotFound | REQUEST BODY { "cFiTransactionId": "UNKNOWN_TRANSACTION_ID" } |
RESPONSE BODY { "requestId": "7b939de054aa11efb9c8eca582d34911", "code": "paymentNotFound", "context": { "cFiTransactionId": "UNKNOWN_TRANSACTION_ID" }, "message": "Payment not found." } |
| 400 public/merchant/invoice/file/:cFiInvoiceId Error Response - invoiceNotFound | PARAMETERS cFiInvoiceId:UNKNOWN_INVOICE_ID |
RESPONSE BODY { "requestId": "0e7ae2d054ab11efb9c8eca582d34911", "code": "invoiceNotFound", "context": { "cFiInvoiceId": "UNKNOWN_INVOICE_ID" }, "message": "Invoice not found." } |
| 400 public/merchant/invoice/remove/:cFiInvoiceId Error Response - invoiceNotFound | PARAMETERS cFiInvoiceId:UNKNOWN_INVOICE_ID |
RESPONSE BODY { "requestId": "4afdc2e054ab11efb9c8eca582d34911", "code": "invoiceNotFound", "context": { "cFiInvoiceId": "UNKNOWN_INVOICE_ID" }, "message": "Invoice not found." } |
| 400 public/customer/payment/link Error Response - paymentNotFound | REQUEST BODY { "link": "UNKNOWN_PAYMENT_LINK" } |
RESPONSE BODY { "requestId": "2b98635054ac11efb9c8eca582d34911", "code": "paymentNotFound", "context": { "cFiTransactionId": "UNKNOWN_PAYMENT_LINK" }, "message": "Payment not found." } |
| 400 public/customer/payment/invoice/file/:cFiInvoiceId Error Response - invoiceNotFound | PARAMETERS cFiInvoiceId:UNKNOWN_INVOICE_ID |
RESPONSE BODY { "requestId": "d775510054ad11efb9c8eca582d34911", "code": "invoiceNotFound", "context": { "cFiInvoiceId": "UNKNOWN_INVOICE_ID" }, "message": "Invoice not found." } |
| 400 public/customer/payment/logo/:logoId Error Response - logoNotFound | PARAMETERS logoId:UNKNOWN_LOGO_ID |
RESPONSE BODY { "requestId": "0262160054ae11efb9c8eca582d34911", "code": "logoNotFound", "context": { "logoId": "UNKNOWN_LOGO_ID" }, "message": "Logo not found." } |
| 400 public/customer/payment/ach-pay Error Response - paymentStatus | REQUEST BODY { "individualName": "Merchant1", "account": { "routing": "011401533", "account": "1111222233330000", "subtype": "checking" } } |
RESPONSE BODY { "requestId": "41b8134054ae11efb9c8eca582d34911", "code": "paymentStatus", "context": { "entityId": "4IuiHmOom7GfH6FG5nSbjH" }, "message": "Wrong Payment status" //Current payment status is not valid for paying } |
| 400 public/customer/payment/ach-pay requestValidateError Missing required property | REQUEST BODY { "individualName": "Merchant1", "account": { "routing": "011401533", "subtype": "checking" } } |
RESPONSE BODY { "requestId": "aedd34f054ae11efb9c8eca582d34911", "code": "requestValidateError", "context": [ { "instancePath": "/account", "schemaPath": "#/properties/account/required", "keyword": "required", "params": { "missingProperty": "account" }, "message": "must have required property 'account'" } ] } |
| 400 public/customer/payment/ach-pay requestValidateError Must not exceed maximum | REQUEST BODY { "individualName": "Merchant1", "account": { "routing": "011401533123456789", "account": "1111222233330000", "subtype": "checking" } } |
RESPONSE BODY { "requestId": "f335b28054ae11efb9c8eca582d34911", "code": "requestValidateError", "context": [ { "instancePath": "/account/routing", "schemaPath": "ach#/definitions/routingNumber/maxLengt h", "keyword": "maxLength", "params": { "limit": 9 }, "message": "must NOT have more than 9 characters" } ] } |
| 400 public/customer/payment/ach-pay Error Response - paymentAvailableType | REQUEST BODY { "individualName": "Merchant1", "account": { "routing": "011401533", "account": "1111222233330000", "subtype": "checking" } } |
RESPONSE BODY { "requestId": "aac05ce054b211efb9c8eca582d34911", "code": "paymentAvailableType", "context": { "entityId": "6ocRUAdCrvcJnEFn8vWhmp" }, "message": "Wrong Payment type" //ACH is not an available payment type for this invoice } |
| 400 public/customer/payment/ach-pay Error Response - paymentPlaidAccount | REQUEST BODY { "individualName": "Merchant1", "account": { "routing": "011401533", "account": "1111222233330000", "subtype": "checking" } } |
RESPONSE BODY { "requestId": "789cdd0054b311efb9c8eca582d34911", "code": "paymentPlaidAccount", "context": { "account_id": "Rmnbwn4VVwCLKa5rdqnehPnB7J8ARNtaNKkP8" }, "message": "Payment Plaid Account Not Found" } |
| 400 public/customer/plaid/exchange-public-token Error Response plaid - Invalid format | REQUEST BODY { "public_token": "UNKNOWN_PUBLIC_TOKEN" } |
RESPONSE BODY { "requestId": "6cae7fc054af11efb9c8eca582d34911", "code": "plaid", "context": { "code": "INVALID_PUBLIC_TOKEN", "display_message": null, "error_type": "INVALID_INPUT", "request_id": "XGOAqv37eSZJuIN", "suggested_action": null }, "message": "provided public token is in an invalid format. expected format: public- } |
| 400 public/customer/plaid/exchange-public-token Error Response plaid - Expired public token | REQUEST BODY { "public_token": "public-sandbox-443c68a5-2ef4-4cb7-8fd5- 1c5747e8ff51" } |
RESPONSE BODY { "requestId": "9d99d85054af11efb9c8eca582d34911", "code": "plaid", "context": { "code": "INVALID_PUBLIC_TOKEN", "display_message": null, "error_type": "INVALID_INPUT", "request_id": "mDIllNG0MMlkaDs", "suggested_action": null }, "message": "provided public token is expired. Public tokens expire 30 minutes after creation at which point they can no longer be exchanged" } |
| 400 public/customer/plaid/exchange-public-token Error Response plaid - No matching token | REQUEST BODY { "public_token": "public-sandbox-443c68a5-2ef4-4cb7-8fd5- 123456789012" } |
RESPONSE BODY { "requestId": "e3d34ae054af11efb9c8eca582d34911", "code": "plaid", "context": { "code": "INVALID_PUBLIC_TOKEN", "display_message": null, "error_type": "INVALID_INPUT", "request_id": "euWeZoE2bRVkZQ3", "suggested_action": null }, "message": "could not find matching public token in db" } |
| 400 public/customer/plaid/exchange-public-token Error Response - plaidUnavailable | REQUEST BODY { "public_token": "public-sandbox-443c68a5-2ef4-4cb7-8fd5- 1c5747e8ff51" } |
RESPONSE BODY { "requestId": "789cdd0054b311efb9c8eca582d34911", "code": "plaidUnavailable", "context": {}, "message": "Plaid Unavailable for the merchant" } |
| 400 public/customer/plaid/get-accounts-balance Error Response - plaidAccessToken | RESPONSE BODY { "requestId": "224bb96054b011efb9c8eca582d34911", "code": "plaidAccessToken", "context": { "cFiSessionId": "4hOxF8yPWxW6ZJvW78YDvP" }, "message": "Plaid Access Token not found" } |
|
| 400 public/customer/payment/card-pay requestValidateError Missing required property | REQUEST BODY { "owner": { "name": { "first": "John", "middle": "M", "last": "Doe", "suffix": "III" }, "address": { "addressLine1": "1346 Pleasant Ave", "addressLine2": "Apt A123", "city": "Salt Lake City", "state": "UT", "postalCode": "12345", "country": "US" }, "phone": { "countryCode": "1", "number": "5556667777" } } } |
RESPONSE BODY { "requestId": "28f7c07054af11efb9c8eca582d34911", "code": "requestValidateError", "context": [ { "instancePath": "", "schemaPath": "#/required", "keyword": "required", "params": { "missingProperty": "clearCard" }, "message": "must have required property 'clearCard'" } ] } |
| 400 public/customer/payment/card-pay Error Response - merchantDetails | REQUEST BODY { "clearCard": { "accountNumber": "1234567890123456", "expirationDate": "202612", "securityCode": "123" }, "owner": { "name": { "first": "John", "middle": "M", "last": "Doe", "suffix": "III" }, "address": { "addressLine1": "1346 Pleasant Ave", "addressLine2": "Apt A123", "city": "Salt Lake City", "state": "UT", "postalCode": "12345", "country": "US" }, "phone": { "countryCode": "1", "number": "5556667777" } } } |
RESPONSE BODY { "requestId": "0789388054b211efb9c8eca582d34911", "code": "merchantDetails", "context": { "cFiMerchantId": "2sApBBEQbR7DA6FBxRoiaK" }, "message": "Merchant details are not full" //Finish filling out merchant details (address, city, state code, postal code, phone, email) via a /payment-link/merchant/update request } |
| 400 public/customer/payment/card-pay Error Response - paymentAvailableType | REQUEST BODY { "clearCard": { "accountNumber": "1234567890123456", "expirationDate": "202612", "securityCode": "123" }, "owner": { "name": { "first": "John", "middle": "M", "last": "Doe", "suffix": "III" }, "address": { "addressLine1": "1346 Pleasant Ave", "addressLine2": "Apt A123", "city": "Salt Lake City", "state": "UT", "postalCode": "12345", "country": "US" }, "phone": { "countryCode": "1", "number": "5556667777" } } } |
RESPONSE BODY { "requestId": "aac05ce054b211efb9c8eca582d34911", "code": "paymentAvailableType", "context": { "entityId": "6ocRUAdCrvcJnEFn8vWhmp" }, "message": "Wrong Payment type" //card is not an available payment type for this invoice } |
| 400 public/merchant/payment/ach/refund Error Response - paymentStatus | REQUEST BODY { "cFiTransactionId": "1rqF1edFQWTNmliNcIbp29", "amount": 1.01, "currency": "USD" } |
RESPONSE BODY { "requestId": "b76683d092f011ef893705725acd1211", "code": "paymentStatus", "context": {}, "message": "Wrong Payment status" } |
| 400 public/merchant/payment/ach/refund Error Response - unavailableAmount | REQUEST BODY { "cFiTransactionId": "1rqF1edFQWTNmliNcIbp29", "amount": 1000.01, "currency": "USD" } |
RESPONSE BODY { "requestId": "9bb36bf092f311ef893705725acd1211", "code": "unavailableAmount", "context": {}, "message": "Unavailable Amount" } |
| 400 public/merchant/payment/ach/refund Error Response - paymentNotFound | REQUEST BODY { "cFiTransactionId": "UnknownId", "amount": 1.01, "currency": "USD" } |
RESPONSE BODY { "requestId": "d52b2ee092f311ef893705725acd1211", "code": "paymentNotFound", "context": { "cFiTransactionId": "UnknownId" }, "message": "Payment not found." } |
| 400 public/merchant/payment/refund-list requestValidateError Must be an allowed value | REQUEST BODY { "cFiTransactionIds": [], "dateCreateFrom": "2024-08-30T18:03:46.637Z", "dateCreateTo": "2024-10-30T18:03:46.637Z", "status": "UnknownStatus" } |
RESPONSE BODY { "requestId": "d8a0d83092f411ef893705725acd1211", "code": "requestValidateError", "context": [ { "instancePath": "/status", "schemaPath": "#/properties/status/enum", "keyword": "enum", "params": { "allowedValues": [ "Initiated", "Sent", "Cancelled", "Rejected", "Error", "Expired", "Processing", "SentToPay", "Completed", "Settled", "Returned", "Declined" ] }, "message": "must be equal to one of the allowed values" } ] } |
| 400 public/merchant/payment/refund-details Error Response - refundNotFound | REQUEST BODY { "cFiTransactionId": "UnknownId" } |
RESPONSE BODY { "requestId": "9b396f1092f511ef893705725acd1211", "code": "refundNotFound", "context": { "cFiTransactionId": "UnknownId" }, "message": "Refund not found." } |
| 400 public/merchant/reminder/create Error Response - paymentNotFound | REQUEST BODY { "items": [ { "cFiTransactionId": "UnknownId", "remindDate": "2024-10-26", "notificationType": "sentLink", "notificationDeliveryTypes": ["SMS", "Email"] } ] } |
RESPONSE BODY { "requestId": "467e7f0092f611ef893705725acd1211", "code": "paymentNotFound", "context": { "cFiTransactionId": "UnknownId" }, "message": "Payment not found." } |
| 400 public/merchant/reminder/create requestValidateError Must be an allowed value | REQUEST BODY { "items": [ { "cFiTransactionId": "1mPKKOXGdRAjwSfwdHCVmg", "remindDate": "2024-10-26", "notificationType": "UnknownType", "notificationDeliveryTypes": ["SMS", "Email"] } ] } |
RESPONSE BODY { "requestId": "8857a4b092f611ef893705725acd1211", "code": "requestValidateError", "context": [ { "instancePath": "/items/0/notificationType", "schemaPath": "#/properties/items/items/properties/not ificationType/enum", "keyword": "enum", "params": { "allowedValues": [ "sentLink", "paidLink" ] }, "message": "must be equal to one of the allowed values" } ] } |
| 400 public/merchant/reminder/remove Error Response reminderNotFound | REQUEST BODY { "cFiReminderIds": ["UnknownId"], "cFiTransactionId": "7g5vgpiVqpEManU8FAxY4h" } |
RESPONSE BODY { "requestId": "7a59447092f811ef893705725acd1211", "code": "reminderNotFound", "context": { "entityId": "UnknownId" }, "message": "Payment reminder not found." } |
| 400 public/merchant/reminder/remove requestValidateError Missing required property | REQUEST BODY { "cFiReminderIds": ["7BzkATAk1fx49MKCS2SW41"] } |
RESPONSE BODY { "requestId": "3f49555092f811ef893705725acd1211", "code": "requestValidateError", "context": [ { "instancePath": "", "schemaPath": "#/required", "keyword": "required", "params": { "missingProperty": "cFiTransactionId" }, "message": "must have required property 'cFiTransactionId'" } ] } |
| 400 public/merchant/reminder/list requestValidateError No additional properties | REQUEST BODY { "cFiTransactionId": "7g5vgpiVqpEManU8FAxY4h", "additionalProperty": "something" } |
RESPONSE BODY { "requestId": "b5a40f2092f711ef893705725acd1211", "code": "requestValidateError", "context": [ { "instancePath": "", "schemaPath": "#/additionalProperties", "keyword": "additionalProperties", "params": { "additionalProperty": "additionalProperty" }, "message": "must NOT have additional properties" } ] } |
| undefined Successful Response | REQUEST BODY { "cFiTransactionIds": ["7g5vgpiVqpEManU8FAxY4h"], "notificationType": "sentLink" } |
RESPONSE BODY |