curl --request get \--url https://api.payroc.com/v1/contacts/89
application/json
{"contactId": 1543,"type": "manager","firstName": "Joe","middleName": "scott","lastName": "Bloggs","identifiers": [{"type": "nationalId","value": "xxx-xx-4320"}],"contactMethods": [{"type": "email",},{"type": "phone","value": "2025550104"},{"type": "mobile","value": "0987654321"}]}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Not Authorized | Your identity could not be verified |
Forbidden | You do not have the required permission |
Not found | Resource could not be found |
Api error | Unable to process your request. |
curl --request put \--url https://api.payroc.com/v1/contacts/89 \--header 'Content-Type: application/json' \--data '{"type":"manager","firstName":"David","middleName":"scott","lastName":"Simpson","identifiers":[{"type":"nationalId","value":"987-65-4320"}],"contactMethods":[{"type":"email","value":"[email protected]"}]}'
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Not Authorized | Your identity could not be verified |
Forbidden | You do not have the required permission |
Not found | Resource could not be found |
Not acceptable | Requested representation not supported |
Api error | Unable to process your request. |
curl --request delete \--url https://api.payroc.com/v1/contacts/89
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Not Authorized | Your identity could not be verified |
Forbidden | You do not have the required permission |
Not found | Resource could not be found |
Api error | Unable to process your request. |
curl --request post \--url https://api.payroc.com/v1/merchant-platforms \--header 'Content-Type: application/json' \--header 'Idempotency-Key: abc123' \--data '{"business":{"name":"abc123","taxId":"abc123","organizationType":"privateCorporation","countryOfOperation":"US","addresses":[{"type":"legalAddress","address1":"1 Example Ave.","address2":"abc123","address3":"abc123","city":"Example city","state":"Illinois","country":"US","postalCode":"60056"}],"contactMethods":[{"type":"email","value":"[email protected]"}]},"processingAccounts":[{"doingBusinessAs":"abc123","owners":[{"firstName":"David","middleName":"scott","lastName":"Simpson","dateOfBirth":"1964-03-22","address":{"address1":"1 Example Ave.","address2":"abc123","address3":"abc123","city":"Example city","state":"Illinois","country":"US","postalCode":"60056"},"identifiers":[{"type":"nationalId","value":"xxx-xx-4320"}],"contactMethods":[{"type":"email","value":"[email protected]"}],"relationship":{"equityPercentage":35.4,"title":"abc123","isControlProng":false,"isAuthorizedSignatory":false}}],"website":"abc123","businessType":"retail","categoryCode":5999,"merchandiseOrServiceSold":"abc123","businessStartDate":"2020-01-01","timezone":"Pacific/Midway","address":{"address1":"1 Example Ave.","address2":"abc123","address3":"abc123","city":"Example city","state":"Illinois","country":"US","postalCode":"60056"},"contactMethods":[{"type":"email","value":"[email protected]"}],"processing":{"transactionAmounts":{"average":89,"highest":89},"monthlyAmounts":{"average":89,"highest":89},"volumeBreakdown":{"cardPresentKeyed":47,"cardPresentSwiped":30,"mailOrTelephone":3,"ecommerce":20},"isSeasonal":false,"monthsOfOperation":["jan"],"ach":{"naics":"44-45","previouslyTerminatedForAch":false,"refunds":{"writtenRefundPolicy":false,"refundPolicyUrl":"abc123"},"estimatedMonthlyTransactions":89,"limits":{"singleTransaction":10000,"dailyDeposit":200000,"monthlyDeposit":89},"transactionTypes":["prearrangedPayment","other"],"transactionTypesOther":"anotherTransactionType"},"cardAcceptance":{"debitOnly":false,"cardsAccepted":["visa","mastercard","discover","amexOptBlue"],"specialityCards":{"americanExpressDirect":{"enabled":false,"merchantNumber":"abc123"},"electronicBenefitsTransfer":{"enabled":false,"fnsNumber":"1234567"},"other":{"wexMerchantNumber":"abc123","voyagerMerchantId":"abc123","fleetMerchantId":"abc123"}}}},"funding":{"fundingSchedule":"nextday","acceleratedFundingFee":1999,"dailyDiscount":false,"fundingAccounts":[{"type":"checking","use":"credit","nameOnAccount":"Joe Bloggs","paymentMethods":[{"type":"ach","value":{"routingNumber":"123456789","accountNumber":"1234567890"}}],"metadata":{"internalRef":"2345"}}]},"pricing":{"pricingIntentId":89},"signature":{"type":"requestedViaEmail"},"contacts":[{"type":"manager","firstName":"David","middleName":"scott","lastName":"Simpson","identifiers":[{"type":"nationalId","value":"987-65-4320"}],"contactMethods":[{"type":"email","value":"[email protected]"}]}],"metadata":{"customerId":"2345"}}],"metadata":{"customerId":"2345"}}'
application/json
{"merchantPlatformId": "12346","createdDate": "2020-09-08T12:00:00.000Z","lastModifiedDate": "2020-09-08T12:00:00.000Z","business": {"name": "Example corp","taxId": "xxx-xx-4321","organizationType": "privateCorporation","countryOfOperation": "US","addresses": [{"type": "legalAddress","address1": "1 Example Ave.","address2": "example line 2","address3": "example line 3","city": "Example city","state": "Illinois","country": "US","postalCode": "60056"}],"contactMethods": [{"type": "email",},{"type": "phone","value": "123 456 7890"}]},"processingAccounts": [{"processingAccountId": "38765","doingBusinessAs": "dba","status": "pending","link": {"rel": "processingAccount","href": "https://api.payroc.com/v1/processing-accounts/38765","method": "get"}}]}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Idempotency key missing | Idempotency key must be supplied |
Funding accounts limit reached | Funding accounts restricted. You can not have any more than two funding accounts attached to this entity |
Too many control prongs | Your request included more than one owner as the control prong. You can set only one owner as the control prong. |
No control prong or authorized signatory | Your request didn’t indicate which owner is the control prong or the authorized signatory. Set one owner as the control prong or the authorized signatory. |
Not Authorized | Your identity could not be verified |
Forbidden | You do not have the required permission |
Not acceptable | Requested representation not supported |
Idempotency key in use | Idempotency key in use |
Tax ID in use | The tax ID supplied is already in use. |
National ID in use | One or more supplied national IDs are not unique. All national IDs must be unique. |
Api error | Unable to process your request. |
GET /merchant-platformsRetrieve a list of merchant platforms associated with your account.
curl --request get \--url https://api.payroc.com/v1/merchant-platforms
application/json
{"limit": 2,"count": 2,"hasMore": true,"links": [{"rel": "previous","method": "get","href": "https://api.payroc.com/v1/merchant-platforms?before=12345&limit=2"},{"rel": "next","method": "get","href": "https://api.payroc.com/v1/merchant-platforms?after=12346&limit=2"}],"data": [{"merchantPlatformId": "12345","createdDate": "2020-09-08T12:00:00.000Z","lastModifiedDate": "2020-09-08T12:00:00.000Z","business": {"name": "Example corp","taxId": "xxx-xx-1234","organizationType": "privateCorporation","countryOfOperation": "US","addresses": [{"type": "legalAddress","address1": "1 Example Ave.","address2": "example line 2","address3": "example line 3","city": "Example city","state": "Illinois","country": "US","postalCode": "60056"}],"contactMethods": [{"type": "email",},{"type": "phone","value": "123 456 7890"}]},"processingAccounts": [{"processingAccountId": "237654","doingBusinessAs": "example dba","status": "pending","link": {"rel": "processingAccount","href": "https://api.payroc.com/v1/processing-accounts/237654","method": "get"}}]},{"merchantPlatformId": "12346","createdDate": "2020-09-08T12:00:00.000Z","lastModifiedDate": "2020-09-08T12:00:00.000Z","business": {"name": "Example corp","taxId": "xxx-xx-4321","organizationType": "privateCorporation","countryOfOperation": "US","addresses": [{"type": "legalAddress","address1": "1 Example Ave.","address2": "example line 2","address3": "example line 3","city": "Example city","state": "Illinois","country": "US","postalCode": "60056"}],"contactMethods": [{"type": "email",},{"type": "phone","value": "123 456 7890"}]},"processingAccounts": [{"processingAccountId": "38765","doingBusinessAs": "dba","status": "pending","link": {"rel": "processingAccount","href": "https://api.payroc.com/v1/processing-accounts/38765","method": "get"}}]}]}
Error | Description |
---|---|
Not Authorized | Your identity could not be verified |
Forbidden | You do not have the required permission |
Not acceptable | Requested representation not supported |
Api error | Unable to process your request. |
GET /merchant-platforms/{merchantPlatformId}Retrieve a specific merchant platform.
curl --request get \--url https://api.payroc.com/v1/merchant-platforms/abc123
application/json
{"merchantPlatformId": "12345","createdDate": "2020-09-08T12:00:00.000Z","lastModifiedDate": "2020-09-08T12:00:00.000Z","business": {"name": "abc123","taxId": "abc123","organizationType": "privateCorporation","countryOfOperation": "US","addresses": [{"type": "legalAddress","address1": "1 Example Ave.","address2": "abc123","address3": "abc123","city": "Example city","state": "Illinois","country": "US","postalCode": "60056"}],"contactMethods": [{"type": "email",}]},"processingAccounts": [{"processingAccountId": "12345","doingBusinessAs": "abc123","status": "entered","link": {"rel": "processingAccount","href": "https://api.payroc.com/v1/processing-accounts/1","method": "get"}}],"metadata": {"customerId": "2345"},"links": {"rel": "previous","method": "get","href": "<uri>"}}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Not Authorized | Your identity could not be verified |
Forbidden | You do not have the required permission |
Not found | Resource could not be found |
Not acceptable | Requested representation not supported |
Api error | Unable to process your request. |
GET /merchant-platforms/{merchantPlatformId}/processing-accountsRetrieve processing accounts associated with a merchant platform.
curl --request get \--url https://api.payroc.com/v1/merchant-platforms/abc123/processing-accounts
application/json
{"limit": 2,"count": 2,"hasMore": true,"links": [{"rel": "previous","method": "get","href": "https://api.payroc.com/v1/merchant-platforms/12345/processing-accounts?before=12345&limit=2"},{"rel": "next","method": "get","href": "https://api.payroc.com/v1/merchant-platforms/12346/processing-accounts?after=12346&limit=2"}],"data": [{"processingAccountId": "12345","createdDate": "2020-09-08T12:00:00.000Z","lastModifiedDate": "2020-09-08T12:00:00.000Z","status": "approved","doingBusinessAs": "Example business","owners": [{"ownerId": 4563,"firstName": "Jane","lastName": "Bloggs","link": {"rel": "owner","href": "https://api.payroc.com/v1/owners/4563","method": "get"}}],"website": "www.example.com","businessType": "retail","categoryCode": 5999,"merchandiseOrServiceSold": "Food","businessStartDate": "2020-01-01","timezone": "America/Chicago","address": {"address1": "1 Example Ave.","address2": "example line 2","address3": "example line 3","city": "Example city","state": "Illinois","country": "US","postalCode": "60056"},"contactMethods": [{"type": "email",},{"type": "phone","value": "123 456 7890"}],"processing": {"merchantId": "444412365478965","transactionAmounts": {"average": 1000,"highest": 200000},"monthlyAmounts": {"average": 1000000,"highest": 200000000},"volumeBreakdown": {"cardPresentKeyed": 47,"cardPresentSwiped": 30,"mailOrTelephone": 3,"ecommerce": 20},"isSeasonal": true,"monthsOfOperation": ["jan","feb","mar","nov","dec"],"ach": {"naics": "441222","previouslyTerminatedForAch": false,"refunds": {"writtenRefundPolicy": true,"refundPolicyUrl": "http://www.example.com/refunds"},"estimatedMonthlyTransactions": 1000,"limits": {"singleTransaction": 10000000,"dailyDeposit": 1000,"monthlyDeposit": 2000},"transactionTypes": ["telephoneInitiatedPayment","webInitiatedPayment"]},"cardAcceptance": {"debitOnly": false,"cardsAccepted": ["visa","mastercard"],"specialityCards": {"americanExpressDirect": {"enabled": true,"merchantNumber": "1234567890"},"electronicBenefitsTransfer": {"enabled": true,"fnsNumber": "1234567"},"other": {"wexMerchantNumber": "1234567890","voyagerMerchantId": "1234567890","fleetMerchantId": "1234567890"}}}},"funding": {"status": "enabled","fundingSchedule": "nextday","acceleratedFundingFee": 1999,"fundingAccounts": [{"fundingAccountId": 123,"status": "pending","link": {"rel": "fundingAccount","method": "get","href": "https://api.payroc.com/v1/funding-accounts/123"}}]},"pricing": {"link": {"rel": "pricing","method": "get","href": "https://api.payroc.com/v1/processing-account/12345/pricing"}},"signature": {"type": "requestedViaEmail"},"contacts": [{"contactId": 87926,"firstName": "Joe","lastName": "Bloggs","link": {"rel": "owner","href": "https://api.payroc.com/v1/contacts/87926","method": "get"}}]},{"processingAccountId": "12346","createdDate": "2020-09-08T12:00:00.000Z","lastModifiedDate": "2020-09-08T12:00:00.000Z","status": "approved","doingBusinessAs": "Example internet business","owners": [{"ownerId": 4564,"firstName": "Joe","lastName": "Bloggs","link": {"rel": "owner","href": "https://api.payroc.com/v1/owners/4564","method": "get"}}],"website": "www.example.com","businessType": "internet","categoryCode": 5999,"merchandiseOrServiceSold": "Food","businessStartDate": "2020-01-01","timezone": "America/Chicago","address": {"address1": "1 Example Ave.","address2": "example line 2","address3": "example line 3","city": "Example city","state": "Illinois","country": "US","postalCode": "60056"},"contactMethods": [{"type": "email",},{"type": "phone","value": "123 456 7890"}],"processing": {"merchantId": "444412365478966","transactionAmounts": {"average": 2000,"highest": 300000},"monthlyAmounts": {"average": 2000000,"highest": 300000000},"volumeBreakdown": {"cardPresentKeyed": 0,"cardPresentSwiped": 0,"mailOrTelephone": 0,"ecommerce": 100},"isSeasonal": false},"funding": {"status": "enabled","fundingSchedule": "nextday","acceleratedFundingFee": 1999,"fundingAccounts": [{"fundingAccountId": 124,"status": "pending","link": {"rel": "fundingAccount","method": "get","href": "https://api.payroc.com/v1/funding-accounts/124"}}]},"pricing": {"link": {"rel": "pricing","method": "get","href": "https://api.payroc.com/v1/processing-account/12346/pricing"}},"signature": {"type": "requestedViaEmail"},"contacts": [{"contactId": 87926,"firstName": "Joe","lastName": "Bloggs","link": {"rel": "owner","href": "https://api.payroc.com/v1/contacts/87926","method": "get"}}]}]}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Not Authorized | Your identity could not be verified |
Forbidden | You do not have the required permission |
Not acceptable | Requested representation not supported |
Api error | Unable to process your request. |
POST /merchant-platforms/{merchantPlatformId}/processing-accountsCreate a new processing account.
curl --request post \--url https://api.payroc.com/v1/merchant-platforms/abc123/processing-accounts \--header 'Content-Type: application/json' \--header 'Idempotency-Key: abc123' \--data '{"doingBusinessAs":"abc123","owners":[{"firstName":"David","middleName":"scott","lastName":"Simpson","dateOfBirth":"1964-03-22","address":{"address1":"1 Example Ave.","address2":"abc123","address3":"abc123","city":"Example city","state":"Illinois","country":"US","postalCode":"60056"},"identifiers":[{"type":"nationalId","value":"xxx-xx-4320"}],"contactMethods":[{"type":"email","value":"[email protected]"}],"relationship":{"equityPercentage":35.4,"title":"abc123","isControlProng":false,"isAuthorizedSignatory":false}}],"website":"abc123","businessType":"retail","categoryCode":5999,"merchandiseOrServiceSold":"abc123","businessStartDate":"2020-01-01","timezone":"Pacific/Midway","address":{"address1":"1 Example Ave.","address2":"abc123","address3":"abc123","city":"Example city","state":"Illinois","country":"US","postalCode":"60056"},"contactMethods":[{"type":"email","value":"[email protected]"}],"processing":{"transactionAmounts":{"average":89,"highest":89},"monthlyAmounts":{"average":89,"highest":89},"volumeBreakdown":{"cardPresentKeyed":47,"cardPresentSwiped":30,"mailOrTelephone":3,"ecommerce":20},"isSeasonal":false,"monthsOfOperation":["jan"],"ach":{"naics":"44-45","previouslyTerminatedForAch":false,"refunds":{"writtenRefundPolicy":false,"refundPolicyUrl":"abc123"},"estimatedMonthlyTransactions":89,"limits":{"singleTransaction":10000,"dailyDeposit":200000,"monthlyDeposit":89},"transactionTypes":["prearrangedPayment","other"],"transactionTypesOther":"anotherTransactionType"},"cardAcceptance":{"debitOnly":false,"cardsAccepted":["visa","mastercard","discover","amexOptBlue"],"specialityCards":{"americanExpressDirect":{"enabled":false,"merchantNumber":"abc123"},"electronicBenefitsTransfer":{"enabled":false,"fnsNumber":"1234567"},"other":{"wexMerchantNumber":"abc123","voyagerMerchantId":"abc123","fleetMerchantId":"abc123"}}}},"funding":{"fundingSchedule":"nextday","acceleratedFundingFee":1999,"dailyDiscount":false,"fundingAccounts":[{"type":"checking","use":"credit","nameOnAccount":"Joe Bloggs","paymentMethods":[{"type":"ach","value":{"routingNumber":"123456789","accountNumber":"1234567890"}}],"metadata":{"internalRef":"2345"}}]},"pricing":{"pricingIntentId":89},"signature":{"type":"requestedViaEmail"},"contacts":[{"type":"manager","firstName":"David","middleName":"scott","lastName":"Simpson","identifiers":[{"type":"nationalId","value":"987-65-4320"}],"contactMethods":[{"type":"email","value":"[email protected]"}]}],"metadata":{"customerId":"2345"}}'
application/json
{"processingAccountId": "12345","createdDate": "2020-09-08T12:00:00.000Z","lastModifiedDate": "2020-09-08T12:00:00.000Z","status": "entered","doingBusinessAs": "abc123","owners": [{"ownerId": 1,"firstName": "Joe","lastName": "Bloggs","link": {"rel": "owner","href": "https://api.payroc.com/v1/owners/1","method": "get"}}],"website": "abc123","businessType": "retail","categoryCode": 5999,"merchandiseOrServiceSold": "abc123","businessStartDate": "2020-01-01","timezone": "Pacific/Midway","address": {"address1": "1 Example Ave.","address2": "abc123","address3": "abc123","city": "Example city","state": "Illinois","country": "US","postalCode": "60056"},"contactMethods": [{"type": "email",}],"processing": {"merchantId": "444412365478965","transactionAmounts": {"average": 89,"highest": 89},"monthlyAmounts": {"average": 89,"highest": 89},"volumeBreakdown": {"cardPresentKeyed": 47,"cardPresentSwiped": 30,"mailOrTelephone": 3,"ecommerce": 20},"isSeasonal": false,"monthsOfOperation": ["jan"],"ach": {"naics": "44-45","previouslyTerminatedForAch": false,"refunds": {"writtenRefundPolicy": false,"refundPolicyUrl": "abc123"},"estimatedMonthlyTransactions": 89,"limits": {"singleTransaction": 10000,"dailyDeposit": 200000,"monthlyDeposit": 89},"transactionTypes": ["prearrangedPayment","other"],"transactionTypesOther": "anotherTransactionType"},"cardAcceptance": {"debitOnly": false,"cardsAccepted": ["visa","mastercard","discover","amexOptBlue"],"specialityCards": {"americanExpressDirect": {"enabled": false,"merchantNumber": "abc123"},"electronicBenefitsTransfer": {"enabled": false,"fnsNumber": "1234567"},"other": {"wexMerchantNumber": "abc123","voyagerMerchantId": "abc123","fleetMerchantId": "abc123"}}}},"funding": {"status": "enabled","fundingSchedule": "nextday","acceleratedFundingFee": 1999,"dailyDiscount": false,"fundingAccounts": [{"fundingAccountId": 123,"status": "pending","link": {"rel": "previous","method": "get","href": "<uri>"}}]},"pricing": {"link": {"rel": "pricing","href": "https://api.payroc.com/v1/processing-account/1/pricing","method": "get"}},"contacts": [{"contactId": 1,"firstName": "Joe","lastName": "Bloggs","link": {"rel": "contact","href": "https://api.payroc.com/v1/contacts/1","method": "get"}}],"signature": {"type": "requestedViaEmail"},"metadata": {"customerId": "2345"},"links": [{"rel": "merchantPricingAgreement","href": "https://agreementexpress.com/38765","method": "get"}]}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Idempotency key missing | Idempotency key must be supplied |
Funding accounts limit reached | Funding accounts restricted. You can not have any more than two funding accounts attached to this entity |
Too many control prongs | Your request included more than one owner as the control prong. You can set only one owner as the control prong. |
No control prong or authorized signatory | Your request didn’t indicate which owner is the control prong or the authorized signatory. Set one owner as the control prong or the authorized signatory. |
Not Authorized | Your identity could not be verified |
Not found | Resource could not be found |
Not acceptable | Requested representation not supported |
Idempotency key in use | Idempotency key in use |
Api error | Unable to process your request. |
curl --request get \--url https://api.payroc.com/v1/owners/89
application/json
{"ownerId": 1543,"firstName": "David","middleName": "scott","lastName": "Simpson","dateOfBirth": "1964-03-22","address": {"address1": "1 Example Ave.","city": "Example city","state": "Illinois","country": "US","postalCode": "60056"},"identifiers": [{"type": "nationalId","value": "xxx-xx-4320"}],"contactMethods": [{"type": "email",},{"type": "phone","value": "2025550104"},{"type": "mobile","value": "0987654321"}],"relationship": {"equityPercentage": 35.4,"title": "string","isControlProng": true,"isAuthorizedSignatory": false}}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Not Authorized | Your identity could not be verified |
Forbidden | You do not have the required permission |
Not found | Resource could not be found |
Api error | Unable to process your request. |
curl --request put \--url https://api.payroc.com/v1/owners/89 \--header 'Content-Type: application/json' \--data '{"firstName":"David","middleName":"scott","lastName":"Simpson","dateOfBirth":"1964-03-22","address":{"address1":"1 Example Ave.","address2":"abc123","address3":"abc123","city":"Example city","state":"Illinois","country":"US","postalCode":"60056"},"identifiers":[{"type":"nationalId","value":"xxx-xx-4320"}],"contactMethods":[{"type":"email","value":"[email protected]"}],"relationship":{"equityPercentage":35.4,"title":"abc123","isControlProng":false,"isAuthorizedSignatory":false}}'
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
KYC check failed | KYC check failed |
Not Authorized | Your identity could not be verified |
Forbidden | You do not have the required permission |
Not found | Resource could not be found |
Not acceptable | Requested representation not supported |
Api error | Unable to process your request. |
curl --request delete \--url https://api.payroc.com/v1/owners/89
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Not Authorized | Your identity could not be verified |
Forbidden | You do not have the required permission |
Not found | Resource could not be found |
Api error | Unable to process your request. |
curl --request get \--url https://api.payroc.com/v1/pricing-intents
application/json
{"limit": 1,"count": 1,"hasMore": true,"links": [{"rel": "previous","method": "get","href": "https://api.payroc.com/v1/pricing-intents?before=5&limit=1"},{"rel": "next","method": "get","href": "https://api.payroc.com/v1/pricing-intents?after=5&limit=1"}],"data": [{"id": "5","createdDate": "2020-09-22T09:00:00.000Z","lastUpdatedDate": "2020-09-22T09:00:00.000Z","status": "active","key": "base","country": "US","version": "4.0","base": {"addressVerification": 5,"annualFee": {"billInMonth": "december","amount": 100},"regulatoryAssistanceProgram": 15,"pciNonCompliance": 4995,"merchantAdvantage": 10,"platinumSecurity": {"billingFrequency": "monthly","amount": 1295},"maintenance": 500,"minimum": 100,"voiceAuthorization": 95,"chargeback": 2500,"retrieval": 1500,"batch": 1000,"earlyTermination": 57500},"processor": {"card": {"planType": "interchangePlus","fees": {"mastercardVisaDiscover": {"volume": 1.25,"transaction": 5},"amex": {"type": "optBlue","volume": 1.25,"transaction": 10},"pinDebit": {"additionalDiscount": 1.25,"transaction": 10,"monthlyAccess": 1200},"electronicBenefitsTransfer": {"transaction": 10},"enhancedInterchange": {"enrollment": 1000,"creditToMerchant": 5.25},"specialityCards": {"transaction": 10}}},"ach": {"fees": {"transaction": 50,"batch": 1000,"returns": 400,"unauthorizedReturn": 1999,"statement": 800,"monthlyMinimum": 20000,"accountVerification": 100,"discountRateUnder10000": 5.25,"discountRateAbove10000": 10}}},"gateway": {"fees": {"monthly": 1000,"setup": 25000,"perTransaction": 0,"perDeviceMonthly": 0,"additionalServiceMonthly": 0}}}]}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Not Authorized | Your identity could not be verified |
Forbidden | You do not have the required permission |
Api error | Unable to process your request. |
curl --request post \--url https://api.payroc.com/v1/pricing-intents \--header 'Content-Type: application/json' \--header 'Idempotency-Key: abc123' \--data '{"key":"abc123","metadata":{"internalReference":"2345"},"country":"US","version":"4.0","base":{"addressVerification":5,"annualFee":{"billInMonth":"december","amount":100},"regulatoryAssistanceProgram":15,"pciNonCompliance":4995,"merchantAdvantage":10,"platinumSecurity":{"billingFrequency":"monthly"},"maintenance":500,"minimum":100,"voiceAuthorization":95,"chargeback":2500,"retrieval":1500,"batch":1500,"earlyTermination":57500},"processor":{"card":{"planType":"interchangePlus","fees":{"mastercardVisaDiscover":{"volume":1.25,"transaction":0},"amex":{"type":"optBlue","volume":1.25,"transaction":0},"pinDebit":{"additionalDiscount":1.25,"transaction":0,"monthlyAccess":0},"electronicBenefitsTransfer":{"transaction":0},"enhancedInterchange":{"enrollment":0,"creditToMerchant":1.25},"specialityCards":{"transaction":0}}},"ach":{"fees":{"transaction":50,"batch":1000,"returns":400,"unauthorizedReturn":1999,"statement":800,"monthlyMinimum":20000,"accountVerification":100,"discountRateUnder10000":1.25,"discountRateAbove10000":1.25}}},"gateway":{"fees":{"monthly":0,"setup":0,"perTransaction":0,"perDeviceMonthly":0,"additionalServiceMonthly":0}}}'
application/json
{"id": "5","createdDate": "2020-09-22T09:00:00.000Z","lastUpdatedDate": "2020-09-22T09:00:00.000Z","status": "active","key": "string","metadata": {"internalReference": "2345"},"country": "US","version": "4.0","base": {"addressVerification": 5,"annualFee": {"billInMonth": "december","amount": 100},"regulatoryAssistanceProgram": 15,"pciNonCompliance": 4995,"merchantAdvantage": 10,"platinumSecurity": {"billingFrequency": "monthly","amount": 1295},"maintenance": 500,"minimum": 100,"voiceAuthorization": 95,"chargeback": 2500,"retrieval": 1500,"batch": 1000,"earlyTermination": 57500},"processor": {"card": {"planType": "interchangePlus","fees": {"mastercardVisaDiscover": {"volume": 1.25,"transaction": 5},"amex": {"type": "optBlue","volume": 1.25,"transaction": 10},"pinDebit": {"additionalDiscount": 1.25,"transaction": 10,"monthlyAccess": 1200},"electronicBenefitsTransfer": {"transaction": 10},"enhancedInterchange": {"enrollment": 1000,"creditToMerchant": 5.25},"specialityCards": {"transaction": 10}}},"ach": {"fees": {"transaction": 50,"batch": 1000,"returns": 400,"unauthorizedReturn": 1999,"statement": 800,"monthlyMinimum": 20000,"accountVerification": 100,"discountRateUnder10000": 5.25,"discountRateAbove10000": 10}}},"gateway": {"fees": {"monthly": 1000,"setup": 25000,"perTransaction": 0,"perDeviceMonthly": 0,"additionalServiceMonthly": 0}}}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Idempotency key missing | Idempotency key must be supplied |
Not Authorized | Your identity could not be verified |
Forbidden | You do not have the required permission |
Not acceptable | Requested representation not supported |
Idempotency key in use | Idempotency key in use |
Api error | Unable to process your request. |
curl --request get \--url https://api.payroc.com/v1/pricing-intents/abc123
application/json
{"id": "5","createdDate": "2020-09-22T09:00:00.000Z","lastUpdatedDate": "2020-09-22T09:00:00.000Z","status": "active","key": "string","metadata": {"internalReference": "2345"},"country": "US","version": "4.0","base": {"addressVerification": 5,"annualFee": {"billInMonth": "december","amount": 100},"regulatoryAssistanceProgram": 15,"pciNonCompliance": 4995,"merchantAdvantage": 10,"platinumSecurity": {"billingFrequency": "monthly","amount": 1295},"maintenance": 500,"minimum": 100,"voiceAuthorization": 95,"chargeback": 2500,"retrieval": 1500,"batch": 1000,"earlyTermination": 57500},"processor": {"card": {"planType": "interchangePlus","fees": {"mastercardVisaDiscover": {"volume": 1.25,"transaction": 5},"amex": {"type": "optBlue","volume": 1.25,"transaction": 10},"pinDebit": {"additionalDiscount": 1.25,"transaction": 10,"monthlyAccess": 1200},"electronicBenefitsTransfer": {"transaction": 10},"enhancedInterchange": {"enrollment": 1000,"creditToMerchant": 5.25},"specialityCards": {"transaction": 10}}},"ach": {"fees": {"transaction": 50,"batch": 1000,"returns": 400,"unauthorizedReturn": 1999,"statement": 800,"monthlyMinimum": 20000,"accountVerification": 100,"discountRateUnder10000": 5.25,"discountRateAbove10000": 10}}},"gateway": {"fees": {"monthly": 1000,"setup": 25000,"perTransaction": 0,"perDeviceMonthly": 0,"additionalServiceMonthly": 0}}}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Not Authorized | Your identity could not be verified |
Forbidden | You do not have the required permission |
Not found | Resource could not be found |
Api error | Unable to process your request. |
curl --request put \--url https://api.payroc.com/v1/pricing-intents/abc123 \--header 'Content-Type: application/json' \--data '{"key":"abc123","metadata":{"internalReference":"2345"},"country":"US","version":"4.0","base":{"addressVerification":5,"annualFee":{"billInMonth":"december","amount":100},"regulatoryAssistanceProgram":15,"pciNonCompliance":4995,"merchantAdvantage":10,"platinumSecurity":{"billingFrequency":"monthly"},"maintenance":500,"minimum":100,"voiceAuthorization":95,"chargeback":2500,"retrieval":1500,"batch":1500,"earlyTermination":57500},"processor":{"card":{"planType":"interchangePlus","fees":{"mastercardVisaDiscover":{"volume":1.25,"transaction":0},"amex":{"type":"optBlue","volume":1.25,"transaction":0},"pinDebit":{"additionalDiscount":1.25,"transaction":0,"monthlyAccess":0},"electronicBenefitsTransfer":{"transaction":0},"enhancedInterchange":{"enrollment":0,"creditToMerchant":1.25},"specialityCards":{"transaction":0}}},"ach":{"fees":{"transaction":50,"batch":1000,"returns":400,"unauthorizedReturn":1999,"statement":800,"monthlyMinimum":20000,"accountVerification":100,"discountRateUnder10000":1.25,"discountRateAbove10000":1.25}}},"gateway":{"fees":{"monthly":0,"setup":0,"perTransaction":0,"perDeviceMonthly":0,"additionalServiceMonthly":0}}}'
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Not Authorized | Your identity could not be verified |
Forbidden | You do not have the required permission |
Not found | Resource could not be found |
Not acceptable | Requested representation not supported |
Api error | Unable to process your request. |
PATCH /pricing-intents/{pricingIntentId}Partially update a pricing intent.
curl --request patch \--url https://api.payroc.com/v1/pricing-intents/abc123 \--header 'Content-Type: application/json' \--header 'Idempotency-Key: abc123' \--data '[{"op":"add","path":"/a/b/c","value":["foo","bar"]},{"op":"remove","path":"/a/b/c"},{"op":"replace","path":"/a/b/c","value":42},{"op":"move","from":"/a/b/c","path":"/a/b/d"},{"op":"copy","from":"/a/b/d","path":"/a/b/e"},{"op":"test","path":"/a/b/c","value":"foo"}]'
application/json
{"id": "5","createdDate": "2020-09-22T09:00:00.000Z","lastUpdatedDate": "2020-09-22T09:00:00.000Z","status": "active","key": "string","metadata": {"internalReference": "2345"},"country": "US","version": "4.0","base": {"addressVerification": 5,"annualFee": {"billInMonth": "december","amount": 100},"regulatoryAssistanceProgram": 15,"pciNonCompliance": 4995,"merchantAdvantage": 10,"platinumSecurity": {"billingFrequency": "monthly","amount": 1295},"maintenance": 500,"minimum": 100,"voiceAuthorization": 95,"chargeback": 2500,"retrieval": 1500,"batch": 1000,"earlyTermination": 57500},"processor": {"card": {"planType": "interchangePlus","fees": {"mastercardVisaDiscover": {"volume": 1.25,"transaction": 5},"amex": {"type": "optBlue","volume": 1.25,"transaction": 10},"pinDebit": {"additionalDiscount": 1.25,"transaction": 10,"monthlyAccess": 1200},"electronicBenefitsTransfer": {"transaction": 10},"enhancedInterchange": {"enrollment": 1000,"creditToMerchant": 5.25},"specialityCards": {"transaction": 10}}},"ach": {"fees": {"transaction": 50,"batch": 1000,"returns": 400,"unauthorizedReturn": 1999,"statement": 800,"monthlyMinimum": 20000,"accountVerification": 100,"discountRateUnder10000": 5.25,"discountRateAbove10000": 10}}},"gateway": {"fees": {"monthly": 1000,"setup": 25000,"perTransaction": 0,"perDeviceMonthly": 0,"additionalServiceMonthly": 0}}}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Not Authorized | Your identity could not be verified |
Forbidden | You do not have the required permission |
Not found | Resource could not be found |
Not acceptable | Requested representation not supported |
Api error | Unable to process your request. |
curl --request delete \--url https://api.payroc.com/v1/pricing-intents/abc123
Error | Description |
---|---|
Not Authorized | Your identity could not be verified |
Forbidden | You do not have the required permission |
Not found | Resource could not be found |
Api error | Unable to process your request. |
GET /processing-accounts/{processingAccountId}Retrieve a specific processing account.
curl --request get \--url https://api.payroc.com/v1/processing-accounts/abc123
application/json
{"processingAccountId": "12345","createdDate": "2020-09-08T12:00:00.000Z","lastModifiedDate": "2020-09-08T12:00:00.000Z","status": "entered","doingBusinessAs": "abc123","owners": [{"ownerId": 1,"firstName": "Joe","lastName": "Bloggs","link": {"rel": "owner","href": "https://api.payroc.com/v1/owners/1","method": "get"}}],"website": "abc123","businessType": "retail","categoryCode": 5999,"merchandiseOrServiceSold": "abc123","businessStartDate": "2020-01-01","timezone": "Pacific/Midway","address": {"address1": "1 Example Ave.","address2": "abc123","address3": "abc123","city": "Example city","state": "Illinois","country": "US","postalCode": "60056"},"contactMethods": [{"type": "email",}],"processing": {"merchantId": "444412365478965","transactionAmounts": {"average": 89,"highest": 89},"monthlyAmounts": {"average": 89,"highest": 89},"volumeBreakdown": {"cardPresentKeyed": 47,"cardPresentSwiped": 30,"mailOrTelephone": 3,"ecommerce": 20},"isSeasonal": false,"monthsOfOperation": ["jan"],"ach": {"naics": "44-45","previouslyTerminatedForAch": false,"refunds": {"writtenRefundPolicy": false,"refundPolicyUrl": "abc123"},"estimatedMonthlyTransactions": 89,"limits": {"singleTransaction": 10000,"dailyDeposit": 200000,"monthlyDeposit": 89},"transactionTypes": ["prearrangedPayment","other"],"transactionTypesOther": "anotherTransactionType"},"cardAcceptance": {"debitOnly": false,"cardsAccepted": ["visa","mastercard","discover","amexOptBlue"],"specialityCards": {"americanExpressDirect": {"enabled": false,"merchantNumber": "abc123"},"electronicBenefitsTransfer": {"enabled": false,"fnsNumber": "1234567"},"other": {"wexMerchantNumber": "abc123","voyagerMerchantId": "abc123","fleetMerchantId": "abc123"}}}},"funding": {"status": "enabled","fundingSchedule": "nextday","acceleratedFundingFee": 1999,"dailyDiscount": false,"fundingAccounts": [{"fundingAccountId": 123,"status": "pending","link": {"rel": "previous","method": "get","href": "<uri>"}}]},"pricing": {"link": {"rel": "pricing","href": "https://api.payroc.com/v1/processing-account/1/pricing","method": "get"}},"contacts": [{"contactId": 1,"firstName": "Joe","lastName": "Bloggs","link": {"rel": "contact","href": "https://api.payroc.com/v1/contacts/1","method": "get"}}],"signature": {"type": "requestedViaEmail"},"metadata": {"customerId": "2345"},"links": [{"rel": "merchantPricingAgreement","href": "https://agreementexpress.com/38765","method": "get"}]}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Not Authorized | Your identity could not be verified |
Forbidden | You do not have the required permission |
Not found | Resource could not be found |
Not acceptable | Requested representation not supported |
Api error | Unable to process your request. |
GET /processing-accounts/{processingAccountId}/funding-accountsRetrieve a list of funding accounts associated with a processing account.
curl --request get \--url https://api.payroc.com/v1/processing-accounts/abc123/funding-accounts
application/json
[{"fundingAccountId": 123,"createdDate": "2020-09-08T12:00:00.000Z","lastModifiedDate": "2020-09-08T12:00:00.000Z","status": "approved","type": "checking","use": "credit","nameOnAccount": "Joe Bloggs","paymentMethods": [{"type": "ach","value": {"routingNumber": "*****6789","accountNumber": "******7890"}}],"metadata": {"internalRef": "2345"},"links": [{"rel": "parent","href": "https://api.payroc.com/v1/processing-accounts/2","method": "get"}]},{"fundingAccountId": 124,"createdDate": "2021-01-08T12:00:00.000Z","lastModifiedDate": "2021-01-08T12:00:00.000Z","status": "pending","type": "checking","use": "debit","nameOnAccount": "Joe Bloggs","paymentMethods": [{"type": "ach","value": {"routingNumber": "*****8725","accountNumber": "******3491"}}],"metadata": {"internalRef": "2346"},"links": [{"rel": "parent","href": "https://api.payroc.com/v1/processing-accounts/2","method": "get"}]}]
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Not Authorized | Your identity could not be verified |
Not found | Resource could not be found |
Not acceptable | Requested representation not supported |
Api error | Unable to process your request. |
GET /processing-accounts/{processingAccountId}/contactsRetrieve a list of contacts associated with a processing account.
curl --request get \--url https://api.payroc.com/v1/processing-accounts/abc123/contacts
application/json
{"limit": 2,"count": 2,"hasMore": true,"links": [{"rel": "previous","method": "get","href": "https://api.payroc.com/v1/processing-accounts/12345/contacts?before=12345&limit=2"},{"rel": "next","method": "get","href": "https://api.payroc.com/v1/processing-accounts/12346/contacts?after=12346&limit=2"}],"data": [{"contactId": 12345,"type": "manager","firstName": "Joe","middleName": "Scott","lastName": "Bloggs","identifiers": [{"type": "nationalId","value": "xxx-xx-1234"}],