Individuals who serve as points of contact for the business.

Retrieve contact

GET /contacts/{contactId}

Retrieve a specific contact.

Path parameters

Response Schema

Status Code 200

Successful request. Returns the requested contact.

Response body

Request

curl --request get \
	--url https://api.payroc.com/v1/contacts/1543 \
	--header 'Authorization: Bearer <access token>'

Response

application/json

{
  "contactId": 1543,
  "type": "manager",
  "firstName": "Jane",
  "middleName": "Helen",
  "lastName": "Doe",
  "identifiers": [
    {
      "type": "nationalId",
      "value": "xxxxx4320"
    }
  ],
  "contactMethods": [
    {
      "type": "email",
      "value": "[email protected]"
    },
    {
      "type": "phone",
      "value": "2025550164"
    },
    {
      "type": "mobile",
      "value": "8445557624"
    },
    {
      "type": "fax",
      "value": "2025550110"
    }
  ]
}

Errors

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.

Update contact

PUT /contacts/{contactId}

Update a specific contact.

Path parameters

Body parameters

Response Schema

Status Code 204

Successful request. We updated the contact.

Request

curl --request put \
	--url https://api.payroc.com/v1/contacts/1543 \
	--header 'Authorization: Bearer <access token>' \
	--header 'Content-Type: application/json' \
	--data '{"type":"manager","firstName":"Jane","middleName":"Helen","lastName":"Doe","identifiers":[{"type":"nationalId","value":"000-00-4320"}],"contactMethods":[{"type":"email","value":"[email protected]"}]}'

Errors

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.

Delete contact

DELETE /contacts/{contactId}

Delete a contact.

Path parameters

Response Schema

Status Code 204

Successful request. We deleted the contact.

Request

curl --request delete \
	--url https://api.payroc.com/v1/contacts/1543 \
	--header 'Authorization: Bearer <access token>'

Errors

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.

A merchant platform is an entity that represents a business and includes its legal information and all processing accounts.

After you create a merchant platform for a business, you can do the following:

Create and add an additional processing account to a merchant platform.
Retrieve a merchant platform.
Retrieve a list of merchant platforms.
Retrieve a list of open processing accounts that are linked to a merchant platform.

For more information about boarding a merchant, go to our Board a merchant guide.

Create merchant platform

POST /merchant-platforms

Use this method to create the entity that represents a business, including its legal information and all its processing accounts.

Note: To add a processing account to an existing merchant platform, go to Create a processing account.

The response contains some fields that we require for other methods:

merchantPlatformId - Unique identifier that we assign to the merchant platform. Use the merchantPlatformId to retrieve and update information about the merchant platform.
processingAccountId- Unique identifier that we assign to each processing account. Use the processingAccountId to retrieve and update information about the processing account.

For more information about how to create a merchant platform, go to Create a merchant platform.

Header parameters

Body parameters

Response Schema

Status Code 201

Successful request. We created the merchant platform.

Response headers

Response body

Request

