Guides
/
Integration guides
/
Set up a funding recipient

Set up a funding recipient

Before you begin, make sure that you have read our Getting Started guide, and that you have received your API key.
A funding recipient is an entity that can receive funds using funding instructions. Each funding recipient includes at least one of the following:
Funding account: The funding recipient’s bank account.
Owner: Individuals that are associated with the funding recipient. You can create funding recipients for third parties that can’t directly process sales. For example, charities.

Integration steps

  • Create your funding recipient.

Before you begin

Bearer tokens

Use our Identity Service to generate a Bearer token to include in the header of your requests. To generate your Bearer token, complete the following steps:
  1. Include your API key in the x-api-key parameter in the header of a POST request.
  2. Send your request to https://identity.payroc.com/authorize.
You need to generate a new Bearer token before the previous Bearer token expires.

Example request

curl --location --request POST  'https://identity.payroc.com/authorize' --header 'x-api-key: <api key>'

Example response

If your request is successful, we return a response that contains your Bearer token, information about its scope, and when it expires.
{
"access_token": "eyJhbGc....adQssw5c",
"expires_in": 3600,
"scope": "service_a service_b",
"token_type": "Bearer"
}

Headers

To create the header of each POST request, you must include the following parameters:
  • Content-Type: Include application/json as the value for this parameter.
  • Authorization: Include your Bearer token in this parameter.
  • Idempotency-Key: Include a UUID v4 to make the request idempotent.
curl
-H "Content-Type: application/json"
-H "Authorization: <Bearer token>"
-H "Idempotency-Key: <UUID v4>"

Errors

If your request is unsuccessful, we return an error. For more information about errors, see Errors.

Create your funding recipient

To create your funding recipient, send a POST request to our Funding Recipients endpoint. Test endpoint: https://api.uat.payroc.com/v1/funding-recipients
Production endpoint: https://api.payroc.com/v1/funding-recipients To create the body of your request, use the following parameters:

Header parameters

Body parameters

Use our metadata feature to add custom information to your request.

Example request

Request
curl --request post \
	--url https://api.payroc.com/v1/funding-recipients \
	--header 'Authorization: Bearer <access token>' \
	--header 'Content-Type: application/json' \
	--header 'Idempotency-Key: 8e03978e-40d5-43e8-bc93-6894a57f9324' \
	--data '{"recipientType":"privateCorporation","taxId":"12-3456789","charityId":"abc123","doingBusinessAs":"abc123","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]"}],"metadata":{"yourCustomField":"abc123"},"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":"xxxxx4320"}],"contactMethods":[{"type":"email","value":"[email protected]"}],"relationship":{"equityPercentage":48.5,"title":"CFO","isControlProng":true,"isAuthorizedSignatory":false}}],"fundingAccounts":[{"type":"checking","use":"credit","nameOnAccount":"Jane Doe","paymentMethods":[{"type":"ach","value":{"routingNumber":"123456789","accountNumber":"1234567890"}}],"metadata":{"yourCustomField":"abc123"}}]}'
If your request is successful, we create the funding recipient and return a response. The response contains the following fields:

Response Schema

Status Code 201

Successful request. We created the funding recipient.
Response headers
Response body

Example response

Response
application/json
{
  "recipientId": 234,
  "status": "approved",
  "createdDate": "2024-07-02T15:30:00Z",
  "lastModifiedDate": "2024-07-02T15:30:00Z",
  "recipientType": "privateCorporation",
  "taxId": "12-3456789",
  "charityId": "abc123",
  "doingBuinessAs": "abc123",
  "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]"
    }
  ],
  "metadata": {
    "yourCustomField": "abc123"
  },
  "owners": [
    {
      "ownerId": 4564,
      "link": {
        "rel": "owner",
        "href": "https://api.payroc.com/v1/owners/4564",
        "method": "get"
      }
    }
  ],
  "fundingAccounts": [
    {
      "fundingAccountId": 123,
      "status": "approved",
      "link": {
        "rel": "fundingAccount",
        "href": "https://api.payroc.com/v1/funding-accounts/123",
        "method": "get"
      }
    },
    {
      "fundingAccountId": 124,
      "status": "rejected",
      "link": {
        "rel": "fundingAccount",
        "href": "https://api.payroc.com/v1/funding-accounts/124",
        "method": "get"
      }
    }
  ]
}

Test cases

Our integration team provides you with test cases that you can run to verify that your integration works with our API. For your next steps, we recommend that you follow our quick start guide about sending funds to your funding recipients. To view other functions about managing your funding recipients, see funding recipients.