How to deposit funds

Once an account has been created funds can be added to an account. Funds can be quickly added in sandbox via the below endpoint without following the same steps as needed in production.

Directly add funds to an account

Request

POST v2/accounts/{{account-id}}/sandbox/fund
{
"data" : {
"type" : "accounts",
"attributes" :{
"amount" : "50000"
}
}
}

Response

{
"data": {
"type": "cash-transactions",
"id": "94367cf8-183e-48d0-ac86-9b5eb75ebed4",
"attributes": {
"amount": 50000,
"comments-1": "Test funds contributed.",
"comments-2": null,
"comments-3": null,
"comments-4": null,
"created-at": "2019-12-03T18:52:28Z",
"currency-type": "USD",
"effective-at": "2019-12-03T18:52:28Z",
"funds-transfer-type": "sandbox",
"ops-reference": null,
"reconciled": false,
"settled-on": "2019-12-03",
"special-type": null
},
"links": {
"self": "/v2/cash-transactions/94367cf8-183e-48d0-ac86-9b5eb75ebed4"
},
"relationships": {
"account": {
"links": {
"related": "/v2/accounts/2053f64b-3631-4e64-a611-0bd09e687af6"
}
},
"funds-transfer": {
"data": null
},
"account-cash-transfer-from": {
"links": {
"related": "/v2/account-cash-transfers/?from-cash-transaction.id=94367cf8-183e-48d0-ac86-9b5eb75ebed4"
}
},
"account-cash-transfer-to": {
"links": {
"related": "/v2/account-cash-transfers/?to-cash-transaction.id=94367cf8-183e-48d0-ac86-9b5eb75ebed4"
}
},
"currency": {
"links": {
"related": "/v2/currencies/USD"
}
},
"reconcile-item": {
"links": {
"related": "/v2/reconcile-items/cash-transactions.id=94367cf8-183e-48d0-ac86-9b5eb75ebed4&one"
}
}
}
},
"included": []
}

Steps to deposit funds using wire

The steps to deposit funds depend on the funds-transfer-type.

  1. Generate a unique reference contact funds transfer reference for the account owner or relevant contact to who the contribution (deposit) should be linked.

  2. Present the wire or check mailing instructions to the end user along with the static reference.

  3. Wait for a webhook which will indicate when the funds are received and to which account with the reference code on the contribution.

Request

POST v2/contact-funds-transfer-references
{
"data" : {
"type" : "contact-funds-transfer-references",
"attributes" : {
"account-id" : "{{account-id}}",
"contact-id" : "{{contact-id}}"
}
}
}

Response

{
"data": {
"type": "contact-funds-transfer-references",
"id": "e23cfa72-6d0c-43b3-9d2f-24646ec31c09",
"attributes": {
"reference": "QNCUSNTW3",
"account-id": "2053f64b-3631-4e64-a611-0bd09e687af6",
"contact-id": "7ae9525b-4127-48e8-a089-80199b0383cd"
},
"links": {
"self": "/v2/contact-funds-transfer-references/e23cfa72-6d0c-43b3-9d2f-24646ec31c09"
},
"relationships": {
"account": {
"links": {
"related": "/v2/accounts/2053f64b-3631-4e64-a611-0bd09e687af6"
}
},
"contact": {
"links": {
"related": "/v2/contacts/7ae9525b-4127-48e8-a089-80199b0383cd"
}
}
}
},
"included": []
}

Steps to deposit funds using ACH or credit / debit Ccard

  1. Create a funds-transfer-method linked to the contact for ACH ideally via the Prime Trust Plaid integration and for credit card via the secure widget. In this guide we will create the funds-transfer-method directly for the sake of an example.

  2. Use the funds-transfer-method to create a contribution to the account.

Request

POST v2/funds-transfer-methods
{
"data" : {
"type" : "funds-transfer-methods",
"attributes" : {
"contact-id" : "{{contact-id}}",
"bank-account-name" : "John James Doe",
"routing-number" : "123456789",
"ip-address" : "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
"bank-account-type" : "checking",
"bank-account-number" : "1234567890",
"ach-check-type" : "personal",
"funds-transfer-type" : "ach"
}
}
}