curl --request post \
	--url https://api.payroc.com/v1/merchant-platforms \
	--header 'Authorization: Bearer <access token>' \
	--header 'Content-Type: application/json' \
	--header 'Idempotency-Key: 8e03978e-40d5-43e8-bc93-6894a57f9324' \
	--data '{"business":{"name":"Example Corp","taxId":"12-3456789","organizationType":"privateCorporation","countryOfOperation":"US","addresses":[{"type":"legalAddress","address1":"1 Example Ave.","address2":"Example Address Line 2","address3":"Example Address Line 3","city":"Chicago","state":"Illinois","country":"US","postalCode":"60056"}],"contactMethods":[{"type":"email","value":"[email protected]"}]},"processingAccounts":[{"doingBusinessAs":"Pizza Doe","owners":[{"firstName":"Jane","middleName":"Helen","lastName":"Doe","dateOfBirth":"1964-03-22","address":{"address1":"1 Example Ave.","address2":"Example Address Line 2","address3":"Example Address Line 3","city":"Chicago","state":"Illinois","country":"US","postalCode":"60056"},"identifiers":[{"type":"nationalId","value":"000-00-4320"}],"contactMethods":[{"type":"email","value":"[email protected]"}],"relationship":{"equityPercentage":48.5,"title":"CFO","isControlProng":true,"isAuthorizedSignatory":false}}],"website":"www.example.com","businessType":"restaurant","categoryCode":5999,"merchandiseOrServiceSold":"Pizza","businessStartDate":"2020-01-01","timezone":"America/Chicago","address":{"address1":"1 Example Ave.","address2":"Example Address Line 2","address3":"Example Address Line 3","city":"Chicago","state":"Illinois","country":"US","postalCode":"60056"},"contactMethods":[{"type":"email","value":"[email protected]"}],"processing":{"transactionAmounts":{"average":5000,"highest":10000},"monthlyAmounts":{"average":50000,"highest":100000},"volumeBreakdown":{"cardPresentKeyed":47,"cardPresentSwiped":30,"mailOrTelephone":3,"ecommerce":20},"isSeasonal":true,"monthsOfOperation":["jan","feb"],"ach":{"naics":"5812","previouslyTerminatedForAch":false,"refunds":{"writtenRefundPolicy":true,"refundPolicyUrl":"www.example.com/refund-poilcy-url"},"estimatedMonthlyTransactions":3000,"limits":{"singleTransaction":10000,"dailyDeposit":200000,"monthlyDeposit":6000000},"transactionTypes":["prearrangedPayment","other"],"transactionTypesOther":"anotherTransactionType"},"cardAcceptance":{"debitOnly":false,"hsaFsa":false,"cardsAccepted":["visa","mastercard"],"specialityCards":{"americanExpressDirect":{"enabled":true,"merchantNumber":"abc1234567"},"electronicBenefitsTransfer":{"enabled":true,"fnsNumber":"6789012"},"other":{"wexMerchantNumber":"abc1234567","voyagerMerchantId":"abc1234567","fleetMerchantId":"abc1234567"}}}},"funding":{"fundingSchedule":"nextday","acceleratedFundingFee":1999,"dailyDiscount":false,"fundingAccounts":[{"type":"checking","use":"creditAndDebit","nameOnAccount":"Jane Doe","paymentMethods":[{"type":"ach","value":{"routingNumber":"123456789","accountNumber":"1234567890"}}],"metadata":{"yourCustomField":"abc123"}}]},"pricing":{"type":"intent","pricingIntentId":6123},"signature":"requestedViaDirectLink","contacts":[{"type":"manager","firstName":"Jane","middleName":"Helen","lastName":"Doe","identifiers":[{"type":"nationalId","value":"000-00-4320"}],"contactMethods":[{"type":"email","value":"[email protected]"}]}],"metadata":{"customerId":"2345"}}],"metadata":{"customerId":"2345"}}'

Response

application/json

{
  "merchantPlatformId": "12345",
  "createdDate": "2024-07-02T12:00:00.000Z",
  "lastModifiedDate": "2024-07-02T12:00:00.000Z",
  "business": {
    "name": "Example Corp",
    "taxId": "xxxxx6789",
    "organizationType": "privateCorporation",
    "countryOfOperation": "US",
    "addresses": [
      {
        "type": "legalAddress",
        "address1": "1 Example Ave.",
        "address2": "Example Address Line 2",
        "address3": "Example Address Line 3",
        "city": "Chicago",
        "state": "Illinois",
        "country": "US",
        "postalCode": "60056"
      }
    ],
    "contactMethods": [
      {
        "type": "email",
        "value": "[email protected]"
      }
    ]
  },
  "processingAccounts": [
    {
      "processingAccountId": "38765",
      "doingBusinessAs": "Pizza Doe",
      "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"
        }
      }
    }
  ]
}

Errors

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.
Cannot select Daily Discount and RewardPayChoice at the same time.	You can't select Daily Discount with a RewardPayChoice pricing plan. To select Daily Discount, choose a different pricing plan.
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.

List merchant platforms

GET /merchant-platforms

Use this method to retrieve a paginated list of the merchant platforms that are linked to the ISV's account.

Query parameters

Response Schema

Status Code 200

Successful request. Returns a list of merchant platforms associated with the ISV's account.

Response body

Request

curl --request get \
	--url https://api.payroc.com/v1/merchant-platforms \
	--header 'Authorization: Bearer <access token>'

Response

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": "2024-07-02T12:00:00.000Z",
      "lastModifiedDate": "2024-07-02T12:00:00.000Z",
      "business": {
        "name": "Example Corp",
        "taxId": "xxxxx6789",
        "organizationType": "privateCorporation",
        "countryOfOperation": "US",
        "addresses": [
          {
            "type": "legalAddress",
            "address1": "1 Example Ave.",
            "address2": "Example Address Line 2",
            "address3": "Example Address Line 3",
            "city": "Chicago",
            "state": "Illinois",
            "country": "US",
            "postalCode": "60056"
          }
        ],
        "contactMethods": [
          {
            "type": "email",
            "value": "[email protected]"
          },
          {
            "type": "phone",
            "value": "123 456 7890"
          }
        ]
      },
      "processingAccounts": [
        {
          "processingAccountId": "38765",
          "doingBusinessAs": "Pizza Doe",
          "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"
            }
          }
        }
      ]
    },
    {
      "merchantPlatformId": "12346",
      "createdDate": "2024-07-02T12:00:00.000Z",
      "lastModifiedDate": "2024-07-02T12:00:00.000Z",
      "business": {
        "name": "Example Corp",
        "taxId": "xxxxx6789",
        "organizationType": "privateCorporation",
        "countryOfOperation": "US",
        "addresses": [
          {
            "type": "legalAddress",
            "address1": "1 Example Ave.",
            "address2": "Example Address Line 2",
            "address3": "Example Address Line 3",
            "city": "Chicago",
            "state": "Illinois",
            "country": "US",
            "postalCode": "60056"
          }
        ],
        "contactMethods": [
          {
            "type": "email",
            "value": "[email protected]"
          },
          {
            "type": "phone",
            "value": "123 456 7890"
          }
        ]
      },
      "processingAccounts": [
        {
          "processingAccountId": "38766",
          "doingBusinessAs": "Doe Hot Dogs",
          "status": "pending",
          "link": {
            "rel": "processingAccount",
            "href": "https://api.payroc.com/v1/processing-accounts/38766",
            "method": "get"
          },
          "signature": {
            "type": "requestedViaDirectLink",
            "link": {
              "rel": "agreement",
              "href": "https://us.agreementexpress.net/mv2/viewer2.jsp?docId=00000000-0000-0000-0000-000000000001",
              "method": "get"
            }
          }
        }
      ]
    }
  ]
}

