POST

Create bank transfer method from Plaid processor token

Sending the processor_token to this endpoint will create the bank transfer method for the given enterprise on the BitGo Platform.

Currently, only ACH bank transfer methods will be accepted.

Ensure you set all the required permissions to the token before submitting it: auth, identity and signal.

Optionally, you can provide the description for the bank transfer method. The description is the display name and works similarly to a nickname. Uses the account name returned by Plaid when omitted.

Body Params

object

enterpriseId string required

The ID of the enterprise that owns the bank transfer method

at least 1 characters
processorToken string required

A Plaid processor token created with BitGo as the processor.

at least 1 characters
description string

Optional display name for the bank transfer method. Uses the account name returned by Plaid when omitted.

Responses

201

Created

Response Body

object

data object required
data object
- bankTransferMethodId string required
  
  The ID of the created bank transfer method

400

Bad Request - Required parameters are missing, the processor token is invalid, or it is not linked to an ACH account

Response Body

object

errorName string required
error string required

403

Forbidden - Client does not have access to the enterprise

Response Body

object

errorName string required
error string required

424

Failed Dependency - Plaid service is unavailable

Response Body

object

errorName string required
error string required

500

Internal Server Error

Response Body

object

errorName string required
error string required

curl -X POST \ --url 'https://app.bitgo-test.com/api/tradfi/v1/plaid/processor-token' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'content-type: application/json' \ --data '{,"enterpriseId":"string","processorToken":"string","description":"string"}'

const url = 'https://app.bitgo-test.com/api/tradfi/v1/plaid/processor-token'; const options = { method: 'POST', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN', 'content-type': 'application/json'}, body: JSON.stringify({,"enterpriseId":"string","processorToken":"string","description":"string"}) }; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err));

require 'uri' require 'net/http' url = URI("https://app.bitgo-test.com/api/tradfi/v1/plaid/processor-token") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' request["content-type"] = 'application/json' request.body = '{,"enterpriseId":"string","processorToken":"string","description":"string"}' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('POST', 'https://app.bitgo-test.com/api/tradfi/v1/plaid/processor-token', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', 'content-type' => 'application/json', ], 'body' => '{,"enterpriseId":"string","processorToken":"string","description":"string"}', ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/tradfi/v1/plaid/processor-token" payload = {,"enterpriseId":"string","processorToken":"string","description":"string"} headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN", "content-type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.text)