Create an exchange for an account
This section contains information on how to create an exchange for a reseller partner or client account. The creation of an exchange serves as the “hand-shake” between Dwolla and a trusted ecosystem partner. The creation of an exchange requires a_link to the exchange partner and tokenized data which encapsulates limited permissioned access between an ecosystem partner and Dwolla.
HTTP request
POST https://api.dwolla.com/exchanges
Request parameters
HTTP status and error codes
| HTTP Status | Code | Description |
|---|---|---|
| 201 | Created | The Dwolla API accepted the request and created an exchange resource. You can reference the Location header to retrieve a link that represents the created exchange resource. |
| 400 | InvalidExchangeToken | The exchange token is not valid to perform this operation. Either the token is expired or invalid, or the products permissions to the token are invalid or expired. |
| 400 | InactiveExchange | Exchange was removed or disabled. |
| 401 | InvalidScope | The scopes for creating an exchange resource for an account is not enabled for this application. Reach out to Dwolla for more information. |
Request and Response (MX)
POST https://api.dwolla.com/exchanges
Accept: application/vnd.dwolla.v1.hal+json
Content-Type: application/vnd.dwolla.v1.hal+json
Authorization: Bearer pBA9fVDBEyYZCEsLf/wKehyh1RTpzjUj5KzIRfDi0wKTii7DqY
{
"_links": {
"exchange-partner": {
"href": "https://api.dwolla.com/exchange-partners/292317ec-e252-47d8-93c3-2d128e037aa4"
}
},
"token": "someMXProcessorToken"
}
HTTP/1.1 201 Created
Location: https://api.dwolla.com/exchanges/fcd15e5f-8d13-4570-a9b7-7fb49e55941d
/**
* No example for this language yet.
**/
# Using dwolla_v2 - https://github.com/Dwolla/dwolla-v2-ruby
request_body = {
_links: {
'exchange-partner': {
href: "https://api.dwolla.com/exchange-partners/292317ec-e252-47d8-93c3-2d128e037aa4"
}
},
token: 'someMXProcessorToken'
}
exchange = app_token.post "exchanges", request_body
exchange.response_headers[:location] # => "https://api.dwolla.com/exchanges/fcd15e5f-8d13-4570-a9b7-7fb49e55941d"
# Using dwollav2 - https://github.com/Dwolla/dwolla-v2-python
request_body = {
'_links': {
'exchange-partner': {
'href': 'https://api.dwolla.com/exchange-partners/292317ec-e252-47d8-93c3-2d128e037aa4'
}
},
'token': 'someMXProcessorToken'
}
exchange = app_token.post('exchange', request_body)
exchange.headers['location'] # => 'https://api.dwolla.com/exchanges/fcd15e5f-8d13-4570-a9b7-7fb49e55941d'
// Using dwolla-v2 - https://github.com/Dwolla/dwolla-v2-node
var requestBody = {
_links: {
"exchange-partner": {
href: "https://api.dwolla.com/exchange-partners/292317ec-e252-47d8-93c3-2d128e037aa4",
},
},
token: "someMXProcessorToken",
};
dwolla
.post("exchanges", requestBody)
.then((res) => res.headers.get("location")); // => 'https://api.dwolla.com/exchanges/fcd15e5f-8d13-4570-a9b7-7fb49e55941d'
Request and Response (Flinks)
POST https://api.dwolla.com/exchanges
Accept: application/vnd.dwolla.v1.hal+json
Content-Type: application/vnd.dwolla.v1.hal+json
Authorization: Bearer pBA9fVDBEyYZCEsLf/wKehyh1RTpzjUj5KzIRfDi0wKTii7DqY
{
"_links": {
"exchange-partner": {
"href": "https://api.dwolla.com/exchange-partners/a0b22a57-68df-4450-b507-47c937e64e89"
}
},
"token": "MTExYTFhMWEtMTExMS0xYWExLTExMTEtMTFhMTExYTExMTFhOjIyMmIyYjFiLTIyMjItMmJiMi0yMjIyLTIyYjIyMmIyMjIyYg=="
}
HTTP/1.1 201 Created
Location: https://api.dwolla.com/exchanges/fcd15e5f-8d13-4570-a9b7-7fb49e55941d
<?php
// Using dwollaswagger - https://github.com/Dwolla/dwolla-swagger-php
$exchangesApi = new ExchangesApi($apiClient);
$authSecret = "111a1a1a-1111-1aa1-1111-11a111a1111a";
$accessToken = "222b2b1b-2222-2bb2-2222-22b222b2222b";
$exchange = $exchangesApi->createAccountExchange(new CreateExchangeRequest([
"_links" => [
"exchange-partner" => [
"href" => "https://api.dwolla.com/exchange-partners/a0b22a57-68df-4450-b507-47c937e64e89"
]
],
"token" => base64_encode($authSecret . ":" . $accessToken)
]));
$exchange; # => https://api.dwolla.com/exchanges/fcd15e5f-8d13-4570-a9b7-7fb49e55941d
?>
# Using dwolla_v2 - https://github.com/Dwolla/dwolla-v2-ruby
require "base64"
auth_secret = '111a1a1a-1111-1aa1-1111-11a111a1111a'
access_token = '222b2b1b-2222-2bb2-2222-22b222b2222b'
request_body = {
_links: {
'exchange-partner': {
href: "https://api.dwolla.com/exchange-partners/a0b22a57-68df-4450-b507-47c937e64e89"
}
},
token: Base64.encode64(auth_secret + ':' + access_token)
}
exchange = app_token.post "exchanges", request_body
exchange.response_headers[:location] # => "https://api.dwolla.com/exchanges/fcd15e5f-8d13-4570-a9b7-7fb49e55941d"
# Using dwollav2 - https://github.com/Dwolla/dwolla-v2-python
import base64
auth_secret = b'111a1a1a-1111-1aa1-1111-11a111a1111a'
access_token = b'222b2b1b-2222-2bb2-2222-22b222b2222b'
request_body = {
'_links': {
'exchange-partner': {
'href': 'https://api.dwolla.com/exchange-partners/a0b22a57-68df-4450-b507-47c937e64e89'
}
},
'token': base64.b64encode(auth_secret + ':' + access_token)
}
exchange = app_token.post('exchange', request_body)
exchange.headers['location'] # => 'https://api.dwolla.com/exchanges/a0b22a57-68df-4450-b507-47c937e64e89'
// Using dwolla-v2 - https://github.com/Dwolla/dwolla-v2-node
var authSecret = "111a1a1a-1111-1aa1-1111-11a111a1111a";
var accessToken = "222b2b1b-2222-2bb2-2222-22b222b2222b";
var requestBody = {
_links: {
"exchange-partner": {
href: "https://api.dwolla.com/exchange-partners/a0b22a57-68df-4450-b507-47c937e64e89",
},
},
token: Buffer.from(authSecret + ":" + accessToken, "utf-8").toString(
"base64"
),
};
dwolla
.post("exchanges", requestBody)
.then((res) => res.headers.get("location")); // => 'https://api.dwolla.com/exchanges/fcd15e5f-8d13-4570-a9b7-7fb49e55941d'
Request and Response (Mastercard)
POST https://api.dwolla.com/exchanges
Accept: application/vnd.dwolla.v1.hal+json
Content-Type: application/vnd.dwolla.v1.hal+json
Authorization: Bearer pBA9fVDBEyYZCEsLf/wKehyh1RTpzjUj5KzIRfDi0wKTii7DqY
{
"_links": {
"exchange-partner": {
"href": "https://api.dwolla.com/exchange-partners/292317ec-e252-47d8-93c3-2d128e037aa4"
}
},
"finicity": {
"profile": 3,
"version": "1",
"receiptId": "cr_4N47ou7SlppuIxq0ZUtACh10vYcloY",
"receiptVersion": "1",
"customerId": "5454874858510164117",
"partnerId": 2445583946651,
"products": [
{
"product": "moneyTransferDetails",
"accountId": "1015199035827334916",
"accessPeriod": {
"type": "timeframe",
"startTime": "2022-07-06",
"endTime": "2022-08-16T06:06:20Z"
}
}
],
"timestamp": "2022-07-11T06:06:23Z"
}
}
HTTP/1.1 201 Created
Location: https://api.dwolla.com/exchanges/fcd15e5f-8d13-4570-a9b7-7fb49e55941d
<?php
// Using dwollaswagger - https://github.com/Dwolla/dwolla-swagger-php
$exchangesApi = new ExchangesApi($apiClient);
$exchange = $exchangesApi->createAccountExchange(new CreateExchangeRequest([
"_links" => [
"exchange-partner" => [
"href" => "https://api.dwolla.com/exchange-partners/292317ec-e252-47d8-93c3-2d128e037aa4"
]
],
"finicity" => [
"profile" => 3,
"version" => "1",
"receiptId" => "cr_4N47ou7SlppuIxq0ZUtACh10vYcloY",
"receiptVersion" => "1",
"customerId" => "5454874858510164117",
"partnerId" => 2445583946651,
"products" => [
[
"product" => "moneyTransferDetails",
"accountId" => "1015199035827334916",
"accessPeriod" => [
"type" => "timeframe",
"startTime" => "2022-07-06",
"endTime" => "2022-08-16T06:06:20Z"
]
]
],
"timestamp" => "2022-07-11T06:06:23Z"
]
]));
$exchange; # => https://api.dwolla.com/exchanges/fcd15e5f-8d13-4570-a9b7-7fb49e55941d
?>
# Using dwolla_v2 - https://github.com/Dwolla/dwolla-v2-ruby
request_body = {
:_links => {
:exchange-partner => {
:href => "https://api.dwolla.com/exchange-partners/292317ec-e252-47d8-93c3-2d128e037aa4"
}
},
:finicity => {
:profile => 3,
:version => "1",
:receiptId => "cr_4N47ou7SlppuIxq0ZUtACh10vYcloY",
:receiptVersion => "1",
:customerId => "5454874858510164117",
:partnerId => 2445583946651,
:products => [
{
:product => "moneyTransferDetails",
:accountId => "1015199035827334916",
:accessPeriod => {
:type => "timeframe",
:startTime => "2022-07-06",
:endTime => "2022-08-16T06:06:20Z"
}
}
],
:timestamp => "2022-07-11T06:06:23Z"
}
}
exchange = app_token.post "exchanges", request_body
exchange.response_headers[:location] # => "https://api.dwolla.com/exchanges/fcd15e5f-8d13-4570-a9b7-7fb49e55941d"
# Using dwollav2 - https://github.com/Dwolla/dwolla-v2-python
request_body = {
'_links': {
'exchange-partner': {
'href': "https://api.dwolla.com/exchange-partners/292317ec-e252-47d8-93c3-2d128e037aa4"
}
},
'finicity': {
'profile': 3,
'version': "1",
'receiptId': "cr_4N47ou7SlppuIxq0ZUtACh10vYcloY",
'receiptVersion': "1",
'customerId': "5454874858510164117",
'partnerId': 2445583946651,
'products': [
{
'product': "moneyTransferDetails",
'accountId': "1015199035827334916",
'accessPeriod': {
'type': "timeframe",
'startTime': "2022-07-06",
'endTime': "2022-08-16T06:06:20Z"
}
}
],
'timestamp': "2022-07-11T06:06:23Z"
}
}
exchange = app_token.post('exchange', request_body)
exchange.headers['location'] # => 'https://api.dwolla.com/exchanges/fcd15e5f-8d13-4570-a9b7-7fb49e55941d'
// Using dwolla-v2 - https://github.com/Dwolla/dwolla-v2-node
var requestBody = {
_links: {
"exchange-partner": {
href: "https://api.dwolla.com/exchange-partners/292317ec-e252-47d8-93c3-2d128e037aa4",
},
},
finicity: {
profile: 3,
version: "1",
receiptId: "cr_4N47ou7SlppuIxq0ZUtACh10vYcloY",
receiptVersion: "1",
customerId: "5454874858510164117",
partnerId: 2445583946651,
products: [
{
product: "moneyTransferDetails",
accountId: "1015199035827334916",
accessPeriod: {
type: "timeframe",
startTime: "2022-07-06",
endTime: "2022-08-16T06:06:20Z",
},
},
],
timestamp: "2022-07-11T06:06:23Z",
},
};
dwolla
.post("exchanges", requestBody)
.then((res) => res.headers.get("location")); // => 'https://api.dwolla.com/exchanges/fcd15e5f-8d13-4570-a9b7-7fb49e55941d'