Errors

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.

Retrieve merchant platform

GET /merchant-platforms/{merchantPlatformId}

Use this method to retrieve information about a merchant platform, including its legal information and processing accounts. Include the merchantPlatformId that we sent you when you created the merchant platform.

Path parameters

Response Schema

Status Code 200

Successful request. Returns the merchant platform.

Response body

Request

curl --request get \
	--url https://api.payroc.com/v1/merchant-platforms/12345 \
	--header 'Authorization: Bearer <access token>'

Response

application/json

{
  "merchantPlatformId": "12345",
  "createdDate": "2024-07-02T12:00:00.000Z",
  "lastModifiedDate": "2024-07-02T12:00:00.000Z",
  "business": {
    "name": "Example Corp",
    "taxId": "xxxxx6789",
    "organizationType": "privateCorporation",
    "countryOfOperation": "US",
    "addresses": [
      {
        "type": "legalAddress",
        "address1": "1 Example Ave.",
        "address2": "Example Address Line 2",
        "address3": "Example Address Line 3",
        "city": "Chicago",
        "state": "Illinois",
        "country": "US",
        "postalCode": "60056"
      }
    ],
    "contactMethods": [
      {
        "type": "email",
        "value": "[email protected]"
      }
    ]
  },
  "processingAccounts": [
    {
      "processingAccountId": "38765",
      "doingBusinessAs": "Pizza Doe",
      "status": "approved",
      "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"
        }
      }
    }
  ],
  "metadata": {
    "customerId": "2345"
  },
  "links": []
}

Errors

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.

List merchant platform's processing accounts

GET /merchant-platforms/{merchantPlatformId}/processing-accounts

Use this method to retrieve a paginated list of processing accounts associated with a merchant platform. When you created the merchant platform, we sent you its merchantPlatformId in the response. Send this merchantPlatformId as a path parameter in your endpoint.

Note: By default, we return only open processing accounts. To include closed processing accounts, send a value of true for the includeClosed query parameter.

Path parameters

Query parameters

Response Schema

Status Code 200

Successful request. Returns a list of processing accounts associated with the merchant platform.

Response body

Request

curl --request get \
	--url https://api.payroc.com/v1/merchant-platforms/12345/processing-accounts \
	--header 'Authorization: Bearer <access token>'

