SchemaFundingFunding Recipients

Create funding account

Use this method to create a funding account and add it to a funding recipient. To add a funding account to a funding recipient, you need the recipientId. Our gateway returned the recipientId in the response of the [Create Funding Recipient](https://docs.payroc.com/api/schema/funding/funding-recipients/create) method. **Note:** If you don't have the recipientId, use our [List Funding Recipients](https://docs.payroc.com/api/schema/funding/funding-recipients/list) method to search for the funding recipient. In the request, include the following information: - Account type, for example, if the account is a checking or savings account. - Account holder's name. - ACH information, including the routing number and account number of the account. Our gateway returns the fundingAccountId, which you can use to run follow-on actions.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path Parameters

recipientIdintegerRequired
Unique identifier that we assigned to the funding recipient.

Headers

Idempotency-KeystringRequiredformat: "uuid"
Unique identifier that you generate for each request. You must use the [UUID v4 format](https://www.rfc-editor.org/rfc/rfc4122) for the identifier. For more information about the idempotency key, go to [Idempotency](https://docs.payroc.com/api/idempotency).

Request

This endpoint expects an object.
typeenumRequired
Type of funding account.
Allowed values:
useenumRequired
Indicates if we send funds or withdraw funds from the account. - `credit` - Send funds to the account. - `debit` - Withdraw funds from the account. - `creditAndDebit` - Send funds and withdraw funds from the account. **Note:** If the funding account is associated with a funding recipient, we accept only a value of `credit`.
Allowed values:
nameOnAccountstringRequired
Name of the account holder.
paymentMethodslist of objectsRequired
Array of paymentMethod objects.
metadatamap from strings to stringsOptional

Metadata object you can use to include custom data with your request.

Response

Successful request. We created the funding account and added it to the funding recipient.
typeenum
Type of funding account.
Allowed values:
useenum
Indicates if we send funds or withdraw funds from the account. - `credit` - Send funds to the account. - `debit` - Withdraw funds from the account. - `creditAndDebit` - Send funds and withdraw funds from the account. **Note:** If the funding account is associated with a funding recipient, we accept only a value of `credit`.
Allowed values:
nameOnAccountstring
Name of the account holder.
paymentMethodslist of objects
Array of paymentMethod objects.
fundingAccountIdinteger or null
Unique identifier that we assigned to the funding account.
createdDatedatetime or null
Date and time that we received your request to create the funding account in our system.
lastModifiedDatedatetime or null
Date and time that the funding account was last modified.
statusenum or null
Status of the funding account. The value is one of the following: - `approved` - We approved the funding account. - `rejected` - We rejected the funding account. - `pending` - We have not yet approved the funding account. - `hold` - Our Risk team have temporarily placed a hold on the funding account.
Allowed values:
metadatamap from strings to strings or null

Metadata object you can use to include custom data with your request.

Errors