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":{"type":"intent","pricingIntentId":89},"signature":"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"},"signature": {"type": "requestedViaDirectLink","link": {"rel": "agreement","href": "https://us.agreementexpress.net/mv2/viewer2.jsp?docId=00000000-0000-0000-0000-000000000000","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"},"signature": {"type": "requestedViaDirectLink","link": {"rel": "agreement","href": "https://us.agreementexpress.net/mv2/viewer2.jsp?docId=00000000-0000-0000-0000-000000000000","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":{"type":"intent","pricingIntentId":89},"signature":"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": "requestedViaDirectLink","link": {"rel": "agreement","href": "https://us.agreementexpress.net/mv2/viewer2.jsp?docId=00000000-0000-0000-0000-000000000000","method": "get"}},"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": "requestedViaDirectLink","link": {"rel": "agreement","href": "https://us.agreementexpress.net/mv2/viewer2.jsp?docId=00000000-0000-0000-0000-000000000000","method": "get"}},"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"}],"contactMethods": [{"type": "phone","value": "98765432000"},{"type": "mobile","value": "85645787451"},{"type": "email",}]},{"contactId": 12346,"type": "representative","firstName": "Jane","middleName": "Emma","lastName": "Bloggs","identifiers": [{"type": "nationalId","value": "xxx-xx-9876"}],"contactMethods": [{"type": "phone","value": "98765432000"},{"type": "mobile","value": "85645787451"},{"type": "email",}]}]}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Not Authorized | Your identity could not be verified |
Not acceptable | Requested representation not supported |
Api error | Unable to process your request. |
GET /processing-accounts/{processingAccountId}/pricingRetrieve a pricing agreement for a processing account.
curl --request get \--url https://api.payroc.com/v1/processing-accounts/abc123/pricing
application/json
{"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": 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. |
GET /processing-accounts/{processingAccountId}/ownersRetrieve owners associated with a processing account.
curl --request get \--url https://api.payroc.com/v1/processing-accounts/abc123/owners
application/json
{"limit": 2,"count": 2,"hasMore": true,"links": [{"rel": "previous","method": "get","href": "https://api.payroc.com/v1/processing-accounts/12345/owners?before=12345&limit=2"},{"rel": "next","method": "get","href": "https://api.payroc.com/v1/processing-accounts/12346/owners?after=12346&limit=2"}],"data": [{"ownerId": 12345,"firstName": "Joe","middleName": "Scott","lastName": "Bloggs","dateOfBirth": "1964-03-22","address": {"address1": "1 Example Ave.","address2": "example line 2","address3": "example line 3","city": "Example city","state": "Illinois","country": "US","postalCode": "60056"},"identifiers": [{"type": "nationalId","value": "xxx-xx-1234"}],"contactMethods": [{"type": "email",},{"type": "phone","value": "1234567890"}],"relationship": {"equityPercentage": 49,"title": "CFO","isControlProng": false,"isAuthorizedSignatory": false}},{"ownerId": 12346,"firstName": "Jane","middleName": "Emma","lastName": "Bloggs","dateOfBirth": "1964-03-22","address": {"address1": "1 Example Ave.","address2": "example line 2","address3": "example line 3","city": "Example city","state": "Illinois","country": "US","postalCode": "60056"},"identifiers": [{"type": "nationalId","value": "xxx-xx-4321"}],"contactMethods": [{"type": "email",},{"type": "phone","value": "1234567890"}],"relationship": {"equityPercentage": 51,"title": "CEO","isControlProng": true,"isAuthorizedSignatory": false}}]}
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 /funding-accountsRetrieve a list of all funding accounts associated with the ISV.
curl --request get \--url https://api.payroc.com/v1/funding-accounts
application/json
{"limit": 2,"count": 2,"hasMore": true,"links": [{"rel": "previous","method": "get","href": "https://api.payroc.com/v1/funding-accounts?before=123&limit=2"},{"rel": "next","method": "get","href": "https://api.payroc.com/v1/funding-accounts?after=124&limit=2"}],"data": [{"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/merchants/1234","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/funding-recipient/2","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 |
Api error | Unable to process your request. |
GET /funding-accounts/{fundingAccountId}Retrieve a specific funding account.
curl --request get \--url https://api.payroc.com/v1/funding-accounts/89
application/json
{"fundingAccountId": 123,"createdDate": "2020-09-08T12:00:00.000Z","lastModifiedDate": "2020-09-08T12:00:00.000Z","status": "pending","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/merchants/1234","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 |
Api error | Unable to process your request. |
curl --request put \--url https://api.payroc.com/v1/funding-accounts/89 \--header 'Content-Type: application/json' \--data '{"type":"checking","use":"credit","nameOnAccount":"Joe Bloggs","paymentMethods":[{"type":"ach","value":{"routingNumber":"123456789","accountNumber":"1234567890"}}],"metadata":{"internalRef":"2345"}}'
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/funding-accounts/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. |
GET /funding-balanceRetrieve the balance of funds that are available for each merchant.
curl --request get \--url https://api.payroc.com/v1/funding-balance
application/json
{"limit": 2,"count": 2,"hasMore": true,"links": [{"rel": "previous","method": "get","href": "https://api.payroc.com/v1/funding-balance?before=65&limit=2"},{"rel": "next","method": "get","href": "https://api.payroc.com/v1/funding-balance?after=66&limit=2"}],"data": [{"merchantId": "65","funds": 120000,"pending": 50050,"available": 69950,"currency": "USD"},{"merchantId": "66","funds": 50000,"pending": 0,"available": 50000,"currency": "USD"}]}
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. |
curl --request get \--url 'https://api.payroc.com/v1/funding-activity?dateFrom=2022-10-01&dateTo=2022-10-01'
application/json
{"limit": 10,"count": 10,"hasMore": true,"links": [{"rel": "previous","method": "get","href": "https://api.payroc.com/v1/funding-activity?before=11&limit=10&datefrom=2021-01-01&dateto=2021-01-30"},{"rel": "next","method": "get","href": "https://api.payroc.com/v1/funding-activity?after=20&limit=10&datefrom=2021-01-01&dateto=2021-01-30"}],"data": [{"id": "11","date": "2021-01-01T17:00:00.000Z","merchant": "Joes Hot dogs","description": "sales","type": "credit","amount": 20000,"currency": "USD"},{"id": "12","date": "2021-01-01T19:32:00.000Z","merchant": "Joes Hot dogs","description": "sales","type": "credit","amount": 50000,"currency": "USD"},{"id": "13","date": "2021-01-01T17:00:00.000Z","merchant": "Joes Hot dogs","recipient": "Joes Hot dogs","description": "payment","type": "debit","amount": 10000,"currency": "USD"},{"id": "14","date": "2021-01-01T17:00:00.000Z","merchant": "Joes Hot dogs","recipient": "Payroc","description": "Interchange Fees","type": "debit","amount": 500,"currency": "USD"},{"id": "15","date": "2021-01-03T09:10:00.000Z","merchant": "Joes Hot dogs","description": "sales","type": "credit","amount": 30000,"currency": "USD"},{"id": "16","date": "2021-01-10T17:00:00.000Z","merchant": "Janes shoe laces LTD","description": "adjustment","type": "credit","amount": 500,"currency": "USD"},{"id": "17","date": "2021-01-10T17:00:00.000Z","merchant": "Janes shoe laces LTD","recipient": "Payroc","description": "Interchange Fees","type": "debit","amount": 500,"currency": "USD"},{"id": "18","date": "2021-01-15T17:00:00.000Z","merchant": "Joes Hot dogs","recipient": "Payroc","description": "Charge back","type": "debit","amount": 1000,"currency": "USD"},{"id": "19","date": "2021-01-17T17:00:00.000Z","merchant": "Janes shoe laces LTD","description": "sales","type": "credit","amount": 50000,"currency": "USD"},{"id": "20","date": "2021-01-26T17:00:00.000Z","merchant": "Joes Hot dogs","recipient": "Mr Payfac corp","description": "payment","type": "debit","amount": 5000,"currency": "USD"}]}
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 /funding-instructionsCreate funding instructions to tell us how to divide funds between your funding recipients.
curl --request post \--url https://api.payroc.com/v1/funding-instructions \--header 'Content-Type: application/json' \--header 'Idempotency-Key: abc123' \--data '{"merchants":[{"merchantId":"123456","recipients":[{"fundingAccountId":5432425374,"paymentMethod":"ACH","amount":{"value":12350,"currency":"USD"},"metadata":{"customerId":"2345"}}]}],"metadata":{"internalInstructionRef":"abcdef"}}'
application/json
{"instructionId": 123,"createdDate": "2021-09-05T13:15:00.000Z","lastModifiedDate": null,"status": "accepted","merchants": [{"merchantId": "99999","recipients": [{"status": "accepted","fundingAccountId": 67890,"paymentMethod": "ACH","amount": {"value": 12350,"currency": "USD"},"metadata": {"customerId": "2345"},"link": {"rel": "fundingAccount","method": "get","href": "https://api.payroc.com/v1/funding-accounts/67890"}}],"link": {"rel": "merchant","method": "get","href": "https://api.payroc.com/v1/merchants/99999"}}],"metadata": {"instructionRef": "abcd"}}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Insufficient funds | You do not have enough funds to complete the request. |
Idempotency key missing | Idempotency key must be supplied |
Funding accounts restricted | Funding accounts restricted. |
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. |
GET /funding-instructionsRetrieve a list of funding instructions for a specific date range.
curl --request get \--url 'https://api.payroc.com/v1/funding-instructions?dateFrom=2022-10-01&dateTo=2022-10-01'
application/json
{"limit": 2,"count": 2,"hasMore": true,"links": [{"rel": "previous","method": "get","href": "https://api.payroc.com/v1/funding-instructions?before=65&limit=2&datefrom=2021-01-01&dateto=2021-01-30"},{"rel": "next","method": "get","href": "https://api.payroc.com/v1/funding-instructions?after=66&limit=2&datefrom=2021-01-01&dateto=2021-01-30"}],"data": [{"instructionId": 65,"createdDate": "2021-09-05T13:15:00.000Z","lastModifiedDate": "2021-09-06T18:00:00.000Z","status": "completed","merchants": [{"merchantId": "99999","recipients": [{"status": "funded","fundingAccountId": 67890,"paymentMethod": "ACH","amount": {"value": 12350,"currency": "USD"},"metadata": {"customerId": "2345"},"link": {"rel": "fundingAccount","method": "get","href": "https://api.payroc.com/v1/funding-accounts/67890"}},{"status": "rejected","fundingAccountId": 67889,"paymentMethod": "ACH","amount": {"value": 9000,"currency": "USD"},"metadata": {"customerId": "2345"},"link": {"rel": "fundingAccount","method": "get","href": "https://api.payroc.com/v1/funding-accounts/67889"}}],"link": {"rel": "merchant","method": "get","href": "https://api.payroc.com/v1/merchants/99999"}}],"metadata": {"instrcutionRef": "abcd"},"link": {"rel": "fundingInstruction","method": "get","href": "https://api.payroc.com/v1/funding-instructions/65"}},{"instructionId": 66,"createdDate": "2021-09-06T13:15:00.000Z","lastModifiedDate": null,"status": "accepted","merchants": [{"merchantId": "12345","recipients": [{"status": "accepted","fundingAccountId": 54784,"paymentMethod": "ACH","amount": {"value": 5000,"currency": "USD"},"metadata": {"customerId": "5412"},"link": {"rel": "fundingAccount","method": "get","href": "https://api.payroc.com/v1/funding-accounts/54784"}}],"link": {"rel": "merchant","method": "get","href": "https://api.payroc.com/v1/merchants/12345"}},{"merchantId": 12346,"recipients": [{"status": "accepted","fundingAccountId": 54784,"paymentMethod": "ACH","amount": {"value": 1000,"currency": "USD"},"metadata": {"customerId": "5412"},"link": {"rel": "fundingAccount","method": "get","href": "https://api.payroc.com/v1/funding-accounts/54784"}}],"link": {"rel": "merchant","method": "get","href": "https://api.payroc.com/v1/merchants/12346"}}],"metadata": {"instrcutionRef": "efgh"},"link": {"rel": "fundingInstruction","method": "get","href": "https://api.payroc.com/v1/funding-instructions/66"}}]}
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. |
GET /funding-instructions/{instructionId}Retrieve a specific funding instruction.
curl --request get \--url https://api.payroc.com/v1/funding-instructions/89
application/json
{"instructionId": 12345,"createdDate": "2021-09-05T13:15:00.000Z","lastModifiedDate": "2021-09-06T18:00:00.000Z","status": "accepted","merchants": [{"merchantId": "123456","recipients": [{"fundingAccountId": 5432425374,"paymentMethod": "ACH","amount": {"value": 12350,"currency": "USD"},"status": "accepted","metadata": {"customerId": "2345"},"link": {"rel": "fundingAccount","method": "get","href": "https://api.payroc.com/v1/funding-accounts/5432425374"}}],"link": {"rel": "merchant","method": "get","href": "https://api.payroc.com/v1/merchants/123456"}}],"metadata": {"internalInstructionRef": "abcdef"}}
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. |
PUT /funding-instructions/{instructionId}Update an existing funding instruction.
curl --request put \--url https://api.payroc.com/v1/funding-instructions/89 \--header 'Content-Type: application/json' \--data '{"merchants":[{"merchantId":"123456","recipients":[{"fundingAccountId":5432425374,"paymentMethod":"ACH","amount":{"value":12350,"currency":"USD"},"metadata":{"customerId":"2345"}}]}],"metadata":{"internalInstructionRef":"abcdef"}}'
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Insufficient funds | You do not have enough funds to complete the request. |
Cannot be modified | Resource cannot be modified. |
Bad request | One or more validation errors occurred. |
Funding accounts restricted | Funding accounts restricted. |
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. |
DELETE /funding-instructions/{instructionId}Delete an existing funding instruction.
curl --request delete \--url https://api.payroc.com/v1/funding-instructions/89
Error | Description |
---|---|
Cannot be modified | Resource cannot be modified. |
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/funding-recipients \--header 'Content-Type: application/json' \--header 'Idempotency-Key: abc123' \--data '{"recipientType":"privateCorporation","taxId":"123456789","charityId":"abc123","doingBusinessAs":"abc123","address":{"address1":"1 Example Ave.","address2":"abc123","address3":"abc123","city":"Example city","state":"Illinois","country":"US","postalCode":"60056"},"contactMethods":[{"type":"email","value":"[email protected]"}],"metadata":{"customerId":"2345"},"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}}],"fundingAccounts":[{"type":"checking","use":"credit","nameOnAccount":"Joe Bloggs","paymentMethods":[{"type":"ach","value":{"routingNumber":"123456789","accountNumber":"1234567890"}}],"metadata":{"internalRef":"2345"}}]}'
application/json
{"recipientId": 1,"status": "approved","createdDate": "2020-09-08T12:00:00.000Z","lastModifiedDate": "2020-09-08T12:00:00.000Z","recipientType": "privateCorporation","taxId": "123456789","charityId": "abc123","doingBuinessAs": "abc123","address": {"address1": "1 Example Ave.","address2": "abc123","address3": "abc123","city": "Example city","state": "Illinois","country": "US","postalCode": "60056"},"contactMethods": [{"type": "email",}],"metadata": {"customerId": "2345"},"owners": [{"ownerId": 1,"link": {"rel": "owner","href": "https://api.payroc.com/v1/owners/1","method": "get"}}],"fundingAccounts": [{"fundingAccountId": 1,"status": "approved","link": {"rel": "fundingAccount","herf": "https://api.payroc.com/v1/funding-accounts/1","method": "get"}},{"fundingAccountId": 2,"status": "rejected","link": {"rel": "fundingAccount","herf": "https://api.payroc.com/v1/funding-accounts/2","method": "get"}}]}
Error | Description |
---|---|
Idempotency key missing | Idempotency key must be supplied |
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 acceptable | Requested representation not supported |
Idempotency key in use | Idempotency key in use |
Api error | Unable to process your request. |
GET /funding-recipientsRetrieve a list of all funding recipients associated with the ISV.
curl --request get \--url https://api.payroc.com/v1/funding-recipients
application/json
{"limit": 10,"count": 1,"hasMore": false,"links": [{"rel": "previous","method": "get","href": "https://api.payroc.com/v1/funding-recipients?before=12345&limit=10"}],"data": [{"recipientId": 12345,"status": "approved","createdDate": "2020-09-08T12:00:00.000Z","lastModifiedDate": "2020-09-08T12:00:00.000Z","recipientType": "privateCorporation","taxId": "123456789","doingBuinessAs": "Example llc","address": {"address1": "1 Example Ave.","city": "Example city","state": "Illinois","country": "US","postalCode": "60056"},"contactMethods": [{"type": "phone","value": "123 456 7890"}],"metadata": {"customerId": 12345},"owners": [{"ownerId": 1,"link": {"rel": "owner","method": "get","href": "https://api.payroc.com/v1/owners/1"}}],"fundingAccounts": [{"fundingAccountId": 1,"status": "approved","link": {"rel": "fundingAccount","method": "get","href": "https://api.payroc.com/v1/funding-accounts/1"}},{"fundingAccountId": 2,"status": "hold","link": {"rel": "fundingAccount","method": "get","href": "https://api.payroc.com/v1/funding-accounts/2"}}]}]}
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. |
GET /funding-recipients/{recipientId}Retrieve a specific funding recipient.
curl --request get \--url https://api.payroc.com/v1/funding-recipients/89
application/json
{"recipientId": 12345,"status": "approved","createdDate": "2020-09-08T12:00:00.000Z","lastModifiedDate": "2020-09-08T12:00:00.000Z","recipientType": "privateCorporation","taxId": "123456789","doingBuinessAs": "Example llc","address": {"address1": "1 Example Ave.","city": "Example city","state": "Illinois","country": "US","postalCode": "60056"},"contactMethods": [{"type": "phone","value": "123 456 7890"}],"metadata": {"customerId": 12345},"owners": [{"ownerId": 1,"link": {"rel": "owner","method": "get","href": "https://api.payroc.com/v1/owners/1"}}],"fundingAccounts": [{"fundingAccountId": 1,"status": "approved","link": {"rel": "fundingAccount","method": "get","href": "https://api.payroc.com/v1/funding-accounts/1"}},{"fundingAccountId": 2,"status": "hold","link": {"rel": "fundingAccount","method": "get","href": "https://api.payroc.com/v1/funding-accounts/2"}}]}
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. |
PUT /funding-recipients/{recipientId}Update a funding recipient. If you make significant changes, we may need to approve the funding recipient again.
curl --request put \--url https://api.payroc.com/v1/funding-recipients/89 \--header 'Content-Type: application/json' \--data '{"recipientType":"privateCorporation","taxId":"123456789","charityId":"abc123","doingBuinessAs":"abc123","address":{"address1":"1 Example Ave.","address2":"abc123","address3":"abc123","city":"Example city","state":"Illinois","country":"US","postalCode":"60056"},"contactMethods":[{"type":"email","value":"[email protected]"}],"metadata":{"customerId":"2345"}}'
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. |
DELETE /funding-recipients/{recipientId}Delete a funding recipient. This includes funding accounts and owners linked to the funding recipient.
curl --request delete \--url https://api.payroc.com/v1/funding-recipients/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. |
GET /funding-recipients/{recipientId}/funding-accountsRetrieve all funding accounts associated with the funding recipient.
curl --request get \--url https://api.payroc.com/v1/funding-recipients/89/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/funding-recipient/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/funding-recipient/2","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 |
Api error | Unable to process your request. |
POST /funding-recipients/{recipientId}/funding-accountsCreate a new funding account, and add it to the funding recipient.
curl --request post \--url https://api.payroc.com/v1/funding-recipients/89/funding-accounts \--header 'Content-Type: application/json' \--header 'Idempotency-Key: abc123' \--data '{"type":"checking","use":"credit","nameOnAccount":"Joe Bloggs","paymentMethods":[{"type":"ach","value":{"routingNumber":"123456789","accountNumber":"1234567890"}}],"metadata":{"internalRef":"2345"}}'
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/funding-recipient/2","method": "get"}]}
Error | Description |
---|---|
Idempotency key missing | Idempotency key must be supplied |
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 |
Idempotency key in use | Idempotency key in use |
Api error | Unable to process your request. |
GET /funding-recipients/{recipientId}/ownersRetrieve all owners associated with the funding recipient.
curl --request get \--url https://api.payroc.com/v1/funding-recipients/89/owners
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. |
POST /funding-recipients/{recipientId}/ownersCreate a new owner, and add it to the funding recipient.
curl --request post \--url https://api.payroc.com/v1/funding-recipients/89/owners \--header 'Content-Type: application/json' \--header 'Idempotency-Key: abc123' \--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}}'
application/json
{"ownerId": 1543,"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",}],"relationship": {"equityPercentage": 35.4,"title": "abc123","isControlProng": false,"isAuthorizedSignatory": false}}
Error | Description |
---|---|
Idempotency key missing | Idempotency key must be supplied |
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 |
Idempotency key in use | Idempotency key in use |
Api error | Unable to process your request. |
POST /devices/{serialNumber}/payment-instructionsSubmit an instruction request to initiate a sale on a payment device.
curl --request post \--url https://api.payroc.com/v1/devices/abc123/payment-instructions \--header 'Content-Type: application/json' \--header 'Idempotency-Key: abc123' \--data '{"operator":"jbloggs","processingTerminalId":"1021","order":{"orderId":"4fd4-99bc","currency":"USD","amount":1000},"customizationOptions":{"entryMethod":"deviceRead"},"autoCapture":true}'
application/json
{"paymentInstructionId": "3743a9165d134678a9100ebba3b29597","status": "inProgress","link": {"rel": "self","method": "GET","href": "https://api.payroc.com/v1/payment-instructions/3743a9165d134678a9100ebba3b29597"}}
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 found | Resource could not be found |
Not acceptable | Requested representation not supported |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
GET /payment-instructions/{paymentInstructionId}Retrieve the current status of a specific payment instruction.
curl --request get \--url https://api.payroc.com/v1/payment-instructions/abc123
application/json
{"paymentInstructionId": "3743a9165d134678a9100ebba3b29597","status": "completed","link": {"rel": "payment","method": "GET","href": "https://api.payroc.com/v1/payments/DD6ZDQU7L2"}}
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. |
POST /devices/{serialNumber}/refund-instructionsSubmit an instruction request to initiate a refund on a payment device.
curl --request post \--url https://api.payroc.com/v1/devices/abc123/refund-instructions \--header 'Content-Type: application/json' \--header 'Idempotency-Key: abc123' \--data '{"operator":"jbloggs","processingTerminalId":"1021","order":{"orderId":"4fd4-99bc","currency":"USD","amount":1000},"customizationOptions":{"entryMethod":"manualEntry"}}'
application/json
{"refundInstructionId": "3743a9165d134678a9100ebba3b29597","status": "inProgress","link": {"rel": "self","method": "GET","href": "https://api.payroc.com/v1/refund-instructions/3743a9165d134678a9100ebba3b29597"}}
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 found | Resource could not be found |
Not acceptable | Requested representation not supported |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
GET /refund-instructions/{refundInstructionId}Retrieve the current status of a specific refund instruction.
curl --request get \--url https://api.payroc.com/v1/refund-instructions/abc123
application/json
{"refundInstructionId": "3743a9165d134678a9100ebba3b29597","status": "completed","link": {"rel": "refund","method": "GET","href": "https://api.payroc.com/v1/refunds/DD6ZDQU7L2"}}
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 post \--url https://api.payroc.com/v1/bank-accounts/verify \--header 'Content-Type: application/json' \--header 'Idempotency-Key: abc123' \--data '{"processingTerminalId":"1017","bankAccount":{"type":"pad","accountType":"checking","nameOnAccount":"Joe Bloggs","accountNumber":"12345678909","routingNumber":"123456789","transitNumber":"12345","institutionNumber":"123"}}'
application/json
{"processingTerminalId": "1017","verified": true}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Idempotency key missing | Idempotency key must be supplied |
Idempotency key in use | Idempotency key in use |
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 |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
curl --request post \--url https://api.payroc.com/v1/bank-transfer-payments \--header 'Content-Type: application/json' \--header 'Idempotency-Key: abc123' \--data '{"processingTerminalId":"1017","order":{"orderId":"orderpop123","description":"sample order","amount":11110,"currency":"USD","breakdown":{"subtotal":10000,"tip":{"type":"percentage","percentage":10},"taxes":[{"name":"VAT","rate":1}]}},"customer":{"notificationLanguage":"en","contactMethods":[{"type":"email","value":"[email protected]"}]},"credentialOnFile":{"tokenize":true},"paymentMethod":{"type":"ach","accountType":"checking","nameOnAccount":"Joe Bloggs","accountNumber":"11101010","routingNumber":"053200983","secCode":"web"}}'
application/json
{"paymentId": "M2MJOG6O2Y","processingTerminalId": "1017","order": {"orderId": "orderpop123","dateTime": "2023-07-25T13:08:45.179Z","description": "sample order","amount": 11110,"currency": "USD","breakdown": {"subtotal": 10000,"tip": {"type": "percentage","amount": 1010,"percentage": 10},"taxes": [{"name": "VAT","rate": 1,"amount": 100}]}},"customer": {"contactMethods": [{"type": "email",}],"notificationLanguage": "en"},"bankAccount": {"type": "ach","secCode": "web","accountType": "checking","nameOnAccount": "Joe Bloggs","accountNumber": "****1010","routingNumber": "053200983","secureToken": {"secureTokenId": "MREF_8d9b44e4-fd9c-45a7-b4b5-5e3d591dd385tK","customerName": "Joe Bloggs","token": "2967534039611822","status": "notValidated","link": {"rel": "self","method": "GET","href": "https://api.payroc.com/v1/processing-terminals/1017/secure-tokens/MREF_8d9b44e4-fd9c-45a7-b4b5-5e3d591dd385tK"}}},"transactionResult": {"type": "payment","status": "ready","authorizedAmount": 11110,"currency": "USD","responseCode": "A","responseMessage": "NoError","processorResponseCode": "0"}}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Idempotency key missing | Idempotency key must be supplied |
Idempotency key in use | Idempotency key in use |
Not Authorized | Your identity could not be verified |
Forbidden | You do not have the required permission |
Not acceptable | Requested representation not supported |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
curl --request get \--url 'https://api.payroc.com/v1/bank-transfer-payments?processingTerminalId=abc123'
application/json
{"limit": 2,"count": 2,"hasMore": true,"data": [{"paymentId": "GTNOY9O4R4","processingTerminalId": "1017","order": {"orderId": "602","dateTime": "2023-05-16T15:53:18.000Z","description": "sample order","amount": 12100,"currency": "CAD","breakdown": {"subtotal": 10000,"tip": {"type": "percentage","amount": 1100,"percentage": 10},"taxes": [{"name": "VAT","rate": 10,"amount": 1000}]}},"customer": {"contactMethods": [{"type": "email",}],"notificationLanguage": "en"},"bankAccount": {"type": "pad","nameOnAccount": "Joe Bloggs","accountNumber": "*******8909","transitNumber": "12345","institutionNumber": "123"},"transactionResult": {"type": "payment","status": "ready","authorizedAmount": 12100,"currency": "CAD","responseCode": "A"}},{"paymentId": "E29U8OU8Q4","processingTerminalId": "1017","order": {"orderId": "541","dateTime": "2023-05-16T15:52:56.000Z","description": "test","amount": 12100,"currency": "CAD","breakdown": {"subtotal": 10000,"tip": {"type": "percentage","amount": 1100,"percentage": 10},"taxes": [{"name": "VAT","rate": 10,"amount": 1000}]}},"customer": {"contactMethods": [{"type": "email",}],"notificationLanguage": "en"},"bankAccount": {"type": "pad","nameOnAccount": "Joe Bloggs","accountNumber": "*******8909","transitNumber": "12345","institutionNumber": "123"},"transactionResult": {"type": "payment","status": "ready","authorizedAmount": 12100,"currency": "CAD","responseCode": "A"}}],"links": [{"rel": "next","method": "get","href": "https://api.payroc.com/v1/bank-transfer-payments?limit=2&processingTerminalId=1017&after=E29U8OU8Q4"},{"rel": "previous","method": "get","href": "https://api.payroc.com/v1//bank-transfer-payments?limit=2&processingTerminalId=1017&before=GTNOY9O4R4"}]}
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. |
curl --request get \--url https://api.payroc.com/v1/bank-transfer-payments/abc123
application/json
{"paymentId": "M2MJOG6O2Y","processingTerminalId": "1017","order": {"orderId": "orderpop123","dateTime": "2023-07-25T13:08:45.179Z","description": "sample order","amount": 11110,"currency": "USD","breakdown": {"subtotal": 10000,"tip": {"type": "percentage","amount": 1010,"percentage": 10},"taxes": [{"name": "VAT","rate": 1,"amount": 100}]}},"customer": {"contactMethods": [{"type": "email",}],"notificationLanguage": "en"},"bankAccount": {"type": "ach","secCode": "web","accountType": "checking","nameOnAccount": "Joe Bloggs","accountNumber": "****1010","routingNumber": "053200983","secureToken": {"secureTokenId": "MREF_8d9b44e4-fd9c-45a7-b4b5-5e3d591dd385tK","customerName": "Joe Bloggs","token": "2967534039611822","status": "notValidated","link": {"rel": "self","method": "GET","href": "https://api.payroc.com/v1/processing-terminals/1017/secure-tokens/MREF_8d9b44e4-fd9c-45a7-b4b5-5e3d591dd385tK"}}},"transactionResult": {"type": "payment","status": "ready","authorizedAmount": 11110,"currency": "USD","responseCode": "A","responseMessage": "NoError","processorResponseCode": "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 post \--url https://api.payroc.com/v1/bank-transfer-payments/abc123/reverse \--header 'Idempotency-Key: abc123'
application/json
{"paymentId": "JKNIJXNZAK","processingTerminalId": "1017","order": {"orderId": "157","dateTime": "2023-05-16T15:54:43.000Z","description": "sample order","amount": 12100,"currency": "CAD","breakdown": {"subtotal": 10000,"tip": {"type": "percentage","percentage": 10},"taxes": [{"name": "VAT","rate": 10,"amount": 1000}]}},"customer": {"contactMethods": [{"type": "email",}],"notificationLanguage": "en"},"bankAccount": {"type": "pad","nameOnAccount": "Joe Bloggs","accountNumber": "*******8909","transitNumber": "12345","institutionNumber": "123"},"transactionResult": {"type": "payment","status": "reversal","authorizedAmount": 12100,"currency": "CAD","responseCode": "A"}}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Idempotency key missing | Idempotency key must be supplied |
Idempotency key in use | Idempotency key in use |
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 |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
curl --request post \--url https://api.payroc.com/v1/bank-transfer-payments/abc123/refund \--header 'Content-Type: application/json' \--header 'Idempotency-Key: abc123' \--data '{"amount":10000,"description":"amount to refund"}'
application/json
{"paymentId": "M12F8SUHGM","processingTerminalId": "1017","order": {"orderId": "243","dateTime": "2023-07-25T21:57:11.000Z","description": "amount to refund","amount": 11110,"currency": "CAD","breakdown": {"subtotal": 10000,"tip": {"type": "percentage","amount": 1010,"percentage": 10},"taxes": [{"name": "VAT","rate": 1,"amount": 100}]}},"customer": {"contactMethods": [{"type": "email",}],"notificationLanguage": "en"},"bankAccount": {"type": "pad","nameOnAccount": "Joe Bloggs","accountNumber": "****9031","transitNumber": "14574","institutionNumber": "644","secureToken": {"secureTokenId": "MREF_465772d1-ab4e-4881-8052-5021a745ed18Df","customerName": "Joe Bloggs","token": "2967536686508441","status": "notValidated","link": {"rel": "self","method": "GET","href": "https://api.payroc.com/v1/processing-terminals/1017/secure-tokens/MREF_465772d1-ab4e-4881-8052-5021a745ed18Df"}}},"transactionResult": {"type": "payment","status": "reversal","authorizedAmount": 11110,"currency": "CAD","responseCode": "A"}}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Idempotency key missing | Idempotency key must be supplied |
Idempotency key in use | Idempotency key in use |
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 |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
POST /bank-transfer-payments/{paymentId}/representRe-present a customer's bank account details if the first payment was declined.
curl --request post \--url https://api.payroc.com/v1/bank-transfer-payments/abc123/represent \--header 'Content-Type: application/json' \--header 'Idempotency-Key: abc123' \--data '{"paymentMethod":{"type":"ach","accountType":"checking","nameOnAccount":"Joe Bloggs","accountNumber":"49100130","routingNumber":"292735277","secCode":"TEL"}}'
application/json
{"paymentId": "M2MJOG6O2Y","processingTerminalId": "1017","order": {"orderId": "orderpop123","dateTime": "2023-07-25T13:08:45.179Z","description": "sample order","amount": 11110,"currency": "USD","breakdown": {"subtotal": 10000,"tip": {"type": "percentage","amount": 1010,"percentage": 10},"taxes": [{"name": "VAT","rate": 1,"amount": 100}]}},"customer": {"contactMethods": [{"type": "email",}],"notificationLanguage": "en"},"bankAccount": {"type": "ach","secCode": "web","accountType": "checking","nameOnAccount": "Joe Bloggs","accountNumber": "****1010","routingNumber": "053200983","secureToken": {"secureTokenId": "MREF_8d9b44e4-fd9c-45a7-b4b5-5e3d591dd385tK","customerName": "Joe Bloggs","token": "2967534039611822","status": "notValidated","link": {"rel": "self","method": "GET","href": "https://api.payroc.com/v1/processing-terminals/1017/secure-tokens/MREF_8d9b44e4-fd9c-45a7-b4b5-5e3d591dd385tK"}}},"transactionResult": {"type": "payment","status": "ready","authorizedAmount": 11110,"currency": "USD","responseCode": "A","responseMessage": "NoError","processorResponseCode": "0"}}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Idempotency key missing | Idempotency key must be supplied |
Idempotency key in use | Idempotency key in use |
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 |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
POST /bank-transfer-refundsSend a refund to a customer's bank account. The refund transaction is not linked to the previous transaction.
curl --request post \--url https://api.payroc.com/v1/bank-transfer-refunds \--header 'Content-Type: application/json' \--header 'Idempotency-Key: abc123' \--data '{"processingTerminalId":"1017","order":{"orderId":314,"description":"refund example","amount":1000,"currency":"USD"},"customer":{"notificationLanguage":"en","contactMethods":[{"type":"email","value":"[email protected]"}]},"refundMethod":{"type":"ach","secCode":"web","accountType":"checking","nameOnAccount":"Joe Bloggs","accountNumber":"32183159","routingNumber":"063100277"}}'
application/json
{"refundId": "JH58KQ5K5E","processingTerminalId": "1017","order": {"orderId": "314","dateTime": "2023-05-17T13:24:11.693Z","description": "refund example","amount": 50000,"currency": "USD"},"customer": {"contactMethods": [{"type": "email",}],"notificationLanguage": "en"},"bankAccount": {"type": "ach","secCode": "web","accountType": "checking","nameOnAccount": "Joe Bloggs","accountNumber": "****3159","routingNumber": "*****0277"},"transactionResult": {"type": "unreferencedRefund","status": "ready","authorizedAmount": -50000,"currency": "USD","responseCode": "A","responseMessage": "NoError","processorResponseCode": "0"}}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Idempotency key missing | Idempotency key must be supplied |
Idempotency key in use | Idempotency key in use |
Not Authorized | Your identity could not be verified |
Forbidden | You do not have the required permission |
Not acceptable | Requested representation not supported |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
curl --request get \--url 'https://api.payroc.com/v1/bank-transfer-refunds?processingTerminalId=abc123'
application/json
{"limit": 2,"count": 2,"hasMore": true,"data": [{"refundId": "DYDJ5KHRT4","processingTerminalId": "1017","order": {"orderId": "304","dateTime": "2023-05-17T13:23:41.000Z","description": "refund example","amount": 100000,"currency": "USD"},"customer": {"contactMethods": [{"type": "email",}],"notificationLanguage": "en"},"bankAccount": {"type": "ach","secCode": "web","accountType": "checking","nameOnAccount": "Joe Bloggs","accountNumber": "****3159","routingNumber": "*****0277"},"transactionResult": {"type": "unreferencedRefund","status": "ready","authorizedAmount": -100000,"currency": "USD","responseCode": "A","responseMessage": "NoError","processorResponseCode": "0"}},{"refundId": "B6ZOFZNVOP","processingTerminalId": "1017","order": {"orderId": "355","dateTime": "2023-05-17T13:21:30.000Z","description": "refund example","amount": 12000,"currency": "USD"},"customer": {"contactMethods": [{"type": "email",}],"notificationLanguage": "en"},"bankAccount": {"type": "ach","secCode": "web","accountType": "checking","nameOnAccount": "Joe Bloggs","accountNumber": "****3159","routingNumber": "*****0277"},"transactionResult": {"type": "unreferencedRefund","status": "ready","authorizedAmount": -12000,"currency": "USD","responseCode": "A","responseMessage": "NoError","processorResponseCode": "0"}}],"links": [{"rel": "next","method": "get","href": "https://api.payroc.com/v1/bank-transfer-refunds?limit=2&processingTerminalId=1017&after=B6ZOFZNVOP"},{"rel": "previous","method": "get","href": "https://api.payroc.com/v1/bank-transfer-refunds?processingTerminalId=1017&limit=2&before=DYDJ5KHRT4"}]}
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. |
curl --request get \--url https://api.payroc.com/v1/bank-transfer-refunds/abc123
application/json
{"refundId": "JH58KQ5K5E","processingTerminalId": "1017","order": {"orderId": "314","dateTime": "2023-05-17T13:24:11.693Z","description": "refund example","amount": 50000,"currency": "USD"},"customer": {"contactMethods": [{"type": "email",}],"notificationLanguage": "en"},"bankAccount": {"type": "ach","secCode": "web","accountType": "checking","nameOnAccount": "Joe Bloggs","accountNumber": "****3159","routingNumber": "*****0277"},"transactionResult": {"type": "unreferencedRefund","status": "ready","authorizedAmount": -50000,"currency": "USD","responseCode": "A","responseMessage": "NoError","processorResponseCode": "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 post \--url https://api.payroc.com/v1/bank-transfer-refunds/abc123/reverse \--header 'Idempotency-Key: abc123'
application/json
{"refundId": "B5FK0CBP2D","processingTerminalId": "1017","order": {"orderId": "622","dateTime": "2023-05-17T13:54:51.000Z","description": "refund example","amount": 1000,"currency": "USD"},"customer": {"contactMethods": [{"type": "email",}],"notificationLanguage": "en"},"bankAccount": {"type": "ach","secCode": "web","accountType": "checking","nameOnAccount": "Joe Bloggs","accountNumber": "****3159","routingNumber": "*****0277"},"transactionResult": {"type": "unreferencedRefund","status": "reversal","authorizedAmount": -1000,"currency": "USD","responseCode": "A","responseMessage": "NoError","processorResponseCode": "0"}}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Idempotency key missing | Idempotency key must be supplied |
Idempotency key in use | Idempotency key in use |
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 |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
POST /cards/verifyVerify that a card is valid. For banks that do not support verification, we charge a micro deposit that we void immediately.
curl --request post \--url https://api.payroc.com/v1/cards/verify \--header 'Content-Type: application/json' \--header 'Idempotency-Key: abc123' \--data '{"operator":"Mark Simpsons","processingTerminalId":"1001","card":{"type":"card","cardDetails":{"entryMethod":"keyed","cardholderName":"Joe Bloggs","cardholderSignature":"13ab","keyedData":{"dataFormat":"plainText","cardNumber":"4539858876047062","expiryDate":"1230"}}}}'
application/json
{"operator": "Mark Simpsons","processingTerminalId": "1001","card": {"type": "Visa Credit","entryMethod": "keyed","cardholderName": "Joe Bloggs","cardholderSignature": "13ab","cardNumber": "453985******7062","expiryDate": "1230"},"verified": true,"transactionResult": {"status": "ready","responseCode": "A","responseMessage": "APPROVAL"}}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Idempotency key missing | Idempotency key must be supplied |
Idempotency key in use | Idempotency key in use |
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 |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
curl --request post \--url https://api.payroc.com/v1/cards/balance \--header 'Content-Type: application/json' \--data '{"operator":"Mark Simpsons","processingTerminalId":"1024","currency":"USD","card":{"type":"card","cardDetails":{"entryMethod":"keyed","cardholderName":"Joe Bloggs","cardholderSignature":"12ab","keyedData":{"dataFormat":"plainText","cardNumber":"6007602801003837967","expiryDate":"1229","device":{"type":"PAX_A920_PRO","dataKsn":"FFFF5B09910001000061","firmwareVersion":"PayDroid_8.1.0_Sagittarius_V11.1.11_20200904 V1.04.02_20210617","category":"attended","serialNumber":"1850010868"}},"pinDetails":{"dataFormat":"dukpt","pin":"0123456789abcdef","pinKsn":"0002152304aad1234561"},"ebtDetails":{"benefitCategory":"cash"}}}}'
application/json
{"operator": "Mark Simpsons","processingTerminalId": "1024","card": {"type": "Common Benefit Identification Card","entryMethod": "keyed","cardholderName": "Joe Bloggs","cardholderSignature": "12ab","cardNumber": "600760*********7967","expiryDate": "1229","balances": [{"benefitCategory": "cash","amount": 10000,"currency": "USD"}]},"responseCode": "A","responseMessage": "Approved"}
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 |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
POST /cards/bin-lookupPerform a BIN (Bank Identification Number) lookup to retrieve information about a card.
curl --request post \--url https://api.payroc.com/v1/cards/bin-lookup \--header 'Content-Type: application/json' \--data '{"operator":"Andrew White","processingTerminalId":"1005","card":{"type":"card","cardDetails":{"entryMethod":"keyed","cardholderName":"Joe Bloggs","cardholderSignature":"13ab","keyedData":{"dataFormat":"plainText","cardNumber":"5001650000000000","expiryDate":"1225"}}}}'
application/json
{"type": "MASTERCARD","cardNumber": "500165******0000","country": "US","currency": "USD","debit": 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 |
Not acceptable | Requested representation not supported |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
POST /fx-ratesCheck if a customer’s card is eligible for Dynamic Currency Conversion (DCC). If the card is eligible for DCC, offer currency conversion to the customer during a transaction.
curl --request post \--url https://api.payroc.com/v1/fx-rates \--header 'Content-Type: application/json' \--data '{"channel":"web","operator":"Aaron","processingTerminalId":"1005","baseAmount":10000,"baseCurrency":"EUR","paymentMethod":{"type":"card","accountType":"checking","cardDetails":{"entryMethod":"keyed","cardholderName":"Joe Bloggs","keyedData":{"dataFormat":"plainText","cardNumber":"5001650000000000","expiryDate":"0430"}}}}'
application/json
{"processingTerminalId": "1005","operator": "Aaron","baseAmount": 10000,"baseCurrency": "EUR","inquiryResult": {"dccOffered": true},"dccOffer": {"accepted": true,"reference": "3396977e-40b9-4b26-8a3f-c25bc1280ee2","fxAmount": 13612,"fxCurrency": "JPY","fxCurrencyCode": "392","fxCurrencyExponent": 0,"fxRate": 136.1248,"markup": 3,"provider": "FEXCO","source": "REUTERS WHOLESALE INTERBANK"},"cardInfo": {"type": "MASTERCARD","cardNumber": "500165******0000"}}
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 |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
POST /processing-terminals/{processingTerminalId}/payment-plansCreate a new payment plan.
curl --request post \--url https://api.payroc.com/v1/processing-terminals/abc123/payment-plans \--header 'Content-Type: application/json' \--header 'Idempotency-Key: abc123' \--data '{"paymentPlanId":"1001_yearly_plan","name":"1001 yearly payment plan","description":"1001 yearly payment plan","currency":"EUR","setupOrder":{"amount":1010,"description":"payment plan setup order","breakdown":{"subtotal":1000,"taxes":[{"name":"VAT","rate":1}]}},"recurringOrder":{"amount":1010,"description":"payment plan setup order","breakdown":{"subtotal":1000,"taxes":[{"name":"VAT","rate":1}]}},"length":5,"type":"automatic","frequency":"yearly","onUpdate":"continue","onDelete":"complete"}'
application/json
{"paymentPlanId": "1001_yearly_plan","processingTerminalId": "1001","name": "1001 yearly payment plan","description": "1001 yearly payment plan","currency": "EUR","setupOrder": {"amount": 1010,"description": "payment plan setup order","breakdown": {"subtotal": 1000,"taxes": [{"name": "VAT","rate": 1}]}},"recurringOrder": {"amount": 1010,"description": "payment plan recurring order","breakdown": {"subtotal": 1000,"taxes": [{"name": "VAT","rate": 1}]}},"length": 5,"type": "automatic","frequency": "yearly","onUpdate": "continue","onDelete": "complete"}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Idempotency key missing | Idempotency key must be supplied |
Idempotency key in use | Idempotency key in use |
Not Authorized | Your identity could not be verified |
Forbidden | You do not have the required permission |
Not acceptable | Requested representation not supported |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
GET /processing-terminals/{processingTerminalId}/payment-plansRetrieve a list of payment plans.
curl --request get \--url https://api.payroc.com/v1/processing-terminals/abc123/payment-plans
application/json
{"limit": 2,"count": 2,"hasMore": true,"data": [{"paymentPlanId": "1001_yearly_plan","processingTerminalId": "1001","name": "1001 yearly plan","description": "payment plan, setup order with taxes","currency": "EUR","length": 0,"type": "automatic","frequency": "yearly","onUpdate": "continue","onDelete": "complete"},{"paymentPlanId": "1001_payment_plan_premium","processingTerminalId": "1001","name": "1001 payment plan premium","description": "a template payment plan for premium users","currency": "EUR","length": 0,"type": "automatic","frequency": "yearly","onUpdate": "continue","onDelete": "complete"}],"links": [{"rel": "next","method": "get","href": "https://api.payroc.com/v1/processing-terminals/1001/payment-plans?limit=2&after=M4MY49Z5JB"},{"rel": "previous","method": "get","href": "https://api.payroc.com/v1/processing-terminals/1001/payment-plans?limit=2&before=GKB49GZ6DL"}]}
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. |
GET /processing-terminals/{processingTerminalId}/payment-plans/{paymentPlanId}Retrieve a specific payment plan.
curl --request get \--url https://api.payroc.com/v1/processing-terminals/abc123/payment-plans/abc123
application/json
{"paymentPlanId": "1001_yearly_plan","processingTerminalId": "1001","name": "1001 yearly payment plan","description": "1001 yearly payment plan","currency": "EUR","setupOrder": {"amount": 1010,"description": "payment plan setup order","breakdown": {"subtotal": 1000,"taxes": [{"name": "VAT","rate": 1}]}},"recurringOrder": {"amount": 1010,"description": "payment plan recurring order","breakdown": {"subtotal": 1000,"taxes": [{"name": "VAT","rate": 1}]}},"length": 5,"type": "automatic","frequency": "yearly","onUpdate": "continue","onDelete": "complete"}
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 /processing-terminals/{processingTerminalId}/payment-plans/{paymentPlanId}Make changes to an existing payment plan.
curl --request patch \--url https://api.payroc.com/v1/processing-terminals/abc123/payment-plans/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
{"paymentPlanId": "1001_yearly_plan","processingTerminalId": "1001","name": "1001 yearly payment plan","description": "1001 yearly payment plan","currency": "EUR","setupOrder": {"amount": 1010,"description": "payment plan setup order","breakdown": {"subtotal": 1000,"taxes": [{"name": "VAT","rate": 1}]}},"recurringOrder": {"amount": 1010,"description": "payment plan recurring order","breakdown": {"subtotal": 1000,"taxes": [{"name": "VAT","rate": 1}]}},"length": 5,"type": "automatic","frequency": "yearly","onUpdate": "continue","onDelete": "complete"}
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 |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
DELETE /processing-terminals/{processingTerminalId}/payment-plans/{paymentPlanId}Delete an existing payment plan.
curl --request delete \--url https://api.payroc.com/v1/processing-terminals/abc123/payment-plans/abc123
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. |
POST /paymentsRun a sale or pre-authorization. You can also:
curl --request post \--url https://api.payroc.com/v1/payments \--header 'Content-Type: application/json' \--header 'Idempotency-Key: abc123' \--data '{"channel":"web","processingTerminalId":"1023","operator":"Postman","order":{"orderId":"order123","description":"Example payment","currency":"USD","amount":100},"customer":{"firstName":"Robert","lastName":"Red","billingAddress":{"address1":"billing address1","address2":"billing address2","address3":"billing address3","city":"Los Angeles","state":"California","country":"US","postalCode":90005},"shippingAddress":{"recipientName":"shipping recipientName","address":{"address1":"shipping address1","address2":"shipping address2","address3":"shipping address3","city":"San Diego","state":"California","country":"US","postalCode":91911}}},"paymentMethod":{"type":"card","cardDetails":{"entryMethod":"keyed","keyedData":{"dataFormat":"plainText","device":{"model":"paxA80","serialNumber":"WPC202833004712"},"expiryDate":"0328","cardNumber":"5001650000000000"}}}}'
application/json
{"paymentId": "KP77BIWR96","processingTerminalId": "1023","operator": "Postman","order": {"orderId": "order123","dateTime": "2023-07-26T16:42:25.018Z","description": "Example payment","amount": 100,"currency": "USD"},"customer": {"firstName": "Robert","lastName": "Red","billingAddress": {"address1": "billing address","address2": "billing address2","address3": "billing address3","city": "Los Angeles","state": "California","country": "US","postalCode": "90005"},"shippingAddress": {"recipientName": "shipping recipientName","address": {"address1": "shipping address1","address2": "shipping address2","address3": "shipping address3","city": "San Diego","state": "California","country": "US","postalCode": "91911"}}},"card": {"type": "MasterCard","entryMethod": "keyed","cardNumber": "500165******0000","expiryDate": "0328","securityChecks": {"cvvResult": "M","avsResult": "Y"}},"supportedOperations": ["capture","fullyReverse","partiallyReverse","incrementAuthorization","adjustTip","setAsPending"],"transactionResult": {"type": "sale","status": "ready","approvalCode": "OK3","authorizedAmount": 100,"currency": "USD","responseCode": "A","responseMessage": "OK3"}}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Idempotency key missing | Idempotency key must be supplied |
Idempotency key in use | Idempotency key in use |
Not Authorized | Your identity could not be verified |
Forbidden | You do not have the required permission |
Not acceptable | Requested representation not supported |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
curl --request get \--url https://api.payroc.com/v1/payments
application/json
{"limit": 2,"count": 2,"hasMore": true,"data": [{"paymentId": "IFA1T74OBS","processingTerminalId": "1001","operator": "Automatic Payment","order": {"orderId": "684255528917","dateTime": "2023-05-16T16:45:29.000Z","description": "recurring order","amount": 100,"currency": "EUR"},"card": {"type": "Visa Credit","cardholderName": "Joe Bloggs","cardNumber": "453985******7062","expiryDate": "0129","secureToken": {"secureTokenId": "FirefoxSecureCard1001","customerName": "Joe Bloggs","token": "2967533500670317","status": "notValidated","link": {"rel": "self","method": "GET","href": "https://api.payroc.com/v1/processing-terminals/1001/secure-tokens/FirefoxSecureCard1001"}},"securityChecks": {"cvvResult": "M","avsResult": "X"}},"supportedOperations": ["fullyReverse","setAsPending"],"transactionResult": {"type": "sale","status": "ready","approvalCode": "475318","authorizedAmount": 100,"currency": "EUR","responseCode": "A","responseMessage": "APPROVAL"}},{"paymentId": "CW4BA4MUH0","processingTerminalId": "1001","operator": "Automatic Payment","order": {"orderId": "684255528143","dateTime": "2023-05-16T16:45:28.000Z","description": "yearly avant-gard cinema subscription","amount": 1000,"currency": "EUR"},"card": {"type": "Visa Debit","cardholderName": "Joe Bloggs","cardNumber": "400006******0006","expiryDate": "0129","secureToken": {"secureTokenId": "FirefoxSecureCard1001","customerName": "Joe Bloggs","token": "2967533500670317","status": "notValidated","link": {"rel": "self","method": "GET","href": "https://api.payroc.com/v1/processing-terminals/1001/secure-tokens/FirefoxSecureCard1001"}},"securityChecks": {"cvvResult": "M","avsResult": "X"}},"supportedOperations": ["fullyReverse","setAsPending"],"transactionResult": {"type": "sale","status": "ready","approvalCode": "475318","authorizedAmount": 1000,"currency": "EUR","responseCode": "A","responseMessage": "APPROVAL"}}],"links": [{"rel": "next","method": "get","href": "https://api.payroc.com/v1/payments?processingTerminalId=1001&limit=2&after=CW4BA4MUH0"},{"rel": "previous","method": "get","href": "https://api.payroc.com/v1/payments?processingTerminalId=1001&limit=2&before=IFA1T74OBS"}]}
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. |
curl --request get \--url https://api.payroc.com/v1/payments/abc123
application/json
{"paymentId": "KP77BIWR96","processingTerminalId": "1023","operator": "Postman","order": {"orderId": "order123","dateTime": "2023-07-26T16:42:25.018Z","description": "Example payment","amount": 100,"currency": "USD"},"customer": {"firstName": "Robert","lastName": "Red","billingAddress": {"address1": "billing address","address2": "billing address2","address3": "billing address3","city": "Los Angeles","state": "California","country": "US","postalCode": "90005"},"shippingAddress": {"recipientName": "shipping recipientName","address": {"address1": "shipping address1","address2": "shipping address2","address3": "shipping address3","city": "San Diego","state": "California","country": "US","postalCode": "91911"}}},"card": {"type": "MasterCard","entryMethod": "keyed","cardNumber": "500165******0000","expiryDate": "0328","securityChecks": {"cvvResult": "M","avsResult": "Y"}},"supportedOperations": ["capture","fullyReverse","partiallyReverse","incrementAuthorization","adjustTip","setAsPending"],"transactionResult": {"type": "sale","status": "ready","approvalCode": "OK3","authorizedAmount": 100,"currency": "USD","responseCode": "A","responseMessage": "OK3"}}
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 post \--url https://api.payroc.com/v1/payments/abc123/adjust \--header 'Content-Type: application/json' \--header 'Idempotency-Key: abc123' \--data '{"adjustments":[{"type":"customer","shippingAddress":{"recipientName":"new recipientName","address":{"address1":"new address1","address2":"address2","address3":"address3","city":"Miami","state":"Florida","country":"US","postalCode":33101}}},{"type":"order","amount":1000}]}'
application/json
{"paymentId": "HW986AQOBB","processingTerminalId": "1023","order": {"orderId": "6u6","dateTime": "2023-07-27T09:28:44.000Z","description": "Example payment","amount": 1000,"currency": "USD"},"customer": {"firstName": "Robert","lastName": "Red","billingAddress": {"address1": "billing address","address2": "billing address2","address3": "billing address3","city": "Los Angeles","state": "California","country": "US","postalCode": "90005"},"shippingAddress": {"recipientName": "new recipientName","address": {"address1": "new address1","address2": "address2","address3": "address3","city": "Miami","state": "Florida","country": "US","postalCode": "33101"}}},"card": {"type": "MasterCard","entryMethod": "keyed","cardNumber": "500165******0000","expiryDate": "0328","securityChecks": {"cvvResult": "M","avsResult": "Y"}},"supportedOperations": ["capture","fullyReverse","partiallyReverse","incrementAuthorization","adjustTip","setAsPending"],"transactionResult": {"type": "sale","status": "ready","approvalCode": "OK6","authorizedAmount": 1000,"currency": "USD","responseCode": "A","responseMessage": "OK6"}}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Idempotency key missing | Idempotency key must be supplied |
Idempotency key in use | Idempotency key in use |
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 |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
curl --request post \--url https://api.payroc.com/v1/payments/abc123/capture \--header 'Content-Type: application/json' \--header 'Idempotency-Key: abc123' \--data '{"processingTerminalId":"abc123","operator":"abc123","amount":89,"breakdown":{"subtotal":89,"cashbackAmount":89,"tip":{"type":"percentage","amount":0,"percentage":0},"taxes":[{"name":"abc123","rate":0}],"surcharge":{"bypass":false},"dualPricing":{"offered":false,"alternativeTender":"card"},"dutyAmount":89,"freightAmount":89,"items":[{"commodityCode":"abc123","productCode":"abc123","description":"abc123","unitOfMeasure":"ACR","unitPrice":0,"quantity":0,"discountRate":0,"taxes":[{"name":"abc123","rate":0}]}]}}'
application/json
{"paymentId": "KP77BIWR96","processingTerminalId": "1023","operator": "Postman","order": {"orderId": "order123","dateTime": "2023-07-26T16:42:25.018Z","description": "Example payment","amount": 100,"currency": "USD"},"customer": {"firstName": "Robert","lastName": "Red","billingAddress": {"address1": "billing address","address2": "billing address2","address3": "billing address3","city": "Los Angeles","state": "California","country": "US","postalCode": "90005"},"shippingAddress": {"recipientName": "shipping recipientName","address": {"address1": "shipping address1","address2": "shipping address2","address3": "shipping address3","city": "San Diego","state": "California","country": "US","postalCode": "91911"}}},"card": {"type": "MasterCard","entryMethod": "keyed","cardNumber": "500165******0000","expiryDate": "0328","securityChecks": {"cvvResult": "M","avsResult": "Y"}},"supportedOperations": ["capture","fullyReverse","partiallyReverse","incrementAuthorization","adjustTip","setAsPending"],"transactionResult": {"type": "sale","status": "ready","approvalCode": "OK3","authorizedAmount": 100,"currency": "USD","responseCode": "A","responseMessage": "OK3"}}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Idempotency key missing | Idempotency key must be supplied |
Idempotency key in use | Idempotency key in use |
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 |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
curl --request post \--url https://api.payroc.com/v1/payments/abc123/reverse \--header 'Content-Type: application/json' \--header 'Idempotency-Key: abc123' \--data '{"amount":10}'
application/json
{"paymentId": "FRED4RL3GO","processingTerminalId": "1023","order": {"orderId": "MAPI_V2_PAY_23","dateTime": "2023-05-18T09:29:25.000Z","description": "Example payment","amount": 100,"currency": "USD"},"customer": {"firstName": "Giuseppe","lastName": "Verdi","billingAddress": {"address1": "example street","address2": "example address2","address3": "example address3","city": "example city","state": "California","country": "USA","postalCode": "1"},"shippingAddress": {"recipientName": "shipping recipientName","address": {"address1": "shipping address1","address2": "shipping address2","address3": "shipping address3","city": "shipping city","state": "shipping state","country": "IT","postalCode": "1"}}},"card": {"type": "MasterCard","entryMethod": "keyed","cardNumber": "500165******0000","expiryDate": "0328","securityChecks": {"cvvResult": "M","avsResult": "Y"}},"supportedOperations": ["capture","fullyReverse","partiallyReverse","incrementAuthorization","adjustTip","setAsPending"],"transactionResult": {"type": "sale","status": "reversal","approvalCode": "OK2","authorizedAmount": 100,"currency": "USD","responseCode": "A","responseMessage": "OK2"}}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Idempotency key missing | Idempotency key must be supplied |
Idempotency key in use | Idempotency key in use |
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 |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
curl --request post \--url https://api.payroc.com/v1/payments/abc123/refund \--header 'Content-Type: application/json' \--header 'Idempotency-Key: abc123' \--data '{"amount":100,"description":"refund - defective item"}'
application/json
{"paymentId": "JTWWI49L6U","processingTerminalId": "1023","operator": "Adam Smith","order": {"orderId": "86f","dateTime": "2024-01-16T16:57:18.000Z","description": "Example payment","amount": 100,"currency": "USD"},"customer": {"firstName": "Robert","lastName": "Red","billingAddress": {"address1": "billing address","address2": "billing address2","address3": "billing address3","city": "Los Angeles","state": "California","country": "US","postalCode": "90005"},"shippingAddress": {"recipientName": "shipping recipientName","address": {"address1": "shipping address1","address2": "shipping address2","address3": "shipping address3","city": "San Diego","state": "California","country": "US","postalCode": "91911"}}},"card": {"type": "MasterCard","entryMethod": "keyed","cardNumber": "500165******0000","expiryDate": "0328","securityChecks": {"cvvResult": "M","avsResult": "Y"}},"refunds": [{"refundId": "BI77XQFQ05","dateTime": "2024-01-16T17:00:41.000Z","amount": -60,"currency": "USD","status": "ready","link": {"rel": "self","method": "GET","href": "https://api.payroc.com/v1/refunds/BI77XQFQ05"}}],"supportedOperations": ["refund"],"transactionResult": {"type": "sale","status": "complete","approvalCode": "OK13","authorizedAmount": 100,"currency": "USD","responseCode": "A","responseMessage": "OK13"}}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Idempotency key missing | Idempotency key must be supplied |
Idempotency key in use | Idempotency key in use |
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 |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
curl --request post \--url https://api.payroc.com/v1/refunds \--header 'Content-Type: application/json' \--header 'Idempotency-Key: abc123' \--data '{"processingTerminalId":"1023","order":{"orderId":"1023_refund_oa8","description":"refund example","amount":1000,"currency":"USD"},"channel":"web","refundMethod":{"type":"card","cardDetails":{"entryMethod":"keyed","keyedData":{"dataFormat":"plainText","device":{"type":"DATECS_BLUEPAD50","serialNumber":"WPC202833004712"},"expiryDate":"0328","cardNumber":"5001650000000000"}}}}'
application/json
{"refundId": "CD3HN88U9F","processingTerminalId": "1023","order": {"orderId": "1023_refund_oa8","dateTime": "2023-07-27T08:51:02.910Z","description": "refund example","amount": 1000,"currency": "USD"},"card": {"type": "MasterCard","entryMethod": "keyed","cardNumber": "500165******0000","expiryDate": "0328"},"transactionResult": {"type": "refund","status": "ready","approvalCode": "000000","authorizedAmount": -1000,"currency": "USD","responseCode": "A","responseMessage": "OK5"}}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Idempotency key missing | Idempotency key must be supplied |
Idempotency key in use | Idempotency key in use |
Not Authorized | Your identity could not be verified |
Forbidden | You do not have the required permission |
Not acceptable | Requested representation not supported |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
curl --request get \--url https://api.payroc.com/v1/refunds
application/json
{"limit": 2,"count": 2,"hasMore": true,"data": [{"refundId": "FPU8P48WN8","processingTerminalId": "1001","order": {"orderId": "1001_refund_1","dateTime": "2023-05-18T15:32:47.000Z","description": "refund example","amount": 1000,"currency": "EUR"},"card": {"type": "MasterCard","cardNumber": "500165******0000","expiryDate": "0328"},"transactionResult": {"type": "refund","status": "ready","approvalCode": "000000","authorizedAmount": -1000,"currency": "EUR","responseCode": "A","responseMessage": "APPROVAL"}},{"refundId": "CYGDZJF0MH","processingTerminalId": "1001","order": {"orderId": "1001_refund","dateTime": "2023-05-18T15:22:43.000Z","description": "refund example","amount": 1000,"currency": "EUR"},"card": {"type": "MasterCard","cardNumber": "500165******0000","expiryDate": "0328"},"transactionResult": {"type": "refund","status": "reversal","approvalCode": "000000","authorizedAmount": -1000,"currency": "EUR","responseCode": "A","responseMessage": "APPROVAL"}}],"links": [{"rel": "next","method": "get","href": "https://api.payroc.com/v1/refunds?processingTerminalId=1001&limit=2&after=CYGDZJF0MH"},{"rel": "previous","method": "get","href": "https://api.payroc.com/v1/refunds?processingTerminalId=1001&limit=2&before=FPU8P48WN8"}]}
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. |
curl --request get \--url https://api.payroc.com/v1/refunds/abc123
application/json
{"refundId": "CD3HN88U9F","processingTerminalId": "1023","order": {"orderId": "1023_refund_oa8","dateTime": "2023-07-27T08:51:02.910Z","description": "refund example","amount": 1000,"currency": "USD"},"card": {"type": "MasterCard","entryMethod": "keyed","cardNumber": "500165******0000","expiryDate": "0328"},"transactionResult": {"type": "refund","status": "ready","approvalCode": "000000","authorizedAmount": -1000,"currency": "USD","responseCode": "A","responseMessage": "OK5"}}
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 post \--url https://api.payroc.com/v1/refunds/abc123/adjust \--header 'Content-Type: application/json' \--header 'Idempotency-Key: abc123' \--data '{"operator":"Adam Smith","adjustments":[{"type":"customer","contactMethods":[{"type":"mobile","value":"+14155556666"}]}]}'
application/json
{"refundId": "I2HLYTVB81","processingTerminalId": "1023","operator": "Adam Smith","order": {"orderId": "1023_refund_czz","dateTime": "2023-07-28T08:44:35.000Z","description": "refund example","amount": 1000,"currency": "USD"},"customer": {"contactMethods": [{"type": "mobile","value": "+14155556666"}]},"card": {"type": "MasterCard","entryMethod": "keyed","cardNumber": "500165******0000","expiryDate": "0328"},"transactionResult": {"type": "refund","status": "ready","approvalCode": "000000","authorizedAmount": -1000,"currency": "USD","responseCode": "A","responseMessage": "OK13"}}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Idempotency key missing | Idempotency key must be supplied |
Idempotency key in use | Idempotency key in use |
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 |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
curl --request post \--url https://api.payroc.com/v1/refunds/abc123/reverse \--header 'Idempotency-Key: abc123'
application/json
{"refundId": "IH83EP2SRN","processingTerminalId": "1001","order": {"orderId": "1001_refund_2","dateTime": "2023-05-18T15:33:10.000Z","description": "refund example","amount": 1000,"currency": "EUR"},"card": {"type": "Visa Credit","entryMethod": "keyed","cardNumber": "453985******7062","expiryDate": "0328"},"transactionResult": {"type": "refund","status": "reversal","approvalCode": "000000","authorizedAmount": -1000,"currency": "EUR","responseCode": "A","responseMessage": "APPROVAL"}}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Idempotency key missing | Idempotency key must be supplied |
Idempotency key in use | Idempotency key in use |
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 |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
POST /processing-terminals/{processingTerminalId}/secure-tokensSave the customer's payment details to use in future transactions.
curl --request post \--url https://api.payroc.com/v1/processing-terminals/abc123/secure-tokens \--header 'Content-Type: application/json' \--header 'Idempotency-Key: abc123' \--data '{"operator":"Adam Smith","mitAgreement":"unscheduled","customer":{"firstName":"Jessica","lastName":"Red","dateOfBirth":"1990-01-01","referenceNumber":"Customer-12","billingAddress":{"address1":"Example Street","address2":"Example address2","address3":"Example address3","city":"Fresno","state":"California","country":"US","postalCode":93650},"shippingAddress":{"recipientName":"Example shipping recipientName","address":{"address1":"Example shipping street","address2":"Example shipping address2","address3":"Exampleshipping address3","city":"Austin","state":"Texas","country":"US","postalCode":73301}},"contactMethods":[{"type":"email","value":"[email protected]"}],"notificationLanguage":"en"},"ipAddress":{"type":"ipv4","value":"124.201.101.1"},"source":{"type":"card","cardDetails":{"entryMethod":"keyed","cardholderName":"Joe Bloggs","keyedData":{"dataFormat":"plainText","cardNumber":"4001020000000009","expiryDate":"0825","cvv":"713"}}}}'
application/json
{"secureTokenId": "MREF_fce7bf52-b3b4-4270-aee9-77b938595078Hm","processingTerminalId": "1001","mitAgreement": "unscheduled","customer": {"firstName": "Joe","lastName": "Bloggs","dateOfBirth": "1950-01-01","referenceNumber": "Customer-1","billingAddress": {"address1": "Example Street","address2": "Example address2","address3": "Example address3","city": "Example Town","state": "California","country": "US","postalCode": "1234"},"shippingAddress": {"recipientName": "Example shipping recipientName","address": {"address1": "Example shipping street","address2": "Example shipping address2","address3": "Exampleshipping address3","city": "Example shipping city","state": "Texas","country": "US","postalCode": "1"}},"contactMethods": [{"type": "email",}],"notificationLanguage": "en"},"source": {"type": "card","cardholderName": "Joe Bloggs","cardNumber": "400102******0009","expiryDate": "0825"},"token": "2967532489076298","status": "notValidated"}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Idempotency key missing | Idempotency key must be supplied |
Idempotency key in use | Idempotency key in use |
Not Authorized | Your identity could not be verified |
Forbidden | You do not have the required permission |
Not acceptable | Requested representation not supported |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
GET /processing-terminals/{processingTerminalId}/secure-tokensReturn a list of secure tokens that are currently saved on the terminal.
curl --request get \--url https://api.payroc.com/v1/processing-terminals/abc123/secure-tokens
application/json
{"limit": 2,"count": 2,"hasMore": true,"data": [{"secureTokenId": "MREF_bd8abfe6-77ed-4e3b-be9f-91cb2f8801daJ2","processingTerminalId": "1001","mitAgreement": "unscheduled","customer": {"firstName": "Joe","lastName": "Bloggs","dateOfBirth": "1950-01-01","referenceNumber": "Customer-1","billingAddress": {"address1": "Example Street","address2": "Example address2","address3": "Example address3","city": "Example Town","state": "California","country": "US","postalCode": "1234"},"shippingAddress": {"recipientName": "Example shipping recipientName","address": {"address1": "Example shipping street","address2": "Example shipping address2","address3": "Exampleshipping address3","city": "Example shipping city","state": "Texas","country": "US","postalCode": "1"}}},"source": {"type": "card","cardholderName": "Joe Bloggs","cardNumber": "500165******0000","expiryDate": "0825"},"token": "2967539621698111","status": "notValidated"},{"secureTokenId": "MREF_dd8d2205-dae2-482c-b89a-2fc14513d7b7l7","processingTerminalId": "1001","mitAgreement": "unscheduled","customer": {"firstName": "Joe","lastName": "Bloggs","dateOfBirth": "1990-01-01","referenceNumber": "Customer-12","billingAddress": {"address1": "Example Street","address2": "Example address2","address3": "Example address3","city": "Example Town","state": "California","country": "US","postalCode": "1234"},"shippingAddress": {"recipientName": "Example shipping recipientName","address": {"address1": "Example shipping street","address2": "Example shipping address2","address3": "Exampleshipping address3","city": "Example shipping city","state": "Texas","country": "US","postalCode": "1"}}},"source": {"type": "card","cardholderName": "Joe Bloggs","cardNumber": "400006******0006","expiryDate": "0825"},"token": "2967530499662487","status": "notValidated"}],"links": [{"rel": "next","method": "get","href": "https://api.payroc.com/v1/processing-terminals/1001/secure-tokens?limit=2&after=KLOLSOAKSL"},{"rel": "previous","method": "get","href": "https://api.payroc.com/v1/processing-terminals/1001/secure-tokens?limit=2&before=HUAR33GOO6"}]}
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. |
GET /processing-terminals/{processingTerminalId}/secure-tokens/{secureTokenId}Return a secure token and its related payment details.
curl --request get \--url https://api.payroc.com/v1/processing-terminals/abc123/secure-tokens/abc123
application/json
{"secureTokenId": "MREF_fce7bf52-b3b4-4270-aee9-77b938595078Hm","processingTerminalId": "1001","mitAgreement": "unscheduled","customer": {"firstName": "Joe","lastName": "Bloggs","dateOfBirth": "1950-01-01","referenceNumber": "Customer-1","billingAddress": {"address1": "Example Street","address2": "Example address2","address3": "Example address3","city": "Example Town","state": "California","country": "US","postalCode": "1234"},"shippingAddress": {"recipientName": "Example shipping recipientName","address": {"address1": "Example shipping street","address2": "Example shipping address2","address3": "Exampleshipping address3","city": "Example shipping city","state": "Texas","country": "US","postalCode": "1"}},"contactMethods": [{"type": "email",}],"notificationLanguage": "en"},"source": {"type": "card","cardholderName": "Joe Bloggs","cardNumber": "400102******0009","expiryDate": "0825"},"token": "2967532489076298","status": "notValidated"}
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 /processing-terminals/{processingTerminalId}/secure-tokens/{secureTokenId}Update the customer's payment details that are represented by the secure token.
curl --request patch \--url https://api.payroc.com/v1/processing-terminals/abc123/secure-tokens/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
{"secureTokenId": "MREF_fce7bf52-b3b4-4270-aee9-77b938595078Hm","processingTerminalId": "1001","mitAgreement": "unscheduled","customer": {"firstName": "Joe","lastName": "Bloggs","dateOfBirth": "1950-01-01","referenceNumber": "Customer-1","billingAddress": {"address1": "Example Street","address2": "Example address2","address3": "Example address3","city": "Example Town","state": "California","country": "US","postalCode": "1234"},"shippingAddress": {"recipientName": "Example shipping recipientName","address": {"address1": "Example shipping street","address2": "Example shipping address2","address3": "Exampleshipping address3","city": "Example shipping city","state": "Texas","country": "US","postalCode": "1"}},"contactMethods": [{"type": "email",}],"notificationLanguage": "en"},"source": {"type": "card","cardholderName": "Joe Bloggs","cardNumber": "400102******0009","expiryDate": "0825"},"token": "2967532489076298","status": "notValidated"}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Idempotency key missing | Idempotency key must be supplied |
Idempotency key in use | Idempotency key in use |
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 |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
DELETE /processing-terminals/{processingTerminalId}/secure-tokens/{secureTokenId}Delete a secure token and its represented payment details.
curl --request delete \--url https://api.payroc.com/v1/processing-terminals/abc123/secure-tokens/abc123
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. |
POST /processing-terminals/{processingTerminalId}/single-use-tokensCreate a single-use token. The token expires after 30 minutes.
curl --request post \--url https://api.payroc.com/v1/processing-terminals/abc123/single-use-tokens \--header 'Content-Type: application/json' \--header 'Idempotency-Key: abc123' \--data '{"operator":"Carol Smith","paymentMethod":{"type":"card","cardDetails":{"entryMethod":"keyed","cardholderName":"Joe Bloggs","keyedData":{"dataFormat":"plainText","cardNumber":"4539858876047062","expiryDate":"0825","cvv":"713"}}}}'
application/json
{"processingTerminalId": "1005","token": "c96cb928e39c34bd05022cd821d2cbba2349f047ce0cef4f77cd2b5762be7608fb7c23e673bf014d58c64672928eb8256e38aa26911a22853143d22dd48ac9aa","expiresAt": "2023-05-18T23:17:34.844Z","cardInfo": {"type": "Visa Credit","cardNumber": "453985******7062","country": "IS","currency": "ISK","debit": false}}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Idempotency key missing | Idempotency key must be supplied |
Idempotency key in use | Idempotency key in use |
Not Authorized | Your identity could not be verified |
Forbidden | You do not have the required permission |
Not acceptable | Requested representation not supported |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
POST /processing-terminals/{processingTerminalId}/subscriptionsCreate a new subscription.
curl --request post \--url https://api.payroc.com/v1/processing-terminals/abc123/subscriptions \--header 'Content-Type: application/json' \--header 'Idempotency-Key: abc123' \--data '{"subscriptionId":"11001_subscription_cinema","paymentPlanId":"1001_payment_plan_yearly","paymentMethod":{"type":"secureToken","token":"2967533500670317"},"name":"subscription from postman","description":"created through postman for card token","setupOrder":{"amount":1010,"description":"setup order","breakdown":{"subtotal":1000,"taxes":[{"name":"VAT","rate":1}]},"orderId":"setup order"},"recurringOrder":{"amount":1010,"description":"recurring order","breakdown":{"subtotal":1000,"taxes":[{"name":"VAT","rate":1}]}},"startDate":"2023-07-01T00:00:00.000Z","endDate":"2025-07-01T00:00:00.000Z","length":2,"pauseCollectionFor":0}'
application/json
{"subscriptionId": "1001_subscription_cinema","processingTerminalId": "1001","paymentPlan": {"paymentPlanId": "1001_paymentplan_yearly","name": "yearly payment plan","link": {"rel": "self","method": "GET","href": "https://api.payroc.com/v1/processing-terminals/1001/payment-plans/1001_paymentplan_yearly"}},"secureToken": {"secureTokenId": "SecureCard1001","customerName": "Joe Bloggs","token": "2967533500670317","status": "notValidated","link": {"rel": "self","method": "GET","href": "https://api.payroc.com/v1/processing-terminals/1001/secure-tokens/SecureCard1001"}},"name": "avant-garde","description": "avant-garde cinema subscription","currency": "EUR","setupOrder": {"orderId": "setup-order","amount": 1010,"description": "setup order","breakdown": {"subtotal": 1000,"taxes": [{"name": "VAT","rate": 1}]}},"recurringOrder": {"amount": 1010,"description": "recurring order","breakdown": {"subtotal": 1000,"taxes": [{"name": "VAT","rate": 1}]}},"currentState": {"status": "active","nextDueDate": "2023-04-25T00:00:00.000Z","paidInvoices": 0,"outstandingInvoices": 3},"startDate": "2023-04-25T00:00:00.000Z","endDate": "2025-04-25T00:00:00.000Z","length": 24,"type": "automatic","frequency": "yearly","pauseCollectionFor": 0}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Idempotency key missing | Idempotency key must be supplied |
Idempotency key in use | Idempotency key in use |
Not Authorized | Your identity could not be verified |
Forbidden | You do not have the required permission |
Not acceptable | Requested representation not supported |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
GET /processing-terminals/{processingTerminalId}/subscriptionsList subscriptions linked to a terminal.
curl --request get \--url https://api.payroc.com/v1/processing-terminals/abc123/subscriptions
application/json
{"limit": 2,"count": 2,"hasMore": true,"data": [{"subscriptionId": "subscription 6","processingTerminalId": "1001","paymentPlan": {"paymentPlanId": "5","name": "platinum plan","link": {"rel": "self","method": "GET","href": "https://api.payroc.com/v1/processing-terminals/1001/payment-plans/5"}},"secureToken": {"secureTokenId": "SecureCard1001","customerName": "Joe Bloggs","token": "2967533500670317","status": "notValidated","link": {"rel": "self","method": "GET","href": "https://api.payroc.com/v1/processing-terminals/1001/secure-tokens/SecureCard1001"}},"name": "subscription 6","description": "this is description","currency": "EUR","setupOrder": {"orderId": "order 201","amount": 1010,"description": "payment plan setup order"},"recurringOrder": {"amount": 100},"currentState": {"status": "active","nextDueDate": "2024-04-11T00:00:00.000Z","paidInvoices": 1,"outstandingInvoices": 10},"startDate": "2023-04-11T00:00:00.000Z","endDate": "2033-04-11T00:00:00.000Z","length": 0,"type": "automatic","frequency": "yearly","pauseCollectionFor": 0},{"subscriptionId": "subscripion 5","processingTerminalId": "1001","paymentPlan": {"paymentPlanId": "1","name": "gold plan","link": {"rel": "self","method": "GET","href": "https://api.payroc.com/v1/processing-terminals/1001/payment-plans/1"}},"secureToken": {"secureTokenId": "SecureCard1001","customerName": "Joe Bloggs","token": "2967533500670317","status": "notValidated","link": {"rel": "self","method": "GET","href": "https://api.payroc.com/v1/processing-terminals/1001/secure-tokens/SecureCard1001"}},"name": "subscription 5","description": "some description","currency": "EUR","setupOrder": {"orderId": "order-509","amount": 1010},"recurringOrder": {"amount": 100},"currentState": {"status": "active","nextDueDate": "2024-04-11T00:00:00.000Z","paidInvoices": 1,"outstandingInvoices": 10},"startDate": "2023-04-11T00:00:00.000Z","endDate": "2033-04-11T00:00:00.000Z","length": 0,"type": "automatic","frequency": "yearly","pauseCollectionFor": 0}],"links": [{"rel": "next","method": "get","href": "https://api.payroc.com/v1/processing-terminals/1001/subscriptions?limit=2&after=LN3K88F1UH"},{"rel": "previous","method": "get","href": "https://api.payroc.com/v1/processing-terminals/1001/subscriptions?limit=2&before=DBDVNUL6RG"}]}
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. |
GET /processing-terminals/{processingTerminalId}/subscriptions/{subscriptionId}Retrieve a specific subscription.
curl --request get \--url https://api.payroc.com/v1/processing-terminals/abc123/subscriptions/abc123
application/json
{"subscriptionId": "1001_subscription_cinema","processingTerminalId": "1001","paymentPlan": {"paymentPlanId": "1001_paymentplan_yearly","name": "yearly payment plan","link": {"rel": "self","method": "GET","href": "https://api.payroc.com/v1/processing-terminals/1001/payment-plans/1001_paymentplan_yearly"}},"secureToken": {"secureTokenId": "SecureCard1001","customerName": "Joe Bloggs","token": "2967533500670317","status": "notValidated","link": {"rel": "self","method": "GET","href": "https://api.payroc.com/v1/processing-terminals/1001/secure-tokens/SecureCard1001"}},"name": "avant-garde","description": "avant-garde cinema subscription","currency": "EUR","setupOrder": {"orderId": "setup-order","amount": 1010,"description": "setup order","breakdown": {"subtotal": 1000,"taxes": [{"name": "VAT","rate": 1}]}},"recurringOrder": {"amount": 1010,"description": "recurring order","breakdown": {"subtotal": 1000,"taxes": [{"name": "VAT","rate": 1}]}},"currentState": {"status": "active","nextDueDate": "2023-04-25T00:00:00.000Z","paidInvoices": 0,"outstandingInvoices": 3},"startDate": "2023-04-25T00:00:00.000Z","endDate": "2025-04-25T00:00:00.000Z","length": 24,"type": "automatic","frequency": "yearly","pauseCollectionFor": 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 /processing-terminals/{processingTerminalId}/subscriptions/{subscriptionId}Make changes to a subscription.
curl --request patch \--url https://api.payroc.com/v1/processing-terminals/abc123/subscriptions/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
{"subscriptionId": "1001_subscription_cinema","processingTerminalId": "1001","paymentPlan": {"paymentPlanId": "1001_paymentplan_yearly","name": "yearly payment plan","link": {"rel": "self","method": "GET","href": "https://api.payroc.com/v1/processing-terminals/1001/payment-plans/1001_paymentplan_yearly"}},"secureToken": {"secureTokenId": "SecureCard1001","customerName": "Joe Bloggs","token": "2967533500670317","status": "notValidated","link": {"rel": "self","method": "GET","href": "https://api.payroc.com/v1/processing-terminals/1001/secure-tokens/SecureCard1001"}},"name": "avant-garde","description": "avant-garde cinema subscription","currency": "EUR","setupOrder": {"orderId": "setup-order","amount": 1010,"description": "setup order","breakdown": {"subtotal": 1000,"taxes": [{"name": "VAT","rate": 1}]}},"recurringOrder": {"amount": 1010,"description": "recurring order","breakdown": {"subtotal": 1000,"taxes": [{"name": "VAT","rate": 1}]}},"currentState": {"status": "active","nextDueDate": "2023-04-25T00:00:00.000Z","paidInvoices": 0,"outstandingInvoices": 3},"startDate": "2023-04-25T00:00:00.000Z","endDate": "2025-04-25T00:00:00.000Z","length": 24,"type": "automatic","frequency": "yearly","pauseCollectionFor": 0}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Idempotency key missing | Idempotency key must be supplied |
Idempotency key in use | Idempotency key in use |
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 |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
POST /processing-terminals/{processingTerminalId}/subscriptions/{subscriptionId}/deactivateDeactivate a subscription.
curl --request post \--url https://api.payroc.com/v1/processing-terminals/abc123/subscriptions/abc123/deactivate
application/json
{"subscriptionId": "1001_subscription_cinema","processingTerminalId": "1001","paymentPlan": {"paymentPlanId": "1001_paymentplan_yearly","name": "yearly payment plan","link": {"rel": "self","method": "GET","href": "https://api.payroc.com/v1/processing-terminals/1001/payment-plans/1001_paymentplan_yearly"}},"secureToken": {"secureTokenId": "SecureCard1001","customerName": "Joe Bloggs","token": "2967533500670317","status": "notValidated","link": {"rel": "self","method": "GET","href": "https://api.payroc.com/v1/processing-terminals/1001/secure-tokens/SecureCard1001"}},"name": "avant-garde","description": "avant-garde cinema subscription","currency": "EUR","setupOrder": {"orderId": "setup-order","amount": 1010,"description": "setup order","breakdown": {"subtotal": 1000,"taxes": [{"name": "VAT","rate": 1}]}},"recurringOrder": {"amount": 1010,"description": "recurring order","breakdown": {"subtotal": 1000,"taxes": [{"name": "VAT","rate": 1}]}},"currentState": {"status": "cancelled","nextDueDate": "2023-04-25T00:00:00.000Z","paidInvoices": 0,"outstandingInvoices": 3},"startDate": "2023-04-25T00:00:00.000Z","endDate": "2025-04-25T00:00:00.000Z","length": 24,"type": "automatic","frequency": "yearly","pauseCollectionFor": 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 |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
POST /processing-terminals/{processingTerminalId}/subscriptions/{subscriptionId}/reactivateRe-activate an existing subscription.
curl --request post \--url https://api.payroc.com/v1/processing-terminals/abc123/subscriptions/abc123/reactivate
application/json
{"subscriptionId": "1001_subscription_cinema","processingTerminalId": "1001","paymentPlan": {"paymentPlanId": "1001_paymentplan_yearly","name": "yearly payment plan","link": {"rel": "self","method": "GET","href": "https://api.payroc.com/v1/processing-terminals/1001/payment-plans/1001_paymentplan_yearly"}},"secureToken": {"secureTokenId": "SecureCard1001","customerName": "Joe Bloggs","token": "2967533500670317","status": "notValidated","link": {"rel": "self","method": "GET","href": "https://api.payroc.com/v1/processing-terminals/1001/secure-tokens/SecureCard1001"}},"name": "avant-garde","description": "avant-garde cinema subscription","currency": "EUR","setupOrder": {"orderId": "setup-order","amount": 1010,"description": "setup order","breakdown": {"subtotal": 1000,"taxes": [{"name": "VAT","rate": 1}]}},"recurringOrder": {"amount": 1010,"description": "recurring order","breakdown": {"subtotal": 1000,"taxes": [{"name": "VAT","rate": 1}]}},"currentState": {"status": "active","nextDueDate": "2023-04-25T00:00:00.000Z","paidInvoices": 0,"outstandingInvoices": 3},"startDate": "2023-04-25T00:00:00.000Z","endDate": "2025-04-25T00:00:00.000Z","length": 24,"type": "automatic","frequency": "yearly","pauseCollectionFor": 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 |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
POST /processing-terminals/{processingTerminalId}/subscriptions/{subscriptionId}/payProcess payment for a manual subscription.
curl --request post \--url https://api.payroc.com/v1/processing-terminals/abc123/subscriptions/abc123/pay \--header 'Content-Type: application/json' \--header 'Idempotency-Key: abc123' \--data '{"operator":"Giuseppe Green","order":{"amount":1010,"description":"manual payment","breakdown":{"subtotal":1000,"taxes":[{"name":"VAT","rate":1}]},"orderId":"manual payment orderx12s"}}'
application/json
{"subscriptionId": "1017_subscription_metro","processingTerminalId": "1017","payment": {"paymentId": "GTZH5WVXK9","dateTime": "2023-07-27T22:36:03.506Z","amount": 1010,"currency": "CAD","status": "ready","responseCode": "A","link": {"rel": "self","method": "GET","href": "https://api.payroc.com/v1/bank-transfer-payments/GTZH5WVXK9"}},"secureToken": {"secureTokenId": "MREF_465772d1-ab4e-4881-8052-5021a745ed18Df","customerName": "Joe Bloggs","token": "2967536686508441","status": "notValidated","link": {"rel": "self","method": "GET","href": "https://api.payroc.com/v1/processing-terminals/1017/secure-tokens/MREF_465772d1-ab4e-4881-8052-5021a745ed18Df"}},"currentState": {"status": "active","nextDueDate": "2024-07-01T00:00:00.000Z","paidInvoices": 1,"outstandingInvoices": 2}}
Error | Description |
---|---|
Bad Request | One or more validation errors occurred |
Idempotency key missing | Idempotency key must be supplied |
Idempotency key in use | Idempotency key in use |
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 |
Resource already exists | Resource already exists |
Unsupported media type | The payload is in an unsupported format. |
Api error | Unable to process your request. |
curl --request get \--url 'https://api.payroc.com/v1/batches?date=abc123'
application/json
{"limit": 2,"count": 2,"hasMore": true,"links": [{"rel": "previous","method": "get","href": "https://api.payroc.com/v1/batches?before=65&limit=2&date=2021-01-01"},{"rel": "next","method": "get","href": "https://api.payroc.com/v1/batches?after=66&limit=2&&date=2021-01-01"}],"data": [{"batchId": 65,"date": "2021-01-01T00:00:00.000Z","createdDate": "2021-09-05T13:15:00.000Z","lastModifiedDate": "2021-09-06T18:00:00.000Z","saleAmount": 100,"heldAmount": 0,"returnAmount": 0,"transactionCount": 10,"currency": "USD","merchant": {"merchantId": "4525644354","doingBusinessAs": "Joe Bloggs pizza","link": {"rel": "merchant","method": "get","href": "https://api.payroc.com/v1/merchants/4525644354"}},"links": [{"rel": "transactions","method": "get","href": "https://api.payroc.com/v1/transactions?batchId=65"},{"rel": "authorizations","method": "get","href": "https://api.payroc.com/v1/authorizations?batchId=65"}]},{"batchId": 66,"date": "2021-01-01T00:00:00.000Z","createdDate": "2021-09-05T13:15:00.000Z","lastModifiedDate": "2021-09-06T18:00:00.000Z","saleAmount": 76,"heldAmount": 0,"returnAmount": 12,"transactionCount": 10,"currency": "USD","merchant": {"merchantId": "987654321","doingBusinessAs": "Joe Bloggs Shoes","link": {"rel": "merchant","method": "get","href": "https://api.payroc.com/v1/merchants/987654321"}},"links": [{"rel": "transactions","method": "get","href": "https://api.payroc.com/v1/transactions?batchId=66"},{"rel": "authorizations","method": "get","href": "https://api.payroc.com/v1/authorizations?batchId=66"}]}]}
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. |
curl --request get \--url https://api.payroc.com/v1/batches/89
application/json
{"batchId": 123,"date": "2021-09-05T00:00:00.000Z","createdDate": "abc123","lastModifiedDate": "abc123","saleAmount": 89,"heldAmount": 89,"returnAmount": 89,"transactionCount": 89,"currency": "abc123","merchant": {"merchantId": "4525644354","doingBusinessAs": "Joes bloggs pizza","link": {"rel": "merchant","method": "get","href": "https://api.payroc.com/v1/merchants/4525644354"}},"links": [{"rel": "transactions","method": "get","href": "https://api.payroc.com/v1/transactions?batchId=123"},{"rel": "authorizations","method": "get","href": "https://api.payroc.com/v1/authorizations?batchId=123"}]}
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 get \--url 'https://api.payroc.com/v1/transactions?date=abc123&batchId=89'
application/json
{"limit": 2,"count": 1,"hasMore": false,"links": [{"rel": "previous","method": "get","href": "https://api.payroc.com/v1/transctions?before=65&limit=2&date=2021-01-01"}],"data": [{"transactionId": 65,"type": "capture","date": "2021-01-01T00:00:00.000Z","amount": 25000,"entryMethod": "ecommerce","createdDate": "2021-09-05T13:15:00.000Z","lastModifiedDate": "2021-09-06T18:00:00.000Z","status": "paid","cashbackAmount": 0,"interchange": {"basisPoint": "0,","transactionFee": 0},"currency": "USD","merchant": {"merchantId": "4525644354","doingBusinessAs": "Joe Bloggs pizza","link": {"rel": "merchant","method": "get","href": "https://api.payroc.com/v1/merchants/4525644354"}},"settled": {"settledBy": "3rd party","achDate": "2021-09-05T13:15:00.000Z"},"batch": {"batchId": 12,"date": "2021-01-01T00:00:00.000Z","cycle": "am","link": {"rel": "batch","method": "get","href": "https://api.payroc.com/v1/batches/12"}},"card": {"cardNumber": "12456**********4124","type": "visa","cvvPresenceIndicator": true,"avsRequest": true,"avsResponse": ""},"authorization": {"authorizationId": 12345,"code": "ABCDE","amount": 100,"avsResponseCode": "","link": {"rel": "authorization","method": "get","href": "https://api.payroc.com/v1/authorizations/12345"}}}]}
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. |
curl --request get \--url https://api.payroc.com/v1/transactions/89
application/json
{"transactionId": 12345,"type": "capture","date": "2021-01-01T17:00:00.000Z","amount": 25000,"entryMethod": "barcodeRead","createdDate": "abc123","lastModifiedDate": "abc123","status": "fullSuspense","cashbackAmount": 89,"interchange": {"basisPoint": 89,"transactionFee": 89},"currency": "abc123","merchant": {"merchantId": "4525644354","doingBusinessAs": "Joes bloggs pizza","link": {"rel": "merchant","method": "get","href": "https://api.payroc.com/v1/merchants/4525644354"}},"settled": {"settledBy": "abc123","achDate": "2021-09-05T00:00:00.000Z"},"batch": {"batchId": 1234,"date": "2021-09-05T00:00:00.000Z","cycle": "am","link": {"rel": "previous","method": "get","href": "<uri>"}},"card": {"cardNumber": "123456**********4124","type": "visa","cvvPresenceIndicator": false,"avsRequest": false,"avsResponse": "abc123"},"authorization": {"authorizationId": 12345,"code": "abc123","amount": 89,"avsResponseCode": "abc123","link": {"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. |
curl --request get \--url 'https://api.payroc.com/v1/authorizations?date=abc123&batchId=89'
application/json
{"limit": 2,"count": 1,"hasMore": false,"links": [{"rel": "previous","method": "get","href": "https://api.payroc.com/v1/authorizations?before=65&limit=2&date=2021-01-01"}],"data": [{"authorizationId": 65,"createdDate": "2021-09-05T13:15:00.000Z","lastModifiedDate": "2021-09-06T18:00:00.000Z","authorizationResponse": "successful","preauthorizationRequestAmount": 10000,"currency": "USD","merchant": {"merchantId": "4525644354","doingBusinessAs": "Joe Bloggs pizza","link": {"rel": "merchant","method": "get","href": "https://api.payroc.com/v1/merchants/4525644354"}},"batch": {"batchId": 12,"date": "2021-01-01T00:00:00.000Z","cycle": "am","link": {"rel": "batch","method": "get","href": "https://api.payroc.com/v1/batches/12"}},"card": {"cardNumber": "12456**********4124","type": "visa","cvvPresenceIndicator": true,"avsRequest": true,"avsResponse": ""},"transaction": {"transactionId": 12345,"type": "capture","date": "","entryMethod": "swiped","amount": 100,"link": {"rel": "transaction","method": "get","href": "https://api.payroc.com/v1/transactions/12345"}}}]}
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. |
curl --request get \--url https://api.payroc.com/v1/authorizations/89
application/json
{"authorizationId": 12345,"createdDate": "abc123","lastModifiedDate": "abc123","authorizationResponse": "activityCountLimitExceeded","preauthorizationRequestAmount": 10000,"currency": "abc123","batch": {"batchId": 1234,"date": "2021-09-05T00:00:00.000Z","cycle": "am","link": {"rel": "previous","method": "get","href": "<uri>"}},"card": {"cardNumber": "123456**********4124","type": "visa","cvvPresenceIndicator": false,"avsRequest": false,"avsResponse": "abc123"},"merchant": {"merchantId": "4525644354","doingBusinessAs": "Joes bloggs pizza","link": {"rel": "merchant","method": "get","href": "https://api.payroc.com/v1/merchants/4525644354"}},"transaction": {"transactionId": 12345,"type": "capture","date": "2021-01-01T17:00:00.000Z","entryMethod": "barcodeRead","amount": 25000,"link": {"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. |
curl --request get \--url 'https://api.payroc.com/v1/disputes?date=2022-10-01'
application/json
{"limit": 2,"count": 1,"hasMore": false,"links": [{"rel": "previous","method": "get","href": "https://api.payroc.com/v1/disputes?before=65&limit=2&date=2021-01-01"}],"data": [{"disputeId": 65,"disputeType": "firstDispute","currentStatus": {"disputeStatusId": 123,"status": "new","statusDate": "","link": {"rel": "statuses","method": "get","href": "https://api.payroc.com/v1/disputes/12345/statuses"}},"createdDate": "2021-09-05T13:15:00.000Z","lastModifiedDate": "2021-09-06T18:00:00.000Z","receivedDate": "","description": "","referenceNumber": "35435435","disputeAmount": 1000,"feeAmount": 100,"firstdispute": true,"authorizationCode": "574254","currency": "USD","merchant": {"merchantId": "4525644354","doingBusinessAs": "Joe Bloggs pizza","link": {"rel": "merchant","method": "get","href": "https://api.payroc.com/v1/merchants/4525644354"}},"card": {"cardNumber": "12456**********4124","type": "visa","cvvPresenceIndicator": true,"avsRequest": true,"avsResponse": ""},"transaction": {"transactionId": 12345,"type": "capture","date": "","entryMethod": "swiped","amount": 100,"link": {"rel": "transaction","method": "get","href": "https://api.payroc.com/v1/transactions/12345"}}}]}
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. |
GET /disputes/{disputeId}/statusesRetrieve the status history for a specific dispute.
curl --request get \--url https://api.payroc.com/v1/disputes/89/statuses
application/json
[{"disputeStatusId": 12345,"status": "prearbitrationInProcess","statusDate": "abc123"}]
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. |