Response

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=38765&limit=2"
    },
    {
      "rel": "next",
      "method": "get",
      "href": "https://api.payroc.com/v1/merchant-platforms/12345/processing-accounts?after=38766&limit=2"
    }
  ],
  "data": [
    {
      "processingAccountId": "38765",
      "createdDate": "2024-07-02T12:00:00.000Z",
      "lastModifiedDate": "2024-07-02T12:00:00.000Z",
      "status": "approved",
      "doingBusinessAs": "Pizza Doe",
      "owners": [
        {
          "ownerId": 4564,
          "firstName": "Jane",
          "lastName": "Doe",
          "link": {
            "rel": "owner",
            "href": "https://api.payroc.com/v1/owners/4564",
            "method": "get"
          }
        }
      ],
      "website": "www.example.com",
      "businessType": "restaurant",
      "categoryCode": 5999,
      "merchandiseOrServiceSold": "Food",
      "businessStartDate": "2020-01-01",
      "timezone": "America/Chicago",
      "address": {
        "address1": "1 Example Ave.",
        "address2": "Example Address Line 2",
        "address3": "Example Address Line 3",
        "city": "Chicago",
        "state": "Illinois",
        "country": "US",
        "postalCode": "60056"
      },
      "contactMethods": [
        {
          "type": "email",
          "value": "[email protected]"
        },
        {
          "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": "5812",
          "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,
          "hsaFsa": 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": 1543,
          "firstName": "Jane",
          "lastName": "Doe",
          "link": {
            "rel": "owner",
            "href": "https://api.payroc.com/v1/contacts/1543",
            "method": "get"
          }
        }
      ]
    },
    {
      "processingAccountId": "38766",
      "createdDate": "2024-07-02T12:00:00.000Z",
      "lastModifiedDate": "2024-07-02T12:00:00.000Z",
      "status": "approved",
      "doingBusinessAs": "Doe Hot Dogs",
      "owners": [
        {
          "ownerId": 4564,
          "firstName": "Jane",
          "lastName": "Doe",
          "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": "3 Example Ave.",
        "address2": "Example Address Line 2",
        "address3": "Example Address Line 3",
        "city": "Chicago",
        "state": "Illinois",
        "country": "US",
        "postalCode": "60056"
      },
      "contactMethods": [
        {
          "type": "email",
          "value": "[email protected]"
        },
        {
          "type": "phone",
          "value": "555 555 3456"
        }
      ],
      "processing": {
        "merchantId": "444412365478966",
        "transactionAmounts": {
          "average": 2000,
          "highest": 300000
        },
        "monthlyAmounts": {
          "average": 2000000,
          "highest": 300000000
        },
        "volumeBreakdown": {
          "cardPresentKeyed": 0,
          "cardPresentSwiped": 0,
          "mailOrTelephone": 0,
          "ecommerce": 100
        },
        "isSeasonal": true
      },
      "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": 1543,
          "firstName": "Jane",
          "lastName": "Doe",
          "link": {
            "rel": "owner",
            "href": "https://api.payroc.com/v1/contacts/1543",
            "method": "get"
          }
        }
      ]
    }
  ]
}

Errors

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.

Create processing account

POST /merchant-platforms/{merchantPlatformId}/processing-accounts

Use this method to create a processing account and add it to a merchant platform.

Note: You can create and add a processing account only to an existing merchant platform. If you have not already created a merchant platform, go to Create a merchant platform.

In the response we return a processingAccountId for the processing account, which you need for the following methods.

Retrieve processing account
List processing account's funding accounts
List contacts
Get a processing account pricing agreement
List owners
Create reminder for processing account

Path parameters

Header parameters

Body parameters

Response Schema

Status Code 201

Successful request. We created the processing account.

Response headers

Response body

Request

curl --request post \
	--url https://api.payroc.com/v1/merchant-platforms/12345/processing-accounts \
	--header 'Authorization: Bearer <access token>' \
	--header 'Content-Type: application/json' \
	--header 'Idempotency-Key: 8e03978e-40d5-43e8-bc93-6894a57f9324' \
	--data '{"doingBusinessAs":"Pizza Doe","owners":[{"firstName":"Jane","middleName":"Helen","lastName":"Doe","dateOfBirth":"1964-03-22","address":{"address1":"1 Example Ave.","address2":"Example Address Line 2","address3":"Example Address Line 3","city":"Chicago","state":"Illinois","country":"US","postalCode":"60056"},"identifiers":[{"type":"nationalId","value":"000-00-4320"}],"contactMethods":[{"type":"email","value":"[email protected]"}],"relationship":{"equityPercentage":51.5,"title":"CFO","isControlProng":true,"isAuthorizedSignatory":false}}],"website":"www.example.com","businessType":"restaurant","categoryCode":5999,"merchandiseOrServiceSold":"Pizza","businessStartDate":"2020-01-01","timezone":"America/Chicago","address":{"address1":"1 Example Ave.","address2":"Example Address Line 2","address3":"Example Address Line 3","city":"Chicago","state":"Illinois","country":"US","postalCode":"60056"},"contactMethods":[{"type":"email","value":"[email protected]"}],"processing":{"transactionAmounts":{"average":5000,"highest":10000},"monthlyAmounts":{"average":50000,"highest":100000},"volumeBreakdown":{"cardPresentKeyed":47,"cardPresentSwiped":30,"mailOrTelephone":3,"ecommerce":20},"isSeasonal":true,"monthsOfOperation":["jan","feb"],"ach":{"naics":"5812","previouslyTerminatedForAch":false,"refunds":{"writtenRefundPolicy":true,"refundPolicyUrl":"www.example.com/refund-poilcy-url"},"estimatedMonthlyTransactions":3000,"limits":{"singleTransaction":10000,"dailyDeposit":200000,"monthlyDeposit":6000000},"transactionTypes":["prearrangedPayment","other"],"transactionTypesOther":"anotherTransactionType"},"cardAcceptance":{"debitOnly":false,"hsaFsa":false,"cardsAccepted":["visa","mastercard"],"specialityCards":{"americanExpressDirect":{"enabled":true,"merchantNumber":"abc1234567"},"electronicBenefitsTransfer":{"enabled":true,"fnsNumber":"6789012"},"other":{"wexMerchantNumber":"abc1234567","voyagerMerchantId":"abc1234567","fleetMerchantId":"abc1234567"}}}},"funding":{"fundingSchedule":"nextday","acceleratedFundingFee":1999,"dailyDiscount":false,"fundingAccounts":[{"type":"checking","use":"creditAndDebit","nameOnAccount":"Jane Doe","paymentMethods":[{"type":"ach","value":{"routingNumber":"123456789","accountNumber":"1234567890"}}],"metadata":{"yourCustomField":"abc123"}}]},"pricing":{"type":"intent","pricingIntentId":6123},"signature":"requestedViaDirectLink","contacts":[{"type":"manager","firstName":"Jane","middleName":"Helen","lastName":"Doe","identifiers":[{"type":"nationalId","value":"000-00-4320"}],"contactMethods":[{"type":"email","value":"[email protected]"}]}],"metadata":{"customerId":"2345"}}'

