Pull Funds From Withdrawal Account - Currencycloud API Documentation

Home > Pull Funds From Withdrawal Account

/v2/withdrawal_accounts/{withdrawal_account_id}/pull_funds

POST

Submits an ACH pull request from a specific withdrawal account. The funds will be pulled into the account the specified withdrawal account is related to

The API responses shown below are static. If you want to try out the API please login, or register for an API key

API parameters

Required

Name	In	Type	Description
X-Auth-Token	header	string	Authentication token.
withdrawal_account_id	path	string	The withdrawal account ID you want to pull the funds from. The funds will be pulled into the account id related to this withdrawal account
reference	formData	string	The reference you want on the statement
amount	formData	string	The amount of funds to pull in USD

curl -X POST  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/withdrawal_accounts/{withdrawal_account_id}/pull_funds

Response

{
    "id": "373ac877-4656-41b8-9851-863796f71aa1",
    "withdrawal_account_id": "0886ac00-6ab6-41a6-b0e1-8d3faf2e0de2",
    "reference": "PullFunds1",
    "amount": "100.00",
    "created_at": "2020-01-23T09:37:06+00:00"
}

Error Codes

HTTP Status	Code	Description	Params
400	reference_is_required	reference is required
	reference_invalid	Only characters, digits, spaces, '_' and '-' allowed
	reference_too_long	Reference cannot be longer than 10 characters
	amount_is_required	amount is required
	amount_is_in_invalid_format	amount should be of numeric type with 2 dp	`{ "type" => "numeric_with_precision", "precision" => 2 }`
	amount_not_positive	Amount should be positive
	amount_not_allowed	Amount should be up to 25000 limit
401	invalid_supplied_credentials	Authentication failed with the supplied credentials
403	permission_denied	permission_denied
429	too_many_requests	Too many requests have been made to the api. Please refer to the Developer Center for more information
500	internal_server_error	Internal server error
503	service_unavailable	Service is temporary unavailable

Was this page helpful?

Yes