Response

{
"data": {
"type": "funds-transfer-methods",
"id": "cf91c5e7-aebf-4c48-a5e6-365a7e9c834d",
"attributes": {
"ach-check-type": "personal",
"bank-account-name": "John James Doe",
"bank-account-type": "checking",
"bank-name": null,
"check-payee": null,
"contact-email": "johndoe@email.in",
"contact-name": "John James Doe",
"credit-card-name": null,
"credit-card-postal-code": null,
"credit-card-type": null,
"credit-card-expiration-date": null,
"funds-transfer-type": "ach",
"further-credit-account-name": null,
"further-credit-account-number": null,
"iban": null,
"inactive": false,
"intermediary-bank-name": null,
"intermediary-bank-reference": null,
"ip-address": "2001:db8:85a3::8a2e:370:7334",
"label": null,
"last-4": "7890",
"routing-number": "123456789",
"swift-code": null
},
"links": {
"self": "/v2/funds-transfer-methods/cf91c5e7-aebf-4c48-a5e6-365a7e9c834d"
},
"relationships": {
"aml-checks": {
"links": {
"related": "/v2/aml-checks?funds-transfer-method.id=cf91c5e7-aebf-4c48-a5e6-365a7e9c834d"
}
},
"contributions": {
"links": {
"related": "/v2/contributions?funds-transfer-method.id=cf91c5e7-aebf-4c48-a5e6-365a7e9c834d"
}
},
"disbursements": {
"links": {
"related": "/v2/disbursements?funds-transfer-method.id=cf91c5e7-aebf-4c48-a5e6-365a7e9c834d"
}
},
"funds-transfers": {
"links": {
"related": "/v2/funds-transfers?funds-transfer-method.id=cf91c5e7-aebf-4c48-a5e6-365a7e9c834d"
}
},
"bank": {
"links": {
"related": "/v2/funds-transfer-methods/cf91c5e7-aebf-4c48-a5e6-365a7e9c834d/bank"
}
},
"contact": {
"links": {
"related": "/v2/contacts/7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"credit-card-resource": {
"links": {
"related": "/v2/credit-card-resources/"
}
},
"plaid-item": {
"data": null
},
"bank-address": {
"data": null
},
"beneficiary-address": {
"data": null
},
"intermediary-bank-address": {
"data": null
},
"mailing-address": {
"data": null
}
}
},
"included": []
}

Make a deposit

*Request8

POST v2/contributions?include=funds-transfer
{
"data" : {
"type" : "contributions",
"attributes" : {
"amount" : "500",
"contact-id" : "{{contact-id}}",
"funds-transfer-method-id" : "{{funds-transfer-method-id}}",
"account-id" : "{{account-id}}"
}
}
}

Response

{
"data": {
"type": "contributions",
"id": "7ef54475-c6d1-4a7f-8e85-a4052f5e8d00",
"attributes": {
"amount": 500,
"currency-type": "USD",
"amount-expected": 500,
"contributor-email": "johndoe@email.in",
"contributor-name": "John James Doe",
"created-at": "2019-12-03T19:06:17Z",
"funds-transfer-details": null,
"funds-transfer-type": "ach",
"message": null,
"reference": null,
"special-instructions": null,
"special-type": null,
"status": "pending",
"payment-details": null,
"payment-type": "ach",
"reference-number": null,
"transaction-number": null
},
"links": {
"self": "/v2/contributions/7ef54475-c6d1-4a7f-8e85-a4052f5e8d00"
},
"relationships": {
"account": {
"links": {
"related": "/v2/accounts/2053f64b-3631-4e64-a611-0bd09e687af6"
}
},
"contact": {
"links": {
"related": "/v2/contacts?funds-transfers.id=662ba985-731b-4ecd-83de-ceba0d54de96&one"
}
},
"contribution-drive": {
"links": {
"related": "/v2/contribution-drives/1a4fd7a9-875f-451a-b237-49f77ab88261"
}
},
"currency": {
"links": {
"related": "/v2/currencies/USD"
}
},
"funds-transfer": {
"data": {
"type": "funds-transfers",
"id": "662ba985-731b-4ecd-83de-ceba0d54de96"
}
},
"funds-transfer-method": {
"links": {
"related": "/v2/funds-transfer-methods?funds-transfer.id=662ba985-731b-4ecd-83de-ceba0d54de96&one"
}
},
"payment-method": {
"links": {
"related": "/v2/payment-methods?funds-transfers.id=662ba985-731b-4ecd-83de-ceba0d54de96&one"
}
}
}
},
"included": [
{
"type": "funds-transfers",
"id": "662ba985-731b-4ecd-83de-ceba0d54de96",
"attributes": {
"amount": 500,
"amount-expected": 500,
"cancelled-at": null,
"clears-on": null,
"created-at": "2019-12-03T19:06:17Z",
"contingencies-cleared-on": null,
"currency-type": "USD",
"funds-source-name": "John James Doe",
"funds-transfer-type": "ach",
"reference": null,
"reversal-details": null,
"settlement-details": null,
"special-instructions": null,
"special-type": null,
"status": "pending"
},
"links": {
"self": "/v2/funds-transfers/662ba985-731b-4ecd-83de-ceba0d54de96"
},
"relationships": {
"children": {
"links": {
"related": "/v2/funds-transfers?parent.id=662ba985-731b-4ecd-83de-ceba0d54de96"
}
},
"contingent-holds": {
"links": {
"related": "/v2/contingent-holds?funds-transfer.id=662ba985-731b-4ecd-83de-ceba0d54de96"
}
},
"currency": {
"links": {
"related": "/v2/currencies/USD"
}
},
"account": {
"links": {
"related": "/v2/accounts/2053f64b-3631-4e64-a611-0bd09e687af6"
}
},
"contact": {
"links": {
"related": "/v2/contacts/7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"contribution": {
"links": {
"related": "/v2/contributions?funds-transfer.id=662ba985-731b-4ecd-83de-ceba0d54de96&one"
}
},
"disbursement": {
"links": {
"related": "/v2/disbursements?funds-transfer.id=662ba985-731b-4ecd-83de-ceba0d54de96&one"
}
},
"disbursement-authorization": {
"links": {
"related": "/v2/disbursement-authorizations?funds-transfer.id=662ba985-731b-4ecd-83de-ceba0d54de96&one"
}
},
"funds-transfer-method": {
"links": {
"related": "/v2/funds-transfer-methods/cf91c5e7-aebf-4c48-a5e6-365a7e9c834d"
}
},
"parent": {
"data": null
},
"refund": {
"data": null
},
"reversed-cash-transaction": {
"data": null
},
"settled-cash-transaction": {
"data": null
},
"shortage-from-child": {
"data": null
},
"surplus-to-child": {
"data": null
}
}
}
]
}

Track a deposit

Once a contribution has been made the associated funds-transfer should be watched for settlement to see that the funds have been received. The account cash total for the account will also update when the funds have been settled to an account. Note that though funds may settle they may not have cleared or be available for transfer out of the account till all contingent holds related to the corresponding funds-transfer have cleared. Contingent Holds can also be cleared in sandbox as seen below. Once a funds-transfer settles a corresponding cash transaction will be created. Funds Transfers can also be reversed in case of an ACH failure or credit/debit chargeback creating an offsetting cash-transaction.

In sandbox to settle the funds-transfer to an account use the following.

Request

POST v2/funds-transfers/{{funds-transfer-id}}/sandbox/settle

Response

{
"data": {
"type": "funds-transfers",
"id": "662ba985-731b-4ecd-83de-ceba0d54de96",
"attributes": {
"amount": 500.0,
"amount-expected": 500.0,
"cancelled-at": null,
"clears-on": "2019-12-13",
"created-at": "2019-12-03T19:06:17Z",
"contingencies-cleared-on": null,
"currency-type": "USD",
"funds-source-name": "John James Doe",
"funds-transfer-type": "ach",
"reference": null,
"reversal-details": null,
"settlement-details": "Settled via sandbox API",
"special-instructions": null,
"special-type": null,
"status": "settled"
},
"links": {
"self": "/v2/funds-transfers/662ba985-731b-4ecd-83de-ceba0d54de96"
},
"relationships": {
"children": {
"links": {
"related": "/v2/funds-transfers?parent.id=662ba985-731b-4ecd-83de-ceba0d54de96"
}
},
"contingent-holds": {
"links": {
"related": "/v2/contingent-holds?funds-transfer.id=662ba985-731b-4ecd-83de-ceba0d54de96"
}
},
"currency": {
"links": {
"related": "/v2/currencies/USD"
}
},
"account": {
"links": {
"related": "/v2/accounts/2053f64b-3631-4e64-a611-0bd09e687af6"
}
},
"contact": {
"links": {
"related": "/v2/contacts/7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"contribution": {
"links": {
"related": "/v2/contributions?funds-transfer.id=662ba985-731b-4ecd-83de-ceba0d54de96&one"
}
},
"disbursement": {
"links": {
"related": "/v2/disbursements?funds-transfer.id=662ba985-731b-4ecd-83de-ceba0d54de96&one"
}
},
"disbursement-authorization": {
"links": {
"related": "/v2/disbursement-authorizations?funds-transfer.id=662ba985-731b-4ecd-83de-ceba0d54de96&one"
}
},
"funds-transfer-method": {
"links": {
"related": "/v2/funds-transfer-methods/cf91c5e7-aebf-4c48-a5e6-365a7e9c834d"
}
},
"parent": {
"data": null
},
"refund": {
"data": null
},
"reversed-cash-transaction": {
"data": null
},
"settled-cash-transaction": {
"links": {
"related": "/v2/cash-transactions/e94412a9-4545-44b6-8a8d-cf4f23a3936e"
}
},
"shortage-from-child": {
"data": null
},
"surplus-to-child": {
"data": null
}
}
},
"included": []
}

Request

GET v2/funds-transfers?filter[id eq]={{funds-transfer-id}}&include=contingent-holds

Response

{
"links": {
"self": "/v2/funds-transfers?filter%5Bid+eq%5D=662ba985-731b-4ecd-83de-ceba0d54de96&include=contingent-holds",
"first": "/v2/funds-transfers?filter%5Bid+eq%5D=662ba985-731b-4ecd-83de-ceba0d54de96&include=contingent-holds&page%5Bnumber%5D=1&page%5Bsize%5D=25"
},
"meta": {
"page-count": 1,
"resource-count": 2
},
"data": [
{
"type": "funds-transfers",
"id": "662ba985-731b-4ecd-83de-ceba0d54de96",
"attributes": {
"amount": 500.0,
"amount-expected": 500.0,
"cancelled-at": null,
"clears-on": "2019-12-13",
"created-at": "2019-12-03T19:06:17Z",
"contingencies-cleared-on": null,
"currency-type": "USD",
"funds-source-name": "John James Doe",
"funds-transfer-type": "ach",
"reference": null,
"reversal-details": null,
"settlement-details": "Settled via sandbox API",
"special-instructions": null,
"special-type": null,
"status": "settled"
},
"links": {
"self": "/v2/funds-transfers/662ba985-731b-4ecd-83de-ceba0d54de96"
},
"relationships": {
"children": {
"links": {
"related": "/v2/funds-transfers?parent.id=662ba985-731b-4ecd-83de-ceba0d54de96"
}
},
"contingent-holds": {
"data": [
{
"type": "contingent-holds",
"id": "d5fbe26e-523b-4672-b8a0-0fae2c6b919b"
},
{
"type": "contingent-holds",
"id": "e0a1c5c2-be33-4391-afe6-a158ff85efec"
}
]
},
"currency": {
"links": {
"related": "/v2/currencies/USD"
}
},
"account": {
"links": {
"related": "/v2/accounts/2053f64b-3631-4e64-a611-0bd09e687af6"
}
},
"contact": {
"links": {
"related": "/v2/contacts/7ae9525b-4127-48e8-a089-80199b0383cd"
}
},
"contribution": {
"links": {
"related": "/v2/contributions?funds-transfer.id=662ba985-731b-4ecd-83de-ceba0d54de96&one"
}
},
"disbursement": {
"links": {
"related": "/v2/disbursements?funds-transfer.id=662ba985-731b-4ecd-83de-ceba0d54de96&one"
}
},
"disbursement-authorization": {
"links": {
"related": "/v2/disbursement-authorizations?funds-transfer.id=662ba985-731b-4ecd-83de-ceba0d54de96&one"
}
},
"funds-transfer-method": {
"links": {
"related": "/v2/funds-transfer-methods/cf91c5e7-aebf-4c48-a5e6-365a7e9c834d"
}
},
"parent": {
"data": null
},
"refund": {
"data": null
},
"reversed-cash-transaction": {
"data": null
},
"settled-cash-transaction": {
"links": {
"related": "/v2/cash-transactions/e94412a9-4545-44b6-8a8d-cf4f23a3936e"
}
},
"shortage-from-child": {
"data": null
},
"surplus-to-child": {
"data": null
}
}
}
],
"included": [
{
"type": "contingent-holds",
"id": "d5fbe26e-523b-4672-b8a0-0fae2c6b919b",
"attributes": {
"cleared-at": null,
"created-at": "2019-12-03T19:14:56Z",
"hold-type": "funds_not_cleared",
"message": null,
"status": "pending"
},
"links": {
"self": "/v2/contingent-holds/d5fbe26e-523b-4672-b8a0-0fae2c6b919b"
},
"relationships": {
"account": {
"links": {
"related": "/v2/accounts/2053f64b-3631-4e64-a611-0bd09e687af6"
}
},
"funds-transfer": {
"links": {
"related": "/v2/funds-transfers/662ba985-731b-4ecd-83de-ceba0d54de96"
}
},
"asset-transfer": {
"links": {
"related": "/v2/asset-transfers/"
}
}
}
},
{
"type": "contingent-holds",
"id": "e0a1c5c2-be33-4391-afe6-a158ff85efec",
"attributes": {
"cleared-at": "2019-12-03T19:14:56Z",
"created-at": "2019-12-03T19:14:56Z",
"hold-type": "aml_check",
"message": null,
"status": "cleared"
},
"links": {
"self": "/v2/contingent-holds/e0a1c5c2-be33-4391-afe6-a158ff85efec"
},
"relationships": {
"account": {
"links": {
"related": "/v2/accounts/2053f64b-3631-4e64-a611-0bd09e687af6"
}
},
"funds-transfer": {
"links": {
"related": "/v2/funds-transfers/662ba985-731b-4ecd-83de-ceba0d54de96"
}
},
"asset-transfer": {
"links": {
"related": "/v2/asset-transfers/"
}
}
}
}
]
}

Request

POST v2/contingent-holds/{{contingent-hold-id}}/sandbox/clear

Response

{
"data": {
"type": "contingent-holds",
"id": "d5fbe26e-523b-4672-b8a0-0fae2c6b919b",
"attributes": {
"cleared-at": "2019-12-03T19:19:09Z",
"created-at": "2019-12-03T19:14:56Z",
"hold-type": "funds_not_cleared",
"message": null,
"status": "cleared"
},
"links": {
"self": "/v2/contingent-holds/d5fbe26e-523b-4672-b8a0-0fae2c6b919b"
},
"relationships": {
"account": {
"links": {
"related": "/v2/accounts/2053f64b-3631-4e64-a611-0bd09e687af6"
}
},
"funds-transfer": {
"links": {
"related": "/v2/funds-transfers/662ba985-731b-4ecd-83de-ceba0d54de96"
}
},
"asset-transfer": {
"links": {
"related": "/v2/asset-transfers/"
}
}
}
},
"included": []
}

See also

  • Funds Transfer Methods

  • Contributions

  • Contact Funds Transfer References

  • Funds Transfers

  • Account Cash Totals

  • Contingent Holds

  • Cash Transactions

  • Sandbox

Last updated on