Response

application/json

{
  "processingAccountId": "38765",
  "createdDate": "2024-07-02T12:00:00.000Z",
  "lastModifiedDate": "2024-07-02T12:00:00.000Z",
  "status": "entered",
  "doingBusinessAs": "Pizza Doe",
  "owners": [
    {
      "ownerId": 4564,
      "firstName": "Jane",
      "lastName": "Doe",
      "link": {
        "rel": "owner",
        "href": "https://api.payroc.com/v1/owners/4564",
        "method": "get"
      }
    }
  ],
  "website": "www.example.com",
  "businessType": "restaurant",
  "categoryCode": 5999,
  "merchandiseOrServiceSold": "Pizza",
  "businessStartDate": "2020-01-01",
  "timezone": "America/Chicago",
  "address": {
    "address1": "1 Example Ave.",
    "address2": "Example Address Line 2",
    "address3": "Example Address Line 3",
    "city": "Chicago",
    "state": "Illinois",
    "country": "US",
    "postalCode": "60056"
  },
  "contactMethods": [
    {
      "type": "email",
      "value": "[email protected]"
    }
  ],
  "processing": {
    "transactionAmounts": {
      "average": 5000,
      "highest": 10000
    },
    "monthlyAmounts": {
      "average": 50000,
      "highest": 100000
    },
    "volumeBreakdown": {
      "cardPresentKeyed": 47,
      "cardPresentSwiped": 30,
      "mailOrTelephone": 3,
      "ecommerce": 20
    },
    "isSeasonal": true,
    "monthsOfOperation": [
      "jan",
      "feb"
    ],
    "ach": {
      "naics": "5812",
      "previouslyTerminatedForAch": false,
      "refunds": {
        "writtenRefundPolicy": true,
        "refundPolicyUrl": "www.example.com/refund-poilcy-url"
      },
      "estimatedMonthlyTransactions": 3000,
      "limits": {
        "singleTransaction": 10000,
        "dailyDeposit": 200000,
        "monthlyDeposit": 6000000
      },
      "transactionTypes": [
        "prearrangedPayment",
        "other"
      ],
      "transactionTypesOther": "anotherTransactionType"
    },
    "cardAcceptance": {
      "debitOnly": false,
      "hsaFsa": false,
      "cardsAccepted": [
        "visa",
        "mastercard"
      ],
      "specialityCards": {
        "americanExpressDirect": {
          "enabled": true,
          "merchantNumber": "abc1234567"
        },
        "electronicBenefitsTransfer": {
          "enabled": true,
          "fnsNumber": "6789012"
        },
        "other": {
          "wexMerchantNumber": "abc1234567",
          "voyagerMerchantId": "abc1234567",
          "fleetMerchantId": "abc1234567"
        }
      }
    }
  },
  "funding": {
    "status": "enabled",
    "fundingSchedule": "nextday",
    "acceleratedFundingFee": 1999,
    "dailyDiscount": false,
    "fundingAccounts": [
      {
        "fundingAccountId": 123,
        "status": "pending",
        "link": {
          "rel": "fundingAccount",
          "method": "get",
          "href": "https://api.payroc.com/v1/funding-account/123"
        }
      }
    ]
  },
  "pricing": {
    "link": {
      "rel": "pricing",
      "href": "https://api.payroc.com/v1/processing-account/12345/pricing",
      "method": "get"
    }
  },
  "contacts": [
    {
      "contactId": 1543,
      "firstName": "Jane",
      "lastName": "Doe",
      "link": {
        "rel": "contact",
        "href": "https://api.payroc.com/v1/contacts/1543",
        "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"
  }
}

Errors

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.
Cannot select Daily Discount and RewardPayChoice at the same time.	You can't select Daily Discount with a RewardPayChoice pricing plan. To select Daily Discount, choose a different pricing plan.
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.

Owners

Individuals who own or control the business.

Retrieve owner

GET /owners/{ownerId}

Retrieve a specific owner.

Path parameters

Response Schema

Status Code 200

Successful request. Returns the requested owner.

Response body

Request

curl --request get \
	--url https://api.payroc.com/v1/owners/4564 \
	--header 'Authorization: Bearer <access token>'

Response

application/json

{
  "ownerId": 4564,
  "firstName": "Jane",
  "middleName": "Helen",
  "lastName": "Doe",
  "dateOfBirth": "1964-03-22",
  "address": {
    "address1": "1 Example Ave.",
    "address2": "Example Address Line 2",
    "address3": "Example Address Line 3",
    "city": "Chicago",
    "state": "Illinois",
    "country": "US",
    "postalCode": "60056"
  },
  "identifiers": [
    {
      "type": "nationalId",
      "value": "xxxxx4320"
    }
  ],
  "contactMethods": [
    {
      "type": "email",
      "value": "[email protected]"
    }
  ],
  "relationship": {
    "equityPercentage": 48.5,
    "title": "CFO",
    "isControlProng": true,
    "isAuthorizedSignatory": false
  }
}

Errors

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.

Update owner

PUT /owners/{ownerId}

Update a specific owner.

Path parameters

Body parameters

Response Schema

Status Code 204

Successful request. We updated the owner.

Request

curl --request put \
	--url https://api.payroc.com/v1/owners/4564 \
	--header 'Authorization: Bearer <access token>' \
	--header 'Content-Type: application/json' \
	--data '{"firstName":"Jane","middleName":"Helen","lastName":"Doe","dateOfBirth":"1964-03-22","address":{"address1":"1 Example Ave.","address2":"Example Address Line 2","address3":"Example Address Line 3","city":"Chicago","state":"Illinois","country":"US","postalCode":"60056"},"identifiers":[{"type":"nationalId","value":"000-00-4320"}],"contactMethods":[{"type":"email","value":"[email protected]"}],"relationship":{"equityPercentage":48.5,"title":"CFO","isControlProng":true,"isAuthorizedSignatory":false}}'

Errors

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 owner

DELETE /owners/{ownerId}

Delete a owner.

Path parameters

Response Schema

Status Code 204

Successful request. We deleted the owner.

Request

curl --request delete \
	--url https://api.payroc.com/v1/owners/4564 \
	--header 'Authorization: Bearer <access token>'

Errors

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.

Pricing intents

Create and manage pricing intents.

List pricing intents

GET /pricing-intents

Retrieve a list of pricing intents.

Query parameters

Response Schema

Status Code 200

Successful response. Returns a list of pricing intents.

Response body

Request

curl --request get \
	--url https://api.payroc.com/v1/pricing-intents \
	--header 'Authorization: Bearer <access token>'

Response

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": "2024-07-02T09:00:00",
      "lastUpdatedDate": "2024-07-02T09:00:00",
      "status": "pendingReview",
      "key": "base",
      "country": "US",
      "version": "5.0",
      "base": {
        "addressVerification": 5,
        "annualFee": {
          "billInMonth": "june",
          "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
        }
      },
      "services": [
        {
          "name": "hardwareAdvantagePlan",
          "enabled": true
        }
      ]
    }
  ]
}

Errors

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.

Create pricing intent

POST /pricing-intents

Create a pricing intent.

Header parameters

Body parameters

Response Schema

Status Code 201

Successful response. We created the pricing intent and it is waiting for approval.

Response headers

Response body

Request

curl --request post \
	--url https://api.payroc.com/v1/pricing-intents \
	--header 'Authorization: Bearer <access token>' \
	--header 'Content-Type: application/json' \
	--header 'Idempotency-Key: 8e03978e-40d5-43e8-bc93-6894a57f9324' \
	--data '{"key":"Your-Unique-Identifier","metadata":{"yourCustomField":"abc123"},"country":"US","version":"5.0","base":{"addressVerification":5,"annualFee":{"billInMonth":"june","amount":9900},"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":0.12,"transaction":0},"amex":{"type":"optBlue","volume":0.12,"transaction":0}}}},"services":[{"name":"hardwareAdvantagePlan","enabled":true}]}'

Response

application/json

{
  "id": "5",
  "createdDate": "2024-07-02T09:00:00",
  "lastUpdatedDate": "2024-07-02T09:00:00",
  "status": "pendingReview",
  "key": "string",
  "metadata": {
    "yourCustomField": "abc123"
  },
  "country": "US",
  "version": "5.0",
  "base": {
    "addressVerification": 5,
    "annualFee": {
      "billInMonth": "june",
      "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
    }
  },
  "services": [
    {
      "name": "hardwareAdvantagePlan",
      "enabled": true
    }
  ]
}

Errors

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.

Retrieve pricing intent

GET /pricing-intents/{pricingIntentId}

Retrieve a specific pricing intent.

Path parameters

Response Schema

Status Code 200

Successful response. Returns the requested pricing intent.

Response body

Request

curl --request get \
	--url https://api.payroc.com/v1/pricing-intents/5 \
	--header 'Authorization: Bearer <access token>'

Response

application/json

{
  "id": "5",
  "createdDate": "2024-07-02T09:00:00",
  "lastUpdatedDate": "2024-07-02T09:00:00",
  "status": "pendingReview",
  "key": "string",
  "metadata": {
    "yourCustomField": "abc123"
  },
  "country": "US",
  "version": "5.0",
  "base": {
    "addressVerification": 5,
    "annualFee": {
      "billInMonth": "june",
      "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
    }
  },
  "services": [
    {
      "name": "hardwareAdvantagePlan",
      "enabled": true
    }
  ]
}

Errors

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.

Update pricing intent

PUT /pricing-intents/{pricingIntentId}

Update a pricing intent.

Path parameters

Body parameters

Response Schema

Status Code 204

Resource successfully updated

Request

curl --request put \
	--url https://api.payroc.com/v1/pricing-intents/5 \
	--header 'Authorization: Bearer <access token>' \
	--header 'Content-Type: application/json' \
	--data '{"key":"Your-Unique-Identifier","metadata":{"yourCustomField":"abc123"},"country":"US","version":"5.0","base":{"addressVerification":5,"annualFee":{"billInMonth":"june","amount":9900},"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":5},"amex":{"type":"optBlue","volume":1.25,"transaction":5},"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":5,"returns":400,"unauthorizedReturn":1999,"statement":800,"monthlyMinimum":20000,"accountVerification":10,"discountRateUnder10000":5.25,"discountRateAbove10000":10}}},"gateway":{"fees":{"monthly":2000,"setup":5000,"perTransaction":2000,"perDeviceMonthly":10}},"services":[{"name":"hardwareAdvantagePlan","enabled":true}]}'

Errors

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.

Partially update pricing intent

PATCH /pricing-intents/{pricingIntentId}

Partially update an existing pricing intent. Structure your request to follow the RFC 6902 standard.

Path parameters

Header parameters

Body parameters

array of Patch Operations

Type

Response Schema

Status Code 200

Successful request. We updated the pricing intent.

Response body

Request

curl --request patch \
	--url https://api.payroc.com/v1/pricing-intents/5 \
	--header 'Authorization: Bearer <access token>' \
	--header 'Content-Type: application/json' \
	--header 'Idempotency-Key: 8e03978e-40d5-43e8-bc93-6894a57f9324' \
	--data '[{"op":"replace","path":"/processor/card/fees/mastercardVisaDiscover/volume","value":1.5},{"op":"replace","path":"/gateway/fees/additionalServiceMonthly","value":16},{"op":"replace","path":"/base/addressVerification","value":6}]'

Response

application/json

{
  "id": "5",
  "createdDate": "2024-07-02T09:00:00",
  "lastUpdatedDate": "2024-07-02T09:00:00",
  "status": "pendingReview",
  "key": "string",
  "metadata": {
    "yourCustomField": "abc123"
  },
  "country": "US",
  "version": "5.0",
  "base": {
    "addressVerification": 5,
    "annualFee": {
      "billInMonth": "june",
      "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
    }
  },
  "services": [
    {
      "name": "hardwareAdvantagePlan",
      "enabled": true
    }
  ]
}

Errors

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.

Delete pricing intent

DELETE /pricing-intents/{pricingIntentId}

Delete a pricing intent.

Path parameters

Response Schema

Status Code 204

Successful request. We deleted the pricing intent.

Request

curl --request delete \
	--url https://api.payroc.com/v1/pricing-intents/5 \
	--header 'Authorization: Bearer <access token>'

Errors

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.

Processing accounts

Create and manage processing accounts.

Retrieve processing account

GET /processing-accounts/{processingAccountId}

Retrieve a specific processing account.

Path parameters

Response Schema

Status Code 200

Successful request. Returns the processing account.

Response body

Request

curl --request get \
	--url https://api.payroc.com/v1/processing-accounts/38765 \
	--header 'Authorization: Bearer <access token>'

Response

application/json

{
  "processingAccountId": "38765",
  "createdDate": "2024-07-02T12:00:00.000Z",
  "lastModifiedDate": "2024-07-02T12:00:00.000Z",
  "status": "approved",
  "doingBusinessAs": "Pizza Doe",
  "owners": [
    {
      "ownerId": 4564,
      "firstName": "Jane",
      "lastName": "Doe",
      "link": {
        "rel": "owner",
        "href": "https://api.payroc.com/v1/owners/1543",
        "method": "get"
      }
    }
  ],
  "website": "www.example.com",
  "businessType": "restaurant",
  "categoryCode": 5999,
  "merchandiseOrServiceSold": "Pizza",
  "businessStartDate": "2020-01-01",
  "timezone": "America/Chicago",
  "address": {
    "address1": "1 Example Ave.",
    "address2": "Example Address Line 2",
    "address3": "Example Address Line 3",
    "city": "Chicago",
    "state": "Illinois",
    "country": "US",
    "postalCode": "60056"
  },
  "contactMethods": [
    {
      "type": "email",
      "value": "[email protected]"
    }
  ],
  "processing": {
    "merchantId": "444412365478965",
    "transactionAmounts": {
      "average": 5000,
      "highest": 10000
    },
    "monthlyAmounts": {
      "average": 50000,
      "highest": 100000
    },
    "volumeBreakdown": {
      "cardPresentKeyed": 47,
      "cardPresentSwiped": 30,
      "mailOrTelephone": 3,
      "ecommerce": 20
    },
    "isSeasonal": true,
    "monthsOfOperation": [
      "jan",
      "feb"
    ],
    "ach": {
      "naics": "5812",
      "previouslyTerminatedForAch": false,
      "refunds": {
        "writtenRefundPolicy": true,
        "refundPolicyUrl": "www.example.com/refund-poilcy-url"
      },
      "estimatedMonthlyTransactions": 3000,
      "limits": {
        "singleTransaction": 10000,
        "dailyDeposit": 200000,
        "monthlyDeposit": 6000000
      },
      "transactionTypes": [
        "prearrangedPayment",
        "other"
      ],
      "transactionTypesOther": "anotherTransactionType"
    },
    "cardAcceptance": {
      "debitOnly": false,
      "hsaFsa": false,
      "cardsAccepted": [
        "visa",
        "mastercard"
      ],
      "specialityCards": {
        "americanExpressDirect": {
          "enabled": true,
          "merchantNumber": "abc1234567"
        },
        "electronicBenefitsTransfer": {
          "enabled": true,
          "fnsNumber": "6789012"
        },
        "other": {
          "wexMerchantNumber": "abc1234567",
          "voyagerMerchantId": "abc1234567",
          "fleetMerchantId": "abc1234567"
        }
      }
    }
  },
  "funding": {
    "status": "enabled",
    "fundingSchedule": "nextday",
    "acceleratedFundingFee": 1999,
    "dailyDiscount": false,
    "fundingAccounts": [
      {
        "fundingAccountId": 123,
        "status": "pending",
        "link": {
          "rel": "fundingAccount",
          "method": "get",
          "href": "https://api.payroc.com/v1/funding-account/123"
        }
      }
    ]
  },
  "pricing": {
    "link": {
      "rel": "pricing",
      "href": "https://api.payroc.com/v1/processing-account/38765/pricing",
      "method": "get"
    }
  },
  "contacts": [
    {
      "contactId": 1543,
      "firstName": "Jane",
      "lastName": "Doe",
      "link": {
        "rel": "contact",
        "href": "https://api.payroc.com/v1/contacts/1543",
        "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"
  }
}

Errors

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.

List processing account's funding accounts

GET /processing-accounts/{processingAccountId}/funding-accounts

Retrieve a list of funding accounts associated with a processing account.

Path parameters

Response Schema

Status Code 200

Successful request. Returns a list of funding accounts associated with the processing account.

Response body

array of funding accounts

Request

curl --request get \
	--url https://api.payroc.com/v1/processing-accounts/38765/funding-accounts \
	--header 'Authorization: Bearer <access token>'

Response

application/json

[
  {
    "fundingAccountId": 123,
    "createdDate": "2024-07-02T12:00:00.000Z'",
    "lastModifiedDate": "2024-07-02T12:00:00.000Z",
    "status": "approved",
    "type": "checking",

Resources

Path parameters

Response Schema

Status Code 200

Response body

Errors

Path parameters

Body parameters

Response Schema

Status Code 204

Errors

Path parameters

Response Schema

Status Code 204

Errors

Header parameters

Body parameters

Response Schema

Status Code 201

Response headers

Response body

Errors

Query parameters

Response Schema

Status Code 200

Response body

Errors

Path parameters

Response Schema

Status Code 200

Response body

Errors

Path parameters

Query parameters

Response Schema

Status Code 200

Response body

Errors

Path parameters

Header parameters

Body parameters

Response Schema

Status Code 201

Response headers

Response body

Errors

Path parameters

Response Schema

Status Code 200

Response body

Errors

Path parameters

Body parameters

Response Schema

Status Code 204

Errors

Path parameters

Response Schema

Status Code 204

Errors

Query parameters

Response Schema

Status Code 200

Response body

Errors

Header parameters

Body parameters

Response Schema

Status Code 201

Response headers

Response body

Errors

Path parameters

Response Schema

Status Code 200

Response body

Errors

Path parameters

Body parameters

Response Schema